🧪 Add config for to enable e2e tests against new zmt deployment

clients/python/docs/BasicTutorial_v0.5.0.ipynb

@@ -149,16 +149,17 @@
     "\n",
     "    solvers_api = osparc.SolversApi(api_client)\n",
     "    solver: osparc.Solver = solvers_api.get_solver_release(\n",
-    "        \"simcore/services/comp/itis/sleeper\", \"2.0.2\"\n",
+    "        \"simcore/services/comp/itis/sleeper\", \"2.1.6\"\n",
     "    )\n",
     "\n",
     "    job: osparc.Job = solvers_api.create_job(\n",
     "        solver.id,\n",
     "        solver.version,\n",
     "        osparc.JobInputs(\n",
     "            {\n",
-    "                \"input_3\": 0,\n",
-    "                \"input_2\": 3.0,\n",
+    "                \"input_4\": 2,\n",
+    "                \"input_3\": \"false\",\n",
+    "                \"input_2\": 3,\n",
     "                \"input_1\": input_file,\n",
     "            }\n",
     "        ),\n",
@@ -169,6 +170,7 @@
     "        time.sleep(3)\n",
     "        status = solvers_api.inspect_job(solver.id, solver.version, job.id)\n",
     "        print(\"Solver progress\", f\"{status.progress}/100\", flush=True)\n",
+    "    assert status.state == \"SUCCESS\"\n",
     "    #\n",
     "    # Solver progress 0/100\n",
     "    # Solver progress 100/100\n",
@@ -273,7 +275,7 @@
     "\n",
     "#### Solvers, Inputs and Outputs\n",
     "\n",
-    "The inputs and outputs are specific for every solver. Every input/output has a name and an associated type that can be as simple as booleans, numbers, strings ... or more complex as files. You can find this information in the UI under Services Tab, selecting the service card > Information > Raw metadata. For instance, the ``sleeper`` version ``2.0.2`` has the following ``raw-metadata``:"
+    "The inputs and outputs are specific for every solver. Every input/output has a name and an associated type that can be as simple as booleans, numbers, strings ... or more complex as files. You can find this information in the UI under Services Tab, selecting the service card > Information > Raw metadata. For instance, the ``sleeper`` version ``2.1.6`` has the following ``raw-metadata``:"
    ]
   },
   {
@@ -291,27 +293,58 @@
    "source": [
     "```json\n",
     "{\n",
-    "    inputs: {\n",
-    "        'input_1': {'description': 'Pick a file containing only one '\n",
-    "                                    'integer',\n",
-    "                    'displayOrder': 1,\n",
-    "                    'fileToKeyMap': {'single_number.txt': 'input_1'},\n",
-    "                    'label': 'File with int number',\n",
-    "                    'type': 'data:text/plain'},\n",
-    "        'input_2': {'defaultValue': 2,\n",
-    "                    'description': 'Choose an amount of time to sleep',\n",
-    "                    'displayOrder': 2,\n",
-    "                    'label': 'Sleep interval',\n",
-    "                    'type': 'integer',\n",
-    "                    'unit': 'second'},\n",
-    "        'input_3': {'defaultValue': False,\n",
-    "                    'description': 'If set to true will cause service to '\n",
-    "                                    'fail after it sleeps',\n",
-    "                    'displayOrder': 3,\n",
-    "                    'label': 'Fail after sleep',\n",
-    "                    'type': 'boolean'},\n",
-    "    }\n",
-    "}\n",
+    " \"inputs\": {\n",
+    "  \"input_1\": {\n",
+    "   \"displayOrder\": 1,\n",
+    "   \"label\": \"File with int number\",\n",
+    "   \"description\": \"Pick a file containing only one integer\",\n",
+    "   \"type\": \"data:text/plain\",\n",
+    "   \"fileToKeyMap\": {\n",
+    "    \"single_number.txt\": \"input_1\"\n",
+    "   },\n",
+    "   \"keyId\": \"input_1\"\n",
+    "  },\n",
+    "  \"input_2\": {\n",
+    "   \"unitLong\": \"second\",\n",
+    "   \"unitShort\": \"s\",\n",
+    "   \"label\": \"Sleep interval\",\n",
+    "   \"description\": \"Choose an amount of time to sleep in range [0-65]\",\n",
+    "   \"keyId\": \"input_2\",\n",
+    "   \"displayOrder\": 2,\n",
+    "   \"type\": \"ref_contentSchema\",\n",
+    "   \"contentSchema\": {\n",
+    "    \"title\": \"Sleep interval\",\n",
+    "    \"type\": \"integer\",\n",
+    "    \"x_unit\": \"second\",\n",
+    "    \"minimum\": 0,\n",
+    "    \"maximum\": 65\n",
+    "   },\n",
+    "   \"defaultValue\": 2\n",
+    "  },\n",
+    "  \"input_3\": {\n",
+    "   \"displayOrder\": 3,\n",
+    "   \"label\": \"Fail after sleep\",\n",
+    "   \"description\": \"If set to true will cause service to fail after it sleeps\",\n",
+    "   \"type\": \"boolean\",\n",
+    "   \"defaultValue\": false,\n",
+    "   \"keyId\": \"input_3\"\n",
+    "  },\n",
+    "  \"input_4\": {\n",
+    "   \"unitLong\": \"meter\",\n",
+    "   \"unitShort\": \"m\",\n",
+    "   \"label\": \"Distance to bed\",\n",
+    "   \"description\": \"It will first walk the distance to bed\",\n",
+    "   \"keyId\": \"input_4\",\n",
+    "   \"displayOrder\": 4,\n",
+    "   \"type\": \"ref_contentSchema\",\n",
+    "   \"contentSchema\": {\n",
+    "    \"title\": \"Distance to bed\",\n",
+    "    \"type\": \"integer\",\n",
+    "    \"x_unit\": \"meter\"\n",
+    "   },\n",
+    "   \"defaultValue\": 0\n",
+    "  }\n",
+    " }\n",
     "```"
    ]
   },
