Merge branch 'main' into flakeguardAggregations

Author: kalverra

.github/workflows/generate-go-docs.yaml

@@ -0,0 +1,78 @@
+name: Generate go-docs
+
+on:
+  pull_request:
+    types:
+      - labeled
+      - reopened
+      - synchronize
+
+jobs:
+  generate_docs_new_pr:
+    if: ${{ contains(github.event.issue.labels.*.name, 'generate_go_docs') }}
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      pull-requests: write
+      repository-projects: read
+
+    steps:
+      - name: Checkout current branch
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Setup Git
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"              
+
+      - name: Get PR details
+        id: pr-details
+        run: |
+          echo "pr_number=$(jq -r .pull_request.number <<< "$GITHUB_EVENT_PATH")" >> $GITHUB_OUTPUT
+          echo "pr_branch=$(jq -r .pull_request.head.ref <<< "$GITHUB_EVENT_PATH")" >> $GITHUB_OUTPUT
+          echo "base_commit=${{ github.event.pull_request.base.sha }}" >> $GITHUB_OUTPUT
+          echo "head_commit=${{ github.event.pull_request.head.sha }}" >> $GITHUB_OUTPUT          
+
+      - name: Install go doc generator
+        shell: bash
+        run: |
+          go install github.com/smartcontractkit/generate-go-function-docs@latest
+
+      - name: Install gopls
+        shell: bash
+        run: |
+          go install golang.org/x/tools/gopls@latest
+
+      - name: Create a new branch
+        run: |
+          git checkout -b ${{ steps.pr-details.outputs.pr_branch }}-docs
+
+      - name: Generate go docs
+        shell: bash
+        env:
+          OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
+        run: |
+          generate-go-function-docs diff -b ${{ steps.pr-details.outputs.base_commit }} -c ${{ steps.pr-details.outputs.head_commit }} -g fake_slash
+
+      - name: Make sure code still compiles
+        run: |
+          go mod tidy
+          go mod vendor
+          go build ./...
+
+      - name: Commit changes
+        run: |
+          git add .
+          git commit -m "Add automatically generated go documentation"
+          git push origin ${{ steps.pr-details.outputs.pr_branch }}-docs
+
+      - name: Create a new PR targeting current PR
+        uses: peter-evans/create-pull-request@v5
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          base: ${{ env.pr_branch }}
+          branch: ${{ steps.pr-details.outputs.pr_branch }}-docs
+          title: "Go docs for PR#${{ env.pr_number }}"
+          body: "This PR contains automatically generated go documentation for the PR#${{ env.pr_number }}. Please review the changes."

.github/workflows/k8s-publish-test-base-image.yaml

@@ -5,6 +5,11 @@ on:
       # we only need base image for k8s based tests
       - 'lib/v*'
   workflow_dispatch:
+    inputs:
+      tag:
+        description: 'Tag for the base image'
+        required: true
+        type: string
 
 jobs:
   publish_test_base_image:
@@ -19,12 +24,20 @@ jobs:
       - uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4.2.1
 
       - name: Strip "lib/" from github.ref_name
+        if: ${{ github.event_name == 'push' }}
         run: |
           stripped_ref_name="${GITHUB_REF//refs\/tags\/lib\//}"
           # disabling as the string containing variable is double-quotted as a whole, no need to quote each variable separately
           # shellcheck disable=SC2086          
           echo "BASE_IMAGE_TAG=${{ secrets.QA_AWS_ACCOUNT_NUMBER }}.dkr.ecr.${{ secrets.QA_AWS_REGION }}.amazonaws.com/test-base-image:$stripped_ref_name" >> $GITHUB_ENV
 
+      - name: Export base image tag for workflow dispatch
+        if: ${{ github.event_name == 'workflow_dispatch' }}
+        shell: bash
+        run: |
+          # shellcheck disable=SC2086
+          echo "BASE_IMAGE_TAG=${{ secrets.QA_AWS_ACCOUNT_NUMBER }}.dkr.ecr.${{ secrets.QA_AWS_REGION }}.amazonaws.com/test-base-image:${{ github.event.inputs.tag }}" >> $GITHUB_ENV
+
       - name: Build Base Image
         uses: smartcontractkit/chainlink-github-actions/docker/build-push@d2f9642bcc24a73400568756f24b72c188ac7a9a # v2.3.31
         with:

book/src/SUMMARY.md

@@ -23,6 +23,7 @@
     - [Mocking Services](framework/components/mocking.md)
     - [Copying Files](framework/copying_files.md)
     - [External Environment](framework/components/external.md)
+    - [Troubleshooting](framework/components/troubleshooting.md)
     - [Secrets]()
     - [Observability Stack](framework/observability/observability_stack.md)
       - [Metrics](framework/observability/metrics.md)

book/src/framework/components/troubleshooting.md

