shipit-engine 0.36.1 → 0.38.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 17cf66ed4359907e35e37a0ac00bcb05884c24148386bf8712d8b73c3cc33708
-  data.tar.gz: b21d35454c554c7faccad5236333cefc3270434617e4bd192372c0a8baa66ac1
+  metadata.gz: f671228679f81a64a70284699951ea5cc8fce83e82a56263cf6a4f52055f5976
+  data.tar.gz: 0d795762874714a9d592edb0dd3fd1b599f1819edc06d1085252a9e26ef0073b
 SHA512:
-  metadata.gz: 1f8e6ba6aaaa5eaa4630cfb52a1445e416e4cb6566550c4a5e2ec447065b2d342c52a728b370552a8b7a2a7df8061c30b0d4987d637729d533fd1bfd907a074a
-  data.tar.gz: 94abc1c12513349c85d4d54c4668865f21a42bf055d630fca667fd636dd7119b42f31c11f5c2182f2412ed76601adecce38b096a1add9e978dd83279b600d7fb
+  metadata.gz: 6c55d8a3f3ab16affd874abd8c15e51c19a29e81ddb3131a4695d9ca2ba409e312e40892ddbd66ec6bca32ce403254f02de632dbab06a97306c6a0da5e684c2e
+  data.tar.gz: fd7b4ad69bd0b03a486a38a4ce2dcf0802581aee836e44f1390f362aeace5b1fbb30f24bd3a5579da89e0bfca8f588ed16d121e9be7a4afd7f7f1efda208a97f

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

@@ -46,9 +46,13 @@ module Shipit
         accepts :ignore_ci, Boolean
         accepts :merge_queue_enabled, Boolean
         accepts :continuous_deployment, Boolean
+        accepts :archived, Boolean
       end
       def update
-        stack.update(params)
+        stack.update(update_params)
+
+        update_archived
+
         render_resource(stack)
       end
 
@@ -62,6 +66,8 @@ module Shipit
       end
 
       def refresh
+        RefreshStatusesJob.perform_later(stack_id: stack.id)
+        RefreshCheckRunsJob.perform_later(stack_id: stack.id)
         GithubSyncJob.perform_later(stack_id: stack.id)
         render_resource(stack, status: :accepted)
       end
@@ -76,6 +82,26 @@ module Shipit
         @stack ||= stacks.from_param!(params[:id])
       end
 
+      def update_archived
+        if key?(:archived)
+          if params[:archived]
+            stack.archive!(nil)
+          elsif stack.archived?
+            stack.unarchive!
+          end
+        end
+      end
+
+      def key?(key)
+        params.to_h.key?(key)
+      end
+
+      def update_params
+        params.select do |key, _|
+          %i(environment branch deploy_url ignore_ci merge_queue_enabled continuous_deployment).include?(key)
+        end
+      end
+
       def repository
         @repository ||= Repository.find_or_create_by(owner: repo_owner, name: repo_name)
       end

data/app/helpers/shipit/api_clients_helper.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+module Shipit
+  module ApiClientsHelper
+    def api_client_token(api_client)
+      if api_client.created_at >= 5.minutes.ago && current_user == api_client.creator
+        api_client.authentication_token
+      else
+        "#{api_client.authentication_token[0..5]}************************"
+      end
+    end
+  end
+end

data/app/jobs/shipit/continuous_delivery_job.rb

@@ -8,7 +8,10 @@ module Shipit
 
     def perform(stack)
       return unless stack.continuous_deployment?
-      return if stack.active_task?
+
+      # checks if there are any tasks running, including concurrent tasks
+      return if stack.occupied?
+
       stack.trigger_continuous_delivery
     end
   end

data/app/models/shipit/stack.rb

@@ -453,6 +453,14 @@ module Shipit
       @active_task ||= tasks.current
     end
 
+    def occupied?
+      !!occupied
+    end
+
+    def occupied
+      @occupied ||= tasks.active.last
+    end
+
     def locked?
       lock_reason.present?
     end

data/app/models/shipit/task_execution_strategy/default.rb

