Merge pull request #871 from p12tic/unittest

Migrate tests to unittest

.github/workflows/pylint.yml

@@ -7,15 +7,12 @@ on:
 jobs:
  lint-ruff:
  runs-on: ubuntu-latest
- strategy:
- matrix:
- python-version: ["3.11"]
  steps:
  - uses: actions/checkout@v3
- - uses: actions/checkout@v3
- name: Set up Python ${{ matrix.python-version }}
+ - name: Set up Python 3.10
+ uses: actions/setup-python@v4
  with:
- python-version: ${{ matrix.python-version }}
+ python-version: "3.11"
  - name: Analysing the code with ruff
  run: |
  pip install -r test-requirements.txt

.github/workflows/pytest.yml

@@ -25,15 +25,9 @@ jobs:
  python -m pip install --upgrade pip
  if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
  if [ -f test-requirements.txt ]; then pip install -r test-requirements.txt; fi
- - name: Lint with flake8
+ - name: Test with unittest
  run: |
- # stop the build if there are Python syntax errors or undefined names
- flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
- # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
- flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
- - name: Test with pytest
- run: |
- coverage run --source podman_compose -m pytest ./pytests
- python -m pytest ./tests
+ coverage run --source podman_compose -m unittest pytests/*.py
+ python -m unittest tests/*.py
  coverage combine
  coverage report

CONTRIBUTING.md

@@ -41,8 +41,8 @@ $ pre-commit run --all-files
 ```
 6. Run code coverage
 ```shell
-coverage run --source podman_compose -m pytest ./pytests
-python -m pytest ./tests
+coverage run --source podman_compose -m unittest pytests/*.py
+python -m unittest tests/*.py
 coverage combine
 coverage report
 coverage html

README.md

@@ -103,11 +103,11 @@ There is also AWX 17.1.0
 Inside `tests/` directory we have many useless docker-compose stacks
 that are meant to test as many cases as we can to make sure we are compatible
 
-### Unit tests with pytest
-run a pytest with following command
+### Unit tests with unittest
+run a unittest with following command
 
 ```shell
-python -m pytest pytests
+python -m unittest pytests/*.py
 ```
 
 # Contributing guide

pytests/test_can_merge_build.py

@@ -2,127 +2,105 @@
 import os
 import argparse
 import yaml
+import unittest
+from parameterized import parameterized
 from podman_compose import normalize_service, PodmanCompose
 
 
-test_cases_simple = [
- ({"test": "test"}, {"test": "test"}),
- ({"build": "."}, {"build": {"context": "."}}),
- ({"build": "./dir-1"}, {"build": {"context": "./dir-1"}}),
- ({"build": {"context": "./dir-1"}}, {"build": {"context": "./dir-1"}}),
- (
- {"build": {"dockerfile": "dockerfile-1"}},
- {"build": {"dockerfile": "dockerfile-1"}},
- ),
- (
- {"build": {"context": "./dir-1", "dockerfile": "dockerfile-1"}},
- {"build": {"context": "./dir-1", "dockerfile": "dockerfile-1"}},
- ),
-]
-
-
-def test_normalize_service_simple():
- for test_case, expected in copy.deepcopy(test_cases_simple):
- test_original = copy.deepcopy(test_case)
- test_case = normalize_service(test_case)
- test_result = expected == test_case
- if not test_result:
- print("test: ", test_original)
- print("expected: ", expected)
- print("actual: ", test_case)
- assert test_result
-
-
-test_cases_sub_dir = [
- ({"test": "test"}, {"test": "test"}),
- ({"build": "."}, {"build": {"context": "./sub_dir/."}}),
- ({"build": "./dir-1"}, {"build": {"context": "./sub_dir/dir-1"}}),
- ({"build": {"context": "./dir-1"}}, {"build": {"context": "./sub_dir/dir-1"}}),
- (
- {"build": {"dockerfile": "dockerfile-1"}},
- {"build": {"context": "./sub_dir", "dockerfile": "dockerfile-1"}},
- ),
- (
- {"build": {"context": "./dir-1", "dockerfile": "dockerfile-1"}},
- {"build": {"context": "./sub_dir/dir-1", "dockerfile": "dockerfile-1"}},
- ),
-]
-
-
-def test_normalize_service_with_sub_dir():
- for test_case, expected in copy.deepcopy(test_cases_sub_dir):
- test_original = copy.deepcopy(test_case)
- test_case = normalize_service(test_case, sub_dir="./sub_dir")
- test_result = expected == test_case
- if not test_result:
- print("test: ", test_original)
- print("expected: ", expected)
- print("actual: ", test_case)
- assert test_result
-
-
-test_cases_merges = [
- ({}, {}, {}),
- ({}, {"test": "test"}, {"test": "test"}),
- ({"test": "test"}, {}, {"test": "test"}),
- ({"test": "test-1"}, {"test": "test-2"}, {"test": "test-2"}),
- ({}, {"build": "."}, {"build": {"context": "."}}),
- ({"build": "."}, {}, {"build": {"context": "."}}),
- ({"build": "./dir-1"}, {"build": "./dir-2"}, {"build": {"context": "./dir-2"}}),
- ({}, {"build": {"context": "./dir-1"}}, {"build": {"context": "./dir-1"}}),
- ({"build": {"context": "./dir-1"}}, {}, {"build": {"context": "./dir-1"}}),
- (
- {"build": {"context": "./dir-1"}},
- {"build": {"context": "./dir-2"}},
- {"build": {"context": "./dir-2"}},
- ),
- (
- {},
- {"build": {"dockerfile": "dockerfile-1"}},
- {"build": {"dockerfile": "dockerfile-1"}},
- ),
- (
- {"build": {"dockerfile": "dockerfile-1"}},
- {},
- {"build": {"dockerfile": "dockerfile-1"}},
- ),
- (
- {"build": {"dockerfile": "./dockerfile-1"}},
- {"build": {"dockerfile": "./dockerfile-2"}},
- {"build": {"dockerfile": "./dockerfile-2"}},
- ),
- (
- {"build": {"dockerfile": "./dockerfile-1"}},
- {"build": {"context": "./dir-2"}},
- {"build": {"dockerfile": "./dockerfile-1", "context": "./dir-2"}},
- ),
- (
- {"build": {"dockerfile": "./dockerfile-1", "context": "./dir-1"}},
- {"build": {"dockerfile": "./dockerfile-2", "context": "./dir-2"}},
- {"build": {"dockerfile": "./dockerfile-2", "context": "./dir-2"}},
- ),
- (
- {"build": {"dockerfile": "./dockerfile-1"}},
- {"build": {"dockerfile": "./dockerfile-2", "args": ["ENV1=1"]}},
- {"build": {"dockerfile": "./dockerfile-2", "args": ["ENV1=1"]}},
- ),
- (
- {"build": {"dockerfile": "./dockerfile-2", "args": ["ENV1=1"]}},
- {"build": {"dockerfile": "./dockerfile-1"}},
- {"build": {"dockerfile": "./dockerfile-1", "args": ["ENV1=1"]}},
- ),
- (
- {"build": {"dockerfile": "./dockerfile-2", "args": ["ENV1=1"]}},
- {"build": {"dockerfile": "./dockerfile-1", "args": ["ENV2=2"]}},
- {"build": {"dockerfile": "./dockerfile-1", "args": ["ENV1=1", "ENV2=2"]}},
- ),
-]
-
-
-def test__parse_compose_file_when_multiple_composes() -> None:
- for test_input, test_override, expected_result in copy.deepcopy(test_cases_merges):
- compose_test_1 = {"services": {"test-service": test_input}}
- compose_test_2 = {"services": {"test-service": test_override}}
+class TestMergeBuild(unittest.TestCase):
+ @parameterized.expand([
+ ({"test": "test"}, {"test": "test"}),
+ ({"build": "."}, {"build": {"context": "."}}),
+ ({"build": "./dir-1"}, {"build": {"context": "./dir-1"}}),
+ ({"build": {"context": "./dir-1"}}, {"build": {"context": "./dir-1"}}),
+ (
+ {"build": {"dockerfile": "dockerfile-1"}},
+ {"build": {"dockerfile": "dockerfile-1"}},
+ ),
+ (
+ {"build": {"context": "./dir-1", "dockerfile": "dockerfile-1"}},
+ {"build": {"context": "./dir-1", "dockerfile": "dockerfile-1"}},
+ ),
+ ])
+ def test_simple(self, input, expected):
+ self.assertEqual(normalize_service(input), expected)
+
+ @parameterized.expand([
+ ({"test": "test"}, {"test": "test"}),
+ ({"build": "."}, {"build": {"context": "./sub_dir/."}}),
+ ({"build": "./dir-1"}, {"build": {"context": "./sub_dir/dir-1"}}),
+ ({"build": {"context": "./dir-1"}}, {"build": {"context": "./sub_dir/dir-1"}}),
+ (
+ {"build": {"dockerfile": "dockerfile-1"}},
+ {"build": {"context": "./sub_dir", "dockerfile": "dockerfile-1"}},
+ ),
+ (
+ {"build": {"context": "./dir-1", "dockerfile": "dockerfile-1"}},
+ {"build": {"context": "./sub_dir/dir-1", "dockerfile": "dockerfile-1"}},
+ ),
+ ])
+ def test_normalize_service_with_sub_dir(self, input, expected):
+ self.assertEqual(normalize_service(input, sub_dir="./sub_dir"), expected)
+
+ @parameterized.expand([
+ ({}, {}, {}),
+ ({}, {"test": "test"}, {"test": "test"}),
+ ({"test": "test"}, {}, {"test": "test"}),
+ ({"test": "test-1"}, {"test": "test-2"}, {"test": "test-2"}),
+ ({}, {"build": "."}, {"build": {"context": "."}}),
+ ({"build": "."}, {}, {"build": {"context": "."}}),
+ ({"build": "./dir-1"}, {"build": "./dir-2"}, {"build": {"context": "./dir-2"}}),
+ ({}, {"build": {"context": "./dir-1"}}, {"build": {"context": "./dir-1"}}),
+ ({"build": {"context": "./dir-1"}}, {}, {"build": {"context": "./dir-1"}}),
+ (
+ {"build": {"context": "./dir-1"}},
+ {"build": {"context": "./dir-2"}},
+ {"build": {"context": "./dir-2"}},
+ ),
+ (
+ {},
+ {"build": {"dockerfile": "dockerfile-1"}},
+ {"build": {"dockerfile": "dockerfile-1"}},
+ ),
+ (
+ {"build": {"dockerfile": "dockerfile-1"}},
+ {},
+ {"build": {"dockerfile": "dockerfile-1"}},
+ ),
+ (
+ {"build": {"dockerfile": "./dockerfile-1"}},
+ {"build": {"dockerfile": "./dockerfile-2"}},
+ {"build": {"dockerfile": "./dockerfile-2"}},
+ ),
+ (
+ {"build": {"dockerfile": "./dockerfile-1"}},
+ {"build": {"context": "./dir-2"}},
+ {"build": {"dockerfile": "./dockerfile-1", "context": "./dir-2"}},
+ ),
+ (
+ {"build": {"dockerfile": "./dockerfile-1", "context": "./dir-1"}},
+ {"build": {"dockerfile": "./dockerfile-2", "context": "./dir-2"}},
+ {"build": {"dockerfile": "./dockerfile-2", "context": "./dir-2"}},
+ ),
+ (
+ {"build": {"dockerfile": "./dockerfile-1"}},
+ {"build": {"dockerfile": "./dockerfile-2", "args": ["ENV1=1"]}},
+ {"build": {"dockerfile": "./dockerfile-2", "args": ["ENV1=1"]}},
+ ),
+ (
+ {"build": {"dockerfile": "./dockerfile-2", "args": ["ENV1=1"]}},
+ {"build": {"dockerfile": "./dockerfile-1"}},
+ {"build": {"dockerfile": "./dockerfile-1", "args": ["ENV1=1"]}},
+ ),
+ (
+ {"build": {"dockerfile": "./dockerfile-2", "args": ["ENV1=1"]}},
+ {"build": {"dockerfile": "./dockerfile-1", "args": ["ENV2=2"]}},
+ {"build": {"dockerfile": "./dockerfile-1", "args": ["ENV1=1", "ENV2=2"]}},
+ ),
+ ])
+ def test_parse_compose_file_when_multiple_composes(self, input, override, expected):
+ compose_test_1 = {"services": {"test-service": input}}
+ compose_test_2 = {"services": {"test-service": override}}
  dump_yaml(compose_test_1, "test-compose-1.yaml")
  dump_yaml(compose_test_2, "test-compose-2.yaml")
 
@@ -135,15 +113,7 @@ def test__parse_compose_file_when_multiple_composes() -> None:
  if podman_compose.services:
  podman_compose.services["test-service"].pop("_deps")
  actual_compose = podman_compose.services["test-service"]
- if actual_compose != expected_result:
- print("compose: ", test_input)
- print("override: ", test_override)
- print("expected: ", expected_result)
- print("actual: ", actual_compose)
-
- compose_expected = expected_result
-
- assert compose_expected == actual_compose
+ self.assertEqual(actual_compose, expected)
 
 
 def set_args(podman_compose: PodmanCompose, file_names: list[str]) -> None: