API logic - experiment state and state transition logic

[mjstealey]

Experiment states and transitions

Define the logic for how an experiment transitions between states as defined below

Endpoints:

• [x] /experiments/{int:pk}/state

Functions:

• [x] get current experiment state - by experiment_id as experiment member or as operator
• [x] update experiment state - by experiment_id as experiment member or as operator

Fields:

--- /experiments/{int:pk}/state
experiment_flags:    - string
experiment_id:       - int
experiment_state:    - string
experiment_uuid:     - string

Request body data (TODO: define these as needed for operation)

• emulation_passed - true or false
  • ACTIVE_EMULATION --> SAVED - emulation complete Flags 100 or 101 (see below)
• exit_development - true or false
  • ACTIVE_DEVELOPMENT --> SAVE_DEVELOPMENT - save vs. save & exit development session (see below)
• exit_sandbox - true or false
  • ACTIVE_SANDBOX --> SAVE_SANDBOX - save vs. save & exit sandbox session (see below)

Possible states

• ACTIVE_DEVELOPMENT
• ACTIVE_EMULATION
• ACTIVE_SANDBOX
• ACTIVE_TESTBED
• SAVING_DEVELOPMENT
• SAVING_SANDBOX
• SAVED (default - set when experiment is created)
• WAIT_DEVELOPMENT_DEPLOY
• WAIT_EMULATION_DEPLOY
• WAIT_EMULATION_SCHEDULE
• WAIT_SANDBOX_DEPLOY
• WAIT_TESTBED_DEPLOY
• WAIT_TESTBED_SCHEDULE

ETP Flags

• Binary triple denoting experiment state as ETP
  • E: Returned from Emulation (1 is true, 0 is false)
  • T: Returned from Testbed (1 is true, 0 is false)
  • P: Passed Emulation Run (1 is passed, 0 is failed)
• Valid Flag statuses as ETP
  • 000: Saved by experimenter
  • 100: Returned from emulation - did not pass
  • 101: Returned from emulation - passed
  • 010: Returned from testbed

Possible state transitions

ACTIVE_DEVELOPMENT

• ACTIVE_DEVELOPMENT --> SAVE_DEVELOPMENT - save development session - Flags 000 (e.g. experimenter logged out of all VMs for one hour)
• Examples:

# save and exit development session
data = {
  "exit_development": true,
  "next_state": "save_development"
}
# save and resume development session
data = {
  "exit_development": false,
  "next_state": "save_development"
}

ACTIVE_EMULATION

• ACTIVE_EMULATION --> SAVED - emulation complete - Flags 100 or 101
• Examples:

# set flags to 101
data = {
  "emulation_passed": true,
  "next_state": "saved"
}
# set flags to 100
data = {
  "emulation_passed": false,
  "next_state": "saved"
}

ACTIVE_SANDBOX

• ACTIVE_SANDBOX --> SAVE_SANDBOX - save sandbox session - Flags 000 (e.g. end of scheduled sandbox session)
• Examples:

# save and exit sandbox session
data = {
  "exit_sandbox": true,
  "next_state": "save_sandbox"
}
# save and resume sandbox session
data = {
  "exit_sandbox": false,
  "next_state": "save_sandbox"
}

ACTIVE_TESTBED

• ACTIVE_TESTBED --> SAVED - execution complete - Flags 010

SAVE_DEVELOPMENT

• SAVE_DEVELOPMENT --> SAVED - save development session - Flags 000 (e.g. experimenter logged out of all VMs for one hour)
• SAVE_DEVELOPMENT --> WAIT_DEVELOPMENT_DEPLOY - save development session and return to development

SAVE_SANDBOX

• SAVE_SANDBOX --> SAVED - save sandbox session - Flags 000 (e.g. end of scheduled sandbox session)
• SAVE_SANDBOX --> WAIT_SANDBOX_DEPLOY - save sandbox session and return to sandbox

SAVED

• SAVED --> WAIT_DEVELOPMENT_DEPLOY - start development session
• SAVED --> WAIT_SANDBOX_DEPLOY - schedule sandbox session
• SAVED --> WAIT_EMULATION_SCHEDULE - reqeust emulation session
• SAVED --> WAIT_TESTBED_SCHEDULE - request testbed session (allowed if (E&&P)|T

WAIT_DEVELOPMENT_DEPLOY

• WAIT_DEVELOPMENT_DEPLOY --> ACTIVE_DEVELOPMENT - deployment on development VMs complete
• WAIT_DEVELOPMENT_DEPLOY --> SAVED - failure to deploy

WAIT_EMULATION_DEPLOY

• WAIT_EMULATION_DEPLOY --> ACTIVE_EMULATION - scheduled deployment of emulation complete
• WAIT_EMULATION_DEPLOY --> SAVED - cancel

WAIT_EMULATION_SCHEDULE

• WAIT_EMULATION_SCHEDULE --> WAIT_EMULATION_DEPLOY - schedule
• WAIT_EMULATION_SCHEDULE --> SAVED - cancel pending emulation session

WAIT_SANDBOX_DEPLOY

• WAIT_SANDBOX_DEPLOY --> ACTIVE_SANDBOX - scheduled deployment on sandbox complete
• WAIT_SANDBOX_DEPLOY --> SAVED - cancel pending sandbox session

WAIT_TESTBED_DEPLOY

• WAIT_TESTBED_DEPLOY --> ACTIVE_TESTBED - scheduled deployment of testbed complete
• WAIT_TESTBED_DEPLOY --> SAVED - cancel

WAIT_TESTBED_SCHEDULE

• WAIT_TESTBED_SCHEDULE --> WAIT_TESTBED_DEPLOY - schedule
• WAIT_TESTBED_SCHEDULE --> SAVED - cancel pending testbed session

Transitioning between states

The following need to be defined for EVERY transition listed above

• PREFLIGHT CHECK: Preflight validation for requested state change / logic / data collection
• ACTION ITEMS: Transition action items (e.g. start/stop Session)
• UPDATE STATE: Update experiment state
• PORTAL CF: portal control framework decision points

[mjstealey]

Update experiment state and transition logic based on diagram