capistrano-archive 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 96b7849b39d712939f1ae0f6ceddb6387b8fcc22632d1f25631acbc151baae17
+  data.tar.gz: 4f6b81d6b51c2f3d1b71194b53f96a513698d472abd602e3291ebbb1d2461af4
+SHA512:
+  metadata.gz: 3a1f0c749f8ec2f67d9789c926e2920a1d4b46254436d92acf7b5a9a20b6c9ee9ae0833250e9d61dff7bd94dbd401f8153b505d70387ee4008b0935f72e33ee1
+  data.tar.gz: 7219e2a539144cc24ad648fdf81153a72392d5ae4e4e7824cacdf79bce0db1357119e990885f5aa0a702327443515a71ea867c9aa115369832eec63dc3447c2c

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+# ChangeLog
+
+All notable changes to this project will be documented in this file.
+
+## [1.0.0] - To be released
+
+### Added
+- First stable release

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in capistrano-bundler.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 PrestaConcept
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,118 @@
+# capistrano-archive
+
+This plugin adds a new scm to Capistrano 3 allowing deployment from an archive stored on the target server (s).
+
+## Features
+
+ * Upload an archive (tar.bz2 as default) to target
+ * Create release from the archive
+ * Can use a file from the archive to know the deployed revision (./REVISION as default) 
+ * Workflow between deploy stages copying the local archive on stage directory 
+
+## Installation
+
+Put this in the Gemfile
+```
+    gem 'capistrano-archive'
+```
+
+Then run 
+```    
+    bundle install
+```
+
+Add theses lines to your Capfile
+
+```ruby
+# Include and use capistrano archive 
+require "capistrano/archive"
+install_plugin Capistrano::Archive::SCM
+```
+
+## Usage
+
+First, you need to have a build system storing artefact release on the server used to deploy.
+
+### Archive location and name
+
+To specify the archive location, you can set the `:archive_release_path` variable. As default, the archive is supposed to be stored in the current directory.
+
+The archive name is built as `:application_:branch` but you can change that with the `:archive_name` variable.  
+
+### Compression
+
+The tar is compressed with bzip as default but you can change that with `:archive_extension` and `:archive_tar_options` variables.
+
+### Upload
+
+As default the archive is sent in the `:tmp_dir` but you can change the destination using the `:archive_remote_path` variable. 
+
+### Workflow
+
+If you want have workflow between stage, like force deploy on staging before production, you can set the  `:archive_workflow_previous` variable in your stages config file.
+
+For example, in a *staging.rb* file, set the variable like that
+
+```ruby 
+  set :archive_workflow_previous, "build"  
+```
+
+And the archive location will be `:archive_releases_path`/build when you deploy the staging stage.
+After the deploy, the archive file will be copied in the `:archive_workflow_next`, as default the current stage.
+
+Do the same in a *production.rb* file
+
+```ruby 
+  set :archive_workflow_previous, "staging"
+```
+
+And the archive location will be `:archive_releases_path`/staging when you deploy the production stage. 
+So you'll have to deploy on staging before production. 
+
+If you want turn off the workflow process, set the variable `:archive_workflow` to false.
+
+### Revision
+
+Capistrano log the revision info, the sha1 commit, in the revisions log file and in the file REVISION.
+Since we are deploying from an archive, if we want to have the same info, it must already be present in the archive.
+The most easy is to store the commit when build the archive in the REVISION file.
+
+As default, the plugin can read the REVISION file from the archive.
+
+If you want to store the info in another file, you can set the file with the `:archive_revision_file` variable.
+If you have to manipulate the output (grep, awk, etc) you can change the `:archive_revision_command`
+
+If you want turn off the revision process, set the variable `:archive_revision` to false. 
+
+### Variables available
+
+If you need to change default values, you can set the following configuration variables in `config/deploy.rb` or wherever relevant:
+
+```ruby
+  set :archive_releases_path, "./"
+  set :archive_name, "#{fetch(:application)}_#{fetch(:branch)}"
+  set :archive_extension, 'tar.bz2'
+  set :archive_tar_options, 'xjf'
+  set :archive_workflow, true
+  set :archive_workflow_previous, ""
+  set :archive_workflow_next,"#{fetch(:stage)}"
+  set :archive_remote_path, "#{fetch(:tmp_dir)}"
+  set :archive_revision, true
+  set :archive_revision_file, './REVISION'
+  set :archive_revision_command, 'cat'
+```
+
+## Contributing
+
+Please feel free to open an [issue](https://github.com/prestaconcept/capistrano-archive/issues) 
+or a [pull request](https://github.com/prestaconcept/capistrano-archive), 
+if you want to help.
+
+Thanks to
+[everyone who has contributed](https://github.com/prestaconcept/capistrano-archive/graphs/contributors) already.
+
+---
+
+*This project is supported by [PrestaConcept](http://www.prestaconcept.net)*
+
+Released under the [MIT License](LICENSE)

data/capistrano-archive.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'capistrano/archive/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "capistrano-archive"
+  spec.version       = Capistrano::Archive::VERSION
+  spec.authors       = ['David Gaussinel']
+  spec.email         = ['dgaussinel@prestaconcept.net']
+  spec.description   = 'Transfer archive release strategy for capistrano.'
+  spec.summary       = 'Transfer archive release strategy for capistrano.'
+  spec.homepage      = 'https://github.com/prestaconcept/capistrano-archive'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/) 
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'capistrano', '>= 3.7.0', '< 4.0.0'
+end

data/lib/capistrano/archive.rb

@@ -0,0 +1 @@
+require 'capistrano/archive/scm'

data/lib/capistrano/archive/scm.rb

@@ -0,0 +1,104 @@
+require 'capistrano/scm/plugin'
+
+module Capistrano
+  module Archive
+    class SCM < ::Capistrano::SCM::Plugin
+      def set_defaults
+        set_if_empty :archive_releases_path, ->{"./"}
+        set_if_empty :archive_name, ->{"#{fetch(:application)}_#{fetch(:branch)}"}
+        set_if_empty :archive_extension, ->{'tar.bz2'}
+        set_if_empty :archive_tar_options, ->{'xjf'}
+        set_if_empty :archive_workflow, ->{true}
+        set_if_empty :archive_workflow_previous, ""
+        set_if_empty :archive_workflow_next,->{"#{fetch(:stage)}"}
+        set_if_empty :archive_remote_path, ->{"#{fetch(:tmp_dir)}"}
+        set_if_empty :archive_revision, ->{true}
+        set_if_empty :archive_revision_file, ->{'./REVISION'}
+        set_if_empty :archive_revision_command, ->{'cat'}
+        set_if_empty :archive_roles, ->{:all}
+      end
+
+      def define_tasks
+        eval_rakefile File.expand_path('../tasks/archive.rake', __FILE__)
+      end
+
+      def register_hooks
+        before 'deploy:new_release_path', 'archive:upload_archive'
+        after "deploy:new_release_path", "archive:create_release"
+        before "deploy:set_current_revision", "archive:set_current_revision"
+        after 'deploy:finished', 'archive:copy_archive_file'
+      end
+
+      def release
+        backend.execute :mkdir, '-p', release_path
+        backend.execute(:tar, fetch(:archive_tar_options), uploaded_archive_filename, '-C', release_path)
+      end
+
+      # @return [String]
+      def revision
+        if fetch(:archive_revision)
+          if File.file?(release_path_filename)
+            `tar #{fetch(:archive_tar_options)} #{release_path_filename} --to-command=\'#{fetch(:archive_revision_command)}\' #{fetch(:archive_revision_file)}`.gsub(/\n/,"")
+          else
+            abort "Archive #{release_path_filename} doesn't exist!"
+          end
+        end
+      end
+
+      def check
+        if !File.file?(release_path_filename)
+          abort "Archive #{release_path_filename} doesn't exist!"
+        end
+      end
+
+      # Upload archive file to server
+      #
+      # @return void
+      def upload
+        if File.file?(release_path_filename)
+          backend.upload!(release_path_filename, fetch(:archive_remote_path))
+        else
+          abort "Archive #{release_path_filename} doesn't exist!"
+        end
+      end
+
+      # Remove archive file
+      #
+      # @return void
+      def clean
+        backend.execute(:rm, '-f', uploaded_archive_filename)
+      end
+
+      # Copy archive file from previous stage to next stage directory release
+      def copy
+        if fetch(:archive_workflow)
+          unless fetch(:archive_workflow_next).to_s.strip.empty?
+            backend.execute(:cp, release_path_filename, "#{fetch(:archive_releases_path)}/#{fetch(:archive_workflow_next)}/")
+          end
+        end
+      end
+
+      # Path and filename to local archive
+      #
+      # @return [String]
+      def release_path_filename
+        @_release_path_filename ||= File.join(fetch(:archive_releases_path), fetch(:archive_workflow_previous) , release_filename)
+      end
+
+      # Filename to local archive
+      #
+      # @return [String]
+      def release_filename
+        @_release_filename ||= "#{fetch(:archive_name)}.#{fetch(:archive_extension)}"
+      end
+
+      # Archive uploaded filename
+      #
+      # @return [String]
+      def uploaded_archive_filename
+        @_uploaded_archive_filename ||= File.join(fetch(:archive_remote_path), release_filename)
+      end
+
+    end
+ end
+end

data/lib/capistrano/archive/tasks/archive.rake

@@ -0,0 +1,44 @@
+set :archive_plugin, self
+
+namespace :archive do
+  desc 'Check that the archive is readable'
+  task :check do
+    run_locally do
+      fetch(:archive_plugin).check
+    end
+  end 
+ 
+  desc 'Upload release to current stage'
+  task :upload_archive do
+    on release_roles(fetch(:archive_roles)) do
+        fetch(:archive_plugin).upload
+    end
+  end
+ 
+  desc 'Copy repo to releases'
+  task :create_release do
+    on release_roles :all do
+      fetch(:archive_plugin).release
+    end
+  end
+
+  desc 'Determine the revision that will be deployed'
+  task :set_current_revision do
+      set :current_revision, fetch(:archive_plugin).revision
+  end
+  
+  desc 'Clean : remove archive file after deploy'
+  task :clean do
+    on roles(:app) do
+      fetch(:archive_plugin).clean
+    end
+  end
+  
+  desc 'Copy local archive to make it available to next stage'
+  task :copy_archive_file do
+    run_locally do
+      fetch(:archive_plugin).copy
+    end
+  end
+
+end

data/lib/capistrano/archive/version.rb

@@ -0,0 +1,8 @@
+# Capistrano
+module Capistrano
+  # Archive
+  module Archive
+    # gem version
+    VERSION = '1.0.0'
+  end
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-archive
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- David Gaussinel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-06-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.7.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.7.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+description: Transfer archive release strategy for capistrano.
+email:
+- dgaussinel@prestaconcept.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- capistrano-archive.gemspec
+- lib/capistrano/archive.rb
+- lib/capistrano/archive/scm.rb
+- lib/capistrano/archive/tasks/archive.rake
+- lib/capistrano/archive/version.rb
+homepage: https://github.com/prestaconcept/capistrano-archive
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: Transfer archive release strategy for capistrano.
+test_files: []