capistrano-nomad 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e1d44671f9ed79b03419c3de79d4b938652eb3f35f3553450f4e5118fadeb596
-  data.tar.gz: 3a6afdc265f7f434774f960e1aa2a9c5950cd8da00c02dbf21407c752ec2bb22
+  metadata.gz: decb45a7958cc1a3b2bc96d8d48e72ff6132d160eac93e81e995b59661dfc5ff
+  data.tar.gz: adaf5bb0a848328cfd830f861b1f8ff744e46bba6eab66f9180fdd21f1bad57b
 SHA512:
-  metadata.gz: 511bf835646bbfb0f5ec7bc0fe5dd575cd34b4a72573d73457ce07830284ad01260521bbdb2cc8a829e1ad535d78cbece3d041ed32f546efbd274090934523db
-  data.tar.gz: d576b13a85867cc3916dd32a7a26ece7aecdda4b1b14bc20a451f24a7bbeb48f3aef1144d3952e9e5ad831f06c33cb609fd41390bb40d2a29e0754254c48f098
+  metadata.gz: cac6624d0caceedcd3ac833d87a3a498d0a023b74d604b626413df62f15e107324a538035d93e9a39800eba57dddca4b6a70a8bd4825fed99a002411634254a5
+  data.tar.gz: 3a622b2f506d8a3d98f5c97646fa6da662b8b6ea86e86c9e315c10a62ef4f88acd7befc7f22167f52b8de3b0d9ea9fc8dfccf5924da7da74a061f3b1ba450ea8

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    capistrano-nomad (0.3.0)
+    capistrano-nomad (0.4.0)
       activesupport (<= 7.0.8)
       byebug
       capistrano (~> 3.0)

data/capistrano-nomad.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "capistrano-nomad"
-  spec.version = "0.3.0"
+  spec.version = "0.4.0"
   spec.authors = ["James Hu"]
 
   spec.summary = "Capistrano plugin for deploying and managing Nomad jobs"

data/lib/capistrano/nomad/helpers/base.rb

@@ -1,5 +1,5 @@
 def capistrano_nomad_root
-  Pathname.new(fetch(:root) || "")
+  @capistrano_nomad_root ||= Pathname.new(fetch(:root) || "")
 end
 
 def capistrano_nomad_deep_symbolize_hash_keys(hash)

data/lib/capistrano/nomad/helpers/docker.rb

@@ -1,3 +1,19 @@
+class CapistranoNomadDockerPushImageInteractionHandler
+  def initialize(*args)
+    @last_digest = nil
+  end
+
+  def on_data(_command, stream_name, data, channel)
+    if (match = data.match(/digest: ([^\s]+)/))
+      @last_digest = match[1]
+    end
+  end
+
+  def last_digest
+    @last_digest
+  end
+end
+
 def capistrano_nomad_docker_image_types_manifest_path
   shared_path.join("docker-image-types.json")
 end
@@ -10,7 +26,7 @@ def capistrano_nomad_read_docker_image_types_manifest
     execute("mkdir -p #{shared_path}")
     execute("touch #{capistrano_nomad_docker_image_types_manifest_path}")
 
-    output = capture "cat #{capistrano_nomad_docker_image_types_manifest_path}"
+    output = capture("cat #{capistrano_nomad_docker_image_types_manifest_path}")
 
     unless output.blank?
       manifest = JSON.parse(output)
