capistrano-nomad 0.3.1 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ccaa807c999207d2220ec964a010a83cee1c562d8ed6312bc2c2ddd1330be53
-  data.tar.gz: 0bf27b5d766d966ac96e6dc1ab215257596778c870364a9a9ee029bb9b539097
+  metadata.gz: 8e086bb0968563ebe8bc50d27aeae5fbf26c91c484e6bb4ff3774e06da3d013a
+  data.tar.gz: 190a466a7334240004d6e7ed7056555ad3872a331e22b2745124fb7394e166ec
 SHA512:
-  metadata.gz: a5528920fc76334182c1f958ae56f61320b8984df5101553610150105f5e93937bbefbb8a8ffa9374e7a2405870b03533994d8d1e1ff9f6946fd5d7f742c67c3
-  data.tar.gz: 7ff7460adefcfca53e20e59b5edf3231a817ebacf63fbdb1573caf1ed981f9dcd657bcee8f0dc4199012c268b22360fcfbd07949181d05ca83890187d8e7d9ef
+  metadata.gz: 74a497827c062c431a59a9b102e4a1f6a3cb4a8c47a700c1acd2f6e6b3591c78aad734867dc649da9b0f616021949bdd9e69cc8031481086d29c7e0e9380d1b7
+  data.tar.gz: f765b3cf57ddf929bf1fb324218be5e093e9709f9bb56a3aef1c8ede338f33c5bbdcbe6c14b9a884fa046680164d9739c23c42fa2b27a843cf87f86b06e17fd6

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    capistrano-nomad (0.3.1)
+    capistrano-nomad (0.4.1)
       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.1"
+  spec.version = "0.4.1"
   spec.authors = ["James Hu"]
 
   spec.summary = "Capistrano plugin for deploying and managing Nomad jobs"

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
@@ -89,24 +76,33 @@ def capistrano_nomad_build_docker_image_for_type(image_type)
     "--platform linux/amd64",
   ]
 
-  build_args =
-    if attributes[:build_args].is_a?(Proc)
-      proc_args = attributes[:build_args].arity == 1 ? [capistrano_nomad_fetch_git_commit_id] : []
-
-      attributes[:build_args].call(*proc_args)
-    else
-      attributes[:build_args]
-    end
-
   if (target = attributes[:target])
     args << "--target #{target}"
   end
 
+  build_args = attributes[:build_args]
+  build_args = build_args.call if build_args&.is_a?(Proc)
+
   (build_args || []).each do |key, value|
     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 +110,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/git.rb

@@ -4,6 +4,6 @@ def capistrano_nomad_git
   @capistrano_nomad_git ||= Git.open(".")
 end
 
-def capistrano_nomad_fetch_git_commit_id
-  capistrano_nomad_git.log.first.sha
+def capistrano_nomad_git_commit_id
+  @capistrano_nomad_git_commit_id ||= capistrano_nomad_git.log.first.sha
 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
 
@@ -106,7 +106,7 @@ def capistrano_nomad_execute_nomad_command(*args)
 end
 
 def capistrano_nomad_exec_within_job(name, command, namespace: nil)
-  capistrano_nomad_execute_nomad_command(:alloc, :exec, { namespace: namespace, task: name, job: name }, command)
+  capistrano_nomad_execute_nomad_command(:alloc, :exec, { namespace: namespace, task: name, job: true }, name, command)
 end
 
 def capistrano_nomad_upload_file(local_path:, remote_path:, erb_vars: {})
@@ -122,7 +122,7 @@ def capistrano_nomad_upload_file(local_path:, remote_path:, erb_vars: {})
   erb = ERB.new(File.open(local_path).read, trim_mode: "-")
 
   final_erb_vars = {
-    git_commit_id: fetch(:current_revision) || capistrano_nomad_fetch_git_commit_id,
+    git_commit_id: fetch(:current_revision) || capistrano_nomad_git_commit_id,
     docker_image_types: docker_image_types,
   }
 
@@ -134,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,
   )
@@ -159,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/scm/git_local.rb

@@ -6,7 +6,7 @@ class Capistrano::SCM::GitLocal < Capistrano::SCM::Plugin
     namespace :git_local do
       task :set_current_revision do
         on release_roles :manager do
-          set :current_revision, capistrano_nomad_fetch_git_commit_id
+          set :current_revision, capistrano_nomad_git_commit_id
         end
       end
 

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.1
+  version: 0.4.1
 platform: ruby
 authors:
 - James Hu
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-10-10 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