[#2475] Rename a struct

Author: fivitti

backend/server/daemons/kea/configdatabaseiterator.go

@@ -11,11 +11,12 @@ import (
 	dbmodel "isc.org/stork/server/database/model"
 )
 
-// Uniquely identifies a cb_cmds config-backend target. Two daemons that share
-// the same config database will have the same configBackendKey and therefore
-// receive only one remote-subnet*-set command with multiple
-// server tags, instead of one command per daemon.
-type configBackendKey struct {
+// Uniquely identifies a configuration target (the Config Backend database or
+// daemon configuration). Two daemons that share the same CB database will
+// have the same configTargetKey and therefore receive only one
+// remote-subnet*-set command with multiple server tags, instead of one command
+// per daemon.
+type configTargetKey struct {
 	// These fields should be filled for daemons using cb_cmds hook. Otherwise,
 	// they must be left empty.
 	DBName string
@@ -26,20 +27,20 @@ type configBackendKey struct {
 	DaemonID int64
 }
 
-// Constructs a configBackendKey for a local subnet's cb_cmds daemon.
+// Constructs a configTargetKey for a local subnet's cb_cmds daemon.
 // The daemon's config databases list must not be empty.
-func buildConfigBackendKey(daemon *dbmodel.Daemon) (configBackendKey, error) {
+func buildConfigTargetKey(daemon *dbmodel.Daemon) (configTargetKey, error) {
 	config := daemon.KeaDaemon.Config
 
 	dbs := config.GetAllDatabases().Config
 	if len(dbs) == 0 {
-		return configBackendKey{}, errors.Errorf(
+		return configTargetKey{}, errors.Errorf(
 			"daemon [%d] has libdhcp_cb_cmds loaded but no config databases configured",
 			daemon.ID,
 		)
 	}
 	db := dbs[0]
-	return configBackendKey{
+	return configTargetKey{
 		DBName: db.Name,
 		DBHost: db.Host,
 		DBPort: db.Port,
@@ -66,18 +67,18 @@ func forEachUniqueConfigSource(
 	localSubnets []*dbmodel.LocalSubnet,
 	fn func(localSubnets []*dbmodel.LocalSubnet) error,
 ) error {
-	localSubnetsByBackend := map[configBackendKey][]*dbmodel.LocalSubnet{}
+	localSubnetsByBackend := map[configTargetKey][]*dbmodel.LocalSubnet{}
 
 	for _, ls := range localSubnets {
 		hook := ls.Daemon.KeaDaemon.Config.GetHookLibraries().GetSubnetAndSharedNetworkAlteringHookLibrary()
 		switch hook {
 		case keaconfig.SubnetAndSharedNetworkAlteringHookLibrarySubnetCmds:
-			// For non-cb_cmds daemons, the config source is the daemon config,
+			// For non-cb_cmds daemons, the config target is the daemon config,
 			// they are not grouped.
-			key := configBackendKey{DaemonID: ls.DaemonID}
+			key := configTargetKey{DaemonID: ls.DaemonID}
 			localSubnetsByBackend[key] = []*dbmodel.LocalSubnet{ls}
 		case keaconfig.SubnetAndSharedNetworkAlteringHookLibraryCBCmds:
-			key, err := buildConfigBackendKey(ls.Daemon)
+			key, err := buildConfigTargetKey(ls.Daemon)
 			if err != nil {
 				log.WithError(err).Warnf(
 					"Skipping local subnet [%d] "+

backend/server/daemons/kea/configdatabaseiterator_test.go

@@ -11,13 +11,13 @@ import (
 	storkutil "isc.org/stork/util"
 )
 
-// Tests that config backend key fields are extracted correctly.
-func TestBuildConfigBackendKeyNoServerTag(t *testing.T) {
+// Tests that config target key fields are extracted correctly.
+func TestBuildConfigTargetKeyNoServerTag(t *testing.T) {
 	// Arrange
 	daemon := newTestDaemonWithConfig(t, daemonname.DHCPv4, nil, keaconfig.SubnetAndSharedNetworkAlteringHookLibraryCBCmds)
 
 	// Act
-	id, err := buildConfigBackendKey(daemon)
+	id, err := buildConfigTargetKey(daemon)
 
 	// Assert
 	require.NoError(t, err)
@@ -26,13 +26,13 @@ func TestBuildConfigBackendKeyNoServerTag(t *testing.T) {
 	require.EqualValues(t, 5432, id.DBPort)
 }
 
-// Tests that the server tag is included in the config backend ID.
-func TestBuildConfigBackendIDWithServerTag(t *testing.T) {
+// Tests that the server tag is included in the config target key.
+func TestBuildConfigTargetKeyWithServerTag(t *testing.T) {
 	// Arrange
 	daemon := newTestDaemonWithConfig(t, daemonname.DHCPv4, storkutil.Ptr("server1"), keaconfig.SubnetAndSharedNetworkAlteringHookLibraryCBCmds)
 
 	// Act
-	id, err := buildConfigBackendKey(daemon)
+	id, err := buildConfigTargetKey(daemon)
 
 	// Assert
 	require.NoError(t, err)
@@ -42,7 +42,7 @@ func TestBuildConfigBackendIDWithServerTag(t *testing.T) {
 }
 
 // Tests that an error is returned when no config databases are configured.
-func TestBuildConfigBackendKeyNoConfigDB(t *testing.T) {
+func TestBuildConfigTargetKeyNoConfigDB(t *testing.T) {
 	// Arrange
 	daemon := &dbmodel.Daemon{
 		Name:      daemonname.DHCPv4,
@@ -53,14 +53,14 @@ func TestBuildConfigBackendKeyNoConfigDB(t *testing.T) {
 	require.NoError(t, err)
 
 	// Act
-	_, err = buildConfigBackendKey(daemon)
+	_, err = buildConfigTargetKey(daemon)
 
 	// Assert
 	require.ErrorContains(t, err, "no config databases configured")
 }
 
-// Tests that target iterator groups daemons sharing the same config backend
-// and calls the callback exactly once for that backend. The daemons with the
+// Tests that target iterator groups daemons sharing the same config target
+// and calls the callback exactly once for that target. The daemons with the
 // subnet_cmds hook are not grouped. The daemons with no hooks or both hooks
 // are silently skipped.
 func TestForEachUniqueConfigSource(t *testing.T) {