Make PyCIEMSS testable (#32)

* Refactor glue code into models

* Remove operations

* Install dev tools

* Add tests [mocking broken]

* Test if visual is True

* Document how to test

* Add CI for tests and formatting

* Link to file instead of URL for dataset

* Remove yaml lint

* Simplify API

* Fix imports on server

* Fix tests path

.github/workflows/correctness.yaml

@@ -0,0 +1,25 @@
+---
+name: Correctness
+on:
+ workflow_call:
+ push:
+ branches: ['main']
+ pull_request:
+ branches: ['main', 'dev/*']
+
+jobs:
+ correctness:
+ runs-on: ubuntu-22.04
+ steps:
+ - uses: actions/checkout@v1
+ - uses: actions/setup-python@v4
+ with:
+ python-version: '3.10'
+ - name: Run image
+ uses: abatilo/actions-poetry@v2
+ with:
+ poetry-version: 1.5.1
+ - name: Create environment
+ run: poetry install
+ - name: Pytest
+ run: poetry run pytest

.github/workflows/formatting.yaml

@@ -0,0 +1,27 @@
+---
+name: Formatting
+on:
+ workflow_call:
+ push:
+ branches: ['main']
+ pull_request:
+ branches: ['main', 'dev/*']
+
+jobs:
+ formatting:
+ runs-on: ubuntu-22.04
+ steps:
+ - uses: actions/checkout@v1
+ - uses: actions/setup-python@v4
+ with:
+ python-version: '3.10'
+ - name: Run image
+ uses: abatilo/actions-poetry@v2
+ with:
+ poetry-version: 1.5.1
+ - name: Create environment
+ run: poetry install
+ - name: Black
+ run: poetry run black . --check --verbose
+ - name: Ruff
+ run: poetry run ruff .

.pre-commit-config.yaml

@@ -0,0 +1,9 @@
+repos:
+ - repo: https://github.com/psf/black
+ rev: 23.7.0
+ hooks:
+ - id: black
+ - repo: https://github.com/astral-sh/ruff-pre-commit
+ rev: v0.0.282
+ hooks:
+ - id: ruff

Makefile

@@ -10,8 +10,15 @@ export LANG
 .PHONY:init
 init:
  make envfile; \
+ poetry run pre-commit install; \
  git submodule update --init; \
 
+
+.PHONY:tidy
+tidy: 
+ poetry run pre-commit run; \
+ poetry run pytest
+
 # Environment file copy
 envfile:
 ifeq ($(wildcard envfile),)

README.md

@@ -18,6 +18,10 @@ in order to pull the PyCIEMSS repository in as a submodule and set up the enviro
 
 to start the containers and the API. The API url will be `http://localhost:8010` by default 
 
+## Testing
+
+`poetry run pytest` executes tests. Run `make tidy` to execute the code formatter, tests, etc.
+
 ## Notes
 
 ### Result Files

docker/Dockerfile.api

@@ -8,6 +8,7 @@ RUN poetry config virtualenvs.create false && \
  poetry install --no-root --no-cache
 
 COPY service service
+COPY tests tests
 COPY README.md README.md
 
 RUN poetry install

docker/Dockerfile.worker

@@ -16,6 +16,7 @@ RUN poetry config virtualenvs.create false && \
 
 RUN pip install --no-cache-dir git+https://github.com/ciemss/pyciemss.git
 COPY service service
+COPY tests tests
 COPY README.md README.md
 
 ENV REDIS_HOST redis