kube_schema 1.4.8 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23eda6bd933e2383e7aebc9b536d0d23ed1f55dff09d6c84968a1471de17a0b4
-  data.tar.gz: 257506c09fbdd153f1eaba48bd38b7012a584a5294086cdbbe517dfd84778e74
+  metadata.gz: 3fe7b4efafcce28b1cead68ac163369fa93a88bf8fb20c1b4c93f184df24383c
+  data.tar.gz: c98ac341e688a2d93a58e470ebc307542628a2682ddc6821756ca13c75221aeb
 SHA512:
-  metadata.gz: 8584a14a894bdfc04a6c26a4ebc5d10a0a0923872b6c747b7fc3d3b0cd1f412a274aeadedf9aff04750dada41780260e6cd882f1aa83ca0a26606078227bbf7b
-  data.tar.gz: ddc8542cdb6a43ca16774fc1abf26990e36c9acb3feeced54d77064010438895027c9f5d22c4ee07b36f129f86f7c65d8fed43701648d25d91fd1e9bb5da6cf1
+  metadata.gz: 8123faed36719b2de640ba907fa86a229eb20fa3f97b38bf72dd030dfce82c2e83673d3f61c7c1c61f51589b418baabbc3619fb61b37c8938ce4fb67d7317ac6
+  data.tar.gz: 07ea4b9cb8cfc4f9fd2b5b8721b884df1ca23cd2a586e7765e4e8a7fef0373ad9074f2f53d5987cf6deb2d5e144a0f5e35bb1f5e66078a90d4a4d738c79251b4

data/Gemfile.lock

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

data/bin/create-cdi-x-values

@@ -0,0 +1,64 @@
+#!/usr/bin/env bash
+#
+# Rewrites schemas/cdi-definitions.json in-place to:
+#   1. Add x-kubernetes-group-version-kind annotations
+#   2. Fix $ref pointers from bare v1.* to io.k8s.* prefix
+#
+set -euo pipefail
+
+DEFS_FILE="schemas/cdi-definitions.json"
+
+echo "Rewriting $DEFS_FILE..."
+
+jq '
+  # GVK map: definition key -> [{ group, version, kind }]
+  {
+    "v1beta1.CDI":                [{ group: "cdi.kubevirt.io",            version: "v1beta1", kind: "CDI" }],
+    "v1beta1.CDIConfig":          [{ group: "cdi.kubevirt.io",            version: "v1beta1", kind: "CDIConfig" }],
+    "v1beta1.DataImportCron":     [{ group: "cdi.kubevirt.io",            version: "v1beta1", kind: "DataImportCron" }],
+    "v1beta1.DataSource":         [{ group: "cdi.kubevirt.io",            version: "v1beta1", kind: "DataSource" }],
+    "v1beta1.DataVolume":         [{ group: "cdi.kubevirt.io",            version: "v1beta1", kind: "DataVolume" }],
+    "v1beta1.ObjectTransfer":     [{ group: "cdi.kubevirt.io",            version: "v1beta1", kind: "ObjectTransfer" }],
+    "v1beta1.StorageProfile":     [{ group: "cdi.kubevirt.io",            version: "v1beta1", kind: "StorageProfile" }],
+    "v1beta1.VolumeCloneSource":  [{ group: "cdi.kubevirt.io",            version: "v1beta1", kind: "VolumeCloneSource" }],
+    "v1beta1.VolumeImportSource": [{ group: "cdi.kubevirt.io",            version: "v1beta1", kind: "VolumeImportSource" }],
+    "v1beta1.VolumeUploadSource": [{ group: "cdi.kubevirt.io",            version: "v1beta1", kind: "VolumeUploadSource" }],
+    "v1beta1.UploadTokenRequest": [{ group: "upload.cdi.kubevirt.io",     version: "v1beta1", kind: "UploadTokenRequest" }]
+  } as $gvk_map |
+
+  # Explicit $ref rewrite map: bare v1.* -> io.k8s.* full paths
+  {
+    "#/definitions/v1.Affinity":                    "#/definitions/io.k8s.api.core.v1.Affinity",
+    "#/definitions/v1.Condition":                   "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Condition",
+    "#/definitions/v1.Duration":                    "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Duration",
+    "#/definitions/v1.LabelSelector":               "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector",
+    "#/definitions/v1.ListMeta":                    "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta",
+    "#/definitions/v1.LocalObjectReference":        "#/definitions/io.k8s.api.core.v1.LocalObjectReference",
+    "#/definitions/v1.ObjectMeta":                  "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta",
+    "#/definitions/v1.PersistentVolumeClaimSpec":   "#/definitions/io.k8s.api.core.v1.PersistentVolumeClaimSpec",
+    "#/definitions/v1.ResourceRequirements":        "#/definitions/io.k8s.api.core.v1.ResourceRequirements",
+    "#/definitions/v1.Time":                        "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time",
+    "#/definitions/v1.Toleration":                  "#/definitions/io.k8s.api.core.v1.Toleration",
+    "#/definitions/v1.TypedLocalObjectReference":   "#/definitions/io.k8s.api.core.v1.TypedLocalObjectReference",
+    "#/definitions/v1.TypedObjectReference":        "#/definitions/io.k8s.api.core.v1.TypedObjectReference",
+    "#/definitions/v1.VolumeResourceRequirements":  "#/definitions/io.k8s.api.core.v1.VolumeResourceRequirements"
+  } as $ref_map |
+
+  # Inject x-kubernetes-group-version-kind annotations
+  with_entries(
+    if $gvk_map[.key] then
+      .value["x-kubernetes-group-version-kind"] = $gvk_map[.key]
+    else . end
+  ) |
+
+  # Fix $ref pointers using explicit mapping
+  walk(
+    if type == "string" and $ref_map[.] then $ref_map[.]
+    else . end
+  )
+' "$DEFS_FILE" > "${DEFS_FILE}.tmp" && mv "${DEFS_FILE}.tmp" "$DEFS_FILE"
+
+ANNOTATED=$(jq '[.[] | select(has("x-kubernetes-group-version-kind"))] | length' "$DEFS_FILE")
+TOTAL=$(jq 'length' "$DEFS_FILE")
+STALE_REFS=$(jq -r '[.. | strings | select(startswith("#/definitions/v1."))] | length' "$DEFS_FILE")
+echo "Done. $ANNOTATED/$TOTAL definitions annotated. $STALE_REFS stale v1.* refs remaining."

data/lib/kube/monkey_patches.rb

@@ -1,4 +1,3 @@
-# https://github.com/mickey/black-hole-struct/blob/master/lib/black_hole_struct.rb
 class Hash
   def method_missing(name, *args)
     key = name.to_s

data/lib/kube/schema/instance.rb

@@ -38,29 +38,52 @@ module Kube
         @version = version
       end
 
-      # Look up a resource by kind (e.g. "Deployment", "NetworkPolicy").
+      # Look up a resource by kind or full GVK string.
+      #
+      # Accepts:
+      #   instance["Deployment"]                      — kind-only lookup
+      #   instance["apps/v1/Deployment"]              — group/version/kind
+      #   instance["v1/Pod"]                          — version/kind (core, empty group)
+      #   instance["networking.k8s.io/v1/Ingress"]    — fully qualified
+      #
       # Returns a class that inherits from Kube::Schema::Resource.
       #
       # Custom schemas registered via Kube::Schema.register take precedence
-      # over built-in definitions, allowing users to override or extend the
-      # schema for any kind.
-      def [](kind)
-        @resource_classes[kind] ||= begin
-          # Custom schemas win over built-in definitions.
-          custom = find_custom_entry(kind)
-          if custom
-            build_resource_class(custom[:schema], custom[:defaults])
-          else
-            entry = find_gvk_entry(kind)
+      # over built-in definitions (kind-only lookups only).
+      def [](input)
+        @resource_classes[input] ||= begin
+          if input.include?("/")
+            parts = input.split("/")
+
+            case parts.length
+            when 3
+              group, version, kind = parts
+            when 2
+              group = ""
+              version, kind = parts
+            else
+              raise "Invalid GVK format: #{input.inspect}." \
+                "\nExpected \"group/version/kind\" or \"version/kind\"."
+            end
 
-            if entry.nil?
-              raise "No resource schema found for #{kind}!" \
-                "\nUse #list_resources to see available kinds for v#{version}."
+            entry = find_gvk_entry_by_full_gvk(group, version, kind)
+          else
+            # Kind-only lookup — custom schemas take precedence.
+            custom = find_custom_entry(input)
+            if custom
+              return build_resource_class(custom[:schema], custom[:defaults])
             end
 
-            ref_schema = schemer.ref("#/definitions/#{entry[:definition_key]}")
-            build_resource_class(ref_schema, entry[:defaults].freeze)
+            entry = find_gvk_entry(input)
+          end
+
+          if entry.nil?
+            raise "No resource schema found for #{input.inspect}!" \
+              "\nUse #list_resources to see available kinds for v#{@version}."
           end
+
+          ref_schema = schemer.ref("#/definitions/#{entry[:definition_key]}")
+          build_resource_class(ref_schema, entry[:defaults].freeze)
         end
       end
 
@@ -167,7 +190,7 @@ module Kube
         #   }
         def gvk_index
           @gvk_index ||= begin
-            index = {}
+            index = Hash.new { |h, k| h[k] = [] }
 
             schemer.value.fetch("definitions", {}).each do |key, definition|
               gvks = definition["x-kubernetes-group-version-kind"]
@@ -179,7 +202,7 @@ module Kube
                 kind = gvk["kind"]
                 api_version = group.empty? ? version : "#{group}/#{version}"
 
-                index[kind] = {
+                index[kind] << {
                   definition_key: key,
                   group: group,
                   version: version,
@@ -197,17 +220,29 @@ module Kube
         end
 
         # Find a GVK entry by kind name (case-insensitive).
-        # Returns the full entry hash or nil.
+        # Returns the first matching entry hash or nil.
         def find_gvk_entry(kind)
-          return gvk_index[kind] if gvk_index.key?(kind)
+          entries = gvk_index[kind]
+          return entries.first if entries && !entries.empty?
 
           gvk_index.each do |k, v|
-            return v if k.downcase == kind.downcase
+            return v.first if k.downcase == kind.downcase
           end
 
           nil
         end
 
+        # Find a GVK entry by exact group, version, and kind.
+        # Returns the matching entry hash or nil.
+        def find_gvk_entry_by_full_gvk(group, version, kind)
+          entries = gvk_index[kind]
+          return nil if entries.nil? || entries.empty?
+
+          entries.find do |entry|
+            entry[:group] == group && entry[:version] == version
+          end
+        end
+
         # Find a custom schema entry by kind (case-insensitive).
         # Returns the { schema:, defaults: } hash or nil.
         def find_custom_entry(kind)
@@ -391,6 +426,46 @@ if __FILE__ == $0
       end
     end
 
+    describe "#[] with full GVK string" do
+      it "resolves apps/v1/Deployment" do
+        klass = instance["apps/v1/Deployment"]
+        expect(klass).to be < Kube::Schema::Resource
+        expect(klass.defaults).to eq({ "apiVersion" => "apps/v1", "kind" => "Deployment" })
+      end
+
+      it "resolves v1/Pod (core resource, empty group)" do
+        klass = instance["v1/Pod"]
+        expect(klass).to be < Kube::Schema::Resource
+        expect(klass.defaults).to eq({ "apiVersion" => "v1", "kind" => "Pod" })
+      end
+
+      it "resolves networking.k8s.io/v1/Ingress" do
+        klass = instance["networking.k8s.io/v1/Ingress"]
+        expect(klass).to be < Kube::Schema::Resource
+        expect(klass.defaults).to eq({ "apiVersion" => "networking.k8s.io/v1", "kind" => "Ingress" })
+      end
+
+      it "resolves kubevirt.io/v1/VirtualMachine" do
+        klass = instance["kubevirt.io/v1/VirtualMachine"]
+        expect(klass).to be < Kube::Schema::Resource
+        expect(klass.defaults).to eq({ "apiVersion" => "kubevirt.io/v1", "kind" => "VirtualMachine" })
+      end
+
+      it "raises for invalid GVK format (too many slashes)" do
+        expect { instance["a/b/c/d"] }.to raise_error(RuntimeError, /Invalid GVK format/)
+      end
+
+      it "raises for non-existent GVK" do
+        expect { instance["fake.io/v99/Blah"] }.to raise_error(RuntimeError, /No resource schema found/)
+      end
+
+      it "caches GVK lookups" do
+        a = instance["apps/v1/Deployment"]
+        b = instance["apps/v1/Deployment"]
+        expect(a).to be(b)
+      end
+    end
+
     describe "#list_resources" do
       it "returns a sorted array of kind strings" do
         kinds = instance.list_resources
@@ -453,6 +528,52 @@ if __FILE__ == $0
       end
     end
 
+    describe "CloudnativePG schemas" do
+      it "resolves Cluster by kind" do
+        klass = instance["Cluster"]
+        expect(klass).to be < Kube::Schema::Resource
+        expect(klass.defaults).to eq({ "apiVersion" => "postgresql.cnpg.io/v1", "kind" => "Cluster" })
+      end
+
+      it "resolves Cluster by full GVK string" do
+        klass = instance["postgresql.cnpg.io/v1/Cluster"]
+        expect(klass).to be < Kube::Schema::Resource
+        expect(klass.defaults).to eq({ "apiVersion" => "postgresql.cnpg.io/v1", "kind" => "Cluster" })
+      end
+
+      it "includes Cluster in list_resources" do
+        expect(instance.list_resources).to include("Cluster")
+      end
+
+      it "resolves Backup" do
+        klass = instance["postgresql.cnpg.io/v1/Backup"]
+        expect(klass.defaults).to eq({ "apiVersion" => "postgresql.cnpg.io/v1", "kind" => "Backup" })
+      end
+
+      it "resolves ScheduledBackup" do
+        klass = instance["postgresql.cnpg.io/v1/ScheduledBackup"]
+        expect(klass.defaults).to eq({ "apiVersion" => "postgresql.cnpg.io/v1", "kind" => "ScheduledBackup" })
+      end
+
+      it "resolves Pooler" do
+        klass = instance["postgresql.cnpg.io/v1/Pooler"]
+        expect(klass.defaults).to eq({ "apiVersion" => "postgresql.cnpg.io/v1", "kind" => "Pooler" })
+      end
+
+      it "can instantiate a Cluster with the block DSL" do
+        resource = instance["postgresql.cnpg.io/v1/Cluster"].new {
+          metadata.name = "pg-cluster"
+          metadata.namespace = "databases"
+          spec.instances = 3
+          spec.storage.size = "10Gi"
+        }
+        expect(resource.to_h[:apiVersion]).to eq("postgresql.cnpg.io/v1")
+        expect(resource.to_h[:kind]).to eq("Cluster")
+        expect(resource.to_h[:metadata][:name]).to eq("pg-cluster")
+        expect(resource.to_h[:spec][:instances]).to eq(3)
+      end
+    end
+
     describe "class-level schemer cache" do
       it "shares the schemer across instances of the same version" do
         a = described_class.new("1.34")

data/lib/kube/schema/resource.rb

@@ -352,7 +352,6 @@ if __FILE__ == $0
 
         expect(yaml).to include("kind: Pod")
         expect(yaml).to include("apiVersion: v1")
-        expect(yaml).not_to include("BlackHoleStruct")
         expect(yaml).not_to include("!ruby/object")
       end
 
@@ -435,7 +434,6 @@ if __FILE__ == $0
           yaml = deployment.to_yaml
 
           expect(yaml).not_to include("!ruby/object")
-          expect(yaml).not_to include("BlackHoleStruct")
           expect(yaml).not_to include("table:")
         end
 

data/lib/kube/schema/version.rb

@@ -2,6 +2,6 @@
 
 module Kube
   module Schema
-    VERSION = "1.4.8"
+    VERSION = "1.5.0"
   end
 end

data/lib/kube/schema.rb

@@ -162,53 +162,6 @@ module Kube
   end
 end
 
-# Patch BlackHoleStruct to handle arrays consistently.
-#
-# The upstream gem does not recurse into arrays — hashes inside arrays
-# are not converted to BlackHoleStruct on construction, and are not
-# converted back to plain Hash on #to_h.  This causes key-type
-# inconsistencies after a Resource round-trip (symbol keys become
-# string keys inside arrays).
-#
-# These two patches fix both directions:
-#   initialize — converts hashes inside arrays to BlackHoleStruct
-#   to_h       — converts BlackHoleStruct/arrays back to plain objects
-class BlackHoleStruct
-  def initialize(hash = {})
-    raise ArgumentError, "Argument should be a Hash" unless hash.is_a?(Hash)
-
-    @table = {}
-    hash.each do |key, value|
-      @table[key.to_sym] = deep_wrap(value)
-    end
-  end
-
-  def to_h
-    hash = {}
-    @table.each do |key, value|
-      hash[key] = deep_unwrap(value)
-    end
-    hash
-  end
-
-  private
-
-  def deep_wrap(value)
-    case value
-    when Hash  then self.class.new(value)
-    when Array then value.map { |v| deep_wrap(v) }
-    else       value
-    end
-  end
-
-  def deep_unwrap(value)
-    case value
-    when self.class then value.to_h
-    when Array      then value.map { |v| deep_unwrap(v) }
-    else            value
-    end
-  end
-end
 
 if __FILE__ == $0
   require "bundler/setup"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kube_schema
 version: !ruby/object:Gem::Version
-  version: 1.4.8
+  version: 1.5.0
 platform: ruby
 authors:
 - Nathan K
@@ -104,6 +104,7 @@ files:
 - assets/validation-error.png
 - bin/console
 - bin/copy-schemas-over
+- bin/create-cdi-x-values
 - bin/create-kubevirt-x-values
 - bin/increment-version
 - bin/release-gem