kube-dsl 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7a616f5571a180de6f04decd298d902b823148b10596292fa69ab68ce7f2ddb
-  data.tar.gz: 51d822c6644973f06cb3f8c819eef7bf99f21d54ff7c7820f0e3105b712a1880
+  metadata.gz: 4c028c471596448f6e06ff1aa0bf50bc3ccdd93e22559a9805d4078921571f8a
+  data.tar.gz: b6e10a2a2f59d21af138e18db5a46b015a331e762642f7d2292daa69e9f4365f
 SHA512:
-  metadata.gz: 821f0332b1aa16b3ba3ffc2fad7a3f453878fa97993dfb71fc74386dc5a0b1aecd0e56f9bd86518a869721d1a5d21a7c2f433edc8bc82e378bba5b1b1900929f
-  data.tar.gz: 6882c287e01af9c05d32a8729e1999a485a75bfec2fd433a53d65efbbd1de0d6fa6dc72b4f6169150d7f00b419e650d8ac4766308f23ba9d766c7bd7af0df354
+  metadata.gz: 7bda26da0d442fbe59af67f1a8c60aad632bb91f789332aa951032d6f25be6dd72461b20c0e24e0ed995f15f7a925ead791feca3b9e99a0d226cc6cf4c3dc423
+  data.tar.gz: 8102bb8df5fdc935f3df34c9ff9a2ae2e3d0f1c6eb3222441d4b082c9cc932a7d5d9856028435726b0d4821e94413e4af377d1869fcfba1e08153052d25f9af0

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.4.0
+* Add validations.
+  - You can now call `#valid?` and `#validate` methods on DSL objects.
+* Fixed several bad inflections causing Ruby keywords to appear in unexpected places, namely in `#serialize` methods.
+* Prevent JSON schema "$" variables (eg. "$ref") from being added as fields.
+
 ## 0.3.0
 * Introduce the `key_value_field` method to simplify creating key/value fields.
 * Add `#merge` and `#merge!` methods to anything that includes or extends `ValueFields`.

data/Rakefile

@@ -39,6 +39,10 @@ task :generate do
 
         inflections.plural('tls', 'tlses')
         inflections.singular('tls', 'tls')
+        inflections.plural('enum', 'enums')
+        inflections.plural('one_of', 'one_ofs')
+        inflections.plural('any_of', 'any_ofs')
+        inflections.plural('all_of', 'all_ofs')
       end
     )
 

data/lib/kube-dsl.rb

@@ -1,19 +1,25 @@
 module KubeDSL
   KUBERNETES_VERSION = '1.17.4'.freeze
 
+  autoload :ArrayFieldRes,        'kube-dsl/array_field_res'
   autoload :Builder,              'kube-dsl/builder'
+  autoload :DefaultFieldRes,      'kube-dsl/default_field_res'
   autoload :DSL,                  'kube-dsl/dsl'
   autoload :DSLObject,            'kube-dsl/dsl_object'
   autoload :Entrypoint,           'kube-dsl/entrypoint'
   autoload :ExternalRef,          'kube-dsl/external_ref'
   autoload :ExternalResourceMeta, 'kube-dsl/external_resource_meta'
+  autoload :FieldRes,             'kube-dsl/field_res'
   autoload :Generator,            'kube-dsl/generator'
   autoload :Inflector,            'kube-dsl/inflector'
   autoload :KeyValueFields,       'kube-dsl/key_value_fields'
+  autoload :KeyValueFieldRes,     'kube-dsl/key_value_field_res'
+  autoload :ObjectFieldRes,       'kube-dsl/object_field_res'
   autoload :Ref,                  'kube-dsl/ref'
   autoload :Resource,             'kube-dsl/resource'
   autoload :ResourceMeta,         'kube-dsl/resource_meta'
   autoload :StringHelpers,        'kube-dsl/string_helpers'
+  autoload :Validations,          'kube-dsl/validations'
   autoload :ValueFields,          'kube-dsl/value_fields'
 
   extend Entrypoint

