path: root/test_json_diff.py

# -*- coding: utf-8 -*-
"""
PyUnit unit tests
"""
from __future__ import division, absolute_import, unicode_literals
import unittest, sys
if sys.version_info[0] == 3: unicode = str
import json
import json_diff
from io import StringIO
import codecs

from test_strings import * #@UnusedWildImport

class OurTestCase(unittest.TestCase):
    def _run_test(self, oldf, newf, difff, msg="", inc=(), exc=()):
        diffator = json_diff.Comparator(oldf, newf, inc, exc)
        diff = diffator.compare_dicts()
        expected = json.load(difff)
        self.assertEqual(json.dumps(diff, sort_keys=True), json.dumps(expected, sort_keys=True),
                         msg + "\n\nexpected = %s\n\nobserved = %s" %
                         (json.dumps(expected, sort_keys=True, indent=4, ensure_ascii=False),
                          json.dumps(diff, sort_keys=True, indent=4, ensure_ascii=False)))

    def _run_test_strings(self, olds, news, diffs, msg="", inc=(), exc=()):
        self._run_test(StringIO(olds), StringIO(news), StringIO(diffs), msg, inc, exc)

    def _run_test_formatted(self, oldf, newf, difff, msg=""):
        diffator = json_diff.Comparator(oldf, newf)
        diff = ("\n".join([line.strip() \
                for line in unicode( \
                    json_diff.HTMLFormatter(diffator.compare_dicts())).split("\n")])).strip()
        expected = ("\n".join([line.strip() for line in difff if line])).strip()
        self.assertEqual(diff, expected, msg +
                         "\n\nexpected = %s\n\nobserved = %s" %
                         (expected, diff))

#class TestUtilities(unittest.TestCase):
#    def test_is_dict_interesting(self):
#        diffator = json_diff.Comparator(StringIO(NESTED_OLD), StringIO(NESTED_NEW),
#                    included_attrs=('nome',))
#        old_res = diffator.dict_no_key_included(diffator.obj1)
#        self.assertFalse(old_res,
#            "check whether the old dict should be excluded or not") # or True? FIXME
#        new_res = diffator.dict_no_key_included(diffator.obj2)
#        self.assertFalse(new_res,
#            "check whether the new dict should be excluded or not") # or True? FIXME


class TestBasicJSONHappyPath(OurTestCase):
    def test_empty(self):
        diffator = json_diff.Comparator({}, {})
        diff = diffator.compare_dicts()
        self.assertEqual(json.dumps(diff).strip(), "{}",
             "Empty objects diff.\n\nexpected = %s\n\nobserved = %s" %
             ({}, diff))

    def test_null(self):
        self._run_test_strings('{"a": null}', '{"a": null}',
            '{}', "Nulls")

    def test_null_to_string(self):
        self._run_test_strings('{"a": null}', '{"a": "something"}',
            '{"_update": {"a": "something"}}', "Null changed to string")

    def test_boolean(self):
        self._run_test_strings('{"a": true}', '{"a": false}',
            '{"_update": {"a": false}}', "Booleans")

    def test_integer(self):
        self._run_test_strings('{"a": 1}', '{"a": 2}',
            '{"_update": {"a": 2}}', "Integers")

    def test_float(self):
        self._run_test_strings('{"a": 1.0}', '{"a": 1.1}',
            '{"_update": {"a": 1.1}}', "Floats")

    def test_int_to_float(self):
        self._run_test_strings('{"a": 1}', '{"a": 1.0}',
            '{"_update": {"a": 1.0}}', "Integer changed to float")

    def test_simple(self):
        self._run_test_strings(SIMPLE_OLD, SIMPLE_NEW, SIMPLE_DIFF,
                "All-scalar objects diff.")

    def test_simple_formatted(self):
        self._run_test_formatted(StringIO(SIMPLE_OLD), StringIO(SIMPLE_NEW),
            StringIO(SIMPLE_DIFF_HTML),
            "All-scalar objects diff (formatted).")

    def test_simple_array(self):
        self._run_test_strings(SIMPLE_ARRAY_OLD, SIMPLE_ARRAY_NEW,
            SIMPLE_ARRAY_DIFF, "Simple array objects diff.")

    def test_realFile(self):
        self._run_test(open("test/old.json"), open("test/new.json"),
            open("test/diff.json"), "Simply nested objects (from file) diff.")

    def test_nested(self):
        self._run_test_strings(NESTED_OLD, NESTED_NEW, NESTED_DIFF, "Nested objects diff.")

    def test_nested_formatted(self):
        self._run_test_formatted(open("test/old.json"), open("test/new.json"),
            codecs.open("test/nested_html_output.html", "r", "utf-8"),
            "Simply nested objects (from file) diff formatted as HTML.")

    def test_nested_excluded(self):
        self._run_test_strings(NESTED_OLD, NESTED_NEW, NESTED_DIFF_EXCL,
            "Nested objects diff.", exc=("nome",))

#    def test_nested_included(self):
#        self._run_test_strings(NESTED_OLD, NESTED_NEW, NESTED_DIFF_INCL,
#            "Nested objects diff.", inc=("nome",))

class TestBasicJSONSadPath(OurTestCase):
    def test_no_JSON(self):
        self.assertRaises(json_diff.BadJSONError,
                json_diff.Comparator, StringIO(NO_JSON_OLD), StringIO(NO_JSON_NEW))

    def test_bad_JSON_no_hex(self):
        self.assertRaises(json_diff.BadJSONError, self._run_test_strings,
            '{"a": 0x1}', '{"a": 2}', '{"_update": {"a": 2}}',
            "Hex numbers not supported")

    def test_bad_JSON_no_octal(self):
        self.assertRaises(json_diff.BadJSONError, self._run_test_strings,
            '{"a": 01}', '{"a": 2}', '{"_update": {"a": 2}}',
            "Octal numbers not supported")


#class TestPiglitData(OurTestCase):
#    pass
#    def test_piglit_results(self):
#        self._run_test(open("test/old-testing-data.json"), open("test/new-testing-data.json"),
#            open("test/diff-testing-data.json"), "Large piglit results diff.")

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