test: Add additional test cases and refactor

rushwerks · rushwerks · commit cad799cc9862 · 2024-09-16T10:42:41.000+01:00
diff --git a/README.md b/README.md
@@ -28,10 +28,9 @@ The formatter follows a list of pre-defined rules outlined below.
     * Tables/step text: Six spaces
 
 ## Installation
-To install the latest feefifofum version from the main branch, run the following command:
+Install the feefifofum directly from GitHub by running the following command:
 ```shell
-pip install git+https://github.com/rushwerks/feefifofum.git@v0.1.0
-
+pip install git+https://github.com/rushwerks/feefifofum.git@v0.1.1
 ```
 
 ## Usage
@@ -47,7 +46,7 @@ feefifofum <directory1> <directory2>
 `feefifofum` is also available as a pre-commit hook. It can be configured as follows:
 ```yaml
   - repo: https://github.com/rushwerks/feefifofum/
-    rev: v0.1.0
+    rev: v0.1.1
     hooks:
       - id: feefifofum
 ```
diff --git a/feefifofum/helpers/constants.py b/feefifofum/helpers/constants.py
@@ -8,11 +8,13 @@
 TABLE_LEFT_EDGE = '| '
 TABLE_RIGHT_EDGE = ' |\n'
 
+
 # Whitespace
 class Whitespace(NamedTuple):
     newline: int
     indent: int
 
+
 WHITESPACE_CONFIG: dict[str, Whitespace] = {
     'Feature': Whitespace(0, 0),
     'Scenario': Whitespace(2, 1),
diff --git a/feefifofum/helpers/whitespace.py b/feefifofum/helpers/whitespace.py
@@ -26,9 +26,10 @@ def format_whitespace(file_lines: list[str]) -> list[str]:
     for line in file_lines:
         leading_word = line.split(maxsplit=1)[0].rstrip(':')
 
-        if leading_word in WHITESPACE_CONFIG or line.startswith(TABLE_SEPARATOR):  # TODO: Test
-            newline, indent = WHITESPACE_CONFIG[leading_word]
-            previous_leading_word_match = leading_word
+        if leading_word in WHITESPACE_CONFIG or line.startswith(TABLE_SEPARATOR):
+            whitespace_key = leading_word if leading_word in WHITESPACE_CONFIG else TABLE_SEPARATOR
+            newline, indent = WHITESPACE_CONFIG[whitespace_key]
+            previous_leading_word_match = whitespace_key
         else:
             newline, indent = WHITESPACE_CONFIG.get(previous_leading_word_match, (0, 0))
             newline = 0  # Keep in same feature file block
diff --git a/pyproject.toml b/pyproject.toml
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "feefifofum"
-version = "0.1.0"
+version = "0.1.1"
 description = "Feature file formatter"
 readme = "README.md"
 requires-python = ">=3.7"
diff --git a/tests/data/full_file_expected.feature b/tests/data/full_file_expected.feature
@@ -4,20 +4,22 @@ Feature: Example test file for formatter
 
   Scenario: Test scenario for formatting
 
-    Given some contract and business partner data exists in system A
-      | contract_id | bp_id |
-      | contract_1  | 1     |
-      | contract_2  | 2     |
-
-    And some contracts data exists in system B
-      # Some random comment
+    Given contracts exist in system A
       | contract_id |
       | contract_1  |
-      | contract_3  |
+      | contract_2  |
+
+    And corresponding customers exists in system B
+      # Comment 1
+      # Comment 2
+      | contract_id | customer_id |
+      | contract_1  | customer_1  |
+      | contract_3  | customer_2  |
 
     Then the output table should show missing contract data and the error type
       """
-      Some other random comment
+      Multi-line
+      comment
       """
       | contract_id | error_type       | missing_in |
       | contract_2  | missing contract | B          |
diff --git a/tests/data/full_file_input.feature b/tests/data/full_file_input.feature
@@ -1,23 +1,25 @@
 
 Feature: Example test file for formatter
     This is an example feature file with poor formatting
+      Scenario: Test scenario for formatting
 
+    Given contracts exist in system A
+    |contract_id       |
+      |contract_1 |
+      | contract_2 |
 
-      Scenario: Test scenario for formatting
 
-    Given some contract and business partner data exists in system A
-    |contract_id       | bp_id |
-      |contract_1 | 1 |
-      | contract_2 | 2 |
-     And some contracts data exists in system B
-    # Some random comment
-      | contract_id       |
-      | contract_1    |
-      | contract_3 |
+     And corresponding customers exists in system B
+    # Comment 1
+      # Comment 2
+      | contract_id       | customer_id |
+      | contract_1    |customer_1   |
+      | contract_3 | customer_2 |
 
     Then the output table should show missing contract data and the error type
     """
-    Some other random comment
+    Multi-line
+  comment
     """
     | contract_id      | error_type              | missing_in |
       | contract_2 | missing contract   |B         |
diff --git a/tests/data/text_only_expected.feature b/tests/data/text_only_expected.feature
@@ -0,0 +1,17 @@
+Feature: Example test file for formatter
+  This is an example feature file with poor formatting
+
+
+  Scenario: Test scenario for formatting
+
+    Given contracts exist in system A
+
+    And corresponding customers exists in system B
+      # Comment 1
+      # Comment 2
+
+    Then the output table should show missing contract data and the error type
+      """
+      Multi-line
+      comment
+      """
diff --git a/tests/data/text_only_input.feature b/tests/data/text_only_input.feature
@@ -0,0 +1,17 @@
+
+Feature: Example test file for formatter
+    This is an example feature file with poor formatting
+      Scenario: Test scenario for formatting
+
+    Given contracts exist in system A
+
+
+     And corresponding customers exists in system B
+    # Comment 1
+      # Comment 2
+
+    Then the output table should show missing contract data and the error type
+    """
+    Multi-line
+  comment
+    """
diff --git a/tests/test_main.py b/tests/test_main.py
@@ -1,20 +1,30 @@
 from pathlib import Path
 
+import pytest
+
 from feefifofum.main import format_feature_file
 from feefifofum.utils.file_utils import read_file_lines
 
-
 ROOT_DIR = Path(__file__).resolve().parent
 
 
-def test_format_feature_file() -> None:
-    """Tests format_feature_file by running all transformations."""
-    file_path_input = ROOT_DIR / 'data' / 'example_input.feature'
-    file_path_expected = ROOT_DIR / 'data' / 'example_expected.feature'
+class TestFormatFeatureFile:
+    """Tests for format_feature_file()."""
+
+    test_data = [
+        ('full_file_input.feature', 'full_file_expected.feature'),
+        ('text_only_input.feature', 'text_only_expected.feature'),
+    ]
+
+    @pytest.mark.parametrize('input_file, expected_file', test_data)
+    def test_format_feature_file(self, input_file: str, expected_file: str) -> None:
+        """Tests format_feature_file by running all transformations."""
+        file_path_input = ROOT_DIR / 'data' / input_file
+        file_path_expected = ROOT_DIR / 'data' / expected_file
 
-    file_lines_input = read_file_lines(file_path_input)
-    formatted_output = format_feature_file(file_lines_input)
+        file_lines_input = read_file_lines(file_path_input)
+        formatted_output = format_feature_file(file_lines_input)
 
-    formatted_expected = read_file_lines(file_path_expected)
+        formatted_expected = read_file_lines(file_path_expected)
 
-    assert formatted_output == formatted_expected
+        assert formatted_output == formatted_expected
