"""GJSON test module.""" import json import re from collections.abc import Mapping from math import isnan import gjson import pytest from gjson._gjson import MODIFIER_NAME_RESERVED_CHARS INPUT_JSON = """ { "name": {"first": "Tom", "last": "Anderson"}, "age":37, "children": ["Sara","Alex","Jack"], "fav.movie": "Deer Hunter", "friends": [ {"first": "Dale", "last": "Murphy", "age": 44, "nets": ["ig", "fb", "tw"]}, {"first": "Roger", "last": "Craig", "age": 68, "nets": ["fb", "tw"]}, {"first": "Jane", "last": "Murphy", "age": 47, "nets": ["ig", "tw"]} ] } """ INPUT_OBJECT = json.loads(INPUT_JSON) INPUT_LIST = json.loads(""" [ {"first": "Dale"}, {"first": "Jane"}, {"last": "Murphy"} ] """) INPUT_ESCAPE = json.loads(""" { "test": { "*":"valZ", "*v":"val0", "keyv*":"val1", "key*v":"val2", "keyv?":"val3", "key?v":"val4", "keyv.":"val5", "key.v":"val6", "keyk*":{"key?":"val7"}, "1key":"val8" } } """) # This json block is poorly formed on purpose. INPUT_BASIC = json.loads(""" {"age":100, "name2":{"here":"B\\\\\\"R"}, "noop":{"what is a wren?":"a bird"}, "happy":true,"immortal":false, "items":[1,2,3,{"tags":[1,2,3],"points":[[1,2],[3,4]]},4,5,6,7], "arr":["1",2,"3",{"hello":"world"},"4",5], "vals":[1,2,3],"name":{"first":"tom","last":null}, "created":"2014-05-16T08:28:06.989Z", "loggy":{ "programmers": [ { "firstName": "Brett", "lastName": "McLaughlin", "email": "aaaa", "tag": "good" }, { "firstName": "Jason", "lastName": "Hunter", "email": "bbbb", "tag": "bad" }, { "firstName": "Elliotte", "lastName": "Harold", "email": "cccc", "tag": "good" }, { "firstName": 1002.3, "age": 101 } ] }, "lastly":{"end...ing":"soon","yay":"final"} } """) INPUT_LINES = """ {"name": "Gilbert", "age": 61} {"name": "Alexa", "age": 34} {"name": "May", "age": 57} {"name": "Deloise", "age": 44} """ INPUT_LINES_WITH_ERRORS = """ {"name": "Gilbert", "age": 61} {invalid {invalid {"name": "Deloise", "age": 44} """ INPUT_TRUTHINESS = json.loads(""" { "vals": [ { "a": 1, "b": true }, { "a": 2, "b": true }, { "a": 3, "b": false }, { "a": 4, "b": "0" }, { "a": 5, "b": 0 }, { "a": 6, "b": "1" }, { "a": 7, "b": 1 }, { "a": 8, "b": "true" }, { "a": 9, "b": false }, { "a": 10, "b": null }, { "a": 11 } ] } """) INPUT_SUM_N = json.loads(""" [ {"key": "a", "value": 1, "other": "value"}, {"key": "b", "value": 2}, {"key": "c", "value": 3, "other": "value"}, {"key": "a", "value": 7}, {"key": "b", "value": 1.5}, {"key": "d", "value": 4}, {"key": "c", "value": 9} ] """) INPUT_NESTED_QUERIES = json.loads(""" { "key": [ {"level1": [{"level2": [{"level3": [1, 2]}]}]}, {"level1": [{"level2": [{"level3": [2, 3]}]}]}, [[{"level3": [1, 2]}], [{"level3": [2, 3]}]], [[{"level3": [2, 3]}], [{"level3": [3, 4]}]], {"another": [{"level2": [{"level3": [2, 3]}]}]}, {"level1": [{"another": [{"level3": [2, 3]}]}]}, {"level1": [{"level2": [{"another": [2, 3]}]}]}, [[{"another": [2, 3]}], [{"another": [3, 4]}]], "spurious", 12.34, {"mixed": [[{"level4": [1, 2]}]]} ] } """) def compare_values(result, expected): """Compare results with the expected values ensuring same-order of keys for dictionaries.""" if isinstance(expected, float) and isnan(expected): assert isnan(result) return assert result == expected if isinstance(expected, Mapping): assert list(result.keys()) == list(expected.keys()) class TestObject: """Testing gjson with a basic input object.""" def setup_method(self): """Initialize the test instance.""" def upper(options, obj, *, last): """Change the case of the object returning its upper version. Custom modifier to be used in tests.""" del options del last if isinstance(obj, list): return [i.upper() for i in obj] return obj.upper() self.object = gjson.GJSON(INPUT_OBJECT) self.object.register_modifier('upper', upper) @pytest.mark.parametrize(('query', 'expected'), ( # Basic ('name.last', 'Anderson'), ('name.first', 'Tom'), ('age', 37), ('children', ['Sara', 'Alex', 'Jack']), ('children.0', 'Sara'), ('children.1', 'Alex'), ('friends.1', {'first': 'Roger', 'last': 'Craig', 'age': 68, 'nets': ['fb', 'tw']}), ('friends.1.first', 'Roger'), # Wildcards ('*.first', 'Tom'), ('?a??.first', 'Tom'), ('child*.2', 'Jack'), ('c?ildren.0', 'Sara'), # Escape characters (r'fav\.movie', 'Deer Hunter'), # Arrays ('friends.#', 3), ('friends.#.age', [44, 68, 47]), ('friends.#.first', ['Dale', 'Roger', 'Jane']), ('friends.#.nets.0', ['ig', 'fb', 'ig']), # Queries ('friends.#(last=="Murphy").first', 'Dale'), ('friends.#(last=="Murphy")#.first', ['Dale', 'Jane']), ('friends.#(=="Murphy")#', []), ('friends.#(=="Mu)(phy")#', []), ('friends.#(=="Mur\tphy")#', []), ('friends.#(age\\===44)#', []), ('friends.#(age>47)#.last', ['Craig']), ('friends.#(age>=47)#.last', ['Craig', 'Murphy']), ('friends.#(age<47)#.last', ['Murphy']), ('friends.#(age<=47)#.last', ['Murphy', 'Murphy']), ('friends.#(age==44)#.last', ['Murphy']), ('friends.#(age!=44)#.last', ['Craig', 'Murphy']), ('friends.#(first%"D*").last', 'Murphy'), ('friends.#(first!%"D*").last', 'Craig'), ('friends.#(first!%"D???").last', 'Craig'), ('friends.#(%0)#', []), ('friends.#(>40)#', []), ('children.#(!%"*a*")', 'Alex'), ('children.#(%"*a*")#', ['Sara', 'Jack']), # Nested queries ('friends.#(nets.#(=="fb"))#.first', ['Dale', 'Roger']), # Modifiers ('children.@reverse', ['Jack', 'Alex', 'Sara']), ('children.@reverse.0', 'Jack'), ('name.@reverse', {'last': 'Anderson', 'first': 'Tom'}), ('age.@reverse', 37), ('@keys', ['name', 'age', 'children', 'fav.movie', 'friends']), ('name.@values', ['Tom', 'Anderson']), ('age.@flatten', 37), ('@pretty:{"indent": 4}', INPUT_OBJECT), (r'fav\.movie.@pretty:{"indent": 4}', 'Deer Hunter'), ('name.@tostr', '{"first": "Tom", "last": "Anderson"}'), ('name.@join', {'first': 'Tom', 'last': 'Anderson'}), ('age.@join', 37), ('children.@join', {}), ('children.0.@join', 'Sara'), ('friends.@join', {'first': 'Jane', 'last': 'Murphy', 'age': 47, 'nets': ['ig', 'tw']}), # Dot vs Pipe ('friends.0.first', 'Dale'), ('friends|0.first', 'Dale'), ('friends.0|first', 'Dale'), ('friends|0|first', 'Dale'), ('friends|#', 3), ('friends.#(last="Murphy")#', [{'first': 'Dale', 'last': 'Murphy', 'age': 44, 'nets': ['ig', 'fb', 'tw']}, {'first': 'Jane', 'last': 'Murphy', 'age': 47, 'nets': ['ig', 'tw']}]), ('friends.#(last="Murphy")#.first', ['Dale', 'Jane']), ('friends.#(last="Murphy")#.0', []), ('friends.#(last="Murphy")#|0', {'first': 'Dale', 'last': 'Murphy', 'age': 44, 'nets': ['ig', 'fb', 'tw']}), ('friends.#(last="Murphy")#.#', []), ('friends.#(last="Murphy")#|#', 2), # Multipaths objects ('{}', {}), ('{.}', {}), ('{.invalid}', {}), ('{.invalid,}', {}), ('{age}', {'age': 37}), (r'{a\ge}', {r'a\ge': 37}), (r'{"a\\ge":age}', {r'a\ge': 37}), ('{"a\tb":age}', {'a\tb': 37}), ('{"key":age}', {'key': 37}), ('{age,age}', {'age': 37}), ('{age,"years":age}', {'age': 37, 'years': 37}), ('{"years":age,age}', {'years': 37, 'age': 37}), ('{age,name.first}', {'age': 37, 'first': 'Tom'}), ('{invalid,invalid.invalid,age}', {'age': 37}), ('{name.first,age,name.last}', {'first': 'Tom', 'age': 37, 'last': 'Anderson'}), ('{{age}}', {'_': {'age': 37}}), ('{{age},age}', {'_': {'age': 37}, 'age': 37}), ('friends.0.{age,nets.#(="ig")}', {'age': 44, '_': 'ig'}), ('friends.0.{age,nets.#(="ig"),invalid}', {'age': 44, '_': 'ig'}), ('friends.0.{age,nets.#(="ig")#}', {'age': 44, '_': ['ig']}), ('friends.#.{age,"key":first}', [{'age': 44, 'key': 'Dale'}, {'age': 68, 'key': 'Roger'}, {'age': 47, 'key': 'Jane'}]), ('friends.#(age>44)#.{age,"key":first}', [{'age': 68, 'key': 'Roger'}, {'age': 47, 'key': 'Jane'}]), ('friends.#(age>44)#.{age,"key":first,invalid}', [{'age': 68, 'key': 'Roger'}, {'age': 47, 'key': 'Jane'}]), (r'{age,name.first,fav\.movie}', {'age': 37, 'first': 'Tom', r'fav\.movie': 'Deer Hunter'}), ('{age,name.{"name":first,"surname":last},children.@sort}', {'age': 37, '_': {'name': 'Tom', 'surname': 'Anderson'}, '@sort': ['Alex', 'Jack', 'Sara']}), ('friends.{0.first,1.last,2.age}.@values', ['Dale', 'Craig', 47]), ('{friends.{"a":0.{nets.{0}}}}', {'_': {'a': {'_': {'0': 'ig'}}}}), ('{friends.{"a":0.{nets.{0,1}}}}', {'_': {'a': {'_': {'0': 'ig', '1': 'fb'}}}}), ('friends.#.{age,first|@upper}', [{'age': 44, '@upper': 'DALE'}, {'age': 68, '@upper': 'ROGER'}, {'age': 47, '@upper': 'JANE'}]), ('{friends.#.{age,"first":first|@upper}|0.first}', {'first': 'DALE'}), ('{"children":children|@upper,"name":name.first,"age":age}', {'children': ['SARA', 'ALEX', 'JACK'], 'name': 'Tom', 'age': 37}), ('friends.#.{age,"first":first.invalid}', [{'age': 44}, {'age': 68}, {'age': 47}]), # Multipaths arrays ('[]', []), ('[.]', []), ('[.invalid]', []), ('[.invalid,]', []), ('[age]', [37]), (r'[a\ge]', [37]), ('[age,age]', [37, 37]), ('[age,name.first]', [37, 'Tom']), ('[name.first,age,invalid,invalid.invalid,name.last]', ['Tom', 37, 'Anderson']), ('[[age]]', [[37]]), ('[[age],age]', [[37], 37]), ('friends.0.[age,nets.#(="ig")]', [44, 'ig']), ('friends.0.[age,nets.#(="ig"),invalid]', [44, 'ig']), ('friends.0.[age,nets.#(="ig")#]', [44, ['ig']]), ('friends.#.[age,first]', [[44, 'Dale'], [68, 'Roger'], [47, 'Jane']]), ('friends.#(age>44)#.[age,first]', [[68, 'Roger'], [47, 'Jane']]), ('friends.#(age>44)#.[age,invalid,invalid.invalid,first]', [[68, 'Roger'], [47, 'Jane']]), (r'[age,name.first,fav\.movie]', [37, 'Tom', 'Deer Hunter']), ('[age,name.[first,last],children.@sort]', [37, ['Tom', 'Anderson'], ['Alex', 'Jack', 'Sara']]), ('friends.[0.first,1.last,2.age]', ['Dale', 'Craig', 47]), ('[friends.[0.[nets.[0]]]]', [[[['ig']]]]), ('[friends.[0.[nets.[0,1]]]]', [[[['ig', 'fb']]]]), # Multipaths mixed ('[{}]', [{}]), ('{[]}', {'_': []}), ('[{},[],{}]', [{}, [], {}]), ('{"a":[]}', {'a': []}), ('[{age},{name.first}]', [{'age': 37}, {'first': 'Tom'}]), ('{friends.0.[age,nets.#(="ig")]}', {'_': [44, 'ig']}), ('{friends.0.[age,nets.#(="ig")],age}', {'_': [44, 'ig'], 'age': 37}), ('{friends.0.[invalid,nets.#(="ig")],age,invalid}', {'_': ['ig'], 'age': 37}), # Literals ('!true', True), ('!false', False), ('!null', None), ('!NaN', float('nan')), ('!Infinity', float('inf')), ('!-Infinity', float('-inf')), ('!"key"', 'key'), ('!"line \\"quotes\\""', 'line "quotes"'), ('!"a\tb"', 'a\tb'), ('!0', 0), ('!12', 12), ('!-12', -12), ('!12.34', 12.34), ('!12.34E2', 1234), ('!12.34E+2', 1234), ('!12.34e-2', 0.1234), ('!-12.34e-2', -0.1234), ('friends.#.!"value"', ['value', 'value', 'value']), ('friends.#.!invalid', []), ('friends.#|!"value"', 'value'), ('friends.#(age>45)#.!"value"', ['value', 'value']), ('name|!"value"', 'value'), ('!{}', {}), ('![]', []), ('!{"name":{"first":"Tom"}}.{name.first}.first', 'Tom'), ('{name.last,"key":!"value"}', {'last': 'Anderson', 'key': 'value'}), ('{name.last,"key":!{"a":"b"},"invalid"}', {'last': 'Anderson', 'key': {'a': 'b'}}), ('{name.last,"key":!{"c":"d"},!"valid"}', {'last': 'Anderson', 'key': {'c': 'd'}, '_': 'valid'}), ('[!true,!false,!null,!Infinity,!invalid,{"name":!"andy",name.last},+Infinity,!["value1","value2"]]', [True, False, None, float('inf'), {'name': 'andy', 'last': 'Anderson'}, ['value1', 'value2']]), ('[!12.34,!-12.34e-2,!true]', [12.34, -0.1234, True]), )) def test_get_ok(self, query, expected): """It should query the JSON object and return the expected result.""" compare_values(self.object.get(query), expected) @pytest.mark.parametrize(('query', 'error'), ( # Basic ('.', 'Invalid query starting with a path delimiter.'), ('|', 'Invalid query starting with a path delimiter.'), ('.name', 'Invalid query starting with a path delimiter.'), ('|age', 'Invalid query starting with a path delimiter.'), ('name..first', 'Invalid query with two consecutive path delimiters.'), ('name||first', 'Invalid query with two consecutive path delimiters.'), ('name.|first', 'Invalid query with two consecutive path delimiters.'), ('name|.first', 'Invalid query with two consecutive path delimiters.'), ('age.0', "Integer query part on unsupported object type "), ('friends.99', 'Index `99` out of range for sequence object with 3 items in query.'), ('name.nonexistent', 'Mapping object does not have key `nonexistent`.'), ('name.1', 'Mapping object does not have key `1`.'), ('children.invalid', 'Invalid or unsupported query part `invalid`.'), ('children.', 'Delimiter at the end of the query.'), ('children\\', 'Escape character at the end of the query.'), # Wildcards ('x*', 'No key matching pattern with wildcard `x*`'), ('??????????', 'No key matching pattern with wildcard `??????????`'), ('children.x*', "Wildcard matching key `x*` requires a mapping object, got instead."), ('(-?', 'No key matching pattern with wildcard `(-?`'), # Queries ('#', "Expected a sequence like object for query part # at the end of the query, got ."), ('#.invalid', 'Invalid or unsupported query part `invalid`.'), ('friends.#(=="Murphy")', 'Query on mapping like objects require a key before the operator.'), ('friends.#(last=={1: 2})', 'Invalid value `{1: 2}` for the query key `last`'), ('friends.#(invalid', 'Unbalanced parentheses `(`, 1 still opened.'), ('#(first)', 'Queries are supported only for sequence like objects'), ('friends.#(invalid)', 'Query for first element does not match anything.'), ('friends.#(last=="invalid")', 'Query for first element does not match anything.'), ('friends.#(first%"D?")', 'Query for first element does not match anything.'), ('friends.#(last=="Murphy")invalid', 'Expected delimiter or end of query after closing parenthesis.'), ('children.#()', 'Empty or invalid query.'), ('children.#()#', 'Empty or invalid query.'), ('friends.#.invalid.#()', 'Empty or invalid query.'), ('friends.#.invalid.#()#', 'Empty or invalid query.'), # Dot vs Pipe ('friends.#(last="Murphy")#|first', 'Invalid or unsupported query'), # Modifiers ('@', 'Got empty modifier name.'), ('friends.@', 'Got empty modifier name.'), ('friends.@pretty:', 'Modifier with options separator `:` without any option.'), ('friends.@pretty:{invalid', 'Unable to load modifier options.'), ('friends.@pretty:["invalid"]', 'Expected JSON object `{...}` as modifier options.'), ('friends.@invalid', 'Unknown modifier @invalid.'), ('friends.@in"valid', 'Invalid modifier name @in"valid, the following characters are not allowed'), # JSON Lines ('..name', 'Invalid query starting with a path delimiter.'), # Multipaths (r'{"a\ge":age}', r'Failed to parse multipaths key "a\ge"'), ('{"age",age}', 'Expected colon after multipaths item with key "age".'), ('{]', 'Unbalanced parentheses `{`, 1 still opened.'), ('{', 'Unbalanced parentheses `{`, 1 still opened.'), ('{}@pretty', 'Expected delimiter or end of query after closing parenthesis.'), ('[{age}}]', 'Missing separator after multipath.'), ('{[age]]}', 'Missing separator after multipath.'), ('[{age,name.first]},age]', 'Expected delimiter or end of query after closing parenthesis.'), # Literals ('!', 'Unable to load literal JSON'), ('name.!', 'Unable to load literal JSON'), ('!invalid', 'Unable to load literal JSON'), (r'!in\valid', 'Unable to load literal JSON'), ('!0.a', 'Invalid or unsupported query part `a`.'), ('!0.1ea', 'Invalid or unsupported query part `ea`.'), ('!-12.', 'Delimiter at the end of the query.'), ('!-12.e', 'Invalid or unsupported query part `e`.'), ('name.!invalid', 'Unable to load literal JSON'), ('!"invalid', 'Unable to find end of literal string.'), ('friends.#|!invalid', 'Unable to load literal JSON'), ('!{true,', 'Unbalanced parentheses `{`, 1 still opened.'), ('![true,', 'Unbalanced parentheses `[`, 1 still opened.'), ('!"value".invalid', 'Invalid or unsupported query part `invalid`.'), ('name.!"value"', 'Unable to load literal JSON: literal afer a dot delimiter.'), )) def test_get_parser_raise(self, query, error): """It should raise a GJSONParseError error with the expected message.""" with pytest.raises(gjson.GJSONParseError, match=fr'^{re.escape(error)}'): self.object.get(query) @pytest.mark.parametrize(('query', 'error'), ( # Basic ('', 'Empty query.'), # Modifiers ('children.@keys', 'The current object does not have a keys() method.'), ('children.@values', 'The current object does not have a values() method.'), ('age.@group', "Modifier @group got object of type as input, expected dictionary."), ('children.@group', "Modifier @group got object of type as input, expected dictionary."), )) def test_get_raise(self, query, error): """It should raise a GJSONError error with the expected message.""" with pytest.raises(gjson.GJSONError, match=fr'^{re.escape(error)}'): self.object.get(query) class TestEscape: """Test gjson for all the escape sequences.""" def setup_method(self): """Initialize the test instance.""" self.escape = gjson.GJSON(INPUT_ESCAPE) @pytest.mark.parametrize(('query', 'expected'), ( (r'test.\*', 'valZ'), (r'test.\*v', 'val0'), (r'test.keyv\*', 'val1'), (r'test.key\*v', 'val2'), (r'test.keyv\?', 'val3'), (r'test.key\?v', 'val4'), (r'test.keyv\.', 'val5'), (r'test.key\.v', 'val6'), (r'test.keyk\*.key\?', 'val7'), ('test.1key', 'val8'), )) def test_get_ok(self, query, expected): """It should query the escape test JSON and return the expected result.""" assert self.escape.get(query, quiet=True) == expected class TestBasic: """Test gjson for basic queries.""" def setup_method(self): """Initialize the test instance.""" self.basic = gjson.GJSON(INPUT_BASIC) @pytest.mark.parametrize(('query', 'expected'), ( ('loggy.programmers.#(age=101).firstName', 1002.3), ('loggy.programmers.#(firstName != "Brett").firstName', 'Jason'), ('loggy.programmers.#(firstName % "Bre*").email', 'aaaa'), ('loggy.programmers.#(firstName !% "Bre*").email', 'bbbb'), ('loggy.programmers.#(firstName == "Brett").email', 'aaaa'), ('loggy.programmers.#.firstName', ['Brett', 'Jason', 'Elliotte', 1002.3]), ('loggy.programmers.#.asd', []), ('items.3.tags.#', 3), ('items.3.points.1.#', 2), ('items.#', 8), ('vals.#', 3), ('name2.here', r'B\"R'), ('arr.#', 6), ('arr.3.hello', 'world'), ('name.first', 'tom'), ('name.last', None), ('age', 100), ('happy', True), ('immortal', False), ('noop', {'what is a wren?': 'a bird'}), # Modifiers ('arr.@join', {'hello': 'world'}), )) def test_get_ok(self, query, expected): """It should query the basic test JSON and return the expected result.""" assert self.basic.get(query) == expected class TestList: """Test gjson queries on a list object.""" def setup_method(self): """Initialize the test instance.""" self.list = gjson.GJSON(INPUT_LIST) @pytest.mark.parametrize(('query', 'expected'), ( # Dot vs Pipe ('#.first', ['Dale', 'Jane']), ('#.first.#', []), ('#.first|#', 2), ('#.0', []), ('#.#', []), # Queries ('#(first)#', [{'first': 'Dale'}, {'first': 'Jane'}]), ('#(first)', {'first': 'Dale'}), ('#(last)#', [{'last': 'Murphy'}]), ('#(last)', {'last': 'Murphy'}), # Modifiers ('@join', {'first': 'Jane', 'last': 'Murphy'}), # Multipaths ('#.{first.@reverse}', [{'@reverse': 'Dale'}, {'@reverse': 'Jane'}, {}]), )) def test_get_ok(self, query, expected): """It should query the list test JSON and return the expected result.""" assert self.list.get(query, quiet=False) == expected @pytest.mark.parametrize(('query', 'error'), ( # Dot vs Pipe ('#|first', 'Invalid or unsupported query part `first`.'), ('#|0', 'Integer query part after a pipe delimiter on an sequence like object.'), ('#|#', 'The pipe delimiter cannot immediately follow the # element.'), )) def test_get_raise(self, query, error): """It should raise a GJSONError error with the expected message.""" with pytest.raises(gjson.GJSONParseError, match=fr'^{re.escape(error)}'): self.list.get(query) class TestFlattenModifier: """Test gjson @flatten modifier.""" def setup_method(self): """Initialize the test instance.""" self.list = gjson.GJSON(json.loads('[1, [2], [3, 4], [5, [6, 7]], [8, [9, [10, 11]]]]')) @pytest.mark.parametrize(('query', 'expected'), ( ('@flatten', [1, 2, 3, 4, 5, [6, 7], 8, [9, [10, 11]]]), ('@flatten:{"deep":true}', [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11]), )) def test_get(self, query, expected): """It should correctly flatten the given object.""" assert self.list.get(query, quiet=True) == expected class TestTruthiness: """Testing gjson with an input object with truthy/falsy objects.""" def setup_method(self): """Initialize the test instance.""" self.object = gjson.GJSON(INPUT_TRUTHINESS) @pytest.mark.parametrize(('query', 'expected'), ( ('vals.#(b==~true).a', 1), ('vals.#(b==~true)#.a', [1, 2, 4, 6, 7, 8]), ('vals.#(b==~false).a', 3), ('vals.#(b==~false)#.a', [3, 5, 9, 10, 11]), ('vals.#(b==~"invalid")#', []), )) def test_get_ok(self, query, expected): """It should query the JSON object and return the expected result.""" compare_values(self.object.get(query), expected) @pytest.mark.parametrize(('query', 'error'), ( ('vals.#(b==~"invalid")', "Queries ==~ operator requires a boolean value, got instead: `invalid`"), )) def test_get_raise(self, query, error): """It should raise a GJSONError error with the expected message.""" with pytest.raises(gjson.GJSONError, match=fr'^{re.escape(error)}'): self.object.get(query) class TestNestedQueries: """Testing gjson nested queries.""" def setup_method(self): """Initialize the test instance.""" self.object = gjson.GJSON(INPUT_NESTED_QUERIES) @pytest.mark.parametrize(('query', 'expected'), ( # Arrays of objects ('key.#(level1.#(level2.#(level3)))', INPUT_NESTED_QUERIES['key'][0]), ('key.#(level1.#(level2.#(level3)))#', INPUT_NESTED_QUERIES['key'][0:2]), ('key.#(level1.#(level2.#(level3.#(==0))))#', []), ('key.#(level1.#(level2.#(level3.#(=1))))', INPUT_NESTED_QUERIES['key'][0]), ('key.#(level1.#(level2.#(level3.#(=1)#)#)#)', INPUT_NESTED_QUERIES['key'][0]), ('key.#(level1.#(level2.#(level3.#(==1))))#', [INPUT_NESTED_QUERIES['key'][0]]), ('key.#(level1.#(level2.#(level3.#(==2))))', INPUT_NESTED_QUERIES['key'][0]), ('key.#(level1.#(level2.#(level3.#(=2))))#', INPUT_NESTED_QUERIES['key'][0:2]), # Arrays of arrays ('key.#(#(#(level3)))', INPUT_NESTED_QUERIES['key'][2]), ('key.#(#(#(level3)))#', INPUT_NESTED_QUERIES['key'][2:4]), ('key.#(#(#(level3.#(==0))))#', []), ('key.#(#(#(level3.#(==1))))', INPUT_NESTED_QUERIES['key'][2]), ('key.#(#(#(level3.#(==1)#)#)#)', INPUT_NESTED_QUERIES['key'][2]), ('key.#(#(#(level3.#(==1))))#', [INPUT_NESTED_QUERIES['key'][2]]), ('key.#(#(#(level3.#(==2))))', INPUT_NESTED_QUERIES['key'][2]), ('key.#(#(#(level3.#(==2))))#', INPUT_NESTED_QUERIES['key'][2:4]), ('key.#(#(#(level3.#(>=4))))', INPUT_NESTED_QUERIES['key'][3]), ('key.#(#(#(level3.#(>=4))))#', [INPUT_NESTED_QUERIES['key'][3]]), # Mixed ('key.#(mixed.#(#(level4)))', INPUT_NESTED_QUERIES['key'][-1]), ('key.#(mixed.#(#(level4)))#', [INPUT_NESTED_QUERIES['key'][-1]]), )) def test_get_ok(self, query, expected): """It should query the JSON object and return the expected result.""" compare_values(self.object.get(query), expected) @pytest.mark.parametrize(('query', 'error'), ( ('key.#(level1.#(level2.#(level3.#(==0))))', 'Query for first element does not match anything.'), ('key.#(#(#(level3.#(==0))))', 'Query for first element does not match anything.'), )) def test_get_raise(self, query, error): """It should raise a GJSONError error with the expected message.""" with pytest.raises(gjson.GJSONError, match=fr'^{re.escape(error)}'): self.object.get(query) @pytest.mark.parametrize(('query', 'expected'), ( ('0.0', 'zero'), ('0|0', 'zero'), ('#.0', ['zero']), ('#.1', ['one', 'one']), ('#.9', []), ('#(0="zero")#|0', {'0': 'zero', '1': 'one'}), ('#(0="zero")#.1', ['one']), ('#(0="zero")#.9', []), ('#(0="invalid")#.1', []), )) def test_get_integer_mapping_keys_ok(query, expected): """It should return the expected result.""" obj = gjson.GJSON([{'0': 'zero', '1': 'one'}, {'1': 'one'}]) assert obj.get(query, quiet=True) == expected @pytest.mark.parametrize(('query', 'error'), ( ('0.1', 'Mapping object does not have key `1`.'), ('#|0', 'Integer query part after a pipe delimiter on an sequence like object.'), ('#|9', 'Integer query part after a pipe delimiter on an sequence like object.'), ('#(0="zero")#|1', 'Index `1` out of range for sequence object with 1 items in query.'), )) def test_get_integer_mapping_keys_raise(query, error): """It should return the expected result.""" with pytest.raises(gjson.GJSONError, match=fr'^{re.escape(error)}'): gjson.GJSON([{'0': 'zero'}]).get(query) @pytest.mark.parametrize('modifier', ('@valid', '@this')) def test_get_modifier_unmodified_ok(modifier): """It should return the same object.""" obj = gjson.GJSON(INPUT_OBJECT) assert obj.get(modifier, quiet=True) == INPUT_OBJECT def test_get_modifier_valid_raise(): """It should return None if the object is invalid JSON and quiet is True.""" obj = gjson.GJSON({'invalid': {1, 2}}) assert obj.get('@valid', quiet=True) is None @pytest.mark.parametrize(('data', 'expected'), ( ('[3, 1, 5, 8, 2]', [1, 2, 3, 5, 8]), ('{"b": 2, "d": 4, "c": 3, "a": 1}', {'a': 1, 'b': 2, 'c': 3, 'd': 4}), ('"a string"', None), )) def test_get_modifier_sort(data, expected): """It should return the object sorted.""" obj = gjson.GJSON(json.loads(data)) compare_values(obj.get('@sort', quiet=True), expected) @pytest.mark.parametrize(('data', 'query', 'expected'), ( ({'a': '{"b": 25}'}, 'a.@fromstr', {'b': 25}), ({'a': '{"b": 25}'}, 'a.@fromstr.b', 25), )) def test_get_modifier_fromstr_ok(data, query, expected): """It should load the JSON-encoded string.""" obj = gjson.GJSON(data) assert obj.get(query, quiet=True) == expected @pytest.mark.parametrize(('query', 'error'), ( ('a.@fromstr', 'The current @fromstr input object cannot be converted to JSON.'), ('b.@fromstr', "Modifier @fromstr got object of type as input, expected string or bytes."), )) def test_get_modifier_fromstr_raise(query, error): """It should raise a GJSONError if the JSON-encoded string has invalid JSON.""" obj = gjson.GJSON({'a': '{"invalid: json"', 'b': {'not': 'a string'}}) with pytest.raises(gjson.GJSONError, match=fr'^{re.escape(error)}'): obj.get(query) def test_get_modifier_tostr_raise(): """It should raise a GJSONError if the object cannot be JSON-encoded.""" obj = gjson.GJSON({'a': {1, 2, 3}}) # Python sets cannot be JSON-encoded match = re.escape('The current object cannot be converted to a JSON-encoded string for @tostr.') with pytest.raises(gjson.GJSONError, match=fr'^{match}'): obj.get('a.@tostr') def test_get_modifier_group_ok(): """It should group the dict of lists into a list of dicts.""" obj = gjson.GJSON({ 'invalid1': 5, 'id': ['123', '456', '789'], 'val': [2, 1], 'invalid2': 'invalid', 'unit': ['ms', 's', 's', 'ms'], }) assert obj.get('@group') == [ {'id': '123', 'val': 2, 'unit': 'ms'}, {'id': '456', 'val': 1, 'unit': 's'}, {'id': '789', 'unit': 's'}, {'unit': 'ms'}, ] def test_get_modifier_group_empty(): """It should return an empty list if no values are lists or are empty.""" obj = gjson.GJSON({'invalid1': 5, 'invalid2': 'invalid', 'invalid3': {'a': 5}, 'id': []}) assert obj.get('@group') == [] def test_get_integer_index_on_mapping(): """It should access the integer as string key correctly.""" obj = gjson.GJSON(json.loads('{"1": 5, "11": 7}')) assert obj.get('1') == 5 assert obj.get('11') == 7 def test_module_get(): """It should return the queried object.""" assert gjson.get({'key': 'value'}, 'key') == 'value' def test_gjson_get_gjson_ok(): """It should return the queried object as a GJSON object.""" ret = gjson.GJSON(INPUT_OBJECT).get_gjson('children') assert isinstance(ret, gjson.GJSON) assert str(ret) == '["Sara", "Alex", "Jack"]' @pytest.mark.parametrize('kwargs', ({}, {'quiet': False})) def test_gjson_get_gjson_raise(kwargs): """It should raise a GJSONError if the quiet parameter is not passed or is False.""" with pytest.raises(gjson.GJSONError, match=r'^Mapping object does not have key `nonexistent`.'): gjson.GJSON(INPUT_OBJECT).get_gjson('nonexistent', **kwargs) @pytest.mark.parametrize(('data', 'num', 'expected'), ( # Valid data ('[1, 2, 3, 4, 5]', None, {1: 1, 2: 1, 3: 1, 4: 1, 5: 1}), ('[1, 2, 3, 4, 5]', 0, {}), ('[1, 2, 3, 4, 5]', 2, {1: 1, 2: 1}), ('[1, 1, 1, 1, 1]', None, {1: 5}), ('[1, 1, 1, 1, 1]', 1, {1: 5}), ('[1, 1, 1, 2, 2, 3]', None, {1: 3, 2: 2, 3: 1}), ('[1, 1, 1, 2, 2, 3, 3, 3, 3]', None, {3: 4, 1: 3, 2: 2}), ('[1, 1, 1, 2, 2, 3, 3, 3, 3]', 2, {3: 4, 1: 3}), # Invalid data ('{"key": "value"}', None, None), ('1', None, None), ('"value"', None, None), )) def test_get_modifier_top_n(data, num, expected): """It should return the top N common items.""" obj = gjson.GJSON(json.loads(data)) if num is not None: compare_values(obj.get(f'@top_n:{{"n": {num}}}', quiet=True), expected) else: compare_values(obj.get('@top_n', quiet=True), expected) @pytest.mark.parametrize(('num', 'expected'), ( (0, {}), (1, {'c': 12}), (2, {'c': 12, 'a': 8}), (3, {'c': 12, 'a': 8, 'd': 4}), (4, {'c': 12, 'a': 8, 'd': 4, 'b': 3.5}), (None, {'c': 12, 'a': 8, 'd': 4, 'b': 3.5}), )) def test_get_modifier_sum_n_valid(num, expected): """It should group and sum and return the top N items.""" obj = gjson.GJSON(INPUT_SUM_N) if num is not None: compare_values(obj.get(f'@sum_n:{{"group": "key", "sum": "value", "n": {num}}}', quiet=True), expected) else: compare_values(obj.get('@sum_n:{"group": "key", "sum": "value"}', quiet=True), expected) @pytest.mark.parametrize('data', ( '{"an": "object"}', '"a string"', '1', )) def test_get_modifier_sum_n_invalid_data(data): """It should raise a GJSONError if the input is invalid.""" obj = gjson.GJSON(json.loads(data)) with pytest.raises(gjson.GJSONError, match=r'^@sum_n modifier not supported for object of type'): obj.get('@sum_n:{"group": "key", "sum": "value"}') @pytest.mark.parametrize('options', ( '', ':{}', ':{"group": "invalid", "sum": "value"}', ':{"group": "key", "sum": "invalid"}', ':{"group": "key", "sum": "other"}', ':{"group": "other", "sum": "value"}', )) def test_get_modifier_sum_n_invalid_options(options): """It should raise a GJSONError if the options are invalid.""" obj = gjson.GJSON(INPUT_SUM_N) with pytest.raises(gjson.GJSONError, match=r'^Modifier @sum_n raised an exception'): obj.get(f'@sum_n{options}') class TestJSONOutput: """Test class for all JSON output functionalities.""" def setup_method(self): """Initialize the test instance.""" self.obj = {'key': 'value', 'hello world': '\u3053\u3093\u306b\u3061\u306f\u4e16\u754c'} self.query = 'key' self.value = '"value"' self.gjson = gjson.GJSON(self.obj) def test_module_get_as_str(self): """It should return the queried object as a JSON string.""" assert gjson.get(self.obj, self.query, as_str=True) == self.value assert gjson.get(self.obj, '', as_str=True, quiet=True) == '' def test_module_get_str(self): """It should return the string representation of the object.""" assert str(self.gjson) == '{"key": "value", "hello world": "\u3053\u3093\u306b\u3061\u306f\u4e16\u754c"}' def test_gjson_getj(self): """It should return the queried object as a JSON string.""" assert self.gjson.getj(self.query) == self.value assert self.gjson.getj('', quiet=True) == '' def test_module_get_as_str_raise(self): """It should raise a GJSONError with the proper message on failure.""" with pytest.raises(gjson.GJSONError, match=r'^Empty query.'): gjson.get(self.obj, '', as_str=True) def test_gjson_get_as_str_raise(self): """It should raise a GJSONError with the proper message on failure.""" with pytest.raises(gjson.GJSONError, match=r'^Empty query.'): self.gjson.getj('') @pytest.mark.parametrize(('query', 'expected'), ( ('@pretty', '{\n "key": "value",\n "hello world": "\u3053\u3093\u306b\u3061\u306f\u4e16\u754c"\n}'), ('@pretty:{"indent": 4}', '{\n "key": "value",\n "hello world": "\u3053\u3093\u306b\u3061\u306f\u4e16\u754c"\n}'), ('@pretty:{"indent": "\t"}', '{\n\t"key": "value",\n\t"hello world": "\u3053\u3093\u306b\u3061\u306f\u4e16\u754c"\n}'), # Multipaths ('{key,"another":key}.@pretty', '{\n "key": "value",\n "another": "value"\n}'), )) def test_modifier_pretty(self, query, expected): """It should prettyfy the JSON string based on the parameters.""" assert self.gjson.getj(query) == expected def test_modifier_pretty_sort_keys_prefix(self): """It should prettyfy the JSON string and sort the keys.""" output = gjson.GJSON({'key2': 'value2', 'key1': 'value1'}).getj('@pretty:{"sortKeys": true, "prefix": "## "}') assert output == '## {\n## "key1": "value1",\n## "key2": "value2"\n## }' def test_modifier_ugly(self): """It should uglyfy the JSON string.""" assert gjson.get(self.obj, '@ugly', as_str=True) == ( '{"key":"value","hello world":"\u3053\u3093\u306b\u3061\u306f\u4e16\u754c"}') def test_output_unicode(self): """It should return unicode characters as-is.""" assert gjson.get(self.obj, 'hello world', as_str=True) == '"\u3053\u3093\u306b\u3061\u306f\u4e16\u754c"' def test_modifier_ascii(self): """It should escape all non-ASCII characters.""" assert gjson.get(self.obj, 'hello world.@ascii', as_str=True) == ( '"\\u3053\\u3093\\u306b\\u3061\\u306f\\u4e16\\u754c"') def custom_sum(options, obj, *, last): """Sum items in list. Custom modifier function to be used in tests.""" assert last is True assert options == {} if not isinstance(obj, list): raise TypeError('@sum can be used only on lists') return sum(obj) class TestCustomModifiers: """Test class for custom modifiers.""" def setup_method(self): """Initialize the test instance.""" self.valid_obj = [1, 2, 3, 4, 5] self.invalid_obj = 'invalid' self.query = '@sum' def test_gjson_register_modifier_ok(self): """It should register a valid modifier.""" obj = gjson.GJSON(self.valid_obj) obj.register_modifier('sum', custom_sum) assert obj.get(self.query) == 15 def test_gjson_register_modifier_with_escape_ok(self): """It should register a valid modifier with escaped characters in the name.""" obj = gjson.GJSON(self.valid_obj) obj.register_modifier('sum\\=', custom_sum) assert obj.get('@sum\\=') == 15 @pytest.mark.parametrize('char', MODIFIER_NAME_RESERVED_CHARS) def test_gjson_register_modifier_invalid_name(self, char): """It should raise a GJSONError if trying to register a modifier with a name with not allowed characters.""" obj = gjson.GJSON(self.valid_obj) name = fr'a{char}b' with pytest.raises( gjson.GJSONError, match=fr'^Unable to register modifier `{re.escape(name)}`, contains at least one not allowed'): obj.register_modifier(name, custom_sum) def test_gjson_register_modifier_override_builtin(self): """It should raise a GJSONError if trying to register a modifier with the same name of a built-in one.""" obj = gjson.GJSON(self.valid_obj) match = re.escape('Unable to register a modifier with the same name of the built-in modifier: @valid') with pytest.raises(gjson.GJSONError, match=fr'^{match}'): obj.register_modifier('valid', custom_sum) def test_gjson_register_modifier_not_callable(self): """It should raise a GJSONError if trying to register a modifier that is not callable.""" obj = gjson.GJSON(self.valid_obj) match = re.escape('The given func "not-callable" for the custom modifier @sum does not adhere to the ' 'gjson.ModifierProtocol.') with pytest.raises(gjson.GJSONError, match=fr'^{match}'): obj.register_modifier('sum', 'not-callable') def test_gjsonobj_custom_modifiers_ok(self): """It should register a valid modifier.""" obj = gjson.GJSONObj(self.valid_obj, self.query, custom_modifiers={'sum': custom_sum}) assert obj.get() == 15 def test_gjsonobj_custom_modifiers_raise(self): """It should encapsulate the modifier raised exception in a GJSONError.""" with pytest.raises(gjson.GJSONError, match=fr'^{re.escape("Modifier @sum raised an exception")}'): gjson.GJSONObj(self.invalid_obj, self.query, custom_modifiers={'sum': custom_sum}).get() def test_gjsonobj_custom_modifiers_override_builtin(self): """It should raise a GJSONError if passing custom modifiers that have the same name of a built-in one.""" with pytest.raises(gjson.GJSONError, match=r"^Some provided custom_modifiers have the same name of built-in ones: {'valid'}"): gjson.GJSONObj(self.valid_obj, self.query, custom_modifiers={'valid': custom_sum}) def test_gjsoniobj_custom_modifiers_not_callable(self): """It should raise a GJSONError if passing custom modifiers that are not callable.""" match = re.escape('The given func "not-callable" for the custom modifier @sum does not adhere to the') with pytest.raises(gjson.GJSONError, match=fr'^{match}'): gjson.GJSONObj(self.valid_obj, self.query, custom_modifiers={'sum': 'not-callable'}) def test_gjsonobj_builtin_modifiers(self): """It should return a set with the names of the built-in modifiers.""" expected = {'ascii', 'flatten', 'fromstr', 'group', 'join', 'keys', 'pretty', 'reverse', 'sort', 'sum_n', 'this', 'top_n', 'tostr', 'valid', 'values', 'ugly'} assert gjson.GJSONObj.builtin_modifiers() == expected