Skip to content

Commit dd648ec

Browse files
committed
Update documentation to provide examples for custom script execution through VC.
1 parent 66831fa commit dd648ec

4 files changed

Lines changed: 190 additions & 471 deletions

File tree

website/docs/guides/0011-profiles.md

Lines changed: 119 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -668,3 +668,122 @@ sequential order as they are defined within the profile. These components begin
668668
-----------> Action 2
669669
-----------> Action 3
670670
-----------> Action 4
671+
```
672+
673+
## Parallel and Sequential Execution Options
674+
Virtual Client supports a few different components that can be used to execute groups of child components in parallel or in sequence as a block.
675+
The following section illustrates usage examples for these components.
676+
677+
### ParallelExecution
678+
Executes all child components **in parallel**. Each component starts at the same time and runs independently.
679+
The `ParallelExecution` component will complete when all components have finished exactly one iteration.
680+
681+
``` json
682+
{
683+
"Type": "ParallelExecution",
684+
"Components": [
685+
{
686+
"Type": "TestExecutor",
687+
"Parameters": {
688+
"Scenario": "ScenarioA"
689+
}
690+
},
691+
{
692+
"Type": "TestExecutor",
693+
"Parameters": {
694+
"Scenario": "ScenarioB"
695+
}
696+
}
697+
]
698+
}
699+
```
700+
701+
### SequentialExecution
702+
Executes all child components **one after another** in the order they are listed. Each component starts only after the previous one
703+
completes. The The `SequentialExecution` component will complete when all components have finished exactly one iteration.
704+
705+
#### Supported Parameters
706+
707+
| Parameter | Purpose | Default Value |
708+
|---------------|----------------------------------------------|---------------|
709+
| Deterministic | Defines true/false whether the sequential execution should be deterministic. When set to true, each component will be executed at least once regardless of any individual component failures. When set to false, the components will execute sequentially until any one fails. No subsequent components will be executed after the failure. | false |
710+
| LoopCount | Specifies the number of times to repeat the execution of each child component under the sequential execution | 1 |
711+
712+
```json
713+
{
714+
"Type": "SequentialExecution",
715+
"Parameters": {
716+
"LoopCount": 2
717+
},
718+
"Components": [
719+
{
720+
"Type": "TestExecutor1",
721+
"Parameters": {
722+
"Scenario": "ScenarioA"
723+
}
724+
},
725+
{
726+
"Type": "TestExecutor2",
727+
"Parameters": {
728+
"Scenario": "ScenarioB"
729+
}
730+
}
731+
]
732+
},
733+
{
734+
"Type": "SequentialExecution",
735+
"Parameters": {
736+
"Deterministic": true
737+
},
738+
"Components": [
739+
{
740+
"Type": "TestExecutor3",
741+
"Parameters": {
742+
"Scenario": "ScenarioA"
743+
}
744+
},
745+
{
746+
"Type": "TestExecutor4",
747+
"Parameters": {
748+
"Scenario": "ScenarioB"
749+
}
750+
}
751+
]
752+
}
753+
```
754+
755+
### ParallelLoopExecution
756+
Executes all child components **in parallel**, and **repeats** this execution for a specified duration or minimum number of
757+
iterations. Each component runs in its own loop, independently, until the overall duration or the minimum iteration count is
758+
reached.
759+
760+
#### Supported Parameters
761+
762+
| Parameter | Purpose | Default Value |
763+
|--------------------|-------------------------------------------------------------|---------------|
764+
| Duration | Maximum time to run the parallel loop (hh:mm:ss format). | -1 (no limit) |
765+
| MinimumIterations | Minimum number of times each child component should run. Set this value to 1 to ensure each component executes to completion at least once. | 0 |
766+
767+
```json
768+
{
769+
"Type": "ParallelLoopExecution",
770+
"Parameters": {
771+
"Duration": "00:10:00",
772+
"MinimumIterations": 3
773+
},
774+
"Components": [
775+
{
776+
"Type": "TestExecutor1",
777+
"Parameters": {
778+
"Scenario": "ScenarioA"
779+
}
780+
},
781+
{
782+
"Type": "TestExecutor2",
783+
"Parameters": {
784+
"Scenario": "ScenarioB"
785+
}
786+
}
787+
]
788+
}
789+
```

website/docs/guides/0012-custom-execution-order.md

Lines changed: 0 additions & 121 deletions
This file was deleted.

0 commit comments

Comments
 (0)