capistrano-nomad 0.14.1 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f23cd98ffcf93c05fd2dc4b20a9acff9865d2904fd105e015d2e3565b7a18957
-  data.tar.gz: 0f4f57b9f66a0477fcbd9f92cbf3f43e5abdfb331e7a629c8f683e4ff5772e4c
+  metadata.gz: 3d733a824e5d9c7403669bbf958bbd8ee0583fe9a054d45065fd1b71eec0941d
+  data.tar.gz: b5a12159f7bf4c6fa241732c21a732a60953dc548fcf2139b97f94348566a584
 SHA512:
-  metadata.gz: 98cd1097efdf727564e167a52da40754fe344661d5d6707841d1efa109047a333f31c99e2adbf6a71639b59b5d461701ca314fb8e72dd6ad778c756481f06a5e
-  data.tar.gz: 8de1096141ae90c3c83a5a2d3bb267a8b8785f2f51fff979671ccbff8a05ba4981f618e42c8f3b6aec6f54c996398de361efe9a0bd41fd65f44396c3339550c5
+  metadata.gz: 7c97291b411d604e7308ed135548d4f3d092158b2ddec7a8675e5e4d1af29a1d66f8e7e9e181d4753dd5042d0ebf2c0ac609e9f03c4341a077b163e0b582835e
+  data.tar.gz: 6819e434bdde1b26b7c7f80d18ccdc23422f6fedb30c4b37f54657ba452b9bcc4309c34b744e9faab0e88df47a8b221e69fee9149a354a02dc956544b1a163e4

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [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`)

data/Gemfile.lock

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

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.1
+  version: 0.15.0
 platform: ruby
 authors:
 - James Hu
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-01-29 00:00:00.000000000 Z
+date: 2026-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport