Merge branch 'main' of github.com:smartcontractkit/chainlink-testing-framework into flakeguardAggregations

kalverra · kalverra · commit 03a17b03cbb6 · 2024-11-25T17:45:09.000-05:00
diff --git a/book/src/framework/components/configuration.md b/book/src/framework/components/configuration.md
@@ -35,11 +35,10 @@ In `TOML`:
 ```
 [blockchain_a]
 chain_id = "31337"
-docker_cmd_params = ["--block-time=1"]
-image = "f4hrenh9it/foundry"
+image = "f4hrenh9it/foundry:latest"
 port = "8500"
-tag = "latest"
 type = "anvil"
+docker_cmd_params = ["-b", "1"]
 ```
 
 ### Best practices for configuration and validation
diff --git a/book/src/framework/connecting_chainlink_node.md b/book/src/framework/connecting_chainlink_node.md
@@ -9,6 +9,8 @@ Create your configuration in `smoke.toml`
   image = "f4hrenh9it/foundry:latest"
   port = "8545"
   type = "anvil"
+  docker_cmd_params = ["-b", "1"]
+
 
 [cl_node]
 
diff --git a/book/src/framework/first_test.md b/book/src/framework/first_test.md
@@ -11,6 +11,7 @@ Create your configuration in `smoke.toml`
   image = "f4hrenh9it/foundry:latest"
   port = "8545"
   type = "anvil"
+  docker_cmd_params = ["-b", "1"]
 ```
 
 Create your test in `smoke_test.go`
diff --git a/book/src/framework/nodeset_capabilities.md b/book/src/framework/nodeset_capabilities.md
@@ -21,6 +21,7 @@ Create a configuration file `smoke.toml`
   image = "f4hrenh9it/foundry:latest"
   port = "8545"
   type = "anvil"
+  docker_cmd_params = ["-b", "1"]
 
 [nodeset]
   nodes = 5
diff --git a/book/src/framework/nodeset_compatibility.md b/book/src/framework/nodeset_compatibility.md
@@ -9,6 +9,7 @@ Create a configuration file `smoke.toml`
   image = "f4hrenh9it/foundry:latest"
   port = "8545"
   type = "anvil"
+  docker_cmd_params = ["-b", "1"]
 
 [nodeset]
   nodes = 5
diff --git a/book/src/framework/nodeset_docker_rebuild.md b/book/src/framework/nodeset_docker_rebuild.md
@@ -9,6 +9,7 @@ Create a configuration file `smoke.toml`
   image = "f4hrenh9it/foundry:latest"
   port = "8545"
   type = "anvil"
+  docker_cmd_params = ["-b", "1"]
 
 [nodeset]
   nodes = 5
diff --git a/book/src/framework/nodeset_environment.md b/book/src/framework/nodeset_environment.md
@@ -9,6 +9,8 @@ Create a configuration file `smoke.toml`
   image = "f4hrenh9it/foundry:latest"
   port = "8545"
   type = "anvil"
+  docker_cmd_params = ["-b", "1"]
+
 
 [nodeset]
   nodes = 5
diff --git a/framework/.changeset/v0.2.9.md b/framework/.changeset/v0.2.9.md
@@ -0,0 +1,2 @@
+- Zero seconds block and anvil mining control example
+- (Bug-fix) Always remove container registry if stopped
diff --git a/framework/CONFIGURATION.md b/framework/CONFIGURATION.md
@@ -35,11 +35,10 @@ In `TOML`:
 ```
 [blockchain_a]
 chain_id = "31337"
-docker_cmd_params = ["--block-time=1"]
-image = "f4hrenh9it/foundry"
+image = "f4hrenh9it/foundry:latest"
 port = "8500"
-tag = "latest"
 type = "anvil"
