[OOM-K8S-CERT-EXTERNAL-PROVIDER] Rename variables to readable.

Issue-ID: OOM-2559
Signed-off-by: Tomasz Wrobel <tomasz.wrobel@nokia.com>
Change-Id: I1da11dcc12e97f6997a409106e90f6000a6102d0

3 files changed, 75 insertions, 77 deletions

diff --git a/certServiceK8sExternalProvider/src/certservice-controller/certificaterequest_reconciler.go b/certServiceK8sExternalProvider/src/certservice-controller/certificaterequest_reconciler.go
index 1a917e1b..92e77960 100644
--- a/certServiceK8sExternalProvider/src/certservice-controller/certificaterequest_reconciler.go
+++ b/certServiceK8sExternalProvider/src/certservice-controller/certificaterequest_reconciler.go
@@ -53,14 +53,14 @@ type CertificateRequestReconciler struct {
 // Reconcile will read and validate a CertServiceIssuer resource associated to the
 // CertificateRequest resource, and it will sign the CertificateRequest with the
 // provisioner in the CertServiceIssuer.
-func (r *CertificateRequestReconciler) Reconcile(req ctrl.Request) (ctrl.Result, error) {
+func (reconciler *CertificateRequestReconciler) Reconcile(req ctrl.Request) (ctrl.Result, error) {
 	ctx := context.Background()
-	log := r.Log.WithValues("certificaterequest", req.NamespacedName)
+	log := reconciler.Log.WithValues("certificaterequest", req.NamespacedName)
 
 	// Fetch the CertificateRequest resource being reconciled.
 	// Just ignore the request if the certificate request has been deleted.
-	cr := new(cmapi.CertificateRequest)
-	if err := r.Client.Get(ctx, req.NamespacedName, cr); err != nil {
+	certificateRequest := new(cmapi.CertificateRequest)
+	if err := reconciler.Client.Get(ctx, req.NamespacedName, certificateRequest); err != nil {
 		if apierrors.IsNotFound(err) {
 			return ctrl.Result{}, nil
 		}
@@ -71,65 +71,65 @@ func (r *CertificateRequestReconciler) Reconcile(req ctrl.Request) (ctrl.Result,
 
 	// Check the CertificateRequest's issuerRef and if it does not match the api
 	// group name, log a message at a debug level and stop processing.
-	if cr.Spec.IssuerRef.Group != "" && cr.Spec.IssuerRef.Group != api.GroupVersion.Group {
-		log.V(4).Info("resource does not specify an issuerRef group name that we are responsible for", "group", cr.Spec.IssuerRef.Group)
+	if certificateRequest.Spec.IssuerRef.Group != "" && certificateRequest.Spec.IssuerRef.Group != api.GroupVersion.Group {
+		log.V(4).Info("resource does not specify an issuerRef group name that we are responsible for", "group", certificateRequest.Spec.IssuerRef.Group)
 		return ctrl.Result{}, nil
 	}
 
 	// If the certificate data is already set then we skip this request as it
 	// has already been completed in the past.
-	if len(cr.Status.Certificate) > 0 {
+	if len(certificateRequest.Status.Certificate) > 0 {
 		log.V(4).Info("existing certificate data found in status, skipping already completed CertificateRequest")
 		return ctrl.Result{}, nil
 	}
 
 	// Fetch the CertServiceIssuer resource
-	iss := api.CertServiceIssuer{}
-	issNamespaceName := types.NamespacedName{
+	issuer := api.CertServiceIssuer{}
+	issuerNamespaceName := types.NamespacedName{
 		Namespace: req.Namespace,
-		Name:      cr.Spec.IssuerRef.Name,
+		Name:      certificateRequest.Spec.IssuerRef.Name,
 	}
-	if err := r.Client.Get(ctx, issNamespaceName, &iss); err != nil {
-		log.Error(err, "failed to retrieve CertServiceIssuer resource", "namespace", req.Namespace, "name", cr.Spec.IssuerRef.Name)
-		_ = r.setStatus(ctx, cr, cmmeta.ConditionFalse, cmapi.CertificateRequestReasonPending, "Failed to retrieve CertServiceIssuer resource %s: %v", issNamespaceName, err)
+	if err := reconciler.Client.Get(ctx, issuerNamespaceName, &issuer); err != nil {
+		log.Error(err, "failed to retrieve CertServiceIssuer resource", "namespace", req.Namespace, "name", certificateRequest.Spec.IssuerRef.Name)
+		_ = reconciler.setStatus(ctx, certificateRequest, cmmeta.ConditionFalse, cmapi.CertificateRequestReasonPending, "Failed to retrieve CertServiceIssuer resource %s: %v", issuerNamespaceName, err)
 		return ctrl.Result{}, err
 	}
 
 	// Check if the CertServiceIssuer resource has been marked Ready
-	if !certServiceIssuerHasCondition(iss, api.CertServiceIssuerCondition{Type: api.ConditionReady, Status: api.ConditionTrue}) {
-		err := fmt.Errorf("resource %s is not ready", issNamespaceName)
-		log.Error(err, "failed to retrieve CertServiceIssuer resource", "namespace", req.Namespace, "name", cr.Spec.IssuerRef.Name)
-		_ = r.setStatus(ctx, cr, cmmeta.ConditionFalse, cmapi.CertificateRequestReasonPending, "CertServiceIssuer resource %s is not Ready", issNamespaceName)
+	if !certServiceIssuerHasCondition(issuer, api.CertServiceIssuerCondition{Type: api.ConditionReady, Status: api.ConditionTrue}) {
+		err := fmt.Errorf("resource %s is not ready", issuerNamespaceName)
+		log.Error(err, "failed to retrieve CertServiceIssuer resource", "namespace", req.Namespace, "name", certificateRequest.Spec.IssuerRef.Name)
+		_ = reconciler.setStatus(ctx, certificateRequest, cmmeta.ConditionFalse, cmapi.CertificateRequestReasonPending, "CertServiceIssuer resource %s is not Ready", issuerNamespaceName)
 		return ctrl.Result{}, err
 	}
 
 	// Load the provisioner that will sign the CertificateRequest
-	provisioner, ok := provisioners.Load(issNamespaceName)
+	provisioner, ok := provisioners.Load(issuerNamespaceName)
 	if !ok {
-		err := fmt.Errorf("provisioner %s not found", issNamespaceName)
+		err := fmt.Errorf("provisioner %s not found", issuerNamespaceName)
 		log.Error(err, "failed to provisioner for CertServiceIssuer resource")
-		_ = r.setStatus(ctx, cr, cmmeta.ConditionFalse, cmapi.CertificateRequestReasonPending, "Failed to load provisioner for CertServiceIssuer resource %s", issNamespaceName)
+		_ = reconciler.setStatus(ctx, certificateRequest, cmmeta.ConditionFalse, cmapi.CertificateRequestReasonPending, "Failed to load provisioner for CertServiceIssuer resource %s", issuerNamespaceName)
 		return ctrl.Result{}, err
 	}
 
 	// Sign CertificateRequest
-	signedPEM, trustedCAs, err := provisioner.Sign(ctx, cr)
+	signedPEM, trustedCAs, err := provisioner.Sign(ctx, certificateRequest)
 	if err != nil {
 		log.Error(err, "failed to sign certificate request")
-		return ctrl.Result{}, r.setStatus(ctx, cr, cmmeta.ConditionFalse, cmapi.CertificateRequestReasonFailed, "Failed to sign certificate request: %v", err)
+		return ctrl.Result{}, reconciler.setStatus(ctx, certificateRequest, cmmeta.ConditionFalse, cmapi.CertificateRequestReasonFailed, "Failed to sign certificate request: %v", err)
 	}
-	cr.Status.Certificate = signedPEM
-	cr.Status.CA = trustedCAs
+	certificateRequest.Status.Certificate = signedPEM
+	certificateRequest.Status.CA = trustedCAs
 
-	return ctrl.Result{}, r.setStatus(ctx, cr, cmmeta.ConditionTrue, cmapi.CertificateRequestReasonIssued, "Certificate issued")
+	return ctrl.Result{}, reconciler.setStatus(ctx, certificateRequest, cmmeta.ConditionTrue, cmapi.CertificateRequestReasonIssued, "Certificate issued")
 }
 
 // SetupWithManager initializes the CertificateRequest controller into the
 // controller runtime.
-func (r *CertificateRequestReconciler) SetupWithManager(mgr ctrl.Manager) error {
-	return ctrl.NewControllerManagedBy(mgr).
+func (reconciler *CertificateRequestReconciler) SetupWithManager(manager ctrl.Manager) error {
+	return ctrl.NewControllerManagedBy(manager).
 		For(&cmapi.CertificateRequest{}).
-		Complete(r)
+		Complete(reconciler)
 }
 
 // certServiceIssuerHasCondition will return true if the given CertServiceIssuer resource has
@@ -137,26 +137,26 @@ func (r *CertificateRequestReconciler) SetupWithManager(mgr ctrl.Manager) error
 // Status field will be used in the comparison, meaning that this function will
 // return 'true' even if the Reason, Message and LastTransitionTime fields do
 // not match.
-func certServiceIssuerHasCondition(iss api.CertServiceIssuer, c api.CertServiceIssuerCondition) bool {
-	existingConditions := iss.Status.Conditions
+func certServiceIssuerHasCondition(issuer api.CertServiceIssuer, condition api.CertServiceIssuerCondition) bool {
+	existingConditions := issuer.Status.Conditions
 	for _, cond := range existingConditions {
-		if c.Type == cond.Type && c.Status == cond.Status {
+		if condition.Type == cond.Type && condition.Status == cond.Status {
 			return true
 		}
 	}
 	return false
 }
 
-func (r *CertificateRequestReconciler) setStatus(ctx context.Context, cr *cmapi.CertificateRequest, status cmmeta.ConditionStatus, reason, message string, args ...interface{}) error {
+func (reconciler *CertificateRequestReconciler) setStatus(ctx context.Context, certificateRequest *cmapi.CertificateRequest, status cmmeta.ConditionStatus, reason, message string, args ...interface{}) error {
 	completeMessage := fmt.Sprintf(message, args...)
-	apiutil.SetCertificateRequestCondition(cr, cmapi.CertificateRequestConditionReady, status, reason, completeMessage)
+	apiutil.SetCertificateRequestCondition(certificateRequest, cmapi.CertificateRequestConditionReady, status, reason, completeMessage)
 
 	// Fire an Event to additionally inform users of the change
 	eventType := core.EventTypeNormal
 	if status == cmmeta.ConditionFalse {
 		eventType = core.EventTypeWarning
 	}
-	r.Recorder.Event(cr, eventType, reason, completeMessage)
+	reconciler.Recorder.Event(certificateRequest, eventType, reason, completeMessage)
 
-	return r.Client.Status().Update(ctx, cr)
+	return reconciler.Client.Status().Update(ctx, certificateRequest)
 }
diff --git a/certServiceK8sExternalProvider/src/certservice-controller/certservice_issuer_reconciler.go b/certServiceK8sExternalProvider/src/certservice-controller/certservice_issuer_reconciler.go
index d5be11e8..b22abcd4 100644
--- a/certServiceK8sExternalProvider/src/certservice-controller/certservice_issuer_reconciler.go
+++ b/certServiceK8sExternalProvider/src/certservice-controller/certservice_issuer_reconciler.go
@@ -23,7 +23,6 @@
  * ============LICENSE_END=========================================================
  */
 
-
 package certservice_controller
 
 import (
@@ -51,18 +50,18 @@ type CertServiceIssuerReconciler struct {
 
 // Reconcile will read and validate the CertServiceIssuer resources, it will set the
 // status condition ready to true if everything is right.
-func (r *CertServiceIssuerReconciler) Reconcile(req ctrl.Request) (ctrl.Result, error) {
+func (reconciler *CertServiceIssuerReconciler) Reconcile(req ctrl.Request) (ctrl.Result, error) {
 	ctx := context.Background()
-	log := r.Log.WithValues("certservice-issuer-controller", req.NamespacedName)
+	log := reconciler.Log.WithValues("certservice-issuer-controller", req.NamespacedName)
 
-	iss := new(api.CertServiceIssuer)
-	if err := r.Client.Get(ctx, req.NamespacedName, iss); err != nil {
+	issuer := new(api.CertServiceIssuer)
+	if err := reconciler.Client.Get(ctx, req.NamespacedName, issuer); err != nil {
 		log.Error(err, "failed to retrieve CertServiceIssuer resource")
 		return ctrl.Result{}, client.IgnoreNotFound(err)
 	}
 
-	statusReconciler := newStatusReconciler(r, iss, log)
-	if err := validateCertServiceIssuerSpec(iss.Spec); err != nil {
+	statusReconciler := newStatusReconciler(reconciler, issuer, log)
+	if err := validateCertServiceIssuerSpec(issuer.Spec); err != nil {
 		log.Error(err, "failed to validate CertServiceIssuer resource")
 		statusReconciler.UpdateNoError(ctx, api.ConditionFalse, "Validation", "Failed to validate resource: %v", err)
 		return ctrl.Result{}, err
@@ -72,9 +71,9 @@ func (r *CertServiceIssuerReconciler) Reconcile(req ctrl.Request) (ctrl.Result,
 	var secret core.Secret
 	secretNamespaceName := types.NamespacedName{
 		Namespace: req.Namespace,
-		Name:      iss.Spec.KeyRef.Name,
+		Name:      issuer.Spec.KeyRef.Name,
 	}
-	if err := r.Client.Get(ctx, secretNamespaceName, &secret); err != nil {
+	if err := reconciler.Client.Get(ctx, secretNamespaceName, &secret); err != nil {
 		log.Error(err, "failed to retrieve CertServiceIssuer provisioner secret", "namespace", secretNamespaceName.Namespace, "name", secretNamespaceName.Name)
 		if apierrors.IsNotFound(err) {
 			statusReconciler.UpdateNoError(ctx, api.ConditionFalse, "NotFound", "Failed to retrieve provisioner secret: %v", err)
@@ -83,41 +82,41 @@ func (r *CertServiceIssuerReconciler) Reconcile(req ctrl.Request) (ctrl.Result,
 		}
 		return ctrl.Result{}, err
 	}
-	password, ok := secret.Data[iss.Spec.KeyRef.Key]
+	password, ok := secret.Data[issuer.Spec.KeyRef.Key]
 	if !ok {
-		err := fmt.Errorf("secret %s does not contain key %s", secret.Name, iss.Spec.KeyRef.Key)
+		err := fmt.Errorf("secret %s does not contain key %s", secret.Name, issuer.Spec.KeyRef.Key)
 		log.Error(err, "failed to retrieve CertServiceIssuer provisioner secret", "namespace", secretNamespaceName.Namespace, "name", secretNamespaceName.Name)
 		statusReconciler.UpdateNoError(ctx, api.ConditionFalse, "NotFound", "Failed to retrieve provisioner secret: %v", err)
 		return ctrl.Result{}, err
 	}
 
 	// Initialize and store the provisioner
-	p, err := provisioners.New(iss, password)
+	provisioner, err := provisioners.New(issuer, password)
 	if err != nil {
 		log.Error(err, "failed to initialize provisioner")
 		statusReconciler.UpdateNoError(ctx, api.ConditionFalse, "Error", "failed initialize provisioner")
 		return ctrl.Result{}, err
 	}
-	provisioners.Store(req.NamespacedName, p)
+	provisioners.Store(req.NamespacedName, provisioner)
 
 	return ctrl.Result{}, statusReconciler.Update(ctx, api.ConditionTrue, "Verified", "CertServiceIssuer verified and ready to sign certificates")
 }
 
 // SetupWithManager initializes the CertServiceIssuer controller into the controller
 // runtime.
-func (r *CertServiceIssuerReconciler) SetupWithManager(mgr ctrl.Manager) error {
-	return ctrl.NewControllerManagedBy(mgr).
+func (reconciler *CertServiceIssuerReconciler) SetupWithManager(manager ctrl.Manager) error {
+	return ctrl.NewControllerManagedBy(manager).
 		For(&api.CertServiceIssuer{}).
-		Complete(r)
+		Complete(reconciler)
 }
 
-func validateCertServiceIssuerSpec(s api.CertServiceIssuerSpec) error {
+func validateCertServiceIssuerSpec(issuerSpec api.CertServiceIssuerSpec) error {
 	switch {
-	case s.URL == "":
+	case issuerSpec.URL == "":
 		return fmt.Errorf("spec.url cannot be empty")
-	case s.KeyRef.Name == "":
+	case issuerSpec.KeyRef.Name == "":
 		return fmt.Errorf("spec.keyRef.name cannot be empty")
-	case s.KeyRef.Key == "":
+	case issuerSpec.KeyRef.Key == "":
 		return fmt.Errorf("spec.keyRef.key cannot be empty")
 	default:
 		return nil
diff --git a/certServiceK8sExternalProvider/src/certservice-controller/certservice_issuer_status_reconciler.go b/certServiceK8sExternalProvider/src/certservice-controller/certservice_issuer_status_reconciler.go
index c01ae85c..6dd8baea 100644
--- a/certServiceK8sExternalProvider/src/certservice-controller/certservice_issuer_status_reconciler.go
+++ b/certServiceK8sExternalProvider/src/certservice-controller/certservice_issuer_status_reconciler.go
@@ -23,7 +23,6 @@
  * ============LICENSE_END=========================================================
  */
 
-
 package certservice_controller
 
 import (
@@ -41,31 +40,31 @@ type certServiceIssuerStatusReconciler struct {
 	logger logr.Logger
 }
 
-func newStatusReconciler(r *CertServiceIssuerReconciler, iss *api.CertServiceIssuer, log logr.Logger) *certServiceIssuerStatusReconciler {
+func newStatusReconciler(reconciler *CertServiceIssuerReconciler, issuer *api.CertServiceIssuer, log logr.Logger) *certServiceIssuerStatusReconciler {
 	return &certServiceIssuerStatusReconciler{
-		CertServiceIssuerReconciler: r,
-		issuer:                      iss,
+		CertServiceIssuerReconciler: reconciler,
+		issuer:                      issuer,
 		logger:                      log,
 	}
 }
 
-func (r *certServiceIssuerStatusReconciler) Update(ctx context.Context, status api.ConditionStatus, reason, message string, args ...interface{}) error {
+func (reconciler *certServiceIssuerStatusReconciler) Update(ctx context.Context, status api.ConditionStatus, reason, message string, args ...interface{}) error {
 	completeMessage := fmt.Sprintf(message, args...)
-	r.setCondition(status, reason, completeMessage)
+	reconciler.setCondition(status, reason, completeMessage)
 
 	// Fire an Event to additionally inform users of the change
 	eventType := core.EventTypeNormal
 	if status == api.ConditionFalse {
 		eventType = core.EventTypeWarning
 	}
-	r.Recorder.Event(r.issuer, eventType, reason, completeMessage)
+	reconciler.Recorder.Event(reconciler.issuer, eventType, reason, completeMessage)
 
-	return r.Client.Status().Update(ctx, r.issuer)
+	return reconciler.Client.Status().Update(ctx, reconciler.issuer)
 }
 
-func (r *certServiceIssuerStatusReconciler) UpdateNoError(ctx context.Context, status api.ConditionStatus, reason, message string, args ...interface{}) {
-	if err := r.Update(ctx, status, reason, message, args...); err != nil {
-		r.logger.Error(err, "failed to update", "status", status, "reason", reason)
+func (reconciler *certServiceIssuerStatusReconciler) UpdateNoError(ctx context.Context, status api.ConditionStatus, reason, message string, args ...interface{}) {
+	if err := reconciler.Update(ctx, status, reason, message, args...); err != nil {
+		reconciler.logger.Error(err, "failed to update", "status", status, "reason", reason)
 	}
 }
 
@@ -78,9 +77,9 @@ func (r *certServiceIssuerStatusReconciler) UpdateNoError(ctx context.Context, s
 // - If a condition of the same type and different state already exists, the
 //   condition will be updated and the LastTransitionTime set to the current
 //   time.
-func (r *certServiceIssuerStatusReconciler) setCondition(status api.ConditionStatus, reason, message string) {
-	now := meta.NewTime(r.Clock.Now())
-	c := api.CertServiceIssuerCondition{
+func (reconciler *certServiceIssuerStatusReconciler) setCondition(status api.ConditionStatus, reason, message string) {
+	now := meta.NewTime(reconciler.Clock.Now())
+	issuerCondition := api.CertServiceIssuerCondition{
 		Type:               api.ConditionReady,
 		Status:             status,
 		Reason:             reason,
@@ -89,27 +88,27 @@ func (r *certServiceIssuerStatusReconciler) setCondition(status api.ConditionSta
 	}
 
 	// Search through existing conditions
-	for idx, cond := range r.issuer.Status.Conditions {
+	for i, condition := range reconciler.issuer.Status.Conditions {
 		// Skip unrelated conditions
-		if cond.Type != api.ConditionReady {
+		if condition.Type != api.ConditionReady {
 			continue
 		}
 
 		// If this update doesn't contain a state transition, we don't update
 		// the conditions LastTransitionTime to Now()
-		if cond.Status == status {
-			c.LastTransitionTime = cond.LastTransitionTime
+		if condition.Status == status {
+			issuerCondition.LastTransitionTime = condition.LastTransitionTime
 		} else {
-			r.logger.Info("found status change for CertServiceIssuer condition; setting lastTransitionTime", "condition", cond.Type, "old_status", cond.Status, "new_status", status, "time", now.Time)
+			reconciler.logger.Info("found status change for CertServiceIssuer condition; setting lastTransitionTime", "condition", condition.Type, "old_status", condition.Status, "new_status", status, "time", now.Time)
 		}
 
 		// Overwrite the existing condition
-		r.issuer.Status.Conditions[idx] = c
+		reconciler.issuer.Status.Conditions[i] = issuerCondition
 		return
 	}
 
 	// If we've not found an existing condition of this type, we simply insert
 	// the new condition into the slice.
-	r.issuer.Status.Conditions = append(r.issuer.Status.Conditions, c)
-	r.logger.Info("setting lastTransitionTime for CertServiceIssuer condition", "condition", api.ConditionReady, "time", now.Time)
+	reconciler.issuer.Status.Conditions = append(reconciler.issuer.Status.Conditions, issuerCondition)
+	reconciler.logger.Info("setting lastTransitionTime for CertServiceIssuer condition", "condition", api.ConditionReady, "time", now.Time)
 }