Merge pull request #28 from cloudblue/LITE-20681-new-events-types

New event types

Author: marcserrat

connect/eaas/config.py

@@ -0,0 +1,110 @@
+#
+# This file is part of the Ingram Micro CloudBlue Connect EaaS Extension Runner.
+#
+# Copyright (c) 2021 Ingram Micro. All Rights Reserved.
+#
+import logging
+
+from connect.eaas.helpers import (
+    get_environment,
+)
+
+
+logger = logging.getLogger(__name__)
+
+
+class ConfigHelper:
+    """
+    Provides both static (from env vars) and dynamic (from backend)
+    configuration.
+    """
+    def __init__(self, secure=True):
+        self.secure = secure
+        self.env = get_environment()
+        self.dyn_config = None
+
+    @property
+    def api_key(self):
+        return self.env['api_key']
+
+    @property
+    def service_id(self):
+        return self.dyn_config.service_id
+
+    @property
+    def product_id(self):
+        return self.dyn_config.product_id
+
+    @property
+    def hub_id(self):
+        return self.dyn_config.hub_id
+
+    @property
+    def environment_id(self):
+        return self.env['environment_id']
+
+    @property
+    def instance_id(self):
+        return self.env['instance_id']
+
+    @property
+    def environment_type(self):
+        return self.dyn_config.environment_type
+
+    @property
+    def account_id(self):
+        return self.dyn_config.account_id
+
+    @property
+    def account_name(self):
+        return self.dyn_config.account_name
+
+    @property
+    def logging_api_key(self):
+        return self.dyn_config.logging_api_key
+
+    @property
+    def variables(self):
+        return self.dyn_config.configuration
+
+    @property
+    def metadata(self):
+        return {
+            'api_address': self.env['api_address'],
+            'service_id': self.service_id,
+            'environment_id': self.environment_id,
+            'environment_type': self.environment_type,
+            'instance_id': self.instance_id,
+            'account_id': self.account_id,
+            'account_name': self.account_name,
+        }
+
+    def get_ws_url(self):
+        proto = 'wss' if self.secure else 'ws'
+        return (
+            f'{proto}://{self.env["ws_address"]}/public/v1/devops/ws'
+            f'/{self.env["environment_id"]}/{self.env["instance_id"]}'
+        )
+
+    def get_api_url(self):
+        return f'https://{self.env["api_address"]}/public/v1'
+
+    def get_headers(self):
+        return (('Authorization', self.api_key),)
+
+    def get_timeout(self, category):
+        return self.env[f'{category}_task_max_execution_time']
+
+    def update_dynamic_config(self, data):
+        """Updates the dynamic configuration."""
+        self.dyn_config = data
+        logger.info(f'Runner dynamic config updated {data}')
+        if data.log_level:
+            logger.info(f'Change extesion logger level to {data.log_level}')
+            logging.getLogger('eaas.extension').setLevel(
+                getattr(logging, data.log_level),
+            )
+        if data.runner_log_level:
+            logging.getLogger('connect.eaas').setLevel(
+                getattr(logging, data.runner_log_level),
+            )

connect/eaas/constants.py

@@ -23,6 +23,11 @@
     TaskType.TIER_CONFIG_ADJUSTMENT_REQUEST_PROCESSING: 'process_tier_config_adjustment_request',
     TaskType.TIER_CONFIG_SETUP_REQUEST_VALIDATION: 'validate_tier_config_setup_request',
     TaskType.TIER_CONFIG_CHANGE_REQUEST_VALIDATION: 'validate_tier_config_change_request',
+    TaskType.LISTING_NEW_REQUEST_PROCESSING: 'process_new_listing_request',
+    TaskType.LISTING_REMOVE_REQUEST_PROCESSING: 'process_remove_listing_request',
+    TaskType.TIER_ACCOUNT_UPDATE_REQUEST_PROCESSING: 'process_tier_account_update_request',
+    TaskType.USAGE_FILE_REQUEST_PROCESSING: 'process_usage_file',
+    TaskType.PART_USAGE_FILE_REQUEST_PROCESSING: 'process_usage_chunk_file',
 }
 
 ASSET_REQUEST_TASK_TYPES = (
@@ -44,6 +49,11 @@
     TaskType.TIER_CONFIG_ADJUSTMENT_REQUEST_PROCESSING,
 )
 
