CR: remove KmdJSONOverride, add LibGoalFixture override

Author: algorandskiy

netdeploy/network.go

@@ -78,6 +78,13 @@ func OverrideConsensusVersion(ver protocol.ConsensusVersion) TemplateOverride {
 	}
 }
 
+// OverrideKmdConfig changes the KMD config.
+func OverrideKmdConfig(kmdConfig TemplateKMDConfig) TemplateOverride {
+	return func(template *NetworkTemplate) {
+		template.kmdConfig = kmdConfig
+	}
+}
+
 // CreateNetworkFromTemplate uses the specified template to deploy a new private network
 // under the specified root directory.
 func CreateNetworkFromTemplate(name, rootDir string, templateReader io.Reader, binDir string, importKeys bool, nodeExitCallback nodecontrol.AlgodExitErrorCallback, consensus config.ConsensusProtocols, overrides ...TemplateOverride) (Network, error) {

netdeploy/networkTemplate.go

@@ -43,6 +43,15 @@ type NetworkTemplate struct {
 	Genesis   gen.GenesisData
 	Nodes     []remote.NodeConfigGoal
 	Consensus config.ConsensusProtocols
+	kmdConfig TemplateKMDConfig
+}
+
+// TemplateKMDConfig is a subset of the kmd configuration that can be overridden in the network template
+// by using OverrideKmdConfig TemplateOverride opts.
+// The reason why config.KMDConfig cannot be used directly is that it contains DataDir field which is
+// is not known until the template instantiation.
+type TemplateKMDConfig struct {
+	SessionLifetimeSecs uint64
 }
 
 var defaultNetworkTemplate = NetworkTemplate{
@@ -133,13 +142,13 @@ func (t NetworkTemplate) createNodeDirectories(targetFolder string, binDir strin
 		}
 
 		var kmdDir string
-		if len(cfg.KmdJSONOverride) > 0 {
+		if (t.kmdConfig != TemplateKMDConfig{}) {
 			kmdDir = filepath.Join(nodeDir, libgoal.DefaultKMDDataDir)
 			err = os.MkdirAll(kmdDir, 0700) // kmd requires 700 permissions
 			if err != nil {
 				return
 			}
-			err = createKMDConfigFile(cfg, kmdDir)
+			err = createKMDConfigFile(t.kmdConfig, kmdDir)
 			if err != nil {
 				return
 			}
@@ -268,15 +277,6 @@ func (t NetworkTemplate) Validate() error {
 		}
 	}
 
-	// Validate KmdJSONOverride decoding
-	for _, cfg := range t.Nodes {
-		kmdconf := kmdconfig.KMDConfig{}
-		err := decodeJSONOverride(cfg.KmdJSONOverride, &kmdconf)
-		if err != nil {
-			return fmt.Errorf("invalid template: unable to decode KmdJSONOverride: %w", err)
-		}
-	}
-
 	// Follow nodes cannot be relays
 	// Relays cannot have peer list
 	for _, cfg := range t.Nodes {
@@ -368,12 +368,8 @@ func createConfigFile(node remote.NodeConfigGoal, configFile string, numNodes in
 	return cfg, cfg.SaveToFile(configFile)
 }
 
-func createKMDConfigFile(node remote.NodeConfigGoal, kmdDir string) error {
+func createKMDConfigFile(kmdConfig TemplateKMDConfig, kmdDir string) error {
 	cfg := kmdconfig.DefaultConfig(kmdDir)
-	err := decodeJSONOverride(node.KmdJSONOverride, &cfg)
-	if err != nil {
-		return err
-	}
-
+	cfg.SessionLifetimeSecs = kmdConfig.SessionLifetimeSecs
 	return kmdconfig.SaveKMDConfig(kmdDir, cfg)
 }

netdeploy/networkTemplates_test.go

@@ -238,20 +238,6 @@ func TestDevModeValidate(t *testing.T) {
 		require.ErrorContains(t, tmpl.Validate(), "unable to decode ConfigJSONOverride")
 	})
 
-	t.Run("KmdJSONOverride does not parse", func(t *testing.T) {
-		t.Parallel()
-		tmpl := NetworkTemplate{
-			Genesis: devmodeGenesis,
-			Nodes: []remote.NodeConfigGoal{
-				{
-					IsRelay:         false,
-					KmdJSONOverride: "DOES NOT PARSE",
-				},
-			},
-		}
-		require.ErrorContains(t, tmpl.Validate(), "unable to decode KmdJSONOverride")
-	})
-
 	t.Run("ConfigJSONOverride unknown key", func(t *testing.T) {
 		t.Parallel()
 		tmpl := NetworkTemplate{
@@ -266,20 +252,6 @@ func TestDevModeValidate(t *testing.T) {
 		require.ErrorContains(t, tmpl.Validate(), "json: unknown field \"Unknown Key\"")
 	})
 
-	t.Run("KmdJSONOverride unknown key", func(t *testing.T) {
-		t.Parallel()
-		tmpl := NetworkTemplate{
-			Genesis: devmodeGenesis,
-			Nodes: []remote.NodeConfigGoal{
-				{
-					IsRelay:         false,
-					KmdJSONOverride: "{\"Unknown Key\": \"Valid JSON\"}",
-				},
-			},
-		}
-		require.ErrorContains(t, tmpl.Validate(), "json: unknown field \"Unknown Key\"")
-	})
-
 	t.Run("Valid multi-node DevMode", func(t *testing.T) {
 		t.Parallel()
 		tmpl := NetworkTemplate{

netdeploy/remote/nodeConfig.go

@@ -63,6 +63,5 @@ type NodeConfigGoal struct {
 	P2PPeerID          string `json:",omitempty"`
 	DeadlockDetection  int    `json:"-"`
 	ConfigJSONOverride string `json:",omitempty"` // Raw json to merge into config.json after other modifications are complete
-	KmdJSONOverride    string `json:",omitempty"` // Raw json to merge into default kmd-config.json
 	PeerList           string `json:",omitempty"` // Semicolon separated list of peers to connect to. Only applicable for non-relays
 }

test/e2e-go/features/transactions/asset_test.go

@@ -682,6 +682,8 @@ func TestAssetGroupCreateSendDestroy(t *testing.T) {
 	txSend, err = client1.MakeUnsignedAssetSendTx(assetID3, 0, account1, "", "")
 	_, err = helperFillSignBroadcast(client1, wh1, account1, txSend, err)
 	a.Error(err)
+
+	a.FailNow("test")
 }
 
 func TestAssetSend(t *testing.T) {

test/framework/fixtures/libgoalFixture.go

@@ -127,7 +127,15 @@ func (f *LibGoalFixture) setup(test TestingTB, testName string, templateFile str
 	importKeys := false // Don't automatically import root keys when creating folders, we'll import on-demand
 	file, err := os.Open(templateFile)
 	f.failOnError(err, "Template file could not be opened: %v")
-	network, err := netdeploy.CreateNetworkFromTemplate("test", f.rootDir, file, f.binDir, importKeys, f.nodeExitWithError, f.consensus, overrides...)
+	defer file.Close()
+
+	// Override the kmd session lifetime to 5 minutes to prevent kmd wallet handles from expiring
+	kmdConfOverride := netdeploy.OverrideKmdConfig(netdeploy.TemplateKMDConfig{SessionLifetimeSecs: 300})
+	// copy overrides to prevent caller's data from being modified
+	extraOverrides := append([]netdeploy.TemplateOverride(nil), overrides...)
+	extraOverrides = append(extraOverrides, kmdConfOverride)
+
+	network, err := netdeploy.CreateNetworkFromTemplate("test", f.rootDir, file, f.binDir, importKeys, f.nodeExitWithError, f.consensus, extraOverrides...)
 	f.failOnError(err, "CreateNetworkFromTemplate failed: %v")
 	f.network = network
 

test/testdata/nettemplates/TwoNodes50Each.json

@@ -22,16 +22,14 @@
             "Wallets": [
                 { "Name": "Wallet1",
                   "ParticipationOnly": false }
-            ],
-            "KmdJSONOverride": "{\"session_lifetime_secs\": 300}"
+            ]
         },
         {
             "Name": "Node",
             "Wallets": [
                 { "Name": "Wallet2",
                   "ParticipationOnly": false }
-            ],
-            "KmdJSONOverride": "{\"session_lifetime_secs\": 300}"
+            ]
         }
     ]
 }

test/testdata/nettemplates/TwoNodes50EachFuture.json

@@ -23,16 +23,14 @@
             "Wallets": [
                 { "Name": "Wallet1",
                   "ParticipationOnly": false }
-            ],
-            "KmdJSONOverride": "{\"session_lifetime_secs\": 300}"
+            ]
         },
         {
             "Name": "Node",
             "Wallets": [
                 { "Name": "Wallet2",
                   "ParticipationOnly": false }
-            ],
-            "KmdJSONOverride": "{\"session_lifetime_secs\": 300}"
+            ]
         }
     ]
 }