Merge branch 'main' into bump-go-ethereum

Author: Tofel

book/README.md

@@ -1,18 +1,16 @@
-# Chainlink Testing Framework Docs
-
-We use [mdBook](https://github.com/rust-lang/mdBook) for our docs. They can be found [here](https://smartcontractkit.github.io/chainlink-testing-framework/).
-
-## Development
-
-First [install Rust](https://doc.rust-lang.org/cargo/getting-started/installation.html), then [mdbook](https://github.com/rust-lang/mdBook).
-
-```sh
-# Install mdBook
+## MDBook
+Install [mdbook](https://github.com/rust-lang/mdBook)
+```
 cargo install mdbook && \
 cargo install mdbook-alerts && \
-cargo install mdbook-cmdrun
-# Run the mdBook
+cargo install mdbook-cmdrun &&
+cargo install mdbook-mermaid
+```
+
+Run it locally
+```
 make run
 ```
+Open your browser [here](http://localhost:9999/)
 
-Visit [localhost:9999](http://localhost:9999) to see your local version.
+GitHub hosted [version](https://smartcontractkit.github.io/chainlink-testing-framework/overview.html)

book/book.toml

@@ -10,6 +10,10 @@ build-dir = "docs"
 
 [output.html]
 default-theme = "ayu"
+additional-js = ["mermaid.min.js", "mermaid-init.js"]
 
 [preprocessor.alerts]
-[preprocessor.cmdrun]
+[preprocessor.cmdrun]
+
+[preprocessor.mermaid]
+command = "mdbook-mermaid"

book/mermaid-init.js

@@ -0,0 +1,35 @@
+(() => {
+    const darkThemes = ['ayu', 'navy', 'coal'];
+    const lightThemes = ['light', 'rust'];
+
+    const classList = document.getElementsByTagName('html')[0].classList;
+
+    let lastThemeWasLight = true;
+    for (const cssClass of classList) {
+        if (darkThemes.includes(cssClass)) {
+            lastThemeWasLight = false;
+            break;
+        }
+    }
+
+    const theme = lastThemeWasLight ? 'default' : 'dark';
+    mermaid.initialize({ startOnLoad: true, theme });
+
+    // Simplest way to make mermaid re-render the diagrams in the new theme is via refreshing the page
+
+    for (const darkTheme of darkThemes) {
+        document.getElementById(darkTheme).addEventListener('click', () => {
+            if (lastThemeWasLight) {
+                window.location.reload();
+            }
+        });
+    }
+
+    for (const lightTheme of lightThemes) {
+        document.getElementById(lightTheme).addEventListener('click', () => {
+            if (!lastThemeWasLight) {
+                window.location.reload();
+            }
+        });
+    }
+})();

book/mermaid.min.js

@@ -49,7 +49,33 @@
 - [Interactive](framework/interactive.md)
 - [Libraries](./libraries.md)
   - [Seth](./libs/seth.md)
-  - [WASP](./libs/wasp.md)
+  - [WASP](./libs/wasp/overview.md)
+    - [Getting started](./libs/wasp/getting_started.md)
+    - [First test (RPS test)](./libs/wasp/first_test.md)
+    - [Stateful test](./libs/wasp/stateful_test.md)
+    - [User Journey test](./libs/wasp/user_journey_test.md)
+    - [Profile test](./libs/wasp/profile_test.md)
+    - [Testing alerts]()
+    - [Configuration](./libs/wasp/configuration.md)
+    - [k8s](./libs/wasp/k8s.md)
+    - [Components](./libs/wasp/components/overview.md)
+      - [Alert Checker]()
+      - [Dashboard](./libs/wasp/components/dashboard.md)
+      - [Generator](./libs/wasp/components/generator.md)
+      - [Loki](./libs/wasp/components/loki.md)
+      - [Profile](./libs/wasp/components/profile.md)
+      - [Sampler](./libs/wasp/components/sampler.md)
+      - [Schedule](./libs/wasp/components/schedule.md)
+    - [How to](./libs/wasp/how-to/overview.md)
+      - [Start local observability stack](./libs/wasp/how-to/start_local_observability_stack.md)
+      - [Try it out quickly](./libs/wasp/how-to/run_included_tests.md)
+      - [Chose between RPS and VUs](./libs/wasp/how-to/chose_rps_vu.md)
+      - [Define NFRs and check alerts](./libs/wasp/how-to/define_nfr_check_alerts.md)
+      - [Use labels](./libs/wasp/how-to/use_labels.md)
+      - [Incorporate load tests in your workflow](./libs/wasp/how-to/incorporate_load_tests.md)
+      - [Reuse dashboard components](./libs/wasp/how-to/reuse_dashboard_components.md) 
+      - [Parallelize load](./libs/wasp/how-to/parallelise_load.md)
+      - [Debug Loki errors](./libs/wasp/how-to/debug_loki_errors.md)
   - [Havoc](./libs/havoc.md)
   - [K8s Test Runner](k8s-test-runner/k8s-test-runner.md)
 

book/src/SUMMARY.md

@@ -13,7 +13,7 @@ Here we provide full configuration reference, if you want to copy and run it, pl
 
   [cl_node.db]
     # PostgreSQL image version and tag
-    image = "postgres:15.6"
+    image = "postgres:12.0"
     # Pulls the image every time if set to 'true', used like that in CI. Can be set to 'false' to speed up local runs
     pull_image = false
 

book/src/framework/components/chainlink/node.md

@@ -55,7 +55,7 @@ Then configure NodeSet
 
   [nodeset.db]
     # PostgreSQL image version and tag
-    image = "postgres:15.6"
+    image = "postgres:12.0"
     # Pulls the image every time if set to 'true', used like that in CI. Can be set to 'false' to speed up local runs
     pull_image = false
     # PostgreSQL volume name

book/src/framework/components/chainlink/nodeset.md

@@ -47,7 +47,7 @@ You can also define a custom set of ports for any node
   override_mode = "each"
 
   [nodeset.db]
-    image = "postgres:15.6"
+    image = "postgres:12.0"
 
   [[nodeset.node_specs]]
 

book/src/framework/components/state.md

@@ -15,7 +15,7 @@ Create your configuration in `smoke.toml`
 [cl_node]
 
   [cl_node.db]
-    image = "postgres:15.6"
+    image = "postgres:12.0"
 
   [cl_node.node]
     image = "public.ecr.aws/chainlink/chainlink:v2.17.0"

book/src/framework/connecting_chainlink_node.md

@@ -28,7 +28,7 @@ Create a configuration file `smoke.toml`
   override_mode = "all"
 
   [nodeset.db]
-    image = "postgres:15.6"
+    image = "postgres:12.0"
 
   [[nodeset.node_specs]]