shipit-engine 0.31.0 → 0.35.0

data/config/routes.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
 Shipit::Engine.routes.draw do
   stack_id_format = %r{[^/]+/[^/]+/[^/]+}
+  repository_id_format = %r{[^/]+/[^/]+}
   sha_format = /[\da-f]{6,40}/
   root to: 'stacks#index'
 
@@ -17,6 +19,7 @@ Shipit::Engine.routes.draw do
     scope '/stacks/*id', id: stack_id_format, as: :stack do
       get '/' => 'stacks#show'
       delete '/' => 'stacks#destroy'
+      patch '/' => 'stacks#update'
     end
 
     scope '/stacks/*stack_id', stack_id: stack_id_format, as: :stack do
@@ -28,8 +31,9 @@ Shipit::Engine.routes.draw do
       resources :deploys, only: %i(index create) do
         resources :release_statuses, only: %i(create)
       end
+      resources :rollbacks, only: %i(create)
       resources :commits, only: %i(index)
-      resources :pull_requests, only: %i(index show update destroy)
+      resources :merge_requests, only: %i(index show update destroy)
       post '/task/:task_name' => 'tasks#trigger', as: :trigger_task
       resources :hooks, only: %i(index create show update destroy)
     end
@@ -43,12 +47,20 @@ Shipit::Engine.routes.draw do
 
   # Browser extension
   get '/merge_status', action: :show, controller: :merge_status, as: :merge_status
-  put '/merge_status/*stack_id/pull/:number', action: :enqueue, controller: :merge_status, id: stack_id_format, as: :enqueue_pull_request
-  delete '/merge_status/*stack_id/pull/:number', action: :dequeue, controller: :merge_status, id: stack_id_format, as: :dequeue_pull_request
+  put '/merge_status/*stack_id/pull/:number', action: :enqueue, controller: :merge_status, id: stack_id_format, as: :enqueue_merge_request
+  delete '/merge_status/*stack_id/pull/:number', action: :dequeue, controller: :merge_status, id: stack_id_format, as: :dequeue_merge_request
 
   # Humans
   resources :api_clients
-  resources :stacks, only: %i(new create index)
+
+  resources :repositories, only: %i(new index create)
+  scope '/repositories/*id', id: repository_id_format, as: :repository do
+    get '/' => 'repositories#show'
+    patch '/' => 'repositories#update'
+    delete '/' => 'repositories#destroy'
+    get :settings, controller: :repositories
+    get 'stacks/new' => 'repositories#new_stack'
+  end
 
   scope '/github/auth/github', as: :github_authentication, controller: :github_authentication do
     get '/', action: :request
@@ -57,11 +69,13 @@ Shipit::Engine.routes.draw do
     get :logout
   end
 
+  resources :stacks, only: %i(new create index)
   scope '/*id', id: stack_id_format, as: :stack do
     get '/' => 'stacks#show'
     patch '/' => 'stacks#update'
     delete '/' => 'stacks#destroy'
     get :settings, controller: :stacks
+    get :all_tasks, controller: :stacks, as: :tasks_list
     get :statistics, controller: :stacks
     post :refresh, controller: :stacks
     get :refresh, controller: :stacks # For easier design, sorry :/
@@ -74,7 +88,7 @@ Shipit::Engine.routes.draw do
 
   scope '/*stack_id', stack_id: stack_id_format, as: :stack do
     get '/commit/:sha/checks' => 'commit_checks#show', as: :commit_checks
-    get '/commit/:sha/checks/tail' => 'commit_checks#tail', as: :tail_commit_checks, defaults: {format: :json}
+    get '/commit/:sha/checks/tail' => 'commit_checks#tail', as: :tail_commit_checks, defaults: { format: :json }
 
     get '/stats' => 'stats#show', as: :stats
 
@@ -89,7 +103,7 @@ Shipit::Engine.routes.draw do
 
       member do
         post :abort
-        get :tail, defaults: {format: :json}
+        get :tail, defaults: { format: :json }
       end
     end
 
@@ -103,7 +117,11 @@ Shipit::Engine.routes.draw do
       resources :release_statuses, only: %i(create)
     end
 
-    resources :pull_requests, only: %i(index destroy create)
+    resources :merge_requests, only: %i(index destroy create)
   end
   get '/stacks/:id' => 'stacks#lookup'
+
+  scope '/*repo', repo: %r{[^/]+/[^/]+}, as: :stack_search do
+    get '/' => 'stacks#index'
+  end
 end

data/config/secrets.development.example.yml

@@ -1,8 +1,10 @@
 host: 'localhost:3000'
 redis_url: 'redis://127.0.0.1:6379/0'
 
+# For creating an app see: https://github.com/Shopify/shipit-engine/blob/master/docs/setup.md#creating-the-github-app
 # Can be obtained there: https://github.com/settings/apps
 # Set the "Authorization callback URL" as `<host>/github/auth/github/callback`
+
 github:
   app_id:
   installation_id:
@@ -12,3 +14,25 @@ github:
     id:
     secret:
     teams: # Optional
+
+# Use this configuration schema if you are configuring multiple Github applications for different Github organizations
+
+# github:
+#   somegithuborg:
+#     app_id:
+#     installation_id:
+#     webhook_secret: # nil
+#     private_key:
+#     oauth:
+#       id:
+#       secret:
+#       teams: # Optional
+#   someothergithuborg:
+#     app_id:
+#     installation_id:
+#     webhook_secret: # nil
+#     private_key:
+#     oauth:
+#       id:
+#       secret:
+#       teams: # Optional

data/config/secrets.development.shopify.yml

@@ -1,13 +1,24 @@
 host: 'shipit-engine.myshopify.io'
 redis_url: 'redis://shipit-engine.railgun:6379'
 
-# TODO: document creating a dev app
+# For creating an app see: https://github.com/Shopify/shipit-engine/blob/master/docs/setup.md#creating-the-github-app
+
 github:
-  app_id:
-  installation_id:
-  webhook_secret: # nil
-  private_key:
-  oauth:
-    id:
-    secret:
-    teams:
+  somegithuborg:
+    app_id:
+    installation_id:
+    webhook_secret: # nil
+    private_key:
+    oauth:
+      id:
+      secret:
+      teams:
+  someothergithuborg:
+    app_id:
+    installation_id:
+    webhook_secret: # nil
+    private_key:
+    oauth:
+      id:
+      secret:
+      teams:

data/db/migrate/20200226211925_add_index_to_tasks_status.rb

@@ -0,0 +1,5 @@
+class AddIndexToTasksStatus < ActiveRecord::Migration[6.0]
+  def change
+    add_index :tasks, :status
+  end
+end

data/db/migrate/20200427135152_add_pull_request_head_sha_to_commit.rb

@@ -0,0 +1,5 @@
+class AddPullRequestHeadShaToCommit < ActiveRecord::Migration[6.0]
+  def change
+    add_column :commits, :pull_request_head_sha, :string, limit: 40
+  end
+end

data/db/migrate/20200615181558_add_rollback_once_aborted_to.rb

@@ -0,0 +1,5 @@
+class AddRollbackOnceAbortedTo < ActiveRecord::Migration[6.0]
+  def change
+    add_column :tasks, :rollback_once_aborted_to_id, :integer
+  end
+end

data/db/migrate/20200706145406_add_review_stacks.rb

@@ -0,0 +1,12 @@
+class AddReviewStacks < ActiveRecord::Migration[6.0]
+  def change
+    add_column :stacks, :provision_status, :string, null: false, default: :deprovisioned
+    add_index :stacks, :provision_status
+
+    add_column :stacks, :type, :string, default: "Shipit::Stack"
+    add_index :stacks, :type
+
+    add_column :stacks, :awaiting_provision, :boolean, null: false, default: false
+    add_index :stacks, :awaiting_provision
+  end
+end

data/db/migrate/20200804144639_rename_pull_request_to_merge_request.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class RenamePullRequestToMergeRequest < ActiveRecord::Migration[6.0]
+  def change
+    rename_table :pull_requests, :merge_requests
+  end
+end

data/db/migrate/20200804161512_rename_commits_pull_request_id_to_merge_request_id.rb

@@ -0,0 +1,5 @@
+class RenameCommitsPullRequestIdToMergeRequestId < ActiveRecord::Migration[6.0]
+  def change
+    rename_column :commits, :pull_request_id, :merge_request_id
+  end
+end

data/db/migrate/20200813134712_recreate_shipit_pull_requests.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+class RecreateShipitPullRequests < ActiveRecord::Migration[6.0]
+  def change
+    create_table :pull_requests do |t|
+      t.references :stack, null: false
+      t.integer :number, null: false
+      t.string :title, limit: 256
+      t.integer :github_id, limit: 8
+      t.string :api_url, limit: 1024
+      t.string :state
+      t.integer :additions, null: false, default: 0
+      t.integer :deletions, null: false, default: 0
+      t.integer :user_id
+      t.text :labels
+      t.references :head
+      t.timestamps
+
+      t.index [:stack_id, :number], unique: true
+      t.index [:stack_id, :github_id], unique: true
+    end
+  end
+end

data/db/migrate/20200813194056_create_pull_request_assignments.rb

@@ -0,0 +1,8 @@
+class CreatePullRequestAssignments < ActiveRecord::Migration[6.0]
+  def change
+    create_table :pull_request_assignments do |t|
+      t.references :pull_request
+      t.references :user
+    end
+  end
+end

data/db/migrate/20201001125502_add_provision_pr_stacks_flag_to_repositories.rb

@@ -0,0 +1,7 @@
+class AddProvisionPrStacksFlagToRepositories < ActiveRecord::Migration[6.0]
+  def change
+    add_column :repositories, :review_stacks_enabled, :boolean, default: false
+    add_column :repositories, :provisioning_behavior, :string, default: :allow_all
+    add_column :repositories, :provisioning_label_name, :string
+  end
+end

data/db/migrate/20201008145809_add_retry_attempt_to_tasks.rb

@@ -0,0 +1,5 @@
+class AddRetryAttemptToTasks < ActiveRecord::Migration[6.0]
+  def change
+    add_column :tasks, :retry_attempt, :integer, null: false, default: 0
+  end
+end

data/db/migrate/20201008152744_add_max_retries_to_tasks.rb

@@ -0,0 +1,5 @@
+class AddMaxRetriesToTasks < ActiveRecord::Migration[6.0]
+  def change
+    add_column :tasks, :max_retries, :integer, null: true
+  end
+end

data/db/migrate/20210325194053_remove_stacks_branch_default.rb

@@ -0,0 +1,5 @@
+class RemoveStacksBranchDefault < ActiveRecord::Migration[6.1]
+  def change
+    change_column_default(:stacks, :branch, from: 'master', to: nil)
+  end
+end

data/db/migrate/20210504200438_add_github_updated_at_to_check_runs.rb

@@ -0,0 +1,5 @@
+class AddGithubUpdatedAtToCheckRuns < ActiveRecord::Migration[6.1]
+  def change
+    add_column :check_runs, :github_updated_at, :datetime, default: nil
+  end
+end

data/db/migrate/20210823075617_change_check_runs_github_updated_at_default.rb

@@ -0,0 +1,5 @@
+class ChangeCheckRunsGithubUpdatedAtDefault < ActiveRecord::Migration[6.1]
+  def change
+    change_column_default :check_runs, :github_updated_at, nil
+  end
+end

data/lib/shipit/cast_value.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Shipit
   module CastValue
     def to_boolean(value)

data/lib/shipit/command.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'pty'
 require 'shellwords'
 require 'fileutils'
@@ -12,7 +13,8 @@ module Shipit
     Denied = Class.new(Error)
     TimedOut = Class.new(Error)
 
-    BASE_ENV = Bundler.clean_env.merge((ENV.keys - Bundler.clean_env.keys).map { |k| [k, nil] }.to_h)
+    unbundled_env = Bundler.respond_to?(:unbundled_env) ? Bundler.unbundled_env : Bundler.clean_env
+    BASE_ENV = unbundled_env.merge((ENV.keys - unbundled_env.keys).map { |k| [k, nil] }.to_h)
 
     class Failed < Error
       attr_reader :exit_code
@@ -27,8 +29,8 @@ module Shipit
 
     def initialize(*args, default_timeout: Shipit.default_inactivity_timeout, env: {}, chdir:)
       @args, options = parse_arguments(args)
-      @timeout = options['timeout'.freeze] || options[:timeout] || default_timeout
-      @env = env
+      @timeout = options['timeout'] || options[:timeout] || default_timeout
+      @env = env.transform_values { |v| v&.to_s }
       @chdir = chdir.to_s
       @timed_out = false
     end
@@ -85,7 +87,7 @@ module Shipit
       @out = @pid = nil
       FileUtils.mkdir_p(@chdir)
       begin
-        @out, child_in, @pid = PTY.spawn(clean_env, *interpolated_arguments, chdir: @chdir)
+        @out, child_in, @pid = PTY.spawn(unbundled_env, *interpolated_arguments, chdir: @chdir)
         child_in.close
       rescue Errno::ENOENT
         raise NotFound, "#{Shellwords.split(interpolated_arguments.first).first}: command not found"
@@ -96,8 +98,8 @@ module Shipit
       self
     end
 
-    def clean_env
-      BASE_ENV.merge('PATH' => "#{ENV['PATH']}:#{Shipit.shell_paths.join(':')}").merge(@env.stringify_keys)
+    def unbundled_env
+      BASE_ENV.merge('PATH' => "#{Shipit.shell_paths.join(':')}:#{ENV['PATH']}").merge(@env.stringify_keys)
     end
 
     def stream(&block)
@@ -146,16 +148,16 @@ module Shipit
     def read_stream(io)
       touch_last_output_at
       loop do
-          yield_control
-          yield io.read_nonblock(MAX_READ)
-          touch_last_output_at
+        yield_control
+        yield io.read_nonblock(MAX_READ)
+        touch_last_output_at
       rescue IO::WaitReadable
-          if output_timed_out?
-            @timed_out = true
-            raise TimedOut
-          end
-          IO.select([io], nil, nil, 1)
-          retry
+        if output_timed_out?
+          @timed_out = true
+          raise TimedOut
+        end
+        IO.select([io], nil, nil, 1)
+        retry
       end
     rescue EOFError
     end
@@ -191,7 +193,7 @@ module Shipit
         # If we let the child a little bit of time, it solves it.
         retry_count -= 1
         if retry_count > 0
-          sleep 0.05
+          sleep(0.05)
           retry
         end
       end
@@ -215,7 +217,7 @@ module Shipit
           argument
         end
       end
-      return args, options
+      [args.map(&:to_s), options]
     end
 
     def running?

data/lib/shipit/commands.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Shipit
   class Commands
     class << self
@@ -6,28 +7,41 @@ module Shipit
       end
 
       def git_version
-        @git_version ||= parse_git_version(`git --version`)
+        @git_version ||= parse_git_version(%x(git --version))
       end
 
       def parse_git_version(raw_git_version)
-        raw_git_version =~ /(\d+\.\d+\.\d+)/
-        raise 'git command not found' unless $1
-        Gem::Version.new($1)
+        match_info = raw_git_version.match(/(\d+\.\d+\.\d+)/)
+        raise 'git command not found' unless match_info
+        Gem::Version.new(match_info[1])
       end
     end
 
     delegate :git_version, to: :class
 
     def env
-      @env ||= Shipit.env.merge(
-        'GITHUB_DOMAIN' => Shipit.github.domain,
-        'GITHUB_TOKEN' => Shipit.github.token,
+      base_env
+    end
+
+    def git(*args)
+      kwargs = args.extract_options!
+      kwargs[:env] ||= base_env
+      Command.new("git", *args, **kwargs)
+    end
+    ruby2_keywords :git if respond_to?(:ruby2_keywords, true)
+
+    private
+
+    def base_env
+      @base_env ||= Shipit.env.merge(
+        'GITHUB_DOMAIN' => github.domain,
+        'GITHUB_TOKEN' => github.token,
         'GIT_ASKPASS' => Shipit::Engine.root.join('lib', 'snippets', 'git-askpass').realpath.to_s,
       )
     end
 
-    def git(*args)
-      Command.new("git", *args)
+    def github
+      Shipit.github
     end
   end
 end