parameter_helper.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 parameters

import (
	"errors"

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

// GetEnvVar return the EnvVar to set in the container.
func (p *Parameter) GetEnvVar() (envVar corev1.EnvVar, err error) {
	switch p.MountType {
	case MountLiteral:
		if len(p.Value) > 0 && len(p.Key) > 0 {
			envVar := corev1.EnvVar{
				Name:  p.Key,
				Value: p.Value,
			}
			return envVar, nil
		}
		return envVar, errors.New("missing key and/or value argument")

	case MountFrom:
		if len(p.FromKey) > 0 && len(p.Ref) > 0 && len(p.Key) > 0 {
			switch p.Type {
			case SecretParameter:
				envVar = corev1.EnvVar{
					Name: p.Key,
					ValueFrom: &corev1.EnvVarSource{
						SecretKeyRef: &corev1.SecretKeySelector{
							LocalObjectReference: corev1.LocalObjectReference{
								Name: p.Ref,
							},
							Key: p.FromKey,
						},
					},
				}
				return envVar, nil

			case ConfigParameter:
				envVar = corev1.EnvVar{
					Name: p.Key,
					ValueFrom: &corev1.EnvVarSource{
						ConfigMapKeyRef: &corev1.ConfigMapKeySelector{
							LocalObjectReference: corev1.LocalObjectReference{
								Name: p.Ref,
							},
							Key: p.FromKey,
						},
					},
				}
				return envVar, nil

			case ObjectFieldParameter:
				envVar = corev1.EnvVar{
					Name: p.Key,
					ValueFrom: &corev1.EnvVarSource{
						FieldRef: &corev1.ObjectFieldSelector{
							APIVersion: p.Ref,
							FieldPath:  p.FromKey,
						},
					},
				}
				return envVar, nil
			}
		}
		return envVar, errors.New("missing arguments")

	default:
		return envVar, errors.New("wrong MountType")
	}
}

// GetPodVolume return the Volume to set in the pod.
func (p *Parameter) GetPodVolume() corev1.Volume {

	volumeSource := corev1.VolumeSource{}

	if p.Type == ConfigParameter {
		volumeSource = corev1.VolumeSource{
			ConfigMap: &corev1.ConfigMapVolumeSource{
				LocalObjectReference: corev1.LocalObjectReference{
					Name: p.ValueFrom.Ref,
				},
				Items: []corev1.KeyToPath{
					{
						Key:  p.Key,
						Path: p.MountPath.SubPath,
					},
				},
			},
		}
	} else {
		volumeSource = corev1.VolumeSource{
			Secret: &corev1.SecretVolumeSource{
				SecretName: p.ValueFrom.Ref,
				Items: []corev1.KeyToPath{
					{
						Key:  p.Key,
						Path: p.MountPath.SubPath,
					},
				},
			},
		}
	}

	volume := corev1.Volume{
		Name:         p.Key,
		VolumeSource: volumeSource,
	}

	return volume
}

// GetVolumeMount returns the VolumeMount to set in the container.
func (p *Parameter) GetVolumeMount() corev1.VolumeMount {
	return corev1.VolumeMount{
		Name:      p.Key,
		ReadOnly:  true,
		MountPath: p.MountPath.Path,
		SubPath:   p.MountPath.SubPath,
	}
}

// IsRand if the the parameter is randomly generated.
func (p *Parameter) IsRand() bool {
	// TODO if should generate random, is we add other types it will fail
	if p.Generate != GenerateTemplate && p.Generate != "" {
		return true
	}
	return false
}

// IsMount returns  if the parameter is mounted in a secret or configmap
func (p *Parameter) IsMount() bool {
	if p.MountType == MountEnvFile || p.MountType == MountFile {
		return true
	}
	return false
}