feat(templates): add volume snapshot and content

Adds templates for volume snapshots and volume snapshot contents.

Author: jgnagy

lib/metatron.rb

@@ -47,6 +47,8 @@ class ConfigError < Error; end
 require "metatron/templates/service"
 require "metatron/templates/service_account"
 require "metatron/templates/stateful_set"
+require "metatron/templates/volume_snapshot"
+require "metatron/templates/volume_snapshot_content"
 require "metatron/controller"
 require "metatron/composite_controller"
 require "metatron/controllers/ping"

lib/metatron/templates/volume_snapshot.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Metatron
+  module Templates
+    # The VolumeSnapshot Kubernetes resource
+    class VolumeSnapshot < Template
+      include Concerns::Annotated
+      include Concerns::Namespaced
+
+      attr_accessor :source, :volume_snapshot_class_name
+
+      alias volumeSnapshotClassName volume_snapshot_class_name
+
+      def initialize(name, source: {}, volume_snapshot_class_name: nil)
+        super(name)
+        @source = source
+        @volume_snapshot_class_name = volume_snapshot_class_name
+        @api_version = "snapshot.storage.k8s.io/v1"
+      end
+
+      def render
+        {
+          apiVersion:,
+          kind:,
+          metadata: {
+            name:,
+            labels: base_labels.merge(additional_labels)
+          }.merge(formatted_annotations).merge(formatted_namespace).compact,
+          spec: {}.merge(formatted_source).merge(formatted_volume_snapshot_class_name).compact
+        }.compact
+      end
+
+      def formatted_source
+        case source
+        when Hash
+          { source: }
+        when Metatron::Templates::VolumeSnapshotContent
+          { source: { volumeSnapshotContentName: source.name } }
+        when Metatron::Templates::PersistentVolumeClaim
+          { source: { persistentVolumeClaimName: source.name } }
+        when nil
+          {}
+        else
+          raise ArgumentError,
+                "Invalid source type: #{source.class}. " \
+                "Expected Hash, VolumeSnapshotContent, or PersistentVolumeClaim."
+        end
+      end
+
+      def formatted_volume_snapshot_class_name
+        return {} unless volume_snapshot_class_name
+
+        if volume_snapshot_class_name.is_a?(String)
+          { volumeSnapshotClassName: }
+        elsif volume_snapshot_class_name.respond_to?(:name)
+          { volumeSnapshotClassName: volume_snapshot_class_name.name }
+        else
+          raise ArgumentError,
+                "Invalid volume_snapshot_class_name type: #{volume_snapshot_class_name.class}."
+        end
+      end
+    end
+  end
+end

lib/metatron/templates/volume_snapshot_content.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Metatron
+  module Templates
+    # The VolumeSnapshotContent Kubernetes resource
+    class VolumeSnapshotContent < Template
+      include Concerns::Annotated
+      include Concerns::Namespaced
+
+      attr_accessor :source, :deletion_policy, :driver, :source_volume_mode, :volume_snapshot_ref
+
+      alias deletionPolicy deletion_policy
+      alias sourceVolumeMode source_volume_mode
+      alias volumeSnapshotRef volume_snapshot_ref
+
+      def initialize(name, driver:, source: {}, deletion_policy: "Delete",
+                     volume_snapshot_ref: nil, source_volume_mode: "Filesystem")
+        super(name)
+        @api_version = "snapshot.storage.k8s.io/v1"
+        @driver = driver
+        @source = source
+        @source_volume_mode = source_volume_mode
+        @deletion_policy = deletion_policy
+        @volume_snapshot_ref = volume_snapshot_ref
+      end
+
+      def render
+        {
+          apiVersion:,
+          kind:,
+          metadata: {
+            name:,
+            labels: base_labels.merge(additional_labels)
+          }.merge(formatted_annotations).merge(formatted_namespace).compact,
+          spec: {
+            driver:,
+            deletionPolicy:,
+            sourceVolumeMode:
+          }.merge(formatted_source).merge(formatted_volume_snapshot_ref).compact
+        }.compact
+      end
+
+      def formatted_source
+        return {} unless source
+        raise ArgumentError, "Invalid source type: #{source.class}." unless source.is_a?(Hash)
+
+        { source: }
+      end
+
+      def formatted_volume_snapshot_ref
+        return {} unless volume_snapshot_ref
+
+        if volume_snapshot_ref.is_a?(Hash)
+          { volumeSnapshotRef: }
+        elsif volume_snapshot_ref.is_a?(VolumeSnapshot)
+          {
+            volumeSnapshotRef: {
+              name: volume_snapshot_ref.name,
+              namespace: volume_snapshot_ref.namespace
+            }.compact
+          }
+        else
+          raise ArgumentError,
+                "Invalid volume_snapshot_ref type: #{volume_snapshot_ref.class}."
+        end
+      end
+    end
+  end
+end

