Skip to content

[CRE-1083] add option to not cleanup docker containers on error #19944

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from
+27 −20
Open

[CRE-1083] add option to not cleanup docker containers on error #19944

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
255f54d
add option to not cleanup docker containers on error. test it out in CI
Tofel Oct 17, 2025
d131860
remove test error
Tofel Oct 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions .github/workflows/cre-system-tests.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,12 +207,13 @@ jobs:
cd core/scripts/cre/environment

# Start CRE with the appropriate contracts version (i.e. Workflow/CapabilityRegistry)
# Do not remove Docker containers on error to allow log collection
if [[ "${CRE_VERSION}" == "v1" ]]; then
echo "Starting CRE with v1 contracts for test: '${TEST_NAME}'"
go run . env start --with-plugins-docker-image "${E2E_TEST_CHAINLINK_IMAGE}:${E2E_TEST_CHAINLINK_VERSION}"
go run . env start --with-plugins-docker-image "${E2E_TEST_CHAINLINK_IMAGE}:${E2E_TEST_CHAINLINK_VERSION}" --cleanup-on-error=false
else
echo "Starting CRE with v2 contracts for test: '${TEST_NAME}'"
go run . env start --with-plugins-docker-image "${E2E_TEST_CHAINLINK_IMAGE}:${E2E_TEST_CHAINLINK_VERSION}" --with-contracts-version v2
go run . env start --with-plugins-docker-image "${E2E_TEST_CHAINLINK_IMAGE}:${E2E_TEST_CHAINLINK_VERSION}" --with-contracts-version v2 --cleanup-on-error=false
fi

exit_code=$?
Expand Down
42 changes: 24 additions & 18 deletions core/scripts/cre/environment/environment/environment.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ var StartCmdPreRunFunc = func(cmd *cobra.Command, args []string) {
}()
}

var StartCmdRecoverHandlerFunc = func(p any, cleanupWait time.Duration) {
var StartCmdRecoverHandlerFunc = func(p any, cleanupOnFailure bool, cleanupWait time.Duration) {
if p != nil {
fmt.Println("Panicked when starting environment")

Expand All @@ -163,15 +163,17 @@ var StartCmdRecoverHandlerFunc = func(p any, cleanupWait time.Duration) {
fmt.Fprintf(os.Stderr, "failed to track startup: %s\n", tracingErr)
}

waitToCleanUp(cleanupWait)
_, saveErr := framework.SaveContainerLogs("./logs")
if saveErr != nil {
fmt.Fprintf(os.Stderr, "failed to save container logs: %s\n", saveErr)
}
if cleanupOnFailure {
waitToCleanUp(cleanupWait)
_, saveErr := framework.SaveContainerLogs("./logs")
if saveErr != nil {
fmt.Fprintf(os.Stderr, "failed to save container logs: %s\n", saveErr)
}

removeErr := framework.RemoveTestContainers()
if removeErr != nil {
fmt.Fprint(os.Stderr, errors.Wrap(removeErr, manualCtfCleanupMsg).Error())
removeErr := framework.RemoveTestContainers()
if removeErr != nil {
fmt.Fprint(os.Stderr, errors.Wrap(removeErr, manualCtfCleanupMsg).Error())
}
}

// signal that the environment failed to start
Expand Down Expand Up @@ -230,6 +232,7 @@ func startCmd() *cobra.Command {
withPluginsDockerImage string
withContractsVersion string
doSetup bool
cleanupOnFailure bool
cleanupWait time.Duration
withBeholder bool
withDashboards bool
Expand All @@ -246,7 +249,7 @@ func startCmd() *cobra.Command {
PersistentPreRun: StartCmdPreRunFunc,
RunE: func(cmd *cobra.Command, args []string) error {
defer func() {
StartCmdRecoverHandlerFunc(recover(), cleanupWait)
StartCmdRecoverHandlerFunc(recover(), cleanupOnFailure, cleanupWait)
}()

if doSetup {
Expand Down Expand Up @@ -338,15 +341,17 @@ func startCmd() *cobra.Command {
fmt.Fprintf(os.Stderr, "failed to track startup: %s\n", dxErr)
}

waitToCleanUp(cleanupWait)
_, saveErr := framework.SaveContainerLogs("./logs")
if saveErr != nil {
fmt.Fprintf(os.Stderr, "failed to save container logs: %s\n", saveErr)
}
if cleanupOnFailure {
waitToCleanUp(cleanupWait)
_, saveErr := framework.SaveContainerLogs("./logs")
if saveErr != nil {
fmt.Fprintf(os.Stderr, "failed to save container logs: %s\n", saveErr)
}

removeErr := framework.RemoveTestContainers()
if removeErr != nil {
return errors.Wrap(removeErr, manualCtfCleanupMsg)
removeErr := framework.RemoveTestContainers()
if removeErr != nil {
return errors.Wrap(removeErr, manualCtfCleanupMsg)
}
}

return errors.Wrap(startErr, "failed to start environment")
Expand Down Expand Up @@ -480,6 +485,7 @@ func startCmd() *cobra.Command {

cmd.Flags().StringVarP(&topology, "topology", "t", TopologyWorkflow, "Topology to use for the environment (workflow, workflow-gateway, workflow-gateway-capabilities)")
cmd.Flags().DurationVarP(&cleanupWait, "wait-on-error-timeout", "w", 15*time.Second, "Wait on error timeout (e.g. 10s, 1m, 1h)")
cmd.Flags().BoolVarP(&cleanupOnFailure, "cleanup-on-error", "l", false, "Whether to remove Docker containers if startup fails")
cmd.Flags().IntSliceVarP(&extraAllowedGatewayPorts, "extra-allowed-gateway-ports", "e", []int{}, "Extra allowed ports for outgoing connections from the Gateway DON (e.g. 8080,8081)")
cmd.Flags().BoolVarP(&withExampleFlag, "with-example", "x", false, "Deploy and register example workflow")
cmd.Flags().DurationVarP(&exampleWorkflowTimeout, "example-workflow-timeout", "u", 5*time.Minute, "Time to wait until example workflow succeeds")
Expand Down
Loading