capistrano-net_storage 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 84584457a37f5cd13b2380cb4d16b531ceff8c9b
-  data.tar.gz: 38816e35039013bceec5d90e583c4b6d8e9dc26e
+SHA256:
+  metadata.gz: 24781ed3a7d2676ccff180118e8c68fa4aa185d379d4ab6943f2c48d3c222b0f
+  data.tar.gz: 6e955db0ccdc03e9179d47f9c21193cb0dbb85e8172291b3d0c584de0a7b406e
 SHA512:
-  metadata.gz: 06642197adfd2a84cd19b4fc94a364283281e537f11e04e188d3ac18fd95f2ab4085b9fbf80b1e2bd7073897f316d0e77ee63e21f4386bf478c8a5f6bd4da8fb
-  data.tar.gz: e60acd1bdbd64fb0b6714cc150491427beb8a3f33d8f411eeb5ef85f1aa8cc90e7621386ef7869048f19aa6026a690c1dd3d91ee41a5eb6fa86d1c59c3b6ec64
+  metadata.gz: a9160786565510e2b34110fdda42339ab107ccea6a27b86ba064b41bd8ac69fe08a218ee702ea853acedd3d6b271689ac64d0e08853105af8b1f49b109484607
+  data.tar.gz: 37863818bb0bd9b07c37c72e0309482f67a879575d6e4d65b6dd21dfed3a839cd4a07d80e084bc1ef84ebbf0809e1c3660f2c914e2032e9131de4c7949fa5b6c

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,7 @@
+### Summary
+
+### Other Information
+
+### Checklist
+
+* [ ] By placing an "x" in the box, I hereby understand, accept and agree to be bound by the terms and conditions of the [Contribution License Agreement](https://dena.github.io/cla/).

data/.gitignore

@@ -7,6 +7,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+/vendor/
 
 # Editor Artifacts
 *.sw[pon]

data/.travis.yml

@@ -1,12 +1,13 @@
 sudo: false
 language: ruby
 rvm:
-- 2.0.0
-- 2.1.8
-- 2.2.0
-before_install: gem install bundler -v 1.14.6
-install: bundle _1.14.6_ install
-script: bundle _1.14.6_ exec rake spec
+- 2.6.3
+- 2.5.5
+- 2.4.6
+
+before_install: gem install bundler
+install: bundle install
+script: bundle exec rake spec
 notifications:
   slack:
     secure: lJCLJetpFwFujt467h250JgTyjF+7qU04Ef6FdwOBZwvjgYmyyZMBhdbL2JOAxrQd6XCWhZy56jCXr4ZdMbMLtzL+wEkQefiOLdpV/556xXK5qmkjLyRWoYOMFEhxSTqjk8hHZVYcLO6IYmwr9CHBWaVGOydADCkR4CYyqmSHtKIbznSs9Y4qrpsf6YC9QiSxoP7d5hayvnVUI8oFvxC8DfPuwrmWoO4WyVTJy2ODg/r/ZNGJCMzW3pvnXGK5oZqgwArlGIV7l3tOX2l24QilkhxhuX7QRCikYoGiIdXqkXdf1S/piaflFGXJ1C2PN5aWEv1/8EYcm7RgPm8I9Pol+7zkpUFUiSj3FDLc/TZZKP7OwPCpXOXZkDTLn0+96H5oWUR+2xwTwETQpW8Qz6ZMiu4EKAiAeU99YgSZOgc3fmonvsQREFwTV1n9AHPFsTHv8f3bzC8gUm3n7PIZX4/vR7Aa+vTVZ1QGW9T7OuWThdCMVVB7L7Q/5pRaE+gFLsN9MQBfbZ5uOOXYHd+yh9rC5qi/wRXPxQ4w1F8R+iKIhF32nUF96jwwCkd7O/LZKlmFRT43App6sfmQIAdPp7Oy/BZZD34u0k5aOciZ59h10+BHmA1E0kphXfbYcbXd53MUCEiYc4HC2xtC5yT+ko+PQ2T37VkkneZIIhjRf+WzXQ=

data/CHANGELOG.md

@@ -1,3 +1,33 @@
+## 0.4.0 (2022/05/17)
+
+Fix Bug:
+
+- Fix a cleanup issue reported at #9 (#12) @naro143
+  - Before:
+    - Archives such as `.tar.gz` and `.zip` are handled in `releases` directory of each server.
+    - Incomplete deployment leads to uncollected garbage directory under `releases`.
+  - After:
+    - Archives are handled within `#{deploy_to}/net_storage_archives` directory of each server.
+    - NetStorage cleanup `net_storage_archives` directory just as Capistrano do in `releases` directory.
+    - One successful deployment can cleanup old archives and there is no more Capistrano warnings.
+  - This includes the same cleanup policy for `local_releases_path` and `local_archives_path` of NetStorage.
+
+Changes:
+
+- Change task name `net_storage:cleanup_remote_release` to `net_storage:cleanup_archives_on_remote_storage`
+
+## 0.3.2 (2017/11/7)
+
+Fix Bug:
+
+- Use Capistrano::Configuration.env.filter (#8) @SpringMT
+
+## 0.3.1 (2017/11/6)
+
+Fix Bug:
+
+- Enable HOSTS settings when using cap deploy --hosts (#6) @SpringMT
+
 ## 0.3.0 (2017/7/14)
 
 Improve:

data/README.md

@@ -49,15 +49,21 @@ Set Capistrano variables by `set name, value`.
  `:scm`  | `nil` | Set `:net_storage` for capistrano before v3.7
  `:branch` | `master` | Target branch of SCM to release
  `:keep_releases` | `5` | Numbers to keep released versions
- `:net_storage_transport` | `nil` | Transport class for _remote storage_
  `:net_storage_archiver` | `Capistrano::NetStorage::Archiver::Zip` | Archiver class
  `:net_storage_scm` | `Capistrano::NetStorage::SCM::Git` | Internal scm class for application repository
- `:net_storage_with_bundle` | `false` | Do `bundle install` when creating archive
+ `:net_storage_transport` | `nil` | Transport class for _remote storage_
+ `:net_storage_archive_on_missing` | `true` | If `true`, create and upload archive only when target archive is missing on remote storage
  `:net_storage_config_files` | `nil` | Files to sync `config/` directory on target servers' application directory
  `:net_storage_max_parallels` | number of servers | Max concurrency for remote tasks
- `:net_storage_archive_on_missing` | `true` | If `true`, create and upload archive only when target archive is missing on remote storage
+ `:net_storage_rsync_options` | `#{ssh_options}` | SSH options for rsync command to sync configs
  `:net_storage_upload_files_by_rsync` | `false` | Use rsync(1) to deploy config files
+ `:net_storage_with_bundle` | `false` | Do `bundle install` when creating archive
  `:net_storage_local_base_path` | `.local_repo` | Base directory on deploy server
+ `:net_storage_local_mirror_path` | `#{net_storage_local_base_path}/mirror` | Path to clone repository on deploy server
+ `:net_storage_local_releases_path` | `#{net_storage_local_base_path}/releases` | Path to keep release directories on deploy server
+ `:net_storage_local_bundle_path` | `#{net_storage_local_base_path}/bundle` | Shared directory to install gems on deploy server
+ `:net_storage_local_archives_path` | `#{net_storage_local_base_path}/archives` | Archive directories on deploy server
+ `:net_storage_archives_path` | `#{deploy_to}/net_storage_archives` | Archive directories on application server
 
 ### Transport Plugins
 

data/lib/capistrano/net_storage/archiver/base.rb

@@ -16,8 +16,7 @@ module Capistrano
           raise NotImplementedError
         end
 
-        # Extract archive.
-        # Archive file should be cleaned up after extracted.
+        # Extract archive
         # @abstract
         def extract
           raise NotImplementedError

data/lib/capistrano/net_storage/archiver/tar_gzip.rb

@@ -23,10 +23,10 @@ class Capistrano::NetStorage::Archiver::TarGzip < Capistrano::NetStorage::Archiv
   def extract
     c = config
     on c.servers, in: :groups, limit: c.max_parallels do
+      execute :mkdir, '-p', c.archives_path
       execute :mkdir, '-p', release_path
       within release_path do
         execute :tar, 'xzf', c.archive_path
-        execute :rm, '-f', c.archive_path
       end
     end
   end

data/lib/capistrano/net_storage/archiver/zip.rb

@@ -23,8 +23,11 @@ class Capistrano::NetStorage::Archiver::Zip < Capistrano::NetStorage::Archiver::
   def extract
     c = config
     on c.servers, in: :groups, limit: c.max_parallels do
-      execute :unzip, c.archive_path, '-d', release_path
-      execute :rm, '-f', c.archive_path
+      execute :mkdir, '-p', c.archives_path
+      execute :mkdir, '-p', release_path
+      within release_path do
+        execute :unzip, c.archive_path
+      end
     end
   end
 end

data/lib/capistrano/net_storage/bundler.rb

@@ -48,7 +48,10 @@ module Capistrano
           end
         end
 
-        bundle_config_path = "#{c.local_base_path}/bundle_config"
+        run_locally do
+          execute :mkdir, '-p', "#{c.local_base_path}/.bundle"
+        end
+        bundle_config_path = "#{c.local_base_path}/.bundle/config"
         File.open(bundle_config_path, 'w') do |file|
           file.print(<<-EOS)
 ---
@@ -60,7 +63,7 @@ BUNDLE_BIN: "#{release_path.join('bin')}"
 EOS
         end
 
-        upload_files([bundle_config_path], dest_path: release_path.join('.bundle', 'config'))
+        upload_files([bundle_config_path], release_path.join('.bundle'))
       end
     end
   end

data/lib/capistrano/net_storage/cleaner.rb

@@ -6,22 +6,95 @@ module Capistrano
     class Cleaner
       include Capistrano::NetStorage::Utils
 
-      # Clean up local release directories and archives.
+      # Clean up old release directories on local.
       # Assumes they are under +config.local_releases_path+
       # @see Capistrano::NetStorage::Config#local_releases_path
-      def cleanup_local_release
+      def cleanup_local_releases
         c = config
         run_locally do
-          releases = capture(:ls, '-xtr', c.local_releases_path).split
-          # Contains archive files and extracted directories
-          if releases.count > fetch(:keep_releases) * 2
-            info "Keeping #{fetch(:keep_releases)} * 2 of #{releases.count} local releases"
-            olds_str = (releases - releases.last(fetch(:keep_releases) * 2)).map do |file|
-              c.local_releases_path.join(file)
-            end.join(' ')
-            execute :rm, '-rf', olds_str
+          contents = capture(:ls, '-x', c.local_releases_path).split
+          # reference
+          # https://github.com/capistrano/capistrano/blob/cc4f31fdfcb4a21c569422a95868d0bb52844c75/lib/capistrano/tasks/deploy.rake#L152
+          releases, invalid = contents.partition { |e| /^\d{14}$/ =~ e }
+
+          if invalid.any?
+            warn "Invalid contents in #{c.local_releases_path} on local:\n#{invalid.join("\n")}"
+          end
+
+          if releases.count > fetch(:keep_releases)
+            info "Keeping #{fetch(:keep_releases)} of #{releases.count} releases on local"
+            old_releases = (releases - releases.last(fetch(:keep_releases))).map do |release|
+              c.local_releases_path.join(release).to_s
+            end
+            execute :rm, '-rf', *old_releases
+          else
+            info "No old releases (keeping newest #{fetch(:keep_releases)}) in #{c.local_releases_path} on local"
+          end
+        end
+      end
+
+      # Clean up old archive files on local.
+      # Assumes they are under +config.local_archives_path+
+      # @see Capistrano::NetStorage::Config#local_archives_path
+      def cleanup_local_archives
+        c = config
+        run_locally do
+          contents = capture(:ls, '-x', c.local_archives_path).split
+          archives, invalid = contents.partition { |e| /^\d{14}\.#{Regexp.escape(c.archive_suffix)}$/ =~ e }
+
+          if invalid.any?
+            warn "Invalid contents in #{c.local_archives_path} on local:\n#{invalid.join("\n")}"
+          end
+
+          if archives.count > fetch(:keep_releases)
+            info "Keeping #{fetch(:keep_releases)} of #{archives.count} archives on local"
+            old_archives = (archives - archives.last(fetch(:keep_releases))).map do |archive|
+              c.local_archives_path.join(archive).to_s
+            end
+            execute :rm, '-f', *old_archives
+          else
+            info "No old archives (keeping newest #{fetch(:keep_releases)}) in #{c.local_archives_path} on local"
+          end
+        end
+      end
+
+      # Clean up old archive files on remote servers.
+      # Assumes they are under +config.archives_path+
+      # @see Capistrano::NetStorage::Config#archives_path
+      def cleanup_archives
+        c = config
+        on c.servers, in: :groups, limit: c.max_parallels do |host|
+          contents = capture(:ls, '-x', c.archives_path).split
+          archives, invalid = contents.partition { |e| /^\d{14}\.#{Regexp.escape(c.archive_suffix)}$/ =~ e }
+
+          if invalid.any?
+            warn "Invalid contents in #{c.archives_path} on #{host}:\n#{invalid.join("\n")}"
+          end
+
+          if archives.count > fetch(:keep_releases)
+            info "Keeping #{fetch(:keep_releases)} of #{archives.count} archives on #{host}"
+            old_archives = (archives - archives.last(fetch(:keep_releases))).map do |archive|
+              c.archives_path.join(archive).to_s
+            end
+
+            if test("[ -d #{current_path} ]")
+              current_release = capture(:readlink, current_path).to_s
+              current_release_archive = c.archives_path.join("#{File.basename(current_release)}.#{c.archive_suffix}")
+              if old_archives.include?(current_release_archive)
+                warn "Current release archive was marked for being removed but it's going to be skipped on #{host}"
+                old_archives.delete(current_release_archive)
+              end
+            else
+              debug "There is no current release present on #{host}"
+            end
+
+            if old_archives.any?
+              old_archives.each_slice(100) do |old_archives_batch|
+                execute :rm, '-f', *old_archives_batch
+              end
+            end
           else
-            info "No old local releases in #{c.local_releases_path}"
+            info "No old archives (keeping newest #{fetch(:keep_releases)}) in #{c.archives_path} on #{host}"
           end
         end
       end

data/lib/capistrano/net_storage/config.rb

@@ -53,7 +53,7 @@ module Capistrano
         @skip_bundle
       end
 
-      # If +true+, create archive ONLY when it's not found on Network Storage.
+      # If +true+, create archive ONLY when it's not found on remote storage.
       # Otherwise, create archive ALWAYS.
       # Defaults to +true+
       def archive_on_missing?
@@ -83,56 +83,63 @@ module Capistrano
       # Path settings
       #
 
-      # Path of base directory on localhost
+      # Path of base directory on local
       # @return [Pathname]
       def local_base_path
         @local_base_path ||= pathname(fetch(:net_storage_local_base_path, "#{Dir.pwd}/.local_repo"))
       end
 
-      # Path to clone repository on localhost
+      # Path to clone repository on local
       # @return [Pathname]
       def local_mirror_path
         @local_mirror_path ||= pathname(fetch(:net_storage_local_mirror_path))
         @local_mirror_path ||= local_base_path.join('mirror')
       end
 
-      # Path to keep release directories and archives on localhost
+      # Path to keep release directories on local
       # @return [Pathname]
       def local_releases_path
         @local_releases_path ||= pathname(fetch(:net_storage_local_releases_path))
         @local_releases_path ||= local_base_path.join('releases')
       end
 
-      # Path to take a snapshot of repository for release
+      # Path to take a snapshot of repository for release on local
       # @return [Pathname]
       def local_release_path
-        @local_release_path ||= pathname(fetch(:net_storage_local_release_path))
         @local_release_path ||= local_releases_path.join(release_timestamp)
       end
 
-      # Shared directory to install gems
+      # Shared directory to install gems on local
       # @return [Pathname]
       def local_bundle_path
         @local_bundle_path ||= pathname(fetch(:net_storage_local_bundle_path))
         @local_bundle_path ||= local_base_path.join('bundle')
       end
 
-      # Destination path to archive application on localhost
+      # Path of archive directories on local
+      # @return [Pathname]
+      def local_archives_path
+        @local_archives_path ||= pathname(fetch(:net_storage_local_archives_path))
+        @local_archives_path ||= local_base_path.join('archives')
+      end
+
+      # Destination path to archive application on local
       # @return [Pathname]
       def local_archive_path
-        @local_archive_path ||= pathname(fetch(:net_storage_local_archive_path))
-        @local_archive_path ||= pathname("#{local_release_path}.#{archive_suffix}")
+        @local_archive_path ||= local_archives_path.join("#{release_timestamp}.#{archive_suffix}")
       end
 
-      # Path of archive file to be downloaded on servers
+      # Path of archive directories on remote servers
+      # @return [Pathname]
+      def archives_path
+        @archives_path ||= pathname(fetch(:net_storage_archives_path))
+        @archives_path ||= deploy_path.join('net_storage_archives')
+      end
+
+      # Path of archive file to be downloaded on remote servers
       # @return [Pathname]
       def archive_path
-        @archive_path ||= pathname(fetch(:net_storage_archive_path))
-        @archive_path ||= begin
-          # Set release_timestamp if not set
-          fetch(:release_path, set_release_path)
-          pathname("#{release_path}.#{archive_suffix}")
-        end
+        @archive_path ||= archives_path.join("#{release_timestamp}.#{archive_suffix}")
       end
 
       # Suffix of archive file

data/lib/capistrano/net_storage/scm/base.rb

@@ -41,7 +41,7 @@ module Capistrano
         # Copy local config files to servers
         def sync_config
           return unless config.config_files
-          upload_files(config.config_files, dest_dir: release_path.join('config'))
+          upload_files(config.config_files, release_path.join('config'))
         end
       end
     end

data/lib/capistrano/net_storage/transport/base.rb

@@ -1,7 +1,7 @@
 module Capistrano
   module NetStorage
     module Transport
-      # Abstract class to transport archive from/to Network Storage
+      # Abstract class to transport archive from/to remote storage
       # @abstract
       class Base
         # Check prerequisites for transport

data/lib/capistrano/net_storage/utils.rb

@@ -14,27 +14,22 @@ module Capistrano
       end
 
       # @param dest_dir [String, Pathname] Destination directory on remote to copy local files into
-      # @param dest_path [String, Pathname] Destination file path on remote to copy local files to
-      # You can provide either of +dest_dir+ or +dest_path+, or files are copied to same pathes
-      def upload_files(files, dest_dir: nil, dest_path: nil)
+      def upload_files(files, dest_dir)
         c = config
-        files.each do |src|
-          basename = File.basename(src)
-          dest = dest_path || begin
-            dir = dest_dir || File.dirname(src)
-            File.join(dir, basename)
-          end
-
-          if c.upload_files_by_rsync?
-            Parallel.each(c.servers, in_threads: c.max_parallels) do |host|
-              ssh = build_ssh_command(host)
-              run_locally do
-                execute :rsync, "-az --rsh='#{ssh}' #{src} #{host}:#{dest}"
+        hosts = ::Capistrano::Configuration.env.filter(c.servers)
+        if c.upload_files_by_rsync?
+          Parallel.each(hosts, in_threads: c.max_parallels) do |host|
+            ssh = build_ssh_command(host)
+            run_locally do
+              files.each do |src|
+                execute :rsync, "-az --rsh='#{ssh}' #{src} #{host}:#{dest_dir}"
               end
             end
-          else
-            on c.servers, in: :groups, limit: c.max_parallels do
-              upload! src, dest
+          end
+        else
+          on c.servers, in: :groups, limit: c.max_parallels do
+            files.each do |src|
+              upload! src, dest_dir
             end
           end
         end

data/lib/capistrano/net_storage/version.rb

@@ -1,5 +1,5 @@
 module Capistrano
   module NetStorage
-    VERSION = '0.3.0'
+    VERSION = '0.4.0'
   end
 end

data/lib/capistrano/tasks/net_storage.rake

@@ -43,19 +43,31 @@ namespace :net_storage do
   end
   after 'net_storage:create_release', 'net_storage:sync_config'
 
-  desc 'Clean up local old archives and snapshots'
-  task :cleanup_local_release do
-    Capistrano::NetStorage.cleaner.cleanup_local_release
+  desc 'Clean up old release directories on local'
+  task :cleanup_local_releases do
+    Capistrano::NetStorage.cleaner.cleanup_local_releases
   end
-  after 'deploy:cleanup', 'net_storage:cleanup_local_release'
+  after 'deploy:cleanup', 'net_storage:cleanup_local_releases'
 
-  desc 'Clean up old archives on remote storage'
-  task :cleanup_remote_release do
+  desc 'Clean up old archive files on remote storage'
+  task :cleanup_archives_on_remote_storage do
     transport = Capistrano::NetStorage.transport
     next unless transport.respond_to?(:cleanup)
     transport.cleanup
   end
-  after 'net_storage:cleanup_local_release', 'net_storage:cleanup_remote_release'
+  after 'deploy:cleanup', 'net_storage:cleanup_archives_on_remote_storage'
+
+  desc 'Clean up old archive files on remote servers'
+  task :cleanup_archives do
+    Capistrano::NetStorage.cleaner.cleanup_archives
+  end
+  after 'deploy:cleanup', 'net_storage:cleanup_archives'
+
+  desc 'Clean up old archive files on local'
+  task :cleanup_local_archives do
+    Capistrano::NetStorage.cleaner.cleanup_local_archives
+  end
+  after 'deploy:cleanup', 'net_storage:cleanup_local_archives'
 
   task prepare_archive: %i(net_storage:scm:update net_storage:check:bundler) do
     config = Capistrano::NetStorage.config
@@ -103,6 +115,7 @@ namespace :net_storage do
         config.local_base_path,
         config.local_mirror_path,
         config.local_releases_path,
+        config.local_archives_path,
       ]
       dirs << config.local_bundle_path unless config.skip_bundle?
       run_locally do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-net_storage
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - progrhyme
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-14 00:00:00.000000000 Z
+date: 2022-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -102,6 +102,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/PULL_REQUEST_TEMPLATE.md"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -149,8 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Capistrano SCM Plugin for fast deployment via remote storage