Give better message to user for MissingValueAtPath and OutputPathNotSatisfied #406
Conversation
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
|
✔️ Deploy Preview for elated-stonebraker-105904 ready! 🔨 Explore the source changes: 65e2a40 🔍 Inspect the deploy log: https://app.netlify.com/sites/elated-stonebraker-105904/deploys/61a53bf2e6733300087a3ce6 😎 Browse the preview: https://deploy-preview-406--elated-stonebraker-105904.netlify.app |
cirocosta
reviewed
Nov 29, 2021
| obj.SetNamespace("my-ns") | ||
|
|
||
| condition := deliverable.MissingValueAtPathCondition(obj, "spec.foo") | ||
| Expect(condition.Message).To(Equal("Waiting to read value [spec.foo] from resource [widget.thing.io/my-widget] in namespace [my-ns]")) |
cirocosta
reviewed
Nov 29, 2021
pkg/realizer/deliverable/errors.go
Outdated
| ) | ||
|
|
||
| const NO_JSONPATH_CONTEXT = "<no jsonpath context>" |
There was a problem hiding this comment.
oh, we usually go with PascalCase rather than UPPER_CASE_WITH_UNDERSCORES for constants
pkg/apis/v1alpha1/cluster_supply_chain.go
29:const (
30- SupplyChainReady = "Ready"
31- SupplyChainTemplatesReady = "TemplatesReady"
--
34:const (
35- ReadyTemplatesReadyReason = "Ready"
36- NotFoundTemplatesReadyReason = "TemplatesNotFound"
cirocosta
reviewed
Nov 29, 2021
| @@ -332,7 +332,7 @@ var _ = Describe("Realizer", func() { | |||
| It("returns RetrieveOutputError", func() { | |||
| _, _, err := rlzr.Realize(ctx, runnable, systemRepo, runnableRepo) | |||
| Expect(err).To(HaveOccurred()) | |||
| Expect(err.Error()).To(ContainSubstring(`unable to retrieve outputs from stamped object for runnable 'my-important-ns/my-runnable': failed to evaluate path [data.hasnot]: evaluate: find results: hasnot is not found`)) | |||
| Expect(err.Error()).To(ContainSubstring(`unable to retrieve outputs from stamped object [my-important-ns/my-stamped-resource-] of type [configmap] for runnable [my-important-ns/my-runnable]: failed to evaluate path [data.hasnot]: evaluate: find results: hasnot is not found`)) | |||
# Conflicts: # pkg/controller/deliverable/reconciler_test.go # pkg/controller/runnable/reconciler_test.go # pkg/realizer/runnable/errors.go # pkg/realizer/runnable/realizer.go # pkg/realizer/runnable/realizer_test.go
cirocosta
reviewed
Nov 29, 2021
| @@ -31,18 +31,19 @@ type Outputs map[string]apiextensionsv1.JSON | |||
| type ClusterRunTemplate interface { | |||
| GetName() string | |||
| GetResourceTemplate() v1alpha1.TemplateSpec | |||
| GetOutput(stampedObjects []*unstructured.Unstructured) (Outputs, error) | |||
| GetOutput(stampedObjects []*unstructured.Unstructured) (Outputs, *unstructured.Unstructured, error) | |||
There was a problem hiding this comment.
nit: not everyone agrees with this, but, for interfaces, I find useful to name the returns so that it's less ambiguous at a first look (in a codebase with little comments) to understand what's supposed to be returned. do you think that's something we should try/think about at some point? any thoughts on it?
cirocosta
approved these changes
Nov 29, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.