validation

Documentation

Overview

Miscellaneous functions to validate that required proto and spec fields are non empty when required for execution.

Index

• func CheckAndFetchInputsForExecution(userInputs *core.LiteralMap, fixedInputs *core.LiteralMap, ...) (*core.LiteralMap, error)
• func CheckValidExecutionID(executionID, fieldName string) error
• func SetDefaults(ctx context.Context, taskConfig runtime.TaskResourceConfiguration, ...)
• func ValidateActiveLaunchPlanListRequest(request admin.ActiveLaunchPlanListRequest) error
• func ValidateActiveLaunchPlanRequest(request admin.ActiveLaunchPlanRequest) error
• func ValidateCompiledWorkflow(identifier core.Identifier, workflow admin.WorkflowClosure, ...) error
• func ValidateCreateWorkflowEventRequest(request admin.WorkflowExecutionEventRequest) error
• func ValidateEmptyStringField(field, fieldName string) error
• func ValidateExecutionRequest(ctx context.Context, request admin.ExecutionCreateRequest, ...) error
• func ValidateIdentifier(id *core.Identifier, expectedType common.Entity) error
• func ValidateLaunchPlan(ctx context.Context, request admin.LaunchPlanCreateRequest, ...) error
• func ValidateLimit(limit uint32) error
• func ValidateMaxLengthStringField(field string, fieldName string, limit int) error
• func ValidateNamedEntityIdentifierListRequest(request admin.NamedEntityIdentifierListRequest) error
• func ValidateNodeExecutionForTaskListRequest(request admin.NodeExecutionForTaskListRequest) error
• func ValidateNodeExecutionIdentifier(identifier *core.NodeExecutionIdentifier) error
• func ValidateNodeExecutionListRequest(request admin.NodeExecutionListRequest) error
• func ValidateProjectAndDomain(ctx context.Context, db repositories.RepositoryInterface, ...) error
• func ValidateProjectRegisterRequest(request admin.ProjectRegisterRequest) error
• func ValidateResourceListRequest(request admin.ResourceListRequest) error
• func ValidateTask(ctx context.Context, request admin.TaskCreateRequest, ...) error
• func ValidateTaskExecutionIdentifier(identifier *core.TaskExecutionIdentifier) error
• func ValidateTaskExecutionListRequest(request admin.TaskExecutionListRequest) error
• func ValidateTaskExecutionRequest(request admin.TaskExecutionEventRequest) error
• func ValidateToken(token string) (int, error)
• func ValidateVersion(version string) error
• func ValidateWorkflow(ctx context.Context, request admin.WorkflowCreateRequest, ...) error
• func ValidateWorkflowExecutionIdentifier(identifier *core.WorkflowExecutionIdentifier) error

Functions

func CheckAndFetchInputsForExecution

func CheckAndFetchInputsForExecution(
	userInputs *core.LiteralMap, fixedInputs *core.LiteralMap, expectedInputs *core.ParameterMap) (*core.LiteralMap, error)

func CheckValidExecutionID

func CheckValidExecutionID(executionID, fieldName string) error

func SetDefaults

func SetDefaults(ctx context.Context, taskConfig runtime.TaskResourceConfiguration, task *core.CompiledTask)

Assumes input contains a compiled task with a valid container resource execConfig.

Note: The system will assign a system-default value for request but for limit it will deduce it from the request itself => Limit := Min([Some-Multiplier X Request], System-Max). For now we are using a multiplier of 1. In general we recommend the users to set limits close to requests for more predictability in the system.

func ValidateActiveLaunchPlanListRequest

func ValidateActiveLaunchPlanListRequest(request admin.ActiveLaunchPlanListRequest) error

func ValidateActiveLaunchPlanRequest

func ValidateActiveLaunchPlanRequest(request admin.ActiveLaunchPlanRequest) error

func ValidateCompiledWorkflow

func ValidateCompiledWorkflow(identifier core.Identifier, workflow admin.WorkflowClosure, config runtime.RegistrationValidationConfiguration) error

func ValidateCreateWorkflowEventRequest

func ValidateCreateWorkflowEventRequest(request admin.WorkflowExecutionEventRequest) error

func ValidateEmptyStringField

func ValidateEmptyStringField(field, fieldName string) error

func ValidateExecutionRequest

func ValidateExecutionRequest(ctx context.Context, request admin.ExecutionCreateRequest,
	db repositories.RepositoryInterface, config runtimeInterfaces.ApplicationConfiguration) error

func ValidateIdentifier

func ValidateIdentifier(id *core.Identifier, expectedType common.Entity) error

Validates that all required fields for an identifier are present.

func ValidateLaunchPlan

func ValidateLaunchPlan(ctx context.Context,
	request admin.LaunchPlanCreateRequest, db repositories.RepositoryInterface,
	config runtimeInterfaces.ApplicationConfiguration, workflowInterface *core.TypedInterface) error

func ValidateLimit

func ValidateLimit(limit uint32) error

func ValidateMaxLengthStringField

func ValidateMaxLengthStringField(field string, fieldName string, limit int) error

Validates that a string field does not exceed a certain character count

func ValidateNamedEntityIdentifierListRequest

func ValidateNamedEntityIdentifierListRequest(request admin.NamedEntityIdentifierListRequest) error

func ValidateNodeExecutionForTaskListRequest

func ValidateNodeExecutionForTaskListRequest(request admin.NodeExecutionForTaskListRequest) error

func ValidateNodeExecutionIdentifier

func ValidateNodeExecutionIdentifier(identifier *core.NodeExecutionIdentifier) error

func ValidateNodeExecutionListRequest

func ValidateNodeExecutionListRequest(request admin.NodeExecutionListRequest) error

func ValidateProjectAndDomain

func ValidateProjectAndDomain(
	ctx context.Context, db repositories.RepositoryInterface, config runtimeInterfaces.ApplicationConfiguration, projectID, domainID string) error

Validates that a specified project and domain combination has been registered and exists in the db.

func ValidateProjectRegisterRequest

func ValidateProjectRegisterRequest(request admin.ProjectRegisterRequest) error

func ValidateResourceListRequest

func ValidateResourceListRequest(request admin.ResourceListRequest) error

func ValidateTask

func ValidateTask(
	ctx context.Context, request admin.TaskCreateRequest, db repositories.RepositoryInterface,
	taskConfig runtime.TaskResourceConfiguration, whitelistConfig runtime.WhitelistConfiguration,
	applicationConfig runtime.ApplicationConfiguration) error

func ValidateTaskExecutionIdentifier

func ValidateTaskExecutionIdentifier(identifier *core.TaskExecutionIdentifier) error

func ValidateTaskExecutionListRequest

func ValidateTaskExecutionListRequest(request admin.TaskExecutionListRequest) error

func ValidateTaskExecutionRequest

func ValidateTaskExecutionRequest(request admin.TaskExecutionEventRequest) error

func ValidateToken

func ValidateToken(token string) (int, error)

Offsets are encoded as string tokens to enable future api pagination changes. In addition to validating that an offset is a valid integer, we assert that it is non-negative.

func ValidateVersion

func ValidateVersion(version string) error

func ValidateWorkflow

func ValidateWorkflow(
	ctx context.Context, request admin.WorkflowCreateRequest, db repositories.RepositoryInterface,
	config runtime.ApplicationConfiguration) error

func ValidateWorkflowExecutionIdentifier

func ValidateWorkflowExecutionIdentifier(identifier *core.WorkflowExecutionIdentifier) error