Merge branch 'main' into tt-1806-required-labels

Author: Tofel

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

@@ -59,6 +59,7 @@ jobs:
           filters: |
             src:
               - 'framework/**'
+              - '.github/workflows/framework-golden-tests.yml'
       - name: Set up Go
         uses: actions/setup-go@v4
         with:
@@ -81,3 +82,10 @@ jobs:
           CTF_CONFIGS: ${{ matrix.test.config }}
         run: |
           go test -timeout ${{ matrix.test.timeout }} -v -count ${{ matrix.test.count }} -run ${{ matrix.test.name }}
+      - name: Upload Logs
+        if: always()
+        uses: actions/upload-artifact@v3
+        with:
+          name: container-logs-${{ matrix.test.name }}
+          path: framework/examples/myproject/logs
+          retention-days: 1

.github/workflows/k8s-e2e.yaml

@@ -1,6 +1,7 @@
 name: (k8s package) E2E tests
-on:
-  pull_request:
+# disabling for now, as they always fail
+#on:
+#  pull_request:
 
 concurrency:
   group: e2e-tests-k8s-${{ github.ref }}

.github/workflows/wasp-test-e2e.yml

@@ -1,5 +1,7 @@
 name: WASP E2E tests
-on: [push]
+# disabling for now, as they always fail
+#on:
+#  push:
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
   cancel-in-progress: true

.tool-versions

@@ -1,4 +1,4 @@
-golang 1.22.3
+golang 1.23.3
 nodejs 18.20.3
 k3d 5.6.3
 act 0.2.52

book/src/SUMMARY.md

@@ -11,11 +11,13 @@
     - [NodeSet (Local Docker builds)](./framework/nodeset_docker_rebuild.md)
     - [NodeSet Compat Environment](./framework/nodeset_compatibility.md)
     - [Fork Testing](./framework/fork.md)
+    - [Quick Contracts Deployment](./framework/quick_deployment.md)
     - [NodeSet with External Blockchain]()
     - [CLI](./framework/cli.md)
     - [Configuration](./framework/configuration.md)
     - [Test Configuration](./framework/test_configuration_overrides.md)
     - [Exposing Components](framework/components/state.md)
+    - [Debugging Tests](framework/components/debug.md)
     - [Components Cleanup](framework/components/cleanup.md)
     - [Components Caching](framework/components/caching.md)
     - [Mocking Services](framework/components/mocking.md)
@@ -27,7 +29,6 @@
       - [Logs](framework/observability/logs.md)
       - [Profiling](framework/observability/profiling.md)
       - [Traces]()
-      - [Debugger]()
     - [Blockscout](framework/observability/blockscout.md)
     - [Components](framework/components/overview.md)
         - [Blockchains](framework/components/blockchains/overview.md)

book/src/framework/components/debug.md

@@ -0,0 +1,44 @@
+# Debugging Tests
+
+All container logs are saved in a directory named `logs`, which will appear in the same directory where you ran the test after the test is completed.
+
+For verifying your on-chain components, refer to the [Blockscout documentation](https://docs.blockscout.com/devs/verification/foundry-verification) on smart contract verification. This guide provides detailed instructions on uploading your ABI and verifying your contracts.
+
+Use `CTF_LOG_LEVEL=trace|debug|info|warn` to debug the framework.
+
+Use `RESTY_DEBUG=true` to debug any API calls.
+
+Use `SETH_LOG_LEVEL=trace|debug|info|warn` to debug [Seth](../../libs/seth.md).
+
+## Using Delve (TBD)
+
+You can use [Delve]() inside your containers to debug aplications.
+
+Build them with `go build -gcflags="all=-N -l" -o myapp` and use an example `Dockerfile`:
+```
+FROM golang:1.20
+
+# Install Delve
+RUN go install github.com/go-delve/delve/cmd/dlv@latest
+
+# Set working directory
+WORKDIR /app
+
+# Copy the application binary and source code (if needed for debugging)
+COPY myapp /app/myapp
+COPY . /app
+
+# Expose the port for Delve
+EXPOSE 40000
+
+# Start Delve in headless mode for remote debugging
+ENTRYPOINT ["dlv", "exec", "./myapp", "--headless", "--listen=:40000", "--api-version=2", "--accept-multiclient"]
+
+```
+
+Adding `Delve` to all our components is WIP right now.
+
+To expose `Delve` port follow this [guide](state.md).
+
+
+

book/src/framework/components/mocking.md

@@ -12,3 +12,10 @@ The framework aims to equip you with all the necessary tools to write end-to-end
 ## Usage
 
 See [full](https://github.com/smartcontractkit/chainlink-testing-framework/blob/main/framework/examples/myproject/fake_test.go) example.
+
+<div class="warning">
+
+`host.docker.internal` is docker platform dependent!
+
+Use `framework.HostDockerInternal()` to reference `host.docker.internal` in your tests, so they can work in GHA CI
+</div>

book/src/framework/observability/debugger.md

@@ -0,0 +1,19 @@
+# Quick Contracts Deployment
+
+You can control the mining pace to accelerate contract deployment. Start anvil with the following configuration:
+
+```toml
+[blockchain_a]
+  chain_id = "31337"
+  image = "f4hrenh9it/foundry:latest"
+  port = "8545"
+  type = "anvil"
+```
+Set the `miner` speed,
+```golang
+	// start periodic mining so nodes can receive heads (async)
+	miner := rpc.NewRemoteAnvilMiner(bcSrc.Nodes[0].HostHTTPUrl, nil)
+	miner.MinePeriodically(5 * time.Second)
+```
+
+Then use this [template](https://github.com/smartcontractkit/chainlink-testing-framework/blob/main/framework/examples/myproject/quick_deploy_test.go)

book/src/framework/quick_deployment.md

@@ -0,0 +1,3 @@
+- Switch to "anvil_mine" instead of "evm_mine"
+- Test that CL nodes can see block heads after we switch the mining pace
+- Quick deployments example (docs)