capistrano-nomad 0.12.0 → 0.12.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d14fcb69aa16bc0815770535ac91e2eef6ef6bbbebc372b2278267912389f68d
-  data.tar.gz: 8a031005e8a27ce2ac50a6cd8f026290b4f6bd3e482b3acc6d819adfb668cc3a
+  metadata.gz: 9ea1dce7c57651a12a7f34dae3d0451cb964500b28c5356b12fbe552b7811f0a
+  data.tar.gz: 3f4a63bb2294ad4928faecd28f1bd0003d0f09b249ccf2649e5228918e562904
 SHA512:
-  metadata.gz: fc3c5fc5c9a43e97e3277e53120ffcf88f14e9436d34742fad563221d8a003e7d9a2d56c93cbd7dad8676f711f86235b6715cd259a037db320c5876bc8f62bf2
-  data.tar.gz: a21adbbb7fc30eac19788733406fbeae0840c8bfab8ece91ee69fc202a35ef200ae8c62000321a6b3562d7d56bb1c4d7408189fcc6276e1d6e7fdbb8407e2494
+  metadata.gz: 168ea50bf0399fa51a796362555a2a29ebe0637f2d7896c2a1f1a83b451fd5d6b35eebb29907b9f6a80c675305ffd319a8acbcab28b5ffc2002c940dc49c1d31
+  data.tar.gz: 0e7eed0ef654d2b945d9d2dd7b7089918aebaac61e3d71b9e8210a8f5038e5cf3baf938c849746da06f80dc97b32f6f0d1fc17cefa697d639221be137fef229c

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    capistrano-nomad (0.12.0)
+    capistrano-nomad (0.12.2)
       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.12.0"
+  spec.version = "0.12.2"
   spec.authors = ["James Hu"]
 
   spec.summary = "Capistrano plugin for deploying and managing Nomad jobs"
