cleanup: Rename CustomSearchDomain to CustomSearchDomainConfig

pkg/nbcontracthelper/helper.go

@@ -1,9 +1,86 @@
 package nbcontracthelper
 
-const (
-	defaultLinuxUser = "azureuser"
+import (
+	"bytes"
+	"encoding/gob"
+	"log"
+
+	nbcontractv1 "github.com/Azure/agentbaker/pkg/proto/nbcontract/v1"
 )
 
-func GetDefaultLinuxAdminUsername() string {
-	return defaultLinuxUser
+type NBContractBuilder struct {
+	// nodeBootstrapConfig is the configuration object for the NBContract (Node Bootstrap Contract).
+	nodeBootstrapConfig *nbcontractv1.Configuration
+}
+
+// Check and initialize each field if it is nil.
+func initializeIfNil[T any](field **T) {
+	if *field == nil {
+		*field = new(T)
+	}
+}
+
+// Ensure all objects are non-nil. Please add new objects here.
+func ensureConfigsNonNil(nBC *nbcontractv1.Configuration) {
+	initializeIfNil(&nBC.KubeBinaryConfig)
+	initializeIfNil(&nBC.ApiServerConfig)
+	initializeIfNil(&nBC.AuthConfig)
+	initializeIfNil(&nBC.ClusterConfig)
+	initializeIfNil(&nBC.ClusterConfig.LoadBalancerConfig)
+	initializeIfNil(&nBC.ClusterConfig.ClusterNetworkConfig)
+	initializeIfNil(&nBC.NetworkConfig)
+	initializeIfNil(&nBC.GpuConfig)
+	initializeIfNil(&nBC.TlsBootstrappingConfig)
+	initializeIfNil(&nBC.KubeletConfig)
+	initializeIfNil(&nBC.RuncConfig)
+	initializeIfNil(&nBC.ContainerdConfig)
+	initializeIfNil(&nBC.TeleportConfig)
+	initializeIfNil(&nBC.CustomLinuxOsConfig)
+	initializeIfNil(&nBC.HttpProxyConfig)
+	initializeIfNil(&nBC.CustomCloudConfig)
+	initializeIfNil(&nBC.CustomSearchDomainConfig)
+}
+
+// Creates a new instance of NBContractBuilder and ensures all objects in nodeBootstrapConfig are non-nil.
+func NewNBContractBuilder() *NBContractBuilder {
+	nbc := &nbcontractv1.Configuration{}
+	ensureConfigsNonNil(nbc)
+	nBCB := &NBContractBuilder{nodeBootstrapConfig: nbc}
+	return nBCB
+}
+
+// Apply the configuration to the nodeBootstrapConfig object.
+func (nBCB *NBContractBuilder) ApplyConfiguration(config *nbcontractv1.Configuration) {
+	if config == nil {
+		return
+	}
+
+	// Use deep copy to avoid modifying the original object 'config'.
+	if err := nBCB.deepCopy(config, nBCB.nodeBootstrapConfig); err != nil {
+		log.Printf("Failed to deep copy the configuration: %v", err)
+		ensureConfigsNonNil(nBCB.nodeBootstrapConfig)
+	}
+}
+
+// Get the nodeBootstrapConfig object.
+func (nBCB *NBContractBuilder) GetNodeBootstrapConfig() *nbcontractv1.Configuration {
+	return nBCB.nodeBootstrapConfig
+}
+
+// Deep copy the source object to the destination object.
+// Note that the existing value in the destination object will not be cleared
+// if the source object doesn't have that field.
+func (nBCB *NBContractBuilder) deepCopy(src, dst interface{}) error {
+	if src == nil {
+		return nil
+	}
+
+	var buf bytes.Buffer
+	if err := gob.NewEncoder(&buf).Encode(src); err != nil {
+		return err
+	}
+	if err := gob.NewDecoder(&buf).Decode(dst); err != nil {
+		return err
+	}
+	return nil
 }

pkg/nbcontracthelper/helper_test.go

@@ -0,0 +1,224 @@
+package nbcontracthelper
+
+import (
+	"log"
+	"reflect"
+	"testing"
+
+	nbcontractv1 "github.com/Azure/agentbaker/pkg/proto/nbcontract/v1"
+	"github.com/Azure/go-autorest/autorest/to"
+)
+
+func TestNewNBContractBuilder(t *testing.T) {
+	wantedResult := &nbcontractv1.Configuration{
+		KubeBinaryConfig: &nbcontractv1.KubeBinaryConfig{},
+		ApiServerConfig:  &nbcontractv1.ApiServerConfig{},
+		AuthConfig:       &nbcontractv1.AuthConfig{},
+		ClusterConfig: &nbcontractv1.ClusterConfig{
+			LoadBalancerConfig:   &nbcontractv1.LoadBalancerConfig{},
+			ClusterNetworkConfig: &nbcontractv1.ClusterNetworkConfig{},
+		},
+		NetworkConfig:            &nbcontractv1.NetworkConfig{},
+		GpuConfig:                &nbcontractv1.GPUConfig{},
+		TlsBootstrappingConfig:   &nbcontractv1.TLSBootstrappingConfig{},
+		KubeletConfig:            &nbcontractv1.KubeletConfig{},
+		RuncConfig:               &nbcontractv1.RuncConfig{},
+		ContainerdConfig:         &nbcontractv1.ContainerdConfig{},
+		TeleportConfig:           &nbcontractv1.TeleportConfig{},
+		CustomLinuxOsConfig:      &nbcontractv1.CustomLinuxOSConfig{},
+		HttpProxyConfig:          &nbcontractv1.HTTPProxyConfig{},
+		CustomCloudConfig:        &nbcontractv1.CustomCloudConfig{},
+		CustomSearchDomainConfig: &nbcontractv1.CustomSearchDomainConfig{},
+	}
+	tests := []struct {
+		name string
+		want *nbcontractv1.Configuration
+	}{
+		{
+			name: "Test with nil configuration",
+			want: wantedResult,
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			if got := NewNBContractBuilder().nodeBootstrapConfig; !reflect.DeepEqual(got, tt.want) {
+				t.Errorf("NewNBContractConfiguration() = %v, want %v", got, tt.want)
+			}
+		})
+	}
+}
+
+func TestNBContractBuilder_ApplyConfiguration(t *testing.T) {
+	type fields struct {
+		nBContractConfiguration *nbcontractv1.Configuration
+	}
+	wantedResult := &nbcontractv1.Configuration{
+		KubeBinaryConfig: &nbcontractv1.KubeBinaryConfig{},
+		ApiServerConfig:  &nbcontractv1.ApiServerConfig{},
+		AuthConfig:       &nbcontractv1.AuthConfig{},
+		ClusterConfig: &nbcontractv1.ClusterConfig{
+			LoadBalancerConfig:   &nbcontractv1.LoadBalancerConfig{},
+			ClusterNetworkConfig: &nbcontractv1.ClusterNetworkConfig{},
+		},
+		NetworkConfig:            &nbcontractv1.NetworkConfig{},
+		GpuConfig:                &nbcontractv1.GPUConfig{},
+		TlsBootstrappingConfig:   &nbcontractv1.TLSBootstrappingConfig{},
+		KubeletConfig:            &nbcontractv1.KubeletConfig{},
+		RuncConfig:               &nbcontractv1.RuncConfig{},
+		ContainerdConfig:         &nbcontractv1.ContainerdConfig{},
+		TeleportConfig:           &nbcontractv1.TeleportConfig{},
+		CustomLinuxOsConfig:      &nbcontractv1.CustomLinuxOSConfig{},
+		HttpProxyConfig:          &nbcontractv1.HTTPProxyConfig{},
+		CustomCloudConfig:        &nbcontractv1.CustomCloudConfig{},
+		CustomSearchDomainConfig: &nbcontractv1.CustomSearchDomainConfig{},
+	}
+	tests := []struct {
+		name   string
+		fields fields
+		want   *nbcontractv1.Configuration
+	}{
+		{
+			name: "Test with nil configuration",
+			fields: fields{
+				nBContractConfiguration: &nbcontractv1.Configuration{},
+			},
+			want: wantedResult,
+		},
+		{
+			name: "Apply nil AuthConfig configuration and expect AuthConfig in nBContractConfiguration to be non-nil",
+			fields: fields{
+				nBContractConfiguration: &nbcontractv1.Configuration{
+					AuthConfig: nil,
+				},
+			},
+			want: wantedResult,
+		},
+		{
+			name: "Apply some configurations and expect them to be applied",
+			fields: fields{
+				nBContractConfiguration: &nbcontractv1.Configuration{
+					AuthConfig: &nbcontractv1.AuthConfig{
+						TargetCloud: "some-cloud",
+					},
+					LinuxAdminUsername: "testuser",
+				},
+			},
+			want: func() *nbcontractv1.Configuration {
+				tmpResult := NewNBContractBuilder().nodeBootstrapConfig
+				tmpResult.AuthConfig.TargetCloud = "some-cloud"
+				tmpResult.LinuxAdminUsername = "testuser"
+				return tmpResult
+			}(),
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			builder := NewNBContractBuilder()
+			builder.ApplyConfiguration(tt.fields.nBContractConfiguration)
+			if got := builder.nodeBootstrapConfig; !reflect.DeepEqual(got, tt.want) {
+				t.Errorf("ApplyConfiguration() = %v, want %v", got, tt.want)
+			}
+		})
+	}
+}
+
+func TestNBContractBuilder_deepCopy(t *testing.T) {
+	type Teststruct struct {
+		A string
+		B *int
+		C bool
+	}
+	type args struct {
+		src *Teststruct
+		dst *Teststruct
+	}
+	tests := []struct {
+		name        string
+		args        args
+		want        *Teststruct
+		isChangeDst bool
+	}{
+		{
+			name: "Test with empty src",
+			args: args{
+				src: &Teststruct{},
+				dst: &Teststruct{},
+			},
+			want:        &Teststruct{},
+			isChangeDst: false,
+		},
+		{
+			name: "Test with non-empty src",
+			args: args{
+				src: &Teststruct{
+					A: "some-string",
+					B: to.IntPtr(123),
+					C: true,
+				},
+				dst: &Teststruct{},
+			},
+			want: &Teststruct{
+				A: "some-string",
+				B: to.IntPtr(123),
+				C: true,
+			},
+			isChangeDst: false,
+		},
+		{
+			name: "Test with dst which has some existing values. Expect them to be overwritten",
+			args: args{
+				src: &Teststruct{
+					A: "some-string",
+					B: to.IntPtr(123),
+				},
+				dst: &Teststruct{
+					A: "some-other-string",
+					B: to.IntPtr(456),
+					C: false,
+				},
+			},
+			want: &Teststruct{
+				A: "some-string",
+				B: to.IntPtr(123),
+				C: false,
+			},
+			isChangeDst: false,
+		},
+		{
+			name: "After deepCopy, changes in dst should not affect src",
+			args: args{
+				src: &Teststruct{
+					A: "some-string",
+					B: to.IntPtr(123),
+				},
+				dst: &Teststruct{},
+			},
+			want: &Teststruct{
+				A: "some-string",
+				B: to.IntPtr(123),
+			},
+			isChangeDst: true,
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			nBCB := &NBContractBuilder{
+				nodeBootstrapConfig: &nbcontractv1.Configuration{},
+			}
+			if err := nBCB.deepCopy(tt.args.src, tt.args.dst); err != nil {
+				log.Printf("Failed to deep copy the configuration: %v", err)
+			}
+			log.Printf("dst = %v, src %v", tt.args.dst, tt.args.src)
+			if got := tt.args.dst; !reflect.DeepEqual(got, tt.want) {
+				t.Errorf("got = %v, want %v", got, tt.want)
+			}
+			if tt.isChangeDst {
+				tt.args.dst.A = "some-other-string"
+				tt.args.dst.B = to.IntPtr(456)
+				if got := tt.args.src; !reflect.DeepEqual(got, tt.want) {
+					t.Errorf("src = %v, want %v", got, tt.want)
+				}
+			}
+		})
+	}
+}

pkg/parser/cse_cmd.sh.gtpl

@@ -12,5 +12,4 @@ KUBE_BINARY_URL="{{.KubeBinaryUrl}}"
 CUSTOM_KUBE_BINARY_URL="{{.CustomKubeBinaryUrl}}"
 KUBEPROXY_URL="{{.KubeproxyUrl}}"
 
-DISABLE_SSH="{{getInverseBoolStr .SshStatus}}"
 IS_CUSTOM_CLOUD={{.CustomCloudConfig.IsCustomCloud}}

pkg/proto/nbcontract/v1/clusterconfig.proto

@@ -19,7 +19,7 @@ message ClusterConfig {
   string primary_scale_set = 5;
 
   // Cluster network config
-  ClusterNetworkConfig virtual_network_config = 6;
+  ClusterNetworkConfig cluster_network_config = 6;
 
   // Specifiy if it uses instance metadata
   bool use_instance_metadata = 7; // default to false