RubyGems - statistrano - Versions diffs - 1.2.0 - Mend

statistrano 1.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (72) hide show

checksums.yaml +7 -0
data/changelog.md +161 -0
data/doc/config/file-permissions.md +33 -0
data/doc/config/log-files.md +32 -0
data/doc/config/task-definitions.md +88 -0
data/doc/getting-started.md +96 -0
data/doc/strategies/base.md +38 -0
data/doc/strategies/branches.md +82 -0
data/doc/strategies/releases.md +110 -0
data/doc/strategies.md +17 -0
data/lib/statistrano/config/configurable.rb +53 -0
data/lib/statistrano/config/rake_task_with_context_creation.rb +43 -0
data/lib/statistrano/config.rb +52 -0
data/lib/statistrano/deployment/log_file.rb +44 -0
data/lib/statistrano/deployment/manifest.rb +88 -0
data/lib/statistrano/deployment/rake_tasks.rb +74 -0
data/lib/statistrano/deployment/registerable.rb +11 -0
data/lib/statistrano/deployment/releaser/revisions.rb +163 -0
data/lib/statistrano/deployment/releaser/single.rb +48 -0
data/lib/statistrano/deployment/releaser.rb +2 -0
data/lib/statistrano/deployment/strategy/base.rb +132 -0
data/lib/statistrano/deployment/strategy/branches/index/template.html.erb +78 -0
data/lib/statistrano/deployment/strategy/branches/index.rb +40 -0
data/lib/statistrano/deployment/strategy/branches/release.rb +73 -0
data/lib/statistrano/deployment/strategy/branches.rb +198 -0
data/lib/statistrano/deployment/strategy/check_git.rb +43 -0
data/lib/statistrano/deployment/strategy/invoke_tasks.rb +58 -0
data/lib/statistrano/deployment/strategy/releases.rb +76 -0
data/lib/statistrano/deployment/strategy.rb +37 -0
data/lib/statistrano/deployment.rb +10 -0
data/lib/statistrano/log/default_logger.rb +105 -0
data/lib/statistrano/log.rb +33 -0
data/lib/statistrano/remote/file.rb +79 -0
data/lib/statistrano/remote.rb +111 -0
data/lib/statistrano/shell.rb +17 -0
data/lib/statistrano/util/file_permissions.rb +34 -0
data/lib/statistrano/util.rb +27 -0
data/lib/statistrano/version.rb +3 -0
data/lib/statistrano.rb +55 -0
data/readme.md +247 -0
data/spec/integration_tests/base_integration_spec.rb +103 -0
data/spec/integration_tests/branches_integration_spec.rb +189 -0
data/spec/integration_tests/releases/deploy_integration_spec.rb +116 -0
data/spec/integration_tests/releases/list_releases_integration_spec.rb +38 -0
data/spec/integration_tests/releases/prune_releases_integration_spec.rb +86 -0
data/spec/integration_tests/releases/rollback_release_integration_spec.rb +46 -0
data/spec/lib/statistrano/config/configurable_spec.rb +88 -0
data/spec/lib/statistrano/config/rake_task_with_context_creation_spec.rb +73 -0
data/spec/lib/statistrano/config_spec.rb +34 -0
data/spec/lib/statistrano/deployment/log_file_spec.rb +75 -0
data/spec/lib/statistrano/deployment/manifest_spec.rb +171 -0
data/spec/lib/statistrano/deployment/rake_tasks_spec.rb +107 -0
data/spec/lib/statistrano/deployment/registerable_spec.rb +19 -0
data/spec/lib/statistrano/deployment/releaser/revisions_spec.rb +486 -0
data/spec/lib/statistrano/deployment/releaser/single_spec.rb +59 -0
data/spec/lib/statistrano/deployment/strategy/base_spec.rb +158 -0
data/spec/lib/statistrano/deployment/strategy/branches_spec.rb +19 -0
data/spec/lib/statistrano/deployment/strategy/check_git_spec.rb +39 -0
data/spec/lib/statistrano/deployment/strategy/invoke_tasks_spec.rb +66 -0
data/spec/lib/statistrano/deployment/strategy/releases_spec.rb +257 -0
data/spec/lib/statistrano/deployment/strategy_spec.rb +76 -0
data/spec/lib/statistrano/deployment_spec.rb +4 -0
data/spec/lib/statistrano/log/default_logger_spec.rb +172 -0
data/spec/lib/statistrano/log_spec.rb +36 -0
data/spec/lib/statistrano/remote/file_spec.rb +166 -0
data/spec/lib/statistrano/remote_spec.rb +226 -0
data/spec/lib/statistrano/util/file_permissions_spec.rb +25 -0
data/spec/lib/statistrano/util_spec.rb +23 -0
data/spec/lib/statistrano_spec.rb +52 -0
data/spec/spec_helper.rb +86 -0
data/spec/support/given.rb +39 -0
metadata +223 -0

data/lib/statistrano/deployment/strategy/base.rb ADDED Viewed

@@ -0,0 +1,132 @@
+module Statistrano
+  module Deployment
+    module Strategy
+      # A Base Deployment Instance
+      # it holds the common methods needed
+      # to create a deployment
+      class Base
+        extend Deployment::Registerable
+        extend Config::Configurable
+        include InvokeTasks
+        include CheckGit
+        attr_reader :name
+        register_strategy :base
+        options :remote_dir, :local_dir,
+                :hostname, :user, :password, :keys, :forward_agent,
+                :build_task, :post_deploy_task,
+                :check_git, :git_branch, :repo_url,
+                :dir_permissions, :file_permissions, :rsync_flags,
+                :log_file_path, :log_file_entry
+        option  :remotes, []
+        option  :dir_permissions, 755
+        option  :file_permissions, 644
+        option  :rsync_flags, '-aqz --delete-after'
+        option  :verbose, false
+        task :deploy,      :deploy,                  "Deploy to remote"
+        task :build,       :invoke_build_task,       "Run build task"
+        task :post_deploy, :invoke_post_deploy_task, "Run post deploy task"
+        # create a new deployment instance
+        # @param name [String]
+        # @return [Void]
+        def initialize name
+          @name = name
+        end
+        # Standard deployment flow
+        # @return [Void]
+        def deploy
+          unless safe_to_deploy?
+            Log.error "exiting due to git check failing"
+            abort()
+          end
+          build_data = invoke_build_task
+          build_data = ensure_data_is_hash build_data
+          unless safe_to_deploy?
+            Log.error "exiting due to git check failing",
+                      "your build task modified checked in files"
+            abort()
+          end
+          remotes.each do |remote|
+            persisted_releaser.create_release remote, build_data
+          end
+          post_deploy_data = invoke_post_deploy_task
+          post_deploy_data = ensure_data_is_hash post_deploy_data
+          if config.log_file_path
+            log_entry = config.log_file_entry.call self, persisted_releaser,
+                                                   build_data, post_deploy_data
+            remotes.each do |remote|
+              log_file(remote).append! log_entry
+            end
+          end
+          flush_persisted_releaser!
+        end
+        def register_tasks
+          RakeTasks.register self
+        end
+        def remotes
+          return @_remotes if @_remotes
+          @_remotes = config.options[:remotes].map do |remote_options|
+            Remote.new Config.new( config.options.dup.merge(remote_options) )
+          end
+          @_remotes.push Remote.new(config) if @_remotes.empty?
+          return @_remotes
+        end
+        def log_file remote=remotes.first
+          Deployment::LogFile.new config.log_file_path, remote
+        end
+        def persisted_releaser
+          @_persisted_releaser ||= releaser
+        end
+        def flush_persisted_releaser!
+          @_persisted_releaser = nil
+        end
+        private
+          def resolve_log_file_path
+            if config.log_file_path.start_with? '/'
+              config.log_file_path
+            else
+              File.join( config.remote_dir, config.log_file_path )
+            end
+          end
+          def ensure_data_is_hash data
+            if data.respond_to? :to_hash
+              data = data.to_hash
+            else
+              data = {}
+            end
+          end
+          def releaser
+            Releaser::Single.new
+          end
+      end
+    end
+  end
+end

data/lib/statistrano/deployment/strategy/branches/index/template.html.erb ADDED Viewed

@@ -0,0 +1,78 @@
+<!DOCTYPE html>
+<html role="document">
+  <head>
+    <meta charset=utf-8>
+    <meta content=en name=language>
+    <meta content=IE=edge,chrome=1 http-equiv=X-UA-Compatible>
+    <meta content=width=device-width name=viewport>
+    <style type=text/css>
+      body {
+        background: #f9f9f9;
+        color: #5f5f5f;
+        font-family: "Helvetica Neue", Arial, Helvetica, sans-serif;
+        -webkit-font-smoothing: antialiased;
+        margin: 0;
+        padding: 0;
+      }
+      h1 {
+        font-size: 3em;
+        margin: .5em 0;
+        line-height: 1;
+      }
+      .content {
+        max-width: 640px;
+        padding: 3em 1em;
+        margin: 0 auto;
+        text-align: center;
+      }
+      ul {
+        padding: 0;
+        outline: 1px solid #a6a6a6;
+        list-style: none;
+        display: inline-block;
+      }
+      li {
+        padding: 1em 1.5em;
+        border-bottom: 1px solid #c2c2c2;
+        text-align: left;
+      }
+        li:last-child {
+          border-bottom: none;
+        }
+      li a {
+        margin: 0;
+        padding: 0 1em 0 0;
+        display: inline-block;
+        font-weight: bold;
+        text-decoration: none;
+        color: inherit;
+             -o-transition: color .2s ease;
+           -moz-transition: color .2s ease;
+        -webkit-transition: color .2s ease;
+                transition: color .2s ease;
+      }
+        li a:hover {
+          color: #449A88;
+        }
+      li small {
+        margin: .25em 0 0 0;
+        padding: 0;
+        font-size: .75em;
+        display: inline-block;
+        color: #999;
+      }
+    </style>
+  </head>
+  <body>
+    <section class="content">
+      <h1>Branch Index</h1>
+      <ul><% releases.each do |release| %>
+        <li>
+          <a href="<%= release.href %>"><%= release.name %></a>
+          <small>updated: <%= Time.at(release.time).strftime('%A %b %d, %Y at %l:%M %P') %></small>
+        </li>
+      <% end %></ul>
+    </section>
+  </body>
+</html>

data/lib/statistrano/deployment/strategy/branches/index.rb ADDED Viewed

@@ -0,0 +1,40 @@
+require 'erb'
+module Statistrano
+  module Deployment
+    module Strategy
+      class Branches
+        class Index
+          attr_reader :template, :releases
+          def initialize releases, template_path=nil
+            @releases = releases
+            @template = IO.read(template_path || File.expand_path("../index/template.html.erb", __FILE__))
+          end
+          def to_html
+            ERB.new(template).result(ERBContext.new(releases).get_binding)
+          end
+          class ERBContext
+            attr_reader :releases
+            def initialize releases
+              @releases = releases
+            end
+            def get_binding
+              binding
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/statistrano/deployment/strategy/branches/release.rb ADDED Viewed

@@ -0,0 +1,73 @@
+module Statistrano
+  module Deployment
+    module Strategy
+      class Branches
+        #
+        # Manages the state of a single release for the manifest
+        #
+        class Release
+          attr_reader :name, :config, :options
+          # init a release
+          # @param name [String] name of the release
+          # @param config [Obj] the config object
+          # @param options [Hash] :time, :commit, & :link || :repo_url
+          def initialize name, config, options={}
+            @name    = name
+            @config  = config
+            @options = Util.symbolize_hash_keys options
+          end
+          def time
+            @_time ||= options.fetch(:time) { Time.now.to_i }
+          end
+          def commit
+            @_commit ||= options.fetch(:commit) { Asgit.current_commit }
+          end
+          def link
+            @_link ||= options.fetch(:link) { (options[:repo_url]) ? "#{options[:repo_url]}/tree/#{commit}" : nil }
+          end
+          def href
+            "http://#{name}.#{config.base_domain}"
+          end
+          # # convert the release to an li element
+          # # @return [String]
+          # def as_li
+          #   "<li>" +
+          #   "<a href=\"http://#{name}.#{config.base_domain}\">#{name}</a>" +
+          #   "<small>updated: #{Time.at(time).strftime('%A %b %d, %Y at %l:%M %P')}</small>" +
+          #   "</li>"
+          # end
+          # def get_binding
+          #   binding
+          # end
+          def to_hash
+            hash = {
+              name: name,
+              time: time,
+              commit: commit
+            }
+            hash.merge({ link: link }) if link
+            return hash
+          end
+          # convert the release to a json object
+          # @return [String]
+          def to_json
+            return to_hash.to_json
+          end
+        end
+      end
+    end
+  end
+end

data/lib/statistrano/deployment/strategy/branches.rb ADDED Viewed

@@ -0,0 +1,198 @@
+module Statistrano
+  module Deployment
+    module Strategy
+      #
+      # Branches is for deployments that depend upon the
+      # current git branch, eg. doing feature branch deployments
+      #
+      class Branches < Base
+        register_strategy :branches
+        option :base_domain
+        option :public_dir, :call, Proc.new { Asgit.current_branch.to_slug }
+        option :post_deploy_task,  Proc.new { |d|
+          d.push_current_release_to_manifest
+          d.generate_index
+        }
+        task :list,           :list_releases,  "List branches"
+        task :prune,          :prune_releases, "Prune a branch"
+        task :generate_index, :generate_index, "Generate a branch index"
+        task :open,           :open_url,       "Open the current branch URL"
+        # output a list of the releases in manifest
+        # @return [Void]
+        def list_releases
+          remotes.each do |remote|
+            releases_data = sorted_release_data(remote)
+            releases_data.map! do |release|
+              "#{release[:name]} created at #{Time.at(release[:time]).strftime('%a %b %d, %Y at %l:%M %P')}"
+            end
+            Log.info remote.config.hostname.to_sym, *releases_data
+          end
+        end
+        # trim releases not in the manifest,
+        # get user input for removal of other releases
+        # @return [Void]
+        def prune_releases
+          candidate_releases = []
+          remotes.each do |remote|
+            prune_untracked_releases(remote)
+            candidate_releases.push *get_releases(remote)
+            candidate_releases.uniq!
+          end
+          if candidate_releases.length > 0
+            pick_and_remove_release candidate_releases
+          else
+            Log.warn "no releases to prune"
+          end
+        end
+        # generate an index file for releases in the manifest
+        # @return [Void]
+        def generate_index
+          remotes.each do |remote|
+            index_dir  = File.join( remote.config.remote_dir, "index" )
+            index_path = File.join( index_dir, "index.html" )
+            remote.create_remote_dir index_dir
+            remote.run "touch #{index_path} && echo '#{release_list_html(remote)}' > #{index_path}"
+          end
+        end
+        # push the current release into the manifest
+        # @return [Void]
+        def push_current_release_to_manifest
+          remotes.each do |remote|
+            mnfst = manifest(remote)
+            mnfst.put Release.new( config.public_dir, config ).to_hash, :name
+            mnfst.save!
+          end
+        end
+        private
+          def manifest remote
+            @_manifests ||= {}
+            @_manifests.fetch( remote ) do
+              Deployment::Manifest.new remote.config.remote_dir, remote
+            end
+          end
+          def pick_and_remove_release candidate_releases
+            picked_release = pick_release_to_remove candidate_releases
+            if picked_release
+              remotes.each do |remote|
+                if get_releases(remote).include? picked_release
+                  remove_release(remote, picked_release)
+                end
+              end
+              generate_index
+            else
+              Log.warn "sorry, that isn't one of the releases"
+            end
+          end
+          def pick_release_to_remove candidate_releases
+            list_releases_with_index candidate_releases
+            picked_release = Shell.get_input("select a release to remove: ").gsub(/[^0-9]/, '')
+            if !picked_release.empty? && picked_release.to_i < candidate_releases.length
+              return candidate_releases[picked_release.to_i]
+            else
+              return false
+            end
+          end
+          def list_releases_with_index releases
+            releases.each_with_index do |release,idx|
+              Log.info :"[#{idx}]", "#{release}"
+            end
+          end
+          # removes releases that are on the remote but not in the manifest
+          # @return [Void]
+          def prune_untracked_releases remote
+            get_actual_releases(remote).each do |release|
+              remove_release(remote, release) unless get_releases(remote).include? release
+            end
+          end
+          def release_list_html remote
+            releases = sorted_release_data(remote).map do |r|
+              name = r.fetch(:name)
+              r.merge({ repo_url: config.repo_url }) if config.repo_url
+              Release.new( name, config, r )
+            end
+            Index.new( releases ).to_html
+          end
+          def sorted_release_data remote
+            manifest(remote).data.sort_by do |r|
+              r[:time]
+            end.reverse
+          end
+          # remove a release
+          # @param name [String]
+          # @return [Void]
+          def remove_release remote, name
+            Log.info remote.config.hostname.to_sym, "Removing release '#{name}'"
+            remote.run "rm -rf #{release_path(name, remote)}"
+            manifest(remote).remove_if do |r|
+              r[:name] == name
+            end
+            manifest(remote).save!
+          end
+          # return array of releases from the manifest
+          # @return [Array]
+          def get_releases remote
+           sorted_release_data(remote).map { |r| r[:name] }
+          end
+          # return array of releases on the remote
+          # @return [Array]
+          def get_actual_releases remote
+            remote.run("ls -mp #{remote.config.remote_dir}")
+                  .stdout.strip.split(',')
+                  .keep_if { |release| /\/$/.match(release) }
+                  .map     { |release| release.strip.sub(/(\/$)/, '') }
+                  .keep_if { |release| release != "index" }
+          end
+          # path to the current release
+          # this is based on the git branch
+          # @return [String]
+          def current_release_path
+            File.join( config.remote_dir, config.public_dir )
+          end
+          # path to a specific release
+          # @return [String]
+          def release_path name, remote
+            File.join( remote.config.remote_dir, name )
+          end
+          # open the current checked out branch
+          # @return [Void]
+          def open_url
+            if config.base_domain
+              url = "http://#{config.public_dir}.#{config.base_domain}"
+              system "open #{url}"
+            end
+          end
+      end
+    end
+  end
+end
+require_relative 'branches/index'
+require_relative 'branches/release'

data/lib/statistrano/deployment/strategy/check_git.rb ADDED Viewed

@@ -0,0 +1,43 @@
+module Statistrano
+  module Deployment
+    module Strategy
+      module CheckGit
+        # Check if things are safe to deploy
+        # @return [Boolean]
+        def safe_to_deploy?
+          # if we don't want to check git
+          # we're good to go
+          if !config.check_git
+            return true
+          end
+          # are there any uncommited changes?
+          if !Asgit.working_tree_clean?
+            Log.warn "You need to commit or stash your changes before deploying"
+            return false
+          end
+          # make sure you're on the branch selected to check against
+          if Asgit.current_branch != config.git_branch
+            Log.warn "You shouldn't deploy from any branch but #{config.git_branch}"
+            return false
+          end
+          # make sure you're up to date
+          if !Asgit.remote_up_to_date?
+            Log.warn "You need to update or push your changes before deploying"
+            return false
+          end
+          # we passed all the checks
+          return true
+        end
+      end
+    end
+  end
+end

data/lib/statistrano/deployment/strategy/invoke_tasks.rb ADDED Viewed

@@ -0,0 +1,58 @@
+module Statistrano
+  module Deployment
+    module Strategy
+      module InvokeTasks
+        # Run the post_deploy_task
+        # return [Void]
+        def invoke_post_deploy_task
+          if config.post_deploy_task
+            Log.info :post_deploy, "Running the post deploy task"
+            call_or_invoke_task config.post_deploy_task
+          end
+        end
+        # Run the build_task supplied
+        # return [Void]
+        def invoke_build_task
+          Log.info :build, "Running the build task"
+          call_or_invoke_task config.build_task
+        end
+        # Run the pre_symlink_task if supplied
+        # return [Void]
+        def invoke_pre_symlink_task remote
+          if !remote.config.pre_symlink_task.nil?
+            Log.info :pre_symlink, "Running the pre_symlink task"
+            resp = call_or_invoke_task remote.config.pre_symlink_task, remote
+            if resp == false
+              Log.error :pre_symlink, "exiting due to falsy return"
+              abort()
+            end
+          end
+        end
+        def call_or_invoke_task task, arg=nil
+          if task.respond_to? :call
+            if arg && task.arity == 2
+              task.call self, arg
+            elsif task.arity == 1
+              task.call self
+            else
+              task.call
+            end
+          else
+            Rake::Task[task].invoke
+          end
+        rescue Exception => e
+          Log.error "exiting due to error in task",
+                    "#{e.class}: #{e}"
+          abort()
+        end
+      end
+    end
+  end
+end

data/lib/statistrano/deployment/strategy/releases.rb ADDED Viewed

@@ -0,0 +1,76 @@
+module Statistrano
+  module Deployment
+    module Strategy
+      # deployment type for running a releases deployment
+      # accross multiple remotes
+      #
+      # @example:
+      #
+      #   define_deployment "multi", :releases do
+      #     build_task 'deploy:build'
+      #     local_dir  'build'
+      #     remote_dir '/var/www/proj'
+      #
+      #     check_git  true
+      #     git_branch 'master'
+      #
+      #     remotes [
+      #       { hostname: 'web01' },
+      #       { hostname: 'web02' }
+      #     ]
+      #
+      #     # each remote gets merged with the global
+      #     # configs and deployed to individually
+      #     #
+      #   end
+      #
+      class Releases < Base
+        register_strategy :releases
+        option :pre_symlink_task, nil
+        option :release_count,    5
+        option :release_dir,      "releases"
+        option :public_dir,       "current"
+        option :remotes, []
+        task :deploy,   :deploy,           "Deploy to all remotes"
+        task :rollback, :rollback_release, "Rollback to the previous release"
+        task :prune,    :prune_releases,   "Prune releases to release count"
+        task :list,     :list_releases,    "List releases"
+        def initialize name
+          @name = name
+        end
+        def rollback_release
+          remotes.each do |remote|
+            releaser.rollback_release remote
+          end
+        end
+        def prune_releases
+          remotes.each do |remote|
+            releaser.prune_releases remote
+          end
+        end
+        def list_releases
+          remotes.each do |remote|
+            releases = releaser.list_releases(remote).map { |rel| rel[:release] }
+            Log.info :"#{remote.config.hostname}", releases
+          end
+        end
+        private
+          def releaser
+            Releaser::Revisions.new
+          end
+      end
+    end
+  end
+end