container/tools/actions/abstract.py

# Copyright (C) 2019 The Android Open Source Project
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

import abc
import logging
import traceback

from datetime import datetime

import numpy as np

# pylint: disable=W0703
class AbstractAction(abc.ABC):
    def __init__(self, url, user, pwd, probability=1.0):
        self.url = url
        self.user = user
        self.pwd = pwd
        self.probability = probability
        self.was_executed = False
        self.failed = False

        self.log = logging.getLogger("ActionLogger")

    def execute(self):
        if self._is_executed():
            self.log.debug("%s STARTED", self.__class__.__name__)

            try:
                start = datetime.utcnow()
                result = self._execute_action()
                self._log_result(
                    duration=datetime.utcnow() - start,
                    message=self._create_log_message(),
                )
                return result
            except Exception:
                self.failed = True
                self._log_result(
                    duration=datetime.utcnow() - start,
                    message=traceback.format_exc().replace("\n", " "),
                )

        return None

    @abc.abstractmethod
    def _execute_action(self):
        pass

    @abc.abstractmethod
    def _create_log_message(self):
        pass

    def _log_result(self, duration=0, message=""):
        self.log.info(
            "%s %s %.2f %s",
            self.__class__.__name__,
            "FAILED" if self.failed else "OK",
            duration.total_seconds() * 1000,
            message,
        )

    def _is_executed(self):
        return np.random.choice(
            (True, False), 1, p=(self.probability, 1 - self.probability)
        )