data/lib/kube-dsl/array_field_res.rb

@@ -0,0 +1,41 @@
+module KubeDSL
+  class ArrayFieldRes
+    include StringHelpers
+
+    attr_reader :name, :required, :elem_res
+
+    alias_method :required?, :required
+
+    def initialize(name, required, elem_res)
+      @name = name
+      @required = required
+      @elem_res = elem_res
+    end
+
+    def fields_to_ruby(inflector)
+      [
+        "array_field(:#{underscore(inflector.singularize(name))})"\
+          " { #{elem_res.ref.ruby_namespace.join('::')}::#{elem_res.ref.kind}.new }"
+      ]
+    end
+
+    def validations(inflector)
+      [].tap do |result|
+        ruby_type = [*elem_res.ref.ruby_namespace, elem_res.ref.kind].join('::')
+        result << "validates :#{plural_name(inflector)}, array: { kind_of: #{ruby_type} }, presence: #{required? ? 'true' : 'false'}"
+      end
+    end
+
+    def serialize_call(inflector)
+      "#{plural_name(inflector)}.map(&:serialize)"
+    end
+
+    private
+
+    def plural_name(inflector)
+      inflector.pluralize(
+        underscore(inflector.singularize(name))
+      )
+    end
+  end
+end

data/lib/kube-dsl/builder.rb

@@ -82,7 +82,6 @@ module KubeDSL
       end
 
       res = resource_cache[ref.str] = ref.meta
-
       add_doc_to_resource(res, ref.document)
 
       res
@@ -151,6 +150,7 @@ module KubeDSL
 
     def add_props_to_resource(properties, res)
       properties.each do |name, prop|
+        next if name.start_with?('$')
         add_prop_to_resource(name, prop, res)
       end
     end
@@ -168,27 +168,34 @@ module KubeDSL
     end
 
     def add_prop_to_resource(name, prop, res)
+      required = prop.include?('type') && !prop['type'].include?('null')
+
       case Array(prop['type']).first
         when 'array'
-          if ref_str = prop['items']['$ref']
+          if ref_str = prop.dig('items', '$ref')
             ref = resolve_ref(ref_str)
-            res.array_fields[name] = resource_from_ref(ref)
+            res.fields[name] = ArrayFieldRes.new(
+              name, required, resource_from_ref(ref)
+            )
           else
-            res.fields << name
+            res.fields[name] = FieldRes.new(
+              name, (prop.dig('items', 'types') || ['string']).first, required
+            )
           end
 
         when 'object' # this means key/value pairs
-          fmt = prop['additionalProperties']['format'] || 'string'
-          res.key_value_fields[name] = fmt
+          type = prop.dig('additionalProperties', 'format') || 'string'
+          res.fields[name] = KeyValueFieldRes.new(name, res, type, required)
 
         when 'string', 'integer', 'number', 'boolean', 'date-time'
           enum = prop['enum']
 
           if enum&.size == 1
-            # use JSON.generate to add quotes around strings, etc
-            res.default_fields[name] = JSON.generate(enum.first)
+            res.fields[name] = DefaultFieldRes.new(name, res, enum)
           else
-            res.fields << name
+            res.fields[name] = FieldRes.new(
+              name, prop['type'].first, required
+            )
           end
 
         else
@@ -196,10 +203,14 @@ module KubeDSL
 
           if ref.object?
             # this ref refers to a nested type
-            res.object_fields[name] = resource_from_ref(ref)
+            res.fields[name] = ObjectFieldRes.new(
+              name, resource_from_ref(ref)
+            )
           else
             # this ref refers to just a field
-            res.fields << name
+            res.fields[name] = FieldRes.new(
+              name, (prop.dig('items', 'types') || ['string']).first, required
+            )
           end
       end
     end

data/lib/kube-dsl/default_field_res.rb