@@ -70,7 +70,7 @@ module Shipit
           @task.acquire_git_cache_lock do
             @task.ping
             unless @commands.fetched?(@task.until_commit).tap(&:run).success?
-              capture!(@commands.fetch)
+              capture!(@commands.fetch_commit(@task.until_commit))
             end
           end
         end

data/app/views/shipit/api_clients/show.html.erb

@@ -10,7 +10,7 @@
   <section>
     <h3>Authentication token:</h3>
     <code style="background-color: yellow">
-      <b><%= @api_client.authentication_token %></b>
+      <b><%= api_client_token(@api_client) %></b>
     </code>
   </section>
 

data/db/migrate/20230703181143_change_commit_deployment_statuses_github_id_to_big_int.rb

@@ -0,0 +1,5 @@
+class ChangeCommitDeploymentStatusesGithubIdToBigInt < ActiveRecord::Migration[7.0]
+  def change
+    change_column :commit_deployment_statuses, :github_id, :bigint
+  end
+end

data/lib/shipit/octokit_iterator.rb

@@ -16,6 +16,8 @@ module Shipit
       response = @response
 
       loop do
+        return unless response.present?
+
         response.data.each(&block)
         return unless response.rels[:next]
         response = response.rels[:next].get

data/lib/shipit/stack_commands.rb

@@ -13,6 +13,16 @@ module Shipit
       super.merge(@stack.env)
     end
 
+    def fetch_commit(commit)
+      create_directories
+      if valid_git_repository?(@stack.git_path)
+        git('fetch', 'origin', '--quiet', '--tags', commit.sha, env: env, chdir: @stack.git_path)
+      else
+        @stack.clear_git_cache!
+        git_clone(@stack.repo_git_url, @stack.git_path, branch: @stack.branch, env: env, chdir: @stack.deploys_path)
+      end
+    end
+
     def fetch
       create_directories
       if valid_git_repository?(@stack.git_path)
@@ -72,7 +82,14 @@ module Shipit
         ).run!
 
         git_dir = File.join(dir, @stack.repo_name)
-        git('-c', 'advice.detachedHead=false', 'checkout', commit.sha, chdir: git_dir).run! if commit
+        git(
+          '-c',
+          'advice.detachedHead=false',
+          'checkout',
+          '--quiet',
+          commit.sha,
+          chdir: git_dir
+        ).run! if commit
         yield Pathname.new(git_dir)
       end
     end

data/lib/shipit/task_commands.rb

@@ -2,7 +2,7 @@
 # rubocop:disable Lint/MissingSuper
 module Shipit
   class TaskCommands < Commands
-    delegate :fetch, :fetched?, to: :stack_commands
+    delegate :fetch_commit, :fetch, :fetched?, to: :stack_commands
 
     def initialize(task)
       @task = task
@@ -47,7 +47,14 @@ module Shipit
     end
 
     def checkout(commit)
-      git('-c', 'advice.detachedHead=false', 'checkout', commit.sha, chdir: @task.working_directory)
+      git(
+        '-c',
+        'advice.detachedHead=false',
+        'checkout',
+        '--quiet',
+        commit.sha,
+        chdir: @task.working_directory
+      )
     end
 
     def clone

data/lib/shipit/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Shipit
-  VERSION = '0.36.1'
+  VERSION = '0.38.0'
 end

data/test/controllers/api/base_controller_test.rb

@@ -3,7 +3,7 @@ require 'test_helper'
 
 module Shipit
   module Api
-    class BaseControllerTest < ActionController::TestCase
+    class BaseControllerTest < ApiControllerTestCase
       test "authentication is required" do
         get :index
         assert_response :unauthorized

data/test/controllers/api/ccmenu_controller_test.rb

@@ -3,7 +3,7 @@ require 'test_helper'
 
 module Shipit
   module Api
-    class CCMenuControllerTest < ActionController::TestCase
+    class CCMenuControllerTest < ApiControllerTestCase
       setup do
         authenticate!
         @stack = shipit_stacks(:shipit)

