certServiceK8sExternalProvider/src/cmpv2controller/cmpv2_issuer_controller_test.go

   1 /*
   2  * ============LICENSE_START=======================================================
   3  * oom-certservice-k8s-external-provider
   4  * ================================================================================
   5  * Copyright (C) 2020 Nokia. All rights reserved.
   6  * ================================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package cmpv2controller
  22
  23 import (
  24         "testing"
  25
  26         "github.com/go-logr/logr"
  27         certmanager "github.com/jetstack/cert-manager/pkg/apis/certmanager/v1"
  28         "github.com/stretchr/testify/assert"
  29         "github.com/stretchr/testify/mock"
  30         apiv1 "k8s.io/api/core/v1"
  31         "k8s.io/apimachinery/pkg/runtime"
  32         "k8s.io/apimachinery/pkg/types"
  33         clientgoscheme "k8s.io/client-go/kubernetes/scheme"
  34         "k8s.io/client-go/tools/record"
  35         "k8s.io/utils/clock"
  36         ctrl "sigs.k8s.io/controller-runtime"
  37         "sigs.k8s.io/controller-runtime/pkg/client"
  38         "sigs.k8s.io/controller-runtime/pkg/client/fake"
  39         "sigs.k8s.io/controller-runtime/pkg/reconcile"
  40
  41         "onap.org/oom-certservice/k8s-external-provider/src/cmpv2api"
  42         certserviceapi "onap.org/oom-certservice/k8s-external-provider/src/cmpv2api"
  43         provisioners "onap.org/oom-certservice/k8s-external-provider/src/cmpv2provisioner"
  44         "onap.org/oom-certservice/k8s-external-provider/src/testdata"
  45 )
  46
  47 func Test_shouldPrepareAndVerifyCMPv2Issuer_whenRequestReceived(t *testing.T) {
  48         scheme := initScheme()
  49         issuer, secret := testdata.GetValidIssuerWithSecret()
  50         fakeClient := getFakeClient(scheme, issuer, secret)
  51         fakeRequest := getFakeRequest()
  52         fakeRecorder := record.NewFakeRecorder(3)
  53         controller := getController(fakeRecorder, fakeClient)
  54
  55         res, err := controller.Reconcile(fakeRequest)
  56
  57         expectedProvisioner, _ := controller.ProvisionerFactory.CreateProvisioner(&issuer, secret)
  58         actualProvisioner, _ := provisioners.Load(types.NamespacedName{Name: testdata.IssuerObjectName, Namespace: testdata.Namespace})
  59         assert.Nil(t, err)
  60         assert.NotNil(t, res)
  61         assert.Equal(t, <-fakeRecorder.Events, "Normal Verified CMPv2Issuer verified and ready to sign certificates")
  62         assert.NotNil(t, actualProvisioner)
  63         assert.ObjectsAreEqual(expectedProvisioner, actualProvisioner)
  64 }
  65
  66 func Test_shouldBeValidCMPv2IssuerSpec_whenAllFieldsAreSet(t *testing.T) {
  67         spec := testdata.GetValidCMPv2IssuerSpec()
  68
  69         err := validateCMPv2IssuerSpec(spec, &MockLogger{})
  70         assert.Nil(t, err)
  71 }
  72
  73 func Test_shouldBeInvalidCMPv2IssuerSpec_whenSpecIsEmpty(t *testing.T) {
  74         spec := cmpv2api.CMPv2IssuerSpec{}
  75         err := validateCMPv2IssuerSpec(spec, nil)
  76         assert.NotNil(t, err)
  77 }
  78
  79 func Test_shouldBeInvalidCMPv2IssuerSpec_whenNotAllFieldsAreSet(t *testing.T) {
  80         setEmptyFieldFunctions := map[string]func(spec *cmpv2api.CMPv2IssuerSpec){
  81                 "emptyUrl":            func(spec *cmpv2api.CMPv2IssuerSpec) { spec.URL = "" },
  82                 "empryCaName":         func(spec *cmpv2api.CMPv2IssuerSpec) { spec.CaName = "" },
  83                 "emptySecretName":     func(spec *cmpv2api.CMPv2IssuerSpec) { spec.CertSecretRef.Name = "" },
  84                 "emptySecretKeyRef":   func(spec *cmpv2api.CMPv2IssuerSpec) { spec.CertSecretRef.KeyRef = "" },
  85                 "emptySecretCertRef":  func(spec *cmpv2api.CMPv2IssuerSpec) { spec.CertSecretRef.CertRef = "" },
  86                 "emptySecretCaertRef": func(spec *cmpv2api.CMPv2IssuerSpec) { spec.CertSecretRef.CacertRef = "" },
  87         }
  88
  89         for caseName, setEmptyFieldFunction := range setEmptyFieldFunctions {
  90                 t.Run(caseName, func(t *testing.T) {
  91                         test_shouldBeInvalidCMPv2IssuerSpec_whenFunctionApplied(t, setEmptyFieldFunction)
  92                 })
  93         }
  94 }
  95
  96 func test_shouldBeInvalidCMPv2IssuerSpec_whenFunctionApplied(t *testing.T, transformSpec func(spec *cmpv2api.CMPv2IssuerSpec)) {
  97         spec := testdata.GetValidCMPv2IssuerSpec()
  98         transformSpec(&spec)
  99         err := validateCMPv2IssuerSpec(spec, nil)
 100         assert.NotNil(t, err)
 101 }
 102
 103 func getController(fakeRecorder *record.FakeRecorder, mockClient client.Client) CMPv2IssuerController {
 104         controller := CMPv2IssuerController{
 105                 Log:                ctrl.Log.WithName("controllers").WithName("CertificateRequest"),
 106                 Clock:              clock.RealClock{},
 107                 Recorder:           fakeRecorder,
 108                 Client:             mockClient,
 109                 ProvisionerFactory: &provisioners.ProvisionerFactoryMock{},
 110         }
 111         return controller
 112 }
 113
 114 func getFakeRequest() reconcile.Request {
 115         fakeRequest := reconcile.Request{
 116                 NamespacedName: types.NamespacedName{
 117                         Namespace: testdata.Namespace,
 118                         Name:      testdata.IssuerObjectName,
 119                 },
 120         }
 121         return fakeRequest
 122 }
 123
 124 func getFakeClient(scheme *runtime.Scheme, issuer cmpv2api.CMPv2Issuer, secret apiv1.Secret) client.Client {
 125         fakeClient := func() client.Client {
 126                 return fake.NewFakeClientWithScheme(scheme, &issuer, &secret)
 127         }()
 128         return fakeClient
 129 }
 130
 131 func initScheme() *runtime.Scheme {
 132         scheme := runtime.NewScheme()
 133         _ = clientgoscheme.AddToScheme(scheme)
 134         _ = certmanager.AddToScheme(scheme)
 135         _ = certserviceapi.AddToScheme(scheme)
 136         return scheme
 137 }
 138
 139 type MockLogger struct {
 140         mock.Mock
 141 }
 142
 143 func (m *MockLogger) Info(msg string, keysAndValues ...interface{})             {}
 144 func (m *MockLogger) Error(err error, msg string, keysAndValues ...interface{}) {}
 145 func (m *MockLogger) Enabled() bool                                             { return false }
 146 func (m *MockLogger) V(level int) logr.Logger                                   { return m }
 147 func (m *MockLogger) WithValues(keysAndValues ...interface{}) logr.Logger       { return m }
 148 func (m *MockLogger) WithName(name string) logr.Logger                          { return m }