github.com/IBM-Blockchain/fabric-operator@v1.0.4/pkg/manager/resources/service/manager.go

/*
 * Copyright contributors to the Hyperledger Fabric Operator project
 *
 * SPDX-License-Identifier: Apache-2.0
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at:
 *
 * 	  http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package service

import (
	"context"
	"fmt"

	k8sclient "github.com/IBM-Blockchain/fabric-operator/pkg/k8s/controllerclient"
	"github.com/IBM-Blockchain/fabric-operator/pkg/manager/resources"
	"github.com/IBM-Blockchain/fabric-operator/pkg/operatorerrors"
	"github.com/IBM-Blockchain/fabric-operator/pkg/util"
	corev1 "k8s.io/api/core/v1"
	k8serrors "k8s.io/apimachinery/pkg/api/errors"
	v1 "k8s.io/apimachinery/pkg/apis/meta/v1"
	"k8s.io/apimachinery/pkg/runtime"
	"k8s.io/apimachinery/pkg/types"
	"sigs.k8s.io/controller-runtime/pkg/client"
	logf "sigs.k8s.io/controller-runtime/pkg/log"
)

var log = logf.Log.WithName("service_manager")

type Manager struct {
	Client      k8sclient.Client
	Scheme      *runtime.Scheme
	ServiceFile string
	Name        string
	CustomName  string

	LabelsFunc   func(v1.Object) map[string]string
	OverrideFunc func(v1.Object, *corev1.Service, resources.Action) error
}

func (m *Manager) GetName(instance v1.Object) string {
	if m.CustomName != "" {
		return m.CustomName
	}
	return GetName(instance.GetName(), m.Name)
}

func (m *Manager) Reconcile(instance v1.Object, update bool) error {
	name := m.GetName(instance)

	err := m.Client.Get(context.TODO(), types.NamespacedName{Name: name, Namespace: instance.GetNamespace()}, &corev1.Service{})
	if err != nil {
		if k8serrors.IsNotFound(err) {
			log.Info(fmt.Sprintf("Creating service '%s'", name))
			service, err := m.GetServiceBasedOnCRFromFile(instance)
			if err != nil {
				return err
			}

			err = m.Client.Create(context.TODO(), service, k8sclient.CreateOption{Owner: instance, Scheme: m.Scheme})
			if err != nil {
				return err
			}
			return nil
		}
		return err
	}

	// TODO: If needed, update logic for servie goes here

	return nil
}

func (m *Manager) GetServiceBasedOnCRFromFile(instance v1.Object) (*corev1.Service, error) {
	service, err := util.GetServiceFromFile(m.ServiceFile)
	if err != nil {
		log.Error(err, fmt.Sprintf("Error reading service configuration file: %s", m.ServiceFile))
		return nil, err
	}

	service.Name = m.GetName(instance)
	service.Namespace = instance.GetNamespace()
	service.Labels = m.LabelsFunc(instance)
	service.Spec.Selector = m.getSelectorLabels(instance)

	return m.BasedOnCR(instance, service)
}

func (m *Manager) BasedOnCR(instance v1.Object, service *corev1.Service) (*corev1.Service, error) {
	if m.OverrideFunc != nil {
		err := m.OverrideFunc(instance, service, resources.Create)
		if err != nil {
			return nil, operatorerrors.New(operatorerrors.InvalidServiceCreateRequest, err.Error())
		}
	}

	return service, nil
}

func (m *Manager) getSelectorLabels(instance v1.Object) map[string]string {
	labels := m.LabelsFunc(instance)
	return labels
}

func (m *Manager) Get(instance v1.Object) (client.Object, error) {
	if instance == nil {
		return nil, nil // Instance has not been reconciled yet
	}

	name := m.GetName(instance)
	service := &corev1.Service{}
	err := m.Client.Get(context.TODO(), types.NamespacedName{Name: name, Namespace: instance.GetNamespace()}, service)
	if err != nil {
		return nil, err
	}

	return service, nil
}

func (m *Manager) Exists(instance v1.Object) bool {
	_, err := m.Get(instance)
	if err != nil {
		return false
	}

	return true
}

func (m *Manager) Delete(instance v1.Object) error {
	service, err := m.Get(instance)
	if err != nil {
		if !k8serrors.IsNotFound(err) {
			return err
		}
	}

	if service == nil {
		return nil
	}

	err = m.Client.Delete(context.TODO(), service)
	if err != nil {
		if !k8serrors.IsNotFound(err) {
			return err
		}
	}

	return nil
}

func (m *Manager) CheckState(instance v1.Object) error {
	// NO-OP
	return nil
}

func (m *Manager) RestoreState(instance v1.Object) error {
	// NO-OP
	return nil
}

func (m *Manager) SetCustomName(name string) {
	m.CustomName = name
}

func GetName(instanceName string, suffix ...string) string {
	if len(suffix) != 0 {
		if suffix[0] != "" {
			return fmt.Sprintf("%s%s", instanceName, suffix[0])
		}
	}
	return fmt.Sprintf("%s", instanceName)
}