capistrano-nomad 0.11.1 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c21ac8313227691d585855b23b06182c72b04000c04f1b74d04825e446febb2
-  data.tar.gz: 19e9c17ef14d2342bd849f03ef4e3515d04f5c61d02ded52edd656bc08c0acd8
+  metadata.gz: d14fcb69aa16bc0815770535ac91e2eef6ef6bbbebc372b2278267912389f68d
+  data.tar.gz: 8a031005e8a27ce2ac50a6cd8f026290b4f6bd3e482b3acc6d819adfb668cc3a
 SHA512:
-  metadata.gz: ecd8ecae5c1e062469e6e308ca68fa09b913edd635c05bc5b1cb80331a7e5ec550f626168a103df2b48f1f465bd846b9054b01f245029c968fc97aa052b8186a
-  data.tar.gz: 9a58048d208327c150c81800eb0f200220494ae48a656c8bb293aaf55b1799d90a8668b09b1ab7be69c7e48c899295a0e64873e2928198ac644276f582205c78
+  metadata.gz: fc3c5fc5c9a43e97e3277e53120ffcf88f14e9436d34742fad563221d8a003e7d9a2d56c93cbd7dad8676f711f86235b6715cd259a037db320c5876bc8f62bf2
+  data.tar.gz: a21adbbb7fc30eac19788733406fbeae0840c8bfab8ece91ee69fc202a35ef200ae8c62000321a6b3562d7d56bb1c4d7408189fcc6276e1d6e7fdbb8407e2494

data/Gemfile.lock

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

data/README.md

@@ -37,7 +37,7 @@ Within `deploy.rb`
 set :nomad_jobs_path, "nomad/jobs"
 set :nomad_var_files_path, "nomad/vars"
 
-# Determines base URL to use when opening job in web UI 
+# Determines base URL to use when opening job in web UI
 set :nomad_ui_url, "http://localhost:4646"
 
 # Make variables available to all template .erb files
@@ -162,6 +162,14 @@ cap production nomad:app:stderr
 cap production nomad:analytics:grafana:follow
 ```
 
+Revert jobs
+
+```shell
+cap production nomad:app:revert
+cap production nomad:app:revert VERSION=4
+cap production nomad:app:revert DOCKER_IMAGE=v1.4.4
+```
+
 Open job in web UI
 
 ```shell

data/capistrano-nomad.gemspec

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

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

@@ -44,7 +44,7 @@ def nomad_job(name, attributes = {})
   attributes[:tags] ||= []
 
   # Tags added to namespace should be added to all jobs within
-  if (nomad_namespace_options = capistrano_nomad_fetch_namespace_options(@nomad_namespace))
+  if (nomad_namespace_options = capistrano_nomad_fetch_namespace_options(namespace: @nomad_namespace))
     attributes[:tags] += nomad_namespace_options[:tags] || []
   end
 
@@ -120,6 +120,14 @@ def nomad_job(name, attributes = {})
         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,
+          namespace: namespace,
+          docker_image: ENV["DOCKER_IMAGE"],
+        )
+      end
+
       desc "Purge #{description_name} job"
       task :purge do
         capistrano_nomad_purge_jobs([name], namespace: namespace, is_detached: false)

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

@@ -29,7 +29,9 @@ def capistrano_nomad_ensure_absolute_path(path)
   path[0] == "/" ? path : "/#{path}"
 end
 
-def capistrano_nomad_build_file_path(parent_path, basename, kind: nil, namespace: :default)
+def capistrano_nomad_build_file_path(parent_path, basename, kind: nil, **options)
+  capistrano_nomad_ensure_options!(**options)
+  namespace = options[:namespace]
   segments = [parent_path]
 
   unless namespace == :default
@@ -41,7 +43,7 @@ def capistrano_nomad_build_file_path(parent_path, basename, kind: nil, namespace
 
     # Otherwise path can be overriden of where files belonging to namespace are stored locally
     else
-      namespace_options = capistrano_nomad_fetch_namespace_options(namespace)
+      namespace_options = capistrano_nomad_fetch_namespace_options(namespace: namespace)
 
       segments << (namespace_options[:path] || namespace)
     end
@@ -132,14 +134,15 @@ def capistrano_nomad_capture_nomad_command(*args, **options)
   output
 end
 
-def capistrano_nomad_find_job_task_details(name, namespace: :default, task: nil)
+def capistrano_nomad_find_job_task_details(name, task: nil, **options)
+  capistrano_nomad_ensure_options!(**options)
   task = task.presence || name
 
   # Find alloc id that contains task that is also running
   allocs_output = capistrano_nomad_capture_nomad_command(
     :job,
     :allocs,
-    { namespace: namespace, t: "'{{range .}}{{ .ID }},{{ .ClientStatus }},{{ .TaskGroup }}|{{end}}'" },
+    options.merge(t: "'{{range .}}{{ .ID }},{{ .ClientStatus }},{{ .TaskGroup }}|{{end}}'"),
     name,
   )
   alloc_id = allocs_output
@@ -154,7 +157,7 @@ def capistrano_nomad_find_job_task_details(name, namespace: :default, task: nil)
   tasks_output = capistrano_nomad_capture_nomad_command(
     :alloc,
     :status,
-    { namespace: namespace, t: "'{{range $key, $value := .TaskStates}}{{ $key }},{{ .State }}|{{end}}'" },
+    options.merge(t: "'{{range $key, $value := .TaskStates}}{{ $key }},{{ .State }}|{{end}}'"),
     alloc_id,
   )
   tasks_by_score = tasks_output.split("|").each_with_object({}) do |task_output, hash|
@@ -174,13 +177,15 @@ def capistrano_nomad_find_job_task_details(name, namespace: :default, task: nil)
   }
 end
 
-def capistrano_nomad_exec_within_job(name, command, namespace: :default, task: nil)
+def capistrano_nomad_exec_within_job(name, command, task: nil, **options)
+  capistrano_nomad_ensure_options!(**options)
+
   capistrano_nomad_run_remotely do
-    if (task_details = capistrano_nomad_find_job_task_details(name, namespace: namespace, task: task))
+    if (task_details = capistrano_nomad_find_job_task_details(name, task: task, **options))
       capistrano_nomad_execute_nomad_command(
         :alloc,
         :exec,
-        { namespace: namespace, task: task_details[:name] },
+        options.merge(task: task_details[:name]),
         task_details[:alloc_id],
         command,
       )
