Raise an error when 'kind' is missing (#280)

* Raise an error instead of crashing when 'kind' is missing (#277)
* Update changelog

CHANGELOG.md

@@ -3,6 +3,8 @@
 *Features*
 
 *Bug Fixes*
+- Display a nice error instead of crashing when a YAML document is missing 'Kind'
+([#280](https://github.com/Shopify/kubernetes-deploy/pull/280))
 
 *Enhancements*
 

lib/kubernetes-deploy/deploy_task.rb

@@ -253,6 +253,7 @@ def split_templates(filename)
         yield doc
       end
     rescue InvalidTemplateError => e
+      e.filename ||= filename
       record_invalid_template(err: e.message, filename: e.filename, content: e.content)
       raise FatalDeploymentError, "Failed to render and parse template"
     rescue Psych::SyntaxError => e

lib/kubernetes-deploy/errors.rb

@@ -4,8 +4,9 @@ class FatalDeploymentError < StandardError; end
   class KubectlError < StandardError; end
 
   class InvalidTemplateError < FatalDeploymentError
-    attr_reader :filename, :content
-    def initialize(err, filename:, content: nil)
+    attr_reader :content
+    attr_accessor :filename
+    def initialize(err, filename: nil, content: nil)
       @filename = filename
       @content = content
       super(err)

lib/kubernetes-deploy/kubernetes_resource.rb

@@ -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'", content: definition.to_yaml)
+        elsif KubernetesDeploy.const_defined?(definition["kind"])
           klass = KubernetesDeploy.const_get(definition["kind"])
           klass.new(**opts)
         else

test/fixtures/invalid-resources/missing_kind.yml

@@ -0,0 +1,5 @@
+apiVersion: v1
+metadata:
+  name: test
+data:
+  datapoint: value1

test/integration/kubernetes_deploy_test.rb

@@ -986,4 +986,21 @@ def test_adds_namespace_labels_to_statsd_tags
       assert_empty desired_tags - metric.tags
     end
   end
+
+  def test_raise_on_yaml_missing_kind
+    result = deploy_fixtures("invalid-resources", subset: ["missing_kind.yml"])
+    assert_deploy_failure(result)
+    assert_logs_match_all([
+      "Invalid template: missing_kind.yml",
+      "> Error message:",
+      "Template missing 'Kind'",
+      "> Template content:",
+      "---",
+      "apiVersion: v1",
+      "metadata:",
+      "  name: test",
+      "data:",
+      "  datapoint: value1"
+    ], in_order: true)
+  end
 end