Test cli help (#391)

* test if showing --help of CLI commands runs without trouble

Signed-off-by: Nicolas Höning <nicolas@seita.nl>

* add name attribute to QuantityField which was causing --help of create schedule CLI to fail

Signed-off-by: Nicolas Höning <nicolas@seita.nl>

* Allow MarshmallowClickMixin to be used for custom fields that define their own __init__

Signed-off-by: F.N. Claessen <felix@seita.nl>

* black

Signed-off-by: F.N. Claessen <felix@seita.nl>

* more generic way to list the click commands per module

Signed-off-by: Nicolas Höning <nicolas@seita.nl>

Co-authored-by: F.N. Claessen <felix@seita.nl>

flexmeasures/cli/data_add.py

@@ -848,6 +848,7 @@ def create_schedule(
     """Create a new schedule for a given power sensor.
 
     Current limitations:
+
     - only supports battery assets and Charge Points
     - only supports datetimes on the hour or a multiple of the sensor resolution thereafter
     """

flexmeasures/cli/tests/test_data_add.py

@@ -6,6 +6,7 @@
     AccountAnnotationRelationship,
 )
 from flexmeasures.data.models.data_sources import DataSource
+from flexmeasures.cli.tests.utils import get_click_commands
 
 
 @pytest.mark.skip_github
@@ -75,3 +76,14 @@ def test_add_holidays(app, db, setup_roles_users):
         .count()
         == 11
     )
+
+
+def test_cli_help(app):
+    """Test that showing help does not throw an error."""
+    from flexmeasures.cli import data_add
+
+    runner = app.test_cli_runner()
+    for cmd in get_click_commands(data_add):
+        result = runner.invoke(cmd, ["--help"])
+        assert result.exit_code == 0
+        assert "Usage" in result.output

flexmeasures/cli/tests/test_data_edit.py

@@ -5,6 +5,7 @@
 
 from flexmeasures.cli.tests.utils import to_flags
 from flexmeasures.data.models.time_series import Sensor, TimedBelief
+from flexmeasures.cli.tests.utils import get_click_commands
 
 
 @pytest.mark.skip
@@ -101,3 +102,14 @@ def test_resample_sensor_data(
         resample_sensor_data, to_flags(cli_input) + ["--skip-integrity-check"]
     )
     assert "Successfully resampled" in result.output
+
+
+def test_cli_help(app):
+    """Test that showing help does not throw an error."""
+    from flexmeasures.cli import data_edit
+
+    runner = app.test_cli_runner()
+    for cmd in get_click_commands(data_edit):
+        result = runner.invoke(cmd, ["--help"])
+        assert result.exit_code == 0
+        assert "Usage" in result.output

flexmeasures/cli/tests/test_data_show.py

@@ -1,6 +1,7 @@
 import pytest
 
 from flexmeasures.data.models.time_series import Sensor
+from flexmeasures.cli.tests.utils import get_click_commands
 
 
 @pytest.mark.skip_github
@@ -110,3 +111,15 @@ def test_plot_beliefs(app, fresh_db, setup_beliefs_fresh_db):
     assert "Data spans an hour" in result.output
 
     assert result.exit_code == 0
+
+
+def test_cli_help(app):
+    """Test that showing help does not throw an error."""
+    from flexmeasures.cli import data_show
+
+    runner = app.test_cli_runner()
+    for cmd in get_click_commands(data_show):
+        result = runner.invoke(cmd, ["--help"])
+        assert "Usage" in result.output
+        assert cmd.__doc__.strip() in result.output
+        assert result.exit_code == 0

flexmeasures/cli/tests/utils.py

@@ -1,3 +1,8 @@
+from typing import List, Callable
+
+from click.core import Command as ClickCommand
+
+
 def to_flags(cli_input: dict) -> list:
     """Turn dictionary of CLI input into a list of CLI flags ready for use in FlaskCliRunner.invoke().
 
@@ -18,3 +23,11 @@ def to_flags(cli_input: dict) -> list:
         )
         for item in sublist
     ]
+
+
+def get_click_commands(module) -> List[Callable]:
+    return [
+        getattr(module, attr)
+        for attr in dir(module)
+        if type(getattr(module, attr)) == ClickCommand
+    ]

flexmeasures/data/schemas/generic_assets.py

@@ -93,7 +93,7 @@ class Meta:
         model = GenericAssetType
 
 
-class GenericAssetIdField(fields.Int, MarshmallowClickMixin):
+class GenericAssetIdField(MarshmallowClickMixin, fields.Int):
     """Field that deserializes to a GenericAsset and serializes back to an integer."""
 
     @with_appcontext

flexmeasures/data/schemas/sensors.py

@@ -52,7 +52,7 @@ class Meta:
         model = Sensor
 
 
-class SensorIdField(fields.Int, MarshmallowClickMixin):
+class SensorIdField(MarshmallowClickMixin, fields.Int):
     """Field that deserializes to a Sensor and serializes back to an integer."""
 
     @with_appcontext

flexmeasures/data/schemas/times.py

@@ -13,7 +13,7 @@ class DurationValidationError(FMValidationError):
     status = "INVALID_PERIOD"  # USEF error status
 
 
-class DurationField(fields.Str, MarshmallowClickMixin):
+class DurationField(MarshmallowClickMixin, fields.Str):
     """Field that deserializes to a ISO8601 Duration
     and serializes back to a string."""
 
@@ -64,7 +64,7 @@ def ground_from(
         return duration
 
 
-class AwareDateTimeField(fields.AwareDateTime, MarshmallowClickMixin):
+class AwareDateTimeField(MarshmallowClickMixin, fields.AwareDateTime):
     """Field that de-serializes to a timezone aware datetime
     and serializes back to a string."""
 

flexmeasures/data/schemas/units.py

@@ -18,7 +18,7 @@ def __call__(self, value):
         return value
 
 
-class QuantityField(fields.Str, MarshmallowClickMixin):
+class QuantityField(MarshmallowClickMixin, fields.Str):
     """Marshmallow/Click field for validating quantities against a unit registry.
 
     The FlexMeasures unit registry is based on the pint library.

flexmeasures/data/schemas/utils.py

@@ -4,6 +4,10 @@
 
 
 class MarshmallowClickMixin(click.ParamType):
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.name = self.__class__.__name__
+
     def get_metavar(self, param):
         return self.__class__.__name__