workload-automation/wa/framework/run.py

#    Copyright 2013-2018 ARM Limited
#
# 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.
#

# Because of use of Enum (dynamic attrs)
# pylint: disable=no-member

import uuid
from collections import OrderedDict, Counter
from copy import copy
from datetime import datetime, timedelta

from wa.framework.configuration.core import Status
from wa.utils.serializer import Podable


class RunInfo(Podable):
    """
    Information about the current run, such as its unique ID, run
    time, etc.

    """
    _pod_serialization_version = 1

    @staticmethod
    def from_pod(pod):
        pod = RunInfo._upgrade_pod(pod)
        uid = pod.pop('uuid')
        _pod_version = pod.pop('_pod_version')
        duration = pod.pop('duration')
        if uid is not None:
            uid = uuid.UUID(uid)
        instance = RunInfo(**pod)
        instance._pod_version = _pod_version  # pylint: disable=protected-access
        instance.uuid = uid
        instance.duration = duration if duration is None else timedelta(seconds=duration)
        return instance

    def __init__(self, run_name=None, project=None, project_stage=None,
                 start_time=None, end_time=None, duration=None):
        super(RunInfo, self).__init__()
        self.uuid = uuid.uuid4()
        self.run_name = run_name
        self.project = project
        self.project_stage = project_stage
        self.start_time = start_time
        self.end_time = end_time
        self.duration = duration

    def to_pod(self):
        d = super(RunInfo, self).to_pod()
        d.update(copy(self.__dict__))
        d['uuid'] = str(self.uuid)
        if self.duration is None:
            d['duration'] = self.duration
        else:
            d['duration'] = self.duration.total_seconds()
        return d

    @staticmethod
    def _pod_upgrade_v1(pod):
        pod['_pod_version'] = pod.get('_pod_version', 1)
        return pod


class RunState(Podable):
    """
    Represents the state of a WA run.

    """
    _pod_serialization_version = 1

    @staticmethod
    def from_pod(pod):
        instance = super(RunState, RunState).from_pod(pod)
        instance.status = Status.from_pod(pod['status'])
        instance.timestamp = pod['timestamp']
        jss = [JobState.from_pod(j) for j in pod['jobs']]
        instance.jobs = OrderedDict(((js.id, js.iteration), js) for js in jss)
        return instance

    @property
    def num_completed_jobs(self):
        return sum(1 for js in self.jobs.values()
                   if js.status > Status.RUNNING)

    def __init__(self):
        super(RunState, self).__init__()
        self.jobs = OrderedDict()
        self.status = Status.NEW
        self.timestamp = datetime.utcnow()

    def add_job(self, job):
        job_state = JobState(job.id, job.label, job.iteration, job.status)
        self.jobs[(job_state.id, job_state.iteration)] = job_state

    def update_job(self, job):
        state = self.jobs[(job.id, job.iteration)]
        state.status = job.status
        state.timestamp = datetime.utcnow()

    def get_status_counts(self):
        counter = Counter()
        for job_state in self.jobs.values():
            counter[job_state.status] += 1
        return counter

    def to_pod(self):
        pod = super(RunState, self).to_pod()
        pod['status'] = self.status.to_pod()
        pod['timestamp'] = self.timestamp
        pod['jobs'] = [j.to_pod() for j in self.jobs.values()]
        return pod

    @staticmethod
    def _pod_upgrade_v1(pod):
        pod['_pod_version'] = pod.get('_pod_version', 1)
        pod['status'] = Status(pod['status']).to_pod()
        return pod


class JobState(Podable):

    _pod_serialization_version = 1

    @staticmethod
    def from_pod(pod):
        pod = JobState._upgrade_pod(pod)
        instance = JobState(pod['id'], pod['label'], pod['iteration'],
                            Status.from_pod(pod['status']))
        instance.retries = pod['retries']
        instance.timestamp = pod['timestamp']
        return instance

    @property
    def output_name(self):
        return '{}-{}-{}'.format(self.id, self.label, self.iteration)

    def __init__(self, id, label, iteration, status):
        # pylint: disable=redefined-builtin
        super(JobState, self).__init__()
        self.id = id
        self.label = label
        self.iteration = iteration
        self.status = status
        self.retries = 0
        self.timestamp = datetime.utcnow()

    def to_pod(self):
        pod = super(JobState, self).to_pod()
        pod['id'] = self.id
        pod['label'] = self.label
        pod['iteration'] = self.iteration
        pod['status'] = self.status.to_pod()
        pod['retries'] = 0
        pod['timestamp'] = self.timestamp
        return pod

    @staticmethod
    def _pod_upgrade_v1(pod):
        pod['_pod_version'] = pod.get('_pod_version', 1)
        pod['status'] = Status(pod['status']).to_pod()
        return pod