fix: test flakyness for solana program loading

Author: ecPablo

legacy/pkg/family/solana/testutils/artifacts.go

@@ -3,34 +3,8 @@ package soltestutils
 import (
 	"os"
 	"path/filepath"
-	"sync"
-	"testing"
-
-	"github.com/stretchr/testify/require"
-
-	"github.com/smartcontractkit/cld-changesets/legacy/pkg/family/solana/solutils"
 )
 
-var (
-	onceCCIP = &sync.Once{}
-)
-
-type downloadFunc func(t *testing.T) string
-
-// downloadChainlinkCCIPProgramArtifacts downloads CCIP Solana artifacts (includes MCMS programs).
-func downloadChainlinkCCIPProgramArtifacts(t *testing.T) string {
-	t.Helper()
-
-	cachePath := programsCacheDir()
-
-	onceCCIP.Do(func() {
-		err := solutils.DownloadChainlinkCCIPProgramArtifacts(t.Context(), cachePath, "", nil)
-		require.NoError(t, err)
-	})
-
-	return cachePath
-}
-
 // programsCacheDir returns where to store downloaded .so files. Leaf dir is solana_programs
 // (under UserCacheDir/TempDir, so "cache" is implied; avoids read-only pkg/mod paths).
 func programsCacheDir() string {

legacy/pkg/family/solana/testutils/preload.go

@@ -1,9 +1,8 @@
 package soltestutils
 
 import (
-	"io"
-	"os"
 	"path/filepath"
+	"sync"
 	"testing"
 
 	"github.com/stretchr/testify/require"
@@ -13,71 +12,58 @@ import (
 	"github.com/smartcontractkit/cld-changesets/legacy/pkg/family/solana/solutils"
 )
 
-// LoadMCMSPrograms loads the MCMS program artifacts into the given directory.
-//
-// Returns the path to the temporary test directory and a map of program names to IDs.
-func LoadMCMSPrograms(t *testing.T, dir string) (string, map[string]string) {
+// programIDMu serializes Solana integration tests that mutate global gobinding
+// program IDs via SetProgramID. solana-go bindings use process-wide state, so
+// parallel package tests otherwise race and fail with "Program is not deployed".
+var programIDMu sync.Mutex
+
+var (
+	mcmsProgramsOnce sync.Once
+	mcmsProgramsPath string
+	mcmsProgramIDs   map[string]string
+)
+
+// sharedMCMSPrograms downloads MCMS Solana program artifacts once per test process
+// and returns the shared cache directory plus program IDs.
+func sharedMCMSPrograms(t *testing.T) (string, map[string]string) {
 	t.Helper()
 
-	progIDs := loadProgramArtifacts(t,
-		solutils.MCMSProgramNames, downloadChainlinkCCIPProgramArtifacts, dir,
-	)
+	mcmsProgramsOnce.Do(func() {
+		mcmsProgramsPath = programsCacheDir()
+		err := solutils.DownloadChainlinkCCIPProgramArtifacts(t.Context(), mcmsProgramsPath, "", nil)
+		require.NoError(t, err)
+
+		mcmsProgramIDs = make(map[string]string, len(solutils.MCMSProgramNames))
+		for _, name := range solutils.MCMSProgramNames {
+			id := solutils.GetProgramID(name)
+			require.NotEmpty(t, id, "program id not found for program name: %s", name)
+			require.FileExists(t, filepath.Join(mcmsProgramsPath, name+".so"))
+			mcmsProgramIDs[name] = id
+		}
+	})
+
+	return mcmsProgramsPath, copyProgramIDs(mcmsProgramIDs)
+}
+
+func copyProgramIDs(src map[string]string) map[string]string {
+	dst := make(map[string]string, len(src))
+	for name, id := range src {
+		dst[name] = id
+	}
 
-	return dir, progIDs
+	return dst
 }
 
 // PreloadMCMS provides a convenience function to preload the MCMS program artifacts and address
 // book for a given selector.
 func PreloadMCMS(t *testing.T, selector uint64) (string, map[string]string, *cldf.AddressBookMap) {
 	t.Helper()
 
-	dir := t.TempDir()
-
-	_, programIDs := LoadMCMSPrograms(t, dir)
+	programIDMu.Lock()
+	t.Cleanup(programIDMu.Unlock)
 
+	programsPath, programIDs := sharedMCMSPrograms(t)
 	ab := PreloadAddressBookWithMCMSPrograms(t, selector)
 
-	return dir, programIDs, ab
-}
-
-// loadProgramArtifacts is a helper function that loads program artifacts into a temporary test directory.
-// It downloads artifacts using the provided download function and copies the specified programs.
-//
-// Returns the map of program names to IDs.
-func loadProgramArtifacts(t *testing.T, programNames []string, downloadFn downloadFunc, targetDir string) map[string]string {
-	t.Helper()
-
-	// Download the program artifacts using the provided download function
-	cachePath := downloadFn(t)
-
-	progIDs := make(map[string]string, len(programNames))
-
-	// Copy the specific artifacts to the target directory and add the program ID to the map
-	for _, name := range programNames {
-		id := solutils.GetProgramID(name)
-		require.NotEmpty(t, id, "program id not found for program name: %s", name)
-
-		src := filepath.Join(cachePath, name+".so")
-		dst := filepath.Join(targetDir, name+".so")
-
-		func() {
-			srcFile, err := os.Open(src)
-			require.NoError(t, err)
-			defer srcFile.Close()
-
-			dstFile, err := os.Create(dst)
-			require.NoError(t, err)
-			defer dstFile.Close()
-
-			_, err = io.Copy(dstFile, srcFile)
-			require.NoError(t, err)
-		}()
-
-		// Add the program ID to the map
-		progIDs[name] = id
-		t.Logf("copied solana program %s to %s", name, dst)
-	}
-
-	// Return the path to the cached artifacts and the map of program IDs
-	return progIDs
+	return programsPath, programIDs, ab
 }