✨ Is621/api server exposes GET /solvers/*/releases/*/jobs/*/outputs/logfile (⚠️ devops) (ITISFoundation#3051)

Author: pcrespov

services/api-server/tests/unit/_catalog_fakes.py renamed to packages/pytest-simcore/src/pytest_simcore/helpers/catalog_data_fakers.py

@@ -10,6 +10,7 @@
     required fields in postgres_database.models tables or pydantic models.
 """
 
+
 import itertools
 import json
 import random
@@ -19,6 +20,8 @@
 
 import faker
 from simcore_postgres_database.models.comp_pipeline import StateType
+from simcore_postgres_database.models.projects import projects
+from simcore_postgres_database.models.users import users
 from simcore_postgres_database.webserver_models import ProjectType, UserStatus
 
 STATES = [
@@ -30,40 +33,69 @@
 ]
 
 
-fake = faker.Faker()
+_faker = faker.Faker()
+
+
+def _compute_hash(password: str) -> str:
+    try:
+        # 'passlib' will be used only if already installed.
+        # This way we do not force all modules to install
+        # it only for testing.
+        import passlib.hash
+
+        return passlib.hash.sha256_crypt.using(rounds=1000).hash(password)
+
+    except ImportError:
+        # if 'passlib' is not installed, we will use a library
+        # from the python distribution for convenience
+        import hashlib
+
+        return hashlib.sha224(password.encode("ascii")).hexdigest()
+
+
+_DEFAULT_HASH = _compute_hash("secret")
 
 
 def random_user(**overrides) -> Dict[str, Any]:
     data = dict(
-        name=fake.name(),
-        email=fake.email(),
-        password_hash=fake.numerify(text="#" * 5),
+        name=_faker.name(),
+        email=_faker.email(),
+        password_hash=_DEFAULT_HASH,
         status=UserStatus.ACTIVE,
-        created_ip=fake.ipv4(),
+        created_ip=_faker.ipv4(),
     )
+    assert set(data.keys()).issubset(set(c.name for c in users.columns))  # nosec
+
+    # transform password in hash
+    password = overrides.pop("password", None)
+    if password:
+        overrides["password_hash"] = _compute_hash(password)
+
     data.update(overrides)
     return data
 
 
 def random_project(**overrides) -> Dict[str, Any]:
     """Generates random fake data projects DATABASE table"""
     data = dict(
-        uuid=fake.uuid4(),
-        name=fake.word(),
-        description=fake.sentence(),
-        prj_owner=fake.pyint(),
-        thumbnail=fake.image_url(width=120, height=120),
+        uuid=_faker.uuid4(),
+        name=_faker.word(),
+        description=_faker.sentence(),
+        prj_owner=_faker.pyint(),
+        thumbnail=_faker.image_url(width=120, height=120),
         access_rights={},
         workbench={},
         published=False,
     )
+    assert set(data.keys()).issubset(set(c.name for c in projects.columns))  # nosec
+
     data.update(overrides)
     return data
 
 
 def random_group(**overrides) -> Dict[str, Any]:
     data = dict(
-        name=fake.company(), description=fake.text(), type=ProjectType.STANDARD.name
+        name=_faker.company(), description=_faker.text(), type=ProjectType.STANDARD.name
     )
     data.update(overrides)
     return data

packages/pytest-simcore/src/pytest_simcore/helpers/rawdata_fakers.py

@@ -1 +1 @@
-0.3.1
+0.4.0

services/api-server/VERSION

@@ -3,7 +3,7 @@
   "info": {
     "title": "osparc.io web API",
     "description": "osparc-simcore public web API specifications",
-    "version": "0.3.1",
+    "version": "0.4.0",
     "x-logo": {
       "url": "https://raw.githubusercontent.com/ITISFoundation/osparc-manual/b809d93619512eb60c827b7e769c6145758378d0/_media/osparc-logo.svg",
       "altText": "osparc-simcore logo"
@@ -993,6 +993,93 @@
           }
         ]
       }
+    },
+    "/v0/solvers/{solver_key}/releases/{version}/jobs/{job_id}/outputs/logfile": {
+      "get": {
+        "tags": [
+          "solvers"
+        ],
+        "summary": "Get Job Output Logfile",
+        "description": "Special extra output with persistent logs file for the solver run.\n\nNOTE: this is not a log stream but a predefined output that is only\navailable after the job is done.",
+        "operationId": "get_job_output_logfile",
+        "parameters": [
+          {
+            "required": true,
+            "schema": {
+              "title": "Solver Key",
+              "pattern": "^(simcore)/(services)/comp(/[\\w/-]+)+$",
+              "type": "string"
+            },
+            "name": "solver_key",
+            "in": "path"
+          },
+          {
+            "required": true,
+            "schema": {
+              "title": "Version",
+              "pattern": "^(0|[1-9]\\d*)(\\.(0|[1-9]\\d*)){2}(-(0|[1-9]\\d*|\\d*[-a-zA-Z][-\\da-zA-Z]*)(\\.(0|[1-9]\\d*|\\d*[-a-zA-Z][-\\da-zA-Z]*))*)?(\\+[-\\da-zA-Z]+(\\.[-\\da-zA-Z-]+)*)?$",
+              "type": "string"
+            },
+            "name": "version",
+            "in": "path"
+          },
+          {
+            "required": true,
+            "schema": {
+              "title": "Job Id",
+              "type": "string",
+              "format": "uuid"
+            },
+            "name": "job_id",
+            "in": "path"
+          }
+        ],
+        "responses": {
+          "307": {
+            "description": "Successful Response"
+          },
+          "200": {
+            "description": "Returns a log file",
+            "content": {
+              "application/octet-stream": {
+                "schema": {
+                  "type": "string",
+                  "format": "binary"
+                }
+              },
+              "application/zip": {
+                "schema": {
+                  "type": "string",
+                  "format": "binary"
+                }
+              },
+              "text/plain": {
+                "schema": {
+                  "type": "string"
+                }
+              }
+            }
+          },
+          "404": {
+            "description": "Log not found"
+          },
+          "422": {
+            "description": "Validation Error",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/HTTPValidationError"
+                }
+              }
+            }
+          }
+        },
+        "security": [
+          {
+            "HTTPBasic": []
+          }
+        ]
+      }
     }
   },
   "components": {
@@ -1509,7 +1596,8 @@
           "ANONYMOUS",
           "GUEST",
           "USER",
-          "TESTER"
+          "TESTER",
+          "ADMIN"
         ],
         "type": "string",
         "description": "An enumeration."

services/api-server/openapi.json

@@ -17,7 +17,8 @@ codecov
 coveralls
 docker
 faker
-fsspec # upload/download files to minio
+types-boto3
+moto[server] # mock out tests based on AWS-S3
 passlib[bcrypt]
 pylint
 pytest
@@ -27,4 +28,3 @@ pytest-docker
 pytest-mock
 pytest-runner
 respx
-tenacity