spec/metatron/templates/volume_snapshot_content_spec.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+RSpec.describe Metatron::Templates::VolumeSnapshotContent do
+  describe "for simple volume snapshot contents" do
+    let(:volume_snapshot_content) do
+      described_class.new(
+        "new-snapshot-content-test",
+        source: { snapshotHandle: "7bdd0de3-aaeb-11e8-9aae-0242ac110002" },
+        driver: "hostpath.csi.k8s.io",
+        volume_snapshot_ref: {
+          name: "new-snapshot-test",
+          namespace: "foo"
+        }
+      )
+    end
+
+    let(:rendered_volume_snapshot_content) do
+      {
+        apiVersion: "snapshot.storage.k8s.io/v1",
+        kind: "VolumeSnapshotContent",
+        metadata: {
+          name: "new-snapshot-content-test",
+          labels: { "metatron.therubyist.org/name": "new-snapshot-content-test" }
+        },
+        spec: {
+          deletionPolicy: "Delete",
+          driver: "hostpath.csi.k8s.io",
+          source: {
+            snapshotHandle: "7bdd0de3-aaeb-11e8-9aae-0242ac110002"
+          },
+          sourceVolumeMode: "Filesystem",
+          volumeSnapshotRef: {
+            name: "new-snapshot-test",
+            namespace: "foo"
+          }
+        }
+      }
+    end
+
+    it "produces a hash" do
+      expect(volume_snapshot_content.render).to be_a(Hash)
+    end
+
+    it "renders properly" do
+      expect(volume_snapshot_content.render).to eq(rendered_volume_snapshot_content)
+    end
+  end
+
+  describe "for volume snapshot contents provided a volume snapshot" do
+    let(:volume_snapshot) do
+      snapshot = Metatron::Templates::VolumeSnapshot.new(
+        "new-snapshot-test",
+        source: { persistentVolumeClaimName: "hello" },
+        volume_snapshot_class_name: "testClass"
+      )
+      snapshot.namespace = "foo"
+      snapshot
+    end
+
+    let(:volume_snapshot_content) do
+      described_class.new(
+        "new-snapshot-content-test",
+        source: { snapshotHandle: "7bdd0de3-aaeb-11e8-9aae-0242ac110003" },
+        driver: "hostpath.csi.k8s.io",
+        volume_snapshot_ref: volume_snapshot
+      )
+    end
+
+    let(:rendered_volume_snapshot_content) do
+      {
+        apiVersion: "snapshot.storage.k8s.io/v1",
+        kind: "VolumeSnapshotContent",
+        metadata: {
+          name: "new-snapshot-content-test",
+          labels: { "metatron.therubyist.org/name": "new-snapshot-content-test" }
+        },
+        spec: {
+          deletionPolicy: "Delete",
+          driver: "hostpath.csi.k8s.io",
+          source: {
+            snapshotHandle: "7bdd0de3-aaeb-11e8-9aae-0242ac110003"
+          },
+          sourceVolumeMode: "Filesystem",
+          volumeSnapshotRef: {
+            name: "new-snapshot-test",
+            namespace: "foo"
+          }
+        }
+      }
+    end
+
+    it "produces a hash" do
+      expect(volume_snapshot_content.render).to be_a(Hash)
+    end
+
+    it "renders properly" do
+      expect(volume_snapshot_content.render).to eq(rendered_volume_snapshot_content)
+    end
+  end
+end

spec/metatron/templates/volume_snapshot_spec.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+RSpec.describe Metatron::Templates::VolumeSnapshot do
+  describe "for simple volume snapshots" do
+    let(:volume_snapshot) do
+      described_class.new("hello", source: { persistentVolumeClaimName: "hello" })
+    end
+
+    let(:rendered_volume_snapshot) do
+      {
+        apiVersion: "snapshot.storage.k8s.io/v1",
+        kind: "VolumeSnapshot",
+        metadata: { labels: { "metatron.therubyist.org/name": "hello" }, name: "hello" },
+        spec: {
+          source: {
+            persistentVolumeClaimName: "hello"
+          }
+        }
+      }
+    end
+
+    it "produces a hash" do
+      expect(volume_snapshot.render).to be_a(Hash)
+    end
+
+    it "renders properly" do
+      expect(volume_snapshot.render).to eq(rendered_volume_snapshot)
+    end
+  end
+
+  describe "for volume snapshots from a persistent volume claim" do
+    let(:volume_snapshot) do
+      described_class.new(
+        "hello",
+        source: Metatron::Templates::PersistentVolumeClaim.new(
+          "hello",
+          storage_class: "test",
+          storage: "1Gi"
+        ),
+        volume_snapshot_class_name: "testClass"
+      )
+    end
+
+    let(:rendered_volume_snapshot) do
+      {
+        apiVersion: "snapshot.storage.k8s.io/v1",
+        kind: "VolumeSnapshot",
+        metadata: { labels: { "metatron.therubyist.org/name": "hello" }, name: "hello" },
+        spec: {
+          source: {
+            persistentVolumeClaimName: "hello"
+          },
+          volumeSnapshotClassName: "testClass"
+        }
+      }
+    end
+
+    it "produces a hash" do
+      expect(volume_snapshot.render).to be_a(Hash)
+    end
+
+    it "renders properly" do
+      expect(volume_snapshot.render).to eq(rendered_volume_snapshot)
+    end
+  end
+end