diff --git a/docs/README.md b/docs/README.md index b8e83d4..f2aff0b 100644 --- a/docs/README.md +++ b/docs/README.md @@ -3,18 +3,12 @@ Welcome to the Smart Socket Service, your one-stop shop for controlling and monitoring smart sockets. This service is like a remote control for your smart sockets, but with superpowers! ๐Ÿ’ช This documentation also has a [github page](https://ylkhayat.github.io/smart-socket-service/), maybe check it out for better visualization when it comes to testsets. -## Usage Scenario - -One scenario for the usage of the smart-socket service is illustrated in the following diagram: - -![Process Diagram](docs/process-scenario-a.svg) - -### Testsets +### Usage Scenario & Testsets This project contains testsets for various scenarios. Jump in there to check them out! +We have two test sets, but you can be more adventurous! -- [Parallel Start Wait Stop](testsets/parallel-start-wait-stop/README.md) -- [Start Wait Stop](testsets/start-wait-stop/README.md) +Navigate to [testsets](./testsets/) so we can discover them further! ## ๐ŸŒ API Endpoints diff --git a/docs/testsets/README.md b/docs/testsets/README.md deleted file mode 100644 index bf5d4f0..0000000 --- a/docs/testsets/README.md +++ /dev/null @@ -1,10 +0,0 @@ -# ๐Ÿงช Testsets - -This directory contains all the testsets for this project. Each testset has its own directory, and each run of a testset has its own subdirectory within the testset's directory. - -## ๐Ÿ“‚ Directories - -- [Parallel Start Wait Stop](./parallel-start-wait-stop/README.md) -- [Start Wait Stop](./start-wait-stop/README.md) - -Please navigate to the specific run directory to view all the HTML reports for that run. diff --git a/docs/testsets/parallel-start-wait-stop/README.md b/docs/testsets/parallel-subprocesses/README.md similarity index 56% rename from docs/testsets/parallel-start-wait-stop/README.md rename to docs/testsets/parallel-subprocesses/README.md index 637d4a7..9e1444c 100644 --- a/docs/testsets/parallel-start-wait-stop/README.md +++ b/docs/testsets/parallel-subprocesses/README.md @@ -1,6 +1,10 @@ -# ๐Ÿงช Parallel Start Wait Stop Testset +# ๐Ÿงช Parallel Subprocesses Testset -This directory contains all the runs for the Parallel Start Wait Stop testset. +This directory contains all the runs for the Parallel Subprocesses testset. + +This process uses instances of the previously defined `Start Wait Stop` testset! + +![Process Diagram](./parallel-subprocesses.svg) ## ๐Ÿ“Š HTML Reports diff --git a/docs/testsets/parallel-subprocesses/parallel-subprocesses.svg b/docs/testsets/parallel-subprocesses/parallel-subprocesses.svg new file mode 100644 index 0000000..3409669 --- /dev/null +++ b/docs/testsets/parallel-subprocesses/parallel-subprocesses.svg @@ -0,0 +1,478 @@ + START + + + + +s + + + +s + + + + +struetrue \ No newline at end of file diff --git a/docs/testsets/parallel-start-wait-stop/parallel-start-wait-stop.xml b/docs/testsets/parallel-subprocesses/parallel-subprocesses.xml similarity index 100% rename from docs/testsets/parallel-start-wait-stop/parallel-start-wait-stop.xml rename to docs/testsets/parallel-subprocesses/parallel-subprocesses.xml diff --git a/docs/testsets/parallel-start-wait-stop/run-1/energy-monitor.html b/docs/testsets/parallel-subprocesses/run-1/energy-monitor.html similarity index 100% rename from docs/testsets/parallel-start-wait-stop/run-1/energy-monitor.html rename to docs/testsets/parallel-subprocesses/run-1/energy-monitor.html diff --git a/docs/testsets/parallel-start-wait-stop/run-1/server-monitor.html b/docs/testsets/parallel-subprocesses/run-1/server-monitor.html similarity index 100% rename from docs/testsets/parallel-start-wait-stop/run-1/server-monitor.html rename to docs/testsets/parallel-subprocesses/run-1/server-monitor.html diff --git a/docs/testsets/parallel-start-wait-stop/run-2/energy-monitor.html b/docs/testsets/parallel-subprocesses/run-2/energy-monitor.html similarity index 100% rename from docs/testsets/parallel-start-wait-stop/run-2/energy-monitor.html rename to docs/testsets/parallel-subprocesses/run-2/energy-monitor.html diff --git a/docs/testsets/parallel-start-wait-stop/run-2/server-monitor.html b/docs/testsets/parallel-subprocesses/run-2/server-monitor.html similarity index 100% rename from docs/testsets/parallel-start-wait-stop/run-2/server-monitor.html rename to docs/testsets/parallel-subprocesses/run-2/server-monitor.html diff --git a/docs/testsets/parallel-start-wait-stop/run-3/energy-monitor.html b/docs/testsets/parallel-subprocesses/run-3/energy-monitor.html similarity index 100% rename from docs/testsets/parallel-start-wait-stop/run-3/energy-monitor.html rename to docs/testsets/parallel-subprocesses/run-3/energy-monitor.html diff --git a/docs/testsets/parallel-start-wait-stop/run-3/server-monitor.html b/docs/testsets/parallel-subprocesses/run-3/server-monitor.html similarity index 100% rename from docs/testsets/parallel-start-wait-stop/run-3/server-monitor.html rename to docs/testsets/parallel-subprocesses/run-3/server-monitor.html diff --git a/docs/testsets/parallel-start-wait-stop/run-4/energy-monitor.html b/docs/testsets/parallel-subprocesses/run-4/energy-monitor.html similarity index 100% rename from docs/testsets/parallel-start-wait-stop/run-4/energy-monitor.html rename to docs/testsets/parallel-subprocesses/run-4/energy-monitor.html diff --git a/docs/testsets/parallel-start-wait-stop/run-4/server-monitor.html b/docs/testsets/parallel-subprocesses/run-4/server-monitor.html similarity index 100% rename from docs/testsets/parallel-start-wait-stop/run-4/server-monitor.html rename to docs/testsets/parallel-subprocesses/run-4/server-monitor.html diff --git a/docs/testsets/start-wait-stop/README.md b/docs/testsets/start-wait-stop/README.md index bbe65fc..0b5282c 100644 --- a/docs/testsets/start-wait-stop/README.md +++ b/docs/testsets/start-wait-stop/README.md @@ -2,6 +2,8 @@ This directory contains all the runs for the Start Wait Stop testset. +![Process Diagram](start-wait-stop.svg) + ## ๐Ÿ“Š HTML Reports Each run generates an HTML report. Here are the reports: diff --git a/docs/process-scenario-a.svg b/docs/testsets/start-wait-stop/start-wait-stop.svg similarity index 100% rename from docs/process-scenario-a.svg rename to docs/testsets/start-wait-stop/start-wait-stop.svg