change chainlink-env to env package and adjust all usages

smartcontractkit · Oct 24, 2023 · f39d61e · f39d61e
1 parent 3fdf6ef
commit f39d61e
Show file tree

Hide file tree

Showing 85 changed files with 541 additions and 1,267 deletions.
diff --git a/.github/workflows/env-e2e.yaml b/.github/workflows/env-e2e.yaml
@@ -0,0 +1,123 @@
+name: (env package) E2E tests
+on:
+  push:
+    paths:
+      - "env/**"
+
+concurrency:
+  group: e2e-tests-chainlink-env-${{ github.ref }}
+  cancel-in-progress: true
+
+env:
+  INTERNAL_DOCKER_REPO: ${{ secrets.QA_AWS_ACCOUNT_NUMBER }}.dkr.ecr.${{ secrets.QA_AWS_REGION }}.amazonaws.com
+  ENV_JOB_IMAGE: ${{ secrets.QA_AWS_ACCOUNT_NUMBER }}.dkr.ecr.${{ secrets.QA_AWS_REGION }}.amazonaws.com/chainlink-testing-framework-tests:ci.${{ github.sha }}
+  BASE_IMAGE_NAME: ${{ secrets.QA_AWS_ACCOUNT_NUMBER }}.dkr.ecr.${{ secrets.QA_AWS_REGION }}.amazonaws.com/test-base-image:ci.${{ github.sha }}
+  CHAINLINK_IMAGE: ${{ secrets.QA_AWS_ACCOUNT_NUMBER }}.dkr.ecr.${{ secrets.QA_AWS_REGION }}.amazonaws.com/chainlink
+  CHAINLINK_VERSION: develop
+  SELECTED_NETWORKS: SIMULATED
+  CHAINLINK_COMMIT_SHA: ${{ github.sha }}
+  CHAINLINK_ENV_USER: ${{ github.actor }}
+  TEST_LOG_LEVEL: debug
+
+jobs:
+  build_tests:
+    runs-on: ubuntu-latest
+    environment: integration
+    permissions:
+      id-token: write
+      contents: read
+    steps:
+      - uses: actions/checkout@v3
+      - name: Build Base Image
+        uses: smartcontractkit/chainlink-github-actions/docker/build-push@ce87f8986ca18336cc5015df75916c2ec0a7c4b3 # v2.1.2
+        with:
+          tags: ${{ env.BASE_IMAGE_NAME }}
+          file: env/Dockerfile.base
+          AWS_REGION: ${{ secrets.QA_AWS_REGION }}
+          AWS_ROLE_TO_ASSUME: ${{ secrets.QA_AWS_ROLE_TO_ASSUME }}
+      - name: Base Image Built
+        run: |
+          # shellcheck disable=SC2086
+          cat <<EOT >>$GITHUB_STEP_SUMMARY
+          ### chainlink image tag used for this test run :link: => \`${{ env.CHAINLINK_VERSION }}\`
+          ### test-base-image image tag for this test run :ship: => \`ci.${{ github.sha }}\`
+          EOT
+      - name: Build Test Runner
+        uses: smartcontractkit/chainlink-github-actions/docker/build-push@ce87f8986ca18336cc5015df75916c2ec0a7c4b3 # v2.1.2
+        with:
+          tags: ${{ env.ENV_JOB_IMAGE }}
+          file: env/Dockerfile
+          build-args: |
+            BASE_IMAGE=${{ secrets.QA_AWS_ACCOUNT_NUMBER }}.dkr.ecr.${{ secrets.QA_AWS_REGION }}.amazonaws.com/test-base-image
+            IMAGE_VERSION=ci.${{ github.sha }}
+          AWS_REGION: ${{ secrets.QA_AWS_REGION }}
+          AWS_ROLE_TO_ASSUME: ${{ secrets.QA_AWS_ROLE_TO_ASSUME }}
+      - name: Test Image Built
+        run: |
+         # shellcheck disable=SC2086
+         cat <<EOT >>$GITHUB_STEP_SUMMARY
+         ### chainlink-env-tests image tag for this test run :ship: -> \`ci.${{ github.sha }}\`
+         EOT
+  e2e_tests:
+    runs-on: ubuntu-latest
+    environment: integration
+    permissions:
+      id-token: write
+      contents: read
+    env:
+      TEST_SUITE: local-runner
+    steps:
+      - uses: actions/checkout@v3
+      - name: Run Tests
+        uses: smartcontractkit/chainlink-github-actions/chainlink-testing-framework/run-tests@ce87f8986ca18336cc5015df75916c2ec0a7c4b3 # v2.1.2
+        with:
+          cl_repo: ${{ env.CHAINLINK_IMAGE }}
+          cl_image_tag: ${{ env.CHAINLINK_VERSION }}
+          test_command_to_run: unset ENV_JOB_IMAGE && cd env && make test_e2e_ci
+          test_download_vendor_packages_command: go mod download
+          artifacts_location: ./e2e/logs
+          publish_check_name: E2E Test Results
+          token: ${{ secrets.GITHUB_TOKEN }}
+          go_mod_path: go.mod
+          QA_AWS_REGION: ${{ secrets.QA_AWS_REGION }}
+          QA_AWS_ROLE_TO_ASSUME: ${{ secrets.QA_AWS_ROLE_TO_ASSUME }}
+          QA_KUBECONFIG: ${{ secrets.QA_KUBECONFIG }}
+      - name: Upload test log
+        uses: actions/upload-artifact@v3
+        if: failure()
+        with:
+          name: test-log
+          path: /tmp/gotest.log
+
+  e2e_remote_runner_tests:
+    runs-on: ubuntu-latest
+    environment: integration
+    needs: [build_tests]
+    permissions:
+      id-token: write
+      contents: read
+    env:
+      TEST_SUITE: remote-runner
+      TEST_TRIGGERED_BY: chainlink-env-remote-runner-ci
+    steps:
+      - uses: actions/checkout@v3
+      - name: Run Remote Runner Tests
+        uses: smartcontractkit/chainlink-github-actions/chainlink-testing-framework/run-tests@ce87f8986ca18336cc5015df75916c2ec0a7c4b3 # v2.1.2
+        with:
+          cl_repo: ${{ env.CHAINLINK_IMAGE }}
+          cl_image_tag: ${{ env.CHAINLINK_VERSION }}
+          test_command_to_run: cd env && make test_e2e_ci_remote_runner
+          test_download_vendor_packages_command: go mod download
+          artifacts_location: ./e2e/logs
+          publish_check_name: E2E Remote Runner Test Results
+          token: ${{ secrets.GITHUB_TOKEN }}
+          go_mod_path: go.mod
+          QA_AWS_REGION: ${{ secrets.QA_AWS_REGION }}
+          QA_AWS_ROLE_TO_ASSUME: ${{ secrets.QA_AWS_ROLE_TO_ASSUME }}
+          QA_KUBECONFIG: ${{ secrets.QA_KUBECONFIG }}
+      - name: Upload test log
+        uses: actions/upload-artifact@v2
+        if: failure()
+        with:
+          name: remote-runner-test-log
+          path: /tmp/remoterunnergotest.log
diff --git a/.github/workflows/env-publish-test-base-image.yaml b/.github/workflows/env-publish-test-base-image.yaml
@@ -0,0 +1,27 @@
+name: (env package) Publish Test Base Image
+on:
+  push:
+    tags:
+      - 'v*'
+    paths:
+    - "env/**"
+
+jobs:
+  publish_test_base_image:
+    if: ${{ false }}
+    runs-on: ubuntu-latest
+    environment: integration
+    permissions:
+      id-token: write
+      contents: read
+    env:
+      BASE_IMAGE_TAG: ${{ secrets.QA_AWS_ACCOUNT_NUMBER }}.dkr.ecr.${{ secrets.QA_AWS_REGION }}.amazonaws.com/test-base-image:${{ github.ref_name }}
+    steps:
+      - uses: actions/checkout@v3
+      - name: Build Base Image
+        uses: smartcontractkit/chainlink-github-actions/docker/build-push@cb4a8f51d77cbf77ea6a765bd1f437ffc7a18730 # v2.0.28
+        with:
+          tags: ${{ env.BASE_IMAGE_TAG }}
+          file: env/Dockerfile.base
+          AWS_REGION: ${{ secrets.QA_AWS_REGION }}
+          AWS_ROLE_TO_ASSUME: ${{ secrets.QA_AWS_ROLE_TO_ASSUME }}
diff --git a/.github/workflows/lint.yaml b/.github/workflows/lint.yaml
@@ -1,4 +1,4 @@
-name: Linting and SonarQube Analysis
+name: (all packages) Lints
 on:
   push:
     branches:

diff --git a/.github/workflows/static-analysis.yaml b/.github/workflows/static-analysis.yaml
@@ -1,4 +1,4 @@
-name: Static Analysis
+name: (all packages) Static Analysis
 on:
   push:
     branches: [main]

diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml
@@ -1,4 +1,4 @@
-name: Tests
+name: (all packages) Unit tests
 on:
   push:
     tags:
@@ -29,7 +29,9 @@ jobs:
           PATH=$PATH:$(go env GOPATH)/bin
           export PATH
           set -euo pipefail
-          go test -json -cover -covermode=count -coverprofile=unit-test-coverage.out ./... 2>&1 | tee /tmp/gotest.log | gotestfmt
+          # disabled, because we want to use a multiline output of go list command
+          # shellcheck disable=SC2046
+          go test -json -cover -covermode=count -coverprofile=unit-test-coverage.out $(go list ./... | grep -v /env/e2e/ | grep -v /env/examples/) 2>&1 | tee /tmp/gotest.log | gotestfmt
       - name: Code Coverage
         uses: codecov/codecov-action@v3
         with:

diff --git a/.gitignore b/.gitignore
@@ -54,4 +54,14 @@ docs/Gemfile.lock
 dist/
 
 **/remote_runner_config.yaml
-logs/
+logs/
+
+env/cmd/chaos
+env/bin/
+# temp manifest for deployment and validation
+tmp-manifest-*.yaml
+# remote runner binary
+remote.test
+e2e.test
+
+k3dvolume/
diff --git a/.golangci.yaml b/.golangci.yaml
@@ -3,6 +3,8 @@ run:
   timeout: 5m
   skip-dirs:
     - contracts/ethereum