@@ -33,52 +49,23 @@ def capistrano_nomad_update_docker_image_types_manifest(image_type, properties =
   end
 end
 
-def capistrano_nomad_build_docker_image_alias(image_type, ref)
-  # Define nomad_docker_image_alias has a proc to return image alias
-  fetch(:nomad_docker_image_alias).call(image_type: image_type, ref: ref)
-end
+def capistrano_nomad_build_docker_image_alias(image_type)
+  image_alias = fetch(:nomad_docker_image_types).dig(image_type, :alias)
+  image_alias = image_alias.call(image_type: image_type) if image_alias&.is_a?(Proc)
 
-# Fetch image alias from manifest
-def current_docker_service_image_alias(image_type)
-  image_alias =
-    capistrano_nomad_read_docker_image_types_manifest
-      .try(:[], image_type.to_sym)
-      .try(:[], :image_alias)
+  raise StandardError, ":alias not defined for #{image_type}" unless image_alias
 
-  return image_alias if image_alias
+  # Add :latest if there's no tag
+  image_alias << ":latest" if image_alias.split(":").count == 1
 
-  capistrano_nomad_build_docker_image_alias(image_type, capistrano_nomad_fetch_git_commit_id)
+  image_alias
 end
 
 # Builds docker image from image type
 #
 # @param image_type [String, Symbol]
-def capistrano_nomad_build_docker_image(image_type, path, *args)
-  run_locally do
-    git_commit_id = capistrano_nomad_fetch_git_commit_id
-
-    [
-      capistrano_nomad_build_docker_image_alias(image_type, git_commit_id),
-      capistrano_nomad_build_docker_image_alias(image_type, "latest"),
-      "trunk/#{fetch(:stage)}/#{image_type}:latest",
-    ]
-      .compact
-      .each do |tag|
-        args << "--tag #{tag}"
-      end
-
-    # If any of these files exist then we're in the middle of rebase so we should interrupt
-    if ["rebase-merge", "rebase-apply"].any? { |f| File.exist?("#{capistrano_nomad_git.dir.path}/.git/#{f}") }
-      raise StandardError, "still in the middle of git rebase, interrupting docker image build"
-    end
-
-    system "docker build #{args.join(' ')} .#{capistrano_nomad_root.join(path)}"
-  end
-end
-
 def capistrano_nomad_build_docker_image_for_type(image_type)
   image_type = image_type.to_sym
-
   attributes = fetch(:nomad_docker_image_types)[image_type]
 
   return unless attributes
@@ -106,7 +93,22 @@ def capistrano_nomad_build_docker_image_for_type(image_type)
     args << "--build-arg #{key}=#{value}"
   end
 
-  capistrano_nomad_build_docker_image(image_type, attributes[:path], args)
+  run_locally do
+    # If any of these files exist then we're in the middle of rebase so we should interrupt
+    if ["rebase-merge", "rebase-apply"].any? { |f| File.exist?("#{capistrano_nomad_git.dir.path}/.git/#{f}") }
+      raise StandardError, "Still in the middle of git rebase, interrupting docker image build"
+    end
+
+    image_alias_args = args.dup
+
+    [capistrano_nomad_build_docker_image_alias(image_type)]
+      .compact
+      .each do |tag|
+        image_alias_args << "--tag #{tag}"
+      end
+
+    execute("docker build #{image_alias_args.join(' ')} .#{capistrano_nomad_root.join(attributes[:path])}")
+  end
 end
 
 def capistrano_nomad_push_docker_image_for_type(image_type, is_manifest_updated: true)
@@ -114,23 +116,22 @@ def capistrano_nomad_push_docker_image_for_type(image_type, is_manifest_updated:
   invoke("nomad:docker_images:push")
 
   run_locally do
-    git_commit_id = capistrano_nomad_fetch_git_commit_id
-    revision_image_alias = capistrano_nomad_build_docker_image_alias(image_type, git_commit_id)
-    latest_image_alias = capistrano_nomad_build_docker_image_alias(image_type, "latest")
-
-    [revision_image_alias, latest_image_alias].each do |image_alias|
-      # We should not proceed if image cannot be pushed
-      unless system("docker push #{image_alias}")
-        raise StandardError, "Docker image push unsuccessful!"
-      end
+    interaction_handler = CapistranoNomadDockerPushImageInteractionHandler.new
+    image_alias = capistrano_nomad_build_docker_image_alias(image_type)
+
+    # We should not proceed if image cannot be pushed
+    unless execute("docker push #{image_alias}", interaction_handler: interaction_handler)
+      raise StandardError, "Docker image push unsuccessful!"
     end
 
     return unless is_manifest_updated
 
     # Update image type manifest
     capistrano_nomad_update_docker_image_types_manifest(image_type,
-      ref: git_commit_id,
-      image_alias: revision_image_alias
+      alias: image_alias,
+
+      # Has the @sha256:xxxx appended so we have the ability to also target by digest
+      alias_digest: "#{image_alias}@#{interaction_handler.last_digest}",
     )
   end
 end

data/lib/capistrano/nomad/helpers/nomad.rb

@@ -1,7 +1,7 @@
 require "active_support/core_ext/string"
 require "sshkit/interactive"
 
-class NomadErbNamespace
+class CapistranoNomadErbNamespace
   def initialize(context:, vars: {})
     @context = context
 
@@ -55,7 +55,11 @@ def capistrano_nomad_build_local_path(path, *args)
   local_path = ".#{capistrano_nomad_root.join(path)}"
 
   # Determine if it has .erb appended or not
-  [local_path, "#{local_path}.erb"].find { |path| File.exist?(path) }
+  found_local_path = [local_path, "#{local_path}.erb"].find { |path| File.exist?(path) }
+
+  raise StandardError, "Could not find local path: #{path}" unless found_local_path
+
+  found_local_path
 end
 
 def capistrano_nomad_build_local_job_path(name, *args)
@@ -130,7 +134,7 @@ def capistrano_nomad_upload_file(local_path:, remote_path:, erb_vars: {})
 
   # We use a custom namespace class so that we can include helper methods into the namespace to make them available for
   # template to access
-  namespace = NomadErbNamespace.new(
+  namespace = CapistranoNomadErbNamespace.new(
     context: self,
     vars: final_erb_vars,
   )
@@ -155,7 +159,7 @@ def capistrano_nomad_fetch_jobs_names_by_namespace
 end
 
 def capistrano_nomad_fetch_jobs_docker_image_types(names, namespace: nil)
-  names.map { |n| fetch(:nomad_jobs).dig(namespace, n.to_sym, :image_types) }.flatten.compact.uniq
+  names.map { |n| fetch(:nomad_jobs).dig(namespace, n.to_sym, :docker_image_types) }.flatten.compact.uniq
 end
 
 def capistrano_nomad_build_jobs_docker_images(names, *args)

data/lib/capistrano/nomad.rb

@@ -1,4 +1,5 @@
 require "capistrano/plugin"
+require "byebug"
 require_relative "nomad/helpers/base"
 require_relative "nomad/helpers/docker"
 require_relative "nomad/helpers/dsl"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-nomad
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - James Hu
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-10-09 00:00:00.000000000 Z
+date: 2023-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -129,7 +129,6 @@ files:
 - lib/capistrano/nomad/helpers/nomad.rb
 - lib/capistrano/nomad/scm/git_local.rb
 - lib/capistrano/nomad/tasks/nomad.rake
-- sig/capistrano/nomad.rbs
 homepage: https://github.com/axsuul/capistrano-nomad
 licenses:
 - MIT

data/sig/capistrano/nomad.rbs

@@ -1,6 +0,0 @@
-module Capistrano
-  module Nomad
-    VERSION: String
-    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
-  end
-end