kube_cluster 0.3.7 → 0.3.9

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

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+require "bundler/setup"
+require "kube/cluster"
+
 module Kube
   module Cluster
     class Middleware
@@ -109,3 +112,160 @@ module Kube
     end
   end
 end
+
+test do
+  Middleware = Kube::Cluster::Middleware
+
+  it "generates_hpa_from_deployment" do
+    m = manifest(Kube::Cluster["Deployment"].new {
+      metadata.name = "web"
+      metadata.namespace = "production"
+      metadata.labels = {
+        "app.kubernetes.io/name": "web",
+        "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" },
+      ]
+    })
+
+    Middleware::HPAForDeployment.new.call(m)
+
+    deploy, hpa = m.resources
+    hh = hpa.to_h
+    metrics = hh.dig(:spec, :metrics)
+
+    metrics[1].dig(:resource, :target, :averageUtilization).should == 80
+  end
+
+  it "custom_cpu_and_memory_targets" do
+    m = manifest(Kube::Cluster["Deployment"].new {
+      metadata.name = "web"
+      metadata.labels = { "app.kubernetes.io/autoscale": "1-3" }
+      spec.selector.matchLabels = { app: "web" }
+      spec.template.metadata.labels = { app: "web" }
+      spec.template.spec.containers = [
+        { name: "web", image: "nginx" },
+      ]
+    })
+
+    Middleware::HPAForDeployment.new(cpu: 60, memory: 70).call(m)
+    hpa = m.resources.last.to_h
+
+    hpa.dig(:spec, :metrics, 1, :resource, :target, :averageUtilization).should == 70
+  end
+
+  it "strips_autoscale_label_from_hpa" do
+    m = manifest(Kube::Cluster["Deployment"].new {
+      metadata.name = "web"
+      metadata.labels = {
+        "app.kubernetes.io/name": "web",
+        "app.kubernetes.io/autoscale": "1-5",
+      }
+      spec.selector.matchLabels = { app: "web" }
+      spec.template.metadata.labels = { app: "web" }
+      spec.template.spec.containers = [
+        { name: "web", image: "nginx" },
+      ]
+    })
+
+    Middleware::HPAForDeployment.new.call(m)
+    hpa_labels = m.resources.last.to_h.dig(:metadata, :labels)
+
+    hpa_labels[:"app.kubernetes.io/autoscale"].should.be.nil
+  end
+
+  it "skips_deployment_without_autoscale_label" do
+    m = manifest(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" },
+      ]
+    })
+
+    Middleware::HPAForDeployment.new.call(m)
+
+    m.resources.size.should == 1
+  end
+
+  it "skips_non_pod_bearing_resources" do
+    m = manifest(Kube::Cluster["ConfigMap"].new {
+      metadata.name = "config"
+      metadata.labels = { "app.kubernetes.io/autoscale": "1-5" }
+    })
+
+    Middleware::HPAForDeployment.new.call(m)
+
+    m.resources.size.should == 1
+  end
+
+  it "raises_on_invalid_range_format" do
+    m = manifest(Kube::Cluster["Deployment"].new {
+      metadata.name = "web"
+      metadata.labels = { "app.kubernetes.io/autoscale": "bad" }
+      spec.selector.matchLabels = { app: "web" }
+      spec.template.metadata.labels = { app: "web" }
+      spec.template.spec.containers = [
+        { name: "web", image: "nginx" },
+      ]
+    })
+
+    error = nil
+    begin
+      Middleware::HPAForDeployment.new.call(m)
+    rescue ArgumentError => e
+      error = e
+    end
+
+    error.message.should.include "Invalid autoscale label"
+  end
+
+  it "raises_on_invalid_range_values" do
+    m = manifest(Kube::Cluster["Deployment"].new {
+      metadata.name = "web"
+      metadata.labels = { "app.kubernetes.io/autoscale": "5-2" }
+      spec.selector.matchLabels = { app: "web" }
+      spec.template.metadata.labels = { app: "web" }
+      spec.template.spec.containers = [
+        { name: "web", image: "nginx" },
+      ]
+    })
+
+    error = nil
+    begin
+      Middleware::HPAForDeployment.new.call(m)
+    rescue ArgumentError => e
+      error = e
+    end
+
+    error.message.should.include "Invalid autoscale range"
+  end
+
+  it "works_with_statefulset" do
+    m = manifest(Kube::Cluster["StatefulSet"].new {
+      metadata.name = "db"
+      metadata.labels = { "app.kubernetes.io/autoscale": "1-3" }
+      spec.selector.matchLabels = { app: "db" }
+      spec.template.metadata.labels = { app: "db" }
+      spec.template.spec.containers = [
+        { name: "postgres", image: "postgres:16" },
+      ]
+    })
+
+    Middleware::HPAForDeployment.new.call(m)
+
+    m.resources.last.to_h.dig(:spec, :scaleTargetRef, :kind).should == "StatefulSet"
+  end
+
+  private
+
+    def manifest(*resources)
+      m = Kube::Cluster::Manifest.new
+      resources.each { |r| m << r }
+      m
+    end
+end

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

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+require "bundler/setup"
+require "kube/cluster"
+
 module Kube
   module Cluster
     class Middleware
@@ -89,3 +92,101 @@ module Kube
     end
   end
 end
+
+test do
+  Middleware = Kube::Cluster::Middleware
+
+  it "generates_ingress_from_service_with_expose_label" do
+    m = manifest(Kube::Cluster["Service"].new {
+      metadata.name = "web"
+      metadata.namespace = "production"
+      metadata.labels = { "app.kubernetes.io/expose": "app.example.com" }
+      spec.selector = { app: "web" }
+      spec.ports = [{ name: "http", port: 80, targetPort: "http" }]
+    })
+
+    Middleware::IngressForService.new.call(m)
+
+    service, ingress = m.resources
+    ih = ingress.to_h
+    rule = ih.dig(:spec, :rules, 0)
+
+    rule.dig(:http, :paths, 0, :backend, :service, :port, :name).should == "http"
+  end
+
+  it "custom_issuer_and_ingress_class" do
+    m = manifest(Kube::Cluster["Service"].new {
+      metadata.name = "web"
+      metadata.labels = { "app.kubernetes.io/expose": "app.example.com" }
+      spec.ports = [{ name: "http", port: 80 }]
+    })
+
+    Middleware::IngressForService.new(
+      issuer: "letsencrypt-staging",
+      ingress_class: "traefik",
+    ).call(m)
+
+    ingress = m.resources.last.to_h
+
+    ingress.dig(:metadata, :annotations, :"cert-manager.io/cluster-issuer").should == "letsencrypt-staging"
+  end
+
+  it "expose_true_uses_name_as_hostname" do
+    m = manifest(Kube::Cluster["Service"].new {
+      metadata.name = "api"
+      metadata.labels = { "app.kubernetes.io/expose": "true" }
+      spec.ports = [{ name: "http", port: 80 }]
+    })
+
+    Middleware::IngressForService.new.call(m)
+    ingress = m.resources.last.to_h
+
+    ingress.dig(:spec, :tls, 0, :hosts).should == ["api.local"]
+  end
+
+  it "strips_expose_label_from_ingress" do
+    m = manifest(Kube::Cluster["Service"].new {
+      metadata.name = "web"
+      metadata.labels = {
+        "app.kubernetes.io/expose": "app.example.com",
+        "app.kubernetes.io/name": "web",
+      }
+      spec.ports = [{ name: "http", port: 80 }]
+    })
+
+    Middleware::IngressForService.new.call(m)
+    ingress_labels = m.resources.last.to_h.dig(:metadata, :labels)
+
+    ingress_labels[:"app.kubernetes.io/expose"].should.be.nil
+  end
+
+  it "skips_service_without_expose_label" do
+    m = manifest(Kube::Cluster["Service"].new {
+      metadata.name = "web"
+      spec.ports = [{ name: "http", port: 80 }]
+    })
+
+    Middleware::IngressForService.new.call(m)
+
+    m.resources.size.should == 1
+  end
+
+  it "skips_non_service_resources" do
+    m = manifest(Kube::Cluster["Deployment"].new {
+      metadata.name = "web"
+      metadata.labels = { "app.kubernetes.io/expose": "app.example.com" }
+    })
+
+    Middleware::IngressForService.new.call(m)
+
+    m.resources.size.should == 1
+  end
+
+  private
+
+    def manifest(*resources)
+      m = Kube::Cluster::Manifest.new
+      resources.each { |r| m << r }
+      m
+    end
+end

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

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+require "bundler/setup"
+require "kube/cluster"
+
 module Kube
   module Cluster
     class Middleware
@@ -57,3 +60,83 @@ module Kube
     end
   end
 end
