capistrano-nomad 0.14.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 077546bb337f4b20a5558aedd518010f9958ce8b59a8caf67b2dc602ea046c0c
-  data.tar.gz: c45ffbfc217ef342abf933f4883ebb06fbb8f4adb6f5fe1b93883048a3fe1e2a
+  metadata.gz: 3d733a824e5d9c7403669bbf958bbd8ee0583fe9a054d45065fd1b71eec0941d
+  data.tar.gz: b5a12159f7bf4c6fa241732c21a732a60953dc548fcf2139b97f94348566a584
 SHA512:
-  metadata.gz: 0bdceb473ffecfa4e8dc10564214eea210016749d470cbb6fd11a59df0fdd5dca72a623c76f99b25f4163ab934d0796cec547d546581486a155ff487856ae001
-  data.tar.gz: 572627c25f188ef9788d2b23c2fa4bfcc66850af933c63ed6210347aa5f94ab3662f2df3d5f789a4c3c490fdc115c8d9c5d180dbb621239f2ddf448cc35142f3
+  metadata.gz: 7c97291b411d604e7308ed135548d4f3d092158b2ddec7a8675e5e4d1af29a1d66f8e7e9e181d4753dd5042d0ebf2c0ac609e9f03c4341a077b163e0b582835e
+  data.tar.gz: 6819e434bdde1b26b7c7f80d18ccdc23422f6fedb30c4b37f54657ba452b9bcc4309c34b744e9faab0e88df47a8b221e69fee9149a354a02dc956544b1a163e4

data/.opencode/commands/release.md

@@ -0,0 +1,39 @@
+---
+description: Release a new version of the gem
+agent: build
+---
+
+Release a new version of the capistrano-nomad gem.
+
+## Current State
+
+Current version: !`grep -m1 'spec.version' capistrano-nomad.gemspec | sed 's/.*"\(.*\)"/\1/'`
+
+Changes pending release:
+!`sed -n '/## \[Unreleased\]/,/## \[/p' CHANGELOG.md | head -20`
+
+## Steps to perform:
+
+1. **Ask what version to release** (unless specified via arguments: $ARGUMENTS)
+
+2. **Update the version** in `capistrano-nomad.gemspec` (line 5: `spec.version = "X.Y.Z"`)
+
+3. **Update CHANGELOG.md**:
+   - Rename `[Unreleased]` section to the new version number (e.g., `## [0.15.0]`)
+   - Add a new empty `## [Unreleased]` section at the top
+
+4. **Commit the version bump**:
+   ```shell
+   git add capistrano-nomad.gemspec CHANGELOG.md
+   git commit -m "X.Y.Z"
+   ```
+
+5. **Run the release command**:
+   ```shell
+   bundle exec rake release
+   ```
+
+   This will:
+   - Create a git tag for the version
+   - Push git commits and the created tag
+   - Push the `.gem` file to rubygems.org

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Unreleased]
 
+## [0.15.0]
+
+- Fix command escaping for console task to support complex commands with special characters using base64 encoding
+
+## [0.14.1]
+
+- Support for `IS_DETACHED` environment variable to run jobs in detached mode (e.g. `IS_DETACHED=true cap production nomad:app:deploy`)
+
 ## [0.14.0]
 
 - `nomad:deploy` properly deploys all jobs across all namespaces now

data/Gemfile.lock

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

data/README.md

@@ -174,6 +174,14 @@ cap production nomad:app:revert VERSION=4
 cap production nomad:app:revert DOCKER_IMAGE=v1.4.4
 ```
 
+Run jobs in detached mode (fire and forget)
+
+```shell
+IS_DETACHED=true cap production nomad:app:deploy
+IS_DETACHED=true cap production nomad:app:run
+IS_DETACHED=true cap production nomad:analytics:grafana:upload_run
+```
+
 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.14.0"
+  spec.version = "0.15.0"
   spec.authors = ["James Hu"]
 
   spec.summary = "Capistrano plugin for deploying and managing Nomad jobs"

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

@@ -9,3 +9,7 @@ end
 def capistrano_nomad_run_remotely(&block)
   on(roles(:manager), &block)
 end
+
+def capistrano_nomad_job_detached_overridden?
+  ENV["IS_DETACHED"]&.downcase == "true"
+end

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

@@ -88,12 +88,12 @@ def nomad_job(name, attributes = {})
 
       desc("Run #{description_name} job")
       task(:run) do
-        capistrano_nomad_run_jobs([name], namespace: namespace, is_detached: false)
+        capistrano_nomad_run_jobs([name], namespace: namespace, is_detached: capistrano_nomad_job_detached_overridden?)
       end
 
       desc("Purge and run #{description_name} job again")
       task(:rerun) do
-        capistrano_nomad_rerun_jobs([name], namespace: namespace, is_detached: false)
+        capistrano_nomad_rerun_jobs([name], namespace: namespace, is_detached: capistrano_nomad_job_detached_overridden?)
       end
 
       desc("Upload and plan #{description_name} job")
@@ -103,17 +103,17 @@ def nomad_job(name, attributes = {})
 
       desc("Upload and run #{description_name} job")
       task(:upload_run) do
-        capistrano_nomad_upload_run_jobs([name], namespace: namespace, is_detached: false)
+        capistrano_nomad_upload_run_jobs([name], namespace: namespace, is_detached: capistrano_nomad_job_detached_overridden?)
       end
 
       desc("Upload and re-run #{description_name} job")
       task(:upload_rerun) do
-        capistrano_nomad_upload_rerun_jobs([name], namespace: namespace, is_detached: false)
+        capistrano_nomad_upload_rerun_jobs([name], namespace: namespace, is_detached: capistrano_nomad_job_detached_overridden?)
       end
 
       desc("Deploy #{description_name} job")
       task(:deploy) do
-        capistrano_nomad_deploy_jobs([name], namespace: namespace, is_detached: false)
+        capistrano_nomad_deploy_jobs([name], namespace: namespace, is_detached: capistrano_nomad_job_detached_overridden?)
       end
 
       desc("Start #{description_name} job")
@@ -142,7 +142,7 @@ def nomad_job(name, attributes = {})
 
       desc("Purge #{description_name} job")
       task(:purge) do
-        capistrano_nomad_purge_jobs([name], namespace: namespace, is_detached: false)
+        capistrano_nomad_purge_jobs([name], namespace: namespace, is_detached: capistrano_nomad_job_detached_overridden?)
       end
 
       desc("Display status of #{description_name} job")

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

@@ -1,4 +1,5 @@
 require "active_support/core_ext/string"
+require "base64"
 require "sshkit/interactive"
 
 class CapistranoNomadErbNamespace
@@ -29,6 +30,48 @@ def capistrano_nomad_ensure_absolute_path(path)
   path[0] == "/" ? path : "/#{path}"
 end
 
+# Escapes a command string for use with sshkit-interactive.
+#
+# sshkit-interactive wraps commands in '$SHELL -l -c "..."' and naively
+# replaces all single quotes with \". This breaks commands that have
+# content inside single quotes (e.g., bin/rails runner 'puts "hello"').
+#
+# This function pre-processes the command to handle single-quoted sections
+# properly by:
+# 1. Converting single quotes to escaped double quotes (\")
+# 2. Escaping content inside those sections for double-quote context
+#    (backslashes become \\, double quotes become \\\")
+#
+# After this transformation, sshkit-interactive's gsub("'", '\\"') becomes
+# a no-op since there are no single quotes left.
+def capistrano_nomad_escape_command(command)
+  # Process single-quoted sections: 'content' -> \"escaped_content\"
+  command.gsub(/'([^']*)'/) do |_match|
+    content = Regexp.last_match(1)
+
+    # Escape for double-quote shell context:
+    # - Backslashes need to be doubled (\ -> \\)
+    # - Double quotes need to become \\\" to survive shell parsing
+    escaped_content = content
+      .gsub("\\", "\\\\\\\\")
+      .gsub('"', '\\\\\\\\\\\"')
+
+    '\"' + escaped_content + '\"'
+  end
+end
+
+# Escapes a command string for use with sshkit-interactive by base64 encoding.
+#
+# sshkit-interactive wraps commands in '$SHELL -l -c "..."' and naively
+# replaces all single quotes with \". Base64 avoids all quoting issues by
+# decoding the command inside the Nomad task and executing it with /bin/sh.
+def capistrano_nomad_escape_command(command)
+  encoded_command = Base64.strict_encode64(command)
+  decoded_command = "printf\\ %s\\ #{encoded_command}\\ \\|\\ base64\\ -d\\ \\|\\ /bin/sh"
+
+  "/bin/sh -lc #{decoded_command}"
+end
+
 def capistrano_nomad_build_file_path(parent_path, basename, kind: nil, **options)
   capistrano_nomad_ensure_options!(options)
   namespace = options[:namespace]
@@ -189,6 +232,9 @@ end
 def capistrano_nomad_exec_within_job(name, command, task: nil, **options)
   capistrano_nomad_ensure_options!(options)
 
+  # Escape command for SSH transport via sshkit-interactive
+  escaped_command = capistrano_nomad_escape_command(command)
+
   capistrano_nomad_run_remotely do
     if (task_details = capistrano_nomad_find_job_task_details(name, task: task, **options))
       capistrano_nomad_execute_nomad_command(
@@ -196,7 +242,7 @@ def capistrano_nomad_exec_within_job(name, command, task: nil, **options)
         :exec,
         options.merge(task: task_details[:name]),
         task_details[:alloc_id],
-        command,
+        escaped_command,
       )
     else
       # If alloc can't be determined then choose at random
@@ -205,7 +251,7 @@ def capistrano_nomad_exec_within_job(name, command, task: nil, **options)
         :exec,
         options.merge(job: true),
         task,
-        command,
+        escaped_command,
       )
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-nomad
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.15.0
 platform: ruby
 authors:
 - James Hu
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-10-06 00:00:00.000000000 Z
+date: 2026-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -114,6 +114,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".opencode/commands/release.md"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock