Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Improve and refactor validation for AnalysisTemplates #1117

Merged
merged 15 commits into from
May 10, 2021
Merged

fix: Improve and refactor validation for AnalysisTemplates #1117

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
7448d66
fix: Improve and refactor validation for AnalysisTemplates
khhirani Apr 27, 2021
fcd52bc
Merge upstream/master
khhirani May 5, 2021
79d8645
Modify validation_references.go
khhirani May 5, 2021
67a2bb6
Comment out failing tests
khhirani May 5, 2021
b8eebb7
Comment out failing tests
khhirani May 5, 2021
fde1429
Add newline for linting
khhirani May 5, 2021
15435d1
Remove tests from analysis_test.go that no longer fit expected behavior
khhirani May 5, 2021
b783b5c
Fix analysis_test.go
khhirani May 5, 2021
0bd305f
Fix existing tests
khhirani May 5, 2021
018e923
Fix validation_references_test.go
khhirani May 5, 2021
97043a6
Make lint
khhirani May 5, 2021
b2dc870
Remove comments
khhirani May 5, 2021
412e286
Modify validation_references_test.go
khhirani May 6, 2021
f3ce1b2
Improve coverage for validation_references_test.go
khhirani May 6, 2021
28e6d27
Make lint
khhirani May 6, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
87 changes: 57 additions & 30 deletions pkg/apis/rollouts/validation/validation_references.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,11 @@ const (
BackgroundAnalysis AnalysisTemplateType = "BackgroundAnalysis"
)

