Raise an error when 'kind' is missing #280
Merged
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
KnVerey
reviewed
Apr 17, 2018
lib/kubernetes-deploy/errors.rb
Outdated
| @@ -2,6 +2,7 @@ | |||
| module KubernetesDeploy | |||
| class FatalDeploymentError < StandardError; end | |||
| class KubectlError < StandardError; end | |||
| class InvalidResourceError < StandardError; end | |||
There was a problem hiding this comment.
This should probably use InvalidTemplateError from the PR I just finally rebased and merged. (please rebase 🙏 )
dturn
force-pushed
the
rescue-missing-kind
branch
from
cbe92f2
to
8ccf6e6
Compare
|
Rebase completed, its a hair different as a result. |
kirs
approved these changes
Apr 18, 2018
dturn
force-pushed
the
rescue-missing-kind
branch
from
19e0799
to
e4a8db8
Compare
dturn
force-pushed
the
rescue-missing-kind
branch
from
e4a8db8
to
88f4a9f
Compare
KnVerey
reviewed
Apr 18, 2018
| @@ -31,7 +31,9 @@ class << self | |||
| def build(namespace:, context:, definition:, logger:, statsd_tags:) | |||
| opts = { namespace: namespace, context: context, definition: definition, logger: logger, | |||
| statsd_tags: statsd_tags } | |||
| if KubernetesDeploy.const_defined?(definition["kind"]) | |||
| if definition["kind"].blank? | |||
| raise InvalidTemplateError.new("Template missing 'Kind'", filename: nil, content: definition.to_s) | |||
There was a problem hiding this comment.
Since we have a valid case for not requiring filename now, let's make the default nil in the initializer so you can leave it off here.
There was a problem hiding this comment.
I think we should to_yaml the definition instead of to_s it, for consistency with the other errors (and readability when the definition is long). Compare:
Versus test_invalid_yaml_fails_fast:
| assert_logs_match_all([ | ||
| "Invalid template: missing_kind.yml", | ||
| "> Error message:", | ||
| "Template missing 'Kind'" |
There was a problem hiding this comment.
Let's add an assertion that proves the content is printed too
CHANGELOG.md
Outdated
| @@ -14,6 +14,8 @@ | |||
| *Bug Fixes* | |||
| - Prevent calling sleep with a negative value ([#273](https://github.com/Shopify/kubernetes-deploy/pull/273)) | |||
| - Prevent no-op redeploys of bad code from hanging forever ([#262](https://github.com/Shopify/kubernetes-deploy/pull/262)) | |||
| - Display a nice error instead of crashing when a YAML document is missing 'Kind' | |||
KnVerey
approved these changes
Apr 18, 2018
klautcomputing
approved these changes
Apr 18, 2018
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.
Currently we crash with a stack dump if a yaml document is missing a
Kind. This PR prints a nice error instead of crashingFixes: #277