+    - examples
+    - imports
 linters:
   enable:
     # defaults

diff --git a/.tool-versions b/.tool-versions
@@ -1,7 +1,10 @@
 golang 1.21.3
 nodejs 14.20.0
-k3d 5.4.6
+k3d 5.5.1
 act 0.2.30
 golangci-lint 1.54.2
 actionlint 1.6.17
 shellcheck 0.9.0
+helm 3.10.3
+kubectl 1.25.5
+yarn 1.22.19
diff --git a/Makefile b/Makefile
@@ -55,4 +55,4 @@ compile_contracts:
 	python3 ./utils/compile_contracts.py
 
 test_unit: install_gotestfmt
-	go test -json -cover -covermode=count -coverprofile=unit-test-coverage.out ./client ./gauntlet ./testreporters ./docker/test_env 2>&1 | tee /tmp/gotest.log | gotestfmt
+	go test -json -cover -covermode=count -coverprofile=unit-test-coverage.out ./client ./gauntlet ./testreporters ./docker/test_env ./env/config 2>&1 | tee /tmp/gotest.log | gotestfmt
diff --git a/README.md b/README.md
@@ -12,6 +12,6 @@
 
 </div>
 
-The Chainlink Testing Framework is a blockchain development framework written in Go. Its primary purpose is to help chainlink developers create extensive integration, e2e, performance, and chaos tests to ensure the stability of the chainlink project. It can also be helpful to those who just want to use chainlink oracles in their projects to help test their contracts, or even for those that aren't using chainlink. This project makes ample use of the [chainlink-env](https://github.com/smartcontractkit/chainlink-env) package to launch resources and testing apparatus.
+The Chainlink Testing Framework is a blockchain development framework written in Go. Its primary purpose is to help chainlink developers create extensive integration, e2e, performance, and chaos tests to ensure the stability of the chainlink project. It can also be helpful to those who just want to use chainlink oracles in their projects to help test their contracts, or even for those that aren't using chainlink.
 
 If you're looking to implement a new chain integration for the testing framework, head over to the [blockchain](./blockchain/) directory for more info.
diff --git a/blockchain/ethereum.go b/blockchain/ethereum.go
@@ -26,7 +26,7 @@ import (
 	"go.uber.org/atomic"
 	"golang.org/x/sync/errgroup"
 
-	"github.com/smartcontractkit/chainlink-env/environment"
+	"github.com/smartcontractkit/chainlink-testing-framework/env/environment"
 
 	"github.com/smartcontractkit/chainlink-testing-framework/utils"
 )

diff --git a/client/mockserver.go b/client/mockserver.go
@@ -6,10 +6,10 @@ import (
 	"strings"
 
 	"github.com/go-resty/resty/v2"
-
 	"github.com/rs/zerolog/log"
-	"github.com/smartcontractkit/chainlink-env/environment"
-	"github.com/smartcontractkit/chainlink-env/pkg/helm/mockserver"
+
+	"github.com/smartcontractkit/chainlink-testing-framework/env/environment"
+	"github.com/smartcontractkit/chainlink-testing-framework/env/pkg/helm/mockserver"
 )
 
 // MockserverClient mockserver client

diff --git a/client/postgres.go b/client/postgres.go
@@ -5,11 +5,11 @@ import (
 	"strings"
 
 	"github.com/jmoiron/sqlx"
-	"github.com/smartcontractkit/chainlink-env/environment"
-
 	// import for side effect of sql packages
 	_ "github.com/lib/pq"
 	"github.com/rs/zerolog/log"
+
+	"github.com/smartcontractkit/chainlink-testing-framework/env/environment"
 )
 
 // PostgresConnector sqlx postgres connector

diff --git a/docs/index.md b/docs/index.md
@@ -22,6 +22,5 @@ Here you'll find some guidelines on writing blockchain tests using this framewor
 
 Some notable packages we use include:
 
-* [chainlink-env](https://github.com/smartcontractkit/chainlink-env)
 * [zerolog](https://github.com/rs/zerolog)
 * [Kubernetes](https://github.com/kubernetes/kubernetes)
diff --git a/docs/setup/code.md b/docs/setup/code.md
@@ -7,11 +7,11 @@ parent: Setup
 
 # Test Setup Code
 
-Now that we've got our config and Kubernetes sorted, we can write a bit of code that will deploy an environment for our test to run. To deploy our simulated geth, mock-server, and Chainlink instances, we rely on another chainlink library, [chainlink-env](https://github.com/smartcontractkit/chainlink-env/). This library handles deploying everything our test needs to the Kubernetes cluster.
+Now that we've got our config and Kubernetes sorted, we can write a bit of code that will deploy an environment for our test to run. To deploy our simulated geth, mock-server, and Chainlink instances, we rely on `env` package. This package handles deploying everything our test needs to the Kubernetes cluster.
 
 ```go
-// We use the chainlink-env library to make and handle deployed resources
-import "github.com/smartcontractkit/chainlink-env/environment"
+// We use the env package to make and handle deployed resources
+import "github.com/smartcontractkit/chainlink-testing-framework/env/environment"
 
 // Deploy a testing environment, and receive it as the `env` variable. This is used to connect to resources.
 e = environment.New(nil)

diff --git a/env/Dockerfile b/env/Dockerfile
@@ -3,5 +3,5 @@ ARG IMAGE_VERSION=latest
 FROM ${BASE_IMAGE}:${IMAGE_VERSION}
 COPY . testdir/
 WORKDIR /go/testdir
-RUN ./scripts/buildTests
-ENTRYPOINT ["./scripts/entrypoint"]
+RUN ./env/scripts/buildTests
+ENTRYPOINT ["./env/scripts/entrypoint"]
diff --git a/env/REMOTE_RUN.md b/env/REMOTE_RUN.md
@@ -25,6 +25,6 @@ export TEST_ENV_VAR=myTestVarForAJob
 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"
 # your example test file to run inside k8s
-# if ENV_JOB_IMAGE is present chainlink-env will create a job, wait until it finished and get logs
+# 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
 ```