@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject do |f|
+    %x(git ls-files -z).split("\x0").reject do |f|
       (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
     end
   end
@@ -27,13 +27,13 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   # Uncomment to register a new dependency of your gem
-  spec.add_dependency "activesupport", "<= 7.0.8"
-  spec.add_dependency "byebug"
-  spec.add_dependency "capistrano", "~> 3.0"
-  spec.add_dependency "git"
-  spec.add_dependency "rake", "~> 13.0"
-  spec.add_dependency "sshkit"
-  spec.add_dependency "sshkit-interactive"
+  spec.add_dependency("activesupport", "<= 7.0.8")
+  spec.add_dependency("byebug")
+  spec.add_dependency("capistrano", "~> 3.0")
+  spec.add_dependency("git")
+  spec.add_dependency("rake", "~> 13.0")
+  spec.add_dependency("sshkit")
+  spec.add_dependency("sshkit-interactive")
 
   # For more information and examples about making a new gem, check out our
   # guide at: https://bundler.io/guides/creating_gem.html

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

@@ -59,115 +59,116 @@ def nomad_job(name, attributes = {})
     description_name << name.to_s
 
     namespace(name) do
-      desc "Build #{description_name} job Docker images"
-      task :build do
+      desc("Build #{description_name} job Docker images")
+      task(:build) do
         capistrano_nomad_build_jobs_docker_images([name], namespace: namespace)
       end
 
-      desc "Push #{description_name} job Docker images"
-      task :push do
+      desc("Push #{description_name} job Docker images")
+      task(:push) do
         capistrano_nomad_push_jobs_docker_images([name], namespace: namespace)
       end
 
-      desc "Build and push #{description_name} job Docker images"
-      task :assemble do
+      desc("Build and push #{description_name} job Docker images")
+      task(:assemble) do
         capistrano_nomad_build_jobs_docker_images([name], namespace: namespace)
         capistrano_nomad_push_jobs_docker_images([name], namespace: namespace)
       end
 
-      desc "Upload #{description_name} job and related files"
-      task :upload do
+      desc("Upload #{description_name} job and related files")
+      task(:upload) do
         capistrano_nomad_upload_jobs([name], namespace: namespace)
       end
 
-      desc "Run #{description_name} job"
-      task :run do
+      desc("Run #{description_name} job")
+      task(:run) do
         capistrano_nomad_run_jobs([name], namespace: namespace, is_detached: false)
       end
 
-      desc "Purge and run #{description_name} job again"
-      task :rerun do
+      desc("Purge and run #{description_name} job again")
+      task(:rerun) do
         capistrano_nomad_rerun_jobs([name], namespace: namespace, is_detached: false)
       end
 
-      desc "Upload and plan #{description_name} job"
-      task :upload_plan do
+      desc("Upload and plan #{description_name} job")
+      task(:upload_plan) do
         capistrano_nomad_upload_plan_jobs([name], namespace: namespace)
       end
 
-      desc "Upload and run #{description_name} job"
-      task :upload_run do
+      desc("Upload and run #{description_name} job")
+      task(:upload_run) do
         capistrano_nomad_upload_run_jobs([name], namespace: namespace, is_detached: false)
       end
 
-      desc "Upload and re-run #{description_name} job"
-      task :upload_rerun do
+      desc("Upload and re-run #{description_name} job")
+      task(:upload_rerun) do
         capistrano_nomad_upload_rerun_jobs([name], namespace: namespace, is_detached: false)
       end
 
-      desc "Deploy #{description_name} job"
-      task :deploy do
+      desc("Deploy #{description_name} job")
+      task(:deploy) do
         capistrano_nomad_deploy_jobs([name], namespace: namespace, is_detached: false)
       end
 
-      desc "Stop #{description_name} job"
-      task :stop do
+      desc("Stop #{description_name} job")
+      task(:stop) do
         capistrano_nomad_stop_jobs([name], namespace: namespace)
       end
 
-      desc "Restart #{description_name} job"
-      task :restart do
+      desc("Restart #{description_name} job")
+      task(:restart) do
         capistrano_nomad_restart_jobs([name], namespace: namespace)
       end
 
-      desc "Revert #{description_name} job. Specify version with VERSION. Specify targeting tasks with docker image with DOCKER_IMAGE. If none specified, it will revert to previous version"
-      task :revert do
-        capistrano_nomad_revert_jobs([name], ENV["VERSION"].presence,
+      desc("Revert #{description_name} job. Specify version with VERSION. Specify targeting tasks with docker image with DOCKER_IMAGE. If none specified, it will revert to previous version")
+      task(:revert) do
+        capistrano_nomad_revert_jobs([name],
           namespace: namespace,
+          version: ENV["VERSION"],
           docker_image: ENV["DOCKER_IMAGE"],
         )
       end
 
-      desc "Purge #{description_name} job"
-      task :purge do
+      desc("Purge #{description_name} job")
+      task(:purge) do
         capistrano_nomad_purge_jobs([name], namespace: namespace, is_detached: false)
       end
 
-      desc "Display status of #{description_name} job"
-      task :status do
+      desc("Display status of #{description_name} job")
+      task(:status) do
         capistrano_nomad_display_job_status(name, namespace: namespace)
       end
 
-      desc "Open console to #{description_name} job. Specify task with TASK, command with CMD"
-      task :console do
+      desc("Open console to #{description_name} job. Specify task with TASK, command with CMD")
+      task(:console) do
         command = ENV["CMD"].presence || "/bin/sh"
 
         capistrano_nomad_exec_within_job(name, command, namespace: namespace, task: ENV["TASK"])
       end
 
-      desc "Display stdout and stderr of #{description_name} job. Specify task with TASK"
-      task :logs do
+      desc("Display stdout and stderr of #{description_name} job. Specify task with TASK")
+      task(:logs) do
         capistrano_nomad_tail_job_logs(name, namespace: namespace, stdout: true)
         capistrano_nomad_tail_job_logs(name, namespace: namespace, stderr: true)
       end
 
-      desc "Display stdout of #{description_name} job. Specify task with TASK"
-      task :stdout do
+      desc("Display stdout of #{description_name} job. Specify task with TASK")
+      task(:stdout) do
         capistrano_nomad_tail_job_logs(name, namespace: namespace, stdout: true)
       end
 
-      desc "Display stderr of #{description_name} job. Specify task with TASK"
-      task :stderr do
+      desc("Display stderr of #{description_name} job. Specify task with TASK")
+      task(:stderr) do
         capistrano_nomad_tail_job_logs(name, namespace: namespace, stderr: true)
       end
 
-      desc "Follow logs of #{description_name} job. Specify task with TASK"
-      task :follow do
+      desc("Follow logs of #{description_name} job. Specify task with TASK")
+      task(:follow) do
         capistrano_nomad_display_job_logs(name, namespace: namespace, f: true)
       end
 
-      desc "Open job in web UI"
-      task :ui do
+      desc("Open job in web UI")
+      task(:ui) do
         capistrano_nomad_open_job_ui(name, namespace: namespace)
       end
     end

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

@@ -30,7 +30,7 @@ def capistrano_nomad_ensure_absolute_path(path)
 end
 
 def capistrano_nomad_build_file_path(parent_path, basename, kind: nil, **options)
-  capistrano_nomad_ensure_options!(**options)
+  capistrano_nomad_ensure_options!(options)
   namespace = options[:namespace]
   segments = [parent_path]
 
@@ -135,7 +135,7 @@ def capistrano_nomad_capture_nomad_command(*args, **options)
 end
 
 def capistrano_nomad_find_job_task_details(name, task: nil, **options)
-  capistrano_nomad_ensure_options!(**options)
+  capistrano_nomad_ensure_options!(options)
   task = task.presence || name
 
   # Find alloc id that contains task that is also running
@@ -178,7 +178,7 @@ def capistrano_nomad_find_job_task_details(name, task: nil, **options)
 end
 
 def capistrano_nomad_exec_within_job(name, command, task: nil, **options)
-  capistrano_nomad_ensure_options!(**options)
+  capistrano_nomad_ensure_options!(options)
 
   capistrano_nomad_run_remotely do
     if (task_details = capistrano_nomad_find_job_task_details(name, task: task, **options))
@@ -251,18 +251,18 @@ def capistrano_nomad_upload(local_path:, remote_path:, erb_vars: {})
   end
 end
 
-def capistrano_nomad_ensure_options!(**options)
+def capistrano_nomad_ensure_options!(options)
   options[:namespace] ||= :default
 end
 
 def capistrano_nomad_fetch_namespace_options(**options)
-  capistrano_nomad_ensure_options!(**options)
+  capistrano_nomad_ensure_options!(options)
 
   fetch(:nomad_namespaces)&.dig(options[:namespace])
 end
 
 def capistrano_nomad_fetch_job_options(name, *args, **options)
-  capistrano_nomad_ensure_options!(**options)
+  capistrano_nomad_ensure_options!(options)
 
   fetch(:nomad_jobs).dig(options[:namespace], name.to_sym, *args)
 end
@@ -272,7 +272,7 @@ def capistrano_nomad_fetch_job_var_files(name, **options)
 end
 
 def capistrano_nomad_fetch_jobs_names_by_namespace(**options)
-  capistrano_nomad_ensure_options!(**options)
+  capistrano_nomad_ensure_options!(options)
   namespace = options[:namespace]
 
   # Can pass tags via command line (e.g. TAG=foo or TAGS=foo,bar)
@@ -298,92 +298,92 @@ def capistrano_nomad_fetch_jobs_names_by_namespace(**options)
 end
 
 def capistrano_nomad_fetch_jobs_docker_image_types(names, **options)
-  capistrano_nomad_ensure_options!(**options)
+  capistrano_nomad_ensure_options!(options)
 
   names.map { |n| fetch(:nomad_jobs).dig(options[:namespace], n.to_sym, :docker_image_types) }.flatten.compact.uniq
 end
 
 def capistrano_nomad_define_group_tasks(namespace:)
   define_tasks = lambda do |nomad_namespace: nil|
-    desc "Build #{nomad_namespace} job Docker images"
-    task :build do
+    desc("Build #{nomad_namespace} job Docker images")
+    task(:build) do
       capistrano_nomad_fetch_jobs_names_by_namespace(namespace: nomad_namespace).each do |jobs_namespace, names|
         capistrano_nomad_push_jobs_docker_images(names, namespace: jobs_namespace)
       end
     end
 
-    desc "Push #{nomad_namespace} job Docker images"
-    task :push do
+    desc("Push #{nomad_namespace} job Docker images")
+    task(:push) do
       capistrano_nomad_fetch_jobs_names_by_namespace(namespace: nomad_namespace).each do |jobs_namespace, names|
         capistrano_nomad_push_jobs_docker_images(names, namespace: jobs_namespace)
       end
     end
 
-    desc "Build and push #{nomad_namespace} job Docker images"
-    task :assemble do
+    desc("Build and push #{nomad_namespace} job Docker images")
+    task(:assemble) do
       capistrano_nomad_fetch_jobs_names_by_namespace(namespace: nomad_namespace).each do |jobs_namespace, names|
         capistrano_nomad_assemble_jobs_docker_images(names, namespace: jobs_namespace)
       end
     end
 
-    desc "Upload #{nomad_namespace} jobs"
-    task :upload do
+    desc("Upload #{nomad_namespace} jobs")
+    task(:upload) do
       capistrano_nomad_fetch_jobs_names_by_namespace(namespace: nomad_namespace).each do |jobs_namespace, names|
         capistrano_nomad_upload_jobs(names, namespace: jobs_namespace)
       end
     end
 
-    desc "Run #{nomad_namespace} jobs"
-    task :run do
+    desc("Run #{nomad_namespace} jobs")
+    task(:run) do
       capistrano_nomad_fetch_jobs_names_by_namespace(namespace: nomad_namespace).each do |jobs_namespace, names|
         capistrano_nomad_run_jobs(names, namespace: jobs_namespace)
       end
     end
 
-    desc "Upload and run #{nomad_namespace} jobs"
-    task :upload_run do
+    desc("Upload and run #{nomad_namespace} jobs")
+    task(:upload_run) do
       capistrano_nomad_fetch_jobs_names_by_namespace(namespace: nomad_namespace).each do |jobs_namespace, names|
         capistrano_nomad_upload_run_jobs(names, namespace: jobs_namespace)
       end
     end
 
-    desc "Deploy #{nomad_namespace} jobs"
-    task :deploy do
+    desc("Deploy #{nomad_namespace} jobs")
+    task(:deploy) do
       capistrano_nomad_fetch_jobs_names_by_namespace(namespace: nomad_namespace).each do |jobs_namespace, names|
         capistrano_nomad_deploy_jobs(names, namespace: jobs_namespace)
       end
     end
 
-    desc "Rerun #{nomad_namespace} jobs"
-    task :rerun do
+    desc("Rerun #{nomad_namespace} jobs")
+    task(:rerun) do
       capistrano_nomad_fetch_jobs_names_by_namespace(namespace: nomad_namespace).each do |jobs_namespace, names|
         capistrano_nomad_rerun_jobs(names, namespace: jobs_namespace)
       end
     end
 
-    desc "Restart #{nomad_namespace} jobs"
-    task :restart do
+    desc("Restart #{nomad_namespace} jobs")
+    task(:restart) do
       capistrano_nomad_fetch_jobs_names_by_namespace(namespace: nomad_namespace).each do |jobs_namespace, names|
         capistrano_nomad_restart_jobs(names, namespace: jobs_namespace)
       end
     end
 
-    desc "Revert #{nomad_namespace} jobs"
-    task :revert do
+    desc("Revert #{nomad_namespace} jobs")
+    task(:revert) do
       capistrano_nomad_fetch_jobs_names_by_namespace(namespace: nomad_namespace).each do |jobs_namespace, names|
         capistrano_nomad_revert_jobs(names, namespace: jobs_namespace)
       end
     end
 
-    desc "Stop #{nomad_namespace} jobs"
-    task :stop do
+    desc("Stop #{nomad_namespace} jobs")
+    task(:stop) do
       capistrano_nomad_fetch_jobs_names_by_namespace(namespace: nomad_namespace).each do |jobs_namespace, names|
         capistrano_nomad_stop_jobs(names, namespace: jobs_namespace)
       end
     end
 
-    desc "Purge #{nomad_namespace} jobs"
-    task :purge do
+    desc("Purge #{nomad_namespace} jobs")
+    task(:purge) do
       capistrano_nomad_fetch_jobs_names_by_namespace(namespace: nomad_namespace).each do |jobs_namespace, names|
         capistrano_nomad_purge_jobs(names, namespace: jobs_namespace)
       end
@@ -459,7 +459,7 @@ def capistrano_nomad_plan_jobs(names, **options)
 end
 
 def capistrano_nomad_run_jobs(names, is_detached: true, **options)
-  capistrano_nomad_ensure_options!(**options)
+  capistrano_nomad_ensure_options!(options)
 
   names.each do |name|
     run_options = {
@@ -521,7 +521,7 @@ def capistrano_nomad_deploy_jobs(names, **options)
 end
 
 def capistrano_nomad_restart_jobs(names, **options)
-  capistrano_nomad_ensure_options!(**options)
+  capistrano_nomad_ensure_options!(options)
 
   names.each do |name|
     # Automatic yes to prompts. If set, the command automatically restarts multi-region jobs only in the region targeted
@@ -531,7 +531,7 @@ def capistrano_nomad_restart_jobs(names, **options)
 end
 
 def capistrano_nomad_stop_jobs(names, **options)
-  capistrano_nomad_ensure_options!(**options)
+  capistrano_nomad_ensure_options!(options)
 
   names.each do |name|
     capistrano_nomad_execute_nomad_command(:job, :stop, options, name)
@@ -539,22 +539,23 @@ def capistrano_nomad_stop_jobs(names, **options)
 end
 
 def capistrano_nomad_purge_jobs(names, is_detached: true, **options)
-  capistrano_nomad_ensure_options!(**options)
+  capistrano_nomad_ensure_options!(options)
 
   names.each do |name|
     capistrano_nomad_execute_nomad_command(:stop, options.reverse_merge(purge: true, detach: is_detached), name)
   end
 end
 
-def capistrano_nomad_revert_jobs(names, version, docker_image: nil, **options)
-  capistrano_nomad_ensure_options!(**options)
+def capistrano_nomad_revert_jobs(names, version: nil, docker_image: nil, **options)
+  capistrano_nomad_ensure_options!(options)
   versions_by_job_name = {}
 
   names.each do |name|
     history_output_json = capistrano_nomad_display_job_history(name, **options.reverse_merge(json: true))
     history_output = JSON.parse(history_output_json)
-
-    versions_by_job_name[name] = if docker_image
+    versions_by_job_name[name] = if version.presence
+      version
+    elsif docker_image.presence
       # Find job history with matching docker image
       docker_image_job_history = history_output.find do |job_history|
         task_images = job_history.dig("TaskGroups")
@@ -570,8 +571,8 @@ def capistrano_nomad_revert_jobs(names, version, docker_image: nil, **options)
       end
 
       docker_image_job_history.dig("Version")
+    # Revert to previous version if nothing specified
     else
-      # If no version specified then revert to previous version
       history_output[1].dig("Version")
     end
   end
@@ -582,13 +583,13 @@ def capistrano_nomad_revert_jobs(names, version, docker_image: nil, **options)
 end
 
 def capistrano_nomad_display_job_history(name, **options)
-  capistrano_nomad_ensure_options!(**options)
+  capistrano_nomad_ensure_options!(options)
 
   capistrano_nomad_capture_nomad_command(:job, :history, options, name)
 end
 
 def capistrano_nomad_display_job_status(name, **options)
-  capistrano_nomad_ensure_options!(**options)
+  capistrano_nomad_ensure_options!(options)
 
   capistrano_nomad_execute_nomad_command(:status, options, name)
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-nomad
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.12.2
 platform: ruby
 authors:
 - James Hu