shipit-engine 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 13126d19eca4966f56856152cf632751bf1ba9d1
-  data.tar.gz: 665a8bce4eb15e193e55b0da971a5840b7888bf6
+  metadata.gz: d3b3153e7b24f260f276933b246bca9d9bc2ebdd
+  data.tar.gz: 93ca93e3b0d8347a453979039c8cb16159ed044c
 SHA512:
-  metadata.gz: 87cf3290c48593691fec2c278607cc1783206af426ca3dbefcab269b639614d98e5e8632cd1bc4fa27842f70615886f9b7c3914191d99dfc8168d43ab61ffcae
-  data.tar.gz: 12077a22444887bb58eb55faed2b395e257d97f2a762fc64164ef216b61921c6606d8261de6f202192324b17e461e4b3c9f008d4278503c7631a41513a309ce2
+  metadata.gz: 7adfee4675b580ed2eba9e0f5057ba4647d51c9ce2b604ccfb598afbdbd9d8601841689e746de78d879975994d3b54eab450d8f0e11400774272702c9d6b399e
+  data.tar.gz: 1cb49f0e1c633f95cf293b9df55314bc6f800920b59308cbcebb58aeaa56d236877762d74410b8f1088d85d651db8b0eb59b3b26a4750c2f3e5c2eb13d2896f9

data/README.md

@@ -125,6 +125,10 @@ The settings in the `shipit.yml` file relate to the different things you can do
 
 All the settings in `shipit.yml` are optional. Most applications can be deployed from Shipit without any configuration.
 
+Aslo, if your repository is deployed different ways depending on the environment, you can have alternative `shipit.yml` by including the environment name.
+
+For example for a stack like: `my-org/my-repo/staging`, `shipit.staging.yml` will have priority over `shipit.yml`.
+
 * * *
 
 <h3 id="installing-dependencies">Installing dependencies</h3>
@@ -183,6 +187,22 @@ deploy:
 ```
 <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.
+
+For example:
+
+```yaml
+deploy:
+  variables:
+    -
+      name: RUN_MIGRATIONS
+      title: Run database migrations on deploy
+      default: 1
+```
+<br>
+
 **<code>rollback.override</code>** contains an array of the shell commands required to rollback the application to a previous state. Shipit will try to infer it from the repository structure, but you can change the default inference. This key defaults to disabled unless Capistrano is detected.
 
 For example:
@@ -255,6 +275,33 @@ tasks:
       - ssh deploy@myserver.example.com 'touch myapp/restart.txt'
 ```
 
+By default custom tasks are not allowed to be triggered while a deploy is running. But if it's safe for that specific task you can change that behavior with the `allow_concurrency` attribute:
+
+```yml
+tasks:
+  flush_cache:
+    action: "Flush Cache"
+    steps:
+      - ssh deploy@myserver.example.com 'myapp/flush_cache.sh'
+    allow_concurrency: true
+```
+
+Tasks like deploys can prompt for user defined environment variables:
+
+```yml
+tasks:
+  restart:
+    action: "Restart Application"
+    description: "Sometimes needed if you the application to restart but don't want to ship any new code."
+    steps:
+      - ssh deploy@myserver.example.com 'touch myapp/restart.txt'
+    variables:
+      -
+        name: FORCE
+        title: Restart server without waiting for in-flight requests to complete (Dangerous).
+        default: 0
+```
+
 <h3 id="review-process">Review process</h3>
 
 You can display review elements, such as monitoring data or a pre-deployment checklist, on the deployment page in Shipit:
@@ -267,7 +314,7 @@ For example:
 review:
   checklist:
     - >
