aboutsummaryrefslogtreecommitdiffstats
path: root/test/tools/test_builder.py
blob: bef0e9d6114407e075bcadff7820fe3f81e0f78e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
"""

Part of the bsie test suite.
A copy of the license is provided with the project.
Author: Matthias Baumgartner, 2022
"""
# imports
import logging
import unittest

# bsie imports
from bsie import base
from bsie.base import errors
from bsie.utils.bsfs import URI

# objects to test
from bsie.tools.builder import ExtractorBuilder
from bsie.tools.builder import PipelineBuilder
from bsie.tools.builder import ReaderBuilder
from bsie.tools.builder import _safe_load
from bsie.tools.builder import _unpack_name


## code ##

class TestUtils(unittest.TestCase):
    def test_safe_load(self):
        # invalid module
        self.assertRaises(errors.LoaderError, _safe_load, 'dBGHMSAYOoKeKMpywDoKZQycENFPvN', 'foobar')
        self.assertRaises(errors.LoaderError, _safe_load, 'dBGHMSAYOoKeKMpywDoKZQycENFPvN.bar', 'foobar')
        # partially valid module
        self.assertRaises(errors.LoaderError, _safe_load, 'os.foo', 'foobar')
        # invalid class
        self.assertRaises(errors.LoaderError, _safe_load, 'os.path', 'foo')
        # valid module and class
        cls = _safe_load('collections.abc', 'Container')
        import collections.abc
        self.assertEqual(cls, collections.abc.Container)

    def test_unpack_name(self):
        self.assertRaises(TypeError, _unpack_name, 123)
        self.assertRaises(TypeError, _unpack_name, None)
        self.assertRaises(ValueError, _unpack_name, '')
        self.assertRaises(ValueError, _unpack_name, 'path')
        self.assertRaises(ValueError, _unpack_name, '.Path')
        self.assertEqual(_unpack_name('path.Path'), ('path', 'Path'))
        self.assertEqual(_unpack_name('path.foo.bar.Path'), ('path.foo.bar', 'Path'))


class TestReaderBuilder(unittest.TestCase):
    def test_build(self):
        builder = ReaderBuilder({'bsie.reader.path.Path': {}})
        # build configured reader
        cls = builder.build('bsie.reader.path.Path')
        import bsie.reader.path
        self.assertIsInstance(cls, bsie.reader.path.Path)
        # build unconfigured reader
        cls = builder.build('bsie.reader.stat.Stat')
        import bsie.reader.stat
        self.assertIsInstance(cls, bsie.reader.stat.Stat)
        # re-build previous reader (test cache)
        self.assertEqual(cls, builder.build('bsie.reader.stat.Stat'))
        # test invalid
        self.assertRaises(TypeError, builder.build, 123)
        self.assertRaises(TypeError, builder.build, None)
        self.assertRaises(ValueError, builder.build, '')
        self.assertRaises(ValueError, builder.build, 'Path')
        self.assertRaises(errors.BuilderError, builder.build, 'path.Path')
        # invalid config
        builder = ReaderBuilder({'bsie.reader.stat.Stat': dict(foo=123)})
        self.assertRaises(errors.BuilderError, builder.build, 'bsie.reader.stat.Stat')
        builder = ReaderBuilder({'bsie.reader.stat.Stat': 123})
        self.assertRaises(TypeError, builder.build, 'bsie.reader.stat.Stat')
        # no instructions
        builder = ReaderBuilder({})
        cls = builder.build('bsie.reader.stat.Stat')
        self.assertIsInstance(cls, bsie.reader.stat.Stat)



class TestExtractorBuilder(unittest.TestCase):
    def test_iter(self):
        # no specifications
        self.assertListEqual(list(ExtractorBuilder([])), [])
        # some specifications
        builder = ExtractorBuilder([
            {'bsie.extractor.generic.path.Path': {}},
            {'bsie.extractor.generic.stat.Stat': {}},
            {'bsie.extractor.generic.path.Path': {}},
            ])
        self.assertListEqual(list(builder), [0, 1, 2])

    def test_build(self):
        # simple and repeated extractors
        builder = ExtractorBuilder([
            {'bsie.extractor.generic.path.Path': {}},
            {'bsie.extractor.generic.stat.Stat': {}},
            {'bsie.extractor.generic.path.Path': {}},
            ])
        ext = [builder.build(0), builder.build(1), builder.build(2)]
        import bsie.extractor.generic.path
        import bsie.extractor.generic.stat
        self.assertListEqual(ext, [
            bsie.extractor.generic.path.Path(),
            bsie.extractor.generic.stat.Stat(),
            bsie.extractor.generic.path.Path(),
            ])
        # out-of-bounds raises KeyError
        self.assertRaises(IndexError, builder.build, 3)

        # building with args
        builder = ExtractorBuilder([
            {'bsie.extractor.generic.constant.Constant': {
                'schema': '''
                    bse:author rdfs:subClassOf bsfs:Predicate ;
                        rdfs:domain bsfs:Entity ;
                        rdfs:range xsd:string ;
                        owl:maxCardinality "1"^^xsd:number .
                    bse:rating rdfs:subClassOf bsfs:Predicate ;
                        rdfs:domain bsfs:Entity ;
                        rdfs:range xsd:integer ;
                        owl:maxCardinality "1"^^xsd:number .
                    ''',
                'tuples': [
                    ('http://bsfs.ai/schema/Entity#author', 'Me, myself, and I'),
                    ('http://bsfs.ai/schema/Entity#rating', 123),
                    ],
            }}])
        obj = builder.build(0)
        import bsie.extractor.generic.constant
        self.assertEqual(obj, bsie.extractor.generic.constant.Constant('''
                    bse:author rdfs:subClassOf bsfs:Predicate ;
                        rdfs:domain bsfs:Entity ;
                        rdfs:range xsd:string ;
                        owl:maxCardinality "1"^^xsd:number .
                    bse:rating rdfs:subClassOf bsfs:Predicate ;
                        rdfs:domain bsfs:Entity ;
                        rdfs:range xsd:integer ;
                        owl:maxCardinality "1"^^xsd:number .
                    ''', [
            ('http://bsfs.ai/schema/Entity#author', 'Me, myself, and I'),
            ('http://bsfs.ai/schema/Entity#rating', 123),
            ]))

        # building with invalid args
        self.assertRaises(errors.BuilderError, ExtractorBuilder(
            [{'bsie.extractor.generic.path.Path': {'foo': 123}}]).build, 0)
        # non-dict build specification
        self.assertRaises(TypeError, ExtractorBuilder(
            [('bsie.extractor.generic.path.Path', {})]).build, 0)
        # multiple keys per build specification
        self.assertRaises(TypeError, ExtractorBuilder(
            [{'bsie.extractor.generic.path.Path': {},
              'bsie.extractor.generic.stat.Stat': {}}]).build, 0)
        # non-dict value for kwargs
        self.assertRaises(TypeError, ExtractorBuilder(
            [{'bsie.extractor.generic.path.Path': 123}]).build, 0)




