kube_cluster 0.3.7 → 0.3.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de5958c26954185923d57f941d9ecea6972b30a7df0a2014e691621c62f731f9
-  data.tar.gz: f593ad383f34c30cf5a3665f32fceee285fd4eb7dc1302bd7189e36b3680f5ed
+  metadata.gz: 6ac91f4fe14ccc5bf1c7e5e1465d2c9568276a0cb3c3623ee5938679deea4d1b
+  data.tar.gz: cf89241b112caf7f919c83b1ffba51883005c7600415b6b626449521ac452fda
 SHA512:
-  metadata.gz: 3610b3f4b74e0c547746bf155f0b717d0cc5a4f7229b04defd35d3baacf5151ddfdda0ba9ac389764a7dc5335d80042062ce178adb04c4485126e68a0cceda60
-  data.tar.gz: a1a31a19a6bd3995b924250f55fe91ddd9397cb20d3dd5d1b243bd01abda5cc6e44aa062e9b4b4b4def02a766f6857be654a959861695c508a5612a443a02d06
+  metadata.gz: 03b65216d55822e7abfaf52f6cdb1b471cc2797e5f57354de6ddc3f8ee688f7954ab9f627499d31d425ce42073bde2f1623ac65314be8d205aeac647e42f3513
+  data.tar.gz: 58400d0fddf0e803578bcc04dec147e3a092da4ec694a45ac98435011558e35782b3b3cac86303b9146514cfb72d6c0b5fb5dbf041cbf0bd2683ea6e6948c006

data/Gemfile.lock

@@ -1,15 +1,19 @@
 PATH
   remote: .
   specs:
-    kube_cluster (0.3.7)
-      kube_kubectl (~> 2.0.0)
-      kube_schema (~> 1.3.0)
+    kube_cluster (0.3.9)
+      kube_kubectl (~> 2.0.9)
+      kube_schema (~> 1.3.7)
+      scampi (~> 0.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.3)
     bigdecimal (4.1.2)
+    colorize (1.1.0)
+    colorize-extended (0.1.0)
+      colorize (~> 1.1)
     date (3.5.1)
     debug (1.11.1)
       irb (~> 1.10)
@@ -28,18 +32,17 @@ GEM
       hana (~> 1.3)
       regexp_parser (~> 2.0)
       simpleidn (~> 0.2)
-    kube_kubectl (2.0.8)
+    kube_kubectl (2.0.9)
       debug (~> 1.11)
       json_schemer (~> 2.5)
       rubyshell (~> 1.5)
       shellwords (~> 0.2.2)
-      string_builder (~> 1.2.0)
-    kube_schema (1.3.4)
+      string_builder (~> 1.2.2)
+    kube_schema (1.3.7)
       json_schemer (~> 2.5.0)
       rubyshell (~> 1.5.0)
     language_server-protocol (3.17.0.5)
     lint_roller (1.1.0)
-    minitest (5.27.0)
     parallel (2.0.1)
     parser (3.3.11.1)
       ast (~> 2.4.1)
@@ -77,9 +80,11 @@ GEM
       prism (~> 1.7)
     ruby-progressbar (1.13.0)
     rubyshell (1.5.0)
+    scampi (0.1.4)
+      colorize-extended
     shellwords (0.2.2)
     simpleidn (0.2.3)
-    string_builder (1.2.1)
+    string_builder (1.2.2)
     stringio (3.2.0)
     tsort (0.2.0)
     unicode-display_width (3.2.0)
@@ -92,7 +97,6 @@ PLATFORMS
 
 DEPENDENCIES
   kube_cluster!
-  minitest (~> 5.0)
   rake (~> 13.0)
   rubocop (~> 1.21)
 

data/README.md

@@ -1,15 +1,138 @@
 # kube_cluster
 
-A template for creating Ruby gems.
+Ruby-native Kubernetes. Define, transform, and deploy cluster resources with pure Ruby.
 
-## Usage
+## Install
 
-```bash
-git clone https://github.com/n-at-han-k/kube_cluster
-cd kube_cluster
-bin/rename-gem my-new-gem
-bin/update-spec
-bin/choose-license
-bin/increment-version patch
-bin/release-gem
+```ruby
+gem "kube_cluster", "~> 0.3"
 ```
+
+## Examples
+
+### Define a resource
+
+```ruby
+pod = Kube::Cluster["Pod"].new {
+  metadata.name = "redis"
+  spec.containers = [{ name: "redis", image: "redis:8" }]
+}
+
+puts pod.to_yaml
+```
+
+### Subclass for reuse
+
+```ruby
+class RedisPod < Kube::Cluster["Pod"]
+  def initialize(&block)
+    super {
+      metadata.name = "redis"
+      spec.containers = [{ name: "redis", image: "redis:8", ports: [{ containerPort: 6379 }] }]
+    }
+    instance_exec(&block) if block_given?
+  end
+end
+
+puts RedisPod.new { metadata.namespace = "production" }.to_yaml
+```
+
+### Manifest + middleware
+
+One Deployment declaration becomes a fully-configured stack:
+
+```ruby
+manifest = Kube::Cluster::Manifest.new(
+  Kube::Cluster["Deployment"].new {
+    metadata.name = "web"
+    metadata.labels = {
+      "app.kubernetes.io/expose": "app.example.com",
+      "app.kubernetes.io/autoscale": "2-10",
+      "app.kubernetes.io/size": "small"
+    }
+    spec.selector.matchLabels = { app: "web" }
+    spec.template.spec.containers = [
+      { name: "web", image: "nginx", ports: [{ name: "http", containerPort: 8080 }] }
+    ]
+  }
+)
+
+Kube::Cluster::Middleware::Stack.new {
+  use Middleware::ServiceForDeployment
+  use Middleware::IngressForService
+  use Middleware::HPAForDeployment
+  use Middleware::Namespace, "production"
+  use Middleware::Labels, managed_by: "kube_cluster"
+  use Middleware::ResourcePreset
+  use Middleware::SecurityContext
+  use Middleware::PodAntiAffinity
+}.call(manifest)
+
+puts manifest.to_yaml  # => Deployment, Service, Ingress, HPA — all configured
+```
+
+### Dirty tracking + patching
+
+```ruby
+cluster = Kube::Cluster.connect(kubeconfig: "~/.kube/config")
+
+config = Kube::Cluster["ConfigMap"].new(cluster:) {
+  metadata.name = "app-config"
+  self.data = { version: "1" }
+}
+
+config.apply           # creates on cluster
+config.data.version = "2"
+config.changed?        # => true
+config.patch           # sends only { data: { version: "2" } }
+```
+
+### Helm charts as manifests
+
+```ruby
+manifest = Kube::Helm::Repo
+  .new("bitnami", url: "https://charts.bitnami.com/bitnami")
+  .fetch("nginx", version: "18.1.0")
+  .apply_values("replicaCount" => 3)
+
+puts manifest.to_yaml
+```
+
+### Register CRDs as first-class resources
+
+```ruby
+chart = Kube::Helm::Repo.new("jetstack", url: "https://charts.jetstack.io")
+  .fetch("cert-manager", version: "1.17.2")
+
+chart.crds.each { |crd|
+  s = crd.to_json_schema
+  Kube::Schema.register(s[:kind], schema: s[:schema], api_version: s[:api_version])
+}
+
+issuer = Kube::Cluster["ClusterIssuer"].new {
+  metadata.name = "letsencrypt"
+  spec.acme.server = "https://acme-v02.api.letsencrypt.org/directory"
+}
+```
+
+## Middleware
+
+| Middleware | Effect |
+|---|---|
+| `Namespace` | Sets `metadata.namespace` on all resources |
+| `Labels` | Merges standard Kubernetes labels |
+| `Annotations` | Merges annotations |
+| `ResourcePreset` | Injects CPU/memory from `app.kubernetes.io/size` (nano → 2xlarge) |
+| `SecurityContext` | Injects restricted/baseline security contexts |
+| `PodAntiAffinity` | Spreads pods across nodes |
+| `ServiceForDeployment` | Generates Service from named container ports |
+| `IngressForService` | Generates Ingress from `app.kubernetes.io/expose` label |
+| `HPAForDeployment` | Generates HPA from `app.kubernetes.io/autoscale` label |
+
+## More examples
+
+See the [`examples/`](examples/) directory for complete runnable projects.
+
+## License
+
+Apache-2.0

data/Rakefile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+task :test do
+  sh "bundle", "exec", "scampi"
+end
+
+task default: :test

data/bin/test

@@ -1,14 +1,3 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
+#!/usr/bin/env bash
 
-$LOAD_PATH.unshift File.expand_path("../test", __dir__)
-
-require "bundler/setup"
-
-Dir.chdir(File.expand_path("..", __dir__))
-
-if ARGV.empty?
-  Dir.glob("test/**/*_test.rb").sort.each { |f| require_relative "../#{f}" }
-else
-  ARGV.each { |f| require_relative "../#{f}" }
-end
+bundle exec scampi $@

data/kube_cluster.gemspec

@@ -28,10 +28,11 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_dependency "scampi", "~> 0.1"
+
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rubocop", "~> 1.21"
 
-  spec.add_dependency "kube_schema", "~> 1.3.0"
-  spec.add_dependency "kube_kubectl", "~> 2.0.0"
+  spec.add_dependency "kube_schema", "~> 1.3.7"
+  spec.add_dependency "kube_kubectl", "~> 2.0.9"
 end

data/lib/kube/cluster/manifest.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+require "bundler/setup"
+require "kube/cluster"
+
 module Kube
   module Cluster
     # A flat, ordered collection of Kubernetes resources.
@@ -23,3 +26,205 @@ module Kube
     end
   end
 end
+
+test do
+  Middleware = Kube::Cluster::Middleware
+
+  # ── Bare manifest ────────────────────────────────────────────────────────
+
+  it "bare_manifest_enumerates_resources_unchanged" do
+    m = Kube::Cluster::Manifest.new
+    m << Kube::Cluster["ConfigMap"].new {
+      metadata.name = "test"
+      self.data = { key: "value" }
+    }
+
+    resources = m.to_a
+    resources.size.should == 1
+  end
+
+  # ── Stack transforms resources ───────────────────────────────────────────
+
+  it "stack_transforms_resources" do
+    m = Kube::Cluster::Manifest.new
+    m << Kube::Cluster["ConfigMap"].new {
+      metadata.name = "test"
+    }
+
+    stack = Middleware::Stack.new do
+      use Middleware::Namespace, "production"
+    end
+    stack.call(m)
+
+    resources = m.to_a
+    resources.first.to_h.dig(:metadata, :namespace).should == "production"
+  end
+
+  it "to_yaml_reflects_middleware" do
+    m = Kube::Cluster::Manifest.new
+    m << Kube::Cluster["ConfigMap"].new {
+      metadata.name = "test"
+    }
+
+    Middleware::Namespace.new("production").call(m)
+
+    yaml = m.to_yaml
+    yaml.should.include "namespace: production"
+  end
+
+  it "enumerable_methods_work" do
+    m = Kube::Cluster::Manifest.new
+    m << Kube::Cluster["ConfigMap"].new { metadata.name = "a" }
+    m << Kube::Cluster["ConfigMap"].new { metadata.name = "b" }
+
+    Middleware::Namespace.new("production").call(m)
+
+    names = m.map { |r| r.to_h.dig(:metadata, :name) }
+    names.should == %w[a b]
+  end
+
+  # ── Multi-middleware stack ──────────────────────────────────────────────
+
+  it "multiple_middleware_compose_in_order" do
+    m = Kube::Cluster::Manifest.new
+    m << Kube::Cluster["ConfigMap"].new {
+      metadata.name = "test"
+    }
+
+    stack = Middleware::Stack.new do
+      use Middleware::Namespace, "staging"
+      use Middleware::Labels, app: "myapp", managed_by: "kube_cluster"
+    end
+    stack.call(m)
+
+    r = m.first
+    h = r.to_h
+
+    h.dig(:metadata, :namespace).should == "staging"
+  end
+
+  # ── size reflects resource count ─────────────────────────────────────────
+
+  it "size_reflects_resource_count" do
+    m = Kube::Cluster::Manifest.new
+    m << Kube::Cluster["ConfigMap"].new { metadata.name = "a" }
+    m << Kube::Cluster["ConfigMap"].new { metadata.name = "b" }
+
+    m.size.should == 2
+  end
+
+  # ── each without block ──────────────────────────────────────────────────
+
+  it "each_without_block_returns_enumerator" do
+    m = Kube::Cluster::Manifest.new
+    m << Kube::Cluster["ConfigMap"].new { metadata.name = "test" }
+
+    Middleware::Namespace.new("production").call(m)
+
+    enum = m.each
+    enum.should.be.instance_of Enumerator
+  end
+
+  # ── Generative middleware produces new resources ─────────────────────────
+
+  it "generative_middleware_adds_service" do
+    m = Kube::Cluster::Manifest.new
+    m << Kube::Cluster["Deployment"].new {
+      metadata.name = "web"
+      metadata.namespace = "default"
+      spec.selector.matchLabels = { app: "web" }
+      spec.template.metadata.labels = { app: "web" }
+      spec.template.spec.containers = [
+        { name: "web", image: "nginx", ports: [{ name: "http", containerPort: 8080 }] },
+      ]
+    }
+
+    Middleware::ServiceForDeployment.new.call(m)
+
+    kinds = m.map { |r| r.to_h[:kind] }
+    kinds.should == %w[Deployment Service]
+  end
+
+  it "generative_middleware_does_not_affect_non_matching_resources" do
+    m = Kube::Cluster::Manifest.new
+    m << Kube::Cluster["ConfigMap"].new {
+      metadata.name = "config"
+    }
+
+    Middleware::ServiceForDeployment.new.call(m)
+
+    resources = m.to_a
+    resources.size.should == 1
+  end
+
+  # ── Generated resources flow through subsequent middleware stages ────────
+
+  it "generated_resources_flow_through_subsequent_stages" do
+    m = Kube::Cluster::Manifest.new
+    m << Kube::Cluster["Deployment"].new {
+      metadata.name = "web"
+      spec.selector.matchLabels = { app: "web" }
+      spec.template.metadata.labels = { app: "web" }
+      spec.template.spec.containers = [
+        { name: "web", image: "nginx", ports: [{ name: "http", containerPort: 8080 }] },
+      ]
+    }
+
+    stack = Middleware::Stack.new do
+      use Middleware::ServiceForDeployment           # generates Service
+      use Middleware::Namespace, "production"         # namespaces everything
+      use Middleware::Labels, managed_by: "middleware" # labels everything
+    end
+    stack.call(m)
+
+    resources = m.to_a
+    resources.size.should == 2
+  end
+
+  # ── YAML serializes integers correctly ──────────────────────────────────
+
+  it "to_yaml_serializes_integers_as_plain_values" do
+    m = Kube::Cluster::Manifest.new
+    m << Kube::Cluster["Deployment"].new {
+      metadata.name = "web"
+      spec.selector.matchLabels = { app: "web" }
+      spec.template.metadata.labels = { app: "web" }
+      spec.template.spec.containers = [
+        { name: "web", image: "nginx", ports: [{ name: "http", containerPort: 8080 }] },
+      ]
+    }
+
+    yaml = m.to_yaml
+    yaml.should.include "containerPort: 8080"
+  end
+
+  # ── Multi-generative: chained generation ────────────────────────────────
+
+  it "chained_generative_middleware" do
+    m = Kube::Cluster::Manifest.new
+    m << Kube::Cluster["Deployment"].new {
+      metadata.name = "web"
+      metadata.namespace = "default"
+      metadata.labels = {
+        "app.kubernetes.io/expose":    "app.example.com",
+        "app.kubernetes.io/autoscale": "2-10",
+      }
+      spec.selector.matchLabels = { app: "web" }
+      spec.template.metadata.labels = { app: "web" }
+      spec.template.spec.containers = [
+        { name: "web", image: "nginx", ports: [{ name: "http", containerPort: 8080 }] },
+      ]
+    }
+
+    stack = Middleware::Stack.new do
+      use Middleware::ServiceForDeployment   # Deployment → +Service
+      use Middleware::IngressForService       # Service with expose label → +Ingress
+      use Middleware::HPAForDeployment        # Deployment with autoscale label → +HPA
+    end
+    stack.call(m)
+
+    kinds = m.map { |r| r.to_h[:kind] }
+
+    m.to_a.size.should == 4
+  end
+end

data/lib/kube/cluster/middleware/annotations.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+require "bundler/setup"
+require "kube/cluster"
+
 module Kube
   module Cluster
     class Middleware
@@ -30,3 +33,61 @@ module Kube
     end
   end
 end
+
+test do
+  Middleware = Kube::Cluster::Middleware
+
+  it "adds_annotations" do
+    m = manifest(Kube::Cluster["ConfigMap"].new { metadata.name = "test" })
+
+    Middleware::Annotations.new(
+      "prometheus.io/scrape": "true",
+      "prometheus.io/port": "9090",
+    ).call(m)
+
+    annotations = m.resources.first.to_h.dig(:metadata, :annotations)
+
+    annotations[:"prometheus.io/port"].should == "9090"
+  end
+
+  it "resource_annotations_override_middleware_defaults" do
+    m = manifest(Kube::Cluster["ConfigMap"].new {
+      metadata.name = "test"
+      metadata.annotations = { "prometheus.io/port": "8080" }
+    })
+
+    Middleware::Annotations.new("prometheus.io/port": "9090").call(m)
+    annotations = m.resources.first.to_h.dig(:metadata, :annotations)
+
+    annotations[:"prometheus.io/port"].should == "8080"
+  end
+
+  it "preserves_existing_annotations" do
+    m = manifest(Kube::Cluster["ConfigMap"].new {
+      metadata.name = "test"
+      metadata.annotations = { "custom/annotation": "keep" }
+    })
+
+    Middleware::Annotations.new("prometheus.io/scrape": "true").call(m)
+    annotations = m.resources.first.to_h.dig(:metadata, :annotations)
+
+    annotations[:"prometheus.io/scrape"].should == "true"
+  end
+
+  it "converts_values_to_strings" do
+    m = manifest(Kube::Cluster["ConfigMap"].new { metadata.name = "test" })
+
+    Middleware::Annotations.new("prometheus.io/port": 9090).call(m)
+    annotations = m.resources.first.to_h.dig(:metadata, :annotations)
+
+    annotations[:"prometheus.io/port"].should == "9090"
+  end
+
+  private
+
+    def manifest(*resources)
+      m = Kube::Cluster::Manifest.new
+      resources.each { |r| m << r }
+      m
+    end
+end