+docker_cmd_params = ["-b", "1"]
 ```
 
 ### Best practices for configuration and validation
diff --git a/framework/components/blockchain/anvil.go b/framework/components/blockchain/anvil.go
@@ -20,7 +20,7 @@ const (
 func deployAnvil(in *Input) (*Output, error) {
 	ctx := context.Background()
 	entryPoint := []string{"anvil"}
-	defaultCmd := []string{"--host", "0.0.0.0", "--port", in.Port, "--chain-id", in.ChainID, "-b", "1"}
+	defaultCmd := []string{"--host", "0.0.0.0", "--port", in.Port, "--chain-id", in.ChainID}
 	entryPoint = append(entryPoint, defaultCmd...)
 	entryPoint = append(entryPoint, in.DockerCmdParamsOverrides...)
 	framework.L.Info().Any("Cmd", strings.Join(entryPoint, " ")).Msg("Creating anvil with command")
diff --git a/framework/docker.go b/framework/docker.go
@@ -76,6 +76,9 @@ func BuildAndPublishLocalDockerImage(once *sync.Once, dockerfile string, buildCo
 		if registryRunning {
 			fmt.Println("Local registry container is already running.")
 		} else {
+			L.Info().Msg("Removing local registry")
+			_ = runCommand("docker", "stop", "local-registry")
+			_ = runCommand("docker", "rm", "local-registry")
 			L.Info().Msg("Starting local registry container...")
 			err := runCommand("docker", "run", "-d", "-p", "5050:5000", "--name", "local-registry", "registry:2")
 			if err != nil {
diff --git a/framework/examples/myproject/chaos.toml b/framework/examples/myproject/chaos.toml
@@ -4,6 +4,7 @@
   image = "f4hrenh9it/foundry:latest"
   port = "8545"
   type = "anvil"
+  docker_cmd_params = ["-b", "1"]
 
 [data_provider]
   port = 9111
diff --git a/framework/examples/myproject/example_components/onchain/deployment.go b/framework/examples/myproject/example_components/onchain/deployment.go
@@ -1,12 +1,9 @@
 package onchain
 
 import (
-	"github.com/smartcontractkit/chainlink-testing-framework/framework/components/blockchain"
+	"github.com/ethereum/go-ethereum/common"
 	testToken "github.com/smartcontractkit/chainlink-testing-framework/framework/examples/example_components/gethwrappers"
 	"math/big"
-	"time"
-
-	"github.com/ethereum/go-ethereum/common"
 
 	"github.com/smartcontractkit/chainlink-testing-framework/seth"
 )
@@ -21,26 +18,13 @@ type Output struct {
 	Addresses []common.Address `toml:"addresses"`
 }
 
-func NewProductOnChainDeployment(in *Input) (*Output, error) {
+func NewProductOnChainDeployment(c *seth.Client, in *Input) (*Output, error) {
 	if in.Out != nil && in.Out.UseCache {
 		return in.Out, nil
 	}
 
 	// deploy your contracts here, example
 
-	t := seth.Duration{D: 2 * time.Minute}
-
-	c, err := seth.NewClientBuilder().
-		WithRpcUrl(in.URL).
-		WithProtections(true, false, &t).
-		WithGasPriceEstimations(true, 0, seth.Priority_Fast).
-		WithTracing(seth.TracingLevel_All, []string{seth.TraceOutput_Console}).
-		WithPrivateKeys([]string{blockchain.DefaultAnvilPrivateKey}).
-		Build()
-	if err != nil {
-		return nil, err
-	}
-
 	contractABI, err := testToken.BurnMintERC677MetaData.GetAbi()
 	if err != nil {
 		return nil, err
@@ -64,6 +48,6 @@ func NewProductOnChainDeployment(in *Input) (*Output, error) {
 		// save all the addresses to output, so it can be cached
 		Addresses: []common.Address{dd.Address},
 	}
-	in.Out = out
+	//in.Out = out
 	return out, nil
 }
diff --git a/framework/examples/myproject/fork.toml b/framework/examples/myproject/fork.toml
@@ -7,10 +7,12 @@
   image = "f4hrenh9it/foundry:latest"
   port = "8545"
   type = "anvil"
+  docker_cmd_params = ["-b", "1"]
 
 [blockchain_src]
   chain_id = "3337"
 #  docker_cmd_params = ["--fork-url", "wss://avalanche-fuji-c-chain-rpc.publicnode.com", "--auto-impersonate"]
   image = "f4hrenh9it/foundry:latest"
   port = "8555"
   type = "anvil"
+  docker_cmd_params = ["-b", "1"]
diff --git a/framework/examples/myproject/fork_plus_offchain.toml b/framework/examples/myproject/fork_plus_offchain.toml
@@ -7,14 +7,15 @@
   image = "f4hrenh9it/foundry:latest"
   port = "8545"
   type = "anvil"
+ docker_cmd_params = ["-b", "1"]
 
 [blockchain_src]
   chain_id = "3337"
 #  docker_cmd_params = ["--fork-url", "wss://avalanche-fuji-c-chain-rpc.publicnode.com", "--auto-impersonate"]
   image = "f4hrenh9it/foundry:latest"
   port = "8555"
   type = "anvil"
-
+  docker_cmd_params = ["-b", "1"]
 
 [nodeset]
   nodes = 5
diff --git a/framework/examples/myproject/fork_plus_offchain_test.go b/framework/examples/myproject/fork_plus_offchain_test.go
@@ -81,10 +81,10 @@ func TestOffChainAndFork(t *testing.T) {
 	// deploy 2 example product contracts
 	// you should replace it with chainlink-deployments
 	in.ContractsSrc.URL = bcSrc.Nodes[0].HostWSUrl
-	contractsSrc, err := onchain.NewProductOnChainDeployment(in.ContractsSrc)
+	contractsSrc, err := onchain.NewProductOnChainDeployment(scSrc, in.ContractsSrc)
 	require.NoError(t, err)
 	in.ContractsDst.URL = bcDst.Nodes[0].HostWSUrl
-	contractsDst, err := onchain.NewProductOnChainDeployment(in.ContractsDst)
+	contractsDst, err := onchain.NewProductOnChainDeployment(scDst, in.ContractsDst)
 	require.NoError(t, err)
 
 	t.Run("test some contracts with fork", func(t *testing.T) {
diff --git a/framework/examples/myproject/fork_test.go b/framework/examples/myproject/fork_test.go
@@ -47,10 +47,10 @@ func TestFork(t *testing.T) {
 	// deploy 2 example product contracts
 	// you can replace it with chainlink-deployments
 	in.ContractsSrc.URL = bcSrc.Nodes[0].HostWSUrl
-	contractsSrc, err := onchain.NewProductOnChainDeployment(in.ContractsSrc)
+	contractsSrc, err := onchain.NewProductOnChainDeployment(scSrc, in.ContractsSrc)
 	require.NoError(t, err)
 	in.ContractsDst.URL = bcDst.Nodes[0].HostWSUrl
-	contractsDst, err := onchain.NewProductOnChainDeployment(in.ContractsDst)
+	contractsDst, err := onchain.NewProductOnChainDeployment(scDst, in.ContractsDst)
 	require.NoError(t, err)
 
 	t.Run("test some contracts with fork", func(t *testing.T) {
diff --git a/framework/examples/myproject/quick-deploy.toml b/framework/examples/myproject/quick-deploy.toml
@@ -0,0 +1,7 @@
+[contracts_src]
+
+[blockchain_src]
+  chain_id = "3337"
+  image = "f4hrenh9it/foundry:latest"
+  port = "8545"
+  type = "anvil"
diff --git a/framework/examples/myproject/quick_deploy_test.go b/framework/examples/myproject/quick_deploy_test.go
@@ -0,0 +1,59 @@
+package examples
+
+import (
+	"github.com/ethereum/go-ethereum/crypto"
+	"github.com/ethereum/go-ethereum/ethclient"
+	"github.com/smartcontractkit/chainlink-testing-framework/framework"
+	"github.com/smartcontractkit/chainlink-testing-framework/framework/components/blockchain"
+	"github.com/smartcontractkit/chainlink-testing-framework/framework/components/simple_node_set"
+	"github.com/smartcontractkit/chainlink-testing-framework/framework/examples/example_components/onchain"
+	"github.com/smartcontractkit/chainlink-testing-framework/framework/rpc"
+	"github.com/stretchr/testify/require"
+	"math/big"
+	"testing"
+	"time"
+)
+
+type CfgQuickDeploy struct {
+	ContractsSrc  *onchain.Input    `toml:"contracts_src" validate:"required"`
+	BlockchainSrc *blockchain.Input `toml:"blockchain_src" validate:"required"`
+}
+
+func randAddr() (string, error) {
+	privateKey, err := crypto.GenerateKey()
+	if err != nil {
+		return "", err
+	}
+	publicKey := privateKey.PublicKey
+	address := crypto.PubkeyToAddress(publicKey).Hex()
+	return address, nil
+}
+
+func TestQuickDeploy(t *testing.T) {
+	in, err := framework.Load[CfgQuickDeploy](t)
+	require.NoError(t, err)
+
+	// spin up 2 anvils
+	bcSrc, err := blockchain.NewBlockchainNetwork(in.BlockchainSrc)
+	require.NoError(t, err)
+
+	// deploy 2 example product contracts
+	// you can replace it with chainlink-deployments
+	in.ContractsSrc.URL = bcSrc.Nodes[0].HostWSUrl
+	c, err := ethclient.Dial(bcSrc.Nodes[0].HostWSUrl)
+	require.NoError(t, err)
+
+	t.Run("make 100 transactions with 0s blocks then control the speed", func(t *testing.T) {
+		for i := 0; i < 100; i++ {
+			ra, err := randAddr()
+			require.NoError(t, err)
+			err = simple_node_set.SendETH(c, blockchain.DefaultAnvilPrivateKey, ra, big.NewFloat(0.1))
+			require.NoError(t, err)
+		}
+		t.Log("now mining")
+
+		miner := rpc.NewRemoteAnvilMiner(bcSrc.Nodes[0].HostHTTPUrl, nil)
+		miner.MinePeriodically(200 * time.Millisecond)
+		time.Sleep(10 * time.Second)
+	})
+}
diff --git a/framework/examples/myproject/scalability.toml b/framework/examples/myproject/scalability.toml
@@ -4,6 +4,7 @@
   image = "f4hrenh9it/foundry:latest"
   port = "8545"
   type = "anvil"
+  docker_cmd_params = ["-b", "1"]
 
 [data_provider]
   port = 9111
diff --git a/framework/examples/myproject/smoke.toml b/framework/examples/myproject/smoke.toml
@@ -4,6 +4,7 @@
   image = "f4hrenh9it/foundry:latest"
   port = "8545"
   type = "anvil"
+  docker_cmd_params = ["-b", "1"]
 
 [data_provider]
   port = 9111
diff --git a/framework/examples/myproject/upgrade.toml b/framework/examples/myproject/upgrade.toml
@@ -4,6 +4,7 @@
   image = "f4hrenh9it/foundry:latest"
   port = "8545"
   type = "anvil"
+  docker_cmd_params = ["-b", "1"]
 
 [data_provider]
   port = 9111
diff --git a/framework/go.mod b/framework/go.mod
@@ -2,6 +2,8 @@ module github.com/smartcontractkit/chainlink-testing-framework/framework
 
 go 1.22
 
+replace github.com/smartcontractkit/chainlink-testing-framework/seth => ../seth
+
 require (
 	github.com/aws/aws-sdk-go-v2/config v1.27.39
 	github.com/aws/aws-sdk-go-v2/service/secretsmanager v1.33.3
diff --git a/go.md b/go.md
@@ -8,6 +8,7 @@ flowchart LR
 	chainlink-testing-framework/framework
 	click chainlink-testing-framework/framework href "https://github.com/smartcontractkit/chainlink-testing-framework"
 	chainlink-testing-framework/framework/examples --> chainlink-testing-framework/framework
+	chainlink-testing-framework/framework/examples --> chainlink-testing-framework/seth
 	chainlink-testing-framework/framework/examples --> chainlink-testing-framework/wasp
 	click chainlink-testing-framework/framework/examples href "https://github.com/smartcontractkit/chainlink-testing-framework"
 	chainlink-testing-framework/grafana
diff --git a/lib/go.md b/lib/go.md
diff --git a/lib/go.mod b/lib/go.mod
@@ -327,6 +327,8 @@ require (
 )
 
 retract (
+	// all of these tags were used, when testing new structure of the repository and by no mean represent latest versions
 	[v1.999.0-test-release, v1.999.999-test-release]
+	[v1.99.1, v1.99.9]
 	v1.50.0
 )
diff --git a/tools/flakeguard/cmd/run.go b/tools/flakeguard/cmd/run.go
@@ -26,6 +26,8 @@ var RunTestsCmd = &cobra.Command{
 		maxPassRatio, _ := cmd.Flags().GetFloat64("max-pass-ratio")
 		skipTests, _ := cmd.Flags().GetStringSlice("skip-tests")
 		printFailedTests, _ := cmd.Flags().GetBool("print-failed-tests")
+		useShuffle, _ := cmd.Flags().GetBool("shuffle")
+		shuffleSeed, _ := cmd.Flags().GetString("shuffle-seed")
 
 		// Check if project dependencies are correctly set up
 		if err := checkDependencies(projectPath); err != nil {
@@ -50,6 +52,8 @@ var RunTestsCmd = &cobra.Command{
 			UseRace:              useRace,
 			SkipTests:            skipTests,
 			SelectedTestPackages: testPackages,
+			UseShuffle:           useShuffle,
+			ShuffleSeed:          shuffleSeed,
 		}
 
 		testReport, err := runner.RunTests()
@@ -93,6 +97,8 @@ func init() {
 	RunTestsCmd.Flags().Bool("run-all-packages", false, "Run all test packages in the project. This flag overrides --test-packages and --test-packages-json")
 	RunTestsCmd.Flags().IntP("run-count", "c", 1, "Number of times to run the tests")
 	RunTestsCmd.Flags().Bool("race", false, "Enable the race detector")
+	RunTestsCmd.Flags().Bool("shuffle", false, "Enable test shuffling")
+	RunTestsCmd.Flags().String("shuffle-seed", "", "Set seed for test shuffling. Must be used with --shuffle")
 	RunTestsCmd.Flags().Bool("fail-fast", false, "Stop on the first test failure")
 	RunTestsCmd.Flags().String("output-json", "", "Path to output the test results in JSON format")
 	RunTestsCmd.Flags().StringSlice("skip-tests", nil, "Comma-separated list of test names to skip from running")
diff --git a/tools/flakeguard/runner/runner.go b/tools/flakeguard/runner/runner.go
@@ -29,6 +29,8 @@ type Runner struct {
 	Verbose              bool     // If true, provides detailed logging.
 	RunCount             int      // Number of times to run the tests.
 	UseRace              bool     // Enable race detector.
+	UseShuffle           bool     // Enable test shuffling. -shuffle=on flag.
+	ShuffleSeed          string   // Set seed for test shuffling -shuffle={seed} flag. Must be used with UseShuffle.
 	FailFast             bool     // Stop on first test failure.
 	SkipTests            []string // Test names to exclude.
 	SelectedTestPackages []string // Explicitly selected packages to run.
@@ -99,6 +101,13 @@ func (r *Runner) runTests(packageName string) (string, bool, error) {
 	if r.UseRace {
 		args = append(args, "-race")
 	}
+	if r.UseShuffle {
+		if r.ShuffleSeed != "" {
+			args = append(args, fmt.Sprintf("-shuffle=%s", r.ShuffleSeed))
+		} else {
+			args = append(args, "-shuffle=on")
+		}
+	}
 	if len(r.SkipTests) > 0 {
 		skipPattern := strings.Join(r.SkipTests, "|")
 		args = append(args, fmt.Sprintf("-skip=%s", skipPattern))

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+- Zero seconds block and anvil mining control example`
	`2`	`+- (Bug-fix) Always remove container registry if stopped`