Merge pull request #14 from srl-labs/refactored-license-update

refactored version detection for license and lic update procedure

api/clientset/v1alpha1/srlinux.go

@@ -25,21 +25,25 @@ var ErrUpdateFailed = errors.New("operation update failed")
 
 // SrlinuxInterface provides access to the Srlinux CRD.
 type SrlinuxInterface interface {
-	List(ctx context.Context, opts metav1.ListOptions) (*typesv1alpha1.SrlinuxList, error)
-	Get(ctx context.Context, name string, options metav1.GetOptions) (*typesv1alpha1.Srlinux, error)
+	List(ctx context.Context, opts *metav1.ListOptions) (*typesv1alpha1.SrlinuxList, error)
+	Get(
+		ctx context.Context,
+		name string,
+		options *metav1.GetOptions,
+	) (*typesv1alpha1.Srlinux, error)
 	Create(ctx context.Context, srlinux *typesv1alpha1.Srlinux) (*typesv1alpha1.Srlinux, error)
-	Delete(ctx context.Context, name string, opts metav1.DeleteOptions) error
-	Watch(ctx context.Context, opts metav1.ListOptions) (watch.Interface, error)
+	Delete(ctx context.Context, name string, opts *metav1.DeleteOptions) error
+	Watch(ctx context.Context, opts *metav1.ListOptions) (watch.Interface, error)
 	Unstructured(
 		ctx context.Context,
 		name string,
-		opts metav1.GetOptions,
+		opts *metav1.GetOptions,
 		subresources ...string,
 	) (*unstructured.Unstructured, error)
 	Update(
 		ctx context.Context,
 		obj *unstructured.Unstructured,
-		opts metav1.UpdateOptions,
+		opts *metav1.UpdateOptions,
 	) (*typesv1alpha1.Srlinux, error)
 }
 
