test and document changes

.github/workflows/python-package-pip.yml

@@ -24,7 +24,16 @@ jobs:
           python -m pip install .
           python -m pip install pytest
 
-      - name: Run tests
+      - name: Run tests (non-distributed)
+        env:
+          AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
+          AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+        run: |
+          python -m pytest tests/
+      - name: Install distributed dependencies
+        run: |
+          python -m pip install .[dask-distributed]
+      - name: Run tests (distributed)
         env:
           AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
           AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}

CHANGELOG.md

@@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+- add support for CLI calls. ![\25](https://github.com/mllam/mllam-data-prep/pull/25).
 - add optional output path argument to parser. ![\#26](https://github.com/mllam/mllam-data-prep/pull/26)
 
 ### Changed
@@ -18,6 +19,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - fix typo in install dependency `distributed` ![\#20](https://github.com/mllam/mllam-data-prep/pull/20)
 - add missing `psutil` requirement. [\#21](https://github.com/mllam/mllam-data-prep/pull/21).
 
+
 ## [v0.3.0](https://github.com/mllam/mllam-data-prep/releases/tag/v0.3.0)
 
 [All changes](https://github.com/mllam/mllam-data-prep/compare/v0.3.0...v0.2.0)

tests/test_cli.py

@@ -0,0 +1,14 @@
+import tempfile
+
+import pytest
+import xarray as xr
+
+from mllam_data_prep.cli import call
+
+
+@pytest.mark.parametrize("args", [["example.danra.yaml"]])
+def test_call(args):
+    with tempfile.TemporaryDirectory(suffix=".zarr") as tmpdir:
+        args.extend(["--output", tmpdir])
+        call(args)
+        _ = xr.open_zarr(tmpdir)

tests/test_distributed.py

@@ -0,0 +1,53 @@
+import importlib
+import tempfile
+
+import pytest
+import xarray as xr
+
+from mllam_data_prep.cli import call
+
+
+def call_wrapper(args):
+    with tempfile.TemporaryDirectory(suffix=".zarr") as tmpdir:
+        args.extend(["--output", tmpdir])
+        call(args)
+        _ = xr.open_zarr(tmpdir)
+
+
+def distributed():
+    """Check if dask.distributed is installed"""
+    try:
+        importlib.import_module("dask.distributed")
+
+        return True
+    except (ModuleNotFoundError, ImportError):
+        return False
+
+
+@pytest.mark.parametrize(
+    "args",
+    [
+        ["example.danra.yaml", "--dask-distributed-local-core-fraction", "1.0"],
+        ["example.danra.yaml"],
+    ],
+)
+def test_run_distributed(args):
+    if distributed():
+        call_wrapper(args)
+    elif not distributed() and "--dask-distributed-local-core-fraction" in args:
+        index = args.index("--dask-distributed-local-core-fraction")
+        core_fraction = float(args[index + 1])
+        if core_fraction > 0:
+            pytest.raises(
+                NameError,
+                call_wrapper,
+                args=args,
+            )
+        else:
+            pytest.raises(
+                ModuleNotFoundError,
+                call_wrapper,
+                args=args,
+            )
+    else:
+        call_wrapper(args)