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

Don't check if trial's metadata is in spec.parameters #1848

Merged
merged 6 commits into from
Apr 17, 2022
Merged

Don't check if trial's metadata is in spec.parameters #1848

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
8b6fc58
do not check trial parameter in experiment parameters if it's trial's…
alexeygorobets Apr 11, 2022
6d4ce0f
revert unnecessary change
alexeygorobets Apr 11, 2022
99ce98f
Merge pull request #2 from mesosphere/fix-trial-metadata-substitution…
alexeygorobets Apr 12, 2022
07725af
add handle Labels[label] and Annotations[annotation]
alexeygorobets Apr 15, 2022
72db2a5
fix test description
alexeygorobets Apr 15, 2022
6713b34
Merge pull request #3 from mesosphere/dont-check-trial-metadata-in-sp…
alexeygorobets Apr 15, 2022
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
10 changes: 10 additions & 0 deletions pkg/controller.v1beta1/consts/const.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,4 +179,14 @@ var (
DefaultKatibDBManagerServiceIP = env.GetEnvOrDefault(DefaultKatibDBManagerServiceIPEnvName, "katib-db-manager")
// DefaultKatibDBManagerServicePort is the default Port of Katib DB Manager
DefaultKatibDBManagerServicePort = env.GetEnvOrDefault(DefaultKatibDBManagerServicePortEnvName, "6789")

// List of all valid keys of trial metadata for substitution in Trial template
TrialTemplateMetaKeys = []string{
TrialTemplateMetaKeyOfName,
TrialTemplateMetaKeyOfNamespace,
TrialTemplateMetaKeyOfKind,
TrialTemplateMetaKeyOfAPIVersion,
TrialTemplateMetaKeyOfAnnotations,
TrialTemplateMetaKeyOfLabels,
}
)
34 changes: 32 additions & 2 deletions pkg/webhook/v1beta1/experiment/validator/validator.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -311,8 +311,10 @@ func (g *DefaultValidator) validateTrialTemplate(instance *experimentsv1beta1.Ex

// Check if parameter reference exist in experiment parameters
if len(experimentParameterNames) > 0 {
if _, ok := experimentParameterNames[parameter.Reference]; !ok {
return fmt.Errorf("parameter reference %v does not exist in spec.parameters: %v", parameter.Reference, instance.Spec.Parameters)
if !isMetaKey(parameter.Reference) {
if _, ok := experimentParameterNames[parameter.Reference]; !ok {
return fmt.Errorf("parameter reference %v does not exist in spec.parameters: %v", parameter.Reference, instance.Spec.Parameters)
}
}
}

Expand Down Expand Up @@ -481,3 +483,31 @@ func (g *DefaultValidator) validateMetricsCollector(inst *experimentsv1beta1.Exp

return nil
}

func isMetaKey(parameter string) bool {
// Check if parameter is trial metadata reference as ${trailSpec.Name}, ${trialSpec.Labels[label]}, etc. used for substitution
match := regexp.MustCompile(consts.TrialTemplateMetaReplaceFormatRegex).FindStringSubmatch(parameter)
isMeta := false
if len(match) > 0 {
matchedKey := match[1]
if contains(consts.TrialTemplateMetaKeys, matchedKey) {
isMeta = true
} else {
// Check if it's Labels[label] or Annotations[annotation]
subMatch := regexp.MustCompile(consts.TrialTemplateMetaParseFormatRegex).FindStringSubmatch(matchedKey)
if len(subMatch) == 3 && contains(consts.TrialTemplateMetaKeys, subMatch[1]) {
isMeta = true
}
}
}
return isMeta
}

func contains(slice []string, item string) bool {
for _, s := range slice {
if s == item {
return true
}
}
return false
}
34 changes: 34 additions & 0 deletions pkg/webhook/v1beta1/experiment/validator/validator_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -415,6 +415,9 @@ spec:
validTemplate4 := p.EXPECT().GetTrialTemplate(gomock.Any()).Return(validJobStr, nil)
validTemplate5 := p.EXPECT().GetTrialTemplate(gomock.Any()).Return(validJobStr, nil)
validTemplate6 := p.EXPECT().GetTrialTemplate(gomock.Any()).Return(validJobStr, nil)
validTemplate7 := p.EXPECT().GetTrialTemplate(gomock.Any()).Return(validJobStr, nil)
validTemplate8 := p.EXPECT().GetTrialTemplate(gomock.Any()).Return(validJobStr, nil)
validTemplate9 := p.EXPECT().GetTrialTemplate(gomock.Any()).Return(validJobStr, nil)

missedParameterTemplate := p.EXPECT().GetTrialTemplate(gomock.Any()).Return(missedParameterJobStr, nil)
oddParameterTemplate := p.EXPECT().GetTrialTemplate(gomock.Any()).Return(oddParameterJobStr, nil)
Expand All @@ -431,6 +434,9 @@ spec:
validTemplate4,
validTemplate5,
validTemplate6,
validTemplate7,
validTemplate8,
validTemplate9,
missedParameterTemplate,
oddParameterTemplate,
invalidParameterTemplate,
Expand Down Expand Up @@ -570,6 +576,34 @@ spec:
Err: false,
testDescription: "Trial template contains Trial parameters when spec.parameters is empty",
},
// Trial template contains Trial metadata parameter substitution
{
Instance: func() *experimentsv1beta1.Experiment {
i := newFakeInstance()
i.Spec.TrialTemplate.TrialParameters[1].Reference = "${trialSpec.Name}"
return i
}(),
Err: false,
testDescription: "Trial template contains Trial metadata reference as parameter",
},
Copy link
Member

@tenzen-y tenzen-y Apr 14, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you also add a test case for Labels or Annotations?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hi @tenzen-y , I've added handing of those cases and tests, thanks!

{
Instance: func() *experimentsv1beta1.Experiment {
i := newFakeInstance()
i.Spec.TrialTemplate.TrialParameters[1].Reference = "${trialSpec.Annotations[test-annotation]}"
return i
}(),
Err: false,
testDescription: "Trial template contains Trial annotation reference as parameter",
},
{
Instance: func() *experimentsv1beta1.Experiment {
i := newFakeInstance()
i.Spec.TrialTemplate.TrialParameters[1].Reference = "${trialSpec.Labels[test-label]}"
return i
}(),
Err: false,
testDescription: "Trial template contains Trial's label reference as parameter",
},
// Trial Template doesn't contain parameter from trialParameters
// missedParameterTemplate case
{
Expand Down