Here lives the integration tests for chainlink, utilizing our chainlink-testing-framework.
If you have previously run these smoke tests using GitHub Actions or some sort of Kubernetes setup, that method is no longer necessary. We have moved the majority of our tests to utilize plain Docker containers (with the help of Testcontainers). This should make tests faster, more stable, and enable you to run them on your local machine without much hassle.
- Go
- Docker
- You'll probably want to increase the resources available to Docker as most tests require quite a few containers (e.g. OCR requires 6 Chainlink nodes, 6 databases, a simulated blockchain, and a mock server).
See the example.env file for environment variables you can set to configure things like network settings, Chainlink version, and log level. Remember to use source .env to activate your settings.
If you'd like to run the tests on a local build of Chainlink, you can point to your own docker image, or build a fresh one with make.
make build_docker_image image=<image-name> tag=<tag>
e.g.
make build_docker_image image=chainlink tag=test-tag
You'll want to set the CHAINLINK_IMAGE and CHAINLINK_VERSION env values appropriately as well. See example.env for more details.
go test ./smoke/<product>_test.go
Most test files have a couple of tests, it's recommended to look into the file and focus on a specific one if possible. 90% of the time this will probably be the Basic test. See ocr_test.go for example, which contains the TestOCRBasic test.
go test ./smoke/ocr_test.go -run TestOCRBasic
It's generally recommended to run only one test at a time on a local machine as it needs a lot of docker containers and can peg your resources otherwise. You will see docker containers spin up on your machine for each component of the test where you can inspect logs.
You can see the results of each test in the terminal with normal go test output. If a test fails, logs of each Chainlink container will dump into the smoke/logs/ folder for later analysis. You can also see these logs in CI uploaded as GitHub artifacts.
These tests remain bound to a Kubernetes run environment, and require more complex setup and running instructions not documented here. We endeavor to make these easier to run and configure, but for the time being please seek a member of the QA/Test Tooling team if you want to run these.