porter/internal/porter_app/environment.go

package porter_app

import (
	"context"
	"fmt"

	porterv1 "github.com/porter-dev/api-contracts/generated/go/porter/v1"
	"github.com/porter-dev/porter/internal/deployment_target"
	"github.com/porter-dev/porter/internal/kubernetes"
	"github.com/porter-dev/porter/internal/kubernetes/environment_groups"
	"github.com/porter-dev/porter/internal/repository"
	"github.com/porter-dev/porter/internal/telemetry"
)

type envVariarableOptions struct {
	includeSecrets             bool
	envGroups                  []string
	excludeDefaultAppEnvGroups bool
}

// EnvVariableOption is a function that modifies AppEnvironmentFromProto
type EnvVariableOption func(*envVariarableOptions)

// WithSecrets includes secrets in the environment groups
func WithSecrets() EnvVariableOption {
	return func(opts *envVariarableOptions) {
		opts.includeSecrets = true
	}
}

// WithEnvGroupFilter filters the environment groups to only include the ones in this list of names
func WithEnvGroupFilter(envGroups []string) EnvVariableOption {
	return func(opts *envVariarableOptions) {
		opts.envGroups = envGroups
	}
}

// WithoutDefaultAppEnvGroups filters out the default app environment groups from the returned list
func WithoutDefaultAppEnvGroups() EnvVariableOption {
	return func(opts *envVariarableOptions) {
		opts.excludeDefaultAppEnvGroups = true
	}
}

// AppEnvironmentFromProtoInput is the input struct for AppEnvironmentFromProto
type AppEnvironmentFromProtoInput struct {
	ProjectID        uint
	ClusterID        int
	DeploymentTarget deployment_target.DeploymentTarget
	App              *porterv1.PorterApp
	K8SAgent         *kubernetes.Agent
}

// AppEnvironmentFromProto returns all envfironment groups referenced in an app proto with their variables
func AppEnvironmentFromProto(ctx context.Context, inp AppEnvironmentFromProtoInput, varOpts ...EnvVariableOption) ([]environment_groups.EnvironmentGroup, error) {
	ctx, span := telemetry.NewSpan(ctx, "porter-app-env-from-proto")
	defer span.End()

	envGroups := []environment_groups.EnvironmentGroup{}

	if inp.ProjectID == 0 {
		return nil, telemetry.Error(ctx, span, nil, "must provide a project id")
	}
	if inp.ClusterID == 0 {
		return nil, telemetry.Error(ctx, span, nil, "must provide a cluster id")
	}
	if inp.App == nil {
		return nil, telemetry.Error(ctx, span, nil, "must provide an app")
	}
	if inp.K8SAgent == nil {
		return nil, telemetry.Error(ctx, span, nil, "must provide a kubernetes agent")
	}

	var opts envVariarableOptions
	for _, opt := range varOpts {
		opt(&opts)
	}

	filteredEnvGroups := inp.App.EnvGroups
	if len(opts.envGroups) > 0 {
		filteredEnvGroups = []*porterv1.EnvGroup{}
		for _, envGroup := range inp.App.EnvGroups {
			for _, envGroupName := range opts.envGroups {
				if envGroup.GetName() == envGroupName {
					filteredEnvGroups = append(filteredEnvGroups, envGroup)
				}
			}
		}
	}

	for _, envGroupRef := range filteredEnvGroups {
		envGroup, err := environment_groups.EnvironmentGroupInTargetNamespace(ctx, inp.K8SAgent, environment_groups.EnvironmentGroupInTargetNamespaceInput{
			Name:                              envGroupRef.GetName(),
			Version:                           int(envGroupRef.GetVersion()),
			Namespace:                         inp.DeploymentTarget.Namespace,
			ExcludeDefaultAppEnvironmentGroup: opts.excludeDefaultAppEnvGroups,
		})
		if err != nil {
			return nil, telemetry.Error(ctx, span, err, "error getting environment group in target namespace")
		}

		if !opts.includeSecrets {
			envGroup.SecretVariables = nil
		}

		// if envGroup.Name is empty, it means the environment group was a default app environment group and was filtered out
		if envGroup.Name != "" {
			envGroups = append(envGroups, envGroup)
		}
	}

	return envGroups, nil
}

// AppEnvGroupName returns the name of the environment group for the app
func AppEnvGroupName(ctx context.Context, appName string, deploymentTargetId string, clusterID uint, porterAppRepository repository.PorterAppRepository) (string, error) {
	ctx, span := telemetry.NewSpan(ctx, "app-env-group-name")
	defer span.End()

	if appName == "" {
		return "", telemetry.Error(ctx, span, nil, "app name is empty")
	}
	telemetry.WithAttributes(span, telemetry.AttributeKV{Key: "app-name", Value: appName})

	if deploymentTargetId == "" {
		return "", telemetry.Error(ctx, span, nil, "deployment target id is empty")
	}
	telemetry.WithAttributes(span, telemetry.AttributeKV{Key: "deployment-target-id", Value: deploymentTargetId})

	if clusterID == 0 {
		return "", telemetry.Error(ctx, span, nil, "cluster id is empty")
	}
	telemetry.WithAttributes(span, telemetry.AttributeKV{Key: "cluster-id", Value: clusterID})

	porterApp, err := porterAppRepository.ReadPorterAppByName(clusterID, appName)
	if err != nil {
		return "", telemetry.Error(ctx, span, err, "error reading porter app by name")
	}
	telemetry.WithAttributes(span, telemetry.AttributeKV{Key: "porter-app-id", Value: porterApp.ID})

	if len(deploymentTargetId) < 6 {
		return "", telemetry.Error(ctx, span, nil, "deployment target id is too short")
	}

	return fmt.Sprintf("%d-%s", porterApp.ID, deploymentTargetId[:6]), nil
}

// AppTemplateEnvGroupName returns the name of the environment group for an app template
func AppTemplateEnvGroupName(ctx context.Context, appName string, clusterID uint, porterAppRepository repository.PorterAppRepository) (string, error) {
	ctx, span := telemetry.NewSpan(ctx, "app-template-env-group-name")
	defer span.End()

	if appName == "" {
		return "", telemetry.Error(ctx, span, nil, "app name is empty")
	}
	telemetry.WithAttributes(span, telemetry.AttributeKV{Key: "app-name", Value: appName})

	if clusterID == 0 {
		return "", telemetry.Error(ctx, span, nil, "cluster id is empty")
	}
	telemetry.WithAttributes(span, telemetry.AttributeKV{Key: "cluster-id", Value: clusterID})

	porterApp, err := porterAppRepository.ReadPorterAppByName(clusterID, appName)
	if err != nil {
		return "", telemetry.Error(ctx, span, err, "error reading porter app by name")
	}
	telemetry.WithAttributes(span, telemetry.AttributeKV{Key: "porter-app-id", Value: porterApp.ID})

	return fmt.Sprintf("%d-template-preview", porterApp.ID), nil
}