summaryrefslogtreecommitdiff
path: root/opendc-web/opendc-web-api/opendc/models/scenario.py
blob: 0fb6c453aef0c4e743c47f184fb72f575bde9410 (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
from datetime import datetime

from marshmallow import Schema, fields

from opendc.exts import db
from opendc.models.model import Model
from opendc.models.portfolio import Portfolio


class TraceSchema(Schema):
    """
    Schema for specifying the trace of a scenario.
    """
    traceId = fields.String()
    loadSamplingFraction = fields.Float()


class TopologySchema(Schema):
    """
    Schema for topology specification for a scenario.
    """
    topologyId = fields.String()


class OperationalSchema(Schema):
    """
    Schema for the operational phenomena for a scenario.
    """
    failuresEnabled = fields.Boolean()
    performanceInterferenceEnabled = fields.Boolean()
    schedulerName = fields.String()


class ScenarioSchema(Schema):
    """
    Schema representing a scenario.
    """
    _id = fields.String(dump_only=True)
    portfolioId = fields.String()
    name = fields.String(required=True)
    trace = fields.Nested(TraceSchema)
    topology = fields.Nested(TopologySchema)
    operational = fields.Nested(OperationalSchema)


class Scenario(Model):
    """Model representing a Scenario."""

    collection_name = 'scenarios'

    def check_user_access(self, user_id, edit_access):
        """Raises an error if the user with given [user_id] has insufficient access.

        Checks access on the parent project.

        :param user_id: The User ID of the user.
        :param edit_access: True when edit access should be checked, otherwise view access.
        """
        portfolio = Portfolio.from_id(self.obj['portfolioId'])
        portfolio.check_user_access(user_id, edit_access)

    @classmethod
    def get_jobs(cls):
        """Obtain the scenarios that have been queued.
        """
        return cls(db.fetch_all({'simulation.state': 'QUEUED'}, cls.collection_name))

    def update_state(self, new_state, results=None):
        """Atomically update the state of the Scenario.
        """
        update = {'$set': {'simulation.state': new_state, 'simulation.heartbeat': datetime.now()}}
        if results:
            update['$set']['results'] = results
        return db.fetch_and_update(
            query={'_id': self.obj['_id'], 'simulation.state': self.obj['simulation']['state']},
            update=update,
            collection=self.collection_name
        )