Merge remote-tracking branch 'upstream/master'

Author: pcrespov

.env-devel

@@ -1,4 +1,5 @@
 # NOTE: write here host gid and docker gid.
+# TODO: keep hierarchy
 HOST_GID=1000
 DOCKER_GID=1001
 RUN_DOCKER_ENGINE_ROOT=0
@@ -18,4 +19,5 @@ S3_ENDPOINT=minio:9000
 S3_ACCESS_KEY=12345678
 S3_SECRET_KEY=12345678
 S3_BUCKET_NAME=simcore
-
+SMTP_HOST=smtp.gmail.com
+SMTP_PORT=465

.github/CODEOWNERS

@@ -1,13 +1,15 @@
 # Order is important. The last matching pattern has the most precedence.
 
 # files and folders recursively
-/docs/                   @pcrespov
-/services/computation    @mguidon
-/services/dy*            @sanderegg
-/services/sidecar        @pcrespov, @mguidon
-/services/web/client     @odeimaiz, @oetiker
-/services/web/server     @pcrespov
-/services/storage        @mguidon
+/api/                      @sanderegg, @pcrespov
+/docs/                     @pcrespov
+/packages/service-library  @pcrespov
+/services/computation      @mguidon
+/services/dy*              @sanderegg
+/services/sidecar          @pcrespov, @mguidon
+/services/web/client       @odeimaiz, @oetiker
+/services/web/server       @pcrespov
+/services/storage          @mguidon
 
 # any change in travis
 /.travis.yml     @odeimaiz

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,3 +1,5 @@
+<!--  **WIP-** prefix in title if still work in progress -->
+
 ## What do these changes do?
 
 <!-- Please give a short brief about these changes. -->
@@ -6,9 +8,8 @@
 ## Related issue number
 
 <!--
- - Add **WIP-** prefix in title if it is still work in progress (i.e. should not be merged but is ready to start reviewing it)
+ Use [waffle.io] keywords in title/descriptions to trigger bot actions:
 
- - Use [waffle.io] keywords in title/descriptions to trigger bot actions:
    - close, closes, close, closes, closed, fix, fixes, fixed, resolve, resolves, resolved #[issueNumber]
    - connect to, connects to, connected to, connect, connects, connected #[issueNumber]
 -->
@@ -19,6 +20,7 @@
 - [ ] I think the code is well written
 - [ ] Unit tests for the changes exist
 - [ ] Documentation reflects the changes
+- [ ] **Runs in the swarm**
 - [ ] If you design a new module, add your user to .github/CODEOWNERS
 
 [waffle.io]:https://waffle.io/marketing-assets/documents/waffleio_cheatsheet_v1.pdf?utm_source=blog&utm_medium=cheatsheet-ctabutton&utm_campaign=cheatsheet

.travis.yml

@@ -46,7 +46,7 @@ matrix:
         - pip3 install packages/director-sdk/python
         - pushd services/web/server; pip3 install -r requirements/ci.txt; popd
         - pushd services/storage; pip3 install -r requirements/dev.txt; popd
-        - pip3 install -r apis/tests/requirements.txt
+        - pip3 install -r api/tests/requirements.txt
         - pip3 install -r services/apihub/tests/requirements.txt
 
       before_script:

Makefile

@@ -96,12 +96,13 @@ before_test:
 	${DOCKER_COMPOSE} -f packages/simcore-sdk/tests/docker-compose.yml build
 
 run_test:
-	pytest -v apis/tests
+	pytest -v api/tests
 	pytest -v services/apihub/tests
 	pytest --cov=pytest_docker -v packages/pytest_docker/tests
 	pytest --cov=s3wrapper -v packages/s3wrapper/tests
 	pytest --cov=simcore_sdk -v packages/simcore-sdk/tests
-	pytest --cov=simcore_service_webserver -v services/web/server/tests
+	pytest --cov=simcore_service_webserver -v services/web/server/tests/unit
+	pytest --cov=simcore_service_webserver -v services/web/server/tests/login
 	pytest --cov=simcore_service_director -v services/director/tests
 	pytest --cov=simcore_service_storage -v -m "not travis" services/storage/tests
 
@@ -116,7 +117,7 @@ test:
 	make run_test
 	make after_test
 
-PLATFORM_VERSION=3.13
+PLATFORM_VERSION=3.18
 
 push_platform_images:
 	${DOCKER} login masu.speag.com

apis/README.md renamed to api/README.md

