Making bdd features optional as examples

Author: nullhack

hooks/post_gen_project.py

@@ -0,0 +1,25 @@
+{%- if cookiecutter.include_examples != "true" -%}
+"""A module for removing specific directories.
+
+This module provides a function to remove specific directories
+using the `shutil` and `pathlib` modules.
+
+Attributes:
+    REMOVE_PATHS (List[str]): A list of directory paths to be removed.
+
+"""
+
+import shutil
+from pathlib import Path
+
+REMOVE_PATHS = []
+REMOVE_PATHS = [
+    "features",
+    "tests/scenarios/steps",
+]
+
+for path in REMOVE_PATHS:
+    p = Path(".") / Path(path)
+    if p and p.exists() and p.is_dir():
+        shutil.rmtree(p)
+{% endif %}

{{cookiecutter.project_slug}}/features/simple_calculation.feature

@@ -0,0 +1,17 @@
+{%- if cookiecutter.include_examples == "true" -%}
+Feature: divide
+    The user should be able to divide two numbers.
+
+    Scenario Outline: Divide 'a' by 'b'
+        Given I have two numbers <a> and <b>
+
+        When I divide <a> by <b>
+
+        Then I should see <output>
+
+        Examples:
+        |   a   |   b   | output |
+        |  2.0  |  2.0  |  1.0   |
+        |  6.0  |  2.0  |  3.0   |
+        |  1.0  |  2.0  |  0.5   |
+{% endif %}

{{cookiecutter.project_slug}}/tests/scenarios/conftest.py

@@ -1,6 +1,8 @@
-"""Configuration file for pytest.
+"""A module for configuring pytest to include new features.
 
-This module will inject configuration scripts before running tests.
+This module provides a function to add new features automatically
+as test files in pytest. The new features will trigger errors because
+steps are not implemented.
 """
 from pathlib import Path
 

{{cookiecutter.project_slug}}/tests/scenarios/steps/simple_calculation_test.py

@@ -0,0 +1,65 @@
+{%- if cookiecutter.include_examples == "true" -%}
+"""Feature steps implementation.
+
+This script defines three steps for a BDD test using pytest-bdd. The test scenario is described in the simple_calculation.feature file.
+
+"""
+
+from pytest_bdd import given, parsers, scenarios, then, when
+
+from {{cookiecutter.package_name}}.{{cookiecutter.module_name}} import Calculator
+
+scenarios("simple_calculation.feature")
+
+
+@given(
+    parsers.parse("I have two numbers {a:f} and {b:f}"), target_fixture="varl"
+)
+def given_numbers(a: float, b: float) -> dict:
+    """Set the initial values for the calculator test.
+
+    Args:
+        a (float): The first number.
+        b (float): The second number.
+
+    Returns:
+        dict: A dictionary with keys "a" and "b" and their corresponding values.
+
+    """
+    return {"a": a, "b": b}
+
+
+@when(parsers.parse("I divide {a:f} by {b:f}"))
+def when_divide(varl: dict, a: float, b: float) -> None:
+    """Perform a division operation using the calculator.
+
+    Args:
+        varl (dict): A dictionary with the initial values for the calculator.
+        a (float): The dividend.
+        b (float): The divisor.
+
+    Returns:
+        None
+    """
+    calc = Calculator()
+    varl["output"] = calc.divide(varl["a"], varl["b"])
+
+
+@then(parsers.parse("I should see {output:f}"))
+def then_should_see(varl: dict, output: float) -> None:
+    """Verify if the result of the operation matches the expected output.
+
+    Args:
+        varl (dict): A dictionary with the initial values for the calculator and the result of the operation.
+        output (float): The expected output.
+
+    Returns:
+        None
+    """
+    assert varl["output"] == output
+{%- elif cookiecutter.include_examples != "true" -%}
+"""Feature steps implementation.
+
+This script defines three steps for a BDD test using pytest-bdd. The test scenario is described in the simple_calculation.feature file.
+
+"""{% endif %}