README
¶
Docker environment
This folder contains a Chainlink cluster environment created with testcontainers-go.
CLI for Local Testing Environment
The command-line interface (CLI) located at ./integration-tests/docker/cmd/test_env.go can be utilized to initiate a local testing environment. It is intended to replace Docker Compose in the near future.
Example:
# Set required envs
export CHAINLINK_IMAGE="<chainlink_node_docker_image_path>"
export CHAINLINK_VERSION="<chainlink_node_docker_image_version>"
# Stream logs to Loki
export LOKI_TOKEN=...
export LOKI_URL=https://${loki_host}/loki/api/v1/push
cd ./integration-tests/docker/cmd
go run test_env.go start-env cl-cluster
Obtaining Test Coverage for Chainlink Node
To acquire test coverage data for end-to-end (E2E) tests on the Chainlink Node, follow these steps:
-
Build Chainlink Node docker image with the cover flag.
First, build the Chainlink Node Docker image with the
GO_COVER_FLAGargument set totrue. This enables the coverage flag in the build process. Here’s how you can do it:docker buildx build --platform linux/arm64 . -t localhost/chainlink-local:develop -f ./core/chainlink.Dockerfile --build-arg GO_COVER_FLAG=trueMake sure to replace localhost/chainlink-local:develop with the appropriate repository and tag.
-
Configure and Run E2E Tests Next, configure the E2E tests to generate an HTML coverage report. You need to modify the
overrides.tomlfile as shown below to include the show_html_coverage_report setting under the[Logging]section:[Logging] show_html_coverage_report=true
After the tests are complete, the coverage report will be generated in HTML format. Example: ~/Downloads/go-coverage/TestOCRv2Basic_plugins-chain-reader/coverage.html
log.go:43: 16:29:46.73 INF Chainlink node coverage html report saved filePath=~/Downloads/go-coverage/TestOCRv2Basic_plugins-chain-reader/coverage.html
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type NodeCoverageHelper ¶
type NodeCoverageHelper struct {
Nodes []tc.Container
GoCoverSrcDir string // Path to the source directory on the chainlink image with go coverage data
NodeCoverageDirs []string // Paths to individual node coverage directories
CoverageDir string // Path to the base directory with all coverage
MergedDir string // Path to the directory where all coverage will be merged
ChainlinkDir string // Path to the root chainlink directory
}
func NewNodeCoverageHelper ¶
func (*NodeCoverageHelper) SaveMergedCoveragePercentage ¶
func (c *NodeCoverageHelper) SaveMergedCoveragePercentage() (string, error)
func (*NodeCoverageHelper) SaveMergedHTMLReport ¶
func (c *NodeCoverageHelper) SaveMergedHTMLReport() (string, error)
Source Files
Directories