o3de/scripts/o3de/tests/unit_test_cmake.py

#
# All or portions of this file Copyright (c) Amazon.com, Inc. or its affiliates or
# its licensors.
#
# For complete copyright and license terms please see the LICENSE at the root of this
# distribution (the "License"). All use of this software is governed by the License,
# or, if provided, by the license below or the license accompanying this file. Do not
# remove or modify any license notices. This file is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
#

import io
import json
import logging
import unittest.mock

import pytest
import pathlib
from unittest.mock import patch

from o3de import cmake


class TestGetEnabledGems:
    @pytest.mark.parametrize(
        "enable_gems_cmake_data, expected_set", [
            pytest.param("""
                # Comment
                set(ENABLED_GEMS foo bar baz)
            """, set(['foo', 'bar', 'baz'])),
            pytest.param("""
                        # Comment
                        set(ENABLED_GEMS
                            foo
                            bar
                            baz
                        )
                    """, set(['foo', 'bar', 'baz'])),
            pytest.param("""
                    # Comment
                    set(ENABLED_GEMS
                        foo
                        bar
                        baz)
                """, set(['foo', 'bar', 'baz'])),
            pytest.param("""
                        # Comment
                        set(ENABLED_GEMS
                            foo bar
                            baz)
                    """, set(['foo', 'bar', 'baz'])),
            pytest.param("""
                        # Comment
                        set(RANDOM_VARIABLE TestGame, TestProject Test Engine)
                        set(ENABLED_GEMS HelloWorld IceCream
                            foo
                            baz bar
                            baz baz baz baz baz morebaz lessbaz
                        )
                        Random Text
                    """, set(['HelloWorld', 'IceCream', 'foo', 'bar', 'baz', 'morebaz', 'lessbaz'])),
        ]
    )
    def test_get_enabled_gems(self, enable_gems_cmake_data, expected_set):
        enabled_gems_set = set()
        with patch('pathlib.Path.resolve', return_value=pathlib.Path('enabled_gems.cmake')) as pathlib_is_resolve_mock,\
                patch('pathlib.Path.is_file', return_value=True) as pathlib_is_file_mock,\
                patch('pathlib.Path.open', return_value=io.StringIO(enable_gems_cmake_data)) as pathlib_open_mock:
            enabled_gems_set = cmake.get_enabled_gems(pathlib.Path('enabled_gems.cmake'))

        assert enabled_gems_set == expected_set


class TestAddGemDependency:
    @pytest.mark.parametrize(
        "enable_gems_cmake_data, expected_set, expected_return", [
            pytest.param("""
                # Comment
                set(ENABLED_GEMS foo bar baz)
            """, set(['foo', 'bar', 'baz', 'TestGem']), 0),
            pytest.param("""
                        # Comment
                        set(ENABLED_GEMS
                            foo
                            bar
                            baz
                        )
                    """, set(['foo', 'bar', 'baz', 'TestGem']), 0),
            pytest.param("""
                    # Comment
                    set(ENABLED_GEMS
                        foo
                        bar
                        baz)
                """, set(['foo', 'bar', 'baz', 'TestGem']), 0),
            pytest.param("""
                        # Comment
                        set(ENABLED_GEMS
                            foo bar
                            baz)
                    """, set(['foo', 'bar', 'baz', 'TestGem']), 0),
            pytest.param("""
                """, set(['TestGem']), 0),
            pytest.param("""
                        # Comment
                        set(RANDOM_VARIABLE TestGame, TestProject Test Engine)
                        set(ENABLED_GEMS HelloWorld IceCream
                            foo
                            baz bar
                            baz baz baz baz baz morebaz lessbaz
                        )
                        Random Text
                    """, set(['HelloWorld', 'IceCream', 'foo', 'bar', 'baz', 'morebaz', 'lessbaz', 'TestGem']),
                         0),
            pytest.param("""
                        set(ENABLED_GEMS foo bar baz
                """, set(['foo', 'bar', 'baz']), 1),
        ]
    )
    def test_add_gem_dependency(self, enable_gems_cmake_data, expected_set, expected_return):
        enabled_gems_set = set()
        add_gem_return = None

        class StringBufferIOWrapper(io.StringIO):
            def __init__(self):
                nonlocal enable_gems_cmake_data
                super().__init__(enable_gems_cmake_data)
            def __enter__(self):
                return super().__enter__()
            def __exit__(self, exc_type, exc_val, exc_tb):
                nonlocal enable_gems_cmake_data
                enable_gems_cmake_data = super().getvalue()
                super().__exit__(exc_tb, exc_val, exc_tb)


        with patch('pathlib.Path.resolve', return_value=pathlib.Path('enabled_gems.cmake')) as pathlib_is_resolve_mock,\
                patch('pathlib.Path.is_file', return_value=True) as pathlib_is_file_mock,\
                patch('pathlib.Path.open', side_effect=lambda mode: StringBufferIOWrapper()) as pathlib_open_mock:

            add_gem_return = cmake.add_gem_dependency(pathlib.Path('enabled_gems.cmake'), 'TestGem')
            enabled_gems_set = cmake.get_enabled_gems(pathlib.Path('enabled_gems.cmake'))

        assert add_gem_return == expected_return
        assert enabled_gems_set == expected_set


class TestRemoveGemDependency:
    @pytest.mark.parametrize(
        "enable_gems_cmake_data, expected_set, expected_return", [
            pytest.param("""
                # Comment
                set(ENABLED_GEMS foo bar baz TestGem)
            """, set(['foo', 'bar', 'baz']), 0),
            pytest.param("""
                        # Comment
                        set(ENABLED_GEMS
                            foo
                            bar
                            baz
                            TestGem
                        )
                    """, set(['foo', 'bar', 'baz']), 0),
            pytest.param("""
                    # Comment
                    set(ENABLED_GEMS
                        foo
                        bar
                        baz
                        TestGem)
                """, set(['foo', 'bar', 'baz']), 0),
            pytest.param("""
                        # Comment
                        set(ENABLED_GEMS
                            foo bar
                            baz TestGem)
                    """, set(['foo', 'bar', 'baz']), 0),
            pytest.param("""
                        # Comment
                        set(ENABLED_GEMS
                            foo
                            TestGem
                            bar
                            TestGem
                            baz
                        )
                        Random Text
                    """, set(['foo', 'bar', 'baz']),
                         0),
            pytest.param("""
                        set(ENABLED_GEMS
                            foo
                            bar
                            baz
                            "TestGem"
                        )
                """, set(['foo', 'bar', 'baz']), 0),
            pytest.param("""
            """, set(), 1),
            pytest.param("""
                set(ENABLED_GEMS
                    foo
                    bar
                    baz
                )
                """, set(['foo', 'bar', 'baz']), 1),
        ]
    )
    def test_remove_gem_dependency(self, enable_gems_cmake_data, expected_set, expected_return):
        enabled_gems_set = set()
        add_gem_return = None

        class StringBufferIOWrapper(io.StringIO):
            def __init__(self):
                nonlocal enable_gems_cmake_data
                super().__init__(enable_gems_cmake_data)
            def __enter__(self):
                return super().__enter__()
            def __exit__(self, exc_type, exc_val, exc_tb):
                nonlocal enable_gems_cmake_data
                enable_gems_cmake_data = super().getvalue()
                super().__exit__(exc_tb, exc_val, exc_tb)


        with patch('pathlib.Path.resolve', return_value=pathlib.Path('enabled_gems.cmake')) as pathlib_is_resolve_mock,\
                patch('pathlib.Path.is_file', return_value=True) as pathlib_is_file_mock,\
                patch('pathlib.Path.open', side_effect=lambda mode: StringBufferIOWrapper()) as pathlib_open_mock:

            add_gem_return = cmake.remove_gem_dependency(pathlib.Path('enabled_gems.cmake'), 'TestGem')
            enabled_gems_set = cmake.get_enabled_gems(pathlib.Path('enabled_gems.cmake'))

        assert add_gem_return == expected_return
        assert enabled_gems_set == expected_set