+LISTING_REQUEST_TASK_TYPES = (
+    TaskType.LISTING_NEW_REQUEST_PROCESSING,
+    TaskType.LISTING_REMOVE_REQUEST_PROCESSING,
+)
+
 BACKGROUND_TASK_TYPES = (
     TaskType.ASSET_PURCHASE_REQUEST_PROCESSING,
     TaskType.ASSET_CHANGE_REQUEST_PROCESSING,
@@ -54,6 +64,12 @@
     TaskType.TIER_CONFIG_SETUP_REQUEST_PROCESSING,
     TaskType.TIER_CONFIG_CHANGE_REQUEST_PROCESSING,
     TaskType.TIER_CONFIG_ADJUSTMENT_REQUEST_PROCESSING,
+    TaskType.LISTING_NEW_REQUEST_PROCESSING,
+    TaskType.LISTING_REMOVE_REQUEST_PROCESSING,
+    TaskType.TIER_ACCOUNT_UPDATE_REQUEST_PROCESSING,
+    TaskType.USAGE_FILE_REQUEST_PROCESSING,
+    TaskType.PART_USAGE_FILE_REQUEST_PROCESSING,
+
 )
 
 INTERACTIVE_TASK_TYPES = (
@@ -65,7 +81,19 @@
     TaskType.PRODUCT_CUSTOM_EVENT_PROCESSING,
 )
 
+VALIDATION_TASK_TYPES = (
+    TaskType.ASSET_PURCHASE_REQUEST_VALIDATION,
+    TaskType.ASSET_CHANGE_REQUEST_VALIDATION,
+    TaskType.TIER_CONFIG_SETUP_REQUEST_VALIDATION,
+    TaskType.TIER_CONFIG_CHANGE_REQUEST_VALIDATION,
+)
+
+OTHER_INTERACTIVE_TASK_TYPES = (
+    TaskType.PRODUCT_ACTION_EXECUTION,
+    TaskType.PRODUCT_CUSTOM_EVENT_PROCESSING,
+)
+
 BACKGROUND_TASK_MAX_EXECUTION_TIME = 300
 INTERACTIVE_TASK_MAX_EXECUTION_TIME = 120
-SCHEDULED_TASK_MAX_EXECUTION_TIME = 300
+SCHEDULED_TASK_MAX_EXECUTION_TIME = 60 * 60 * 12
 RESULT_SENDER_MAX_RETRIES = 5

connect/eaas/dataclasses.py

@@ -19,6 +19,11 @@ class TaskType:
     TIER_CONFIG_SETUP_REQUEST_VALIDATION = 'tier_config_setup_request_validation'
     TIER_CONFIG_CHANGE_REQUEST_VALIDATION = 'tier_config_change_request_validation'
     SCHEDULED_EXECUTION = 'scheduled_execution'
+    LISTING_NEW_REQUEST_PROCESSING = 'listing_new_request_processing'
+    LISTING_REMOVE_REQUEST_PROCESSING = 'listing_remove_request_processing'
+    TIER_ACCOUNT_UPDATE_REQUEST_PROCESSING = 'tier_account_update_request_processing'
+    USAGE_FILE_REQUEST_PROCESSING = 'usage_file_request_processing'
+    PART_USAGE_FILE_REQUEST_PROCESSING = 'part_usage_file_request_processing'
 
 
 class MessageType:
@@ -68,6 +73,8 @@ class ConfigurationPayload:
     service_id: Optional[str] = None
     log_level: Optional[str] = None
     runner_log_level: Optional[str] = None
+    product_id: Optional[str] = None
+    hub_id: Optional[str] = None
 
 
 @dataclasses.dataclass

connect/eaas/extension.py

@@ -116,7 +116,7 @@ def __init__(self, client, logger, config):
         self.config = config
 
     @classmethod