data/test/controllers/api/commits_controller_test.rb

@@ -3,7 +3,7 @@ require 'test_helper'
 
 module Shipit
   module Api
-    class CommitsControllerTest < ActionController::TestCase
+    class CommitsControllerTest < ApiControllerTestCase
       setup do
         @stack = shipit_stacks(:shipit)
         authenticate!

data/test/controllers/api/deploys_controller_test.rb

@@ -3,7 +3,7 @@ require 'test_helper'
 
 module Shipit
   module Api
-    class DeploysControllerTest < ActionController::TestCase
+    class DeploysControllerTest < ApiControllerTestCase
       setup do
         authenticate!
         @user = shipit_users(:walrus)

data/test/controllers/api/hooks_controller_test.rb

@@ -3,7 +3,7 @@ require 'test_helper'
 
 module Shipit
   module Api
-    class HooksControllerTest < ActionController::TestCase
+    class HooksControllerTest < ApiControllerTestCase
       setup do
         authenticate!
         @stack = shipit_stacks(:shipit)

data/test/controllers/api/locks_controller_test.rb

@@ -3,7 +3,7 @@ require 'test_helper'
 
 module Shipit
   module Api
-    class LocksControllerTest < ActionController::TestCase
+    class LocksControllerTest < ApiControllerTestCase
       setup do
         authenticate!
         @stack = shipit_stacks(:shipit)

data/test/controllers/api/merge_requests_controller_test.rb

@@ -3,7 +3,7 @@ require 'test_helper'
 
 module Shipit
   module Api
-    class MergeRequestsControllerTest < ActionController::TestCase
+    class MergeRequestsControllerTest < ApiControllerTestCase
       setup do
         @stack = shipit_stacks(:shipit)
         @merge_request = shipit_merge_requests(:shipit_pending)

data/test/controllers/api/outputs_controller_test.rb

@@ -3,7 +3,7 @@ require 'test_helper'
 
 module Shipit
   module Api
-    class OutputsControllerTest < ActionController::TestCase
+    class OutputsControllerTest < ApiControllerTestCase
       setup do
         @stack = shipit_stacks(:shipit)
         authenticate!

data/test/controllers/api/release_statuses_controller_test.rb

@@ -3,7 +3,7 @@ require 'test_helper'
 
 module Shipit
   module Api
-    class ReleaseStatusesControllerTest < ActionController::TestCase
+    class ReleaseStatusesControllerTest < ApiControllerTestCase
       setup do
         authenticate!
         @stack = shipit_stacks(:shipit_canaries)

data/test/controllers/api/rollback_controller_test.rb

@@ -3,7 +3,7 @@ require 'test_helper'
 
 module Shipit
   module Api
-    class RollbacksControllerTest < ActionController::TestCase
+    class RollbacksControllerTest < ApiControllerTestCase
       setup do
         authenticate!
         @user = shipit_users(:walrus)

data/test/controllers/api/stacks_controller_test.rb

@@ -3,7 +3,7 @@ require 'test_helper'
 
 module Shipit
   module Api
-    class StacksControllerTest < ActionController::TestCase
+    class StacksControllerTest < ApiControllerTestCase
       setup do
         authenticate!
         @stack = shipit_stacks(:shipit)
@@ -114,6 +114,57 @@ module Shipit
         refute @stack.continuous_deployment
       end
 
