♻️ Major cleanup of catalog service

.env-devel

@@ -30,6 +30,7 @@ AUTOSCALING_LOGLEVEL=WARNING
 AUTOSCALING_NODES_MONITORING=null
 AUTOSCALING_POLL_INTERVAL=10
 
+CATALOG_BACKGROUND_TASK_REST_TIME=60
 CATALOG_DEV_FEATURES_ENABLED=0
 CATALOG_HOST=catalog
 CATALOG_LOGLEVEL=WARNING

scripts/common-service.Makefile

@@ -180,3 +180,23 @@ _run-test-ci: _check_venv_active
 .PHONY: _assert_target_defined
 _assert_target_defined:
 	$(if $(target),,$(error unset argument 'target' is required))
+
+
+
+
+#
+# OPENAPI SPECIFICATIONS ROUTINES
+#
+
+
+# specification of the used openapi-generator-cli (see also https://github.com/ITISFoundation/openapi-generator)
+OPENAPI_GENERATOR_NAME := itisfoundation/openapi-generator-cli-openapi-generator-v4.2.3
+OPENAPI_GENERATOR_TAG := v0
+OPENAPI_GENERATOR_IMAGE := $(OPENAPI_GENERATOR_NAME):$(OPENAPI_GENERATOR_TAG)
+
+define validate_openapi_specs
+	# Validating OAS '$(1)' ...
+	docker run --rm \
+			--volume "$(CURDIR):/local" \
+			$(OPENAPI_GENERATOR_IMAGE) validate --input-spec /local/$(strip $(1))
+endef

services/api-server/tests/unit/conftest.py

@@ -408,7 +408,7 @@ def mocked_catalog_service_api_base(
             text="simcore_service_catalog.api.routes.health@2023-07-03T12:59:12.024551+00:00",
         )
         respx_mock.get("/v0/meta").respond(
-            status.HTTP_200_OK, json=schemas["Meta"]["example"]
+            status.HTTP_200_OK, json=schemas["BaseMeta"]["example"]
         )
 
         # SEE https://github.com/pcrespov/sandbox-python/blob/f650aad57aced304aac9d0ad56c00723d2274ad0/respx-lib/test_disable_mock.py

services/catalog/Makefile

@@ -5,69 +5,19 @@ include ../../scripts/common.Makefile
 include ../../scripts/common-service.Makefile
 
 
-.PHONY: requirements reqs
-requirements reqs: ## (or reqs) compiles pip requirements (.in -> .txt)
-	@$(MAKE_C) requirements reqs
 
-
-
-
-
-# DEVELOPMENT ########
-
-.env:
-	cp .env-devel $@
-
-
-.PHONY: run-devel up-extra down down-extra
-
-up-extra: .env down-extra ## creates and starts adjacent services and migrates postgres database
-	# starting all adjacent services
-	docker compose -f docker-compose-extra.yml up --detach
-	sleep 1
-	# discovering postgres services
-	@export $(shell grep -v '^#' .env | xargs) && sc-pg discover
-	@sc-pg info
-	# upgrading postgres database to HEAD version
-	@sc-pg upgrade
-
-down down-extra: docker-compose-extra.yml ## stops pg fixture
-	# cleanup discover cache
-	-@sc-pg clean
-	# stopping extra services
-	-@docker compose -f docker-compose-extra.yml down
-	# killing any process using port 8000
-	-@fuser --kill --verbose --namespace tcp 8000
-
-
-run-devel: .env up-extra  ## starts app with extra stack
-	# start app (within $<) in devel mode
-	uvicorn $(APP_PACKAGE_NAME).__main__:the_app \
-		--reload --reload-dir $(SRC_DIR) \
-		--port=8000 --host=0.0.0.0
-
-run-prod: .env up-extra
-	# start app (within $<) in prod mode
-	$(APP_CLI_NAME)
-
-
-
-# BUILD #####################
-
-
-# specification of the used openapi-generator-cli (see also https://github.com/ITISFoundation/openapi-generator)
-OPENAPI_GENERATOR_NAME := itisfoundation/openapi-generator-cli-openapi-generator-v4.2.3
-OPENAPI_GENERATOR_TAG := v0
-OPENAPI_GENERATOR_IMAGE := $(OPENAPI_GENERATOR_NAME):$(OPENAPI_GENERATOR_TAG)
+.env-ignore:
+	$(APP_CLI_NAME) echo-dotenv > $@
 
 
 .PHONY: openapi-specs openapi.json
 openapi-specs: openapi.json
-openapi.json: .env
-	# generating openapi specs file
+openapi.json: .env-ignore
+	# generating openapi specs file (need to have the environment set for this)
+	@set -o allexport; \
+	source $<; \
+	set +o allexport; \
 	python3 -c "import json; from $(APP_PACKAGE_NAME).main import *; print( json.dumps(the_app.openapi(), indent=2) )" > $@
 
 	# validates OAS file: $@
-	docker run --rm \
-			--volume "$(CURDIR):/local" \
-			$(OPENAPI_GENERATOR_IMAGE) validate --input-spec /local/$@
+	$(call validate_openapi_specs,$@)

services/catalog/README.md

@@ -1,44 +1,3 @@
 # catalog
 
-[![image-size]](https://microbadger.com/images/itisfoundation/catalog. "More on itisfoundation/catalog:staging-latest image")
-[![image-badge]](https://microbadger.com/images/itisfoundation/catalog "More on Components Catalog Service image in registry")
-[![image-version]](https://microbadger.com/images/itisfoundation/catalog "More on Components Catalog Service image in registry")
-[![image-commit]](https://microbadger.com/images/itisfoundation/catalog "More on Components Catalog Service image in registry")
-
 Manages and maintains a catalog of all published components (e.g. macro-algorithms, scripts, etc)
-
-## Development
-
-Typical development workflow:
-
-```cmd
-make devenv
-source .venv/bin/activate
-
-cd services/api-service
-make install-dev
-```
-
-Then
-```cmd
-make run-devel
-```
-will start the service in development-mode together with a postgres db initialized with test data. The API can be query using
-- http://127.0.0.1:8000/api/docs: swagger-UI API doc
-
-
-Finally
-```cmd
-make tests
-make build-devel
-make build
-```
-
-
-
-<!-- Add badges urls here-->
-[image-size]:https://img.shields.io/microbadger/image-size/itisfoundation/catalog./staging-latest.svg?label=catalog.&style=flat
-[image-badge]:https://images.microbadger.com/badges/image/itisfoundation/catalog.svg
-[image-version]:https://images.microbadger.com/badges/version/itisfoundation/catalog.svg
-[image-commit]:https://images.microbadger.com/badges/commit/itisfoundation/catalog.svg
-<!------------------------->