-    def get_descriptor(cls):
+    def get_descriptor(cls):  # pragma: no cover
         return json.load(
             pkg_resources.resource_stream(
                 cls.__module__,
@@ -168,3 +168,18 @@ def execute_product_action(self, request):  # pragma: no cover
 
     def process_product_custom_event(self, request):  # pragma: no cover
         raise NotImplementedError()
+
+    def process_new_listing_request(self, request):  # pragma: no cover
+        raise NotImplementedError()
+
+    def process_remove_listing_request(self, request):  # pragma: no cover
+        raise NotImplementedError()
+
+    def process_tier_account_update_request(self, request):  # pragma: no cover
+        raise NotImplementedError()
+
+    def process_usage_file(self, request):  # pragma: no cover
+        raise NotImplementedError()
+
+    def process_usage_chunk_file(self, request):  # pragma: no cover
+        raise NotImplementedError()

connect/eaas/handler.py

@@ -0,0 +1,84 @@
+import logging
+
+from connect.client import AsyncConnectClient, ConnectClient
+from connect.eaas.helpers import (
+    get_extension_class,
+    get_extension_type,
+)
+from connect.eaas.config import ConfigHelper
+from connect.eaas.logging import ExtensionLogHandler, RequestLogger
+
+
+class ExtensionHandler:
+    """
+    Handle the lifecycle of an extension.
+    """
+    def __init__(self, config: ConfigHelper):
+        self.config = config
+        self.extension_class = get_extension_class()
+        self.extension_type = get_extension_type(self.extension_class)
+        self.descriptor = self.extension_class.get_descriptor()
+        self.logging_handler = None
+
+    @property
+    def capabilities(self):
+        return self.descriptor['capabilities']
+
+    @property
+    def variables(self):
+        return self.descriptor.get('variables')
+
+    @property
+    def schedulables(self):
+        return self.descriptor.get('schedulables')
+
+    @property
+    def readme(self):
+        return self.descriptor['readme_url']
+
+    @property
+    def changelog(self):
+        return self.descriptor['changelog_url']
+
+    def new_extension(self, task_id):
+        return self.extension_class(
+            self._create_client(task_id),
+            logging.LoggerAdapter(
+                self._create_logger(),
+                {'task_id': task_id},
+            ),
+            self.config.variables,
+        )
+
+    def _create_logger(self):
+        """
+        Returns a logger instance configured with the LogZ.io handler.
+        This logger will be used by the extension to send logging records
+        to the Logz.io service.
+        """
+        logger = logging.getLogger('eaas.extension')
+        if self.logging_handler is None and self.config.logging_api_key is not None:
+            self.logging_handler = ExtensionLogHandler(
+                self.config.logging_api_key,
+                default_extra_fields=self.config.metadata,
+            )
+            logger.addHandler(self.logging_handler)
+        return logger
+
+    def _create_client(self, task_id):
+        """
+        Get an instance of the Connect Openapi Client. If the extension is asyncrhonous
+        it returns an instance of the AsyncConnectClient otherwise the ConnectClient.
+        """
+        Client = ConnectClient if self.extension_type == 'sync' else AsyncConnectClient
+        return Client(
+            self.config.api_key,
+            endpoint=self.config.get_api_url(),
+            use_specs=False,
+            logger=RequestLogger(
+                logging.LoggerAdapter(
+                    self._create_logger(),
+                    {'task_id': task_id},
+                ),
+            ),
+        )

connect/eaas/helpers.py

@@ -10,7 +10,12 @@
 
 import pkg_resources
 
-from connect.eaas.constants import TASK_TYPE_EXT_METHOD_MAP
+from connect.eaas.constants import (
+    BACKGROUND_TASK_MAX_EXECUTION_TIME,
+    INTERACTIVE_TASK_MAX_EXECUTION_TIME,
+    SCHEDULED_TASK_MAX_EXECUTION_TIME,
+    TASK_TYPE_EXT_METHOD_MAP,
+)
 from connect.eaas.exceptions import EaaSError
 
 
@@ -57,6 +62,15 @@ def get_environment():
         'instance_id': os.getenv('INSTANCE_ID', get_container_id()),
         'ws_address': os.getenv('SERVER_ADDRESS', 'api.cnct.info'),
         'api_address': os.getenv('API_ADDRESS', os.getenv('SERVER_ADDRESS', 'api.cnct.info')),
+        'background_task_max_execution_time': int(os.getenv(
+            'BACKGROUND_TASK_MAX_EXECUTION_TIME', BACKGROUND_TASK_MAX_EXECUTION_TIME,
+        )),
+        'interactive_task_max_execution_time': int(os.getenv(
+            'INTERACTIVE_TASK_MAX_EXECUTION_TIME', INTERACTIVE_TASK_MAX_EXECUTION_TIME,
+        )),
+        'scheduled_task_max_execution_time': int(os.getenv(
+            'SCHEDULED_TASK_MAX_EXECUTION_TIME', SCHEDULED_TASK_MAX_EXECUTION_TIME,
+        )),
     }
 
 

connect/eaas/logging.py

@@ -15,7 +15,6 @@ def extra_fields(self, message):
 
 
 class RequestLogger:
-
     def __init__(self, logger):
         self.logger = logger