Start testing cli

.gitignore

@@ -3,3 +3,5 @@ dist/
 *.pyc
 *.ipynb
 *.egg-info
+cli_tests/outputs
+.coverage

.travis.yml

@@ -11,5 +11,5 @@ install:
   - "pip install coveralls nose"
 script: 
   - "coverage run --source=pathsjson setup.py nosetests"
-  - "./cli_tests.sh"
+  - "./test_cli.sh"
 after_success: coveralls

cli_tests/full_env/.paths.json

@@ -0,0 +1,29 @@
+{
+    "clean_dir": [
+        "$data_dir",
+        "clean"
+    ],
+    "raw_dir": [
+        "$data_dir",
+        "raw"
+    ],
+    "latest_data": [
+        "$raw_dir",
+        "$$VERSION",
+        "data.csv"
+    ],
+    "test_dir": [
+        "$data_dir",
+        "tests"
+    ],
+    "__ENV": {
+        "VERSION": "1.0.0"
+    },
+    "data_dir": [
+        "data"
+    ],
+    "codebook_dir": [
+        "$clean_dir",
+        "codebooks"
+    ]
+}

cli_tests/test_1.expected.txt

@@ -0,0 +1 @@
+No `.paths.json` file found!

cli_tests/test_2.expected.txt

@@ -0,0 +1,6 @@
+export clean_dir="data/clean"
+export raw_dir="data/raw"
+export latest_data="data/raw/1.0.0/data.csv"
+export test_dir="data/tests"
+export data_dir="data"
+export codebook_dir="data/clean/codebooks"

cli_tests/test_3.expected.txt

@@ -0,0 +1,6 @@
+clean_dir?=data/clean
+raw_dir?=data/raw
+latest_data?=data/raw/1.0.0/data.csv
+test_dir?=data/tests
+data_dir?=data
+codebook_dir?=data/clean/codebooks

pathsjson/cli.py

@@ -5,7 +5,7 @@
 from pathsjson.impl import *
 
 
-def main(args=None):
+def _main(args=None):
     parser = argparse.ArgumentParser()
 
     parser.add_argument('--print-global-path',
@@ -61,5 +61,16 @@ def main(args=None):
             json.dump({"__ENV": {}}, fp, indent="    ")
             sys.exit()
 
-
     parser.print_help()
+
+
+def main(args=None):
+    try:
+        _main(args)
+    except IOError as e:
+        print(e)
+        sys.exit(1)
+
+
+if __name__ == '__main__':
+    main(sys.argv[1:])

pathsjson/impl.py

@@ -178,8 +178,11 @@ def create_user_globals_file(overwrite=False):
 
 def patch_with_user_globals(data, skip_noexist=True):
     file_path = get_user_globals_path()
-    if not skip_noexist and not os.path.exists(file_path):
-        raise IOError("User globals missing at: ".format(file_path))
+    if not os.path.exists(file_path):
+        if skip_noexist:
+            return data
+        else:
+            raise IOError("User globals missing at: ".format(file_path))
 
     with open(file_path) as fp:
         global_data = json.load(fp, object_pairs_hook=OrderedDict)
@@ -246,9 +249,13 @@ def __init__(self, file_path=None, src_dir=None, target_name=".paths.json",
         self._enable_env_overrides = enable_env_overrides
         self._enable_user_global_overrides = enable_user_global_overrides
         self._validate = validate
+
         self.reload()
 
     def reload(self):
+        """
+        Reload the path definitions.
+        """
         file_path = self._file_path
         enable_env_overrides = self._enable_env_overrides
         enable_user_global_overrides = self._enable_user_global_overrides

test_cli.sh

@@ -0,0 +1,47 @@
+#!/bin/bash
+
+###############################################################################
+# setUp
+###############################################################################
+
+set -ev  # Fail on first non-zero return value.
+rm -rf cli_tests/outputs && mkdir cli_tests/outputs
+
+###############################################################################
+# Test that automagic importing works.
+###############################################################################
+
+PWD=tests/examples/twitter python -c "from pathsjson.automagic import PATHS;"
+
+###############################################################################
+# 1. Test without any ancestral .paths.json
+###############################################################################
+
+(coverage run --source=pathsjson --append -m pathsjson.cli --shell-exports \
+    > cli_tests/outputs/test_1.txt) || true
+
+cmp -b cli_tests/outputs/test_1.txt cli_tests/test_1.expected.txt
+
+###############################################################################
+# 2. Test --shell-exports
+###############################################################################
+
+(PWD=cli_tests/full_env 
+    coverage run --source=pathsjson --append -m pathsjson.cli --shell-exports \
+    > cli_tests/outputs/test_2.txt) || true
+
+diff cli_tests/outputs/test_2.txt cli_tests/test_2.expected.txt
+
+###############################################################################
+# 3. Test --make-exports
+###############################################################################
+
+(PWD=cli_tests/full_env \
+    coverage run --source=pathsjson --append -m pathsjson.cli --make-exports \
+    > cli_tests/outputs/test_3.txt) || true
+diff cli_tests/outputs/test_3.txt cli_tests/test_3.expected.txt
+
+###############################################################################
+# tearDown
+###############################################################################
+rm -rf cli_tests/outputs

tests/fixtures/paths_with_args.json

@@ -0,0 +1,4 @@
+{
+    "__ENV": { "VERSION": "1.0.0" },
+    "special": ["root", "$$VERSION", "$$user_name"]
+}

tests/test_pathsjson.py

@@ -52,7 +52,11 @@ def delete_and_replace(path):
             with open(path, "w") as fp:
                 fp.write(src)
     else:
-        yield
+        try:
+            yield
+        finally:
+            if os.path.exists(path):
+                os.unlink(path)
 
 ###############################################################################