Merge pull request #681 from iotaledger/fix/docker-tests-candidate-race

Fix race condition when stopping publishing candidate payloads.

Author: piotrm50

components/restapi/core/accounts.go

@@ -269,11 +269,9 @@ func selectedCommittee(c echo.Context) (*api.CommitteeResponse, error) {
 		// by default we return current epoch
 		slot = timeProvider.SlotFromTime(time.Now())
 		epoch = timeProvider.EpochFromSlot(slot)
-	} else {
-		slot = timeProvider.EpochEnd(epoch)
 	}
 
-	seatedAccounts, exists := deps.Protocol.Engines.Main.Get().SybilProtection.SeatManager().CommitteeInSlot(slot)
+	seatedAccounts, exists := deps.Protocol.Engines.Main.Get().SybilProtection.SeatManager().CommitteeInEpoch(epoch)
 	if !exists {
 		return &api.CommitteeResponse{
 			Epoch: epoch,

tools/docker-network/docker-compose.yml

@@ -299,6 +299,7 @@ services:
       --inx.address=node-1-validator:9029
       --validator.ignoreBootstrapped=true
       --validator.accountAddress=rms1pzg8cqhfxqhq7pt37y8cs4v5u4kcc48lquy2k73ehsdhf5ukhya3y5rx2w6
+      --validator.issueCandidacyPayload=${ISSUE_CANDIDACY_PAYLOAD_V1:-true}
 
   inx-validator-2:
     image: iotaledger/inx-validator:1.0-alpha
@@ -315,6 +316,7 @@ services:
       --logger.level=debug
       --inx.address=node-2-validator:9029
       --validator.accountAddress=rms1pqm4xk8e9ny5w5rxjkvtp249tfhlwvcshyr3pc0665jvp7g3hc875k538hl
+      --validator.issueCandidacyPayload=${ISSUE_CANDIDACY_PAYLOAD_V2:-true}
 
   inx-validator-3:
     image: iotaledger/inx-validator:1.0-alpha
@@ -331,6 +333,7 @@ services:
       --logger.level=debug
       --inx.address=node-3-validator:9029
       --validator.accountAddress=rms1pp4wuuz0y42caz48vv876qfpmffswsvg40zz8v79sy8cp0jfxm4kunflcgt
+      --validator.issueCandidacyPayload=${ISSUE_CANDIDACY_PAYLOAD_V3:-true}
 
   inx-validator-4:
     image: iotaledger/inx-validator:1.0-alpha
@@ -347,7 +350,7 @@ services:
       --logger.level=debug
       --inx.address=node-4-validator:9029
       --validator.accountAddress=rms1pr8cxs3dzu9xh4cduff4dd4cxdthpjkpwmz2244f75m0urslrsvtsshrrjw
-      --logger.level=debug
+      --validator.issueCandidacyPayload=${ISSUE_CANDIDACY_PAYLOAD_V4:-true}
 
 # Create our own network
 networks:

tools/docker-network/tests/committeerotation_test.go

@@ -146,10 +146,10 @@ func Test_NoCandidacyPayload(t *testing.T) {
 		))
 	defer d.Stop()
 
-	d.AddValidatorNode("V1", "docker-network-inx-validator-1-1", "http://localhost:8050", "rms1pzg8cqhfxqhq7pt37y8cs4v5u4kcc48lquy2k73ehsdhf5ukhya3y5rx2w6")
-	d.AddValidatorNode("V2", "docker-network-inx-validator-2-1", "http://localhost:8060", "rms1pqm4xk8e9ny5w5rxjkvtp249tfhlwvcshyr3pc0665jvp7g3hc875k538hl")
-	d.AddValidatorNode("V3", "docker-network-inx-validator-3-1", "http://localhost:8070", "rms1pp4wuuz0y42caz48vv876qfpmffswsvg40zz8v79sy8cp0jfxm4kunflcgt")
-	d.AddValidatorNode("V4", "docker-network-inx-validator-4-1", "http://localhost:8040", "rms1pr8cxs3dzu9xh4cduff4dd4cxdthpjkpwmz2244f75m0urslrsvtsshrrjw")
+	d.AddValidatorNode("V1", "docker-network-inx-validator-1-1", "http://localhost:8050", "rms1pzg8cqhfxqhq7pt37y8cs4v5u4kcc48lquy2k73ehsdhf5ukhya3y5rx2w6", false)
+	d.AddValidatorNode("V2", "docker-network-inx-validator-2-1", "http://localhost:8060", "rms1pqm4xk8e9ny5w5rxjkvtp249tfhlwvcshyr3pc0665jvp7g3hc875k538hl", false)
+	d.AddValidatorNode("V3", "docker-network-inx-validator-3-1", "http://localhost:8070", "rms1pp4wuuz0y42caz48vv876qfpmffswsvg40zz8v79sy8cp0jfxm4kunflcgt", false)
+	d.AddValidatorNode("V4", "docker-network-inx-validator-4-1", "http://localhost:8040", "rms1pr8cxs3dzu9xh4cduff4dd4cxdthpjkpwmz2244f75m0urslrsvtsshrrjw", false)
 	d.AddNode("node5", "docker-network-node-5-1", "http://localhost:8090")
 
 	err := d.Run()
@@ -164,7 +164,7 @@ func Test_NoCandidacyPayload(t *testing.T) {
 	fmt.Println("First finalized slot: ", prevFinalizedSlot)
 	currentEpoch := clt.CommittedAPI().TimeProvider().EpochFromSlot(status.LatestAcceptedBlockSlot)
 
-	d.StopIssueCandidacyPayload(d.Nodes()...)
+	d.AssertCommittee(currentEpoch+1, d.AccountsFromNodes(d.Nodes()...))
 
 	// Due to no candidacy payloads, committee should be reused, remain 4 validators
 	d.AssertCommittee(currentEpoch+2, d.AccountsFromNodes(d.Nodes()...))

tools/docker-network/tests/dockerframework.go

@@ -7,6 +7,7 @@ import (
 	"crypto/ed25519"
 	"fmt"
 	"log"
+	"os"
 	"os/exec"
 	"sort"
 	"strings"
@@ -48,13 +49,14 @@ var (
 )
 
 type Node struct {
-	Name                 string
-	ContainerName        string
-	ClientURL            string
-	Client               *nodeclient.Client
-	AccountAddressBech32 string
-	ContainerConfigs     string
-	PrivateKey           string
+	Name                  string
+	ContainerName         string
+	ClientURL             string
+	Client                *nodeclient.Client
+	AccountAddressBech32  string
+	ContainerConfigs      string
+	PrivateKey            string
+	IssueCandidacyPayload bool
 }
 
 type Account struct {
@@ -115,21 +117,36 @@ func NewDockerTestFramework(t *testing.T, opts ...options.Option[DockerTestFrame
 	})
 }
 
+func (d *DockerTestFramework) DockerComposeUp(detach ...bool) error {
+	cmd := exec.Command("docker", "compose", "up")
+
+	if len(detach) > 0 && detach[0] {
+		cmd = exec.Command("docker", "compose", "up", "-d")
+	}
+
+	cmd.Env = os.Environ()
+	for _, node := range d.nodes {
+		cmd.Env = append(cmd.Env, fmt.Sprintf("ISSUE_CANDIDACY_PAYLOAD_%s=%t", node.Name, node.IssueCandidacyPayload))
+	}
+
+	var out strings.Builder
+	cmd.Stderr = &out
+	err := cmd.Run()
+	if err != nil {
+		fmt.Println("Docker compose up failed with error:", err, ":", out.String())
+	}
+
+	return err
+}
+
 func (d *DockerTestFramework) Run() error {
 	ch := make(chan error)
 	stopCh := make(chan struct{})
 	defer close(ch)
 	defer close(stopCh)
 
 	go func() {
-		cmd := exec.Command("docker", "compose", "up")
-		var out strings.Builder
-		cmd.Stderr = &out
-		err := cmd.Run()
-
-		if err != nil {
-			fmt.Println("Docker compose up failed with error:", err, ":", out.String())
-		}
+		err := d.DockerComposeUp()
 
 		// make sure that the channel is not already closed
 		select {
@@ -211,12 +228,18 @@ func (d *DockerTestFramework) WaitUntilSync() error {
 	return nil
 }
 
-func (d *DockerTestFramework) AddValidatorNode(name string, containerName string, clientURL string, accAddrBech32 string) {
+func (d *DockerTestFramework) AddValidatorNode(name string, containerName string, clientURL string, accAddrBech32 string, optIssueCandidacyPayload ...bool) {
+	issueCandidacyPayload := true
+	if len(optIssueCandidacyPayload) > 0 {
+		issueCandidacyPayload = optIssueCandidacyPayload[0]
+	}
+
 	d.nodes[name] = &Node{
-		Name:                 name,
-		ContainerName:        containerName,
-		ClientURL:            clientURL,
-		AccountAddressBech32: accAddrBech32,
+		Name:                  name,
+		ContainerName:         containerName,
+		ClientURL:             clientURL,
+		AccountAddressBech32:  accAddrBech32,
+		IssueCandidacyPayload: issueCandidacyPayload,
 	}
 }
 
@@ -273,52 +296,32 @@ func (d *DockerTestFramework) AccountsFromNodes(nodes ...*Node) []string {
 	return accounts
 }
 
-func (d *DockerTestFramework) StopIssueCandidacyPayload(nodes ...*Node) {
-	// build a new image from the current one so we could set IssueCandidacyPayload to false,
-	// the committed image will not remember the container configs, so it's fine to commit the first validator of the nodes
-	newImageName := "no-candidacy-payload-image"
-	err := exec.Command("docker", "commit", nodes[0].ContainerName, newImageName).Run()
-	require.NoError(d.Testing, err)
+func (d *DockerTestFramework) StartIssueCandidacyPayload(nodes ...*Node) {
+	if len(nodes) == 0 {
+		return
+	}
 
 	for _, node := range nodes {
-		if node.AccountAddressBech32 == "" {
-			continue
-		}
+		node.IssueCandidacyPayload = true
+	}
 
-		// stop the inx-validator that issues candidacy payload
-		err = d.StopContainer(node.ContainerName)
-		require.NoError(d.Testing, err)
+	d.DockerComposeUp(true)
+}
 
-		// start a new inx-validator that does not issue candidacy payload
-		newContainerName := fmt.Sprintf("%s-1", node.ContainerName)
-		cmd := fmt.Sprintf("docker run --network docker-network_iota-core --env %s --name %s  %s %s --validator.issueCandidacyPayload=false &", node.PrivateKey, newContainerName, newImageName, node.ContainerConfigs)
-		err = exec.Command("bash", "-c", cmd).Run()
-		require.NoError(d.Testing, err)
+func (d *DockerTestFramework) StopIssueCandidacyPayload(nodes ...*Node) {
+	if len(nodes) == 0 {
+		return
 	}
-}
 
-func (d *DockerTestFramework) StartIssueCandidacyPayload(nodes ...*Node) {
 	for _, node := range nodes {
-		if node.AccountAddressBech32 == "" {
-			continue
-		}
-
-		// stop and remove the inx-validator that does not issue candidacy payload
-		newContainerName := fmt.Sprintf("%s-1", node.ContainerName)
-		err := d.StopContainer(newContainerName)
-		require.NoError(d.Testing, err)
-
-		err = exec.Command("docker", "rm", newContainerName).Run()
-		require.NoError(d.Testing, err)
-
-		// start the inx-validator that issues candidacy payload
-		err = d.RestartContainer(node.ContainerName)
-		require.NoError(d.Testing, err)
+		node.IssueCandidacyPayload = false
 	}
+
+	d.DockerComposeUp(true)
 }
 
 func (d *DockerTestFramework) CreateAccount(opts ...options.Option[builder.AccountOutputBuilder]) *Account {
-	// create implicit account by requesting faucet funds
+	// create an implicit account by requesting faucet funds
 	ctx := context.TODO()
 	receiverAddr, implicitPrivateKey := d.getAddress(iotago.AddressImplicitAccountCreation)
 	implicitOutputID, implicitAccountOutput := d.RequestFaucetFunds(ctx, receiverAddr)
@@ -327,10 +330,10 @@ func (d *DockerTestFramework) CreateAccount(opts ...options.Option[builder.Accou
 	accountAddress, ok := accountID.ToAddress().(*iotago.AccountAddress)
 	require.True(d.Testing, ok)
 
-	// make sure implicit account is committed
+	// make sure an implicit account is committed
 	d.CheckAccountStatus(ctx, iotago.EmptyBlockID, implicitOutputID.TransactionID(), implicitOutputID, accountAddress)
 
-	// transition to full account with new Ed25519 address and staking feature
+	// transition to a full account with new Ed25519 address and staking feature
 	accEd25519Addr, accPrivateKey := d.getAddress(iotago.AddressEd25519)
 	accBlockIssuerKey := iotago.Ed25519PublicKeyHashBlockIssuerKeyFromPublicKey(accPrivateKey.Public().(ed25519.PublicKey))
 	accountOutput := options.Apply(builder.NewAccountOutputBuilder(accEd25519Addr, implicitAccountOutput.BaseTokenAmount()),