forked from devfile/devworkspace-operator
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: warn when trying to use unsupported devfile features
Fix devfile#984 Signed-off-by: Andrew Obuchowicz <aobuchow@redhat.com>
- Loading branch information
Showing
2 changed files
with
182 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,162 @@ | ||
| // | ||
| // Copyright (c) 2019-2022 Red Hat, Inc. | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // 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 handler | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "strings" | ||
|
|
||
| dwv2 "github.com/devfile/api/v2/pkg/apis/workspaces/v1alpha2" | ||
| ) | ||
|
|
||
| type unsupportedWarnings struct { | ||
| serviceAnnotations []string | ||
| endpointAnnotations []string | ||
| dedicatedPod []string | ||
| imageComponent []string | ||
| customComponent []string | ||
| volumeSize []string | ||
| eventPostStop []string | ||
| eventPreStop []string | ||
| } | ||
|
|
||
| func checkUnsupportedFeatures(devWorkspaceSpec dwv2.DevWorkspaceTemplateSpec) (warnings *unsupportedWarnings) { | ||
| warnings = &unsupportedWarnings{} | ||
| for _, component := range devWorkspaceSpec.Components { | ||
| if component.Container != nil { | ||
| if component.Container.Annotation != nil && component.Container.Annotation.Service != nil { | ||
| warnings.serviceAnnotations = append(warnings.serviceAnnotations, component.Name) | ||
| } | ||
| for _, endpoint := range component.Container.Endpoints { | ||
| if endpoint.Annotations != nil { | ||
| warnings.endpointAnnotations = append(warnings.endpointAnnotations, component.Name) | ||
| } | ||
| } | ||
| if component.Container.DedicatedPod != nil && *component.Container.DedicatedPod { | ||
| warnings.dedicatedPod = append(warnings.dedicatedPod, component.Name) | ||
| } | ||
| } | ||
|
|
||
| if component.Image != nil { | ||
| warnings.imageComponent = append(warnings.imageComponent, component.Name) | ||
| } | ||
| if component.Custom != nil { | ||
| warnings.customComponent = append(warnings.customComponent, component.Name) | ||
| } | ||
| if component.Volume != nil && component.Volume.Size != "" { | ||
| warnings.volumeSize = append(warnings.volumeSize, component.Name) | ||
| } | ||
| } | ||
|
|
||
| if devWorkspaceSpec.Events != nil { | ||
| if len(devWorkspaceSpec.Events.PostStop) > 0 { | ||
| warnings.eventPostStop = append(warnings.eventPostStop, devWorkspaceSpec.Events.PostStop...) | ||
| } | ||
|
|
||
| if len(devWorkspaceSpec.Events.PreStop) > 0 { | ||
| warnings.eventPreStop = append(warnings.eventPreStop, devWorkspaceSpec.Events.PreStop...) | ||
| } | ||
| } | ||
| return warnings | ||
| } | ||
|
|
||
| func unsupportedWarningsPresent(warnings *unsupportedWarnings) bool { | ||
| return len(warnings.serviceAnnotations) > 0 || | ||
| len(warnings.endpointAnnotations) > 0 || | ||
| len(warnings.dedicatedPod) > 0 || | ||
| len(warnings.imageComponent) > 0 || | ||
| len(warnings.customComponent) > 0 || | ||
| len(warnings.volumeSize) > 0 || | ||
| len(warnings.eventPostStop) > 0 || | ||
| len(warnings.eventPreStop) > 0 | ||
| } | ||
|
|
||
| func formatUnsupportedFeaturesWarning(warnings *unsupportedWarnings) string { | ||
| var msg []string | ||
| if len(warnings.serviceAnnotations) > 0 { | ||
| serviceAnnotationsMsg := "components[].container.annotation.service, used by components: " + strings.Join(warnings.serviceAnnotations, ", ") | ||
| msg = append(msg, serviceAnnotationsMsg) | ||
| } | ||
| if len(warnings.endpointAnnotations) > 0 { | ||
| endpointAnnotationsMsg := "components[].container.endpoints[].annotations, used by components: " + strings.Join(warnings.endpointAnnotations, ", ") | ||
| msg = append(msg, endpointAnnotationsMsg) | ||
| } | ||
| if len(warnings.dedicatedPod) > 0 { | ||
| dedicatedPodMsg := "components[].container.dedicatedPod, used by components: " + strings.Join(warnings.dedicatedPod, ", ") | ||
| msg = append(msg, dedicatedPodMsg) | ||
| } | ||
| if len(warnings.imageComponent) > 0 { | ||
| imageComponentMsg := "components[].image, used by components: " + strings.Join(warnings.imageComponent, ", ") | ||
| msg = append(msg, imageComponentMsg) | ||
| } | ||
| if len(warnings.customComponent) > 0 { | ||
| customComponentMsg := "components[].custom, used by components: " + strings.Join(warnings.customComponent, ", ") | ||
| msg = append(msg, customComponentMsg) | ||
| } | ||
| if len(warnings.volumeSize) > 0 { | ||
| volumeSizeMsg := "components[].volume.size, used by components: " + strings.Join(warnings.volumeSize, ", ") | ||
| msg = append(msg, volumeSizeMsg) | ||
| } | ||
| if len(warnings.eventPostStop) > 0 { | ||
| eventPostStopMsg := "events.postStop: " + strings.Join(warnings.eventPostStop, ", ") | ||
| msg = append(msg, eventPostStopMsg) | ||
| } | ||
| if len(warnings.eventPreStop) > 0 { | ||
| eventPreStopMsg := "events.preStop: " + strings.Join(warnings.eventPreStop, ", ") | ||
| msg = append(msg, eventPreStopMsg) | ||
| } | ||
| // TODO: Improve warning message? | ||
| return fmt.Sprintf("Unsupported Devfile features are present in this workspace. The following features will have no effect: %s", strings.Join(msg, "; ")) | ||
| } | ||
|
|
||
| // Returns unsupported feature warnings that are present in the new workspace | ||
| // but not present in the new workspace | ||
| func checkForAddedUnsupportedFeatures(oldWksp, newWksp *dwv2.DevWorkspace) *unsupportedWarnings { | ||
| oldWarnings := checkUnsupportedFeatures(oldWksp.Spec.Template) | ||
| newWarnings := checkUnsupportedFeatures(newWksp.Spec.Template) | ||
| additionalWarnings := &unsupportedWarnings{} | ||
|
|
||
| // TODO: I don't really like the way 'oldWarningNames' and 'newWarningNames' are named | ||
| // since the warnings can be component names or events. | ||
| // They could be renamed to 'oldWarnings'/'newWarnings', but that could be confusing with | ||
| // the variables declared at the top of this function | ||
| unsupportedFeaturesDiff := func(oldWarningNames, newWarningNames []string) []string { | ||
| var additionalWarnings []string | ||
| for _, newWarning := range newWarningNames { | ||
| found := false | ||
| for _, oldWarning := range oldWarningNames { | ||
| if newWarning == oldWarning { | ||
| found = true | ||
| break | ||
| } | ||
| } | ||
| if !found { | ||
| additionalWarnings = append(additionalWarnings, newWarning) | ||
| } | ||
| } | ||
| return additionalWarnings | ||
| } | ||
|
|
||
| additionalWarnings.serviceAnnotations = append(additionalWarnings.serviceAnnotations, unsupportedFeaturesDiff(oldWarnings.serviceAnnotations, newWarnings.serviceAnnotations)...) | ||
| additionalWarnings.endpointAnnotations = append(additionalWarnings.endpointAnnotations, unsupportedFeaturesDiff(oldWarnings.endpointAnnotations, newWarnings.endpointAnnotations)...) | ||
| additionalWarnings.dedicatedPod = append(additionalWarnings.dedicatedPod, unsupportedFeaturesDiff(oldWarnings.dedicatedPod, newWarnings.dedicatedPod)...) | ||
| additionalWarnings.imageComponent = append(additionalWarnings.imageComponent, unsupportedFeaturesDiff(oldWarnings.imageComponent, newWarnings.imageComponent)...) | ||
| additionalWarnings.customComponent = append(additionalWarnings.customComponent, unsupportedFeaturesDiff(oldWarnings.customComponent, newWarnings.customComponent)...) | ||
| additionalWarnings.volumeSize = append(additionalWarnings.volumeSize, unsupportedFeaturesDiff(oldWarnings.volumeSize, newWarnings.volumeSize)...) | ||
| additionalWarnings.eventPreStop = append(additionalWarnings.eventPreStop, unsupportedFeaturesDiff(oldWarnings.eventPreStop, newWarnings.eventPreStop)...) | ||
| additionalWarnings.eventPostStop = append(additionalWarnings.eventPostStop, unsupportedFeaturesDiff(oldWarnings.eventPostStop, newWarnings.eventPostStop)...) | ||
| return additionalWarnings | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters