component.go

/*

Licensed under the GNU AFFERO GENERAL PUBLIC LICENSE Version 3 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    https://www.gnu.org/licenses/agpl-3.0.html

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 settings

import (
	"sort"
	"strings"

	"k8s.libre.sh/controller-utils/application/settings/parameters"
	"k8s.libre.sh/controller-utils/interfaces"
	"k8s.libre.sh/controller-utils/meta"
	"k8s.libre.sh/controller-utils/objects"
	"k8s.libre.sh/controller-utils/objects/configmap"
	"k8s.libre.sh/controller-utils/objects/secret"
	"sigs.k8s.io/controller-runtime/pkg/client"

	corev1 "k8s.io/api/core/v1"
	"k8s.io/apimachinery/pkg/runtime"
)

type Component interface {
	GetMeta() meta.Instance
	GetConfig() Config
	SetDefaults()
	Config
	GetCreateOptions() *CreateOptions
	GetObjects() map[int]objects.Object
}

// TemplateValues returns the component as values for the template function
func TemplateValues(s Component) map[string]interface{} {

	values := make(map[string]interface{})

	keyPairValues := parameters.KeyPairValues(s.GetConfig().GetParameters())
	values[s.GetMeta().GetComponent()] = keyPairValues

	return values
}

// GetObjects returns an ordered list of objects.Object interfaces.
// Annotations are added for the generated parameters.
// Only secrets and configmaps are supported.
func GetObjects(s Component) map[int]objects.Object {

	cm := &configmap.ConfigMap{
		ObjectMeta: s.GetCreateOptions().ConfigMeta,
		Data:       s.GetParameters().GetConfigData(),
	}

	secret := &secret.Secret{
		ObjectMeta: s.GetCreateOptions().SecretMeta,
		Data:       s.GetParameters().GetSecretData(),
	}

	objs := make(map[int]objects.Object, 2)

	genConfigParams := []string{}
	genSecretParams := []string{}

	for _, p := range *s.GetConfig().GetParameters() {
		if p.IsMount() && len(p.Value) > 0 && p.IsRand() {
			switch p.Type {
			case parameters.SecretParameter, "":
				genSecretParams = append(genSecretParams, p.Key)
			case parameters.ConfigParameter:
				genConfigParams = append(genConfigParams, p.Key)
			}
		}
	}

	// Sort annotations as it is sorted in kubernetes and will have a diff otherwise
	sort.Strings(genConfigParams)
	sort.Strings(genSecretParams)

	// TODO TO FIX remove annotation if secret is not generated anymore
	if len(genSecretParams) > 0 {
		if len(secret.ObjectMeta.Annotations) == 0 {
			secret.ObjectMeta.Annotations = make(map[string]string, 1)
		}
		secret.ObjectMeta.Annotations["settings.k8s.libre.sh/generate"] = strings.Join(genSecretParams, ",")
	}

	if len(genConfigParams) > 0 {
		if len(cm.ObjectMeta.Annotations) == 0 {
			cm.ObjectMeta.Annotations = make(map[string]string, 1)
		}
		cm.ObjectMeta.Annotations["settings.k8s.libre.sh/generate"] = strings.Join(genConfigParams, ",")
	}

	if len(secret.Data) > 0 {
		objs[0] = secret
	}

	if len(cm.Data) > 0 {
		objs[1] = cm
	}

	return objs

}

func GetGenAnnotionForType(ps *parameters.Parameters, pType parameters.ParameterType) map[string]string {
	list := []string{}
	annot := make(map[string]string)

	for _, p := range *ps {
		if p.IsMount() && len(p.Value) > 0 && p.IsRand() && p.Type == pType {
			list = append(list, p.Key)
		}
	}

	if len(list) > 0 {
		annot["settings.k8s.libre.sh/generate"] = strings.Join(list, ",")
	}

	return annot

}

func GetConfigGenAnnotion(ps *parameters.Parameters) map[string]string {
	list := []string{}
	annot := make(map[string]string)

	for _, p := range *ps {
		if p.IsMount() && len(p.Value) > 0 && p.IsRand() && p.Type == parameters.ConfigParameter {
			list = append(list, p.Key)
		}
	}

	if len(list) > 0 {
		annot["settings.k8s.libre.sh/generate"] = strings.Join(list, ",")
	}

	return annot
}

func GetSecretGenAnnotion(ps *parameters.Parameters) map[string]string {
	list := []string{}
	annot := make(map[string]string)

	for _, p := range *ps {
		if p.IsMount() && len(p.Value) > 0 && p.IsRand() && (p.Type == parameters.SecretParameter || p.Type == "") {
			list = append(list, p.Key)
		}
	}

	if len(list) > 0 {
		annot["settings.k8s.libre.sh/generate"] = strings.Join(list, ",")
	}

	return annot
}

func Init(s Component, c client.Client, owner interfaces.Object, scheme *runtime.Scheme) error {

	opts := s.GetCreateOptions()
	if opts == nil {
		opts = &CreateOptions{}
	}
	opts.Init()

	meta.SetObjectMeta(opts.CommonMeta, opts.ConfigMeta)
	meta.SetObjectMeta(opts.CommonMeta, opts.SecretMeta)

	err := InitParametersValueFrom(s, c, owner, scheme)

	if err != nil {
		return err
	}

	s.GetParameters().InitRandValues()

	return nil
}

// InitParametersValueFrom intialise the parameters with values provided in external resources in the same namespace.
// All parameters values are filled from those resources and new parameters are appended.
// Only Secrets and Configmaps are supported.
func InitParametersValueFrom(s Component, c client.Client, owner interfaces.Object, scheme *runtime.Scheme) error {

	// TO DO TO FIX, InitValueFrom and ParametersFromSources do the same thing ?
	err := s.GetParameters().InitValueFrom(c, owner, scheme)
	if err != nil {
		return err
	}

	ps, err := ParametersFromSources(s.GetSources(), c, owner, scheme)

	if err != nil {
		return err
	}

	s.GetParameters().Merge(ps)

	return nil
}

// ParametersFromSources returns the parameters from external resources that are provided in the sources.
// Owner is provided to check if resources is owned in that case, only generated data defined in the annotations are fetched.
// Only Secrets and Configmaps are supported.
func ParametersFromSources(srcs *Sources, c client.Client, owner interfaces.Object, scheme *runtime.Scheme) (*parameters.Parameters, error) {

	var obj interfaces.Object
	ps := &parameters.Parameters{}

	for _, src := range *srcs {
		switch src.Type {
		case "configmap":
			obj = &corev1.ConfigMap{}
		case "secret":
			obj = &corev1.Secret{}
		default:
			return ps, nil
		}
		obj.SetName(src.Ref)
		obj.SetNamespace(owner.GetNamespace())

	}

	data, err := parameters.GetDataFromResource(c, obj, owner, scheme)
	if err != nil {
		return ps, err
	}

	if len(data) > 0 {
		for k, v := range data {
			*ps = append(*ps, &parameters.Parameter{
				Value: v,
				Key:   k,
			})
		}
	}

	return ps, nil

}