shipit-engine 0.29.0 → 0.30.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 842f0db76bf2cd73d310aebd6b3abed371658c76731c383573e4a061de4e64bd
-  data.tar.gz: 2c640e960809d4a29d441f0bc20f2724d406f60d4f13573aad9f1b7d234b547e
+  metadata.gz: a26f88ecb6d3d82e4b537df7cab3cbdd615dc6e2d3663695e18301ccadecb350
+  data.tar.gz: d45d1e8cce82d0b3ec920429474deeae101ffe5bbc8d92272897be8bcef5ca4a
 SHA512:
-  metadata.gz: faaeb16d6eb385ab64d1035c6d1a08e4d6646482bf4e87bdfe1031edb2955e52a0daa73b1dc5757e6b9253d4c51c3538db7aca388eddc8c20f1b683ee5dcfa67
-  data.tar.gz: b31c919542c163a44dd30338acdfe19b61cdd5b3bac87a9b3ed87f57e3d0f0b82602869b681e59b5401d1206f8941b44a4599e4859745a6a1dda772fcd40d2d3
+  metadata.gz: 179ad0206a3ca03960bdcf444328a0b6c5c5bbc2ae314f7148365c78edb68380a3e804c6e757f08261f13ca24e0d9c604d0730e3f5c046d6fe2270264ea4195d
+  data.tar.gz: 52db719ed7037625ecec6bb5b31e1a87493cc595e4f8a2a14a65ef7708ca83bebf2193fe0fa82ea33ea9fa11027061f8fade805d4b24fa79c771c6f69ee5c322

data/README.md

@@ -35,7 +35,11 @@ This guide aims to help you [set up](#installation-and-setup), [use](#using-ship
 * [Configuring providers](#configuring-providers)
 * [Free samples](/examples/shipit.yml)
 
-**IV. CONTRIBUTING**
+**IV. INTERGRATING**
+
+* [Registering webhooks](#integrating-webhooks)
+
+**V. CONTRIBUTING**
 
 * [Instructions](#contributing-instructions)
 * [Local development](#contributing-local-dev)
@@ -634,7 +638,36 @@ For Kubernetes, you have to provision Shipit environment with the following tool
 * `kubectl`
 * `kubernetes-deploy` [gem](https://github.com/Shopify/kubernetes-deploy)
 
-<h2 id="contributing">IV. CONTRIBUTING</h2>
+<h2 id="integrating">IV. INTERGRATING</h2>
+
+<h3 id="integrating-webhooks">Registering webhooks</h3>
+
+Shipit handles several webhook types by default, listed in `Shipit::Wehbooks::DEFAULT_HANDLERS`, in order to implement default behaviours. Extra handler blocks can be registered via `Shipit::Webhooks.register_handler`. Valid handlers need only implement the `call` method - meaning any object which implements `call` - blocks, procs, or lambdas are valid. The webhooks controller will pass a `params` argument to the handler. Some examples:
+
+
+<h4>Registering a Plain old Ruby Object as a handler</h4>
+
+```ruby
+class PullRequestHandler
+  def call(params)
+    # do something with pull request webhook events
+  end
+end
+
+Shipit::Webhooks.register_handler('pull_request', PullRequestHandler)
+```
+
+<h4>Registering a Block as a handler</h4>
+
+```ruby
+Shipit::Webhooks.register_handler('pull_request') do |params|
+  # do something with pull request webhook events
+end
+```
+
+Multiple handler blocks can be registered. If any raise errors, execution will be halted and the request will be reported failed to github.
+
+<h2 id="contributing">V. CONTRIBUTING</h2>
 
 <h3 id="contributing-instructions">Instructions</h3>
 
@@ -657,3 +690,5 @@ Run `./bin/bootstrap` in order to bootstrap the dummy application. The bootstrap
 Run `./test/dummy/bin/rails server` to run the rails dummy application.
 
 Set the environment variable `SHIPIT_DISABLE_AUTH=1` in order to disable authentication.
+
+If you need to test caching behaviour in the dummy application, use `bin/rails dev:cache`.

data/app/assets/images/archive-solid.svg

@@ -0,0 +1 @@
+<svg aria-hidden="true" focusable="false" data-prefix="fas" data-icon="archive" class="svg-inline--fa fa-archive fa-w-16" role="img" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><path fill="currentColor" d="M32 448c0 17.7 14.3 32 32 32h384c17.7 0 32-14.3 32-32V160H32v288zm160-212c0-6.6 5.4-12 12-12h104c6.6 0 12 5.4 12 12v8c0 6.6-5.4 12-12 12H204c-6.6 0-12-5.4-12-12v-8zM480 32H32C14.3 32 0 46.3 0 64v48c0 8.8 7.2 16 16 16h480c8.8 0 16-7.2 16-16V64c0-17.7-14.3-32-32-32z"></path></svg>

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

@@ -49,6 +49,15 @@
       padding-left: 30px;
       margin-left: -30px;
     }
+    .archived {
+      // From FontAwesome, license @ https://fontawesome.com/license/free
+      background-image: asset-data-url('archive-solid.svg');
+      background-repeat: no-repeat;
+      background-size: 22px 22px;
+      background-position: 0px center;
+      padding-left: 30px;
+      margin-left: -30px;
+    }
 }
 
 .stack-lst:empty:before {
@@ -161,3 +170,70 @@
 .pagination {
   text-align: center;
 }
+
+.box {
+  border-radius: 5px;
+  width: 32%;
+  float: left;
+  padding: 5px;
+}
+
+.box__header {
+  padding: 15px 25px;
+  position: relative;
+}
+
+.box__header-title {
+  color: #333;
+  font-size: 18px;
+}
+
+.box__body {
+  padding: 0 25px;
+}
+
+.row {
+  @include clearfix;
+}
+
+/* STATS */
+
+.stats {
+  color: #333;
+  position: relative;
+  padding-bottom: 25px;
+}
+
+.stats__amount {
+  font-size: 54px;
+  line-height: 1.2;
+}
+
+.stats__caption {
+  font-size: 18px;
+
+}
+
+.stats__change {
+  position: absolute;
+  top: 10px;
+  right: 0;
+  text-align: right;
+  color: #B1B7C8;
+}
+
+.stats__value {
+  font-size: 18px;
+}
+
+.stats__period {
+  font-size: 14px;
+}
+
+.stats__value--positive {
+  color: #AEDC6F;
+}
+
+.stats__value--negative {
+  color: #FB5055;
+}

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

@@ -18,7 +18,10 @@ module Shipit
         accepts :merge_queue_enabled, Boolean
       end
       def create
-        render_resource Stack.create(params)
+        stack = Stack.new(create_params)
+        stack.repository = repository
+        stack.save
+        render_resource stack
       end
 
       def show
@@ -32,9 +35,25 @@ module Shipit
 
       private
 
+      def create_params
+        params.reject { |key, _| %i(repo_owner repo_name).include?(key) }
+      end
+
       def stack
         @stack ||= stacks.from_param!(params[:id])
       end
+
+      def repository
+        @repository ||= Repository.find_or_create_by(owner: repo_owner, name: repo_name)
+      end
+
+      def repo_owner
+        params[:repo_owner]
+      end
+
+      def repo_name
+        params[:repo_name]
+      end
     end
   end
 end

data/app/controllers/shipit/api_clients_controller.rb

@@ -0,0 +1,49 @@
+module Shipit
+  class ApiClientsController < ShipitController
+    include Pagination
+
+    def index
+      paginator = paginate(ApiClient.order(created_at: :desc).all)
+      @api_clients = paginator.to_a
+      @links = paginator.links
+    end
+
+    def new
+      @api_client = ApiClient.new
+    end
+
+    def create
+      @api_client = ApiClient.new(create_params.merge(creator_id: current_user.id))
+      unless @api_client.save
+        flash[:warning] = @api_client.errors.full_messages.to_sentence
+      end
+
+      respond_with(@api_client)
+    end
+
+    def show
+      @api_client = ApiClient.find(params[:id])
+    end
+
+    def update
+      @api_client = ApiClient.find(params[:id])
+      options = if @api_client.update(update_params)
+        {flash: {success: 'Successfully updated'}}
+      else
+        {flash: {warning: @stack.errors.full_messages.to_sentence}}
+                end
+
+      redirect_to(params[:return_to].presence || api_client_path(@api_client), options)
+    end
+
+    private
+
+    def create_params
+      params.require(:api_client).permit(:name, permissions: [])
+    end
+
+    def update_params
+      params.require(:api_client).permit(permissions: [])
+    end
+  end
+end

data/app/controllers/shipit/merge_status_controller.rb

@@ -60,10 +60,14 @@ module Shipit
       @stack ||= if params[:stack_id]
         Stack.from_param!(params[:stack_id])
       else
-        scope = Stack.order(merge_queue_enabled: :desc, id: :asc).where(
-          repo_owner: referrer_parser.repo_owner,
-          repo_name: referrer_parser.repo_name,
-        )
+        # Null ordering is inconsistent across DBMS's, this case statement is ugly but supported universally
+        scope = Stack.order(Arel.sql('CASE WHEN locked_since IS NULL THEN 1 ELSE 0 END, locked_since'))
+                     .order(merge_queue_enabled: :desc, id: :asc).includes(:repository).where(
+                       repositories: {
+                         owner: referrer_parser.repo_owner,
+                         name: referrer_parser.repo_name,
+                       },
+                     )
         scope = if params[:branch]
           scope.where(branch: params[:branch])
         else

data/app/controllers/shipit/stacks_controller.rb

@@ -1,6 +1,6 @@
 module Shipit
   class StacksController < ShipitController
-    before_action :load_stack, only: %i(update destroy settings clear_git_cache refresh)
+    before_action :load_stack, only: %i(update destroy settings statistics clear_git_cache refresh)
 
     def new
       @stack = Stack.new
@@ -9,7 +9,12 @@ module Shipit
     def index
       @user_stacks = current_user.stacks_contributed_to
 
-      @stacks = Stack.order(Arel.sql('(undeployed_commits_count > 0) desc'), tasks_count: :desc).to_a
+      @stacks = Stack.order(Arel.sql('(undeployed_commits_count > 0) desc'), tasks_count: :desc)
+
+      @show_archived = params[:show_archived]
+      @stacks = @stacks.not_archived unless @show_archived
+
+      @stacks = @stacks.to_a
     end
 
     def show
@@ -48,6 +53,7 @@ module Shipit
 
     def create
       @stack = Stack.new(create_params)
+      @stack.repository = repository
       unless @stack.save
         flash[:warning] = @stack.errors.full_messages.to_sentence
       end
@@ -62,6 +68,16 @@ module Shipit
     def settings
     end
 
+    def statistics
+      previous_deploy_stats = Shipit::DeployStats.new(@stack.deploys.not_active.previous_seven_days)
+      @deploy_stats = Shipit::DeployStats.new(@stack.deploys.not_active.last_seven_days)
+      if @deploy_stats.empty?
+        flash[:warning] = 'Statistics not available without previous deploys'
+        return redirect_to stack_path(@stack)
+      end
+      @diffs = @deploy_stats.compare(previous_deploy_stats)
+    end
+
     def refresh
       RefreshStatusesJob.perform_later(stack_id: @stack.id)
       RefreshCheckRunsJob.perform_later(stack_id: @stack.id)
@@ -76,12 +92,8 @@ module Shipit
         options = {flash: {warning: @stack.errors.full_messages.to_sentence}}
       end
 
-      reason = params[:stack][:lock_reason]
-      if reason.present?
-        @stack.lock(reason, current_user)
-      elsif @stack.locked?
-        @stack.unlock
-      end
+      update_lock
+      update_archived
 
       redirect_to(params[:return_to].presence || stack_settings_path(@stack), options)
     end
@@ -94,6 +106,27 @@ module Shipit
 
     private
 
+    def update_lock
+      if params[:stack].key?(:lock_reason)
+        reason = params[:stack][:lock_reason]
+        if reason.present?
+          @stack.lock(reason, current_user)
+        elsif @stack.locked?
+          @stack.unlock
+        end
+      end
+    end
+
+    def update_archived
+      if params[:stack][:archived].present?
+        if params[:stack][:archived] == "true"
+          @stack.archive!(current_user)
+        elsif @stack.archived?
+          @stack.unarchive!
+        end
+      end
+    end
+
     def map_to_undeployed_commit(commits, next_expected_commit_to_deploy:)
       commits.map.with_index do |c, i|
         index = commits.size - i - 1
@@ -106,7 +139,7 @@ module Shipit
     end
 
     def create_params
-      params.require(:stack).permit(:repo_name, :repo_owner, :environment, :branch, :deploy_url, :ignore_ci)
+      params.require(:stack).permit(:environment, :branch, :deploy_url, :ignore_ci)
     end
 
     def update_params
@@ -118,5 +151,21 @@ module Shipit
         :merge_queue_enabled,
       )
     end
+
+    def repository
+      @repository ||= Repository.find_or_create_by(owner: repo_owner, name: repo_name)
+    end
+
+    def repo_owner
+      repository_params[:repo_owner]
+    end
+
+    def repo_name
+      repository_params[:repo_name]
+    end
+
+    def repository_params
+      params.require(:stack).permit(:repo_owner, :repo_name)
+    end
   end
 end

data/app/controllers/shipit/webhooks_controller.rb

@@ -5,137 +5,9 @@ module Shipit
 
     respond_to :json
 
-    class Handler
-      class << self
-        attr_reader :param_parser
-
-        def params(&block)
-          @param_parser = ExplicitParameters::Parameters.define(&block)
-        end
-      end
-
-      attr_reader :params, :payload
-
-      def initialize(payload)
-        @payload = payload
-        @params = self.class.param_parser.parse!(payload)
-      end
-
-      def process
-        raise NotImplementedError
-      end
-
-      private
-
-      def stacks
-        @stacks ||= Stack.repo(repository_name)
-      end
-
-      def repository_name
-        payload.dig('repository', 'full_name')
-      end
-    end
-
-    class PushHandler < Handler
-      params do
-        requires :ref
-      end
-      def process
-        stacks.where(branch: branch).each(&:sync_github)
-      end
-
-      private
-
-      def branch
-        params.ref.gsub('refs/heads/', '')
-      end
-    end
-
-    class StatusHandler < Handler
-      params do
-        requires :sha, String
-        requires :state, String
-        accepts :description, String
-        accepts :target_url, String
-        accepts :context, String
-        accepts :created_at, String
-
-        accepts :branches, Array do
-          requires :name, String
-        end
-      end
-      def process
-        Commit.where(sha: params.sha).each do |commit|
-          commit.create_status_from_github!(params)
-        end
-      end
-    end
-
-    class CheckSuiteHandler < Handler
-      params do
-        requires :check_suite do
-          requires :head_sha, String
-          requires :head_branch, String
-        end
-      end
-      def process
-        stacks.where(branch: params.check_suite.head_branch).each do |stack|
-          stack.commits.where(sha: params.check_suite.head_sha).each(&:schedule_refresh_check_runs!)
-        end
-      end
-    end
-
-    class MembershipHandler < Handler
-      params do
-        requires :action, String
-        requires :team do
-          requires :id, Integer
-          requires :name, String
-          requires :slug, String
-          requires :url, String
-        end
-        requires :organization do
-          requires :login, String
-        end
-        requires :member do
-          requires :login, String
-        end
-      end
-      def process
-        team = find_or_create_team!
-        member = User.find_or_create_by_login!(params.member.login)
-
-        case params.action
-        when 'added'
-          team.add_member(member)
-        when 'removed'
-          team.members.delete(member)
-        else
-          raise ArgumentError, "Don't know how to perform action: `#{action.inspect}`"
-        end
-      end
-
-      private
-
-      def find_or_create_team!
-        Team.find_or_create_by!(github_id: params.team.id) do |team|
-          team.github_team = params.team
-          team.organization = params.organization.login
-        end
-      end
-    end
-
-    HANDLERS = {
-      'push' => PushHandler,
-      'status' => StatusHandler,
-      'membership' => MembershipHandler,
-      'check_suite' => CheckSuiteHandler,
-    }.freeze
-
     def create
-      if handler = HANDLERS[event]
-        handler.new(JSON.parse(request.raw_post)).process
-      end
+      params = JSON.parse(request.raw_post)
+      Shipit::Webhooks.for_event(event).each { |handler| handler.call(params) }
 
       head :ok
     end