@@ -15,19 +15,19 @@ The oSparc platform uses the following standards:
 ## Folder structure
 
 ```bash
-/apis/                                  # base folder
-/apis/director/                         # service name folder (e.g. for director service)
-/apis/director/v0/                      # service version (v0 for development, then v1, v2... only major)
-/apis/director/v0/openapi.yaml          # openapi specifications in YAML
-/apis/director/v0/schemas/              # schemas only used by the director API
-/apis/director/v0/schemas/services.yaml # openapi encoded service only schema
-
-/apis/shared/                           # shared apis/schemas base folder
-/apis/shared/schemas/                   # sub folder for schemas
-/apis/shared/schemas/health_check.yaml  # openapi encoded shared schema
-/apis/shared/schemas/node-meta.json     # jsonschema encoded shared schema
-/apis/shared/schemas/v1/error.yaml      # openapi encoded shaared schema for version 1
-/apis/shared/schemas/v2/error.yaml      # openapi encoded shaared schema for version 2
+/api/specs/                                  # base folder
+/api/specs/director/                         # service name folder (e.g. for director service)
+/api/specs/director/v0/                      # service version (v0 for development, then v1, v2... only major)
+/api/specs/director/v0/openapi.yaml          # openapi specifications in YAML
+/api/specs/director/v0/schemas/              # schemas only used by the director API
+/api/specs/director/v0/schemas/services.yaml # openapi encoded service only schema
+
+/api/specs/shared/                           # shared api/specs/schemas base folder
+/api/specs/shared/schemas/                   # sub folder for schemas
+/api/specs/shared/schemas/health_check.yaml  # openapi encoded shared schema
+/api/specs/shared/schemas/node-meta.json     # jsonschema encoded shared schema
+/api/specs/shared/schemas/v1/error.yaml      # openapi encoded shaared schema for version 1
+/api/specs/shared/schemas/v2/error.yaml      # openapi encoded shaared schema for version 2
 
 /tests/                                 # python tests folder to check schemas validity
 /tests/requirements.txt                 # requirements for python tests

apis/director/v0/openapi.yaml renamed to api/specs/director/v0/openapi.yaml

@@ -1,11 +1,11 @@
 $schema: http://json-schema.org/draft-07/schema#
-$id: https://simcore.io/apis/shared/schemas/node-output-list-api-v0.0.1.yaml
+$id: https://simcore.io/api/specs/shared/schemas/node-output-list-api-v0.0.1.yaml
 
 title: node output list api
 description: nodes using the list representation for the output
   must be able to handle the following requests
 type: object
-required: 
+required:
   # the validator does not appreciate when required is missing here... and
   # sadly does not throw any meaningful error about it... so for now I put this...
   - getItemList

apis/shared/schemas/error.yaml renamed to api/specs/shared/schemas/error.yaml

@@ -0,0 +1,74 @@
+ErrorEnveloped:
+# - notice that data is defaulted to null
+#
+  type: object
+  required:
+    - data
+    - error
+  properties:
+    data:
+      nullable: true
+      default: null
+    error:
+      $ref: "#/ErrorType"
+
+
+
+ErrorType:
+#  - Normally transmitted as a response from server to client
+#  - can exchage log messages between server and client. Possible applications:
+#     - e.g. client side can render a widget to display messages logged to 'user'
+#  - contains meta-information to allow client programatically understand the error. Possible applications:
+#     - e.g. metadata can serialize an exception in server that can be reproduced in client side
+#
+  type: object
+  properties:
+    logs:
+      description: log messages
+      type: array
+      items:
+        $ref: './log_message.yaml#/LogMessageType'
+    errors:
+      description: errors metadata
+      type: array
+      items:
+         $ref: '#/ErrorItemType'
+    status:
+      description: HTTP error code
+      type: integer
+  example:
+    BadRequestError:
+      logs:
+        - message: 'Requested information is incomplete or malformed'
+          level: ERROR
+        - message: 'Invalid email and password'
+          level: ERROR
+          logger: USER
+      errors:
+        - code: "InvalidEmail"
+          message: "Email is malformed"
+          field: email
+        - code: "UnsavePassword"
+          message: "Password is not secure"
+          field: pasword
+      status: 400
+
+
+ErrorItemType:
+  type: object
+  required:
+    - code
+    - message
+  properties:
+    code:
+      type: string
+      description: Typically the name of the exception that produced it otherwise some known error code
+    message:
+      type: string
+      description: Error message specific to this item
+    resource:
+      type: string
+      description: API resource affected by this error
+    field:
+      type: string
+      description: Specific field within the resource

apis/shared/schemas/health_check.yaml renamed to api/specs/shared/schemas/health_check.yaml

@@ -0,0 +1,36 @@
+FakeEnveloped:
+  type: object
+  required:
+    - data
+    - error
+  properties:
+    data:
+      $ref: '#/FakeType'
+      nullable: true
+      default: null
+    error:
+      $ref: "./error.yaml#/ErrorType"
+      nullable: true
+      default: null
+
+FakeType:
+  type: object
+  required:
+    - path_value
+    - query_value
+    - body_value
+  properties:
+    path_value:
+      type: string
+    query_value:
+      type: string
+    body_value:
+      type: object
+      additionalProperties:
+        type: string
+  example:
+    path_value: foo
+    query_value: bar
+    body_value:
+      key1: value1
+      key2: value2

apis/shared/schemas/node-meta-v0.0.1-converted.yaml renamed to api/specs/shared/schemas/node-meta-v0.0.1-converted.yaml

@@ -0,0 +1,32 @@
+HealthCheckEnveloped:
+  type: object
+  required:
+    - data
+    - error
+  properties:
+    data:
+      $ref: '#/HealthCheckType'
+      nullable: true
+      default: null
+    error:
+      $ref: "./error.yaml#/ErrorType"
+      nullable: true
+      default: null
+
+
+HealthCheckType:
+  type: object
+  properties:
+    name:
+      type: string
+    status:
+      type: string
+    api_version:
+      type: string
+    version:
+      type: string
+  example:
+    name: 'simcore-director-service'
+    status: SERVICE_RUNNING
+    api_version: 0.1.0-dev+NJuzzD9S
+    version: 0.1.0-dev+N127Mfv9H

apis/shared/schemas/node-meta-v0.0.1.json renamed to api/specs/shared/schemas/node-meta-v0.0.1.json

@@ -0,0 +1,44 @@
+LogMessageEnveloped:
+  type: object
+  required:
+    - data
+    - error
+  properties:
+    data:
+      $ref: "#/LogMessageType"
+      nullable: true
+      default: null
+    error:
+      $ref: "./error.yaml#/ErrorType"
+      nullable: true
+      default: null
+
+
+LogMessageType:
+# - logger can be use as a way for the client to filter messages.
+# - E.g. logger naming can be hierarchical, and all including "*.user.*"
+#   are displayed as a flash message in the front-end
+#
+  type: object
+  properties:
+    level:
+      description: log level
+      type: string
+      default: INFO
+      enum:
+       - DEBUG
+       - WARNING
+       - INFO
+       - ERROR
+    message:
+      description: log message. If logger is USER, then it MUST be human readable
+      type: string
+    logger:
+      description: name of the logger receiving this message
+      type: string
+  required:
+   - message
+  example:
+    message: 'Hi there, Mr user'
+    level: INFO
+    logger: user-logger

apis/shared/schemas/node-output-list-api-v0.0.1.yaml renamed to api/specs/shared/schemas/node-output-list-api-v0.0.1.yaml

@@ -0,0 +1,28 @@
+LoginEnveloped:
+  type: object
+  required:
+    - data
+    - error
+  properties:
+    data:
+      $ref: '#/LoginFormType'
+      nullable: true
+      default: null
+    error:
+      $ref: "./error.yaml#/ErrorType"
+      nullable: true
+      default: null
+
+
+LoginFormType:
+  type: object
+  properties:
+    email:
+      type: string
+      #FIXME: format: email
+    password:
+      type: string
+      #FIXME: format: password
+  example:
+    email: [email protected]
+    password: 'my secret'

apis/shared/schemas/response204.yaml renamed to api/specs/shared/schemas/response204.yaml

@@ -0,0 +1,36 @@
+RegistrationEnveloped:
+  type: object
+  required:
+    - data
+    - error
+  properties:
+    data:
+      $ref: '#/RegistrationType'
+      nullable: true
+      default: null
+    error:
+      $ref: "./error.yaml#/ErrorType"
+      nullable: true
+      default: null
+
+
+RegistrationType:
+  type: object
+  properties:
+    email:
+      type: string
+      #FIXME:  'error': {'logs': [], 'errors': [{'code': 'OpenAPISchemaError', 'message': 'Unsupported email format unmarshalling', 'resource': None, 'field': None}], 'status': 400}}
+      #format: email
+    password:
+      type: string
+      # TODO:   File "/home/crespo/devp/osparc-simcore/.venv/lib/python3.6/site-packages/openapi_core/schema/schemas/models.py", line 182, in _unmarshal_string
+      # formatter = self.STRING_FORMAT_CAST_CALLABLE_GETTER[schema_format]
+      # KeyError: <SchemaFormat.PASSWORD: 'password'>
+      #format: password
+    confirm:
+      type: string
+      #format: password
+  example:
+    email: [email protected]
+    password: 'my secret'
+    confim: 'my secret'