aboutsummaryrefslogtreecommitdiffstats
path: root/test/query/test_validator.py
blob: dc9d91323f43d422f5850d88951cffb413e483e9 (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
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
"""

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

# bsfs imports
from bsfs import schema as _schema
from bsfs.namespace import ns
from bsfs.query import ast
from bsfs.utils import errors

# objects to test
from bsfs.query.validator import Filter


## code ##

class TestFilter(unittest.TestCase):
    def setUp(self):
        self.schema = _schema.from_string('''
            prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#>
            prefix xsd: <http://www.w3.org/2001/XMLSchema#>

            prefix bsfs: <http://bsfs.ai/schema/>
            prefix bse: <http://bsfs.ai/schema/Entity#>

            bsfs:Entity rdfs:subClassOf bsfs:Node .
            bsfs:URI rdfs:subClassOf bsfs:Literal .

            bsfs:Tag rdfs:subClassOf bsfs:Node .
            xsd:string rdfs:subClassOf bsfs:Literal .
            bsfs:Number rdfs:subClassOf bsfs:Literal .
            bsfs:Array rdfs:subClassOf bsfs:Literal .
            bsfs:Feature rdfs:subClassOf bsfs:Array .
            xsd:integer rdfs:subClassOf bsfs:Number .

            bsfs:Colors rdfs:subClassOf bsfs:Feature ;
                bsfs:dimension "5"^^xsd:integer ;
                bsfs:dtype bsfs:f32 .

            bse:color rdfs:subClassOf bsfs:Predicate ;
                rdfs:domain bsfs:Node ;
                rdfs:range bsfs:Colors ;
                bsfs:unique "true"^^xsd:boolean .

            bse:comment rdfs:subClassOf bsfs:Predicate ;
                rdfs:domain bsfs:Node ;
                rdfs:range xsd:string ;
                bsfs:unique "false"^^xsd:boolean .

            bse:filesize rdfs:subClassOf bsfs:Predicate ;
                rdfs:domain bsfs:Entity ;
                rdfs:range xsd:integer ;
                bsfs:unique "true"^^xsd:boolean .

            bse:tag rdfs:subClassOf bsfs:Predicate ;
                rdfs:domain bsfs:Entity ;
                rdfs:range bsfs:Tag ;
                bsfs:unique "false"^^xsd:boolean .

            bse:label rdfs:subClassOf bsfs:Predicate ;
                rdfs:domain bsfs:Tag ;
                rdfs:range xsd:string ;
                bsfs:unique "true"^^xsd:boolean .

            bse:buddy rdfs:subClassOf bsfs:Predicate ;
                rdfs:domain bsfs:Entity ;
                rdfs:range bsfs:Node ;
                bsfs:unique "false"^^xsd:boolean .

            ''')
        self.validate = Filter(self.schema)

    def test_call(self):
        # root_type must be a _schema.Node
        self.assertRaises(TypeError, self.validate, 1234, None)
        self.assertRaises(TypeError, self.validate, '1234', None)
        self.assertRaises(TypeError, self.validate, self.schema.literal(ns.bsfs.URI), None)
        # root_type must exist in the schema
        self.assertRaises(errors.ConsistencyError, self.validate, self.schema.node(ns.bsfs.Node).child(ns.bsfs.Image), None)
        self.assertRaises(errors.ConsistencyError, self.validate, self.schema.node(ns.bsfs.Entity).child(ns.bsfs.Image), None)
        # valid query returns true
        self.assertTrue(self.validate(self.schema.node(ns.bsfs.Entity),
            ast.filter.Any(ast.filter.OneOf(ns.bse.tag, ns.bse.buddy),
                ast.filter.Or(
                    ast.filter.Is('http://example.com/symbol#1234'),
                    ast.filter.All(ns.bse.comment, ast.filter.StartsWith('foo')),
                    ast.filter.And(
                        ast.filter.Has(ns.bse.comment, ast.filter.Or(
                            ast.filter.GreaterThan(5),
                            ast.filter.LessThan(1),
                            )
                        ),
                        ast.filter.Not(ast.filter.Any(ns.bse.comment,
                            ast.filter.Not(ast.filter.Equals('hello world')))),
                    ast.filter.Any(ns.bse.color, ast.filter.Distance([1,2,3,4,5], 3)),
                    )))))
        # invalid paths raise consistency error
        self.assertRaises(errors.ConsistencyError, self.validate, self.schema.node(ns.bsfs.Entity),
            ast.filter.Any(ast.filter.OneOf(ns.bse.tag, ns.bse.buddy),
            ast.filter.Or(
                ast.filter.All(ns.bse.comment, ast.filter.Equals('hello world')),
                ast.filter.All(ns.bse.label, ast.filter.Equals('hello world')), # domain mismatch
                )))

    def test_routing(self):
        self.assertRaises(errors.BackendError, self.validate._parse_filter_expression, ast.filter.FilterExpression(), self.schema.node(ns.bsfs.Node))
        self.assertRaises(errors.BackendError, self.validate._parse_predicate_expression, ast.filter.PredicateExpression())

    def test_predicate(self):
        # predicate must be in the schema
        self.assertRaises(errors.ConsistencyError, self.validate._predicate, ast.filter.Predicate(ns.bse.invalid))
        # predicate must have a range
        self.assertRaises(errors.BackendError, self.validate._predicate, ast.filter.Predicate(ns.bsfs.Predicate))
        # predicate returns domain and range
        self.assertEqual(self.validate._predicate(ast.filter.Predicate(ns.bse.tag)),
            (self.schema.node(ns.bsfs.Entity), self.schema.node(ns.bsfs.Tag)))
        # reverse is applied
        self.assertEqual(self.validate._predicate(ast.filter.Predicate(ns.bse.tag, reverse=True)),
            (self.schema.node(ns.bsfs.Tag), self.schema.node(ns.bsfs.Entity)))

    def test_one_of(self):
        # domains must both be nodes or literals
        self.assertRaises(errors.ConsistencyError, self.validate._one_of, ast.filter.OneOf(ns.bse.tag, ast.filter.Predicate(ns.bse.label, reverse=True)))
        # domains must be related
        self.assertRaises(errors.ConsistencyError, self.validate._one_of, ast.filter.OneOf(ns.bse.tag, ns.bse.label))
        # ranges must both be nodes or literals
        self.assertRaises(errors.ConsistencyError, self.validate._one_of, ast.filter.OneOf(ns.bse.tag, ns.bse.comment))
        # ranges must be related
        self.assertRaises(errors.ConsistencyError, self.validate._one_of, ast.filter.OneOf(ns.bse.tag, ast.filter.Predicate(ns.bse.buddy, reverse=True)))
        # one_of returns most specific domain
        self.assertEqual(self.validate._one_of(ast.filter.OneOf(ns.bse.comment, ns.bse.label)),
            (self.schema.node(ns.bsfs.Tag), self.schema.literal(ns.xsd.string)))
        # one_of returns the most generic range
        self.assertEqual(self.validate._one_of(ast.filter.OneOf(ns.bse.tag, ns.bse.buddy)),
            (self.schema.node(ns.bsfs.Entity), self.schema.node(ns.bsfs.Node)))

    def test_branch(self):
        # type must be a node
        self.assertRaises(errors.ConsistencyError, self.validate._branch, self.schema.literal(ns.bsfs.Literal), None)
        # type must be in the schema
        self.assertRaises(errors.ConsistencyError, self.validate._branch, self.schema.node(ns.bsfs.Node).child(ns.bsfs.Invalid), None)
        # predicate is verified
        self.assertRaises(errors.ConsistencyError, self.validate._branch, self.schema.node(ns.bsfs.Entity),
            ast.filter.Any(ns.bsfs.Invalid, ast.filter.Is('http://example.com/entity#1234')))
        # predicate must match the domain
        self.assertRaises(errors.ConsistencyError, self.validate._branch, self.schema.node(ns.bsfs.Node),
            ast.filter.Any(ns.bse.tag, ast.filter.Is('http://example.com/tag#1234')))
        self.assertRaises(errors.ConsistencyError, self.validate._branch, self.schema.node(ns.bsfs.Tag),
            ast.filter.Any(ns.bse.tag, ast.filter.Is('http://example.com/tag#1234')))
        # child expression must be valid
        self.assertRaises(errors.ConsistencyError, self.validate._branch, self.schema.node(ns.bsfs.Entity),
            ast.filter.Any(ns.bse.tag, ast.filter.Equals('hello world')))
        # branch accepts valid expressions
        self.assertIsNone(self.validate._branch(self.schema.node(ns.bsfs.Entity),
            ast.filter.Any(ns.bse.tag, ast.filter.Is('http://example.com/entity#1234'))))
        self.assertIsNone(self.validate._branch(self.schema.node(ns.bsfs.Entity),
            ast.filter.All(ns.bse.tag, ast.filter.Is('http://example.com/entity#1234'))))

    def test_agg(self):
        # agg evaluates child expressions
        self.assertRaises(errors.ConsistencyError, self.validate._agg, self.schema.node(ns.bsfs.Entity),
            ast.filter.And(ast.filter.Is('http://example.com/entity#1234'), ast.filter.Equals('hello world')))
        self.assertRaises(errors.ConsistencyError, self.validate._agg, self.schema.literal(ns.xsd.string),
            ast.filter.And(ast.filter.Is('http://example.com/entity#1234'), ast.filter.Equals('hello world')))
        self.assertRaises(errors.ConsistencyError, self.validate._agg, self.schema.node(ns.bsfs.Entity),
            ast.filter.Or(ast.filter.Is('http://example.com/entity#1234'), ast.filter.Equals('hello world')))
        self.assertRaises(errors.ConsistencyError, self.validate._agg, self.schema.literal(ns.xsd.string),
            ast.filter.Or(ast.filter.Is('http://example.com/entity#1234'), ast.filter.Equals('hello world')))
        # agg works on nodes
        self.assertIsNone(self.validate._agg(self.schema.node(ns.bsfs.Entity),
            ast.filter.And(ast.filter.Is('http://example.com/entity#1234'), ast.filter.Is('http://example.com/entity#4321'))))
        self.assertIsNone(self.validate._agg(self.schema.node(ns.bsfs.Entity),
            ast.filter.Or(ast.filter.Is('http://example.com/entity#1234'), ast.filter.Is('http://example.com/entity#4321'))))
        # agg works on literals
        self.assertIsNone(self.validate._agg(self.schema.literal(ns.xsd.string),
            ast.filter.And(ast.filter.Equals('foobar'), ast.filter.Equals('hello world'))))
        self.assertIsNone(self.validate._agg(self.schema.literal(ns.xsd.string),
            ast.filter.Or(ast.filter.Equals('foobar'), ast.filter.Equals('hello world'))))

    def test_not(self):
        # not evaluates child expressions
        self.assertRaises(errors.ConsistencyError, self.validate._not, self.schema.node(ns.bsfs.Entity),
            ast.filter.Not(ast.filter.Equals('hello world')))
        self.assertRaises(errors.ConsistencyError, self.validate._not, self.schema.literal(ns.xsd.string),
            ast.filter.Not(ast.filter.Is('http://example.com/entity#1234')))
        # not works on nodes
        self.assertIsNone(self.validate._not(self.schema.node(ns.bsfs.Entity),
            ast.filter.Not(ast.filter.Is('http://example.com/entity#1234'))))
        # not works on literals
        self.assertIsNone(self.validate._not(self.schema.literal(ns.xsd.string),
            ast.filter.Not(ast.filter.Equals('hello world'))))

    def test_has(self):
        # type must be node
        self.assertRaises(errors.ConsistencyError, self.validate._has, self.schema.literal(ns.bsfs.Literal),
            ast.filter.Has(ns.bse.tag))
        # type must be in the schema
        self.assertRaises(errors.ConsistencyError, self.validate._has, self.schema.node(ns.bsfs.Node).child(ns.bsfs.Invalid),
            ast.filter.Has(ns.bse.tag))
        # has checks predicate
        self.assertRaises(errors.ConsistencyError, self.validate._has, self.schema.node(ns.bsfs.Entity),
            ast.filter.Has(ns.bse.invalid))
        # predicate must match domain
        self.assertRaises(errors.ConsistencyError, self.validate._has, self.schema.node(ns.bsfs.Tag),
            ast.filter.Has(ns.bse.tag))
        # has checks count expression
        self.assertRaises(errors.ConsistencyError, self.validate._has, self.schema.node(ns.bsfs.Entity),
            ast.filter.Has(ns.bse.tag, ast.filter.Is('http://example.com/entity#1234')))
        # has accepts correct expressions
        self.assertIsNone(self.validate._has(self.schema.node(ns.bsfs.Entity), ast.filter.Has(ns.bse.tag, ast.filter.GreaterThan(5))))

    def test_is(self):
        # type must be node
        self.assertRaises(errors.ConsistencyError, self.validate._is, self.schema.literal(ns.bsfs.Literal),
            ast.filter.Is('http://example.com/foo'))
        # type must be in the schema
        self.assertRaises(errors.ConsistencyError, self.validate._is, self.schema.node(ns.bsfs.Node).child(ns.bsfs.Invalid),
            ast.filter.Is('http://example.com/foo'))
        # is accepts correct expressions
        self.assertIsNone(self.validate._is(self.schema.node(ns.bsfs.Entity), ast.filter.Is('http://example.com/entity#1234')))

    def test_value(self):
        # type must be literal
        self.assertRaises(errors.ConsistencyError, self.validate._value, self.schema.node(ns.bsfs.Node),
            ast.filter.Equals('hello world'))
        self.assertRaises(errors.ConsistencyError, self.validate._value, self.schema.node(ns.bsfs.Node),
            ast.filter.Substring('hello world'))
        self.assertRaises(errors.ConsistencyError, self.validate._value, self.schema.node(ns.bsfs.Node),
            ast.filter.StartsWith('hello world'))
        self.assertRaises(errors.ConsistencyError, self.validate._value, self.schema.node(ns.bsfs.Node),
            ast.filter.EndsWith('hello world'))
        # type must be in the schema
        self.assertRaises(errors.ConsistencyError, self.validate._value, self.schema.literal(ns.bsfs.Literal).child(ns.bsfs.Invalid),
            ast.filter.Equals('hello world'))
        self.assertRaises(errors.ConsistencyError, self.validate._value, self.schema.literal(ns.bsfs.Literal).child(ns.bsfs.Invalid),
            ast.filter.Substring('hello world'))
        self.assertRaises(errors.ConsistencyError, self.validate._value, self.schema.literal(ns.bsfs.Literal).child(ns.bsfs.Invalid),
            ast.filter.StartsWith('hello world'))
        self.assertRaises(errors.ConsistencyError, self.validate._value, self.schema.literal(ns.bsfs.Literal).child(ns.bsfs.Invalid),
            ast.filter.EndsWith('hello world'))
        # value accepts correct expressions
        self.assertIsNone(self.validate._value(self.schema.literal(ns.xsd.string), ast.filter.Equals('hello world')))
        self.assertIsNone(self.validate._value(self.schema.literal(ns.xsd.string), ast.filter.Substring('hello world')))
        self.assertIsNone(self.validate._value(self.schema.literal(ns.xsd.string), ast.filter.StartsWith('hello world')))
        self.assertIsNone(self.validate._value(self.schema.literal(ns.xsd.string), ast.filter.EndsWith('hello world')))

    def test_bounded(self):
        # type must be literal
        self.assertRaises(errors.ConsistencyError, self.validate._bounded, self.schema.node(ns.bsfs.Node),
            ast.filter.GreaterThan(0))
        self.assertRaises(errors.ConsistencyError, self.validate._bounded, self.schema.node(ns.bsfs.Node),
            ast.filter.LessThan(0))
        # type must be in the schema
        self.assertRaises(errors.ConsistencyError, self.validate._bounded, self.schema.literal(ns.bsfs.Literal).child(ns.bsfs.Invalid),
            ast.filter.GreaterThan(0))
        self.assertRaises(errors.ConsistencyError, self.validate._bounded, self.schema.literal(ns.bsfs.Literal).child(ns.bsfs.Invalid),
            ast.filter.LessThan(0))
        # type must be a number
        self.assertRaises(errors.ConsistencyError, self.validate._bounded, self.schema.literal(ns.xsd.string),
            ast.filter.LessThan(0))
        # bounded accepts correct expressions
        self.assertIsNone(self.validate._bounded(self.schema.literal(ns.xsd.integer), ast.filter.LessThan(0)))
        self.assertIsNone(self.validate._bounded(self.schema.literal(ns.xsd.integer), ast.filter.GreaterThan(0)))

    def test_distance(self):
        # type must be a literal
        self.assertRaises(errors.ConsistencyError, self.validate._distance, self.schema.node(ns.bsfs.Node),
            ast.filter.Distance([1,2,3], 1, False))
        # type must be a feature
        self.assertRaises(errors.ConsistencyError, self.validate._distance, self.schema.literal(ns.bsfs.Array),
            ast.filter.Distance([1,2,3], 1, False))
        # type must be in the schema
        self.assertRaises(errors.ConsistencyError, self.validate._distance, self.schema.literal(ns.bsfs.Feature).child(ns.bsfs.Invalid),
            ast.filter.Distance([1,2,3], 1, False))
        # FIXME: reference must be a numpy array
        # reference must have the correct dimension
        self.assertRaises(errors.ConsistencyError, self.validate._distance, self.schema.literal(ns.bsfs.Colors),
            ast.filter.Distance([1,2,3], 1, False))
        # FIXME: reference must have the correct dtype
        # distance accepts correct expressions
        self.assertIsNone(self.validate._distance(self.schema.literal(ns.bsfs.Colors), ast.filter.Distance([1,2,3,4,5], 1, False)))


## main ##

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

## EOF ##