🔨 New settings-library for settings (ITISFoundation#2395)

* NEW packages/settings-library package for settings : implements new settings designed drafted in sample-app-settings repo.
* ADDS new fixtures pytest_simcore.cli_runner
* UPDATED storage service: replaces model_library.settings by settings_library

Author: pcrespov

.github/CODEOWNERS

@@ -17,6 +17,7 @@ Makefile                                  @pcrespov, @sanderegg
 /packages/pytest-simcore/                 @pcrespov, @sanderegg
 /packages/service-integration/            @pcrespov, @sanderegg, @KZzizzle
 /packages/service-library/                @pcrespov
+/packages/settings-library/               @pcrespov, @sanderegg
 /requirements/                            @pcrespov
 /scripts/demo/                            @odeimaiz, @pcrespov
 /scripts/json-schema-to-openapi-schema    @sanderegg

.github/workflows/ci-testing-deploy.yml

@@ -614,6 +614,53 @@ jobs:
           name: codeclimate-${{ github.job }}-coverage
           path: codeclimate.${{ github.job }}_coverage.json
 
+  unit-test-settings-library:
+    name: "[unit] settings-library"
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        python: [3.8]
+        os: [ubuntu-20.04]
+      fail-fast: false
+    steps:
+      - uses: actions/checkout@v2
+      - name: setup docker
+        run: |
+          sudo ./ci/github/helpers/setup_docker_compose.bash
+          ./ci/github/helpers/setup_docker_experimental.bash
+      - name: setup python environment
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python }}
+      - name: show system version
+        run: ./ci/helpers/show_system_versions.bash
+      - uses: actions/cache@v2
+        name: getting cached data
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-settings-library-${{ hashFiles('packages/settings-library/requirements/ci.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-settings-library-
+            ${{ runner.os }}-pip-
+            ${{ runner.os }}-
+      - name: install
+        run: ./ci/github/unit-testing/settings-library.bash install
+      - name: test
+        run: ./ci/github/unit-testing/settings-library.bash test
+      - uses: codecov/codecov-action@v1
+        with:
+          flags: unittests #optional
+      - name: prepare codeclimate coverage file
+        run: |
+          curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-0.7.0-linux-amd64 > ./cc-test-reporter
+          chmod +x ./cc-test-reporter && ./cc-test-reporter --version
+          ./cc-test-reporter format-coverage -t coverage.py -o codeclimate.${{ github.job }}_coverage.json coverage.xml
+      - name: upload codeclimate coverage
+        uses: actions/upload-artifact@v2
+        with:
+          name: codeclimate-${{ github.job }}-coverage
+          path: codeclimate.${{ github.job }}_coverage.json
+
   unit-test-models-library:
     name: "[unit] models-library"
     runs-on: ${{ matrix.os }}
@@ -1853,6 +1900,7 @@ jobs:
         unit-test-dask-sidecar,
         unit-test-service-integration,
         unit-test-service-library,
+        unit-test-settings-library,
         unit-test-models-library,
         unit-test-simcore-sdk,
         unit-test-storage,
@@ -1911,6 +1959,7 @@ jobs:
         unit-test-python-linting,
         unit-test-service-integration,
         unit-test-service-library,
+        unit-test-settings-library,
         unit-test-models-library,
         unit-test-simcore-sdk,
         unit-test-storage,

ci/github/unit-testing/settings-library.bash

@@ -0,0 +1,29 @@
+#!/bin/bash
+# http://redsymbol.net/articles/unofficial-bash-strict-mode/
+set -o errexit   # abort on nonzero exitstatus
+set -o nounset   # abort on unbound variable
+set -o pipefail  # don't hide errors within pipes
+IFS=$'\n\t'
+
+install() {
+    bash ci/helpers/ensure_python_pip.bash
+    pushd packages/settings-library; pip3 install -r requirements/ci.txt; popd;
+    pip list -v
+}
+
+test() {
+    pytest --cov=settings_library --durations=10 --cov-append \
+          --color=yes --cov-report=term-missing --cov-report=xml --cov-config=.coveragerc \
+          -v packages/settings-library/tests
+}
+
+# Check if the function exists (bash specific)
+if declare -f "$1" > /dev/null
+then
+  # call arguments verbatim
+  "$@"
+else
+  # Show a helpful error
+  echo "'$1' is not a known function name" >&2
+  exit 1
+fi

packages/pytest-simcore/src/pytest_simcore/cli_runner.py

@@ -0,0 +1,25 @@
+# pylint: disable=redefined-outer-name
+#
+# Fixture to test Typer applications
+#
+# SEE https://typer.tiangolo.com/tutorial/testing/#testing-input
+# Based on https://github.com/Stranger6667/pytest-click
+
+
+from typing import Iterator
+
+import pytest
+from typer.testing import CliRunner
+
+
+@pytest.fixture
+def cli_runner() -> CliRunner:
+    """Instance of `typer.testing.CliRunner`"""
+    return CliRunner()
+
+
+@pytest.fixture
+def isolated_cli_runner(cli_runner: CliRunner) -> Iterator[CliRunner]:
+    """Instance of `typer.testing.CliRunner` running under a temporary working directory for isolated filesystem tests."""
+    with cli_runner.isolated_filesystem():
+        yield cli_runner

packages/settings-library/Makefile

@@ -0,0 +1,23 @@
+#
+# Targets for DEVELOPMENT of models Library
+#
+include ../../scripts/common.Makefile
+include ../../scripts/common-package.Makefile
+
+.PHONY: requirements
+requirements: ## compiles pip requirements (.in -> .txt)
+	@$(MAKE_C) requirements reqs
+
+
+.PHONY: install-dev install-prod install-ci
+install-dev install-prod install-ci: _check_venv_active ## install app in development/production or CI mode
+	# installing in $(subst install-,,$@) mode
+	pip-sync requirements/$(subst install-,,$@).txt
+
+
+.PHONY: tests
+tests: ## runs unit tests
+	# running unit tests
+	@pytest -vv --color=yes --exitfirst --failed-first --durations=10 \
+	--cov-config=../../.coveragerc --cov=settings_library --cov-report=term-missing \
+	--pdb $(CURDIR)/tests

packages/settings-library/README.md

@@ -0,0 +1,20 @@
+# simcore settings library
+
+Contains [pydantic](https://pydantic-docs.helpmanual.io/usage/settings/)-based
+common settings used for app configs
+
+SEE concept in https://github.com/pcrespov/sample-app-settings
+
+## Installation
+
+```console
+make help
+make install-dev
+```
+
+## Test
+
+```console
+make help
+make test-dev
+```

packages/settings-library/VERSION

@@ -0,0 +1 @@
+0.1.0

packages/settings-library/requirements/Makefile

@@ -0,0 +1,6 @@
+#
+# Targets to pip-compile requirements
+#
+include ../../../requirements/base.Makefile
+
+# Add here any extra explicit dependency: e.g. _migration.txt: _base.txt

packages/settings-library/requirements/_base.in

@@ -0,0 +1,10 @@
+#
+# Specifies third-party dependencies for 'models-library'
+#
+-c ../../../requirements/constraints.txt
+
+pydantic
+
+
+# extra
+typer

packages/settings-library/requirements/_base.txt

@@ -0,0 +1,16 @@
+#
+# This file is autogenerated by pip-compile with python 3.8
+# To update, run:
+#
+#    pip-compile --output-file=requirements/_base.txt requirements/_base.in
+#
+click==7.1.2
+    # via typer
+pydantic==1.8.2
+    # via
+    #   -c requirements/../../../requirements/constraints.txt
+    #   -r requirements/_base.in
+typer==0.3.2
+    # via -r requirements/_base.in
+typing-extensions==3.10.0.0
+    # via pydantic