kube_schema 1.3.2 → 1.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d74795f238283bb03bba7c2a82459475512cf3922704870aa2256f6235410d66
-  data.tar.gz: 19d329b7abbad3dbf5d37daa8202a457ec14c26f23a078bafaf1e1f10c67abe1
+  metadata.gz: 193f973be41e7f42709ecf8d2407d47d7200ab399a441563b34342149f759956
+  data.tar.gz: 3a931d60cf56e1d03ed9a25eee098978a1e6f647113dc22f05f1858d0d03e045
 SHA512:
-  metadata.gz: f11cfd8ce0f92d2c7b824eba56559860a95eca65e2c13ffbcd8177f296b26fabcf395fb66c16d8d4533fbb188e81698f4560d8f3a5f08d2536b2a8d36557eff7
-  data.tar.gz: 7af51b827644818da72e031e858f47697678dc8d97929c7d2e5bfcd964e2202ede1507f0f20e63ba64dec6a2bebdb0e2128a99a0085fa3562ce3fac1a8d241d0
+  metadata.gz: d789cd2fe143a465f645f73fb7d6ecc0882ace1bbaadca2513b26053efff52bd1c162aff2fe43ee25e0bd600024366db92a221b855562d3eef4b44025f691daf
+  data.tar.gz: 94642b199d333cb7da54cc324c0ee29641431bcc4884e38b7e24e6d47eb97f886ece7f680f3923c336c62a55ff171d247d8578abde94e10cee0c5eda8a8759a6

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    kube_schema (1.3.1)
+    kube_schema (1.3.3)
       json_schemer (~> 2.5.0)
       rubyshell (~> 1.5.0)
 

data/lib/kube/schema/instance.rb

@@ -101,6 +101,14 @@ module Kube
               schema["definitions"].merge!(extra)
             end
 
+            # Kubernetes OpenAPI v2 defines IntOrString as "type": "string"
+            # with "format": "int-or-string". This is a limitation of
+            # OpenAPI v2 which cannot express union types. Patch the
+            # definition so JSONSchemer accepts both integers and strings.
+            if (int_or_str = schema.dig("definitions", "io.k8s.apimachinery.pkg.util.intstr.IntOrString"))
+              int_or_str["type"] = ["string", "integer"]
+            end
+
             JSONSchemer.schema(schema)
           end
         end
@@ -184,6 +192,7 @@ module Kube
           Class.new(::Kube::Schema::Resource) do
             @schema = schema_instance
             @defaults = defaults
+            @schema_properties = @schema.value["properties"].keys.map(&:to_sym)
 
             def self.schema
               @schema || superclass.schema
@@ -192,6 +201,16 @@ module Kube
             def self.defaults
               @defaults || superclass.defaults
             end
+
+            def self.schema_properties
+              @schema_properties
+            end
+
+            schema_instance.value["properties"].keys.then do |properties|
+              properties.each do |prop|
+                define_method(prop.to_sym) { @data[prop.to_sym] }
+              end
+            end
           end
         end
 

data/lib/kube/schema/manifest.rb

@@ -90,8 +90,32 @@ module Kube
       # File I/O
       # -------------------------------------------------------------------
 
+      # Parse a YAML string containing one or more Kubernetes resource
+      # documents and return a Manifest populated with typed Resource objects.
+      #
+      # Each document's "kind" is resolved via Kube::Schema.parse to
+      # produce the correct Resource subclass (e.g. Deployment, Service).
+      # Documents without a recognized "kind" fall back to a bare Resource.
+      #
+      #   yaml = `helm template my-release bitnami/nginx`
+      #   manifest = Kube::Schema::Manifest.parse(yaml)
+      #   manifest.first.class  #=> Kube::Schema::Resource (Deployment subclass)
+      #
+      # @param yaml_string [String] multi-document YAML
+      # @return [Manifest]
+      def self.parse(yaml_string)
+        docs = if YAML.respond_to?(:safe_load_stream)
+                 YAML.safe_load_stream(yaml_string, permitted_classes: [Symbol])
+               else
+                 YAML.load_stream(yaml_string)
+               end
+
+        resources = docs.compact.map { |doc| parse_doc(doc) }
+        new(*resources)
+      end
+
       # Read a YAML file containing one or more Kubernetes resource documents
-      # and return a Manifest populated with Resource objects.
+      # and return a Manifest populated with typed Resource objects.
       #
       #   manifest = Kube::Schema::Manifest.open("deploy.yaml")
       #   manifest.count  #=> 3
@@ -108,7 +132,7 @@ module Kube
                  YAML.load_stream(contents)
                end
 
-        resources = docs.compact.map { |doc| Resource.new(doc) }
+        resources = docs.compact.map { |doc| parse_doc(doc) }
         new(*resources, filename: path)
       end
 
@@ -127,6 +151,16 @@ module Kube
         path
       end
 
+      # Parse a single YAML document hash into a typed Resource.
+      #
+      # @param doc [Hash] a parsed YAML document
+      # @return [Resource]
+      # @raise [RuntimeError] if the kind is not recognized
+      def self.parse_doc(doc)
+        Kube::Schema.parse(doc)
+      end
+      private_class_method :parse_doc
+
       private
 
         # Deep-stringify keys for clean YAML output.

