summaryrefslogtreecommitdiff
path: root/opendc-web/opendc-web-api/opendc/api/jobs.py
blob: 5feaea16e84f1d9a30c63f958adaa55eacf94fbd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
#  Copyright (c) 2021 AtLarge Research
#
#  Permission is hereby granted, free of charge, to any person obtaining a copy
#  of this software and associated documentation files (the "Software"), to deal
#  in the Software without restriction, including without limitation the rights
#  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
#  copies of the Software, and to permit persons to whom the Software is
#  furnished to do so, subject to the following conditions:
#
#  The above copyright notice and this permission notice shall be included in all
#  copies or substantial portions of the Software.
#
#  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
#  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
#  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
#  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
#  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
#  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
#  SOFTWARE.
from flask import request
from flask_restful import Resource
from marshmallow import fields, Schema, validate
from werkzeug.exceptions import BadRequest, Conflict

from opendc.exts import requires_auth
from opendc.models.scenario import Scenario


def convert_to_job(scenario):
    """Convert a scenario to a job.
    """
    return JobSchema().dump({
        '_id': scenario['_id'],
        'scenarioId': scenario['_id'],
        'state': scenario['simulation']['state'],
        'heartbeat': scenario['simulation'].get('heartbeat', None),
        'results': scenario.get('results', {})
    })


class JobSchema(Schema):
    """
    Schema representing a simulation job.
    """
    _id = fields.String(dump_only=True)
    scenarioId = fields.String(dump_only=True)
    state = fields.String(required=True,
                          validate=validate.OneOf(["QUEUED", "CLAIMED", "RUNNING", "FINISHED", "FAILED"]))
    heartbeat = fields.DateTime()
    results = fields.Dict()


class JobList(Resource):
    """
    Resource representing the list of available jobs.
    """
    method_decorators = [requires_auth]

    def get(self):
        """Get all available jobs."""
        jobs = Scenario.get_jobs()
        data = list(map(convert_to_job, jobs.obj))
        return {'data': data}


class Job(Resource):
    """
    Resource representing a single job.
    """
    method_decorators = [requires_auth]

    def get(self, job_id):
        """Get the details of a single job."""
        job = Scenario.from_id(job_id)
        job.check_exists()
        data = convert_to_job(job.obj)
        return {'data': data}

    def post(self, job_id):
        """Update the details of a single job."""
        action = JobSchema(only=('state', 'results')).load(request.json)

        job = Scenario.from_id(job_id)
        job.check_exists()

        old_state = job.obj['simulation']['state']
        new_state = action['state']

        if old_state == new_state:
            data = job.update_state(new_state)
        elif (old_state, new_state) == ('QUEUED', 'CLAIMED'):
            data = job.update_state('CLAIMED')
        elif (old_state, new_state) == ('CLAIMED', 'RUNNING'):
            data = job.update_state('RUNNING')
        elif (old_state, new_state) == ('RUNNING', 'FINISHED'):
            data = job.update_state('FINISHED', results=action.get('results', None))
        elif old_state in ('CLAIMED', 'RUNNING') and new_state == 'FAILED':
            data = job.update_state('FAILED')
        else:
            raise BadRequest('Invalid state transition')

        if not data:
            raise Conflict('State conflict')

        return {'data': convert_to_job(data)}