🔨 Updates settings and removes config files: storage service (ITISFoundation#2369)

* Updates settings and removes config files

* ❤️ emoticon prefix

* linter and adds json-schema flag in CLI

* Removing Dict configs

* constants are not settings

* And of course, renaming

* adds typer as CLI

* Updates testing dependencies and adds python-dotenv

* Updates CLI and fixes entrypoints

* GitHK review: adds a test to enforce settings config

* @GitHK review: using attrs from new settings

* @GitHK review: test refactor

* @GitHK review: using attrs instead of keys

Author: pcrespov

.env-devel

@@ -1,6 +1,12 @@
 #
 # - Keep it alfphabetical order and grouped by prefix [see vscode cmd: Sort Lines Ascending]
-# - To expose:  export $(grep -v '^#' .env | xargs -0)
+# - To expose:
+#     set -o allexport
+#     source .env
+#     set +o allexport
+#   or
+#     export $(grep -v '^#' .env | xargs)
+#     unset  $(grep -v '^#' .env | sed -E 's/(.*)=.*/\1/' | xargs)
 #
 
 API_SERVER_DEV_FEATURES_ENABLED=0

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,10 +1,18 @@
 <!-- Common title prefixes/annotations:
 
-  WIP:
-  bugfix:
-  🏗️ maintenance:
+WIP: work in progress
 
-  (⚠️ devops)  = changes in devops config required before deploying
+Consider prefix your PR message with an emoticon
+  🐛 bugfix
+  ✨ new feature
+  🔨 refactoring
+  🏗️ maintenance
+  📚 documentation
+
+and append (⚠️ devops) if changes in devops configuration required before deploying
+
+  SEE https://github.com/dannyfritz/commit-message-emoji
+  SEE https://emojipedia.org
 -->
 
 ## What do these changes do?

packages/models-library/src/models_library/settings/base.py

@@ -0,0 +1,35 @@
+from contextlib import suppress
+from typing import List, Tuple
+
+from pydantic import BaseSettings, Extra, SecretStr, ValidationError
+
+
+class BaseCustomSettings(BaseSettings):
+    class Config:
+        case_sensitive = False
+        extra = Extra.forbid
+        allow_mutation = False
+        frozen = True
+        validate_all = True
+        json_encoders = {SecretStr: lambda v: v.get_secret_value()}
+
+    @classmethod
+    def set_defaults_with_default_constructors(
+        cls, default_fields: List[Tuple[str, "BaseCustomSettings"]]
+    ):
+        # This funcion can set defaults on fields that are BaseSettings as well
+        # It is used in control construction of defaults.
+        # Pydantic offers a defaults_factory but it is executed upon creation of the Settings **class**
+        # which is too early for our purpose. Instead, we want to create the defaults just
+        # before the settings instance is constructed
+
+        assert issubclass(cls, BaseCustomSettings)
+
+        # Builds defaults at this point
+        for name, default_cls in default_fields:
+            with suppress(ValidationError):
+                default = default_cls()
+                field_obj = cls.__fields__[name]
+                field_obj.default = default
+                field_obj.field_info.default = default
+                field_obj.required = False

packages/service-library/src/servicelib/application.py

@@ -17,7 +17,7 @@ async def shutdown_info(app: web.Application):
 def create_safe_application(config: Optional[Dict] = None) -> web.Application:
     app = web.Application()
 
-    # Enxures config entry
+    # Ensures config entry
     app[APP_CONFIG_KEY] = config or {}
 
     app.on_startup.append(startup_info)

packages/service-library/src/servicelib/tracing.py

@@ -14,7 +14,7 @@
 
 
 def setup_tracing(
-    app: web.Application, app_name: str, host: str, port: str, config: Dict
+    app: web.Application, app_name: str, host: str, port: int, config: Dict
 ) -> bool:
     zipkin_address = f"{config['zipkin_endpoint']}/api/v2/spans"
     endpoint = az.create_endpoint(app_name, ipv4=host, port=port)

services/storage/Makefile

@@ -13,7 +13,7 @@ openapi-specs: ## updates and validates openapi specifications
 .PHONY: tests
 tests: ## runs unit tests
 	# running unit tests
-	@pytest -vv --exitfirst --failed-first --durations=10 --pdb $(CURDIR)/tests
+	@pytest -vv --failed-first --durations=10 --pdb $(CURDIR)/tests
 
 
 # DEVELOPMENT ########

services/storage/docker/boot.sh

@@ -24,23 +24,20 @@ if [ "${SC_BUILD_TARGET}" = "development" ]; then
   echo "$INFO" "PIP :"
   pip list | sed 's/^/    /'
 
-  APP_CONFIG=docker-dev-config.yaml
   echo "$INFO" "Setting entrypoint to use watchmedo autorestart..."
   entrypoint='watchmedo auto-restart --recursive --pattern="*.py" --'
 
 elif [ "${SC_BUILD_TARGET}" = "production" ]; then
-  APP_CONFIG=docker-prod-config.yaml
   entrypoint=""
 fi
 
 # RUNNING application ----------------------------------------
-echo "$INFO" "Selected config $APP_CONFIG"
-
+echo "$INFO" "Selected config ${SC_BUILD_TARGET}"
 if [ "${SC_BOOT_MODE}" = "debug-ptvsd" ]; then
   # NOTE: needs ptvsd installed
-  echo "$INFO" "PTVSD Debugger initializing in port 3000 with ${APP_CONFIG}"
+  echo "$INFO" "PTVSD Debugger initializing in port 3000 with ${SC_BUILD_TARGET}"
   eval "$entrypoint" python3 -m ptvsd --host 0.0.0.0 --port 3000 -m \
-    simcore_service_storage --config $APP_CONFIG
+    simcore_service_storage run
 else
-  exec simcore-service-storage --config $APP_CONFIG
+  exec simcore-service-storage run
 fi

services/storage/requirements/_base.in

@@ -20,7 +20,7 @@ aiopg[sa]
 
 tenacity
 semantic_version
-click
+typer
 minio
 urllib3
 

services/storage/requirements/_base.txt

@@ -62,7 +62,7 @@ chardet==4.0.0
     #   aiohttp
     #   requests
 click==7.1.2
-    # via -r requirements/_base.in
+    # via typer
 configparser==5.0.2
     # via blackfynn
 dataclasses==0.8
@@ -208,6 +208,8 @@ tenacity==7.0.0
     #   -r requirements/_base.in
 trafaret==2.1.0
     # via -r requirements/../../../packages/service-library/requirements/_base.in
+typer==0.3.2
+    # via -r requirements/_base.in
 typing-extensions==3.10.0.0
     # via
     #   aiohttp

services/storage/requirements/_test.in

@@ -17,6 +17,7 @@ pytest-mock
 pytest-runner
 pytest-sugar
 pylint
+python-dotenv
 
 # test coverage
 coverage