azure/aria/aria-extension-cloudify/src/aria/aria/orchestrator/workflows/executor/base.py

   1 # Licensed to the Apache Software Foundation (ASF) under one or more
   2 # contributor license agreements.  See the NOTICE file distributed with
   3 # this work for additional information regarding copyright ownership.
   4 # The ASF licenses this file to You under the Apache License, Version 2.0
   5 # (the "License"); you may not use this file except in compliance with
   6 # the License.  You may obtain a copy of the License at
   7 #
   8 #     http://www.apache.org/licenses/LICENSE-2.0
   9 #
  10 # Unless required by applicable law or agreed to in writing, software
  11 # distributed under the License is distributed on an "AS IS" BASIS,
  12 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13 # See the License for the specific language governing permissions and
  14 # limitations under the License.
  15
  16 """
  17 Base class for task executors.
  18 """
  19
  20 from aria import logger
  21 from aria.orchestrator import events
  22
  23
  24 class BaseExecutor(logger.LoggerMixin):
  25     """
  26     Base class for task executors.
  27     """
  28     def _execute(self, ctx):
  29         raise NotImplementedError
  30
  31     def execute(self, ctx):
  32         """
  33         Executes a task.
  34
  35         :param task: task to execute
  36         """
  37         if ctx.task.function:
  38             self._execute(ctx)
  39         else:
  40             # In this case the task is missing a function. This task still gets to an
  41             # executor, but since there is nothing to run, we by default simply skip the
  42             # execution itself.
  43             self._task_started(ctx)
  44             self._task_succeeded(ctx)
  45
  46     def close(self):
  47         """
  48         Closes the executor.
  49         """
  50         pass
  51
  52     def terminate(self, task_id):
  53         """
  54         Terminate the executing task
  55         :return:
  56         """
  57         pass
  58
  59     @staticmethod
  60     def _task_started(ctx):
  61         events.start_task_signal.send(ctx)
  62
  63     @staticmethod
  64     def _task_failed(ctx, exception, traceback=None):
  65         events.on_failure_task_signal.send(ctx, exception=exception, traceback=traceback)
  66
  67     @staticmethod
  68     def _task_succeeded(ctx):
  69         events.on_success_task_signal.send(ctx)
  70
  71
  72 class StubTaskExecutor(BaseExecutor):                                                               # pylint: disable=abstract-method
  73     def execute(self, ctx, *args, **kwargs):
  74         with ctx.persist_changes:
  75             ctx.task.status = ctx.task.SUCCESS