Rename stage => files

Author: nichtich

.gitignore

@@ -2,7 +2,7 @@
 __pycache__
 .coverage
 reports/
-stage/
+files/
 downloads/
 config/
 config.json

Makefile

@@ -12,7 +12,7 @@ all: # TODO: include integration test with backends such as QPM
 	@. .venv/bin/activate && coverage run --branch -m pytest -v -s && coverage report -m && coverage html
 
 start:
-	@test -d stage || mkdir stage
+	@test -d files || mkdir files
 	@.venv/bin/python3 app.py
 
 lint:

README.md

@@ -60,7 +60,7 @@ The [default configuration](config.default.json) contains some base formats. To
 
 - `title` (title of the webservice) is set to "Validation Service" by default.
 - `port` (numeric port to run the webservice) is set to 7007 by default.
-- `stage` (stage directory for data files at the server) is set to `false` (disabled) by default.
+- `files` (stage directory for data files at the server) is set to `false` (disabled) by default.
 - `reports` (reports directory to store reports in) is set to `false` (disabled) by default.
 - `downloads` (cache directory for data retrieved via URL) is set to `false` (disabled) by default.
 
@@ -105,7 +105,7 @@ Validate data against an application profile and return a list of errors in [Dat
 
 - `data` as string
 - `url` to be downloaded from an URL (if the service is configured with `downloads` directory)
-- `file` to be read from a local file in the stage directory of the server (if the service is configured with `stage` directory)
+- `file` to be read from a local file in the stage directory of the server (if the service is configured with `files` directory)
 
 Status code is always 200 if validation could be executed, no matter whether errors have been found or not. For example validating the string `[1,2` at default profile `json` results in the following validation response. The error position (after the fourth character on line 1) is referenced with multiple dimensions. Dimension values are always strings.
 

config.default.json

@@ -1,6 +1,6 @@
 {
   "port": 7007,
-  "stage": false,
+  "files": false,
   "reports": false,
   "downloads": false,
   "profiles": [

lib/service.py

@@ -21,7 +21,7 @@ def __init__(self, config=None, **kwargs):
 
         self.root = config.get("root", None)
 
-        for name in ['stage', 'reports', 'downloads']:
+        for name in ['files', 'reports', 'downloads']:
             path = config.get(name, False)
             if path:
                 path = Path(path)
@@ -63,12 +63,12 @@ def validate(self, profile, data=None, url=None, file=None):
             else:
                 raise ValueError("This service does not support passing data via URL")
         else:
-            if self.stage:
+            if self.files:
                 if not re.match('^[a-zA-Z0-9_-][a-z0-9._-]*$', file):
                     raise ValueError("Filename must contain only characters [a-zA-Z0-9._-]")
-                file = Path(self.stage / file)
+                file = Path(self.files / file)
                 if not file.is_file():
-                    raise LookupError(f"File not found in local stage: {file.name}")
+                    raise LookupError(f"File not found in local files: {file.name}")
             else:
                 raise ValueError("This service does not support passing data at server")
 

tests/test_api.py

@@ -34,18 +34,18 @@ def tmp_dir():
 def client(tmp_dir):
     app.testing = True
 
-    stage = Path(__file__).parent / 'files'
+    files = Path(__file__).parent / 'files'
 
     profiles = [{
         "id": "json",
         "checks": ["json"]
     }]
-    init(dict(title="Validation Service Test", stage=stage, downloads=tmp_dir, profiles=profiles))
+    init(dict(title="Validation Service Test", files=files, downloads=tmp_dir, profiles=profiles))
 
     with app.test_client() as client:
         setattr(client, 'fail', lambda *args, **kw: expect_fail(client, *args, **kw))
         setattr(client, 'fine', lambda *args, **kw: expect_fine(client, *args, **kw))
-        setattr(client, 'stage', stage)
+        setattr(client, 'files', files)
         yield client
 
 
@@ -84,7 +84,7 @@ def test_validate_file(client):
                 error="Filename must contain only characters [a-zA-Z0-9._-]")
 
     client.fail('GET', '/json/validate?file=not.found', code=404,
-                error="File not found in local stage: not.found")
+                error="File not found in local files: not.found")
 
     client.fine('GET', '/json/validate?file=valid.json')
 

tests/test_service.py

@@ -36,10 +36,10 @@ def test_config():
         service.validate('json', data=42)
 
     with TemporaryDirectory() as path:
-        service = ValidationService(stage=path, profiles=[])
+        service = ValidationService(files=path, profiles=[])
 
-        with pytest.raises(FileNotFoundError, match=r"Missing stage directory:"):
-            service = ValidationService(stage=f"{path}/XXX", profiles=[])
+        with pytest.raises(FileNotFoundError, match=r"Missing files directory:"):
+            service = ValidationService(files=f"{path}/XXX", profiles=[])
 
         service = ValidationService(profiles=profiles, downloads=path)