finalize

Author: skudasov

book/src/SUMMARY.md

@@ -14,6 +14,7 @@
     - [CLI](./framework/cli.md)
     - [Configuration](./framework/configuration.md)
     - [Test Configuration](./framework/test_configuration_overrides.md)
+    - [Caching](framework/components/caching.md)
     - [Secrets]()
     - [Observability Stack](framework/observability/observability_stack.md)
       - [Metrics]()

book/src/developing/developing_components.md

@@ -49,11 +49,11 @@ Each component can define inputs and outputs, following these rules:
 
 ### Docker components good practices for [testcontainers-go](https://golang.testcontainers.org/):
 
-An example [simple component](../../../../framework/components/blockchain/anvil.go)
+An example [simple component](https://github.com/smartcontractkit/chainlink-testing-framework/blob/main/framework/components/blockchain/anvil.go)
 
-An example of [complex component](../../../../framework/components/clnode/clnode.go)
+An example of [complex component](https://github.com/smartcontractkit/chainlink-testing-framework/blob/main/framework/components/clnode/clnode.go)
 
-An example of [composite component](../../../../framework/components/simple_node_set/node_set.go)
+An example of [composite component](https://github.com/smartcontractkit/chainlink-testing-framework/blob/main/framework/components/simple_node_set/node_set.go)
 
 - Inputs should include at least `image`, `tag` and `pull_image` field
 ```golang

book/src/framework/components/caching.md

@@ -2,9 +2,9 @@
 
 We use component caching to accelerate test development and enforce idempotent test actions.
 
-Each component is designed to be pure with defined inputs/outputs.
+Each component is isolated by means of inputs and outputs.
 
-You can use an environment variable to skip deployment steps and use cached outputs if your infrastructure is already running (locally or remotely):
+If cached config has any outputs with `use_cache = true` it will be used instead of deploying a component again.
 
 ```
 export CTF_CONFIGS=smoke-cache.toml
@@ -26,4 +26,4 @@ http_url = 'http://127.0.0.1:33447'
 docker_internal_ws_url = 'ws://anvil-3716a:8900'
 docker_internal_http_url = 'http://anvil-3716a:8900'
 ```
-Set flag `use_cache = true` on any component output and run your test again
+Set flag `use_cache = true` on any component output, change output fields as needed and run your test again.

book/src/framework/getting_started.md

@@ -6,6 +6,7 @@ go get github.com/smartcontractkit/chainlink-testing-framework/framework
 ```
 
 Then download the CLI (runs from directory where you have `go.mod`)
+Make sure you have your GOPATH set: `export GOPATH=$HOME/go && export PATH=$PATH:$GOPATH/bin`
 ```
 go get github.com/smartcontractkit/chainlink-testing-framework/framework/cmd && \
 go install github.com/smartcontractkit/chainlink-testing-framework/framework/cmd && \

book/src/framework/nodeset_capabilities.md

@@ -16,8 +16,6 @@ Create a configuration file `smoke.toml`
   port = "8545"
   type = "anvil"
 
-[contracts]
-
 [data_provider]
   port = 9111
 

book/src/framework/nodeset_compatibility.md

@@ -85,13 +85,9 @@ package capabilities_test
 import (
 	"fmt"
 	"github.com/smartcontractkit/chainlink-testing-framework/framework"
-	"github.com/smartcontractkit/chainlink-testing-framework/framework/clclient"
 	"github.com/smartcontractkit/chainlink-testing-framework/framework/components/blockchain"
 	"github.com/smartcontractkit/chainlink-testing-framework/framework/components/fake"
 	ns "github.com/smartcontractkit/chainlink-testing-framework/framework/components/simple_node_set"
-	"github.com/smartcontractkit/chainlink-testing-framework/seth"
-	burn_mint_erc677 "github.com/smartcontractkit/chainlink/e2e/capabilities/components/gethwrappers"
-	"github.com/smartcontractkit/chainlink/e2e/capabilities/components/onchain"
 	"github.com/stretchr/testify/require"
 	"os"
 	"testing"

book/src/framework/nodeset_environment.md

@@ -38,7 +38,6 @@ import (
 	"github.com/smartcontractkit/chainlink-testing-framework/framework/components/blockchain"
 	"github.com/smartcontractkit/chainlink-testing-framework/framework/components/fake"
 	ns "github.com/smartcontractkit/chainlink-testing-framework/framework/components/simple_node_set"
-	"github.com/smartcontractkit/chainlink/e2e/capabilities/components/onchain"
 	"github.com/stretchr/testify/require"
 	"testing"
 )

book/src/framework/test_configuration_overrides.md

@@ -4,8 +4,28 @@ To override any test configuration, we merge multiple files into a single struct
 
 You can specify multiple file paths using `CTF_CONFIGS=path1,path2,path3`.
 
-The framework will apply these configurations from right to left.
+The framework will apply these configurations from right to left and marshal them to a single test config structure.
 
-> [!NOTE]  
-> When override slices remember that you should replace the full slice, it won't be extended by default!
+Use it to structure the variations of your test, ex.:
+```
+export CTF_CONFIGS=smoke-test-feature-a-simulated-network.toml
+export CTF_CONFIGS=smoke-test-feature-a-simulated-network.toml,smoke-test-feature-a-testnet.toml
+
+export CTF_CONFIGS=smoke-test-feature-a.toml
+export CTF_CONFIGS=smoke-test-feature-a.toml,smoke-test-feature-b.toml
+
+export CTF_CONFIGS=load-profile-api-service-1.toml
+export CTF_CONFIGS=load-profile-api-service-1.toml,load-profile-api-service-2.toml
+```
 
+This helps reduce duplication in the configuration.
+
+> [!NOTE]
+> We designed overrides to be as simple as possible, as frameworks like [envconfig](https://github.com/kelseyhightower/envconfig) and [viper](https://github.com/spf13/viper) offer extensive flexibility but can lead to inconsistent configurations prone to drift.
+> 
+> This feature is meant to override test setup configurations, not test logic. Avoid using TOML to alter test logic.
+> 
+> Tests should remain straightforward, readable, and perform a single set of actions (potentially across different CI/CD environments). If variations in test logic are required, consider splitting them into separate tests.
+
+> [!WARNING]  
+> When override slices remember that you should replace the full slice, it won't be extended by default!

book/src/lib/crib.md

@@ -2,6 +2,6 @@
 
 <div class="warning">
 
-`GAPv1` won't be supported, so you can use [this example](https://github.com/smartcontractkit/chainlink/tree/develop/integration-tests/crib), [CI run](https://github.com/smartcontractkit/chainlink/actions/workflows/crib-integration-test.yml)
+`GAPv1` won't be supported in the future, you can still use [this example](https://github.com/smartcontractkit/chainlink/tree/develop/integration-tests/crib), [CI run](https://github.com/smartcontractkit/chainlink/actions/workflows/crib-integration-test.yml) but expect this to be changed.
 
 </div>

framework/README.md

@@ -1,31 +1,5 @@
-## Chainlink Testing Framework Harness
+# Framework
 
-<!-- TOC -->
-* [CLI](./cmd/README.md)
-* [Components](./COMPONENTS.md)
-* [Configuration](./CONFIGURATION.md)
-* [Caching](./CACHING.md)
-* [Local Observability Stack](./cmd/observability/README.md)
-* [Examples](https://github.com/smartcontractkit/chainlink/tree/8e8597aa14c39c48ed4b3261f6080fa43b5d7cd0/e2e/capabilities)
-<!-- TOC -->
+Modular and data-driven harness for Chainlink on-chain and off-chain components.
 
-This module includes the CTFv2 harness, a lightweight, modular, and data-driven framework designed for combining off-chain and on-chain components while implementing best practices for end-to-end system-level testing:
-
-- **Non-nil configuration**: All test variables must have defaults, automatic validation.
-- **Component isolation**: Components are decoupled via input/output structs, without exposing internal details.
-- **Modular configuration**: No arcane knowledge of framework settings is required; the config is simply a reflection of the components being used in the test. Components declare their own configuration—'what you see is what you get.'
-- **Replaceability and extensibility**: Since components are decoupled via outputs, any deployment component can be swapped with a real service without altering the test code.
-- **Caching**: any component can use cached configs to skip environment setup for faster test development
-- **Integrated observability stack**: use `ctf obs up` to spin up a local observability stack.
-
-
-### Environment variables (Tests, when using in Go code)
-|             Name             |                                                                      Description                                                                       |          Possible values | Default |        Required?         |
-|:----------------------------:|:------------------------------------------------------------------------------------------------------------------------------------------------------:|-------------------------:|:-------:|:------------------------:|
-|         CTF_CONFIGS          | Path(s) to test config files. <br/>Can be more than one, ex.: smoke.toml,smoke_1.toml,smoke_2.toml.<br/>First filepath will hold all the merged values | Any valid TOML file path |         |            ✅             |
-|        CTF_LOG_LEVEL         |                                                                   Harness log level                                                                    | `info`, `debug`, `trace` | `info`  |            🚫            |
-|       CTF_LOKI_STREAM        |                                                Streams all components logs to `Loki`, see params below                                                 |          `true`, `false` | `false` |            🚫            |
-|           LOKI_URL           |                                            URL to `Loki` push api, should be like`${host}/loki/api/v1/push`                                            |                      URL |    -    | If you use `Loki` then ✅ |
-|        LOKI_TENANT_ID        |                                                Streams all components logs to `Loki`, see params below                                                 |          `true`, `false` |    -    | If you use `Loki` then ✅ |
-| TESTCONTAINERS_RYUK_DISABLED |                                   Testcontainers-Go reaper container, removes all the containers after the test exit                                   |          `true`, `false` | `false` |            🚫            |
-|         RESTY_DEBUG          |                                                            Log all Resty client HTTP calls                                                             |          `true`, `false` | `false` |            🚫            |
+[![Documentation](https://img.shields.io/badge/Documentation-MDBook-blue?style=for-the-badge)](http://localhost:9999/framework/overview.html)