[NONEVM-1712] CTF Integration with GHA Cache by jadepark-dev · Pull Request #12 · smartcontractkit/chainlink-ton

jadepark-dev · 2025-05-13T14:00:02Z

This PR introduces CTF integration in TON blockchain integration tests with GHA Cache NONEVM-1712

Primary Changes

Added GitHub Action for caching MyLocalTon Docker images to optimize CI test runs
Created a example integration test for TON blockchain smoke testing
Implemented Docker image caching mechanism to improve test execution time

Others

Added cache directory structure and configuration for storing Docker images
Configured scheduled weekly cache updates to ensure fresh images
Set up TON blockchain configuration for test environment

Requires

Ton Network Support chainlink-testing-framework#1823
[DX-841] Refactor TON network to use testcontainers-go chainlink-testing-framework#1833
Address feedback & clean up structure & debugging logs
Add documentation

This reverts commit 3b5cade.

Copilot

Pull Request Overview

This PR introduces CTF integration for TON blockchain integration tests by adding a caching mechanism for MyLocalTon Docker images, which aims to speed up CI test runs.

Added a TOML configuration for TON blockchain integration
Created a new Go-based integration test for TON blockchain smoke testing
Configured GitHub workflows and a composite action to pull, cache, and refresh Docker images

Reviewed Changes

Copilot reviewed 8 out of 10 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
integration-tests/examples/smoke_ton.toml	New config file defining blockchain type, image URL, and service list for TON tests.
integration-tests/examples/ctf_test.go	Introduces an integration test including blockchain network setup and wallet operations.
.github/workflows/test-ctf.yml	Workflow to run integration tests along with setting up MyLocalTon images and Go environment.
.github/workflows/cache-mylocalton-images.yml	Workflow for scheduled and manual caching of MyLocalTon Docker images.
.github/actions/mylocalton-images/action.yml	Composite action to prepare cache directories, manage Docker image pulls/saves, and update the cache.

Files not reviewed (2)

integration-tests/.gitignore: Language not supported
integration-tests/go.mod: Language not supported

integration-tests/examples/ctf_test.go

Copilot · 2025-05-14T08:42:16Z

.github/workflows/test-ctf.yml

+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out code
+        uses: actions/checkout@0ad4b8fadaa221de15dcec353f45205ec38ea70b # v4.1.4


Consider using a stable version tag (e.g., actions/checkout@v4) instead of a commit hash to make the workflow easier to maintain.

Suggested change

uses: actions/checkout@0ad4b8fadaa221de15dcec353f45205ec38ea70b # v4.1.4

uses: actions/checkout@v4

Copilot · 2025-05-14T08:42:16Z

.github/actions/mylocalton-images/action.yml

+      uses: actions/cache@v4
+      with:
+        path: ${{ inputs.cache-dir }}/docker-images.tar
+        key: mylocalton-images-${{ hashFiles('${{ inputs.cache-dir }}/docker-compose.yml') }}


[nitpick] Double-check the use of nested expressions inside hashFiles; consider simplifying the expression to ensure that the correct file is hashed for cache key generation.

Suggested change

key: mylocalton-images-${{ hashFiles('${{ inputs.cache-dir }}/docker-compose.yml') }}

key: mylocalton-images-${{ hashFiles(compose_file_path) }}

krebernisak · 2025-05-15T13:04:02Z

.github/workflows/test-ctf.yml

+        uses: ./.github/actions/mylocalton-images
+
+      - name: Setup Go
+        uses: smartcontractkit/.github/actions/setup-golang@setup-golang/v1


Please adopt and use Nix - we will not use custom unportable GHA setups

Yes, absolutely. I had copied it from another repo’s workflow and added it temporarily because the Go dependency installation was taking a long time during testing. Thanks for the feedback!

fixed in 7b3cde2

krebernisak · 2025-05-15T13:06:59Z

.github/actions/mylocalton-images/action.yml

+    description: 'Space-separated list of Docker images'
+    required: false
+    default: >-
+      ghcr.io/neodix42/mylocalton-docker:latest


Please try to simplify this custom action (ideally remove it completely) by reusing existing Docker bake action which has support for caching and pulling from cache using an additional configuration file: https://twistezo.github.io/blog/posts/caching-docker

I have a question about this part — please correct me if I’m wrong. I ran some tests based on the reference link you shared, but the docker-compose file we’ll be using (which will be hosted remotely and not modified) doesn’t include any build step. My understanding is that Docker Bake Action is primarily for caching build layers. Because of that, I initially failed to implement it, but I’ll give it another try. I agree that we should avoid using custom scripts.

krebernisak · 2025-05-15T13:10:16Z

integration-tests/examples/smoke_ton.toml

+image = "https://raw.githubusercontent.com/neodix42/mylocalton-docker/main/docker-compose.yaml"
+ton_core_services = [


Why is this declared as an image?

Why are these services configured as ton_core_services - couldn't this be general Docker compose support, and a configuration for a list of any Docker compose services?

Thanks for the feedback! I initially used the existing field image, but it has now been changed to docker_compose_file_url.

You’re right about the Docker images — it makes sense for the field names to represent general image options that can be selected within a Docker Compose setup

replaced with docker_compose_file_url / docker_compose_services. fixed in f9b8858

krebernisak · 2025-05-15T13:11:28Z

integration-tests/examples/smoke_ton.toml

+[blockchain_a]
+type = "ton"


[blockchain_a] type = "ton"

What is blockchain_a?
What is type = "ton" used for, if we also configure the docker-compose.yaml file?

These are CTF configuration fields.

iiuc, blockchain_a indicates the first blockchain involved in this test setup

Here's the other test configuration involving 2 chains -- with blockchain_a and blockchain_b
https://github.com/smartcontractkit/chainlink-testing-framework/blob/96212dfb45f083f6358e7a85f4e0e85d35353168/framework/examples/myproject/chaos/chaos_reorg.toml#L7

type = "ton" is another input field used for getting the right blockchain handler
https://github.com/smartcontractkit/chainlink-testing-framework/blob/96212dfb45f083f6358e7a85f4e0e85d35353168/framework/components/blockchain/blockchain.go#L82

I’m checking how we can move this chain-specific test network implementation into chainlink-ton, then probably other integration projects would import it when they need to run tests related to TON, since these fields will likely be needed for them as well?

jadepark-dev · 2025-05-21T14:38:44Z

Closing this PR to switch to a different E2E pattern. #18 The image caching and test setup can still be reused.

jadepark-dev added 25 commits May 7, 2025 16:50

feat: init CTF GHA caching

0dfef4e

feat: login

912b9fd

feat: cache images

c9bebd5

chore: gha triggers

a115120

chore: triggering gha

1f3caad

feat: setup-golang

1f6512b

chore: triggering

06231bb

chore: disable cache on push

f9cf77f

chore: build test

e57551a

chore: build source

55338b7

chore: testing build and bake

16803b8

fix: build source

3b5cade

Revert "fix: build source"

4bd70d4

This reverts commit 3b5cade.

fix: build source

1c22f7c

fix: workdir

fdb5381

fix: source

ee9a4f0

chore: no java bulid

36025e0

chore: remove docker cache

f6f78a0

Merge branch 'main' into feature/CTF-GHA-cache

d4ae22b

chore: bump ctf

bbbee1d

fix: remove orphan script

3ac5264

fix: typo

1f192b1

chore: cache trigger

2121b81

chore: disable caching on push

325c280

chore: bump ctf@0.7.9

ac8f65b

jadepark-dev changed the title ~~[DRAFT] CTF with GHA Cache~~ [NONEVM-1712] CTF Integration with GHA Cache May 14, 2025

jadepark-dev marked this pull request as ready for review May 14, 2025 08:41

Copilot AI review requested due to automatic review settings May 14, 2025 08:41

Copilot AI reviewed May 14, 2025

View reviewed changes

krebernisak reviewed May 15, 2025

View reviewed changes

jadepark-dev added 14 commits May 16, 2025 12:50

feat: temp localnet blockchain module

3ab4b55

fix: more general input field, bump ctf

f9b8858

fix: use nix

7b3cde2

feat: local and gha baked cache

0d19fb2

test: cache on push

9cdb874

fix: remove recurring cache action

88ef652

fix: cache config name

5c7d05a

test: caching images

282f0b8

test: local cache

e599948

chore: not on pr

8187610

chore: remove deprecated ScribeMD/docker-cache

e3bc696

fix: bump ctf, rm local pkg

969856a

chore: bump ctf

4dc5092

chore: clean up

5969542

jadepark-dev closed this May 21, 2025

	uses: actions/checkout@0ad4b8fadaa221de15dcec353f45205ec38ea70b # v4.1.4
	uses: actions/checkout@v4

	key: mylocalton-images-${{ hashFiles('${{ inputs.cache-dir }}/docker-compose.yml') }}
	key: mylocalton-images-${{ hashFiles(compose_file_path) }}

		image = "https://raw.githubusercontent.com/neodix42/mylocalton-docker/main/docker-compose.yaml"
		ton_core_services = [

Conversation

jadepark-dev commented May 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Primary Changes

Others

Requires

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Copilot AI May 14, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI May 14, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jadepark-dev commented May 21, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

jadepark-dev commented May 13, 2025 •

edited

Loading