Skip to content

Commit

Permalink
docs: add design diagram
Browse files Browse the repository at this point in the history
  • Loading branch information
ph-fritsche committed Dec 25, 2023
1 parent b275392 commit 553bf59
Showing 1 changed file with 54 additions and 0 deletions.
54 changes: 54 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,58 @@ const tester = await setupToolboxTester(

// Run the tests with each of the conductors and report combined results
await tester.start()
```

## Design

```mermaid
graph
FS[(FS)]
FsWatcher
Manager[TestRunManager]
Conductor[TestConductor]
Run(TestRunStack)
RunInstance(TestRunInstance)
Suite(TestSuite)
subgraph TargetEnv[Target environment]
Runner[TestRunner]
SetupFiles[(Setup module)]
TestSuiteFile[(Test suite file)]
Test([Test])
ReporterClient(TestReporterClient)
Imports[(Imported module)]
end
ReporterServer(TestReporterServer)
RunnerServer
FileServer
FileProvider
FileLoader
FsWatcher -- watch --> FS
FsWatcher -- report list of files --> mapToTestFile[[map to test suite files]] --> Manager
Manager -- create --> Run
Manager -- filter/exec --> Suite
Run --- RunInstance
RunInstance --- Conductor
RunInstance --- Suite
Suite -- delegate execution --> Conductor
Conductor -- launch target environment --> TargetEnv
Conductor ---- ReporterServer
Conductor -- load --> Runner
Conductor -- load --> SetupFiles
Conductor -- load --> TestSuiteFile
TestSuiteFile -- create --> Test
RunnerServer -- serves --> Runner
FileServer -- serves --> TestSuiteFile
FileServer -. serves .-> Imports
FileServer ---- FileProvider
FsWatcher -- invalidates --> FileProvider
FileProvider ---- FileLoader
FileLoader -- load and transform --> FS
TestSuiteFile -- import --> Imports
Runner -- execute --> Test
Runner -- report --> ReporterClient
ReporterClient -- report --> ReporterServer
ReporterServer -- report --> Suite
```

0 comments on commit 553bf59

Please sign in to comment.