@@ -0,0 +1,28 @@
+require 'json'
+
+module KubeDSL
+  class DefaultFieldRes
+    include StringHelpers
+
+    attr_reader :name, :res, :allowed_values
+
+    def initialize(name, res, allowed_values)
+      @name = name
+      @res = res
+      @allowed_values = allowed_values
+    end
+
+    def fields_to_ruby(_inflector)
+      []
+    end
+
+    def validations(_inflector)
+      []
+    end
+
+    def serialize_call(_inflector)
+      # use JSON.generate to add quotes around strings, etc
+      JSON.generate(allowed_values.first)
+    end
+  end
+end

data/lib/kube-dsl/dsl/admissionregistration/v1/mutating_webhook.rb

@@ -1,24 +1,42 @@
 module KubeDSL::DSL::Admissionregistration::V1
   class MutatingWebhook < ::KubeDSL::DSLObject
-    value_fields :admission_review_versions, :failure_policy, :match_policy, :name, :reinvocation_policy, :side_effects, :timeout_seconds
-    array_field(:rule) { KubeDSL::DSL::Admissionregistration::V1::RuleWithOperations.new }
+    value_field :admission_review_versions
     object_field(:client_config) { KubeDSL::DSL::Admissionregistration::V1::WebhookClientConfig.new }
+    value_field :failure_policy
+    value_field :match_policy
+    value_field :name
     object_field(:namespace_selector) { KubeDSL::DSL::Meta::V1::LabelSelector.new }
     object_field(:object_selector) { KubeDSL::DSL::Meta::V1::LabelSelector.new }
+    value_field :reinvocation_policy
+    array_field(:rule) { KubeDSL::DSL::Admissionregistration::V1::RuleWithOperations.new }
+    value_field :side_effects
+    value_field :timeout_seconds
+
+    validates :admission_review_versions, field: { format: :string }, presence: false
+    validates :client_config, object: { kind_of: KubeDSL::DSL::Admissionregistration::V1::WebhookClientConfig }
+    validates :failure_policy, field: { format: :string }, presence: false
+    validates :match_policy, field: { format: :string }, presence: false
+    validates :name, field: { format: :string }, presence: false
+    validates :namespace_selector, object: { kind_of: KubeDSL::DSL::Meta::V1::LabelSelector }
+    validates :object_selector, object: { kind_of: KubeDSL::DSL::Meta::V1::LabelSelector }
+    validates :reinvocation_policy, field: { format: :string }, presence: false
+    validates :rules, array: { kind_of: KubeDSL::DSL::Admissionregistration::V1::RuleWithOperations }, presence: false
+    validates :side_effects, field: { format: :string }, presence: false
+    validates :timeout_seconds, field: { format: :integer }, presence: false
 
     def serialize
       {}.tap do |result|
         result[:admissionReviewVersions] = admission_review_versions
+        result[:clientConfig] = client_config.serialize
         result[:failurePolicy] = failure_policy
         result[:matchPolicy] = match_policy
         result[:name] = name
+        result[:namespaceSelector] = namespace_selector.serialize
+        result[:objectSelector] = object_selector.serialize
         result[:reinvocationPolicy] = reinvocation_policy
+        result[:rules] = rules.map(&:serialize)
         result[:sideEffects] = side_effects
         result[:timeoutSeconds] = timeout_seconds
-        result[:rules] = rules.map(&:serialize)
-        result[:clientConfig] = client_config.serialize
-        result[:namespaceSelector] = namespace_selector.serialize
-        result[:objectSelector] = object_selector.serialize
       end
     end
 

data/lib/kube-dsl/dsl/admissionregistration/v1/mutating_webhook_configuration.rb

@@ -1,14 +1,17 @@
 module KubeDSL::DSL::Admissionregistration::V1
   class MutatingWebhookConfiguration < ::KubeDSL::DSLObject
-    array_field(:webhook) { KubeDSL::DSL::Admissionregistration::V1::MutatingWebhook.new }
     object_field(:metadata) { KubeDSL::DSL::Meta::V1::ObjectMeta.new }
+    array_field(:webhook) { KubeDSL::DSL::Admissionregistration::V1::MutatingWebhook.new }
+
+    validates :metadata, object: { kind_of: KubeDSL::DSL::Meta::V1::ObjectMeta }
+    validates :webhooks, array: { kind_of: KubeDSL::DSL::Admissionregistration::V1::MutatingWebhook }, presence: false
 
     def serialize
       {}.tap do |result|
         result[:apiVersion] = "admissionregistration.k8s.io/v1"
         result[:kind] = "MutatingWebhookConfiguration"
-        result[:webhooks] = webhooks.map(&:serialize)
         result[:metadata] = metadata.serialize
+        result[:webhooks] = webhooks.map(&:serialize)
       end
     end
 

data/lib/kube-dsl/dsl/admissionregistration/v1/mutating_webhook_configuration_list.rb

@@ -3,11 +3,14 @@ module KubeDSL::DSL::Admissionregistration::V1
     array_field(:item) { KubeDSL::DSL::Admissionregistration::V1::MutatingWebhookConfiguration.new }
     object_field(:metadata) { KubeDSL::DSL::Meta::V1::ListMeta.new }
 
+    validates :items, array: { kind_of: KubeDSL::DSL::Admissionregistration::V1::MutatingWebhookConfiguration }, presence: false
+    validates :metadata, object: { kind_of: KubeDSL::DSL::Meta::V1::ListMeta }
+
     def serialize
       {}.tap do |result|
         result[:apiVersion] = "admissionregistration.k8s.io/v1"
-        result[:kind] = "MutatingWebhookConfigurationList"
         result[:items] = items.map(&:serialize)
+        result[:kind] = "MutatingWebhookConfigurationList"
         result[:metadata] = metadata.serialize
       end
     end

data/lib/kube-dsl/dsl/admissionregistration/v1/rule_with_operations.rb

@@ -1,6 +1,16 @@
 module KubeDSL::DSL::Admissionregistration::V1
   class RuleWithOperations < ::KubeDSL::DSLObject
-    value_fields :api_groups, :api_versions, :operations, :resources, :scope
+    value_field :api_groups
+    value_field :api_versions
+    value_field :operations
+    value_field :resources
+    value_field :scope
+
+    validates :api_groups, field: { format: :string }, presence: false
+    validates :api_versions, field: { format: :string }, presence: false
+    validates :operations, field: { format: :string }, presence: false
+    validates :resources, field: { format: :string }, presence: false
+    validates :scope, field: { format: :string }, presence: false
 
     def serialize
       {}.tap do |result|

data/lib/kube-dsl/dsl/admissionregistration/v1/service_reference.rb

@@ -1,6 +1,14 @@
 module KubeDSL::DSL::Admissionregistration::V1
   class ServiceReference < ::KubeDSL::DSLObject
-    value_fields :name, :namespace, :path, :port
+    value_field :name
+    value_field :namespace
+    value_field :path
+    value_field :port
+
+    validates :name, field: { format: :string }, presence: false
+    validates :namespace, field: { format: :string }, presence: false
+    validates :path, field: { format: :string }, presence: false
+    validates :port, field: { format: :integer }, presence: false
 
     def serialize
       {}.tap do |result|

data/lib/kube-dsl/dsl/admissionregistration/v1/validating_webhook.rb

@@ -1,23 +1,39 @@
 module KubeDSL::DSL::Admissionregistration::V1
   class ValidatingWebhook < ::KubeDSL::DSLObject
-    value_fields :admission_review_versions, :failure_policy, :match_policy, :name, :side_effects, :timeout_seconds
-    array_field(:rule) { KubeDSL::DSL::Admissionregistration::V1::RuleWithOperations.new }
+    value_field :admission_review_versions
     object_field(:client_config) { KubeDSL::DSL::Admissionregistration::V1::WebhookClientConfig.new }
+    value_field :failure_policy
+    value_field :match_policy
+    value_field :name
     object_field(:namespace_selector) { KubeDSL::DSL::Meta::V1::LabelSelector.new }
     object_field(:object_selector) { KubeDSL::DSL::Meta::V1::LabelSelector.new }
+    array_field(:rule) { KubeDSL::DSL::Admissionregistration::V1::RuleWithOperations.new }
+    value_field :side_effects
+    value_field :timeout_seconds
+
+    validates :admission_review_versions, field: { format: :string }, presence: false
+    validates :client_config, object: { kind_of: KubeDSL::DSL::Admissionregistration::V1::WebhookClientConfig }
+    validates :failure_policy, field: { format: :string }, presence: false
+    validates :match_policy, field: { format: :string }, presence: false
+    validates :name, field: { format: :string }, presence: false
+    validates :namespace_selector, object: { kind_of: KubeDSL::DSL::Meta::V1::LabelSelector }
+    validates :object_selector, object: { kind_of: KubeDSL::DSL::Meta::V1::LabelSelector }
+    validates :rules, array: { kind_of: KubeDSL::DSL::Admissionregistration::V1::RuleWithOperations }, presence: false
+    validates :side_effects, field: { format: :string }, presence: false
+    validates :timeout_seconds, field: { format: :integer }, presence: false
 
     def serialize
       {}.tap do |result|
         result[:admissionReviewVersions] = admission_review_versions
+        result[:clientConfig] = client_config.serialize
         result[:failurePolicy] = failure_policy
         result[:matchPolicy] = match_policy
         result[:name] = name
-        result[:sideEffects] = side_effects
-        result[:timeoutSeconds] = timeout_seconds
-        result[:rules] = rules.map(&:serialize)
-        result[:clientConfig] = client_config.serialize
         result[:namespaceSelector] = namespace_selector.serialize
         result[:objectSelector] = object_selector.serialize
+        result[:rules] = rules.map(&:serialize)
+        result[:sideEffects] = side_effects
+        result[:timeoutSeconds] = timeout_seconds
       end
     end
 

data/lib/kube-dsl/dsl/admissionregistration/v1/validating_webhook_configuration.rb

@@ -1,14 +1,17 @@
 module KubeDSL::DSL::Admissionregistration::V1
   class ValidatingWebhookConfiguration < ::KubeDSL::DSLObject
-    array_field(:webhook) { KubeDSL::DSL::Admissionregistration::V1::ValidatingWebhook.new }
     object_field(:metadata) { KubeDSL::DSL::Meta::V1::ObjectMeta.new }
+    array_field(:webhook) { KubeDSL::DSL::Admissionregistration::V1::ValidatingWebhook.new }
+
+    validates :metadata, object: { kind_of: KubeDSL::DSL::Meta::V1::ObjectMeta }
+    validates :webhooks, array: { kind_of: KubeDSL::DSL::Admissionregistration::V1::ValidatingWebhook }, presence: false
 
     def serialize
       {}.tap do |result|
         result[:apiVersion] = "admissionregistration.k8s.io/v1"
         result[:kind] = "ValidatingWebhookConfiguration"
-        result[:webhooks] = webhooks.map(&:serialize)
         result[:metadata] = metadata.serialize
+        result[:webhooks] = webhooks.map(&:serialize)
       end
     end
 

data/lib/kube-dsl/dsl/admissionregistration/v1/validating_webhook_configuration_list.rb

@@ -3,11 +3,14 @@ module KubeDSL::DSL::Admissionregistration::V1
     array_field(:item) { KubeDSL::DSL::Admissionregistration::V1::ValidatingWebhookConfiguration.new }
     object_field(:metadata) { KubeDSL::DSL::Meta::V1::ListMeta.new }
 
+    validates :items, array: { kind_of: KubeDSL::DSL::Admissionregistration::V1::ValidatingWebhookConfiguration }, presence: false
+    validates :metadata, object: { kind_of: KubeDSL::DSL::Meta::V1::ListMeta }
+
     def serialize
       {}.tap do |result|
         result[:apiVersion] = "admissionregistration.k8s.io/v1"
-        result[:kind] = "ValidatingWebhookConfigurationList"
         result[:items] = items.map(&:serialize)
