| #!/usr/bin/env python3 |
| # |
| # Copyright 2022 The Fuchsia Authors |
| # |
| # 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. |
| |
| import unittest |
| from functools import partial |
| from unittest import TestCase |
| |
| from mock import Mock, patch |
| |
| from antlion import context |
| from antlion.context import ( |
| RootContext, |
| TestCaseContext, |
| TestClassContext, |
| TestContext, |
| _update_test_case_context, |
| _update_test_class_context, |
| get_context_for_event, |
| get_current_context, |
| ) |
| from antlion.event.event import ( |
| TestCaseBeginEvent, |
| TestCaseEndEvent, |
| TestCaseEvent, |
| TestClassBeginEvent, |
| TestClassEndEvent, |
| TestClassEvent, |
| ) |
| |
| LOGGING = "antlion.context.logging" |
| |
| |
| def reset_context(): |
| context._contexts = [RootContext()] |
| |
| |
| TEST_CASE = "test_case_name" |
| |
| |
| class TestClass: |
| pass |
| |
| |
| class ModuleTest(TestCase): |
| """Unit tests for the context module.""" |
| |
| def test_get_context_for_event_for_test_case(self): |
| event = Mock(spec=TestCaseEvent) |
| event.test_class = Mock() |
| event.test_case = Mock() |
| context = get_context_for_event(event) |
| |
| self.assertIsInstance(context, TestCaseContext) |
| self.assertEqual(context.test_class, event.test_class) |
| self.assertEqual(context.test_case, event.test_case) |
| |
| def test_get_context_for_event_for_test_class(self): |
| event = Mock(spec=TestClassEvent) |
| event.test_class = Mock() |
| context = get_context_for_event(event) |
| |
| self.assertIsInstance(context, TestClassContext) |
| self.assertEqual(context.test_class, event.test_class) |
| |
| def test_get_context_for_unknown_event_type(self): |
| event = Mock() |
| |
| self.assertRaises(TypeError, partial(get_context_for_event, event)) |
| |
| def test_update_test_class_context_for_test_class_begin(self): |
| event = Mock(spec=TestClassBeginEvent) |
| event.test_class = Mock() |
| |
| _update_test_class_context(event) |
| self.assertIsInstance(get_current_context(), TestClassContext) |
| reset_context() |
| |
| def test_update_test_class_context_for_test_class_end(self): |
| event = Mock(spec=TestClassBeginEvent) |
| event.test_class = Mock() |
| event2 = Mock(spec=TestClassEndEvent) |
| event2.test_class = Mock() |
| |
| _update_test_class_context(event) |
| _update_test_class_context(event2) |
| |
| self.assertIsInstance(get_current_context(), RootContext) |
| reset_context() |
| |
| def test_update_test_case_context_for_test_case_begin(self): |
| event = Mock(spec=TestClassBeginEvent) |
| event.test_class = Mock() |
| event2 = Mock(spec=TestCaseBeginEvent) |
| event2.test_class = Mock() |
| event2.test_case = Mock() |
| |
| _update_test_class_context(event) |
| _update_test_case_context(event2) |
| |
| self.assertIsInstance(get_current_context(), TestCaseContext) |
| reset_context() |
| |
| def test_update_test_case_context_for_test_case_end(self): |
| event = Mock(spec=TestClassBeginEvent) |
| event.test_class = Mock() |
| event2 = Mock(spec=TestCaseBeginEvent) |
| event2.test_class = Mock() |
| event2.test_case = Mock() |
| event3 = Mock(spec=TestCaseEndEvent) |
| event3.test_class = Mock() |
| event3.test_case = Mock() |
| |
| _update_test_class_context(event) |
| _update_test_case_context(event2) |
| _update_test_case_context(event3) |
| |
| self.assertIsInstance(get_current_context(), TestClassContext) |
| reset_context() |
| |
| |
| class TestContextTest(TestCase): |
| """Unit tests for the TestContext class.""" |
| |
| @patch(LOGGING) |
| def test_get_base_output_path_uses_default(self, logging): |
| context = TestContext() |
| |
| self.assertEqual(context.get_base_output_path(), logging.log_path) |
| |
| @patch(LOGGING) |
| def test_add_base_path_overrides_default(self, _): |
| context = TestContext() |
| mock_path = Mock() |
| |
| context.add_base_output_path("basepath", mock_path) |
| |
| self.assertEqual(context.get_base_output_path("basepath"), mock_path) |
| |
| def test_get_subcontext_returns_empty_string_by_default(self): |
| context = TestContext() |
| |
| self.assertEqual(context.get_subcontext(), "") |
| |
| def test_add_subcontext_sets_correct_path(self): |
| context = TestContext() |
| mock_path = Mock() |
| |
| context.add_subcontext("subcontext", mock_path) |
| |
| self.assertEqual(context.get_subcontext("subcontext"), mock_path) |
| |
| @patch(LOGGING) |
| @patch("os.makedirs") |
| def test_get_full_output_path_returns_correct_path(self, *_): |
| context = TestClassContext(TestClass()) |
| context.add_base_output_path("foo", "base/path") |
| context.add_subcontext("foo", "subcontext") |
| |
| full_path = "base/path/TestClass/subcontext" |
| self.assertEqual(context.get_full_output_path("foo"), full_path) |
| |
| def test_identifier_not_implemented(self): |
| context = TestContext() |
| |
| self.assertRaises(NotImplementedError, lambda: context.identifier) |
| |
| |
| class TestClassContextTest(TestCase): |
| """Unit tests for the TestClassContext class.""" |
| |
| def test_init_attributes(self): |
| test_class = Mock() |
| context = TestClassContext(test_class) |
| |
| self.assertEqual(context.test_class, test_class) |
| |
| def test_get_class_name(self): |
| class TestClass: |
| pass |
| |
| test_class = TestClass() |
| context = TestClassContext(test_class) |
| |
| self.assertEqual(context.test_class_name, TestClass.__name__) |
| |
| def test_context_dir_is_class_name(self): |
| class TestClass: |
| pass |
| |
| test_class = TestClass() |
| context = TestClassContext(test_class) |
| |
| self.assertEqual(context._get_default_context_dir(), TestClass.__name__) |
| |
| def test_identifier_is_class_name(self): |
| class TestClass: |
| pass |
| |
| test_class = TestClass() |
| context = TestClassContext(test_class) |
| |
| self.assertEqual(context.identifier, TestClass.__name__) |
| |
| |
| class TestCaseContextTest(TestCase): |
| """Unit tests for the TestCaseContext class.""" |
| |
| def test_init_attributes(self): |
| test_class = Mock() |
| test_case = TEST_CASE |
| context = TestCaseContext(test_class, test_case) |
| |
| self.assertEqual(context.test_class, test_class) |
| self.assertEqual(context.test_case, test_case) |
| self.assertEqual(context.test_case_name, test_case) |
| |
| def test_get_class_name(self): |
| test_class = TestClass() |
| context = TestCaseContext(test_class, TEST_CASE) |
| |
| self.assertEqual(context.test_class_name, TestClass.__name__) |
| |
| def test_context_dir_is_class_and_test_case_name(self): |
| test_class = TestClass() |
| context = TestCaseContext(test_class, TEST_CASE) |
| |
| context_dir = f"{TestClass.__name__}/{TEST_CASE}" |
| self.assertEqual(context._get_default_context_dir(), context_dir) |
| |
| def test_identifier_is_class_and_test_case_name(self): |
| test_class = TestClass() |
| context = TestCaseContext(test_class, TEST_CASE) |
| |
| identifier = f"{TestClass.__name__}.{TEST_CASE}" |
| self.assertEqual(context.identifier, identifier) |
| |
| |
| if __name__ == "__main__": |
| unittest.main() |
