Merge branch 'main' into ship-3979-remove-ws-validation

Author: davidcauchi

.github/workflows/docs.yml

@@ -18,7 +18,7 @@ jobs:
           fetch-depth: 0  # Fetch all history for all tags
 
       - name: Setup mdBook
-        uses: peaceiris/actions-mdbook@v1
+        uses: peaceiris/actions-mdbook@v2
         with:
           mdbook-version: '0.4.40'
 
@@ -33,7 +33,7 @@ jobs:
           mdbook build
 
       - name: Deploy to GitHub Pages
-        uses: peaceiris/actions-gh-pages@v3
+        uses: peaceiris/actions-gh-pages@v4
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_dir: book

.github/workflows/framework-golden-tests.yml

@@ -1,9 +1,6 @@
 name: Framework Golden Tests Examples
 on:
   push:
-concurrency:
-  group: ${{ github.workflow }}-${{ github.ref }}-framework-golden-examples
-  cancel-in-progress: true
 
 jobs:
   test:
@@ -18,20 +15,30 @@ jobs:
       id-token: write
       contents: read
     strategy:
+      fail-fast: false
       matrix:
         test:
           - name: TestSmoke
             config: smoke.toml
             count: 1
             timeout: 10m
-          - name: TestLoad
-            config: load.toml
+          - name: TestUpgrade
+            config: upgrade.toml
+            count: 1
+            timeout: 10m
+          - name: TestPerformanceBaseline
+            config: performance_baseline.toml
             count: 1
             timeout: 10m
           - name: TestChaos
             config: chaos.toml
             count: 1
             timeout: 10m
+          - name: TestScalability
+            config: scalability.toml
+            count: 1
+            timeout: 10m
+    name: ${{ matrix.test.name }}
     steps:
       - name: Checkout repo
         uses: actions/checkout@0ad4b8fadaa221de15dcec353f45205ec38ea70b # v4.1.4
@@ -62,9 +69,10 @@ jobs:
           path: |
             ~/.cache/go-build
             ~/go/pkg/mod
-          key: go-modules-${{ hashFiles('**/go.sum') }}-${{ runner.os }}-framework-golden-examples
+          key: go-modules-${{ hashFiles('framework/examples/myproject/go.sum') }}-${{ runner.os }}-framework-golden-examples
           restore-keys: |
-            go-modules-${{ hashFiles('**/go.sum') }}-${{ runner.os }}-framework-golden-examples
+            go-modules-${{ runner.os }}-framework-golden-examples
+            go-modules-${{ runner.os }}
       - name: Install dependencies
         run: go mod download
       - name: Run Docker Component Tests

.github/workflows/framework.yml

@@ -38,7 +38,7 @@ jobs:
         with:
           go-version: 1.22.8
       - name: Cache Go modules
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: |
             ~/.cache/go-build

.github/workflows/modgraph.yaml

@@ -0,0 +1,15 @@
+name: Module graph
+on:
+  pull_request:
+jobs:
+  modgraph:
+    runs-on: ubuntu-latest
+    name: modgraph
+    steps:
+      - name: Checkout the Repo
+        uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4.2.1
+      - name: Setup Go
+        uses: actions/setup-go@v5
+      - run: make modgraph
+      - name: Ensure clean modgraph
+        run: git diff --minimal --exit-code

.gitignore

@@ -46,9 +46,7 @@ suite/remote_runner_config.yaml
 *.csv
 
 # docs
-docs/_site/
-docs/.sass-cache/
-docs/Gemfile.lock
+book/docs/
 
 dist/
 
@@ -78,4 +76,4 @@ __debug*
 .tool-versions
 
 import_keys_test.go
-tag.py
+tag.py

.nancy-ignore

@@ -11,3 +11,5 @@ CVE-2023-48795 # Improper Validation of Integrity Check Value x/crypto, which is
 CVE-2024-24786 # CWE-835 Loop with Unreachable Exit Condition ('Infinite Loop') in indirect dependency
 CVE-2024-32972 # CWE-400: Uncontrolled Resource Consumption ('Resource Exhaustion') [still not fixed, not even in v1.13.8]
 CVE-2023-42319 # CWE-noinfo: lol... go-ethereum v1.13.8 again
+CVE-2024-10086 # Improper Neutralization of Input During Web Page Generation ('Cross-site Scripting')
+CVE-2024-51744 # CWE-755: Improper Handling of Exceptional Conditions

CONTRIBUTING.md

@@ -0,0 +1,5 @@
+.PHONY: modgraph
+modgraph:
+	go install github.com/jmank88/[email protected]
+	go install github.com/jmank88/[email protected]
+	./modgraph > go.md

Makefile

@@ -1,15 +1,18 @@
-## MDBook
-Install [mdbook](https://github.com/rust-lang/mdBook)
-```
+# 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
 cargo install mdbook && \
 cargo install mdbook-alerts && \
 cargo install mdbook-cmdrun
-```
-
-Run it locally
-```
+# Run the mdBook
 make run
 ```
-Open your browser [here](http://localhost:9999/)
 
-GitHub hosted [version](https://smartcontractkit.github.io/chainlink-testing-framework/overview.html)
+Visit [localhost:9999](http://localhost:9999) to see your local version.

book/README.md

@@ -14,7 +14,10 @@
     - [CLI](./framework/cli.md)
     - [Configuration](./framework/configuration.md)
     - [Test Configuration](./framework/test_configuration_overrides.md)
-    - [Caching](framework/components/caching.md)
+    - [Components Persistence](framework/components/state.md)
+    - [Components Cleanup](framework/components/cleanup.md)
+    - [Components Caching](framework/components/caching.md)
+    - [External Environment](framework/components/external.md)
     - [Secrets]()
     - [Observability Stack](framework/observability/observability_stack.md)
       - [Metrics](framework/observability/metrics.md)
@@ -36,12 +39,11 @@
       - [Chainlink]()
       - [RPC]()
       - [Loki]()
-- [Testing]()
+- [Testing Maturity Model](framework/testing.md)
   - [Smoke]()
   - [Performance]()
   - [Chaos]()
 - [Interactive](framework/interactive.md)
-- [Continuous Integration](ci/ci.md)
 - [Libraries](./libraries.md)
   - [Seth](./libs/seth.md)
   - [WASP](./libs/wasp.md)