xref: /aosp_15_r20/tools/platform-compat/build/process-compat-config-test.py (revision b7bfe76a3376ed14ad4000514e7f5aa4f0ee949d)

#!/usr/bin/env python3
#
# Copyright (C) 2019 The Android Open Source Project
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
"""Unit tests for process_compat_config.py."""

import difflib
import io
import unittest
import xml.dom.minidom
from inspect import currentframe, getframeinfo

import process_compat_config

def here():
    f = currentframe().f_back
    return "%s:%d" % (getframeinfo(f).filename, f.f_lineno)

class ProcessCompatConfigTest(unittest.TestCase):

    def setUp(self):
        self.merger = process_compat_config.ConfigMerger(detect_conflicts = True)
        self.stderr = io.StringIO()
        self.merger.write_errors_to = self.stderr
        self.xml = io.BytesIO()

    def remove_white_space_text_nodes(self, node):
        remove = []
        # Find any child nodes that are just white space, and add them to a list
        # to remove. Do not remove the child while iterating as that prevents
        # the following node from being seen.
        for child in node.childNodes:
            if child.nodeType == node.ELEMENT_NODE:
                self.remove_white_space_text_nodes(child)
            elif child.nodeType == node.TEXT_NODE:
                if str.isspace(child.data):
                    remove.append(child)
        # Remove any child nodes that were just white space.
        for child in remove:
            node.removeChild(child)
            child.unlink()

    def parse_xml(self, text):
        node = xml.dom.minidom.parseString(text)
        # Remove any white space text nodes as they are irrelevant.
        self.remove_white_space_text_nodes(node)
        return node.toprettyxml()

    def assert_same_xml(self, got, expected):
        got = self.parse_xml(got)
        expected = self.parse_xml(expected)
        diffs = [diff for diff in difflib.ndiff(got.split('\n'), expected.split('\n')) if not diff.startswith(" ")]
        self.assertEqual("", "\n".join(diffs), msg="Got unexpected diffs in XML")

    def test_no_config_to_merge(self):
        self.merger.write(self.xml)
        self.assert_same_xml(self.xml.getvalue(), "<config />")

    def test_merge_one_file(self):
        self.merger.merge(io.BytesIO(b'<config><compat-change id="1234" name="TEST_CHANGE" /></config>'), here())
        self.merger.write(self.xml)
        self.assert_same_xml(self.xml.getvalue(), '<config><compat-change id="1234" name="TEST_CHANGE" /></config>')

    def test_merge_two_files(self):
        self.merger.merge(io.BytesIO(b'<config><compat-change id="1234" name="TEST_CHANGE" /></config>'), here())
        self.merger.merge(io.BytesIO(b'<config><compat-change id="1235" name="TEST_CHANGE2" /></config>'), here())
        self.merger.write(self.xml)
        self.assert_same_xml(self.xml.getvalue(),
            '<config><compat-change id="1234" name="TEST_CHANGE" /><compat-change id="1235" name="TEST_CHANGE2" /></config>')

    def test_merge_two_files_metadata(self):
        self.merger.merge(io.BytesIO(
            b'<config><compat-change id="1234" name="TEST_CHANGE"><meta-data definedIn="some.Class" sourcePosition="some.java:1" />'
            b'</compat-change></config>'), here())
        self.merger.merge(io.BytesIO(
            b'<config><compat-change id="1235" name="TEST_CHANGE2"><meta-data definedIn="other.Class" sourcePosition="other.java:2" />'
            b'</compat-change></config>'), here())
        self.merger.write(self.xml)
        self.assert_same_xml(self.xml.getvalue(), b'<config>'
            b'<compat-change id="1234" name="TEST_CHANGE"><meta-data definedIn="some.Class" sourcePosition="some.java:1" /></compat-change>'
            b'<compat-change id="1235" name="TEST_CHANGE2"><meta-data definedIn="other.Class" sourcePosition="other.java:2" /></compat-change>'
            b'</config>')

    def test_write_device_config_metadata_stripped(self):
        self.merger.merge(io.BytesIO(
            b'<config><compat-change id="1234" name="TEST_CHANGE"><meta-data definedIn="some.Class" sourcePosition="file.java:1"/>'
            b'</compat-change></config>'), here())
        self.merger.write_device_config(self.xml)
        self.assert_same_xml(self.xml.getvalue(), b'<config>'
            b'<compat-change id="1234" name="TEST_CHANGE" />'
            b'</config>')

    def test_merge_two_files_duplicate_id(self):
        self.merger.merge(io.BytesIO(b'<config><compat-change id="1234" name="TEST_CHANGE" /></config>'), here())
        self.merger.merge(io.BytesIO(b'<config><compat-change id="1234" name="TEST_CHANGE2" /></config>'), here())
        self.assertIn(r'ERROR: Duplicate definitions for compat change with ID 1234', self.stderr.getvalue())
        with self.assertRaisesRegex(Exception, ' 1 .*error'):
            self.merger.write(self.xml)

    def test_merge_two_files_duplicate_name(self):
        self.merger.merge(io.BytesIO(b'<config><compat-change id="1234" name="TEST_CHANGE" /></config>'), here())
        self.merger.merge(io.BytesIO(b'<config><compat-change id="1235" name="TEST_CHANGE" /></config>'), here())
        self.assertIn(r'ERROR: Duplicate definitions for compat change with name TEST_CHANGE', self.stderr.getvalue())
        with self.assertRaisesRegex(Exception, ' 1 .*error'):
            self.merger.write(self.xml)

    def test_merge_two_files_duplicate_id_allow_duplicates(self):
        self.merger = process_compat_config.ConfigMerger(detect_conflicts = False)
        self.merger.merge(io.BytesIO(b'<config><compat-change id="1234" name="TEST_CHANGE" /></config>'), here())
        self.merger.merge(io.BytesIO(b'<config><compat-change id="1234" name="TEST_CHANGE2" /></config>'), here())
        self.merger.write(self.xml)

    def test_merge_two_files_duplicate_name_allow_duplicates(self):
        self.merger = process_compat_config.ConfigMerger(detect_conflicts = False)
        self.merger.merge(io.BytesIO(b'<config><compat-change id="1234" name="TEST_CHANGE" /></config>'), here())
        self.merger.merge(io.BytesIO(b'<config><compat-change id="1235" name="TEST_CHANGE" /></config>'), here())
        self.merger.write(self.xml)

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