capistrano-dockerbuild 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7346efa239fc872e0194afb86f2e155aec196f8ef16490af28dfb16a8e1b726
-  data.tar.gz: 647ae21571209763324edb86400d78498bdbd5b5423784530cac71e01544e783
+  metadata.gz: ed984b515b7f0d43d3985d442dba5bf85c1539f3109d8360bf9864db5a549a2d
+  data.tar.gz: cbcea200c07484a17aec1edb9d6e5e99ec2548811e3bc3de34cec1f2deb993a0
 SHA512:
-  metadata.gz: 9e3b6d93525ef5baf7d376f9d893f5f0db6227bb4c8fbb04c11f7c92a126e6ec2481c1dfb7c61562004aa58f4391bca3b31f73217df843b0af062032e32514b4
-  data.tar.gz: 949edfc5295850a32f6dbef737127ba2d1e700214fb560666936b4a6e6c8f4be3f60846f7c635b394914088afb97ee93270c4bbb382287c4ac285936d2e007e5
+  metadata.gz: eb19d9ee91eb190e367a5dfe3fe75c9a695465afae9eff6d9a6f9d79c1548b4e6ede86a66f004bc4d9d23d5bbc56e70b719ca157903b59f8ca4251b4fc6342e7
+  data.tar.gz: 98752e45ab74d37285903f283efa3c8c2e167d51e8fd366c381099bc33b33b947c9a03ea018d93e90bfa91bcfbfd5a302288db93630a6700e671e7c9490f44e0

data/README.md

@@ -139,9 +139,11 @@ The temporary directory is removed automatically by `docker:clean` after `docker
 
 #### docker:clone
 - Clone repo to `#{docker_build_base_dir}` as mirror
+- Serialized with `docker:update_mirror` via a `flock` keyed by `#{docker_build_base_dir}`'s basename, since both mutate the shared repo directory (a mirror by default, or a regular checkout under `:docker_build_no_worktree`) at `#{docker_build_base_dir}`. This matters when multiple deploys (e.g. CI jobs for different branches) target the same build host concurrently — without it, concurrent `git clone`/`git remote update` on the shared directory can corrupt its `.git/config` or fail with transport errors. Keying the lock by basename keeps unrelated consumers that share the same parent directory from serializing against each other.
 
 #### docker:update_mirror
 - git remote update `#{docker_build_base_dir}`
+- Serialized with `docker:clone` via the same `flock` (see above)
 
 #### docker:build
 - Create `#{branch}` worktree to `#{docker_tag}-#{timestamp}`

data/capistrano-dockerbuild.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "capistrano-dockerbuild"
-  spec.version       = "1.1.0"
+  spec.version       = "1.2.0"
   spec.authors       = ["joker1007"]
   spec.email         = ["kakyoin.hierophant@gmail.com"]
 
@@ -22,6 +22,6 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency "capistrano", ">= 3.2"
 
-  spec.add_development_dependency "bundler", "~> 2.3"
+  spec.add_development_dependency "bundler", ">= 2.3"
   spec.add_development_dependency "rake", "~> 13.0"
 end

data/lib/capistrano/dockerbuild.rb

@@ -1,6 +1,7 @@
 require "cgi"
 require "uri"
 require "securerandom"
+require "shellwords"
 
 class Capistrano::Dockerbuild < Capistrano::Plugin
   def set_defaults
@@ -28,6 +29,16 @@ class Capistrano::Dockerbuild < Capistrano::Plugin
     Pathname(fetch(:docker_build_base_dir))
   end
 
+  # Lock serializing access to the shared repo dir at docker_build_base_path
+  # across concurrent deploys on the same build host (see README for the race).
+  #
+  # Keyed by basename, not a fixed name, so unrelated consumers sharing a parent
+  # directory don't serialize against each other.
+  def docker_build_lock_path
+    base = docker_build_base_path
+    base.dirname.join("capistrano_dockerbuild.#{base.basename}.lock").to_s
+  end
+
   def git_repo_url
     if fetch(:git_http_username) && fetch(:git_http_password)
       URI.parse(repo_url).tap do |repo_uri|

data/lib/capistrano/tasks/docker.rake

@@ -38,25 +38,20 @@ namespace :docker do
   desc "Clone the repo to docker build base directory"
   task :clone => [:'docker:check'] do
     on roles(:docker_build) do |host|
-      if fetch(:docker_build_no_worktree)
-        if test " [ -f #{dockerbuild_plugin.docker_build_base_path}/.git/HEAD ] "
-          info "The repository is at #{dockerbuild_plugin.docker_build_base_path}"
-        else
-          within dockerbuild_plugin.docker_build_base_path.dirname do
-            with dockerbuild_plugin.git_env(host) do
-              execute :git, :clone, dockerbuild_plugin.git_repo_url, dockerbuild_plugin.docker_build_base_path.to_s
-            end
-          end
-        end
-      else
-        if test " [ -f #{dockerbuild_plugin.docker_build_base_path}/HEAD ] "
-          info t(:mirror_exists, at: dockerbuild_plugin.docker_build_base_path.to_s)
-        else
-          within dockerbuild_plugin.docker_build_base_path.dirname do
-            with dockerbuild_plugin.git_env(host) do
-              execute :git, :clone, "--mirror", dockerbuild_plugin.git_repo_url, dockerbuild_plugin.docker_build_base_path.to_s
+      within dockerbuild_plugin.docker_build_base_path.dirname do
+        with dockerbuild_plugin.git_env(host) do
+          path = dockerbuild_plugin.docker_build_base_path.to_s.shellescape
+          url = dockerbuild_plugin.git_repo_url.shellescape
+          # Existence check runs inside the same flock as the clone itself, not before
+          # acquiring it — otherwise two concurrent deploys can both observe the repo
+          # missing and the second `git clone` fails once the first has created it.
+          commands =
+            if fetch(:docker_build_no_worktree)
+              "[ -f #{path}/.git/HEAD ] || git clone #{url} #{path}"
+            else
+              "[ -f #{path}/HEAD ] || git clone --mirror #{url} #{path}"
             end
-          end
+          execute :flock, dockerbuild_plugin.docker_build_lock_path.shellescape, "-c", commands.shellescape
         end
       end
     end
@@ -67,8 +62,8 @@ namespace :docker do
     on roles(:docker_build) do |host|
       within dockerbuild_plugin.docker_build_base_path do
         with dockerbuild_plugin.git_env(host) do
-          execute :git, :remote, "set-url", :origin, dockerbuild_plugin.git_repo_url
-          execute :git, :remote, :update, "--prune"
+          commands = "git remote set-url origin #{dockerbuild_plugin.git_repo_url.shellescape} && git remote update --prune"
+          execute :flock, dockerbuild_plugin.docker_build_lock_path.shellescape, "-c", commands.shellescape
         end
       end
     end
@@ -90,7 +85,7 @@ namespace :docker do
           submodule_cmd = fetch(:update_git_submodule) ? "; git submodule update --init --recursive" : ""
           commands = "sha1=$(git rev-parse #{fetch(:branch)}); git reset --hard ${sha1}#{submodule_cmd}; #{build_cmd.map {|c| c.to_s.shellescape }.join(" ")}"
           with dockerbuild_plugin.git_env(host) do
-            execute(:flock, "capistrano_dockerbuild.lock", "-c", "'#{commands}'")
+            execute(:flock, dockerbuild_plugin.docker_build_lock_path.shellescape, "-c", "'#{commands}'")
           end
         else
           timestamp = Time.now.to_i

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-dockerbuild
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - joker1007
@@ -27,14 +27,14 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.3'
 - !ruby/object:Gem::Dependency
@@ -86,7 +86,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.10
+rubygems_version: 4.0.16
 specification_version: 4
 summary: Capistrano task definition for `docker build`
 test_files: []