capistrano-nomad 0.16.0 → 0.16.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 40b9b44a616fbf4c542f561845ffb785aa73b476027f78ee227953b15ab326a4
-  data.tar.gz: 9ebe475b0c6af2aee4c098536e9453fe231fcb7e9c86ce0b30e940ebc0f8d7f1
+  metadata.gz: 408063f04626ace5215b232901a72869fb5aabfe336017ce0e33aa1f1b53b02c
+  data.tar.gz: 4f3019490d7fa5042f1efe94ba7bedf1725fe3f25d391c19ae87fd45b051d79e
 SHA512:
-  metadata.gz: 0e7c48930dbc272c34c48922a2b93bb67b78d4729f2e2ca4c4602e33ed9019834d0c65b2cffaafa5bcdd450aeef335a8df95628dceb385f322b36815d96ef0f9
-  data.tar.gz: ca780918d90383b5232ff2c1c27e5d6ed65085358e475e7cf132fed07fd527f15fb6013fe732f9dc8cbdd9ebd179faacb751c73b0aa723aa0f377211169cb64a
+  metadata.gz: ae43c669814a9ba3ccd7462d4cd862b97cc79bdeefed86966fa251fbe45fa184cb8ac570b35bfd811907f1e276af4c6c6c6e3d57823c4fdea6922f891822b2c1
+  data.tar.gz: bb552095171a362745db10f63a45c3ca24ee9f7fb715d52738fa18802472798b695090a55a5d79bb5a7457dbad84d44e1b03b5112a132f7cdda1b0d1c8ca8051

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 ## [Unreleased]
 
+## [0.16.2]
+
+- Fail `upload_plan` and other plan operations when Nomad rejects a job or cannot determine the plan
+- Keep successful plans with allocation changes successful despite Nomad's exit code 1
+- Include CLI regression tests in the gem
+
+## [0.16.1]
+
+- Pass every configured variable file to `nomad plan` and `nomad run`
+
 ## [0.16.0]
 
 - Add `:redeploy` task that stops job before performing a full deploy to ensure fresh allocations

data/Gemfile

@@ -4,3 +4,5 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in capistrano-nomad.gemspec
 gemspec
+
+gem "minitest", "~> 5.0"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    capistrano-nomad (0.16.0)
+    capistrano-nomad (0.16.2)
       activesupport (<= 7.0.8)
       byebug
       capistrano (~> 3.0)
@@ -52,9 +52,11 @@ GEM
 PLATFORMS
   arm64-darwin-21
   arm64-darwin-23
+  x86_64-linux-gnu
 
 DEPENDENCIES
   capistrano-nomad!
+  minitest (~> 5.0)
 
 BUNDLED WITH
    2.4.20

data/README.md

@@ -213,7 +213,9 @@ cap production nomad:version
 
 After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+Run `bundle exec rake test` to test the generated Capistrano `upload_plan` task through the CLI. The tests use local transport and controlled Nomad exit codes. To also check rejection of invalid HCL with a real Nomad binary, run `NOMAD_REAL_BINARY=/path/to/nomad bundle exec rake test`.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version in `capistrano-nomad.gemspec`, run `bundle install`, and update `CHANGELOG.md`. Run `bundle exec rake test` and commit the release changes. Then run `bundle exec rake release`, which creates the version tag, pushes the release commit and tag, and publishes the gem to [RubyGems](https://rubygems.org).
 
 ## Contributing
 

data/Rakefile

@@ -1,4 +1,11 @@
 # frozen_string_literal: true
 
 require "bundler/gem_tasks"
-task default: %i[]
+require "rake/testtask"
+
+Rake::TestTask.new do |task|
+  task.libs << "test"
+  task.pattern = "test/**/*_test.rb"
+end
+
+task default: :test

data/capistrano-nomad.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "capistrano-nomad"
-  spec.version = "0.16.0"
+  spec.version = "0.16.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
     %x(git ls-files -z).split("\x0").reject do |f|
-      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
     end
   end
   spec.bindir = "exe"

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

@@ -138,6 +138,10 @@ def capistrano_nomad_build_release_var_file_path(name, **options)
   "#{release_path}#{capistrano_nomad_ensure_absolute_path(capistrano_nomad_build_base_var_file_path(name, **options))}"
 end
 
+def capistrano_nomad_plan_command?(args)
+  args.first.to_s == "plan" || args.take(2).map(&:to_s) == ["job", "plan"]
+end
+
 def capistrano_nomad_run_nomad_command(kind, *args)
   converted_args = args.each_with_object([]) do |arg, collection|
     # If hash then convert it as options
@@ -165,15 +169,25 @@ def capistrano_nomad_run_nomad_command(kind, *args)
   end
 
   with(env_vars) do
-    # Ignore errors
-    public_send(kind, :nomad, *converted_args, raise_on_non_zero_exit: false)
+    if capistrano_nomad_plan_command?(args)
+      # Nomad returns 1 for a successful plan with changes; all other nonzero exits are errors
+      public_send(kind, :nomad, *converted_args, '; status=$?; if [ "$status" -eq 1 ]; then exit 0; else exit "$status"; fi', raise_on_non_zero_exit: true)
+    else
+      # Ignore errors for commands other than plans
+      public_send(kind, :nomad, *converted_args, raise_on_non_zero_exit: false)
+    end
   end
 end
 
 def capistrano_nomad_execute_nomad_command(*args, **options)
   capistrano_nomad_run_remotely do |host|
-    run_interactively(host) do
+    if capistrano_nomad_plan_command?(args)
+      # Use SSHKit's checked execution because the interactive backend does not raise on failure
       capistrano_nomad_run_nomad_command(:execute, *args, **options)
+    else
+      run_interactively(host) do
+        capistrano_nomad_run_nomad_command(:execute, *args, **options)
+      end
     end
   end
 end
@@ -328,6 +342,15 @@ def capistrano_nomad_fetch_job_var_files(name, **options)
   capistrano_nomad_fetch_job_options(name, :var_files, **options) || []
 end
 
+# Build one command option per configured variable file so Nomad receives every file in order
+def capistrano_nomad_build_job_var_file_options(name, **options)
+  capistrano_nomad_fetch_job_var_files(name, **options).map do |var_file|
+    {
+      var_file: capistrano_nomad_build_release_var_file_path(var_file, **options),
+    }
+  end
+end
+
 def capistrano_nomad_fetch_jobs_names_by_namespace(**options)
   capistrano_nomad_ensure_options!(options)
   namespace = options[:namespace]
@@ -521,14 +544,19 @@ def capistrano_nomad_upload_jobs(names, **options)
   end
 end
 
+# Plan each job with every configured variable file before the uploaded job path
 def capistrano_nomad_plan_jobs(names, **options)
   names.each do |name|
-    args = [capistrano_nomad_build_release_job_path(name, **options)]
+    args = [
+      *capistrano_nomad_build_job_var_file_options(name, **options),
+      capistrano_nomad_build_release_job_path(name, **options),
+    ]
 
     capistrano_nomad_execute_nomad_command(:plan, *args)
   end
 end
 
+# Run each job with all configured variable files while preserving the existing command options
 def capistrano_nomad_run_jobs(names, is_detached: true, **options)
   capistrano_nomad_ensure_options!(options)
 
@@ -541,13 +569,10 @@ def capistrano_nomad_run_jobs(names, is_detached: true, **options)
       preserve_counts: true,
     }
 
-    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_job_var_file_options(name, **options),
       capistrano_nomad_build_release_job_path(name, **options),
     )
   end

data/test/upload_plan_test.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require "minitest/autorun"
+require "fileutils"
+require "open3"
+require "tmpdir"
+
+class UploadPlanTest < Minitest::Test
+  def test_upload_plan_succeeds_for_accepted_plans_and_fails_for_rejected_plans
+    Dir.mktmpdir("capistrano-nomad") do |root|
+      FileUtils.mkdir_p(["#{root}/config/deploy", "#{root}/nomad/jobs", "#{root}/bin"])
+      File.write("#{root}/Capfile", <<~RUBY)
+        require "capistrano/setup"
+        require "capistrano/deploy"
+        require "capistrano/nomad"
+        install_plugin Capistrano::Nomad
+      RUBY
+      File.write("#{root}/config/deploy.rb", <<~RUBY)
+        set :application, "plan-test"
+        set :deploy_to, #{"#{root}/remote".inspect}
+        set :root, #{root.inspect}
+        set :current_revision, "test"
+        set :nomad_docker_image_types, {}
+        SSHKit.config.command_map[:nomad] = #{"#{root}/bin/nomad".inspect}
+        nomad_job :example
+      RUBY
+      File.write("#{root}/config/deploy/test.rb", <<~RUBY)
+        server "localhost", roles: [:manager]
+        set :sshkit_backend, SSHKit::Backend::Local
+      RUBY
+      File.write("#{root}/bin/ssh", <<~SH)
+        #!/bin/sh
+        for argument do command="$argument"; done
+        exec /bin/sh -c "$command"
+      SH
+      FileUtils.chmod(0755, "#{root}/bin/ssh")
+      File.write("#{root}/bin/nomad", <<~SH)
+        #!/bin/sh
+        [ "$1" = plan ] || exit 99
+        cat "$2"
+        case "$NOMAD_TEST_EXIT" in
+          0|1) echo 'Scheduler dry-run: accepted';;
+          *) echo 'Error determining plan results' >&2;;
+        esac
+        exit "$NOMAD_TEST_EXIT"
+      SH
+      FileUtils.chmod(0755, "#{root}/bin/nomad")
+
+      [0, 1, 255, 2].each do |exit_code|
+        job = exit_code < 2 ? 'job "example" {}' : 'job "example" {'
+        File.write("#{root}/nomad/jobs/example.hcl", job)
+        output, status = Open3.capture2e(
+          { "NOMAD_TEST_EXIT" => exit_code.to_s, "PATH" => "#{root}/bin:#{ENV.fetch("PATH")}" },
+          "bundle", "exec", "cap", "test", "nomad:example:upload_plan",
+          chdir: root,
+        )
+
+        assert_includes(output, job, output)
+        if exit_code < 2
+          assert(status.success?, output)
+          assert_includes(output, "Scheduler dry-run: accepted")
+        else
+          refute(status.success?, output)
+          assert_includes(output, "Error determining plan results")
+        end
+      end
+
+      if ENV["NOMAD_REAL_BINARY"]
+        FileUtils.cp(ENV.fetch("NOMAD_REAL_BINARY"), "#{root}/bin/nomad")
+        output, status = Open3.capture2e("bundle", "exec", "cap", "test", "nomad:example:upload_plan", chdir: root)
+
+        refute(status.success?, output)
+        assert_includes(output, "Error parsing job file")
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-nomad
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.16.2
 platform: ruby
 authors:
 - James Hu
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-02-15 00:00:00.000000000 Z
+date: 2026-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -130,6 +130,7 @@ files:
 - lib/capistrano/nomad/helpers/nomad.rb
 - lib/capistrano/nomad/scm/git_local.rb
 - lib/capistrano/nomad/tasks/nomad.rake
+- test/upload_plan_test.rb
 homepage: https://github.com/axsuul/capistrano-nomad
 licenses:
 - MIT
@@ -152,7 +153,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.27
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: Capistrano plugin for deploying and managing Nomad jobs