+
+test do
+  Middleware = Kube::Cluster::Middleware
+
+  it "adds_standard_labels" do
+    m = manifest(Kube::Cluster["ConfigMap"].new { metadata.name = "test" })
+
+    Middleware::Labels.new(app: "web", managed_by: "kube_cluster").call(m)
+    labels = m.resources.first.to_h.dig(:metadata, :labels)
+
+    labels[:"app.kubernetes.io/name"].should == "web"
+  end
+
+  it "maps_all_standard_keys" do
+    m = manifest(Kube::Cluster["ConfigMap"].new { metadata.name = "test" })
+
+    Middleware::Labels.new(
+      app: "web",
+      instance: "my-release",
+      version: "1.0.0",
+      component: "frontend",
+      part_of: "platform",
+      managed_by: "kube_cluster",
+    ).call(m)
+
+    labels = m.resources.first.to_h.dig(:metadata, :labels)
+
+    labels[:"app.kubernetes.io/managed-by"].should == "kube_cluster"
+  end
+
+  it "resource_labels_override_middleware_defaults" do
+    m = manifest(Kube::Cluster["ConfigMap"].new {
+      metadata.name = "test"
+      metadata.labels = { "app.kubernetes.io/name": "override" }
+    })
+
+    Middleware::Labels.new(app: "default").call(m)
+    labels = m.resources.first.to_h.dig(:metadata, :labels)
+
+    labels[:"app.kubernetes.io/name"].should == "override"
+  end
+
+  it "preserves_existing_labels" do
+    m = manifest(Kube::Cluster["ConfigMap"].new {
+      metadata.name = "test"
+      metadata.labels = { custom: "value" }
+    })
+
+    Middleware::Labels.new(app: "web").call(m)
+    labels = m.resources.first.to_h.dig(:metadata, :labels)
+
+    labels[:custom].should == "value"
+  end
+
+  it "passes_through_non_standard_keys" do
+    m = manifest(Kube::Cluster["ConfigMap"].new { metadata.name = "test" })
+
+    Middleware::Labels.new(:"team.io/name" => "platform").call(m)
+    labels = m.resources.first.to_h.dig(:metadata, :labels)
+
+    labels[:"team.io/name"].should == "platform"
+  end
+
+  it "converts_values_to_strings" do
+    m = manifest(Kube::Cluster["ConfigMap"].new { metadata.name = "test" })
+
+    Middleware::Labels.new(version: 2).call(m)
+    labels = m.resources.first.to_h.dig(:metadata, :labels)
+
+    labels[:"app.kubernetes.io/version"].should == "2"
+  end
+
+  private
+
+    def manifest(*resources)
+      m = Kube::Cluster::Manifest.new
+      resources.each { |r| m << r }
+      m
+    end
+end

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

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+require "bundler/setup"
+require "kube/cluster"
+
 module Kube
   module Cluster
     class Middleware
@@ -29,3 +32,75 @@ module Kube
     end
   end
 end
+
+test do
+  Middleware = Kube::Cluster::Middleware
+
+  it "sets_namespace_on_configmap" do
+    m = manifest(Kube::Cluster["ConfigMap"].new { metadata.name = "test" })
+
+    Middleware::Namespace.new("production").call(m)
+
+    m.resources.first.to_h.dig(:metadata, :namespace).should == "production"
+  end
+
+  it "sets_namespace_on_deployment" do
+    m = manifest(Kube::Cluster["Deployment"].new { metadata.name = "web" })
+
+    Middleware::Namespace.new("staging").call(m)
+
+    m.resources.first.to_h.dig(:metadata, :namespace).should == "staging"
+  end
+
+  it "skips_namespace_resource" do
+    m = manifest(Kube::Cluster["Namespace"].new { metadata.name = "my-ns" })
+
+    Middleware::Namespace.new("production").call(m)
+
+    m.resources.first.to_h.dig(:metadata, :namespace).should.be.nil
+  end
+
+  it "skips_cluster_role" do
+    m = manifest(Kube::Cluster["ClusterRole"].new { metadata.name = "admin" })
+
+    Middleware::Namespace.new("production").call(m)
+
+    m.resources.first.to_h.dig(:metadata, :namespace).should.be.nil
+  end
+
+  it "skips_cluster_role_binding" do
+    m = manifest(Kube::Cluster["ClusterRoleBinding"].new { metadata.name = "admin-binding" })
+
+    Middleware::Namespace.new("production").call(m)
+
+    m.resources.first.to_h.dig(:metadata, :namespace).should.be.nil
+  end
+
+  it "overwrites_existing_namespace" do
+    m = manifest(Kube::Cluster["ConfigMap"].new {
+      metadata.name = "test"
+      metadata.namespace = "old"
+    })
+
+    Middleware::Namespace.new("new").call(m)
+
+    m.resources.first.to_h.dig(:metadata, :namespace).should == "new"
+  end
+
+  it "returns_new_resource_instance" do
+    resource = Kube::Cluster["ConfigMap"].new { metadata.name = "test" }
+    m = manifest(resource)
+
+    Middleware::Namespace.new("production").call(m)
+
+    resource.equal?(m.resources.first).should.be.false
+  end
+
+  private
+
+    def manifest(*resources)
+      m = Kube::Cluster::Manifest.new
+      resources.each { |r| m << r }
+      m
+    end
+end

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

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+require "bundler/setup"
+require "kube/cluster"
+
 module Kube
   module Cluster
     class Middleware
@@ -59,3 +62,126 @@ module Kube
     end
   end
 end
+
+test do
+  Middleware = Kube::Cluster::Middleware
+
+  it "injects_soft_anti_affinity_on_deployment" do
+    m = manifest(Kube::Cluster["Deployment"].new {
+      metadata.name = "web"
+      spec.selector.matchLabels = { app: "web", instance: "prod" }
+      spec.template.metadata.labels = { app: "web" }
+      spec.template.spec.containers = [
+        { name: "web", image: "nginx:latest" },
+      ]
+    })
+
+    Middleware::PodAntiAffinity.new.call(m)
+    affinity = m.resources.first.to_h.dig(:spec, :template, :spec, :affinity)
+
+    paa = affinity.dig(:podAntiAffinity, :preferredDuringSchedulingIgnoredDuringExecution)
+    paa.size.should == 1
+  end
+
+  it "custom_topology_key" do
+    m = manifest(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:latest" },
+      ]
+    })
+
+    Middleware::PodAntiAffinity.new(
+      topology_key: "topology.kubernetes.io/zone",
+    ).call(m)
+
+    affinity = m.resources.first.to_h.dig(:spec, :template, :spec, :affinity)
+    term = affinity.dig(:podAntiAffinity, :preferredDuringSchedulingIgnoredDuringExecution, 0)
+
+    term.dig(:podAffinityTerm, :topologyKey).should == "topology.kubernetes.io/zone"
+  end
+
+  it "custom_weight" do
+    m = manifest(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:latest" },
+      ]
+    })
+
+    Middleware::PodAntiAffinity.new(weight: 100).call(m)
+    term = m.resources.first.to_h.dig(:spec, :template, :spec, :affinity,
+      :podAntiAffinity, :preferredDuringSchedulingIgnoredDuringExecution, 0)
+
+    term[:weight].should == 100
+  end
+
+  it "skips_resources_with_existing_affinity" do
+    m = manifest(Kube::Cluster["Deployment"].new {
+      metadata.name = "web"
+      spec.selector.matchLabels = { app: "web" }
+      spec.template.metadata.labels = { app: "web" }
+      spec.template.spec.affinity = { nodeAffinity: { custom: true } }
+      spec.template.spec.containers = [
+        { name: "web", image: "nginx:latest" },
+      ]
+    })
+
+    Middleware::PodAntiAffinity.new.call(m)
+    affinity = m.resources.first.to_h.dig(:spec, :template, :spec, :affinity)
+
+    affinity.should == { nodeAffinity: { custom: true } }
+  end
+
+  it "skips_non_pod_bearing_resources" do
+    resource = Kube::Cluster["ConfigMap"].new { metadata.name = "config" }
+    m = manifest(resource)
+
+    Middleware::PodAntiAffinity.new.call(m)
+
+    m.resources.first.to_h.should == resource.to_h
+  end
+
+  it "skips_resources_without_match_labels" do
+    m = manifest(Kube::Cluster["Deployment"].new {
+      metadata.name = "web"
+      spec.template.metadata.labels = { app: "web" }
+      spec.template.spec.containers = [
+        { name: "web", image: "nginx:latest" },
+      ]
+    })
+
+    Middleware::PodAntiAffinity.new.call(m)
+    affinity = m.resources.first.to_h.dig(:spec, :template, :spec, :affinity)
+
+    affinity.should.be.nil
+  end
+
+  it "applies_to_statefulset" do
+    m = manifest(Kube::Cluster["StatefulSet"].new {
+      metadata.name = "db"
+      spec.selector.matchLabels = { app: "db" }
+      spec.template.metadata.labels = { app: "db" }
+      spec.template.spec.containers = [
+        { name: "postgres", image: "postgres:16" },
+      ]
+    })
+
+    Middleware::PodAntiAffinity.new.call(m)
+    affinity = m.resources.first.to_h.dig(:spec, :template, :spec, :affinity)
+
+    affinity.dig(:podAntiAffinity).should.not.be.nil
+  end
+
+  private
+
+    def manifest(*resources)
+      m = Kube::Cluster::Manifest.new
+      resources.each { |r| m << r }
+      m
+    end
+end