-    Do you know if it is safe to revert the code being shipped? What happens if we need to undo this deploy?
+      Do you know if it is safe to revert the code being shipped? What happens if we need to undo this deploy?
     - Has the Docs team been notified of any major changes to the app?
     - Is the app stable right now?
 ```
@@ -381,7 +428,8 @@ Your deploy scripts have access to the following environment variables:
 * `SHIPIT_LINK`: URL to the task output, usefull to broadcast it in an IRC channel
 * `USER`: Full name of the user that triggered the deploy/task
 * `EMAIL`: Email of the user that triggered the deploy/task (if available)
-* `ENVIRONMENT`: The stack environment (e.g production / staging)
+* `ENVIRONMENT`: The stack environment (e.g `production` / `staging`)
+* `BRANCH`: The stack branch (e.g `master`)
 * `LAST_DEPLOYED_SHA`: The git SHA of the last deployed commit
 * All the content of the `secrets.yml` `env` key
 * All the content of the `shipit.yml` `machine.environment` key

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

@@ -9,11 +9,12 @@
   display: flex;
 }
 
-.environment-variables {
+.variables-header {
   margin: 1rem 0;
+  padding-top: 1rem;
 }
 
-.environment-variable {
+.variables-fields {
   input {
     display: inline-block;
     width: inherit;

data/app/controllers/shipit/api/base_controller.rb

@@ -7,6 +7,7 @@ module Shipit
       include Paginable
 
       rescue_from ApiClient::InsufficientPermission, with: :insufficient_permission
+      rescue_from EnvironmentVariables::NotPermitted, with: :validation_error
       rescue_from TaskDefinition::NotFound, with: :not_found
 
       class << self
@@ -60,6 +61,10 @@ module Shipit
         render status: :forbidden, json: {message: error.message}
       end
 
+      def validation_error(error)
+        render status: :unprocessable_entity, json: {message: error.message}
+      end
+
       def not_found(_error)
         render status: :not_found, json: {status: '404', error: 'Not Found'}
       end

data/app/controllers/shipit/api/deploys_controller.rb

@@ -6,11 +6,12 @@ module Shipit
       params do
         requires :sha, String, length: {in: 6..40}
         accepts :force, Boolean, default: false
+        accepts :env, Hash, default: {}
       end
       def create
         commit = stack.commits.by_sha(params.sha) || param_error!(:sha, 'Unknown revision')
         param_error!(:force, "Can't deploy a locked stack") if !params.force && stack.locked?
-        render_resource stack.trigger_deploy(commit, current_user), status: :accepted
+        render_resource stack.trigger_deploy(commit, current_user, env: params.env), status: :accepted
       end
     end
   end

data/app/controllers/shipit/api/tasks_controller.rb

@@ -12,8 +12,11 @@ module Shipit
         render_resource stack.tasks.find(params[:id])
       end
 
+      params do
+        accepts :env, Hash, default: {}
+      end
       def trigger
-        render_resource stack.trigger_task(params[:task_name], current_user), status: :accepted
+        render_resource stack.trigger_task(params[:task_name], current_user, env: params.env), status: :accepted
       end
     end
   end

data/app/controllers/shipit/deploys_controller.rb

@@ -16,7 +16,7 @@ module Shipit
     end
 
     def create
-      return redirect_to new_stack_deploy_path(@stack, sha: @until_commit.sha) if !params[:force] && @stack.deploying?
+      return redirect_to new_stack_deploy_path(@stack, sha: @until_commit.sha) if !params[:force] && @stack.active_task?
 
       @deploy = @stack.trigger_deploy(@until_commit, current_user, env: deploy_params[:env])
       respond_with(@deploy.stack, @deploy)

data/app/controllers/shipit/github_authentication_controller.rb

@@ -9,6 +9,7 @@ module Shipit
       return render 'failed', layout: false if auth.blank?
 
       session[:user_id] = sign_in_github(auth)
+
       redirect_to return_url
     end
 
@@ -20,8 +21,9 @@ module Shipit
     private
 
     def sign_in_github(auth)
-      user = Shipit.github_api.user(auth[:info][:nickname])
-      User.find_or_create_from_github(user).id
+      user = User.find_or_create_from_github(auth.extra.raw_info)
+      user.update(github_access_token: auth.credentials.token)
+      user.id
     end
   end
 end

data/app/controllers/shipit/rollbacks_controller.rb

@@ -4,7 +4,7 @@ module Shipit
     before_action :load_deploy
 
     def create
-      return redirect_to rollback_stack_deploy_path(@stack, @deploy) if !params[:force] && @stack.deploying?
+      return redirect_to rollback_stack_deploy_path(@stack, @deploy) if !params[:force] && @stack.active_task?
       @rollback = @deploy.trigger_rollback(current_user, env: rollback_params[:env])
       redirect_to stack_deploy_path(@stack, @rollback)
     end

data/app/controllers/shipit/tasks_controller.rb

@@ -22,8 +22,14 @@ module Shipit
     end
 
     def create
-      @task = stack.trigger_task(params[:definition_id], current_user)
-      redirect_to [stack, @task]
+      @definition = stack.find_task_definition(params[:definition_id])
+
+      if @definition.allow_concurrency? || params[:force] || !@stack.active_task?
+        @task = stack.trigger_task(params[:definition_id], current_user, env: task_params[:env])
+        redirect_to [stack, @task]
+      else
+        redirect_to new_stack_tasks_path(stack, @definition)
+      end
     end
 
     def abort
@@ -44,5 +50,11 @@ module Shipit
     def stack
       @stack ||= Stack.from_param!(params[:stack_id])
     end
+
+    def task_params
+      return {} unless params[:task]
+      @definition = stack.find_task_definition(params[:definition_id])
+      @task_params ||= params.require(:task).permit(env: @definition.variables.map(&:name))
+    end
   end
 end

data/app/helpers/shipit/github_url_helper.rb

@@ -1,5 +1,7 @@
 module Shipit
   module GithubUrlHelper
+    private
+
     def github_avatar(user, options = {})
       uri = user.avatar_uri
       attributes = options.slice(:class).merge(alt: user.try!(:name))
@@ -35,8 +37,8 @@ module Shipit
       github_repo_url(commit.stack.repo_owner, commit.stack.repo_name, 'commit', commit.sha)
     end
 
-    def github_diff_url(owner, repo, from_sha, to_sha)
-      github_repo_url(owner, repo, 'compare', "#{from_sha}...#{to_sha}")
+    def github_pull_request_url(commit)
+      github_repo_url(commit.stack.repo_owner, commit.stack.repo_name, 'pull', commit.pull_request_number)
     end
 
     def link_to_github_deploy(deploy)

data/app/helpers/shipit/stacks_helper.rb

@@ -12,7 +12,7 @@ module Shipit
 
       caption = 'Redeploy'
       caption = 'Locked' if commit.stack.locked? && !ignore_lock?
-      caption = 'Deploy in progress...' if commit.stack.deploying?
+      caption = 'Deploy in progress...' if commit.stack.active_task?
 
       link_to(caption, url, class: classes)
     end
@@ -53,7 +53,7 @@ module Shipit
     end
 
     def pull_request_link(commit)
-      link_to("##{commit.pull_request_id}", commit.pull_request_url, target: '_blank', class: 'number')
+      link_to("##{commit.pull_request_number}", commit.pull_request_url, target: '_blank', class: 'number')
     end
 
     def render_raw_commit_id_link(commit)
@@ -70,7 +70,7 @@ module Shipit
       state = commit.status.state
       state = 'locked' if commit.stack.locked? && !ignore_lock?
       if commit.deployable?
-        state = commit.stack.deploying? ? 'deploying' : 'enabled'
+        state = commit.stack.active_task? ? 'deploying' : 'enabled'
       end
       t("deploy_button.caption.#{state}")
     end

data/app/jobs/shipit/continuous_delivery_job.rb

@@ -0,0 +1,12 @@
+module Shipit
+  class ContinuousDeliveryJob < BackgroundJob
+    include BackgroundJob::Unique
+
+    queue_as :default
+
+    def perform(stack)
+      return unless stack.continuous_deployment?
+      stack.trigger_continuous_deploy
+    end
+  end
+end

data/app/jobs/shipit/create_on_github_job.rb

@@ -0,0 +1,11 @@
+module Shipit
+  class CreateOnGithubJob < BackgroundJob
+    include BackgroundJob::Unique
+
+    queue_as :default
+
+    def perform(record)
+      record.create_on_github!
+    end
+  end
+end

data/app/jobs/shipit/fetch_deployed_revision_job.rb

@@ -3,7 +3,7 @@ module Shipit
     queue_as :default
 
     def perform(stack)
-      return if stack.deploying?
+      return if stack.active_task?
 
       commands = StackCommands.new(stack)
 

data/app/models/shipit/anonymous_user.rb

@@ -39,5 +39,9 @@ module Shipit
     def read_attribute_for_serialization(attr)
       public_send(attr)
     end
+
+    def github_api
+      Shipit.github_api
+    end
   end
 end

data/app/models/shipit/commit.rb

@@ -117,10 +117,10 @@ module Shipit
     end
 
     def pull_request_url
-      parsed && Shipit.github_url("/#{stack.repo_owner}/#{stack.repo_name}/pull/#{pull_request_id}")
+      parsed && Shipit.github_url("/#{stack.repo_owner}/#{stack.repo_name}/pull/#{pull_request_number}")
     end
 
-    def pull_request_id
+    def pull_request_number
       parsed && parsed['pr_id'].to_i
     end
 
@@ -141,10 +141,8 @@ module Shipit
     end
 
     def schedule_continuous_delivery
-      return unless state == 'success' && stack.continuous_deployment?
-      return unless stack.deployable?
-      return if already_deployed?
-      stack.trigger_deploy(self, committer)
+      return unless state == 'success' && stack.continuous_deployment? && stack.deployable?
+      ContinuousDeliveryJob.perform_later(stack)
     end
 
     def github_commit
@@ -188,6 +186,10 @@ module Shipit
       non_success_statuses.reject(&:pending?).first || non_success_statuses.first || UnknownStatus.new(self)
     end
 
+    def deployed?
+      stack.last_deployed_commit.id >= id
+    end
+
     private
 
     def missing_statuses
@@ -198,10 +200,6 @@ module Shipit
       stack.touch
     end
 
-    def already_deployed?
-      stack.last_deployed_commit.id >= id
-    end
-
     def simple_state(status)
       status.state == 'error' ? 'failure' : status.state
     end

data/app/models/shipit/commit_deployment.rb

@@ -0,0 +1,56 @@
+module Shipit
+  class CommitDeployment < ActiveRecord::Base
+    belongs_to :commit
+    belongs_to :task
+    has_many :statuses, class_name: 'CommitDeploymentStatus'
+
+    after_commit :schedule_create_on_github, on: :create
+
+    delegate :stack, :author, to: :task
+
+    def create_on_github!
+      return unless commit.pull_request?
+
+      create_deployment_on_github!
+      statuses.order(id: :asc).each(&:create_on_github!)
+    end
+
+    def create_deployment_on_github!
+      return if github_id?
+
+      response = begin
+        create_deployment_on_github(author.github_api)
+      rescue Octokit::NotFound, Octokit::Forbidden
+        raise if Shipit.github_api == author.github_api
+        # If the deploy author didn't gave us the permission to create the deployment we falback the the main shipit
+        # user.
+        #
+        # Octokit currently raise NotFound, but I'm convinced it should be Forbidden if the user can see the repository.
+        # So to be future proof I catch boths.
+        create_deployment_on_github(Shipit.github_api)
+      end
+      update!(github_id: response.id, api_url: response.url)
+    end
+
+    def pull_request_head
+      pull_request = Shipit.github_api.pull_request(stack.github_repo_name, commit.pull_request_number)
+      pull_request.head.sha
+    end
+
+    def schedule_create_on_github
+      CreateOnGithubJob.perform_later(self)
+    end
+
+    private
+
+    def create_deployment_on_github(client)
+      client.create_deployment(
+        stack.github_repo_name,
+        pull_request_head,
+        auto_merge: false,
+        description: "Via Shipit",
+        environment: stack.environment,
+      )
+    end
+  end
+end

data/app/models/shipit/commit_deployment_status.rb

@@ -0,0 +1,57 @@
+module Shipit
+  class CommitDeploymentStatus < ActiveRecord::Base
+    belongs_to :commit_deployment
+
+    after_commit :schedule_create_on_github, on: :create
+
+    delegate :stack, :task, :author, to: :commit_deployment
+
+    def create_on_github!
+      return if github_id?
+      response = begin
+        create_status_on_github(author.github_api)
+      rescue Octokit::NotFound, Octokit::Forbidden
+        raise if Shipit.github_api == author.github_api
+        # If the deploy author didn't gave us the permission to create the deployment we falback the the main shipit
+        # user.
+        #
+        # Octokit currently raise NotFound, but I'm convinced it should be Forbidden if the user can see the repository.
+        # So to be future proof I catch boths.
+        create_status_on_github(Shipit.github_api)
+      end
+      update!(github_id: response.id, api_url: response.url)
+    end
+
+    def description
+      I18n.t(
+        "deployment_description.#{task_type}.#{status}",
+        sha: task.until_commit.sha,
+        author: task.author.login,
+        stack: stack.to_param,
+      )
+    end
+
+    def task_type
+      task.class.name.demodulize.underscore
+    end
+
+    def schedule_create_on_github
+      CreateOnGithubJob.perform_later(commit_deployment)
+    end
+
+    private
+
+    def create_status_on_github(client)
+      client.create_deployment_status(
+        commit_deployment.api_url,
+        status,
+        target_url: url_helpers.stack_deploy_url(stack, task),
+        description: description,
+      )
+    end
+
+    def url_helpers
+      Engine.routes.url_helpers
+    end
+  end
+end