ITISFoundation · sanderegg · Sep 13, 2018 · Aug 15, 2018 · Aug 15, 2018 · Aug 15, 2018
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -2,7 +2,8 @@
   "extends": "eslint:recommended",
   "parser": "babel-eslint",
   "globals": {
-    "osparc": false
+    "osparc": false,
+    "window": false
   },
   "rules": {
     "max-len": [

diff --git a/.gitignore b/.gitignore
@@ -122,3 +122,9 @@ services/docker-compose.swarm.yml
 # key-words in filename to ignore them
 *secret*
 *ignore*
+
+# Any output directory
+*output/
+# backup files
+*~
+*.bak
diff --git a/.travis.yml b/.travis.yml
@@ -38,6 +38,8 @@ matrix:
         - pip install --upgrade pip wheel setuptools && pip3 --version
         - pip3 install packages/s3wrapper[test]
         - pip3 install packages/simcore-sdk[test]
+        - pip3 install services/director[test]
+        - pip3 install packages/director-sdk/python
         - pushd services/web/server; pip3 install -r requirements/ci.txt; popd
 
       before_script:

@@ -1,19 +1,24 @@
 # author: Sylvain Anderegg
 
 # TODO: add flavours by combinging docker-compose files. Namely development, test and production.
-VERSION := $(shell cat /proc/version)
+VERSION := $(shell uname -a)
 # SAN this is a hack so that docker-compose works in the linux virtual environment under Windows
 ifneq (,$(findstring Microsoft,$(VERSION)))
 export DOCKER_COMPOSE=docker-compose
 export DOCKER=docker
 export RUN_DOCKER_ENGINE_ROOT=1
+# Windows does not have these things defined... but they are needed to execute a local swarm
+export DOCKER_GID=1001
+export HOST_GID=1000
 else
 export DOCKER_COMPOSE=docker-compose
 export DOCKER=docker
 export RUN_DOCKER_ENGINE_ROOT=0
+# TODO: Add a meaningfull call to retrieve the local docker group ID and the user ID in linux.
 endif
 
-PY_FILES = $(strip $(shell find services packages -iname '*.py' -not -path "*egg*" -not -path "*contrib*"))
+PY_FILES = $(strip $(shell find services packages -iname '*.py' -not -path "*egg*" -not -path "*contrib*" -not -path "*/director-sdk/python*" -not -path "*/generated_code/models*" -not -path "*/generated_code/util*"))
+
 export PYTHONPATH=${CURDIR}/packages/s3wrapper/src:${CURDIR}/packages/simcore-sdk/src
 
 all:
@@ -31,7 +36,7 @@ rebuild-devel:
 	${DOCKER_COMPOSE} -f services/docker-compose.yml -f services/docker-compose.devel.yml build --no-cache
 
 up-devel:
-	${DOCKER_COMPOSE} -f services/docker-compose.yml -f services/docker-compose.devel.yml up
+	${DOCKER_COMPOSE} -f services/docker-compose.yml -f services/docker-compose.devel.yml -f services/docker-compose.tools.yml up
 
 build:
 	${DOCKER_COMPOSE} -f services/docker-compose.yml build
@@ -40,18 +45,18 @@ rebuild:
 	${DOCKER_COMPOSE} -f services/docker-compose.yml build --no-cache
 
 up:
-	${DOCKER_COMPOSE} -f services/docker-compose.yml up
+	${DOCKER_COMPOSE} -f services/docker-compose.yml -f services/docker-compose.tools.yml up
 
 up-swarm:
 	${DOCKER} swarm init
-	${DOCKER} stack deploy -c services/docker-compose.yml -c services/docker-compose.deploy.yml services
+	${DOCKER} stack deploy -c services/docker-compose.yml -c services/docker-compose.deploy.yml  -c services/docker-compose.tools.yml services
 
 up-swarm-devel:
 	${DOCKER} swarm init
-	${DOCKER} stack deploy -c services/docker-compose.yml -c services/docker-compose.devel.yml -c services/docker-compose.deploy.devel.yml services
+	${DOCKER} stack deploy -c services/docker-compose.yml -c services/docker-compose.devel.yml -c services/docker-compose.deploy.devel.yml  -c services/docker-compose.tools.yml services
 
 down:
-	${DOCKER_COMPOSE} -f services/docker-compose.yml down
+	${DOCKER_COMPOSE} -f services/docker-compose.yml  -f services/docker-compose.tools.yml down
 	${DOCKER_COMPOSE} -f services/docker-compose.yml -f services/docker-compose.devel.yml down
 
 down-swarm:
@@ -84,6 +89,7 @@ run_test:
 	pytest --cov=s3wrapper -v packages/s3wrapper/tests
 	pytest --cov=simcore_sdk -v packages/simcore-sdk/tests
 	pytest --cov=server -v services/web/server/tests
+	pytest --cov=simcore_service_director -v services/director/tests
 
 after_test:
 	# leave a clean slate (not sure whether this is actually needed)

diff --git a/packages/director-sdk/README.md b/packages/director-sdk/README.md
@@ -0,0 +1,28 @@
+# simcore-director-sdk
+
+The simcore-director-sdk is the client library needed to access the director REST Api.
+
+It is currently available as an auto-generated python package but could be easily generated for other languages.
+
+## Usage
+
+pip install -v  git+https://github.com/ITISFoundation/osparc-simcore.git@director-sdk#subdirectory=packages/director-sdk/python
+
+## Development
+
+No development as the code is automatically generated.
+
+### local testing
+
+Do the following:
+1. Start the oSparc swarm
+```bash
+make build
+make up-swarm
+```
+2. Execute __sample.py__ as an example
+3. Observe logs
+
+## code generation from REST API "client side"
+
+Python: The code was generated using the __codegen.sh__ script together with __codegen_config.json__.
diff --git a/packages/director-sdk/codegen.sh b/packages/director-sdk/codegen.sh
@@ -0,0 +1,6 @@
+#/bin/bash
+exec ../../scripts/openapi/openapi_codegen.sh \
+    -i ../../services/director/src/simcore_service_director/.oas3/v1/openapi.yaml \
+    -o . \
+    -g python \
+    -c ./codegen_config.json
diff --git a/packages/director-sdk/codegen_config.json b/packages/director-sdk/codegen_config.json
@@ -0,0 +1,7 @@
+{
+    "packageName":"simcore_director_sdk",
+    "projectName":"simcore-director-sdk",
+    "packageVersion":"1.0.0",
+    "packageUrl":"https://github.com/ITISFoundation/osparc-simcore/tree/master/packages/director-sdk/python",
+    "library":"asyncio"
+}
diff --git a/packages/director-sdk/python/.openapi-generator/VERSION b/packages/director-sdk/python/.openapi-generator/VERSION
@@ -0,0 +1 @@
+3.3.0-SNAPSHOT
diff --git a/packages/director-sdk/python/.travis.yml b/packages/director-sdk/python/.travis.yml
@@ -0,0 +1,14 @@
+# ref: https://docs.travis-ci.com/user/languages/python
+language: python
+python:
+  - "2.7"
+  - "3.2"
+  - "3.3"
+  - "3.4"
+  - "3.5"
+  #- "3.5-dev" # 3.5 development branch
+  #- "nightly" # points to the latest development branch e.g. 3.6-dev
+# command to install dependencies
+install: "pip install -r requirements.txt"
+# command to run tests
+script: nosetests
diff --git a/packages/director-sdk/python/README.md b/packages/director-sdk/python/README.md
@@ -0,0 +1,103 @@
+# simcore-director-sdk
+This is the oSparc's director API
+
+This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 1.0.0
+- Package version: 1.0.0
+- Build package: org.openapitools.codegen.languages.PythonClientCodegen
+
+## Requirements.
+
+Python 2.7 and 3.4+
+
+## Installation & Usage
+### pip install
+
+If the python package is hosted on Github, you can install directly from Github
+
+```sh
+pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
+```
+(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)
+
+Then import the package:
+```python
+import simcore_director_sdk 
+```
+
+### Setuptools
+
+Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
+
+```sh
+python setup.py install --user
+```
+(or `sudo python setup.py install` to install the package for all users)
+
+Then import the package:
+```python
+import simcore_director_sdk
+```
+
+## Getting Started
+
+Please follow the [installation procedure](#installation--usage) and then run the following:
+
+```python
+from __future__ import print_function
+import time
+import simcore_director_sdk
+from simcore_director_sdk.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = simcore_director_sdk.UsersApi(simcore_director_sdk.ApiClient(configuration))
+
+try:
+    # Service health-check endpoint
+    api_response = api_instance.root_get()
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling UsersApi->root_get: %s\n" % e)
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *http://{host}:{port}/{version}*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*UsersApi* | [**root_get**](docs/UsersApi.md#root_get) | **GET** / | Service health-check endpoint
+*UsersApi* | [**running_interactive_services_delete**](docs/UsersApi.md#running_interactive_services_delete) | **DELETE** /running_interactive_services/{service_uuid} | Stops and removes an interactive service from the oSparc platform
+*UsersApi* | [**running_interactive_services_get**](docs/UsersApi.md#running_interactive_services_get) | **GET** /running_interactive_services/{service_uuid} | Succesfully returns if a service with the defined uuid is up and running
+*UsersApi* | [**running_interactive_services_post**](docs/UsersApi.md#running_interactive_services_post) | **POST** /running_interactive_services | Starts an interactive service in the oSparc platform and returns its entrypoint
+*UsersApi* | [**services_by_key_version_get**](docs/UsersApi.md#services_by_key_version_get) | **GET** /services/{service_key}/{service_version} | Returns details of the selected service if available in the oSparc platform
+*UsersApi* | [**services_get**](docs/UsersApi.md#services_get) | **GET** /services | Lists available services in the oSparc platform
+
+
+## Documentation For Models
+
+ - [Error](docs/Error.md)
+ - [ErrorEnveloped](docs/ErrorEnveloped.md)
+ - [HealthCheck](docs/HealthCheck.md)
+ - [HealthCheckEnveloped](docs/HealthCheckEnveloped.md)
+ - [NodeMetaV0](docs/NodeMetaV0.md)
+ - [Nodemetav0Authors](docs/Nodemetav0Authors.md)
+ - [Response204Enveloped](docs/Response204Enveloped.md)
+ - [RunningService](docs/RunningService.md)
+ - [RunningServiceEnveloped](docs/RunningServiceEnveloped.md)
+ - [ServicesEnveloped](docs/ServicesEnveloped.md)
+
+
+## Documentation For Authorization
+
+ All endpoints do not require authorization.
+
+
+## Author
+
+[email protected]
+
+
diff --git a/packages/director-sdk/python/docs/Error.md b/packages/director-sdk/python/docs/Error.md
@@ -0,0 +1,12 @@
+# Error
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **str** | Error message | 
+**errors** | **list[object]** |  | [optional] 
+**status** | **int** | Error code | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/packages/director-sdk/python/docs/ErrorEnveloped.md b/packages/director-sdk/python/docs/ErrorEnveloped.md
@@ -0,0 +1,11 @@
+# ErrorEnveloped
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Error**](Error.md) |  | [optional] 
+**status** | **int** |  | [optional] 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/packages/director-sdk/python/docs/HealthCheck.md b/packages/director-sdk/python/docs/HealthCheck.md
@@ -0,0 +1,13 @@
+# HealthCheck
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **str** |  | [optional] 
+**status** | **str** |  | [optional] 
+**api_version** | **str** |  | [optional] 
+**version** | **str** |  | [optional] 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/packages/director-sdk/python/docs/HealthCheckEnveloped.md b/packages/director-sdk/python/docs/HealthCheckEnveloped.md
@@ -0,0 +1,11 @@
+# HealthCheckEnveloped
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**HealthCheck**](HealthCheck.md) |  | [optional] 
+**status** | **int** |  | [optional] 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/packages/director-sdk/python/docs/NodeMetaV0.md b/packages/director-sdk/python/docs/NodeMetaV0.md
@@ -0,0 +1,18 @@
+# NodeMetaV0
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **str** | distinctive name for the node based on the docker registry path | 
+**version** | **str** | semantic version number | 
+**type** | **str** | service type | 
+**name** | **str** | short, human readable name for the node | 
+**description** | **str** | human readable description of the purpose of the node | 
+**authors** | [**list[Nodemetav0Authors]**](Nodemetav0Authors.md) |  | 
+**contact** | **str** | email to correspond to the authors about the node | 
+**inputs** | **object** | definition of the inputs of this node | 
+**outputs** | **object** | definition of the outputs of this node | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/packages/director-sdk/python/docs/Nodemetav0Authors.md b/packages/director-sdk/python/docs/Nodemetav0Authors.md
@@ -0,0 +1,12 @@
+# Nodemetav0Authors
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **str** | Name of the author | [optional] 
+**email** | **str** | Email address | [optional] 
+**affiliation** | **str** | Affiliation of the author | [optional] 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/packages/director-sdk/python/docs/Response204Enveloped.md b/packages/director-sdk/python/docs/Response204Enveloped.md
@@ -0,0 +1,11 @@
+# Response204Enveloped
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | **str** |  | [optional] 
+**status** | **int** |  | [optional] 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/packages/director-sdk/python/docs/RunningService.md b/packages/director-sdk/python/docs/RunningService.md
@@ -0,0 +1,12 @@
+# RunningService
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**published_port** | **int** | The ports where the service provides its interface | 
+**entry_point** | **str** | The entry point where the service provides its interface if specified | [optional] 
+**service_uuid** | **str** | The UUID attached to this service | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/packages/director-sdk/python/docs/RunningServiceEnveloped.md b/packages/director-sdk/python/docs/RunningServiceEnveloped.md
@@ -0,0 +1,11 @@
+# RunningServiceEnveloped
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**RunningService**](RunningService.md) |  | [optional] 
+**status** | **int** |  | [optional] 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/packages/director-sdk/python/docs/ServicesEnveloped.md b/packages/director-sdk/python/docs/ServicesEnveloped.md
@@ -0,0 +1,11 @@
+# ServicesEnveloped
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**list[NodeMetaV0]**](NodeMetaV0.md) |  | [optional] 
+**status** | **int** |  | [optional] 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+