@@ -189,7 +194,7 @@ def capistrano_nomad_exec_within_job(name, command, namespace: :default, task: n
       capistrano_nomad_execute_nomad_command(
         :alloc,
         :exec,
-        { namespace: namespace, job: true },
+        options.merge(job: true),
         task,
         command,
       )
@@ -246,19 +251,30 @@ def capistrano_nomad_upload(local_path:, remote_path:, erb_vars: {})
   end
 end
 
-def capistrano_nomad_fetch_namespace_options(namespace)
-  fetch(:nomad_namespaces)&.dig(namespace)
+def capistrano_nomad_ensure_options!(**options)
+  options[:namespace] ||= :default
+end
+
+def capistrano_nomad_fetch_namespace_options(**options)
+  capistrano_nomad_ensure_options!(**options)
+
+  fetch(:nomad_namespaces)&.dig(options[:namespace])
 end
 
-def capistrano_nomad_fetch_job_options(name, *args, namespace: :default)
-  fetch(:nomad_jobs).dig(namespace, name.to_sym, *args)
+def capistrano_nomad_fetch_job_options(name, *args, **options)
+  capistrano_nomad_ensure_options!(**options)
+
+  fetch(:nomad_jobs).dig(options[:namespace], name.to_sym, *args)
 end
 
 def capistrano_nomad_fetch_job_var_files(name, **options)
   capistrano_nomad_fetch_job_options(name, :var_files, **options) || []
 end
 
-def capistrano_nomad_fetch_jobs_names_by_namespace(namespace: :default)
+def capistrano_nomad_fetch_jobs_names_by_namespace(**options)
+  capistrano_nomad_ensure_options!(**options)
+  namespace = options[:namespace]
+
   # Can pass tags via command line (e.g. TAG=foo or TAGS=foo,bar)
   tags =
     [ENV["TAG"], ENV["TAGS"]].map do |tag_args|
@@ -281,8 +297,10 @@ def capistrano_nomad_fetch_jobs_names_by_namespace(namespace: :default)
   end
 end
 
-def capistrano_nomad_fetch_jobs_docker_image_types(names, namespace: :default)
-  names.map { |n| fetch(:nomad_jobs).dig(namespace, n.to_sym, :docker_image_types) }.flatten.compact.uniq
+def capistrano_nomad_fetch_jobs_docker_image_types(names, **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:)
@@ -350,6 +368,13 @@ def capistrano_nomad_define_group_tasks(namespace:)
       end
     end
 
+    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
       capistrano_nomad_fetch_jobs_names_by_namespace(namespace: nomad_namespace).each do |jobs_namespace, names|
@@ -433,24 +458,26 @@ def capistrano_nomad_plan_jobs(names, **options)
   end
 end
 
-def capistrano_nomad_run_jobs(names, namespace: :default, is_detached: true)
+def capistrano_nomad_run_jobs(names, is_detached: true, **options)
+  capistrano_nomad_ensure_options!(**options)
+
   names.each do |name|
     run_options = {
-      namespace: namespace,
+      namespace: options[:namespace],
       detach: is_detached,
 
       # Don't reset counts since they may have been scaled
       preserve_counts: true,
     }
 
-    capistrano_nomad_fetch_job_var_files(name, namespace: namespace).each do |var_file|
-      run_options[:var_file] = capistrano_nomad_build_release_var_file_path(var_file, namespace: namespace)
+    capistrano_nomad_fetch_job_var_files(name, **options).each do |var_file|
+      run_options[:var_file] = capistrano_nomad_build_release_var_file_path(var_file, **options)
     end
 
     capistrano_nomad_execute_nomad_command(
       :run,
       run_options,
-      capistrano_nomad_build_release_job_path(name, namespace: namespace),
+      capistrano_nomad_build_release_job_path(name, **options),
     )
   end
 end
@@ -494,6 +521,8 @@ def capistrano_nomad_deploy_jobs(names, **options)
 end
 
 def capistrano_nomad_restart_jobs(names, **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
     # by the command, ignores batch errors, and automatically proceeds with the remaining batches without waiting
@@ -502,27 +531,75 @@ def capistrano_nomad_restart_jobs(names, **options)
 end
 
 def capistrano_nomad_stop_jobs(names, **options)
+  capistrano_nomad_ensure_options!(**options)
+
   names.each do |name|
     capistrano_nomad_execute_nomad_command(:job, :stop, options, name)
   end
 end
 
-def capistrano_nomad_purge_jobs(names, namespace: :default, is_detached: true)
+def capistrano_nomad_purge_jobs(names, is_detached: true, **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)
+  versions_by_job_name = {}
+
   names.each do |name|
-    capistrano_nomad_execute_nomad_command(:stop, { namespace: namespace, purge: true, detach: is_detached }, 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
+      # Find job history with matching docker image
+      docker_image_job_history = history_output.find do |job_history|
+        task_images = job_history.dig("TaskGroups")
+          .map { |g| g.dig("Tasks").map { |t| t.dig("Config", "image") } }
+          .flatten
+          .compact
+
+        task_images.any? { |image| image.include?(docker_image) }
+      end
+
+      unless docker_image_job_history
+        raise ArgumentError, "No job history found for job #{name} with docker image: #{docker_image}"
+      end
+
+      docker_image_job_history.dig("Version")
+    else
+      # If no version specified then revert to previous version
+      history_output[1].dig("Version")
+    end
+  end
+
+  versions_by_job_name.each do |name, version|
+    capistrano_nomad_execute_nomad_command(:job, :revert, options, name, version)
   end
 end
 
+def capistrano_nomad_display_job_history(name, **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_execute_nomad_command(:status, options, name)
 end
 
-def capistrano_nomad_display_job_logs(name, namespace: :default, **options)
-  if (task_details = capistrano_nomad_find_job_task_details(name, namespace: namespace, task: ENV["TASK"]))
+def capistrano_nomad_display_job_logs(name, **options)
+  if (task_details = capistrano_nomad_find_job_task_details(name, **options.slice(:namespace).reverse_merge(task: ENV["TASK"])
+  ))
     capistrano_nomad_execute_nomad_command(
       :alloc,
       :logs,
-      options.merge(namespace: namespace, task: task_details[:name]),
+      options.reverse_merge(task: task_details[:name]),
       task_details[:alloc_id],
     )
   else
@@ -530,7 +607,7 @@ def capistrano_nomad_display_job_logs(name, namespace: :default, **options)
     capistrano_nomad_execute_nomad_command(
       :alloc,
       :logs,
-      options.merge(namespace: namespace, job: true),
+      options.reverse_merge(job: true),
       name,
     )
   end
@@ -540,7 +617,7 @@ def capistrano_nomad_tail_job_logs(*args, **options)
   capistrano_nomad_display_job_logs(*args, **options.merge(tail: true, n: 50))
 end
 
-def capistrano_nomad_open_job_ui(name, namespace: :default)
+def capistrano_nomad_open_job_ui(name, namespace: nil)
   run_locally do
     url = "#{fetch(:nomad_ui_url)}/ui/jobs/#{name}"
     url += "@#{namespace}" if namespace

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-nomad
 version: !ruby/object:Gem::Version
-  version: 0.11.1
+  version: 0.12.0
 platform: ruby
 authors:
 - James Hu
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-02-10 00:00:00.000000000 Z
+date: 2025-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport