shipit-engine 0.8.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d3b3153e7b24f260f276933b246bca9d9bc2ebdd
-  data.tar.gz: 93ca93e3b0d8347a453979039c8cb16159ed044c
+  metadata.gz: 044a58eabe4689b586de4daf11cca00b72cf7d37
+  data.tar.gz: 39509907d1d0ae00f7573f699b6c2c9e63cf9999
 SHA512:
-  metadata.gz: 7adfee4675b580ed2eba9e0f5057ba4647d51c9ce2b604ccfb598afbdbd9d8601841689e746de78d879975994d3b54eab450d8f0e11400774272702c9d6b399e
-  data.tar.gz: 1cb49f0e1c633f95cf293b9df55314bc6f800920b59308cbcebb58aeaa56d236877762d74410b8f1088d85d651db8b0eb59b3b26a4750c2f3e5c2eb13d2896f9
+  metadata.gz: eef3d23d0c0b3cb858e7986332fda01cbfcfdc02a48cb7b3ea486d304e818366ea9365db89b1657354f3e90bb3ccb49818a0ea667c141eb6e39207d95ea2ab89
+  data.tar.gz: 1f96ec3403295af649196bcdc38a13bdbe6212931022ccb1b7882e638f3d4a80f8f820dc3fdb7b39ee7b4e45ff450c59d79626799a0fb5f2f212d415d818e46a

data/README.md

@@ -118,7 +118,7 @@ The settings in the `shipit.yml` file relate to the different things you can do
 
 * [Installing dependencies](#installing-dependencies) (`dependencies`)
 * [Deployment](#deployment) (`deploy`, `rollback`, `fetch`)
-* [Environment](#environment) (`machine.environment`)
+* [Environment](#environment) (`machine.environment`, `machine.directory`, `machine.cleanup`)
 * [CI](#ci) (`ci.require`, `ci.hide`, `ci.allow_failures`)
 * [Custom tasks](#custom-tasks) (`restart`, `unlock`)
 * [Review Process](#review-process) (`monitor`, `checklist`, `checks`)
@@ -172,9 +172,33 @@ dependencies:
     - npm install
 ```
 
+**<code>dependencies.pre</code>** If you wish to execute commands before Shipit install the dependencies you can specify them here:
+
+For example:
+
+```yml
+depedencies:
+  pre:
+    - mkdir tmp/
+    - cp -R /var/cache/ tmp/cache
+```
+<br>
+
+**<code>dependencies.post</code>** If you wish to execute commands after Shipit installed the dependencies you can specify them here:
+
+For example:
+
+```yml
+depedencies:
+  post:
+    - cp -R tmp/cache /var/cache/
+```
+<br>
+
+
 <h3 id="deployment">Deployment</h3>
 
-The `override` and `deployment` deployment tasks are the core of Shipit:
+The `deploy` and `rollback` sections are the core of Shipit:
 
 **<code>deploy.override</code>** contains an array of the shell commands required to deploy the application. Shipit will try to infer it from the repository structure, but you can change the default inference.
 
@@ -187,6 +211,29 @@ deploy:
 ```
 <br>
 
+**<code>deploy.pre</code>** If you wish to execute commands before Shipit execute your deploy script you can specify them here:
+
+For example:
+
+```yml
+deploy:
+  pre:
+    - ./script/notify_deploy_start
+```
+<br>
+
+**<code>deploy.post</code>** If you wish to execute commands after Shipit executed your deploy script you can specify them here:
+
+For example:
+
+```yml
+deploy:
+  post:
+    - ./script/notify_deploy_end
+```
+<br>
+
+
 You can also accept custom environment variables defined by the user that trigger the deploy:
 
 **<code>deploy.variables</code>** contains an array of variable definitions.
@@ -214,6 +261,29 @@ rollback:
 ```
 <br>
 
+**<code>rollback.pre</code>** If you wish to execute commands before Shipit execute your rollback script you can specify them here:
+
+For example:
+
+```yml
+rollback:
+  pre:
+    - ./script/notify_rollback_start
+```
+<br>
+
+**<code>rollback.post</code>** If you wish to execute commands after Shipit executed your rollback script you can specify them here:
+
+For example:
+
+```yml
+rollback:
+  post:
+    - ./script/notify_rollback_end
+```
+<br>
+
+
 **<code>fetch</code>** contains an array of the shell commands that Shipit executes to check the revision of the currently-deployed version. This key defaults to disabled.
 
 For example:
@@ -232,6 +302,26 @@ machine:
     key: val # things added as environment variables
 ```
 
+<h3 id="directory">Directory</h3>
+
+**<code>machine.directory</code>** specify a subfolder in which to execute all tasks. Useful for repositories containing multiple applications or if you don't want your deploy scripts to be located at the root.
+
+For example:
+```yml
+machine:
+  directory: scripts/deploy/
+```
+
+<h3 id="cleanup">Cleanup</h3>
+
+**<code>machine.cleanup</code>** specify wether or not the deploy working directory should cleaned up once the deploy completed. Defaults to `true`, but can be useful to disable temporarily to investigate bugs.
+
+For example:
+```yml
+machine:
+  cleanup: false
+```
+
 <h3 id="ci">CI</h3>
 **<code>ci.require</code>** contains an array of the [statuses context](https://developer.github.com/v3/repos/statuses/) you want Shipit to disallow deploys if any of them is missing.
 

data/app/assets/stylesheets/_pages/_commits.scss

@@ -132,6 +132,9 @@
 
 .status-group {
   position: relative; // Required to position the status-items div correctly
+  .status-item.ignored {
+    opacity: .5;
+  }
 }
 
 .status {

data/app/assets/stylesheets/_pages/_deploy.scss

@@ -63,9 +63,14 @@
   flex-wrap: wrap;
 
   .deploy-banner-section {
+    display: inline-block;
     padding: .95rem 1.5rem 1.125rem;
   }
 
+  .stack-link {
+    display: none;
+  }
+
   .action-buttons {
     flex: none;
   }
@@ -75,6 +80,10 @@
     top: 0;
     left: 0;
     right: 0;
+
+    .stack-link {
+      display: inline-block;
+    }
   }
 
   &[data-status="running"]:before,

data/app/assets/stylesheets/_structure/_layout.scss

@@ -38,6 +38,15 @@
   margin: .4em .5em .4em 0;
 }
 
+.powered-by {
+  float: right;
+  position: relative;
+  top: .5rem;
+  right: 1rem;
+  font-size: 12px;
+  color: #999;
+}
+
 
 // LOGO
 // -----------------------------------------------------------------------------

data/app/jobs/shipit/perform_task_job.rb

@@ -11,7 +11,7 @@ module Shipit
       end
       run
     ensure
-      @task.clear_working_directory
+      @commands.clear_working_directory
     end
 
     def run

data/app/models/shipit/commit.rb

@@ -9,7 +9,7 @@ module Shipit
     after_commit { broadcast_update }
     after_create { stack.update_undeployed_commits_count }
 
-    after_commit :schedule_refresh_statuses!, :schedule_fetch_stats!, on: :create
+    after_commit :schedule_refresh_statuses!, :schedule_fetch_stats!, :schedule_continuous_delivery, on: :create
 
     after_touch :touch_stack
 
@@ -92,7 +92,7 @@ module Shipit
 
       payload = {commit: self, stack: stack, status: new_status.state}
       Hook.emit(:commit_status, stack, payload.merge(commit_status: new_status)) if previous_status != new_status
-      if simple_state(previous_status) != simple_state(new_status) && !new_status.pending?
+      if previous_status.simple_state != new_status.simple_state && !new_status.pending?
         Hook.emit(:deployable_status, stack, payload.merge(deployable_status: new_status))
       end
       new_status
@@ -141,7 +141,7 @@ module Shipit
     end
 
     def schedule_continuous_delivery
-      return unless state == 'success' && stack.continuous_deployment? && stack.deployable?
+      return unless deployable? && stack.continuous_deployment? && stack.deployable?
       ContinuousDeliveryJob.perform_later(stack)
     end
 
@@ -199,9 +199,5 @@ module Shipit
     def touch_stack
       stack.touch
     end
-
-    def simple_state(status)
-      status.state == 'error' ? 'failure' : status.state
-    end
   end
 end

data/app/models/shipit/commit_deployment.rb

@@ -48,6 +48,7 @@ module Shipit
         stack.github_repo_name,
         pull_request_head,
         auto_merge: false,
+        required_contexts: [],
         description: "Via Shipit",
         environment: stack.environment,
       )

data/app/models/shipit/deploy.rb

@@ -14,7 +14,7 @@ module Shipit
     has_many :commit_deployments, inverse_of: :task, foreign_key: :task_id do
       GITHUB_STATUSES = {
         'pending' => 'pending',
-        'failed' => 'failed',
+        'failed' => 'failure',
         'success' => 'success',
         'error' => 'error',
         'aborted' => 'error',

data/app/models/shipit/deploy_spec.rb

@@ -29,8 +29,15 @@ module Shipit
       self
     end
 
-    def config(*keys)
-      keys.flatten.reduce(@config) { |h, k| h[k] if h.respond_to?(:[]) }
+    def config(*keys, &default)
+      default ||= -> { nil }
+      keys.flatten.reduce(@config) do |hash, key|
+        if hash.is_a?(Hash)
+          hash.fetch(key) { return default.call }
+        else
+          return default.call
+        end
+      end
     end
 
     def supports_fetch_deployed_revision?
@@ -50,12 +57,16 @@ module Shipit
     end
 
     def dependencies_steps
-      config('dependencies', 'override') || discover_dependencies_steps || []
+      around_steps('dependencies') do
+        config('dependencies', 'override') { discover_dependencies_steps || [] }
+      end
     end
     alias_method :dependencies_steps!, :dependencies_steps
 
     def deploy_steps
-      config('deploy', 'override') || discover_deploy_steps
+      around_steps('deploy') do
+        config('deploy', 'override') { discover_deploy_steps }
+      end
     end
 
     def deploy_steps!
@@ -67,7 +78,9 @@ module Shipit
     end
 
     def rollback_steps
-      config('rollback', 'override') || discover_rollback_steps
+      around_steps('rollback') do
+        config('rollback', 'override') { discover_rollback_steps }
+      end
     end
 
     def rollback_steps!
@@ -126,8 +139,18 @@ module Shipit
       config('plugins') || {}
     end
 
+    def clear_working_directory?
+      config('machine', 'cleanup') { true }
+    end
+
     private
 
+    def around_steps(section)
+      steps = yield
+      return unless steps
+      config(section, 'pre') { [] } + steps + config(section, 'post') { [] }
+    end
+
     def coerce_task_definition(config)
       config
     end

data/app/models/shipit/deploy_spec/file_system.rb

@@ -15,6 +15,14 @@ module Shipit
         DeploySpec.new(cacheable_config)
       end
 
+      def file(path, root: false)
+        if root || directory.blank?
+          @app_dir.join(path)
+        else
+          Pathname.new(File.join(@app_dir, directory, path))
+        end
+      end
+
       private
 
       def cacheable_config
@@ -24,7 +32,11 @@ module Shipit
             'allow_failures' => soft_failing_statuses,
             'require' => required_statuses,
           },
-          'machine' => {'environment' => machine_env, 'directory' => directory},
+          'machine' => {
+            'environment' => machine_env,
+            'directory' => directory,
+            'cleanup' => true,
+          },
           'review' => {
             'checklist' => review_checklist,
             'monitoring' => review_monitoring,
@@ -49,16 +61,13 @@ module Shipit
       end
 
       def load_config
-        read_config(file("shipit.#{@env}.yml")) || read_config(file('shipit.yml'))
+        read_config(file("shipit.#{@env}.yml", root: true)) ||
+          read_config(file('shipit.yml', root: true))
       end
 
       def read_config(path)
         SafeYAML.load(path.read) if path.exist?
       end
-
-      def file(path)
-        @app_dir.join(path)
-      end
     end
   end
 end

data/app/models/shipit/hook.rb

@@ -15,6 +15,7 @@ module Shipit
       lock
       commit_status
       deployable_status
+      merge_status
     ).freeze
 
     belongs_to :stack, required: false
@@ -32,6 +33,7 @@ module Shipit
 
     class << self
       def emit(event, stack, payload)
+        raise "#{event} is not declared in Shipit::Hook::EVENTS" unless EVENTS.include?(event.to_s)
         Shipit::EmitEventJob.perform_later(
           event: event.to_s,
           stack_id: stack.try!(:id),

data/app/models/shipit/stack.rb

@@ -32,6 +32,7 @@ module Shipit
     after_commit :emit_updated_hooks, on: :update
     after_commit :emit_removed_hooks, on: :destroy
     after_commit :broadcast_update, on: :update
+    after_commit :emit_merge_status_hooks, on: :update
     after_commit :setup_hooks, :sync_github, on: :create
     after_touch :clear_cache
 
@@ -116,11 +117,25 @@ module Shipit
       commits.reachable.first.try!(:sha)
     end
 
+    def merge_status
+      if locked?
+        'locked'
+      else
+        significant_statuses = undeployed_commits.map(&:significant_status)
+        last_finalized_status = significant_statuses.reject { |s| %w(pending unknown).include?(s.state) }.first
+        last_finalized_status.try!(:simple_state) || 'pending'
+      end
+    end
+
     def status
       return :deploying if active_task?
       :default
     end
 
+    def undeployed_commits
+      commits.reachable.newer_than(last_deployed_commit).order(id: :desc)
+    end
+
     def last_successful_deploy
       deploys_and_rollbacks.success.order(created_at: :desc).first
     end
@@ -150,11 +165,11 @@ module Shipit
     end
 
     def repo_name=(name)
-      super(name.try(:downcase))
+      super(name.try!(:downcase))
     end
 
     def repo_owner=(name)
-      super(name.try(:downcase))
+      super(name.try!(:downcase))
     end
 
     def repo_http_url
@@ -250,7 +265,7 @@ module Shipit
 
     def update_undeployed_commits_count(after_commit = nil)
       after_commit ||= last_deployed_commit
-      undeployed_commits = commits.reachable.select('count(*) as count').where('id > ?', after_commit.id)
+      undeployed_commits = commits.reachable.newer_than(after_commit).select('count(*) as count')
       self.class.where(id: id).update_all("undeployed_commits_count = (#{undeployed_commits.to_sql})")
     end
 
@@ -335,6 +350,10 @@ module Shipit
       Hook.emit(:stack, self, action: :removed, stack: self)
     end
 
+    def emit_merge_status_hooks
+      Hook.emit(:merge_status, self, merge_status: merge_status, stack: self)
+    end
+
     def ci_enabled_cache_key
       "stacks:#{id}:ci_enabled"
     end

data/app/models/shipit/status.rb

@@ -23,10 +23,20 @@ module Shipit
       )
     end
 
+    delegate :stack, to: :commit
+
+    def ignored?
+      stack.soft_failing_statuses.include?(context)
+    end
+
     def group?
       false
     end
 
+    def simple_state
+      state == 'error' ? 'failure' : state
+    end
+
     private
 
     def enable_ci_on_stack

data/app/models/shipit/task.rb

@@ -181,10 +181,6 @@ module Shipit
       File.join(stack.deploys_path, id.to_s)
     end
 
-    def clear_working_directory
-      FileUtils.rm_rf(working_directory)
-    end
-
     def record_status_change
       @status_changed ||= status_changed?
     end

data/app/models/shipit/unknown_status.rb

@@ -3,6 +3,7 @@ module Shipit
     def state
       'unknown'
     end
+    alias_method :simple_state, :state
 
     def pending?
       false

data/app/views/layouts/shipit.html.erb

@@ -25,6 +25,7 @@
   </div>
 
   <header class="header">
+    <%= link_to "Shipit v#{Shipit::VERSION}", "https://github.com/Shopify/shipit-engine/tree/v#{Shipit::VERSION}", class: 'powered-by' %>
     <div class="wrapper">
       <div class="header__inner">
         <a href="/" class="logo">

data/app/views/shipit/stacks/new.html.erb

@@ -11,7 +11,7 @@
           <%= Shipit.github_url %>
           <%= f.text_field :repo_owner, placeholder: 'e.g. Shopify', required: true, class: "repo" %>
           /
-          <%= f.text_field :repo_name, required: true, pattern: "^[a-z0-9\-_\.]+$", class: "repo" %>
+          <%= f.text_field :repo_name, required: true, pattern: "^[a-zA-Z0-9\-_\.]+$", class: "repo" %>
         </p>
         <p>
           <%= f.label :branch %>

data/app/views/shipit/statuses/_group.html.erb

@@ -7,7 +7,7 @@
       <strong class="status-item__service"><%= group.description %></strong>
     </div>
     <% group.statuses.each do |status| %>
-      <div class="status-item status-item--<%= status.state %>">
+      <div class="status-item status-item--<%= status.state %> <%= :ignored if status.ignored? %>">
         <i class="status-item__icon"></i>
         <a href="<%= status.target_url %>" target="_blank">
           <strong class="status-item__service"><%= status.context %></strong>

data/app/views/shipit/tasks/_task_output.html.erb

@@ -9,26 +9,29 @@
 <div class="deploy-main" data-task="<%= {repo: @stack.github_repo_name, description: task_description(task)}.to_json %>">
   <span class="deploy-tasks"></span>
   <div class="deploy-banner" data-status="<%= task.status %>">
-      <div class="deploy-banner-section">
-        <a href="#" class="user main-user disabled"><%= task.author.name %></a>
-        <span class="deploy-status">
-          <%= content_for :task_title %>
-        </span>
-      </div>
+    <div class="deploy-banner-section stack-link">
+      <%= link_to "Return to #{@stack.repo_name}/#{@stack.environment}", stack_path(@stack) %>
+    </div>
+    <div class="deploy-banner-section">
+      <a href="#" class="user main-user disabled"><%= task.author.name %></a>
+      <span class="deploy-status">
+        <%= content_for :task_title %>
+      </span>
+    </div>
 
-      <div class="deploy-banner-section action-buttons">
-        <%= link_to abort_stack_task_path(@stack, task), class: "btn btn--alert action-button", data: { action: "abort", status: task.status } do %>
-          <span class="caption--ready">Abort</span>
-          <span class="caption--pending">Aborting...</span>
-        <% end %>
+    <div class="deploy-banner-section action-buttons">
+      <%= link_to abort_stack_task_path(@stack, task), class: "btn btn--alert action-button", data: { action: "abort", status: task.status } do %>
+        <span class="caption--ready">Abort</span>
+        <span class="caption--pending">Aborting...</span>
+      <% end %>
 
-        <% if task.supports_rollback? %>
-          <%= link_to abort_stack_task_path(@stack, task, rollback: true), class: "btn btn--delete action-button", data: { action: "abort", rollback: true, status: task.status } do %>
-            <span class="caption--ready">Abort and Rollback</span>
-            <span class="caption--pending">Aborting with Rollback...</span>
-          <% end %>
+      <% if task.supports_rollback? %>
+        <%= link_to abort_stack_task_path(@stack, task, rollback: true), class: "btn btn--delete action-button", data: { action: "abort", rollback: true, status: task.status } do %>
+          <span class="caption--ready">Abort and Rollback</span>
+          <span class="caption--pending">Aborting with Rollback...</span>
         <% end %>
-      </div>
+      <% end %>
+    </div>
   </div>
 
   <pre class="nowrap" data-status="<%= task.status %>"><code data-next-chunks-url="<%= next_chunks_url(task) %>"><%= task.chunk_output %></code></pre>

data/lib/shipit.rb

@@ -26,6 +26,7 @@ require 'redis-namespace'
 require 'octokit'
 require 'faraday-http-cache'
 
+require 'shipit/version'
 require 'shipit/paginator'
 require 'shipit/null_serializer'
 require 'shipit/csv_serializer'

data/lib/shipit/task_commands.rb

@@ -52,6 +52,10 @@ module Shipit
       @stack_commands = StackCommands.new(@stack)
     end
 
+    def clear_working_directory
+      FileUtils.rm_rf(@task.working_directory) if deploy_spec.clear_working_directory?
+    end
+
     protected
 
     def steps_directory

data/lib/shipit/version.rb

@@ -1,3 +1,3 @@
 module Shipit
-  VERSION = '0.8.0'
+  VERSION = '0.8.1'
 end

data/test/jobs/perform_task_job_test.rb

@@ -19,7 +19,7 @@ module Shipit
       @commands.expects(:install_dependencies).returns([]).once
       @commands.expects(:perform).returns([]).once
 
-      @deploy.expects(:clear_working_directory)
+      @commands.expects(:clear_working_directory)
 
       @job.perform(@deploy)
     end
@@ -83,7 +83,7 @@ module Shipit
       @commands.stubs(:install_dependencies).returns([])
       @commands.stubs(:perform).returns([])
       DeployCommands.expects(:new).with(@deploy).returns(@commands)
-      @deploy.stubs(:clear_working_directory)
+      @commands.stubs(:clear_working_directory)
 
       @stack.update!(cached_deploy_spec: DeploySpec.new({}))
 

data/test/models/commit_deployment_test.rb

@@ -25,6 +25,7 @@ module Shipit
         'shopify/shipit-engine',
         pull_request_response.head.sha,
         auto_merge: false,
+        required_contexts: [],
         description: "Via Shipit",
         environment: @stack.environment,
       ).returns(deployment_response)

data/test/models/stacks_test.rb

@@ -19,6 +19,22 @@ module Shipit
       refute_predicate @stack, :valid?
     end
 
+    test "repo_owner and repo_name are case insensitive" do
+      assert_no_difference -> { Stack.count } do
+        error = assert_raises ActiveRecord::RecordInvalid do
+          Stack.create!(
+            repo_owner: @stack.repo_owner.upcase,
+            repo_name: @stack.repo_name.upcase,
+            environment: @stack.environment,
+          )
+        end
+        assert_equal 'Validation failed: Repo name has already been taken', error.message
+      end
+
+      new_stack = Stack.create!(repo_owner: 'FOO', repo_name: 'BAR')
+      assert_equal new_stack, Stack.find_by(repo_owner: 'foo', repo_name: 'bar')
+    end
+
     test "repo_owner is automatically downcased" do
       @stack.repo_owner = 'George'
       assert_equal 'george', @stack.repo_owner
@@ -360,5 +376,34 @@ module Shipit
         @stack.update(updated_at: Time.zone.now)
       end
     end
+
+    test "#merge_status returns locked if stack is locked" do
+      @stack.update!(lock_reason: 'Maintenance operation')
+      assert_equal 'locked', @stack.merge_status
+    end
+
+    test "#merge_status returns state of last finalized undeployed commit" do
+      @stack.deploys_and_rollbacks.destroy_all
+      shipit_commits(:fifth).statuses.destroy_all
+      shipit_commits(:fourth).statuses.update_all(state: 'pending')
+      shipit_commits(:third).statuses.update_all(state: 'success')
+      shipit_commits(:second).statuses.update_all(state: 'failure')
+
+      assert_equal 'success', @stack.merge_status
+    end
+
+    test "#merge_status returns pending if all undeployed commits are in pending or unknown state" do
+      shipit_commits(:fifth).statuses.destroy_all
+      shipit_commits(:fourth).statuses.update_all(state: 'pending')
+      @stack.expects(:last_deployed_commit).returns(shipit_commits(:third))
+
+      assert_equal 'pending', @stack.merge_status
+    end
+
+    test "#merge_status returns pending if there are no undeployed commits" do
+      @stack.expects(:last_deployed_commit).returns(shipit_commits(:fifth))
+
+      assert_equal 'pending', @stack.merge_status
+    end
   end
 end

data/test/models/status_test.rb

@@ -32,6 +32,15 @@ module Shipit
       assert_not_equal stack_last_updated_at, @stack.reload.updated_at
     end
 
+    test ".simple_state returns failure when status is error" do
+      assert_equal 'failure', Status.new(state: 'error').simple_state
+    end
+
+    test ".simple_state returns status when status is not error" do
+      assert_equal 'success', Status.new(state: 'success').simple_state
+      assert_equal 'failure', Status.new(state: 'failure').simple_state
+    end
+
     private
 
     def github_status

data/test/unit/deploy_commands_test.rb

@@ -12,6 +12,7 @@ module Shipit
         rollback_steps!: ['bundle exec cap $ENVIRONMENT deploy:rollback'],
         machine_env: {'GLOBAL' => '1'},
         directory: nil,
+        clear_working_directory?: true,
       )
       @commands.stubs(:deploy_spec).returns(@deploy_spec)
 
@@ -179,5 +180,16 @@ module Shipit
       command = @commands.install_dependencies.first
       assert_equal 'BAR', command.env['FOO']
     end
+
+    test "#clear_working_directory rm -rf the working directory" do
+      FileUtils.expects(:rm_rf).with(@deploy.working_directory)
+      @commands.clear_working_directory
+    end
+
+    test "#clear_working_directory is a noop if the deploy spec disabled cleanup" do
+      @deploy_spec.expects(:clear_working_directory?).returns(false)
+      FileUtils.expects(:rm_rf).never
+      @commands.clear_working_directory
+    end
   end
 end

data/test/unit/deploy_spec_test.rb

@@ -3,7 +3,8 @@ require 'test_helper'
 module Shipit
   class DeploySpecTest < ActiveSupport::TestCase
     setup do
-      @spec = DeploySpec::FileSystem.new('/tmp/', 'env')
+      @app_dir = '/tmp/'
+      @spec = DeploySpec::FileSystem.new(@app_dir, 'env')
       @spec.stubs(:load_config).returns({})
     end
 
@@ -37,8 +38,15 @@ module Shipit
 
     test '#dependencies_steps returns `bundle install` if a `Gemfile` is present' do
       @spec.expects(:bundler?).returns(true)
-      @spec.expects(:bundle_install).returns(:bundle_install)
-      assert_equal :bundle_install, @spec.dependencies_steps
+      @spec.expects(:bundle_install).returns(['bundle install'])
+      assert_equal ['bundle install'], @spec.dependencies_steps
+    end
+
+    test "#dependencies_steps prepend and append pre and post steps" do
+      @spec.stubs(:load_config).returns('dependencies' => {'pre' => ['before'], 'post' => ['after']})
+      @spec.expects(:bundler?).returns(true)
+      @spec.expects(:bundle_install).returns(['bundle install'])
+      assert_equal ['before', 'bundle install', 'after'], @spec.dependencies_steps
     end
 
     test '#fetch_deployed_revision_steps! is unknown by default' do
@@ -108,6 +116,13 @@ module Shipit
       assert_equal ['bundle exec cap $ENVIRONMENT deploy'], @spec.deploy_steps
     end
 
+    test "#deploy_steps prepend and append pre and post steps" do
+      @spec.stubs(:load_config).returns('deploy' => {'pre' => ['before'], 'post' => ['after']})
+      @spec.expects(:bundler?).returns(true)
+      @spec.expects(:capistrano?).returns(true)
+      assert_equal ['before', 'bundle exec cap $ENVIRONMENT deploy', 'after'], @spec.deploy_steps
+    end
+
     test '#deploy_steps raise a DeploySpec::Error! if it dont know how to deploy the app' do
       @spec.expects(:capistrano?).returns(false)
       assert_raise DeploySpec::Error do
@@ -126,6 +141,13 @@ module Shipit
       assert_equal ['bundle exec cap $ENVIRONMENT deploy:rollback'], @spec.rollback_steps
     end
 
+    test "#rollback_steps prepend and append pre and post steps" do
+      @spec.stubs(:load_config).returns('rollback' => {'pre' => ['before'], 'post' => ['after']})
+      @spec.expects(:bundler?).returns(true)
+      @spec.expects(:capistrano?).returns(true)
+      assert_equal ['before', 'bundle exec cap $ENVIRONMENT deploy:rollback', 'after'], @spec.rollback_steps
+    end
+
     test '#machine_env return an environment hash' do
       @spec.stubs(:load_config).returns('machine' => {'environment' => {'GLOBAL' => '1'}})
       assert_equal({'GLOBAL' => '1'}, @spec.machine_env)
@@ -136,7 +158,7 @@ module Shipit
       config.expects(:exist?).returns(true)
       config.expects(:read).returns({'dependencies' => {'override' => %w(foo bar baz)}}.to_yaml)
       spec = DeploySpec::FileSystem.new('.', 'staging')
-      spec.expects(:file).with('shipit.staging.yml').returns(config)
+      spec.expects(:file).with('shipit.staging.yml', root: true).returns(config)
       assert_equal %w(foo bar baz), spec.dependencies_steps
     end
 
@@ -149,8 +171,8 @@ module Shipit
       config.expects(:read).returns({'dependencies' => {'override' => %w(foo bar baz)}}.to_yaml)
 
       spec = DeploySpec::FileSystem.new('.', 'staging')
-      spec.expects(:file).with('shipit.staging.yml').returns(not_config)
-      spec.expects(:file).with('shipit.yml').returns(config)
+      spec.expects(:file).with('shipit.staging.yml', root: true).returns(not_config)
+      spec.expects(:file).with('shipit.yml', root: true).returns(config)
       assert_equal %w(foo bar baz), spec.dependencies_steps
     end
 
@@ -204,7 +226,7 @@ module Shipit
       assert_instance_of DeploySpec, @spec.cacheable
       config = {
         'ci' => {'hide' => [], 'allow_failures' => [], 'require' => []},
-        'machine' => {'environment' => {}, 'directory' => nil},
+        'machine' => {'environment' => {}, 'directory' => nil, 'cleanup' => true},
         'review' => {'checklist' => [], 'monitoring' => [], 'checks' => []},
         'dependencies' => {'override' => []},
         'plugins' => {},
@@ -315,5 +337,16 @@ module Shipit
       @spec.expects(:load_config).returns('ci' => {'hide' => %w(ci/circleci ci/jenkins)})
       assert_equal %w(ci/circleci ci/jenkins), @spec.hidden_statuses
     end
+
+    test "#file is impacted by `machine.directory`" do
+      subdir = '/foo/bar'
+      @spec.stubs(:load_config).returns('machine' => {'directory' => subdir})
+      assert_instance_of Pathname, @spec.file('baz')
+      assert_equal File.join(@app_dir, subdir, 'baz'), @spec.file('baz').to_s
+    end
+
+    test "#clear_working_directory? returns true by default" do
+      assert_predicate @spec, :clear_working_directory?
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shipit-engine
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.1
 platform: ruby
 authors:
 - Jean Boussier
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-04 00:00:00.000000000 Z
+date: 2016-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -599,7 +599,6 @@ files:
 - test/controllers/status_controller_test.rb
 - test/controllers/tasks_controller_test.rb
 - test/controllers/webhooks_controller_test.rb
-- test/dummy/README.rdoc
 - test/dummy/Rakefile
 - test/dummy/app/assets/javascripts/application.js
 - test/dummy/app/assets/stylesheets/application.css
@@ -807,7 +806,6 @@ test_files:
 - test/dummy/public/500.html
 - test/dummy/public/favicon.ico
 - test/dummy/Rakefile
-- test/dummy/README.rdoc
 - test/fixtures/payloads/push_master.json
 - test/fixtures/payloads/push_not_master.json
 - test/fixtures/payloads/status_master.json

data/test/dummy/README.rdoc

@@ -1,28 +0,0 @@
-== README
-
-This README would normally document whatever steps are necessary to get the
-application up and running.
-
-Things you may want to cover:
-
-* Ruby version
-
-* System dependencies
-
-* Configuration
-
-* Database creation
-
-* Database initialization
-
-* How to run the test suite
-
-* Services (job queues, cache servers, search engines, etc.)
-
-* Deployment instructions
-
-* ...
-
-
-Please feel free to use a different markup language if you do not plan to run
-<tt>rake doc:app</tt>.