@@ -104,14 +108,14 @@ type srlinuxClient struct {
 // List gets a list of SRLinux resources.
 func (s *srlinuxClient) List(
 	ctx context.Context,
-	opts metav1.ListOptions,
+	opts *metav1.ListOptions,
 ) (*typesv1alpha1.SrlinuxList, error) {
 	result := typesv1alpha1.SrlinuxList{}
 	err := s.restClient.
 		Get().
 		Namespace(s.ns).
 		Resource(gvr.Resource).
-		VersionedParams(&opts, scheme.ParameterCodec).
+		VersionedParams(opts, scheme.ParameterCodec).
 		Do(ctx).
 		Into(&result)
 
@@ -122,15 +126,15 @@ func (s *srlinuxClient) List(
 func (s *srlinuxClient) Get(
 	ctx context.Context,
 	name string,
-	opts metav1.GetOptions,
+	opts *metav1.GetOptions,
 ) (*typesv1alpha1.Srlinux, error) {
 	result := typesv1alpha1.Srlinux{}
 	err := s.restClient.
 		Get().
 		Namespace(s.ns).
 		Resource(gvr.Resource).
 		Name(name).
-		VersionedParams(&opts, scheme.ParameterCodec).
+		VersionedParams(opts, scheme.ParameterCodec).
 		Do(ctx).
 		Into(&result)
 
@@ -156,24 +160,24 @@ func (s *srlinuxClient) Create(
 
 func (s *srlinuxClient) Watch(
 	ctx context.Context,
-	opts metav1.ListOptions,
+	opts *metav1.ListOptions,
 ) (watch.Interface, error) {
 	opts.Watch = true
 
 	return s.restClient.
 		Get().
 		Namespace(s.ns).
 		Resource(gvr.Resource).
-		VersionedParams(&opts, scheme.ParameterCodec).
+		VersionedParams(opts, scheme.ParameterCodec).
 		Watch(ctx)
 }
 
-func (s *srlinuxClient) Delete(ctx context.Context, name string, opts metav1.DeleteOptions) error {
+func (s *srlinuxClient) Delete(ctx context.Context, name string, opts *metav1.DeleteOptions) error {
 	return s.restClient.
 		Delete().
 		Namespace(s.ns).
 		Resource(gvr.Resource).
-		VersionedParams(&opts, scheme.ParameterCodec).
+		VersionedParams(opts, scheme.ParameterCodec).
 		Name(name).
 		Do(ctx).
 		Error()
@@ -182,7 +186,7 @@ func (s *srlinuxClient) Delete(ctx context.Context, name string, opts metav1.Del
 func (s *srlinuxClient) Update(
 	ctx context.Context,
 	obj *unstructured.Unstructured,
-	opts metav1.UpdateOptions,
+	_ *metav1.UpdateOptions,
 ) (*typesv1alpha1.Srlinux, error) {
 	result := typesv1alpha1.Srlinux{}
 
@@ -202,10 +206,10 @@ func (s *srlinuxClient) Update(
 func (s *srlinuxClient) Unstructured(
 	ctx context.Context,
 	name string,
-	opts metav1.GetOptions,
+	opts *metav1.GetOptions,
 	subresources ...string,
 ) (*unstructured.Unstructured, error) {
-	return s.dInterface.Namespace(s.ns).Get(ctx, name, opts, subresources...)
+	return s.dInterface.Namespace(s.ns).Get(ctx, name, *opts, subresources...)
 }
 
 func init() {

api/types/v1alpha1/srlinux_types.go

@@ -59,8 +59,6 @@ type Srlinux struct {
 	Spec   SrlinuxSpec   `json:"spec,omitempty"`
 	Status SrlinuxStatus `json:"status,omitempty"`
 
-	// parsed NOS version
-	NOSVersion *SrlVersion `json:"nos-version,omitempty"`
 	// license key from license secret that contains a license file for this Srlinux
 	LicenseKey string `json:"license_key,omitempty"`
 }
@@ -154,12 +152,13 @@ func (s *SrlinuxSpec) GetImageVersion() (*SrlVersion, error) {
 func (s *Srlinux) InitLicenseKey(
 	_ context.Context,
 	secret *corev1.Secret,
+	version *SrlVersion,
 ) {
 	if secret == nil {
 		return
 	}
 
-	versionSecretKey := fmt.Sprintf("%s-%s.key", s.NOSVersion.Major, s.NOSVersion.Minor)
+	versionSecretKey := fmt.Sprintf("%s-%s.key", version.Major, version.Minor)
 	if _, ok := secret.Data[versionSecretKey]; ok {
 		s.LicenseKey = versionSecretKey
 

api/types/v1alpha1/srlinux_types_test.go

@@ -135,16 +135,14 @@ func TestGetImageVersion(t *testing.T) {
 
 func TestInitVersion(t *testing.T) {
 	tests := []struct {
-		desc   string
-		srl    *Srlinux
-		secret *corev1.Secret
-		want   string
+		desc    string
+		version *SrlVersion
+		secret  *corev1.Secret
+		want    string
 	}{
 		{
-			desc: "secret key matches srl version",
-			srl: &Srlinux{
-				NOSVersion: &SrlVersion{"22", "3", "", "", ""},
-			},
+			desc:    "secret key matches srl version",
+			version: &SrlVersion{"22", "3", "", "", ""},
 			secret: &corev1.Secret{
 				Data: map[string][]byte{
 					"22-3.key": nil,
@@ -154,10 +152,8 @@ func TestInitVersion(t *testing.T) {
 			want: "22-3.key",
 		},
 		{
-			desc: "wildcard secret key matches srl version",
-			srl: &Srlinux{
-				NOSVersion: &SrlVersion{"22", "3", "", "", ""},
-			},
+			desc:    "wildcard secret key matches srl version",
+			version: &SrlVersion{"22", "3", "", "", ""},
 			secret: &corev1.Secret{
 				Data: map[string][]byte{
 					"22-6.key": nil,
@@ -167,24 +163,23 @@ func TestInitVersion(t *testing.T) {
 			want: "all.key",
 		},
 		{
-			desc: "secret does not exist",
-			srl: &Srlinux{
-				NOSVersion: &SrlVersion{"22", "3", "", "", ""},
-			},
-			secret: nil,
-			want:   "",
+			desc:    "secret does not exist",
+			version: &SrlVersion{"22", "3", "", "", ""},
+			secret:  nil,
+			want:    "",
 		},
 	}
 
 	for _, tt := range tests {
 		t.Run(tt.desc, func(t *testing.T) {
-			tt.srl.InitLicenseKey(context.TODO(), tt.secret)
+			srl := &Srlinux{}
+			srl.InitLicenseKey(context.TODO(), tt.secret, tt.version)
 
-			if !cmp.Equal(tt.srl.LicenseKey, tt.want) {
+			if !cmp.Equal(srl.LicenseKey, tt.want) {
 				t.Fatalf(
 					"%s: actual and expected inputs do not match\nactual: %+v\nexpected:%+v",
 					tt.desc,
-					tt.srl.LicenseKey,
+					srl.LicenseKey,
 					tt.want,
 				)
 			}

config/crd/bases/kne.srlinux.dev_srlinuxes.yaml

@@ -44,20 +44,6 @@ spec:
             type: string
           metadata:
             type: object
-          nos-version:
-            description: parsed NOS version
-            properties:
-              build:
-                type: string
-              commit:
-                type: string
-              major:
-                type: string
-              minor:
-                type: string
-              patch:
-                type: string
-            type: object
           spec:
             description: SrlinuxSpec defines the desired state of Srlinux.
             properties:

config/manager/kustomization.yaml

@@ -13,4 +13,4 @@ kind: Kustomization
 images:
   - name: controller
     newName: ghcr.io/srl-labs/srl-controller
-    newTag: 0.4.0
+    newTag: 0.4.2