class TestPipelineBuilder(unittest.TestCase):
    def test_build(self):
        prefix = URI('http://example.com/local/file#')
        c_schema = '''
            bse:author rdfs:subClassOf bsfs:Predicate ;
                rdfs:domain bsfs:Entity ;
                rdfs:range xsd:string ;
                owl:maxCardinality "1"^^xsd:number .
            '''
        c_tuples = [('http://bsfs.ai/schema/Entity#author', 'Me, myself, and I')]
        # prepare builders
        rbuild = ReaderBuilder({})
        ebuild = ExtractorBuilder([
            {'bsie.extractor.generic.path.Path': {}},
            {'bsie.extractor.generic.stat.Stat': {}},
            {'bsie.extractor.generic.constant.Constant': dict(
                schema=c_schema,
                tuples=c_tuples,
                )},
            ])
        # build pipeline
        builder = PipelineBuilder(prefix, rbuild, ebuild)
        pipeline = builder.build()
        # delayed import
        import bsie.reader.path
        import bsie.reader.stat
        import bsie.extractor.generic.path
        import bsie.extractor.generic.stat
        import bsie.extractor.generic.constant
        # check pipeline
        self.assertDictEqual(pipeline._ext2rdr, {
            bsie.extractor.generic.path.Path(): bsie.reader.path.Path(),
            bsie.extractor.generic.stat.Stat(): bsie.reader.stat.Stat(),
            bsie.extractor.generic.constant.Constant(c_schema, c_tuples): None,
            })

        # fail to load extractor
        ebuild_err = ExtractorBuilder([
            {'bsie.extractor.generic.foo.Foo': {}},
            {'bsie.extractor.generic.path.Path': {}},
            ])
        with self.assertLogs(logging.getLogger('bsie.tools.builder'), logging.ERROR):
            pipeline = PipelineBuilder(prefix, rbuild, ebuild_err).build()
            self.assertDictEqual(pipeline._ext2rdr, {
                bsie.extractor.generic.path.Path(): bsie.reader.path.Path()})

        # fail to build extractor
        ebuild_err = ExtractorBuilder([
            {'bsie.extractor.generic.path.Path': {'foo': 123}},
            {'bsie.extractor.generic.path.Path': {}},
            ])
        with self.assertLogs(logging.getLogger('bsie.tools.builder'), logging.ERROR):
            pipeline = PipelineBuilder(prefix, rbuild, ebuild_err).build()
            self.assertDictEqual(pipeline._ext2rdr, {
                bsie.extractor.generic.path.Path(): bsie.reader.path.Path()})

        # fail to load reader
        with self.assertLogs(logging.getLogger('bsie.tools.builder'), logging.ERROR):
            # switch reader of an extractor
            old_reader = bsie.extractor.generic.path.Path.CONTENT_READER
            bsie.extractor.generic.path.Path.CONTENT_READER = 'bsie.reader.foo.Foo'
            # build pipeline with invalid reader reference
            pipeline = PipelineBuilder(prefix, rbuild, ebuild).build()
            self.assertDictEqual(pipeline._ext2rdr, {
                bsie.extractor.generic.stat.Stat(): bsie.reader.stat.Stat(),
                bsie.extractor.generic.constant.Constant(c_schema, c_tuples): None,
                })
            # switch back
            bsie.extractor.generic.path.Path.CONTENT_READER = old_reader

        # fail to build reader
        rbuild_err = ReaderBuilder({'bsie.reader.stat.Stat': dict(foo=123)})
        with self.assertLogs(logging.getLogger('bsie.tools.builder'), logging.ERROR):
            pipeline = PipelineBuilder(prefix, rbuild_err, ebuild).build()
            self.assertDictEqual(pipeline._ext2rdr, {
                bsie.extractor.generic.path.Path(): bsie.reader.path.Path(),
                bsie.extractor.generic.constant.Constant(c_schema, c_tuples): None,
                })


## main ##

if __name__ == '__main__':
    unittest.main()

## EOF ##