@@ -0,0 +1,12 @@
+# Troubleshooting
+
+## Can't run `anvil`, issue with `Rosetta`
+```
+2024/11/27 15:20:27 ⏳ Waiting for container id 79f8a68c07cc image: f4hrenh9it/foundry:latest. Waiting for: &{Port:8546 timeout:0x14000901278 PollInterval:100ms skipInternalCheck:false}
+2024/11/27 15:20:27 container logs (all exposed ports, [8546/tcp], were not mapped in 5s: port 8546/tcp is not mapped yet
+wait until ready: check target: retries: 1, port: "", last err: container exited with code 133):
+rosetta error: Rosetta is only intended to run on Apple Silicon with a macOS host using Virtualization.framework with Rosetta mode enabled
+```
+#### Solution
+
+Update your docker to `Docker version 27.3.1, build ce12230`

book/src/framework/getting_started.md

@@ -4,6 +4,12 @@
 - `Docker` [OrbStack](https://orbstack.dev/) or [Docker Desktop](https://www.docker.com/products/docker-desktop/), we recommend OrbStack (faster, smaller memory footprint)
 - [Golang](https://go.dev/doc/install)
 
+Tested with
+```
+Docker version 27.3.1
+OrbStack Version: 1.8.2 (1080200)
+```
+
 ## Test setup
 
 To start writing tests create a directory for your project with `go.mod` and add a package

book/src/framework/observability/blockscout.md

@@ -12,6 +12,14 @@ To remove it, we also clean up all Blockscout databases to prevent stale data wh
 ctf bs down
 ```
 
+## Selecting Blockchain Node
+
+By default, we connect to the first `anvil` node, but you can select the node explicitly
+```
+ctf bs -r http://host.docker.internal:8545 d
+ctf bs -r http://host.docker.internal:8555 d
+```
+
 <div class="warning">
 
 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. 

book/src/k8s-test-runner/k8s-test-runner.md

@@ -45,6 +45,7 @@ The TOML config should specify the test runner configuration as follows:
 ```
 namespace = "e2e-tests"
 rbac_role_name = "" # RBAC role name for the chart
+rbac_service_account_name = "" # RBAC service account name for the chart
 image_registry_url = "" # URL to the ECR containing the test binary image, e.g., staging ECR URL
 image_name = "k8s-test-runner"
 image_tag = ""  # The image tag to use, like "mercury-load-tests" (see readme above)
@@ -61,8 +62,16 @@ resources_limits_memory = "1024Mi"
 WASP_LOG_LEVEL = "info"
 TEST_LOG_LEVEL = "info"
 MERCURY_TEST_LOG_LEVEL = "info"
+[metadata.labels]
+"chain.link/component" = "test-runner"
+"chain.link/product" = "<your-product-name>"
+"chain.link/team" = "<name–of-the-team-you're-running-the-test-for>"
+"chain.link/cost-center" = "test-tooling-<testType>-test"
 ```
 
+> [NOTE]
+> Make sure to quote labels with "/" as otherwise parsing them will fail.
+
 Where:
 
 - `test_name` is the name of the test to run (must be included in the test binary).
@@ -113,6 +122,7 @@ Then:
         cat << EOF > config.toml
         namespace = "e2e-tests"
         rbac_role_name = "" # RBAC role name for the chart
+        rbac_service_account_name = "" # RBAC service account name for the chart
         image_registry_url = "${{ secrets.AWS_ACCOUNT_ID_STAGING }}.dkr.ecr.${{ secrets.AWS_REGION }}.amazonaws.com"
         image_name = "k8s-test-runner"
         image_tag = "mercury-load-test"
@@ -130,6 +140,11 @@ Then:
         WASP_LOG_LEVEL = "info"
         TEST_LOG_LEVEL = "info"
         MERCURY_TEST_LOG_LEVEL = "info"
+        [metadata.labels]
+        "chain.link/component" = "test-runner"
+        "chain.link/product" = "data-streamsv0.3"
+        "chain.link/team" = "Data Streams"
+        "chain.link/cost-center" = "test-tooling-load-test"
         EOF
 
         ./k8s-test-runner-linux-amd64 run -c config.toml

framework/.changeset/v0.2.12.md

@@ -0,0 +1,2 @@
+- Omit all local tooling container logs
+- Allow to connect Blockscout to any node

framework/.changeset/v0.2.13.md

@@ -0,0 +1,3 @@
+- Simplify local Chainlink build
+- Remove dependency on "local-registry"
+- Skip Promtail to accelerate CI 🚀

framework/cmd/blockscout.go

@@ -3,14 +3,16 @@ package main
 import (
 	"fmt"
 	"github.com/smartcontractkit/chainlink-testing-framework/framework"
+	"os"
 	"path/filepath"
 )
 
-func blockscoutUp() error {
+func blockscoutUp(url string) error {
 	framework.L.Info().Msg("Creating local Blockscout stack")
 	if err := extractAllFiles("observability"); err != nil {
 		return err
 	}
+	os.Setenv("BLOCKSCOUT_RPC_URL", url)
 	err := runCommand("bash", "-c", fmt.Sprintf(`
 		cd %s && \
 		docker compose up -d
@@ -23,8 +25,9 @@ func blockscoutUp() error {
 	return nil
 }
 
-func blockscoutDown() error {
+func blockscoutDown(url string) error {
 	framework.L.Info().Msg("Removing local Blockscout stack")
+	os.Setenv("BLOCKSCOUT_RPC_URL", url)
 	err := runCommand("bash", "-c", fmt.Sprintf(`
 		cd %s && \
 		docker compose down -v