settings.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/application/settings/parameters"
	"k8s.libre.sh/interfaces"
	"k8s.libre.sh/meta"
	"k8s.libre.sh/objects"
	"k8s.libre.sh/objects/configmap"
	"k8s.libre.sh/objects/secret"
	"sigs.k8s.io/controller-runtime/pkg/client"

	corev1 "k8s.io/api/core/v1"
)

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

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
}

func GetObjects(s Component) map[int]objects.Object {

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

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

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

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

	for _, p := range *s.GetConfig().GetParameters() {

		if p.IsMount() && len(p.Value) > 0 {
			if p.Type == parameters.SecretParameter || p.Type == "" {
				if p.IsRand() {
					genSecretParams = append(genSecretParams, p.Key)
				}
				secret.Parameters = append(secret.Parameters, p)
			}
			if p.Type == parameters.ConfigParameter {
				if p.IsRand() {
					genConfigParams = append(genConfigParams, p.Key)
				}
				cm.Parameters = append(cm.Parameters, p)
			}
		}
	}
	// Sort annotations as it is sorted in kubernetes and will have a diff otherwise
	sort.Strings(genConfigParams)
	sort.Strings(genSecretParams)

	// secretAnnot := Annotations(genSecretParams)
	// configAnnot := Annotations(genConfigParams)

	// 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(secret.ObjectMeta.Annotations) == 0 {
			cm.ObjectMeta.Annotations = make(map[string]string, 1)
		}
		secret.ObjectMeta.Annotations["settings.k8s.libre.sh/generate"] = strings.Join(genConfigParams, ",")
	}

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

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

	return objs

}

func Init(s Component, c client.Client, owner interfaces.Object) 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)

	if err != nil {
		return err
	}

	s.GetParameters().InitRandValues()

	if err != nil {
		return err
	}

	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 created when needed
// Only Secrets and Configmaps are supported
func InitParametersValueFrom(s Component, c client.Client, owner interfaces.Object) error {

	err := s.GetParameters().InitValueFrom(c, owner)
	if err != nil {
		return err
	}

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

	s.GetParameters().Merge(ps)

	secretSrc := Source{
		Ref:  s.GetCreateOptions().SecretMeta.GetName(),
		Type: "secret",
	}
	configSrc := Source{
		Ref:  s.GetCreateOptions().ConfigMeta.GetName(),
		Type: "configmap",
	}

	srcs := &Sources{}
	// Reset sources, we do not want to mount orginal resources
	if s.GetCreateOptions().Generate == GenEnvFile {
		srcs = &Sources{}
	}

	// s.GetParameters().Merge(params)

	// TODO IMPROVE
	for _, p := range *s.GetParameters() {
		if p.MountType == parameters.MountEnvFile || s.GetCreateOptions().Generate == GenEnvFile {
			p.MountType = parameters.MountEnvFile
			// add newly created resource ref to sources
			if p.Type == parameters.ConfigParameter {
				srcs = AppendSourceIfUnique(srcs, configSrc)
			} else if p.Type == parameters.SecretParameter || p.Type == "" {
				srcs = AppendSourceIfUnique(srcs, secretSrc)
			}
			// Reset valueFrom, we do not want to mount orginal resources
			p.ValueFrom = parameters.ValueFrom{}
		}

		if s.GetCreateOptions().SettingsType == "configmap" {
			p.Type = parameters.ConfigParameter
		} else if s.GetCreateOptions().SettingsType == "secret" {
			p.Type = parameters.SecretParameter
		}

		if p.MountType == parameters.MountFile && len(p.Ref) == 0 {
			if p.Type == parameters.ConfigParameter {
				p.Ref = s.GetCreateOptions().ConfigMeta.GetName()

			}
			if p.Type == parameters.SecretParameter {
				p.Ref = s.GetCreateOptions().SecretMeta.GetName()

			}
		}
	}

	srcs.DeepCopyInto(s.GetSources())

	return nil
}

func ParametersFromSources(srcs *Sources, c client.Client, owner interfaces.Object) (*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)
	if err != nil {
		return ps, err
	}

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

}

func OrderByResourceRef(s Component) (secrets, configMaps map[string]*parameters.Parameters) {
	secrets = make(map[string]*parameters.Parameters)
	configMaps = make(map[string]*parameters.Parameters)

	for _, source := range *s.GetSources() {
		if source.Type == "secret" {
			secrets[source.Ref] = &parameters.Parameters{}
		} else if source.Type == "configmap" {
			configMaps[source.Ref] = &parameters.Parameters{}
		}
	}

	// Then we get the sources that are provided for each parameters and will need a transformation
	for _, p := range *s.GetParameters() {
		if p != nil {
			// TOFIX only refType ? by default secret ?
			if len(p.ValueFrom.Ref) > 0 && (p.Type == parameters.SecretParameter || p.RefType == "secret") {
				// TODO add a warning, if secret given a source and in valuefrom only keys in valuefrom will be fetched
				if secrets[p.ValueFrom.Ref] == nil {
					secrets[p.ValueFrom.Ref] = &parameters.Parameters{}
				}
				*secrets[p.ValueFrom.Ref] = append(*secrets[p.ValueFrom.Ref], p)
			}
			if len(p.ValueFrom.Ref) > 0 && (p.Type == parameters.ConfigParameter || p.RefType == "configmap") {
				if configMaps[p.ValueFrom.Ref] == nil {
					configMaps[p.ValueFrom.Ref] = &parameters.Parameters{}
				}
				*configMaps[p.ValueFrom.Ref] = append(*configMaps[p.ValueFrom.Ref], p)
			}
		}

	}

	return secrets, configMaps
}