API endpoint /sessions

[mjstealey]

/sessions

Endpoints

• [x] /sessions paginated
• [x] /sessions/{int:pk}

Functions

• [x] search - by experiment_id as operator
• [x] detail - by session_id as operator
• [x] create - by experiment workflow - event driven and not via the API, see experiment_sessions.py
• [x] update - by experiment workflow - event driven and not via the API, see experiment_sessions.py
• [x] delete - by experiment workflow - event driven and not via the API, see experiment_sessions.py

Fields

--- /sessions
end_date_time:       - string
ended_by:            - int
experiment_id:       - int
session_id:          - int
session_type:        - string
start_date_time:     - string
started_by:          - int
--- /sessions/{int:pk}
created_by           - string
end_date_time:       - string
ended_by:            - int
experiment_id:       - int
is_active            - bool
session_id:          - int
session_type:        - string
start_date_time:     - string
started_by:          - int

Notes

• Rows are created as immutable (other than ended_by and end_time which are NULL and then both populated at the same time (generally by an operator controlled action)
• All testbed (and emulation?) sessions currently created by an operator
• Sandbox sessions can be created by online tools as an experimenter
• Development sessions could be automated by the experimenter when they submit to the testbed via tools
• For any experiment there can only be 1 active execution session

Experiment states and sessions

Define the session create/activate, start, stop and deactivate criterea for each state transition

class SessionType(models.TextChoices):
    DEVELOPMENT = 'development', _('Development')
    EMULATION = 'emulation', _('Emulation')
    SANDBOX = 'sandbox', _('Sandbox')
    TESTBED = 'testbed', _('Testbed')

Possible states - session(s)

• ACTIVE_DEVELOPMENT - DEVELOPMENT start, started by, active=True
• ACTIVE_EMULATION - EMULATION start, started by, active=True
• ACTIVE_SANDBOX - SANDBOX start, started by, active=True
• ACTIVE_TESTBED - TESTBED start, started by, active=True
• SAVED - DEVELOPMENT, EMULATION, SANDBOX, TESTBED stop, stopped by, active=False
• WAIT_DEVELOPMENT_DEPLOY - DEVELOPMENT create, active=True
• WAIT_EMULATION_DEPLOY - EMULATION active=True
• WAIT_EMULATION_SCHEDULE - EMULATION create, active=True
• WAIT_SANDBOX_DEPLOY - SANDBOX create, active=True
• WAIT_TESTBED_DEPLOY - TESTBED active=True
• WAIT_TESTBED_SCHEDULE - TESTBED create, active=True

Possible state transitions

ACTIVE_DEVELOPMENT

• [x] ACTIVE_DEVELOPMENT --> SAVED - save development session - Flags 000 (e.g. experimenter logged out of all VMs for one hour)
  • Session: DEVELOPMENT - end_date_time, ended_by, active=False
• [x] ACTIVE_DEVELOPMENT --> ACTIVE_DEVELOPMENT - save development session but do not exit
  • Session: DEVELOPMENT - active=True

ACTIVE_EMULATION

• [x] ACTIVE_EMULATION --> SAVED - emulation complete - Flags 100 or 101
  • Session: EMULATION - end_date_time, ended_by, active=False

ACTIVE_SANDBOX

• [x] ACTIVE_SANDBOX --> SAVED - save sandbox session - Flags 000 (e.g. end of scheduled sandbox session)
  • Session: SANDBOX - end_date_time, ended_by, active=False
• [x] ACTIVE_SANDBOX --> ACTIVE_SANDBOX - save sandbox session but do not exit
  • Session: SANDBOX - active=True

ACTIVE_TESTBED

• [x] ACTIVE_TESTBED --> SAVED - execution complete - Flags 010
  • Session: TESTBED - end_date_time, ended_by, active=False

SAVED

• [x] SAVED --> WAIT_DEVELOPMENT_DEPLOY - start development session
  • Session: DEVELOPMENT - created, created_by
• [x] SAVED --> WAIT_SANDBOX_DEPLOY - schedule sandbox session
  • Session: SANDBOX - created, created_by
• [x] SAVED --> WAIT_EMULATION_SCHEDULE - reqeust emulation session
  • Session: EMULATION - created, created_by
• [x] SAVED --> WAIT_TESTBED_SCHEDULE - request testbed session (allowed if (E&&P)|T
  • Session: TESTBED - created, created_by

WAIT_DEVELOPMENT_DEPLOY

• [x] WAIT_DEVELOPMENT_DEPLOY --> ACTIVE_DEVELOPMENT - deployment on development VMs complete
  • Session: DEVELOPMENT - start_date_time, started_by
• [x] WAIT_DEVELOPMENT_DEPLOY --> SAVED - failure to deploy
  • Session: DEVELOPMENT - active=False

WAIT_EMULATION_DEPLOY

• [x] WAIT_EMULATION_DEPLOY --> ACTIVE_EMULATION - scheduled deployment of emulation complete
  • Session: EMULATION - start_date_time, started_by
• [x] WAIT_EMULATION_DEPLOY --> SAVED - cancel
  • Session: EMULATION - active=False

WAIT_EMULATION_SCHEDULE

• [x] WAIT_EMULATION_SCHEDULE --> WAIT_EMULATION_DEPLOY - schedule
  • Session: EMULATION - active=True
• [x] WAIT_EMULATION_SCHEDULE --> SAVED - cancel pending emulation session
  • Session: EMULATION - active=False

WAIT_SANDBOX_DEPLOY

• [x] WAIT_SANDBOX_DEPLOY --> ACTIVE_SANDBOX - scheduled deployment on sandbox complete
  • Session: SANDBOX - start_date_time, started_by
• [x] WAIT_SANDBOX_DEPLOY --> SAVED - cancel pending sandbox session
  • Session: SANDBOX - active=False

WAIT_TESTBED_DEPLOY

• [x] WAIT_TESTBED_DEPLOY --> ACTIVE_TESTBED - scheduled deployment of testbed complete
  • Session: TESTBED - start_date_time, started_by
• [x] WAIT_TESTBED_DEPLOY --> SAVED - cancel
  • Session: TESTBED - active=False

WAIT_TESTBED_SCHEDULE

• [x] WAIT_TESTBED_SCHEDULE --> WAIT_TESTBED_DEPLOY - schedule
  • Session: TESTBED - active=True
• [x] WAIT_TESTBED_SCHEDULE --> SAVED - cancel pending testbed session
  • Session: TESTBED - active=False