+      test "#update does not perform archive when key is not provided" do
+        refute_predicate @stack, :archived?
+        refute_predicate @stack, :locked?
+
+        patch :update, params: { id: @stack.to_param }
+
+        @stack.reload
+        refute_predicate @stack, :archived?
+        refute_predicate @stack, :locked?
+      end
+
+      test "#update does not perform unarchive when key is not provided" do
+        @stack.archive!(shipit_users(:walrus))
+        assert_predicate @stack, :locked?
+        assert_predicate @stack, :archived?
+
+        patch :update, params: { id: @stack.to_param }
+
+        @stack.reload
+        assert_predicate @stack, :locked?
+        assert_predicate @stack, :archived?
+      end
+
+      test "#update allows to archive the stack" do
+        refute_predicate @stack, :archived?
+        refute_predicate @stack, :locked?
+
+        patch :update, params: { id: @stack.to_param, archived: true }
+
+        @stack.reload
+        assert_predicate @stack, :locked?
+        assert_predicate @stack, :archived?
+        assert_instance_of AnonymousUser, @stack.lock_author
+        assert_equal "Archived", @stack.lock_reason
+      end
+
+      test "#update allows to unarchive the stack" do
+        @stack.archive!(shipit_users(:walrus))
+        assert_predicate @stack, :locked?
+        assert_predicate @stack, :archived?
+
+        patch :update, params: { id: @stack.to_param, archived: false }
+
+        @stack.reload
+        refute_predicate @stack, :archived?
+        refute_predicate @stack, :locked?
+        assert_nil @stack.locked_since
+        assert_nil @stack.lock_reason
+        assert_instance_of AnonymousUser, @stack.lock_author
+      end
+
       test "#index returns a list of stacks" do
         stack = Stack.last
         get :index
@@ -214,6 +265,15 @@ module Shipit
         end
         assert_response :accepted
       end
+
+      test "#refresh queues a RefreshStatusesJob and RefreshCheckRunsJob" do
+        assert_enqueued_with(job: RefreshStatusesJob, args: [stack_id: @stack.id]) do
+          assert_enqueued_with(job: RefreshCheckRunsJob, args: [stack_id: @stack.id]) do
+            post :refresh, params: { id: @stack.to_param }
+          end
+        end
+        assert_response :accepted
+      end
     end
   end
 end

data/test/controllers/api/tasks_controller_test.rb

@@ -3,7 +3,7 @@ require 'test_helper'
 
 module Shipit
   module Api
-    class TasksControllerTest < ActionController::TestCase
+    class TasksControllerTest < ApiControllerTestCase
       setup do
         @stack = shipit_stacks(:shipit)
         @user = shipit_users(:walrus)

data/test/dummy/db/schema.rb

@@ -10,7 +10,7 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 2021_11_03_154121) do
+ActiveRecord::Schema.define(version: 2023_07_03_181143) do
 
   create_table "api_clients", force: :cascade do |t|
     t.text "permissions", limit: 65535
@@ -42,7 +42,7 @@ ActiveRecord::Schema.define(version: 2021_11_03_154121) do
   create_table "commit_deployment_statuses", force: :cascade do |t|
     t.integer "commit_deployment_id"
     t.string "status"
-    t.integer "github_id"
+    t.bigint "github_id"
     t.string "api_url"
     t.datetime "created_at", null: false
     t.datetime "updated_at", null: false

data/test/helpers/api_helper.rb

@@ -8,3 +8,16 @@ module ApiHelper
     request.headers['Authorization'] = "Basic #{Base64.encode64(client.authentication_token)}"
   end
 end
+
+module Shipit
+  class ApiControllerTestCase < ActionController::TestCase
+    private
+
+    def process(_action, **kwargs)
+      if kwargs[:method] != "GET"
+        kwargs[:as] ||= :json
+      end
+      super
+    end
+  end
+end

data/test/models/shipit/stacks_test.rb

@@ -278,6 +278,36 @@ module Shipit
       end
     end
 
+    test "#active_task? is false if stack has a concurrent deploy in active state" do
+      @stack.trigger_deploy(shipit_commits(:third), AnonymousUser.new, force: true)
+      refute @stack.active_task?
+    end
+
+    test "#occupied? is false if stack has no deploy in either pending or running state" do
+      @stack.deploys.active.destroy_all
+      refute @stack.occupied?
+    end
+
+    test "#occupied? is false if stack has no deploy at all" do
+      @stack.deploys.destroy_all
+      refute @stack.occupied?
+    end
+
+    test "occupied? is true if stack has a concurrent deploy in active state" do
+      @stack.trigger_deploy(shipit_commits(:third), AnonymousUser.new, force: true)
+      assert @stack.occupied?
+    end
+
+    test "occupied? is true if stack has a deploy in pending state" do
+      @stack.trigger_deploy(shipit_commits(:third), AnonymousUser.new)
+      assert @stack.occupied?
+    end
+
+    test "#occupied? is true if a rollback is ongoing" do
+      shipit_deploys(:shipit_complete).trigger_rollback(AnonymousUser.new)
+      assert @stack.occupied?
+    end
+
     test "#deployable? returns true if the stack is not locked, not awaiting provision, and is not deploying" do
       @stack.deploys.destroy_all
       @stack.update!(lock_reason: nil, awaiting_provision: false)

data/test/unit/deploy_commands_test.rb

@@ -21,6 +21,100 @@ module Shipit
       StackCommands.stubs(git_version: Gem::Version.new('1.8.4.3'))
     end
 
+    test "#fetch_commit calls git fetch if repository cache already exist" do
+      @stack.git_path.stubs(:exist?).returns(true)
+      @stack.git_path.stubs(:empty?).returns(false)
+
+      command = @commands.fetch_commit(@deploy.until_commit)
+
+      assert_equal %W(git fetch origin --quiet --tags #{@deploy.until_commit.sha}), command.args
+    end
+
+    test "#fetch_commit calls git fetch in git_path directory if repository cache already exist" do
+      @stack.git_path.stubs(:exist?).returns(true)
+      @stack.git_path.stubs(:empty?).returns(false)
+
+      command = @commands.fetch_commit(@deploy.until_commit)
+
+      assert_equal @stack.git_path.to_s, command.chdir
+    end
+
+    test "#fetch_commit calls git clone if repository cache do not exist" do
+      @stack.git_path.stubs(:exist?).returns(false)
+
+      command = @commands.fetch_commit(@deploy.until_commit)
+
+      expected = %W(git clone --quiet --single-branch --recursive --branch master #{@stack.repo_git_url} #{@stack.git_path})
+      assert_equal expected, command.args.map(&:to_s)
+    end
+
+    test "#fetch_commit calls git clone if repository cache is empty" do
+      @stack.git_path.stubs(:exist?).returns(true)
+      @stack.git_path.stubs(:empty?).returns(true)
+
+      command = @commands.fetch_commit(@deploy.until_commit)
+
+      expected = %W(git clone --quiet --single-branch --recursive --branch master #{@stack.repo_git_url} #{@stack.git_path})
+      assert_equal expected, command.args
+    end
+
+    test "#fetch_commit calls git clone if repository cache corrupt" do
+      @stack.git_path.stubs(:exist?).returns(true)
+      @stack.git_path.stubs(:empty?).returns(false)
+      StackCommands.any_instance.expects(:git_cmd_succeeds?)
+        .with(@stack.git_path)
+        .returns(false)
+
+      command = @commands.fetch_commit(@deploy.until_commit)
+
+      expected = %W(git clone --quiet --single-branch --recursive --branch master #{@stack.repo_git_url} #{@stack.git_path})
+      assert_equal expected, command.args
+    end
+
+    test "#fetch_commit clears a corrupted git stash before cloning" do
+      @stack.expects(:clear_git_cache!)
+      @stack.git_path.stubs(:exist?).returns(true)
+      @stack.git_path.stubs(:empty?).returns(false)
+      StackCommands.any_instance.expects(:git_cmd_succeeds?)
+        .with(@stack.git_path)
+        .returns(false)
+
+      command = @commands.fetch_commit(@deploy.until_commit)
+
+      expected = %W(git clone --quiet --single-branch --recursive --branch master #{@stack.repo_git_url} #{@stack.git_path})
+      assert_equal expected, command.args
+    end
+
+    test "#fetch_commit does not use --single-branch if git is outdated" do
+      @stack.git_path.stubs(:exist?).returns(false)
+      StackCommands.stubs(git_version: Gem::Version.new('1.7.2.30'))
+
+      command = @commands.fetch_commit(@deploy.until_commit)
+
+      expected = %W(git clone --quiet --recursive --branch master #{@stack.repo_git_url} #{@stack.git_path})
+      assert_equal expected, command.args.map(&:to_s)
+    end
+
+    test "#fetch_commit calls git fetch in base_path directory if repository cache do not exist" do
+      @stack.git_path.stubs(:exist?).returns(false)
+
+      command = @commands.fetch_commit(@deploy.until_commit)
+
+      assert_equal @stack.deploys_path.to_s, command.chdir
+    end
+
+    test "#fetch_commit merges Shipit.env in ENVIRONMENT" do
+      Shipit.stubs(:env).returns("SPECIFIC_CONFIG" => 5)
+      command = @commands.fetch_commit(@deploy.until_commit)
+      assert_equal '5', command.env["SPECIFIC_CONFIG"]
+    end
+
+    test "#env uses the correct Github token for a stack" do
+      Shipit.github(organization: 'shopify').stubs(:token).returns('aS3cr3Tt0kEn')
+      command = @commands.fetch_commit(@deploy.until_commit)
+      assert_equal 'aS3cr3Tt0kEn', command.env["GITHUB_TOKEN"]
+    end
+
     test "#fetch calls git fetch if repository cache already exist" do
       @stack.git_path.stubs(:exist?).returns(true)
       @stack.git_path.stubs(:empty?).returns(false)
@@ -109,12 +203,6 @@ module Shipit
       assert_equal '5', command.env["SPECIFIC_CONFIG"]
     end
 
-    test "#env uses the correct Github token for a stack" do
-      Shipit.github(organization: 'shopify').stubs(:token).returns('aS3cr3Tt0kEn')
-      command = @commands.fetch
-      assert_equal 'aS3cr3Tt0kEn', command.env["GITHUB_TOKEN"]
-    end
-
     test "#clone clones the repository cache into the working directory" do
       commands = @commands.clone
       assert_equal 2, commands.size
@@ -134,7 +222,11 @@ module Shipit
 
     test "#checkout checks out the deployed commit" do
       command = @commands.checkout(@deploy.until_commit)
-      assert_equal ['git', '-c', 'advice.detachedHead=false', 'checkout', @deploy.until_commit.sha], command.args
+      checkout_args = [
+        'git', '-c', 'advice.detachedHead=false', 'checkout', '--quiet',
+        @deploy.until_commit.sha,
+      ]
+      assert_equal checkout_args, command.args
     end
 
     test "#checkout checks out the deployed commit from the working directory" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shipit-engine
 version: !ruby/object:Gem::Version
-  version: 0.36.1
+  version: 0.38.0
 platform: ruby
 authors:
 - Jean Boussier
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-13 00:00:00.000000000 Z
+date: 2023-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_model_serializers
@@ -38,20 +38,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.0.6
-- !ruby/object:Gem::Dependency
-  name: attr_encrypted
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.1.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.1.0
 - !ruby/object:Gem::Dependency
   name: autoprefixer-rails
   requirement: !ruby/object:Gem::Requirement
@@ -521,6 +507,7 @@ files:
 - app/controllers/shipit/status_controller.rb
 - app/controllers/shipit/tasks_controller.rb
 - app/controllers/shipit/webhooks_controller.rb
+- app/helpers/shipit/api_clients_helper.rb
 - app/helpers/shipit/chunks_helper.rb
 - app/helpers/shipit/deploys_helper.rb
 - app/helpers/shipit/github_url_helper.rb
@@ -785,6 +772,7 @@ files:
 - db/migrate/20210504200438_add_github_updated_at_to_check_runs.rb
 - db/migrate/20210823075617_change_check_runs_github_updated_at_default.rb
 - db/migrate/20211103154121_increase_github_team_slug_size.rb
+- db/migrate/20230703181143_change_commit_deployment_statuses_github_id_to_big_int.rb
 - lib/shipit-engine.rb
 - lib/shipit.rb
 - lib/shipit/cast_value.rb
@@ -1053,7 +1041,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.4.14
 signing_key: 
 specification_version: 4
 summary: Application deployment software