+        result[:kind] = "ValidatingWebhookConfigurationList"
         result[:metadata] = metadata.serialize
       end
     end

data/lib/kube-dsl/dsl/admissionregistration/v1/webhook_client_config.rb

@@ -1,13 +1,18 @@
 module KubeDSL::DSL::Admissionregistration::V1
   class WebhookClientConfig < ::KubeDSL::DSLObject
-    value_fields :ca_bundle, :url
+    value_field :ca_bundle
     object_field(:service) { KubeDSL::DSL::Admissionregistration::V1::ServiceReference.new }
+    value_field :url
+
+    validates :ca_bundle, field: { format: :string }, presence: false
+    validates :service, object: { kind_of: KubeDSL::DSL::Admissionregistration::V1::ServiceReference }
+    validates :url, field: { format: :string }, presence: false
 
     def serialize
       {}.tap do |result|
         result[:caBundle] = ca_bundle
-        result[:url] = url
         result[:service] = service.serialize
+        result[:url] = url
       end
     end
 

data/lib/kube-dsl/dsl/admissionregistration/v1beta1/mutating_webhook.rb

@@ -1,24 +1,42 @@
 module KubeDSL::DSL::Admissionregistration::V1beta1
   class MutatingWebhook < ::KubeDSL::DSLObject
-    value_fields :admission_review_versions, :failure_policy, :match_policy, :name, :reinvocation_policy, :side_effects, :timeout_seconds
-    array_field(:rule) { KubeDSL::DSL::Admissionregistration::V1beta1::RuleWithOperations.new }
+    value_field :admission_review_versions
     object_field(:client_config) { KubeDSL::DSL::Admissionregistration::V1beta1::WebhookClientConfig.new }
+    value_field :failure_policy
+    value_field :match_policy
+    value_field :name
     object_field(:namespace_selector) { KubeDSL::DSL::Meta::V1::LabelSelector.new }
     object_field(:object_selector) { KubeDSL::DSL::Meta::V1::LabelSelector.new }
+    value_field :reinvocation_policy
+    array_field(:rule) { KubeDSL::DSL::Admissionregistration::V1beta1::RuleWithOperations.new }
+    value_field :side_effects
+    value_field :timeout_seconds
+
+    validates :admission_review_versions, field: { format: :string }, presence: false
+    validates :client_config, object: { kind_of: KubeDSL::DSL::Admissionregistration::V1beta1::WebhookClientConfig }
+    validates :failure_policy, field: { format: :string }, presence: false
+    validates :match_policy, field: { format: :string }, presence: false
+    validates :name, field: { format: :string }, presence: false
+    validates :namespace_selector, object: { kind_of: KubeDSL::DSL::Meta::V1::LabelSelector }
+    validates :object_selector, object: { kind_of: KubeDSL::DSL::Meta::V1::LabelSelector }
+    validates :reinvocation_policy, field: { format: :string }, presence: false
+    validates :rules, array: { kind_of: KubeDSL::DSL::Admissionregistration::V1beta1::RuleWithOperations }, presence: false
+    validates :side_effects, field: { format: :string }, presence: false
+    validates :timeout_seconds, field: { format: :integer }, presence: false
 
     def serialize
       {}.tap do |result|
         result[:admissionReviewVersions] = admission_review_versions
+        result[:clientConfig] = client_config.serialize
         result[:failurePolicy] = failure_policy
         result[:matchPolicy] = match_policy
         result[:name] = name
+        result[:namespaceSelector] = namespace_selector.serialize
+        result[:objectSelector] = object_selector.serialize
         result[:reinvocationPolicy] = reinvocation_policy
+        result[:rules] = rules.map(&:serialize)
         result[:sideEffects] = side_effects
         result[:timeoutSeconds] = timeout_seconds
-        result[:rules] = rules.map(&:serialize)
-        result[:clientConfig] = client_config.serialize
-        result[:namespaceSelector] = namespace_selector.serialize
-        result[:objectSelector] = object_selector.serialize
       end
     end