@@ -332,17 +365,18 @@
    "source": [
     "```python\n",
     "# ...\n",
-    "job = solvers_api.create_job(\n",
-    "            solver.id,\n",
-    "            solver.version,\n",
-    "            job_inputs=JobInputs(\n",
-    "                {\n",
-    "                    \"input_1\": uploaded_input_file,\n",
-    "                    \"input_2\": 3 * n,  # sleep time in secs\n",
-    "                    \"input_3\": bool(n % 2),  # fail after sleep?\n",
-    "                }\n",
-    "            ),\n",
-    "        )\n",
+    "job: osparc.Job = solvers_api.create_job(\n",
+    "    solver.id,\n",
+    "    solver.version,\n",
+    "    osparc.JobInputs(\n",
+    "        {\n",
+    "            \"input_4\": 2,\n",
+    "            \"input_3\": \"false\",\n",
+    "            \"input_2\": 3,\n",
+    "            \"input_1\": input_file,\n",
+    "        }\n",
+    "    ),\n",
+    ")\n",
     "```"
    ]
   },
@@ -369,19 +403,29 @@
    },
    "source": [
     "```json\n",
-    "{\n",
-    "    'outputs': {'output_1': {'description': 'Integer is generated in range [1-9]',\n",
-    "                            'displayOrder': 1,\n",
-    "                            'fileToKeyMap': {'single_number.txt': 'output_1'},\n",
-    "                            'label': 'File containing one random integer',\n",
-    "                            'type': 'data:text/plain'},\n",
-    "                'output_2': {'description': 'Interval is generated in range '\n",
-    "                                            '[1-9]',\n",
-    "                            'displayOrder': 2,\n",
-    "                            'label': 'Random sleep interval',\n",
-    "                            'type': 'integer',\n",
-    "                            'unit': 'second'}},\n",
-    "}\n",
+    "  \"output_1\": {\n",
+    "   \"displayOrder\": 1,\n",
+    "   \"label\": \"File containing one random integer\",\n",
+    "   \"description\": \"Integer is generated in range [1-9]\",\n",
+    "   \"type\": \"data:text/plain\",\n",
+    "   \"fileToKeyMap\": {\n",
+    "    \"single_number.txt\": \"output_1\"\n",
+    "   },\n",
+    "   \"keyId\": \"output_1\"\n",
+    "  },\n",
+    "  \"output_2\": {\n",
+    "   \"unitLong\": \"second\",\n",
+    "   \"unitShort\": \"s\",\n",
+    "   \"label\": \"Random sleep interval\",\n",
+    "   \"description\": \"Interval is generated in range [1-9]\",\n",
+    "   \"keyId\": \"output_2\",\n",
+    "   \"displayOrder\": 2,\n",
+    "   \"type\": \"ref_contentSchema\",\n",
+    "   \"contentSchema\": {\n",
+    "    \"title\": \"Random sleep interval\",\n",
+    "    \"type\": \"integer\",\n",
+    "    \"x_unit\": \"second\"\n",
+    "   }\n",
     "```"
    ]
   },

clients/python/docs/BasicTutorial_v0.6.0.ipynb

@@ -148,7 +148,7 @@
     "    input_file: osparc.File = files_api.upload_file(file=\"file_with_number.txt\")\n",
     "\n",
     "    solver_key: str = \"simcore/services/comp/itis/sleeper\"\n",
-    "    solver_version: str = \"2.0.2\"\n",
+    "    solver_version: str = \"2.1.6\"\n",
     "    \n",
     "    solvers_api = osparc.SolversApi(api_client)\n",
     "    solver: osparc.Solver = solvers_api.get_solver_release(solver_key=solver_key, version=solver_version)\n",
@@ -161,8 +161,9 @@
     "        solver.version,\n",
     "        osparc.JobInputs(\n",
     "            {\n",
-    "                \"input_3\": 0,\n",
-    "                \"input_2\": 3.0,\n",
+    "                \"input_4\": 2,\n",
+    "                \"input_3\": \"false\",\n",
+    "                \"input_2\": 3,\n",
     "                \"input_1\": input_file,\n",
     "            }\n",
     "        ),\n",
@@ -173,6 +174,8 @@
     "        time.sleep(3)\n",
     "        status = solvers_api.inspect_job(solver.id, solver.version, job.id)\n",
     "        print(\"Solver progress\", f\"{status.progress}/100\", flush=True)\n",
+    "    assert status.state == \"SUCCESS\"\n",
+    "\n",
     "    #\n",
     "    # Solver progress 0/100\n",
     "    # Solver progress 100/100\n",
@@ -295,27 +298,58 @@
    "source": [
     "```json\n",
     "{\n",
-    "    inputs: {\n",
-    "        'input_1': {'description': 'Pick a file containing only one '\n",
-    "                                    'integer',\n",
-    "                    'displayOrder': 1,\n",
-    "                    'fileToKeyMap': {'single_number.txt': 'input_1'},\n",
-    "                    'label': 'File with int number',\n",
-    "                    'type': 'data:text/plain'},\n",
-    "        'input_2': {'defaultValue': 2,\n",
-    "                    'description': 'Choose an amount of time to sleep',\n",
-    "                    'displayOrder': 2,\n",
-    "                    'label': 'Sleep interval',\n",
-    "                    'type': 'integer',\n",
-    "                    'unit': 'second'},\n",
-    "        'input_3': {'defaultValue': False,\n",
-    "                    'description': 'If set to true will cause service to '\n",
-    "                                    'fail after it sleeps',\n",
-    "                    'displayOrder': 3,\n",
-    "                    'label': 'Fail after sleep',\n",
-    "                    'type': 'boolean'},\n",
-    "    }\n",
-    "}\n",
+    " \"inputs\": {\n",
+    "  \"input_1\": {\n",
+    "   \"displayOrder\": 1,\n",
+    "   \"label\": \"File with int number\",\n",
+    "   \"description\": \"Pick a file containing only one integer\",\n",
+    "   \"type\": \"data:text/plain\",\n",
+    "   \"fileToKeyMap\": {\n",
+    "    \"single_number.txt\": \"input_1\"\n",
+    "   },\n",
+    "   \"keyId\": \"input_1\"\n",
+    "  },\n",
+    "  \"input_2\": {\n",
+    "   \"unitLong\": \"second\",\n",
+    "   \"unitShort\": \"s\",\n",
+    "   \"label\": \"Sleep interval\",\n",
+    "   \"description\": \"Choose an amount of time to sleep in range [0-65]\",\n",
+    "   \"keyId\": \"input_2\",\n",
+    "   \"displayOrder\": 2,\n",
+    "   \"type\": \"ref_contentSchema\",\n",
+    "   \"contentSchema\": {\n",
+    "    \"title\": \"Sleep interval\",\n",
+    "    \"type\": \"integer\",\n",
+    "    \"x_unit\": \"second\",\n",
+    "    \"minimum\": 0,\n",
+    "    \"maximum\": 65\n",
+    "   },\n",
+    "   \"defaultValue\": 2\n",
+    "  },\n",
+    "  \"input_3\": {\n",
+    "   \"displayOrder\": 3,\n",
+    "   \"label\": \"Fail after sleep\",\n",
+    "   \"description\": \"If set to true will cause service to fail after it sleeps\",\n",
+    "   \"type\": \"boolean\",\n",
+    "   \"defaultValue\": false,\n",
+    "   \"keyId\": \"input_3\"\n",
+    "  },\n",
+    "  \"input_4\": {\n",
+    "   \"unitLong\": \"meter\",\n",
+    "   \"unitShort\": \"m\",\n",
+    "   \"label\": \"Distance to bed\",\n",
+    "   \"description\": \"It will first walk the distance to bed\",\n",
+    "   \"keyId\": \"input_4\",\n",
+    "   \"displayOrder\": 4,\n",
+    "   \"type\": \"ref_contentSchema\",\n",
+    "   \"contentSchema\": {\n",
+    "    \"title\": \"Distance to bed\",\n",
+    "    \"type\": \"integer\",\n",
+    "    \"x_unit\": \"meter\"\n",
+    "   },\n",
+    "   \"defaultValue\": 0\n",
+    "  }\n",
+    " }\n",
     "```"
    ]
   },
@@ -336,17 +370,18 @@
    "source": [
     "```python\n",
     "# ...\n",
-    "job = solvers_api.create_job(\n",
-    "            solver.id,\n",
-    "            solver.version,\n",
-    "            job_inputs=JobInputs(\n",
-    "                {\n",
-    "                    \"input_1\": uploaded_input_file,\n",
-    "                    \"input_2\": 3 * n,  # sleep time in secs\n",
-    "                    \"input_3\": bool(n % 2),  # fail after sleep?\n",
-    "                }\n",
-    "            ),\n",
-    "        )\n",
+    "job: osparc.Job = solvers_api.create_job(\n",
+    "    solver.id,\n",
+    "    solver.version,\n",
+    "    osparc.JobInputs(\n",
+    "        {\n",
+    "            \"input_4\": 2,\n",
+    "            \"input_3\": \"false\",\n",
+    "            \"input_2\": 3,\n",
+    "            \"input_1\": input_file,\n",
+    "        }\n",
+    "    ),\n",
+    ")\n",
     "```"
    ]
   },
@@ -373,19 +408,29 @@
    },
    "source": [
     "```json\n",
-    "{\n",
-    "    'outputs': {'output_1': {'description': 'Integer is generated in range [1-9]',\n",
-    "                            'displayOrder': 1,\n",
-    "                            'fileToKeyMap': {'single_number.txt': 'output_1'},\n",
-    "                            'label': 'File containing one random integer',\n",
-    "                            'type': 'data:text/plain'},\n",
-    "                'output_2': {'description': 'Interval is generated in range '\n",
-    "                                            '[1-9]',\n",
-    "                            'displayOrder': 2,\n",
-    "                            'label': 'Random sleep interval',\n",
-    "                            'type': 'integer',\n",
-    "                            'unit': 'second'}},\n",
-    "}\n",
+    "  \"output_1\": {\n",
+    "   \"displayOrder\": 1,\n",
+    "   \"label\": \"File containing one random integer\",\n",
+    "   \"description\": \"Integer is generated in range [1-9]\",\n",
+    "   \"type\": \"data:text/plain\",\n",
+    "   \"fileToKeyMap\": {\n",
+    "    \"single_number.txt\": \"output_1\"\n",
+    "   },\n",
+    "   \"keyId\": \"output_1\"\n",
+    "  },\n",
+    "  \"output_2\": {\n",
+    "   \"unitLong\": \"second\",\n",
+    "   \"unitShort\": \"s\",\n",
+    "   \"label\": \"Random sleep interval\",\n",
+    "   \"description\": \"Interval is generated in range [1-9]\",\n",
+    "   \"keyId\": \"output_2\",\n",
+    "   \"displayOrder\": 2,\n",
+    "   \"type\": \"ref_contentSchema\",\n",
+    "   \"contentSchema\": {\n",
+    "    \"title\": \"Random sleep interval\",\n",
+    "    \"type\": \"integer\",\n",
+    "    \"x_unit\": \"second\"\n",
+    "   }\n",
     "```"
    ]
   },

clients/python/test/e2e/ci/_utils.py

@@ -10,11 +10,11 @@
 _CI_DIR: Path = (_E2E_DIR / "ci").resolve()
 _PYTEST_INI: Path = (_E2E_DIR / "pytest.ini").resolve()
 _ARTIFACTS_DIR: Path = (_E2E_DIR.parent.parent / "artifacts" / "e2e").resolve()
-_COMPATIBILITY_JSON: Path = (
-    _E2E_DIR / "data" / "server_client_compatibility.json"
+_COMPATIBILITY_CSV: Path = (
+    _E2E_DIR / "data" / "server_client_compatibility.csv"
 ).resolve()
 
-assert _COMPATIBILITY_JSON.is_file()
+assert _COMPATIBILITY_CSV.is_file()
 
 
 def print_line():