summaryrefslogtreecommitdiff
path: root/opendc-web/opendc-web-api/opendc/models/scenario.py
blob: 2911b1ae6f929e05a68d32ad23fe49df24482a4b (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
from marshmallow import Schema, fields
from opendc.models.model import Model
from opendc.models.portfolio import Portfolio


class SimulationSchema(Schema):
    """
    Simulation details.
    """
    state = fields.String()


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()
    portfolioId = fields.String()
    name = fields.String(required=True)
    simulation = fields.Nested(SimulationSchema)
    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)