filedicts: unit test example

.github/workflows/esm_tools_actions.yml

@@ -31,7 +31,8 @@ jobs:
 
     - name: Run Pytest
       run: |
-        pip install pytest
+        # Install test requirements
+        pip install .[test]
         pytest -v .
         # For now, only test actual source code. Stuff like coupling scripts is ignored
         pytest -v --doctest-modules src --ignore src/esm_runscripts/coupling --ignore-glob "*backup*" 

setup.py

@@ -2,9 +2,10 @@
 
 """The setup script."""
 
-from setuptools import setup, find_packages
 from os import getenv
 
+from setuptools import find_packages, setup
+
 with open("README.rst") as readme_file:
     readme = readme_file.read()
 
@@ -38,7 +39,11 @@
 
 setup_requirements = []
 
-test_requirements = ["pyfakefs"]
+test_requirements = ["pytest", "pyfakefs"]
+
+extras = {
+    "test": test_requirements,
+}
 
 setup(
     author="Dirk Barbi",
@@ -90,6 +95,7 @@
     setup_requires=setup_requirements,
     test_suite="tests",
     tests_require=test_requirements,
+    extras_require=extras,
     url="https://github.com/esm-tools/esm_tools",
     version="6.13.4",
     zip_safe=False,

src/esm_runscripts/filedicts.py

@@ -0,0 +1,10 @@
+"""
+The file-dictionary implementation
+"""
+
+
+def copy_files(config):
+    """Copies files"""
+    # PG: No. We do not want this kind of general function. This is just to
+    # demonstrate how the test would work
+    return config

tests/test_esm_runscripts/test_filedicts.py

@@ -0,0 +1,41 @@
+"""
+Unit tests for the new file-dict feature
+
+Some considerations
+~~~~~~~~~~~~~~~~~~~
+* It might be clever to put the "fake config" somewhere in the top level, but
+  then again, it would be nice to have a unique config for each test. This is
+  undeniably more verbose, but we then have very clear examples to follow when
+  we want to translate later on.
+* You _could_ use the config in each function to generate the fake files, to
+  avoid repeating yourself; however, that adds real programming logic into the
+  unit test, which you don't really want.  
+"""
+import os
+
+import yaml
+
+import esm_runscripts.filedicts
+
+
+def test_example(fs):
+    # Make a fake config:
+    config = """
+    general:
+        base_dir: /some/dummy/location/
+    echam:
+        simulation_files:
+            jan_surf:
+                name: ECHAM Jan Surf File
+                path_in_pool: /work/ollie/pool/ECHAM/T63CORE2_jan_surf.nc
+                name_in_work: unit.24
+    """
+    config = yaml.safe_load(config)
+    # Create some fake files and directories you might want in your test
+    fs.create_file("/work/ollie/pool/ECHAM/T63CORE2_jan_surf.nc")
+    fs.create_dir("/some/dummy/location/expid/run_18500101-18501231/work")
+    # This module also have functions for link files, globbing, etc.
+    config_out = esm_runscripts.filedicts.copy_files(config)
+    assert os.path.exists(
+        "/some/dummy/location/expid/run_18500101-18501231/work/unit.24"
+    )