Library for executing a serialized event sequence
This is a simple library that can generate a described sequence of events to allow for testing of code response.
The library comes packaged with a few event types and the user can map additional actions and synchronizers for timeline to execute.
A timeline sequence is composed of events that are either synchornizers or actions. Synchronizers indicate timeline should synchornize the event flow with something such as an OS signal or a timer expiration. Actions simply call functions in your code base.
timeline:
- sync: SignalRecv
inputs:
signal: SIGUSR1
- action: NetworkBlock
block: true
inputs:
dest: 10.0.0.1/32
- sync: TimerWait
inputs:
duration: 30s
- action: NetworkAllow
block: false
inputs:
dest: 10.0.0.1/32 The above serialization indicates a timeline
that will wait until the executable receives
the SIGUSR1 signal and then execute
a function the user has mapped to NetworkBlock
passing the inputs object as a parameter. It will
block until that function returns and then the timeline
will wait idly for 30s before calling the function
for NetworkAllow.
Technically there is little difference between an action and a synchronizer. The serialization only differentiates them to reason about the intent of the timeline.
Synchronizers are functions that work to synchronize the timeline with external or environmental conditions.
Synchronize the timeline execution with OS signals that are sent to the rcon process. This could used to synchronize an external measurement or testing system with described changes made to the runtime context.
This is a basic timer to pause execution of the timeline for a static amount of time described as a Go ParseDuration format.
Actions are functions that can be used to change the runtime context. This could be to emulate failed network connectivity, change the contents of a file, or just have rcon log a message.