type AnalysisTemplateWithType struct {
AnalysisTemplate *v1alpha1.AnalysisTemplate
ClusterAnalysisTemplate *v1alpha1.ClusterAnalysisTemplate
TemplateType AnalysisTemplateType
AnalysisIndex int
// Used only for InlineAnalysis
type AnalysisTemplatesWithType struct {
AnalysisTemplates []*v1alpha1.AnalysisTemplate
ClusterAnalysisTemplates []*v1alpha1.ClusterAnalysisTemplate
TemplateType AnalysisTemplateType
// CanaryStepIndex only used for InlineAnalysis
CanaryStepIndex int
}

Expand All @@ -54,20 +53,20 @@ type ServiceWithType struct {
}

type ReferencedResources struct {
AnalysisTemplateWithType []AnalysisTemplateWithType
Ingresses []v1beta1.Ingress
ServiceWithType []ServiceWithType
VirtualServices []unstructured.Unstructured
AmbassadorMappings []unstructured.Unstructured
AnalysisTemplatesWithType []AnalysisTemplatesWithType
Ingresses []v1beta1.Ingress
ServiceWithType []ServiceWithType
VirtualServices []unstructured.Unstructured
AmbassadorMappings []unstructured.Unstructured
}

func ValidateRolloutReferencedResources(rollout *v1alpha1.Rollout, referencedResources ReferencedResources) field.ErrorList {
allErrs := field.ErrorList{}
for _, service := range referencedResources.ServiceWithType {
allErrs = append(allErrs, ValidateService(service, rollout)...)
}
for _, template := range referencedResources.AnalysisTemplateWithType {
allErrs = append(allErrs, ValidateAnalysisTemplateWithType(rollout, template)...)
for _, templates := range referencedResources.AnalysisTemplatesWithType {
allErrs = append(allErrs, ValidateAnalysisTemplatesWithType(rollout, templates)...)
}
for _, ingress := range referencedResources.Ingresses {
allErrs = append(allErrs, ValidateIngress(rollout, ingress)...)
Expand Down Expand Up @@ -97,30 +96,48 @@ func ValidateService(svc ServiceWithType, rollout *v1alpha1.Rollout) field.Error
return allErrs
}

func ValidateAnalysisTemplateWithType(rollout *v1alpha1.Rollout, template AnalysisTemplateWithType) field.ErrorList {
func ValidateAnalysisTemplatesWithType(rollout *v1alpha1.Rollout, templates AnalysisTemplatesWithType) field.ErrorList {
allErrs := field.ErrorList{}
fldPath := GetAnalysisTemplateWithTypeFieldPath(template.TemplateType, template.AnalysisIndex, template.CanaryStepIndex)
fldPath := GetAnalysisTemplateWithTypeFieldPath(templates.TemplateType, templates.CanaryStepIndex)
if fldPath == nil {
return allErrs
}

flattenedTemplate, err := analysisutil.FlattenTemplates(templates.AnalysisTemplates, templates.ClusterAnalysisTemplates)
templateNames := GetAnalysisTemplateNames(templates)
value := fmt.Sprintf("templateNames: %s", templateNames)
if err != nil {
allErrs = append(allErrs, field.Invalid(fldPath, value, err.Error()))
return allErrs
}
err = analysisutil.ResolveArgs(flattenedTemplate.Spec.Args)
if err != nil {
allErrs = append(allErrs, field.Invalid(fldPath, value, err.Error()))
return allErrs
}

for _, template := range templates.AnalysisTemplates {
allErrs = append(allErrs, ValidateAnalysisTemplateWithType(rollout, template, nil, templates.TemplateType, fldPath)...)
}
for _, clusterTemplate := range templates.ClusterAnalysisTemplates {
allErrs = append(allErrs, ValidateAnalysisTemplateWithType(rollout, nil, clusterTemplate, templates.TemplateType, fldPath)...)
}
return allErrs
}

func ValidateAnalysisTemplateWithType(rollout *v1alpha1.Rollout, template *v1alpha1.AnalysisTemplate, clusterTemplate *v1alpha1.ClusterAnalysisTemplate, templateType AnalysisTemplateType, fldPath *field.Path) field.ErrorList {
allErrs := field.ErrorList{}

var templateSpec v1alpha1.AnalysisTemplateSpec
var templateName string
//var args []v1alpha1.Argument

if template.ClusterAnalysisTemplate != nil {
templateName, templateSpec, _ = template.ClusterAnalysisTemplate.Name, template.ClusterAnalysisTemplate.Spec, template.ClusterAnalysisTemplate.Spec.Args
} else if template.AnalysisTemplate != nil {
templateName, templateSpec, _ = template.AnalysisTemplate.Name, template.AnalysisTemplate.Spec, template.AnalysisTemplate.Spec.Args
if clusterTemplate != nil {
templateName, templateSpec = clusterTemplate.Name, clusterTemplate.Spec
} else if template != nil {
templateName, templateSpec = template.Name, template.Spec
}

// err := analysisutil.ResolveArgs(args)
// if err != nil {
// msg := fmt.Sprintf("AnalysisTemplate %s has invalid arguments: %v", templateName, err)
// allErrs = append(allErrs, field.Invalid(fldPath, templateName, msg))
// }

if template.TemplateType != BackgroundAnalysis {
if templateType != BackgroundAnalysis {
setArgValuePlaceHolder(templateSpec.Args)
resolvedMetrics, err := analysisutil.ResolveMetrics(templateSpec.Metrics, templateSpec.Args)
if err != nil {
Expand All @@ -135,7 +152,7 @@ func ValidateAnalysisTemplateWithType(rollout *v1alpha1.Rollout, template Analys
}
}
}
} else if template.TemplateType == BackgroundAnalysis && len(templateSpec.Args) > 0 {
} else if templateType == BackgroundAnalysis && len(templateSpec.Args) > 0 {
for _, arg := range templateSpec.Args {
if arg.Value != nil || arg.ValueFrom != nil {
continue
Expand Down Expand Up @@ -248,7 +265,18 @@ func GetServiceWithTypeFieldPath(serviceType ServiceType) *field.Path {
return fldPath
}

func GetAnalysisTemplateWithTypeFieldPath(templateType AnalysisTemplateType, analysisIndex int, canaryStepIndex int) *field.Path {
func GetAnalysisTemplateNames(templates AnalysisTemplatesWithType) []string {
templateNames := make([]string, 0)
for _, template := range templates.AnalysisTemplates {
templateNames = append(templateNames, template.Name)
}
for _, clusterTemplate := range templates.ClusterAnalysisTemplates {
templateNames = append(templateNames, clusterTemplate.Name)
}
return templateNames
}

func GetAnalysisTemplateWithTypeFieldPath(templateType AnalysisTemplateType, canaryStepIndex int) *field.Path {
fldPath := field.NewPath("spec", "strategy")
switch templateType {
case PrePromotionAnalysis:
Expand All @@ -263,6 +291,5 @@ func GetAnalysisTemplateWithTypeFieldPath(templateType AnalysisTemplateType, ana
// No path specified
return nil
}
fldPath = fldPath.Index(analysisIndex).Child("templateName")
return fldPath
}
Loading