data/lib/kube/schema/resource.rb

@@ -11,12 +11,16 @@ module Kube
           # Therefore, they are ONLY ever set from the self.defaults
           # property.
           deep_symbolize_keys(hash).then do |symbolized|
-            config = defaults.merge({
-              metadata: symbolized.delete(:metadata) || {},
-              spec: symbolized.delete(:spec) || {},
-            })
-
-            @data = config
+            @data = defaults
+
+            # This is extracting "top-level" properties from the input hash
+            # such as [apiVersion, spec, metadata, roleRef, ...]
+            # We then ignore the rest of the attributes by design.
+            self.class.schema_properties.each do |property|
+              if symbolized.key?(property)
+                @data[property] = symbolized.delete(property)
+              end
+            end
           end
         end
 
@@ -25,17 +29,20 @@ module Kube
         end
       end
 
-      def apiVersion = @data.apiVersion
-      def kind       = @data.kind
-      def spec       = @data.spec
-      def metadata   = @data.metadata
-
       # Gets overridden by the factory in Kube::Schema::Instance
-      def self.schema = nil
+      def self.schema
+        raise "Kube::Schema::Resource should NOT be instanciated directly"
+      end
+
+      def self.schema_properties
+        raise "Kube::Schema::Resource should NOT be instanciated directly"
+      end
 
       # Gets overridden by the factory in Kube::Schema::Instance.
       # Returns a frozen Hash like { "apiVersion" => "apps/v1", "kind" => "Deployment" }
-      def self.defaults = nil
+      def self.defaults
+        raise "Kube::Schema::Resource should NOT be instanciated directly"
+      end
 
       def valid?
         if self.class.schema.nil?
@@ -69,7 +76,8 @@ module Kube
       # they are facts derived from the GVK metadata.
       def to_h
         defaults = self.class.defaults
-        data = @data.reject { |_, v| v.is_a?(Hash) && v.empty? }
+        data = deep_compact(@data)
+        data = data.reject { |_, v| v.is_a?(Hash) && v.empty? }
 
         if defaults
           symbolized = deep_symbolize_keys(defaults)
@@ -95,6 +103,20 @@ module Kube
 
       private
 
+        def deep_compact(obj)
+          case obj
+          when Hash
+            obj.each_with_object({}) do |(k, v), result|
+              compacted = deep_compact(v)
+              result[k] = compacted unless compacted.nil?
+            end
+          when Array
+            obj.map { |v| deep_compact(v) }
+          else
+            obj
+          end
+        end
+
         def deep_stringify_keys(obj)
           case obj
           when Hash

data/lib/kube/schema/version.rb

@@ -2,6 +2,6 @@
 
 module Kube
   module Schema
-    VERSION = "1.3.2"
+    VERSION = "1.3.4"
   end
 end

data/lib/kube/schema.rb

@@ -48,11 +48,11 @@ module Kube
       #     api_version: "cert-manager.io/v1"
       #   )
       #
-      # @example Register from a Hash
-      #   Kube::Schema.register("MyResource",
-      #     schema: { "type" => "object", "properties" => { ... } },
-      #     api_version: "example.com/v1"
-      #   )
+      # @example Register from Chart#crds
+      #   chart.crds.each do |crd|
+      #     s = crd.to_json_schema
+      #     Kube::Schema.register(s[:kind], schema: s[:schema], api_version: s[:api_version])
+      #   end
       #
       def register(kind, schema:, api_version:)
         require "json"
@@ -117,10 +117,26 @@ module Kube
         end
       end
 
-      # Build a Resource from a hash.
-      #   Kube::Schema.parse(Kube::Schema["Deployment"].to_h) == Kube::Schema["Deployment"]
+      # Build a typed Resource from a raw hash.
+      #
+      # Looks up the "kind" key in the hash and resolves it to the
+      # correct Resource subclass via the schema registry. The hash
+      # may use string or symbol keys.
+      #
+      #   Kube::Schema.parse("kind" => "Deployment", "apiVersion" => "apps/v1")
+      #   Kube::Schema.parse(kind: "Pod", apiVersion: "v1", metadata: { name: "web" })
+      #
+      # @param hash [Hash] a Kubernetes resource hash with at least a "kind" key
+      # @return [Resource] a schema-validated Resource instance
+      # @raise [ArgumentError] if the hash is nil, not a Hash, or missing "kind"
       def parse(hash)
-        raise NotImplementedError
+        raise ArgumentError, "Expected a Hash, got #{hash.class}" unless hash.is_a?(Hash)
+
+        kind = hash["kind"] || hash[:kind]
+        raise ArgumentError, "Hash must contain a \"kind\" key" if kind.nil?
+
+        resource_class = self[kind]
+        resource_class.new(hash)
       end
 
       # Available Kubernetes versions, read from the local schemas directory.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kube_schema
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.3.4
 platform: ruby
 authors:
 - Nathan K
@@ -96,7 +96,6 @@ files:
 - ".github/workflows/update-schemas.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- AGENTS.md
 - Gemfile
 - Gemfile.lock
 - README.md

data/AGENTS.md

@@ -1 +0,0 @@
-The "schemas" branch is FUCKING HUGE!!!!!!!!!!!! DO NOT FUCKING DOWNLOAD IT!!!!!!