+
+
+ {{workflow_version.name}}
+ (version {{workflow_version.version}})
+
+
+ + {% if build.status == 'failed' %} + Some builds on instance {{test_instance.name}} were not successful + {% else %} + Test instance {{test_instance.name}} has recovered + {% endif %} +
+ +
+ 
+
+
+
+ + + Test Build #{{build.id}} + {{ 'failed' if build.status == 'failed' else 'passed' }} !!! +
+ +
+ test suite
+
+ {{suite.name}}
+
+ running on the
+
+ {{test_instance.testing_service.type}}
+ service
+
+ through the + + {{test_instance.name}} + + instance +
+
+
+ + through the + + {{test_instance.name}} + + instance +
+
+
diff --git a/lifemonitor/templates/mail/validate_email.j2 b/lifemonitor/templates/mail/validate_email.j2
new file mode 100644
index 000000000..285d1fed4
--- /dev/null
+++ b/lifemonitor/templates/mail/validate_email.j2
@@ -0,0 +1,86 @@
+
+
+
+
+
+
+
+
+
+
+
+
+ + email updated +
+ ++ Hi, {{user.username}} +
+ +
+ Click the button below to confirm your email address
+
+
+
+
+
+ or copy and paste the following link into your browser
+ {{confirmation_address}}
+
+
+
+
diff --git a/lifemonitor/utils.py b/lifemonitor/utils.py
index 78f124375..da0868932 100644
--- a/lifemonitor/utils.py
+++ b/lifemonitor/utils.py
@@ -85,6 +85,16 @@ def values_as_string(values, in_separator='\\s?,\\s?|\\s+', out_separator=" "):
raise ValueError("Invalid format")
+def boolean_value(value) -> bool:
+ if value is None or value == "":
+ return False
+ if isinstance(value, bool):
+ return value
+ if isinstance(value, str):
+ return bool_from_string(value)
+ raise ValueError(f"Invalid value for boolean. Got '{value}'")
+
+
def bool_from_string(s) -> bool:
if s is None or s == "":
return None
@@ -468,3 +478,30 @@ def get_class(self, concrete_type):
def get_classes(self):
return [_[0] for _ in self._concrete_types.values()]
+
+
+class Base64Encoder(object):
+
+ _cache = {}
+
+ @classmethod
+ def encode_file(cls, file: str) -> str:
+ data = cls._cache.get(file, None)
+ if data is None:
+ with open(file, "rb") as f:
+ data = base64.b64encode(f.read())
+ cls._cache[file] = data
+ return data.decode()
+
+ @classmethod
+ def encode_object(cls, obj: object) -> str:
+ key = hash(frozenset(obj.items()))
+ data = cls._cache.get(key, None)
+ if data is None:
+ data = base64.b64encode(json.dumps(obj).encode())
+ cls._cache[key] = data
+ return data.decode()
+
+ @classmethod
+ def decode(cls, data: str) -> object:
+ return base64.b64decode(data.encode())
diff --git a/migrations/versions/24c34681f538_add_list_of_events_to_the_subscription_.py b/migrations/versions/24c34681f538_add_list_of_events_to_the_subscription_.py
new file mode 100644
index 000000000..4d091cf15
--- /dev/null
+++ b/migrations/versions/24c34681f538_add_list_of_events_to_the_subscription_.py
@@ -0,0 +1,25 @@
+"""Add list of events to the subscription model
+
+Revision ID: 24c34681f538
+Revises: d5da43a38a6a
+Create Date: 2022-01-21 15:29:19.648485
+
+"""
+from alembic import op
+import sqlalchemy as sa
+from lifemonitor.models import IntegerSet
+
+# revision identifiers, used by Alembic.
+revision = '24c34681f538'
+down_revision = 'd5da43a38a6a'
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+ op.add_column('subscription', sa.Column('events', IntegerSet(), nullable=True))
+ op.execute("UPDATE subscription SET events = '0'")
+
+
+def downgrade():
+ op.drop_column('subscription', 'events')
diff --git a/migrations/versions/296634f13bc4_automatically_register_submitter_.py b/migrations/versions/296634f13bc4_automatically_register_submitter_.py
new file mode 100644
index 000000000..b085e5ede
--- /dev/null
+++ b/migrations/versions/296634f13bc4_automatically_register_submitter_.py
@@ -0,0 +1,35 @@
+"""Automatically register submitter subscription to workflows
+
+Revision ID: 296634f13bc4
+Revises: a46c90bedbbf
+Create Date: 2022-01-24 14:07:00.098626
+
+"""
+import logging
+from datetime import datetime
+
+from alembic import op
+
+# set logger
+logger = logging.getLogger('alembic.env')
+
+
+# revision identifiers, used by Alembic.
+revision = '296634f13bc4'
+down_revision = 'a46c90bedbbf'
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+ bind = op.get_bind()
+ res = bind.execute('SELECT * from workflow_version WHERE workflow_id NOT IN (SELECT resource_id FROM subscription)')
+ logger.info(res)
+ for wdata in res:
+ logger.info("(v_id,submitter,wf_id)=(%d,%d,%d)", wdata[0], wdata[1], wdata[2])
+ now = datetime.utcnow()
+ bind.execute(f"INSERT INTO subscription (user_id,created,modified,resource_id,events) VALUES ({wdata[1]},TIMESTAMP '{now}',TIMESTAMP '{now}',{wdata[2]},'0')")
+
+
+def downgrade():
+ pass
diff --git a/migrations/versions/505e4e6976de_add_uuid_property_to_notification_model.py b/migrations/versions/505e4e6976de_add_uuid_property_to_notification_model.py
new file mode 100644
index 000000000..7122b57b5
--- /dev/null
+++ b/migrations/versions/505e4e6976de_add_uuid_property_to_notification_model.py
@@ -0,0 +1,36 @@
+"""Add uuid property to notification model
+
+Revision ID: 505e4e6976de
+Revises: 296634f13bc4
+Create Date: 2022-01-27 11:43:27.119562
+
+"""
+from alembic import op
+import sqlalchemy as sa
+from lifemonitor.models import UUID
+import uuid as _uuid
+
+# revision identifiers, used by Alembic.
+revision = '505e4e6976de'
+down_revision = '296634f13bc4'
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+ bind = op.get_bind()
+ notifications = bind.execute("SELECT id FROM notification")
+ # ### commands auto generated by Alembic - please adjust! ###
+ op.add_column('notification', sa.Column('uuid', UUID(), nullable=True))
+ for n in notifications:
+ bind.execute(f"UPDATE notification SET uuid = '{_uuid.uuid4()}' WHERE id = {n[0]}")
+ op.alter_column('notification', 'uuid', nullable=False)
+ op.create_index(op.f('ix_notification_uuid'), 'notification', ['uuid'], unique=False)
+ # ### end Alembic commands ###
+
+
+def downgrade():
+ # ### commands auto generated by Alembic - please adjust! ###
+ op.drop_index(op.f('ix_notification_uuid'), table_name='notification')
+ op.drop_column('notification', 'uuid')
+ # ### end Alembic commands ###
diff --git a/migrations/versions/97e77a9c44b2_add_user_notification_model.py b/migrations/versions/97e77a9c44b2_add_user_notification_model.py
new file mode 100644
index 000000000..51ebf5790
--- /dev/null
+++ b/migrations/versions/97e77a9c44b2_add_user_notification_model.py
@@ -0,0 +1,48 @@
+"""Add user notification model
+
+Revision ID: 97e77a9c44b2
+Revises: f4cbfe20075f
+Create Date: 2022-01-17 13:21:37.565495
+
+"""
+from alembic import op
+import sqlalchemy as sa
+from lifemonitor.models import JSON
+
+
+# revision identifiers, used by Alembic.
+revision = '97e77a9c44b2'
+down_revision = 'f4cbfe20075f'
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+ op.create_table('notification',
+ sa.Column('id', sa.Integer(), nullable=False),
+ sa.Column('created', sa.DateTime(), nullable=True),
+ sa.Column('name', sa.String(), nullable=True),
+ sa.Column('type', sa.String(), nullable=False),
+ sa.Column('data', JSON(), nullable=True),
+ sa.PrimaryKeyConstraint('id')
+ )
+ op.create_table('user_notification',
+ sa.Column('emailed', sa.DateTime(), nullable=True),
+ sa.Column('read', sa.DateTime(), nullable=True),
+ sa.Column('user_id', sa.Integer(), nullable=False),
+ sa.Column('notification_id', sa.Integer(), nullable=False),
+ sa.ForeignKeyConstraint(['notification_id'], ['notification.id'], ),
+ sa.ForeignKeyConstraint(['user_id'], ['user.id'], ),
+ sa.PrimaryKeyConstraint('user_id', 'notification_id')
+ )
+ op.add_column('user', sa.Column('email', sa.String(), nullable=True))
+ op.add_column('user', sa.Column('email_verification_hash', sa.String(length=256), nullable=True))
+ op.add_column('user', sa.Column('email_verified', sa.Boolean(), nullable=True))
+
+
+def downgrade():
+ op.drop_column('user', 'email_verified')
+ op.drop_column('user', 'email_verification_hash')
+ op.drop_column('user', 'email')
+ op.drop_table('user_notification')
+ op.drop_table('notification')
diff --git a/migrations/versions/a46c90bedbbf_change_notification_type_str_to_.py b/migrations/versions/a46c90bedbbf_change_notification_type_str_to_.py
new file mode 100644
index 000000000..00c4e0e97
--- /dev/null
+++ b/migrations/versions/a46c90bedbbf_change_notification_type_str_to_.py
@@ -0,0 +1,30 @@
+"""Change Notification.type::str to Notification.event::EventType
+
+Revision ID: a46c90bedbbf
+Revises: 24c34681f538
+Create Date: 2022-01-24 09:27:57.815975
+
+"""
+from alembic import op
+import sqlalchemy as sa
+
+
+# revision identifiers, used by Alembic.
+revision = 'a46c90bedbbf'
+down_revision = '24c34681f538'
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+ # ### commands auto generated by Alembic - please adjust! ###
+ op.add_column('notification', sa.Column('event', sa.Integer(), nullable=False))
+ op.drop_column('notification', 'type')
+ # ### end Alembic commands ###
+
+
+def downgrade():
+ # ### commands auto generated by Alembic - please adjust! ###
+ op.add_column('notification', sa.Column('type', sa.VARCHAR(), autoincrement=False, nullable=False))
+ op.drop_column('notification', 'event')
+ # ### end Alembic commands ###
diff --git a/migrations/versions/d1387a6fe551_add_name_index_on_notification_model.py b/migrations/versions/d1387a6fe551_add_name_index_on_notification_model.py
new file mode 100644
index 000000000..7629c681d
--- /dev/null
+++ b/migrations/versions/d1387a6fe551_add_name_index_on_notification_model.py
@@ -0,0 +1,23 @@
+"""Add name index on notification model
+
+Revision ID: d1387a6fe551
+Revises: 97e77a9c44b2
+Create Date: 2022-01-18 15:41:53.769530
+
+"""
+from alembic import op
+
+
+# revision identifiers, used by Alembic.
+revision = 'd1387a6fe551'
+down_revision = '97e77a9c44b2'
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+ op.create_index(op.f('ix_notification_name'), 'notification', ['name'], unique=False)
+
+
+def downgrade():
+ op.drop_index(op.f('ix_notification_name'), table_name='notification')
diff --git a/migrations/versions/d5da43a38a6a_add_flag_to_enable_disable_mail_.py b/migrations/versions/d5da43a38a6a_add_flag_to_enable_disable_mail_.py
new file mode 100644
index 000000000..9004634a4
--- /dev/null
+++ b/migrations/versions/d5da43a38a6a_add_flag_to_enable_disable_mail_.py
@@ -0,0 +1,26 @@
+"""Add flag to enable/disable mail notifications
+
+Revision ID: d5da43a38a6a
+Revises: d1387a6fe551
+Create Date: 2022-01-20 13:27:41.016651
+
+"""
+from alembic import op
+import sqlalchemy as sa
+
+
+# revision identifiers, used by Alembic.
+revision = 'd5da43a38a6a'
+down_revision = 'd1387a6fe551'
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+ op.add_column('user', sa.Column('email_notifications', sa.Boolean()))
+ op.execute("UPDATE \"user\" SET email_notifications = true")
+ op.alter_column('user', 'email_notifications', nullable=False)
+
+
+def downgrade():
+ op.drop_column('user', 'email_notifications')
diff --git a/requirements.txt b/requirements.txt
index 45fdeb9c9..14b532e83 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -13,6 +13,7 @@ flask-wtf~=0.15.1
Flask-APScheduler==1.12.2
Flask-SQLAlchemy==2.5.1
Flask-Migrate==3.1.0
+Flask-Mail~=0.9.1
Flask>=1.1.4,<2.0.0
gunicorn~=20.1.0
jwt==1.2.0
diff --git a/settings.conf b/settings.conf
index 33119552e..fdaa9c056 100644
--- a/settings.conf
+++ b/settings.conf
@@ -16,6 +16,9 @@ FLASK_ENV=development
# used as base_url on all the links returned by the API
#EXTERNAL_SERVER_URL=https://lifemonitor.eu
+# Base URL of the LifeMonitor web app associated with this back-end instance
+WEBAPP_URL=https://app.lifemonitor.eu
+
# Normally, OAuthLib will raise an InsecureTransportError if you attempt to use OAuth2 over HTTP,
# rather than HTTPS. Setting this environment variable will prevent this error from being raised.
# This is mostly useful for local testing, or automated tests. Never set this variable in production.
@@ -54,6 +57,15 @@ REDIS_HOST=redis
REDIS_PASSWORD=foobar
REDIS_PORT_NUMBER=6379
+# Email settings
+MAIL_SERVER=''
+MAIL_PORT=465
+MAIL_USERNAME=''
+MAIL_PASSWORD=''
+MAIL_USE_TLS=False
+MAIL_USE_SSL=True
+MAIL_DEFAULT_SENDER=''
+
# Cache settings
CACHE_REDIS_DB=0
CACHE_DEFAULT_TIMEOUT=300
diff --git a/specs/api.yaml b/specs/api.yaml
index d69518bc1..f45de7ef0 100644
--- a/specs/api.yaml
+++ b/specs/api.yaml
@@ -3,7 +3,7 @@
openapi: "3.0.0"
info:
- version: "0.5.1"
+ version: "0.6.0"
title: "Life Monitor API"
description: |
*Workflow sustainability service*
@@ -18,7 +18,7 @@ info:
servers:
- url: /
description: >
- Version 0.5.1 of API.
+ Version 0.6.0 of API.
tags:
- name: Registries
@@ -170,6 +170,122 @@ paths:
"404":
$ref: "#/components/responses/NotFound"
+ /users/current/notifications:
+ get:
+ tags: ["Users"]
+ x-openapi-router-controller: lifemonitor.auth.controllers
+ operationId: "user_notifications_get"
+ summary: List notifications for the current user
+ description: |
+ List all notifications for the current (authenticated) user
+ security:
+ - apiKey: ["user.profile"]
+ - RegistryCodeFlow: ["user.profile"]
+ - AuthorizationCodeFlow: ["user.profile"]
+ responses:
+ "200":
+ description: User profile
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ListOfNotifications"
+ "400":
+ $ref: "#/components/responses/BadRequest"
+ "401":
+ $ref: "#/components/responses/Unauthorized"
+ "403":
+ $ref: "#/components/responses/Forbidden"
+ "404":
+ $ref: "#/components/responses/NotFound"
+
+ put:
+ tags: ["Users"]
+ x-openapi-router-controller: lifemonitor.auth.controllers
+ operationId: "user_notifications_put"
+ summary: Mark as read notifications for the current user
+ description: |
+ Mark as read notifications for the current (authenticated) user
+ security:
+ - apiKey: ["user.profile"]
+ - RegistryCodeFlow: ["user.profile"]
+ - AuthorizationCodeFlow: ["user.profile"]
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ListOfNotifications"
+ responses:
+ "204":
+ description: "Notifications updated"
+ "400":
+ $ref: "#/components/responses/BadRequest"
+ "401":
+ $ref: "#/components/responses/Unauthorized"
+ "403":
+ $ref: "#/components/responses/Forbidden"
+ "404":
+ $ref: "#/components/responses/NotFound"
+
+ patch:
+ tags: ["Users"]
+ x-openapi-router-controller: lifemonitor.auth.controllers
+ operationId: "user_notifications_patch"
+ summary: Delete notifications for the current user
+ description: |
+ Delete notifications for the current (authenticated) user
+ security:
+ - apiKey: ["user.profile"]
+ - RegistryCodeFlow: ["user.profile"]
+ - AuthorizationCodeFlow: ["user.profile"]
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ description: List of UUIDs
+ type: array
+ items:
+ type: string
+ example: "21ac72ec-b9a5-49e0-b5a6-1322b8b54552"
+ responses:
+ "204":
+ description: "Notifications updated"
+ "400":
+ $ref: "#/components/responses/BadRequest"
+ "401":
+ $ref: "#/components/responses/Unauthorized"
+ "403":
+ $ref: "#/components/responses/Forbidden"
+ "404":
+ $ref: "#/components/responses/NotFound"
+
+ /users/current/notifications/{notification_uuid}:
+ delete:
+ tags: ["Users"]
+ x-openapi-router-controller: lifemonitor.auth.controllers
+ operationId: "user_notifications_delete"
+ summary: Delete notification for the current user
+ description: |
+ Delete notification for the current (authenticated) user
+ security:
+ - apiKey: ["user.profile"]
+ - RegistryCodeFlow: ["user.profile"]
+ - AuthorizationCodeFlow: ["user.profile"]
+ parameters:
+ - $ref: "#/components/parameters/notification_uuid"
+ responses:
+ "204":
+ description: "Notifications updated"
+ "400":
+ $ref: "#/components/responses/BadRequest"
+ "401":
+ $ref: "#/components/responses/Unauthorized"
+ "403":
+ $ref: "#/components/responses/Forbidden"
+ "404":
+ $ref: "#/components/responses/NotFound"
+
/registries/current:
get:
tags: ["Registry Client Operations"]
@@ -474,7 +590,7 @@ paths:
tags: ["Users"]
x-openapi-router-controller: lifemonitor.auth.controllers
operationId: "user_subscriptions_get"
- summary: "List all subscriptions for the current user"
+ summary: "List subscriptions for the current user"
description: |
List all subscriptions for the current user
security:
@@ -625,6 +741,42 @@ paths:
"404":
$ref: "#/components/responses/NotFound"
+ put:
+ summary: Subscribe user to workflow events
+ description: "Subscribe the current (authenticated) user to a list of events for the specified workflow"
+ x-openapi-router-controller: lifemonitor.api.controllers
+ operationId: "user_workflow_subscribe_events"
+ tags: ["Users"]
+ security:
+ - apiKey: ["workflow.write"]
+ - AuthorizationCodeFlow: ["workflow.write"]
+ - RegistryCodeFlow: ["workflow.write"]
+ parameters:
+ - $ref: "#/components/parameters/wf_uuid"
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ListOfEvents"
+ responses:
+ "201":
+ description: "Subscription to events created"
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Subscription"
+ "204":
+ description: "Subscription updated with events"
+ "400":
+ $ref: "#/components/responses/BadRequest"
+ "401":
+ $ref: "#/components/responses/Unauthorized"
+ "403":
+ $ref: "#/components/responses/Forbidden"
+ "404":
+ $ref: "#/components/responses/NotFound"
+
/workflows/{wf_uuid}/unsubscribe:
post:
summary: Unsubscribe user from a workflow
@@ -1290,6 +1442,14 @@ components:
minimum: 1
default: 10
description: "Maximum number of items to retrieve"
+ notification_uuid:
+ name: "notification_uuid"
+ description: "Universal unique identifier of the user notification"
+ in: path
+ schema:
+ type: string
+ required: true
+ example: 123e4567-e89b-12d3-a456-426614174000
responses:
NotFound:
@@ -1462,11 +1622,29 @@ components:
description: |
A timestamp for the modification time of the subscription
example: 1616427512.0
+ events:
+ $ref: "#/components/schemas/ListOfEvents"
required:
- user
- resource
- created
- modified
+ - events
+
+ EventType:
+ type: string
+ enum:
+ - ALL
+ - BUILD_FAILED
+ - BUILD_RECOVERED
+
+ ListOfEvents:
+ type: array
+ items:
+ $ref: "#/components/schemas/EventType"
+ description: |
+ List of events related to the specified workflow
+ example: ["all"]
ListOfSubscriptions:
type: object
@@ -1478,6 +1656,49 @@ components:
required:
- items
+ Notification:
+ type: object
+ description: A notification for the current user.
+ properties:
+ uuid:
+ type: string
+ description: Universal unique identifier of notification
+ example: aa16c6a9-571f-4a62-976f-60ea514ad2c1
+ data:
+ type: object
+ description: "Notification payload"
+ readOnly: true
+ created:
+ type: string
+ description: |
+ A timestamp for the creation time of the notification
+ example: 1616427012.0
+ readOnly: true
+ read:
+ type: string
+ description: |
+ A timestamp for the read time of the notification
+ example: 1616427012.0
+ emailed:
+ type: string
+ description: |
+ A timestamp for the time when the email was sent
+ example: 1616427012.0
+ readOnly: true
+ required:
+ - uuid
+ - created
+
+ ListOfNotifications:
+ type: object
+ properties:
+ items:
+ type: array
+ items:
+ $ref: "#/components/schemas/Notification"
+ required:
+ - items
+
IdentityProviderType:
type: string
enum:
@@ -1638,13 +1859,13 @@ components:
latest_version:
type: string
description: The workflow identifier on the registry
- example: '1.0'
+ example: "1.0"
versions:
description: The list of workflow versions
type: array
items:
type: string
- example: ['1.0', "1.0-dev"]
+ example: ["1.0", "1.0-dev"]
ListOfRegistryWorkflows:
type: object
diff --git a/tests/integration/api/controllers/test_user_subscriptions.py b/tests/integration/api/controllers/test_user_subscriptions.py
index 9236fb441..275b91e12 100644
--- a/tests/integration/api/controllers/test_user_subscriptions.py
+++ b/tests/integration/api/controllers/test_user_subscriptions.py
@@ -23,7 +23,7 @@
import pytest
from lifemonitor.api.services import LifeMonitor
-from lifemonitor.auth.models import User
+from lifemonitor.auth.models import EventType, User
from tests import utils
from tests.conftest_helpers import enable_auto_login
from tests.conftest_types import ClientAuthenticationMethod
@@ -62,12 +62,78 @@ def test_user_unsubscribe_not_authorized(app_client, client_auth_method, user1,
ClientAuthenticationMethod.REGISTRY_CODE_FLOW
], indirect=True)
@pytest.mark.parametrize("user1", [True], indirect=True)
-def test_user_subscribe_workflow(app_client, client_auth_method, user1, user1_auth, valid_workflow):
+def test_submitter_subscribe_workflow(app_client, client_auth_method,
+ user1, user1_auth, valid_workflow):
workflow = utils.pick_workflow(user1, valid_workflow)
logger.debug("User1 Auth Headers: %r", user1_auth)
enable_auto_login(user1['user'])
r = app_client.post(
- utils.build_workflow_path(workflow, include_version=False, subpath='subscribe'), headers=user1_auth
+ utils.build_workflow_path(workflow, include_version=False, subpath='subscribe'),
+ headers=user1_auth
+ )
+ assert r.status_code == 204, f"Error when subscribing to the workflow {workflow}"
+
+
+@pytest.mark.parametrize("client_auth_method", [
+ # ClientAuthenticationMethod.BASIC,
+ ClientAuthenticationMethod.API_KEY,
+ ClientAuthenticationMethod.AUTHORIZATION_CODE,
+ ClientAuthenticationMethod.REGISTRY_CODE_FLOW
+], indirect=True)
+@pytest.mark.parametrize("user1", [True], indirect=True)
+def test_user_subscribe_workflow(app_client, client_auth_method,
+ user1, user1_auth, user2, user2_auth,
+ valid_workflow):
+ workflow = utils.pick_workflow(user1, valid_workflow)
+ logger.debug("User1 Auth Headers: %r", user1_auth)
+ enable_auto_login(user1['user'])
+ r = app_client.post(
+ utils.build_workflow_path(workflow, include_version=False, subpath='subscribe'),
+ headers=user2_auth
+ )
+ assert r.status_code == 201, f"Error when subscribing to the workflow {workflow}"
+ data = json.loads(r.data.decode())
+ logger.debug(data)
+
+
+@pytest.mark.parametrize("client_auth_method", [
+ # ClientAuthenticationMethod.BASIC,
+ ClientAuthenticationMethod.API_KEY,
+ ClientAuthenticationMethod.AUTHORIZATION_CODE,
+ ClientAuthenticationMethod.REGISTRY_CODE_FLOW
+], indirect=True)
+@pytest.mark.parametrize("user1", [True], indirect=True)
+def test_user_subscribe_workflow_old_events(app_client, client_auth_method,
+ user1, user1_auth, valid_workflow):
+ workflow = utils.pick_workflow(user1, valid_workflow)
+ logger.debug("User1 Auth Headers: %r", user1_auth)
+ enable_auto_login(user1['user'])
+ body = [EventType.ALL.name]
+ r = app_client.put(
+ utils.build_workflow_path(workflow, include_version=False, subpath='subscribe'),
+ headers=user1_auth,
+ json=body
+ )
+ assert r.status_code == 204, f"Error when subscribing to the workflow {workflow}"
+
+
+@pytest.mark.parametrize("client_auth_method", [
+ # ClientAuthenticationMethod.BASIC,
+ ClientAuthenticationMethod.API_KEY,
+ ClientAuthenticationMethod.AUTHORIZATION_CODE,
+ ClientAuthenticationMethod.REGISTRY_CODE_FLOW
+], indirect=True)
+@pytest.mark.parametrize("user1", [True], indirect=True)
+def test_user_subscribe_workflow_new_events(app_client, client_auth_method,
+ user1, user1_auth, valid_workflow):
+ workflow = utils.pick_workflow(user1, valid_workflow)
+ logger.debug("User1 Auth Headers: %r", user1_auth)
+ enable_auto_login(user1['user'])
+ body = [EventType.BUILD_FAILED.name, EventType.BUILD_RECOVERED.name]
+ r = app_client.put(
+ utils.build_workflow_path(workflow, include_version=False, subpath='subscribe'),
+ headers=user1_auth,
+ json=body
)
assert r.status_code == 201, f"Error when subscribing to the workflow {workflow}"
data = json.loads(r.data.decode())
@@ -88,8 +154,25 @@ def test_user_unsubscribe_workflow(app_client, client_auth_method, user1, user1_
# register a subscription
workflow = lm.get_workflow(wdata['uuid'])
assert workflow, "Invalid workflow"
- lm.subscribe_user_resource(user, workflow)
- assert len(user.subscriptions) == 1, "Invalid number of subscriptions"
+ subscription = user.get_subscription(workflow)
+ assert subscription, "User should be subscribed to the workflow"
+
+ # check number of subscriptions before unsubscribing
+ r = app_client.get('/users/current/subscriptions', headers=user1_auth)
+ assert r.status_code == 200, f"Error when getting the list of subscriptions to the workflow {workflow}"
+ data = r.get_json()
+ logger.debug("Current list of subscriptions: %r", data)
+ assert 'items' in data, "Unexpected response type: missing 'items' property"
+ number_of_subscriptions = len(data['items'])
+ logger.debug("Current number of subscriptions: %r", number_of_subscriptions)
+
+ # check if there exists a subscription for the workflow
+ found = False
+ for s in data['items']:
+ if s['resource']['uuid'] == str(workflow.uuid):
+ found = True
+ break
+ assert found, "Unable to find the workflow among subscriptions"
# try to delete the subscription via API
r = app_client.post(
@@ -97,6 +180,13 @@ def test_user_unsubscribe_workflow(app_client, client_auth_method, user1, user1_
)
assert r.status_code == 204, f"Error when unsubscribing to the workflow {workflow}"
+ # check number of subscriptions after unsubscribing
+ r = app_client.get('/users/current/subscriptions', headers=user1_auth)
+ assert r.status_code == 200, f"Error when getting the list of subscriptions to the workflow {workflow}"
+ data = r.get_json()
+ assert 'items' in data, "Unexpected response type: missing 'items' property"
+ assert len(data['items']) == number_of_subscriptions - 1, "Unexpected number of subscriptions"
+
@pytest.mark.parametrize("client_auth_method", [
# ClientAuthenticationMethod.BASIC,
@@ -105,9 +195,13 @@ def test_user_unsubscribe_workflow(app_client, client_auth_method, user1, user1_
ClientAuthenticationMethod.REGISTRY_CODE_FLOW
], indirect=True)
@pytest.mark.parametrize("user1", [True], indirect=True)
-def test_user_subscriptions(app_client, client_auth_method, user1, user1_auth, valid_workflow, lm: LifeMonitor):
+def test_user_subscriptions(app_client, client_auth_method,
+ user1, user1_auth, user2, user2_auth,
+ valid_workflow, lm: LifeMonitor):
+ # pick user1 workflow
wdata = utils.pick_workflow(user1, valid_workflow)
- user: User = user1['user']
+ # set user2 as current user
+ user: User = user2['user']
enable_auto_login(user)
# register a subscription
workflow = lm.get_workflow(wdata['uuid'])
@@ -117,7 +211,7 @@ def test_user_subscriptions(app_client, client_auth_method, user1, user1_auth, v
# get subscriptions of the current user
r = app_client.get(
- '/users/current/subscriptions', headers=user1_auth
+ '/users/current/subscriptions', headers=user2_auth
)
assert r.status_code == 200, "Error when trying to get user subscriptions"
data = json.loads(r.data.decode())
diff --git a/tests/integration/api/services/test_workflow_subscriptions.py b/tests/integration/api/services/test_workflow_subscriptions.py
index 84fbcffa2..df9f237ae 100644
--- a/tests/integration/api/services/test_workflow_subscriptions.py
+++ b/tests/integration/api/services/test_workflow_subscriptions.py
@@ -20,25 +20,63 @@
import logging
-from lifemonitor.auth.models import User, Subscription
+from lifemonitor.auth.models import EventType, User, Subscription
from lifemonitor.api.services import LifeMonitor
from tests import utils
logger = logging.getLogger()
-def test_user_workflow_subscription(app_client, lm: LifeMonitor, user1: dict, valid_workflow: str):
- _, workflow = utils.pick_and_register_workflow(user1, valid_workflow)
+def test_submitter_workflow_subscription(app_client, lm: LifeMonitor, user1: dict, valid_workflow: str):
+ _, workflow_version = utils.pick_and_register_workflow(user1, valid_workflow)
+ user: User = user1['user']
+ # check number of subscriptions
+ assert len(user.subscriptions) == 1, "Unexpected number of subscriptions"
+ # subscribe to the workflow
+ s: Subscription = user.subscriptions[0]
+ assert s, "Subscription should not be empty"
+ assert s.resource.uuid == workflow_version.workflow.uuid, "Unexpected resource UUID"
+ assert s.resource == workflow_version.workflow, "Unexpected resource instance"
+ assert len(s.events) == 1, "Unexpected number of subscription events"
+
+
+def test_submitter_workflow_unsubscription(app_client, lm: LifeMonitor, user1: dict, valid_workflow: str):
+ _, workflow_version = utils.pick_and_register_workflow(user1, valid_workflow)
user: User = user1['user']
# check number of subscriptions
+ assert len(user.subscriptions) == 1, "Unexpected number of subscriptions"
+ # unsubscribe to workflow
+ s: Subscription = lm.unsubscribe_user_resource(user, workflow_version.workflow)
+ assert s, "Subscription should not be empty"
+ # check number of subscriptions
+ assert len(user.subscriptions) == 0, "Unexpected number of subscriptions"
+
+
+def test_user_workflow_subscription(app_client, lm: LifeMonitor, user1: dict, user2: dict, valid_workflow: str):
+ _, workflow = utils.pick_and_register_workflow(user1, valid_workflow)
+ user: User = user2['user']
+ # check number of subscriptions
assert len(user.subscriptions) == 0, "Unexpected number of subscriptions"
+
# subscribe to the workflow
- s: Subscription = lm.subscribe_user_resource(user, workflow)
+ events = [EventType.BUILD_FAILED, EventType.BUILD_RECOVERED]
+ s: Subscription = lm.subscribe_user_resource(user, workflow, events)
assert s, "Subscription should not be empty"
assert s.resource.uuid == workflow.uuid, "Unexpected resource UUID"
assert s.resource == workflow, "Unexpected resource instance"
+ assert len(s.events) == len(events), "Unexpected number of subscription events"
+ for e in events:
+ assert s.has_event(e), f"Subscription should be have event {e}"
# check number of subscriptions
assert len(user.subscriptions) == 1, "Unexpected number of subscriptions"
+
+ # update subscription events
+ events = [EventType.BUILD_FAILED]
+ s: Subscription = lm.subscribe_user_resource(user, workflow, events)
+ assert len(s.events) == len(events), "Unexpected number of subscription events"
+ for e in events:
+ assert s.has_event(e), f"Subscription should be have event {e}"
+
# unsubscribe to workflow
s: Subscription = lm.unsubscribe_user_resource(user, workflow)
assert s, "Subscription should not be empty"
diff --git a/tests/settings.conf b/tests/settings.conf
index 77c5aa288..b2732fdaf 100644
--- a/tests/settings.conf
+++ b/tests/settings.conf
@@ -8,6 +8,9 @@
# It is only used to build the links returned by the API
#EXTERNAL_ACCESS_BASE_URL="https://api.lifemonitor.eu"
+# Base URL of the LifeMonitor web app associated with this back-end instance
+# WEBAPP_URL=https://app.lifemonitor.eu
+
# Normally, OAuthLib will raise an InsecureTransportError if you attempt to use OAuth2 over HTTP,
# rather than HTTPS. Setting this environment variable will prevent this error from being raised.
# This is mostly useful for local testing, or automated tests. Never set this variable in production.
@@ -43,6 +46,15 @@ CACHE_SESSION_TIMEOUT=3600
CACHE_WORKFLOW_TIMEOUT=1800
CACHE_BUILD_TIMEOUT=84600
+# Email settings
+MAIL_SERVER=''
+MAIL_PORT=465
+MAIL_USERNAME=''
+MAIL_PASSWORD=''
+MAIL_USE_TLS=False
+MAIL_USE_SSL=True
+MAIL_DEFAULT_SENDER=''
+
# PostgreSQL DBMS settings
#POSTGRESQL_HOST=0.0.0.0
#POSTGRESQL_PORT=5432
diff --git a/tests/unit/api/models/test_subscriptions.py b/tests/unit/api/models/test_subscriptions.py
index c864d3bd5..b373e6d76 100644
--- a/tests/unit/api/models/test_subscriptions.py
+++ b/tests/unit/api/models/test_subscriptions.py
@@ -22,21 +22,48 @@
import logging
-from lifemonitor.auth.models import Subscription, User
+from lifemonitor.auth.models import User, EventType
from tests import utils
logger = logging.getLogger()
def test_workflow_subscription(user1: dict, valid_workflow: str):
- _, workflow = utils.pick_and_register_workflow(user1, valid_workflow)
+ _, workflow_version = utils.pick_and_register_workflow(user1, valid_workflow)
user: User = user1['user']
- s: Subscription = user.subscribe(workflow)
- logger.debug("Subscription: %r", s)
- assert s, "Subscription should not be empty"
- assert len(user.subscriptions) == 1, "Unexpected number of subscriptions"
-
- s: Subscription = user.unsubscribe(workflow)
- logger.debug("Subscription: %r", s)
- assert s, "Subscription should not be empty"
+
+ # check default subscription
+ s = user.get_subscription(workflow_version.workflow)
+ assert s, "The submitter subscription should be automatically registered"
+ # check default events
+ assert len(s.events) == 1, "Invalid number of events"
+ assert s.has_event(EventType.ALL), f"Event '{EventType.ALL.name}' not registered on the subscription"
+ for event in EventType.all():
+ assert s.has_event(event), f"Event '{event.name}' should be included"
+
+ # check delete all events
+ s.events = None
+ assert len(s.events) == 0, "Invalid number of events"
+ s.save()
+
+ # check event udpate
+ s.events = [EventType.BUILD_FAILED, EventType.BUILD_RECOVERED]
+ s.save()
+ assert len(s.events) == 2, "Invalid number of events"
+ assert not s.has_event(EventType.ALL), f"Event '{EventType.ALL.name}' should not be registered on the subscription"
+
+
+def test_workflow_unsubscription(user1: dict, valid_workflow: str):
+ _, workflow_version = utils.pick_and_register_workflow(user1, valid_workflow)
+ user: User = user1['user']
+
+ # check default subscription
+ s = user.get_subscription(workflow_version.workflow)
+ assert s, "The submitter subscription should be automatically registered"
+
+ # test unsubscription
+ user.unsubscribe(workflow_version.workflow)
+ user.save()
assert len(user.subscriptions) == 0, "Unexpected number of subscriptions"
+ s = user.get_subscription(workflow_version.workflow)
+ assert s is None, "Subscription should be empty"