Merge branch 'main' into tt-1862-remove-logstream

Author: Tofel

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

@@ -10,6 +10,9 @@ jobs:
     env:
       LOKI_TENANT_ID: promtail
       LOKI_URL: http://localhost:3030/loki/api/v1/push
+      # this is not the best practice, and it must be fixed, run your tests WITHOUT IT!
+      # however, on current latest image we must use this flag
+      CTF_IGNORE_CRITICAL_LOGS: true
     runs-on: ubuntu-latest
     permissions:
       id-token: write

book/src/SUMMARY.md

@@ -10,8 +10,10 @@
     - [NodeSet with Capabilities](./framework/nodeset_capabilities.md)
     - [NodeSet (Local Docker builds)](./framework/nodeset_docker_rebuild.md)
     - [NodeSet Compat Environment](./framework/nodeset_compatibility.md)
+    - [Creating your own components](./developing/developing_components.md)
     - [Fork Testing](./framework/fork.md)
     - [Quick Contracts Deployment](./framework/quick_deployment.md)
+    - [Verifying Contracts](./framework/verify.md)
     - [NodeSet with External Blockchain]()
     - [CLI](./framework/cli.md)
     - [Configuration](./framework/configuration.md)
@@ -82,8 +84,6 @@
 
 ---
 
-- [Developing](developing.md)
-  - [Components](developing/developing_components.md)
 - [Releasing modules](releasing_modules.md)
 
 ---
@@ -92,6 +92,7 @@
     - [Kubernetes](lib/k8s/KUBERNETES.md)
     - [K8s Remote Run](lib/k8s/REMOTE_RUN.md)
     - [K8s Tutorial](lib/k8s/TUTORIAL.md)
+    - [k8s chain.link labels](lib/k8s/labels.md)
     - [Config](lib/config/config.md)
     - [CRIB Connector](lib/crib.md)
 ---

book/src/developing/developing_components.md

@@ -47,13 +47,13 @@ Each component can define inputs and outputs, following these rules:
 - If your component is used for side effects output can be omitted.
 - `input.Out.UseCache` should be added if you'd like to use caching, see more [here](caching)
 
-### Docker components good practices for [testcontainers-go](https://golang.testcontainers.org/):
+### Building Local Images
 
-An example [simple component](https://github.com/smartcontractkit/chainlink-testing-framework/blob/main/framework/components/blockchain/anvil.go)
+Use `framework.BuildImage` or `framework.BuildImageOnce` to build the docker image.
 
-An example of [complex component](https://github.com/smartcontractkit/chainlink-testing-framework/blob/main/framework/components/clnode/clnode.go)
+Do not use `testcontainers.NewDockerProvider()` methods, see issues: [#1](https://github.com/testcontainers/testcontainers-go/pull/2482), [#2](https://github.com/testcontainers/testcontainers-go/issues/1484)
 
-An example of [composite component](https://github.com/smartcontractkit/chainlink-testing-framework/blob/main/framework/components/simple_node_set/node_set.go)
+### Docker components good practices for [testcontainers-go](https://golang.testcontainers.org/):
 
 - Inputs should include at least `image`, `tag` and `pull_image` field
 ```golang
@@ -94,3 +94,10 @@ An example of [composite component](https://github.com/smartcontractkit/chainlin
 		HostURL:   fmt.Sprintf("http://%s:%s", host, mp.Port()),
 	}, nil
 ```
+
+An example [simple component](https://github.com/smartcontractkit/chainlink-testing-framework/blob/main/framework/components/blockchain/anvil.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](https://github.com/smartcontractkit/chainlink-testing-framework/blob/main/framework/components/simple_node_set/node_set.go)
+

book/src/framework/configuration.md

@@ -11,3 +11,5 @@
 |        LOKI_TENANT_ID        |                                                Streams all components logs to `Loki`, see params below                                                 |                 `string` |                     `promtail`                      |    🚫     |
 |       LOKI_BASIC_AUTH        |                                                          Basic auth in format $user:$password                                                          |        `$user:$password` |                          -                          |    🚫     |
 |         RESTY_DEBUG          |                                                            Log all Resty client HTTP calls                                                             |          `true`, `false` |                       `false`                       |    🚫     |
+|   CTF_IGNORE_CRITICAL_LOGS   |                                      Ignore all logs that has CRIT,FATAL or PANIC levels (Chainlink nodes only!)                                       |          `true`, `false` |                       `false`                       |    🚫     |
+|     CTF_CHAINLINK_IMAGE      |                                           Flag to override Chainlink Docker image in format $repository:$tag                                           |         $repository:$tag |                          -                          |    🚫     |

book/src/framework/nodeset_docker_rebuild.md

@@ -25,5 +25,7 @@ Create a configuration file `smoke.toml`
 
 These paths will work for `e2e/capabilities` in our main [repository](https://github.com/smartcontractkit/chainlink/tree/ctf-v2-tests/e2e/capabilities)
 
+Also check how you can add rebuild to your [components](../developing/developing_components.md#building-local-images).
+
 Summary:
 - We learned how we can quickly re-build local docker image for CL node

book/src/framework/observability/blockscout.md

@@ -25,9 +25,4 @@ ctf bs -r http://host.docker.internal:8555 d
 Blockscout isn’t ideal for local, ephemeral environments, as it won’t re-index blocks and transactions on test reruns. The easiest approach is to set up Blockscout first, initialize the test environment, switch to the [cache](../components/caching.md) config, and run tests without restarting RPC nodes. 
 
 Otherwise, use `ctf bs r` each time you restart your test with a fresh docker environment.
-</div>
-
-<div class="warning">
-
-Blockscout integration is still WIP, for now Blockscout reads only one node that is on `:8545`, all our blockchain implementation expose this port by default.
-</div>
+</div>

book/src/framework/verify.md

@@ -0,0 +1,16 @@
+# Verifying Contracts
+
+Check out our [example](https://github.com/smartcontractkit/chainlink-testing-framework/blob/main/framework/examples/myproject/verify_test.go) of programmatically verifying contracts using `Blockscout` and `Foundry`. You'll need to provide:
+
+- The path to your Foundry directory
+- The path to the contract
+- The contract name
+
+```golang
+		err := blockchain.VerifyContract(blockchainComponentOutput, c.Addresses[0].String(),
+			"example_components/onchain",
+			"src/Counter.sol",
+			"Counter",
+		)
+		require.NoError(t, err)
+```

book/src/lib/k8s/REMOTE_RUN.md

@@ -39,6 +39,9 @@ export TEST_ENV_VAR=myTestVarForAJob
 # your image to run as a k8s job
 ACCOUNT=$(aws sts get-caller-identity | jq -r .Account)
 export ENV_JOB_IMAGE="${ACCOUNT}.dkr.ecr.us-west-2.amazonaws.com/core-integration-tests:v1.1"
+export DETACH_RUNNER=true # if you want the test job to run in the background after it has started
+export CHAINLINK_ENV_USER=yourUser # user to run the tests
+export CHAINLINK_USER_TEAM=yourTeam # team to run the tests for
 # your example test file to run inside k8s
 # if ENV_JOB_IMAGE is present it will create a job, wait until it finished and get logs
 go run examples/remote-test-runner/env.go