shipit-engine 0.33.0 → 0.34.0

data/lib/shipit/github_app.rb

@@ -42,8 +42,9 @@ module Shipit
 
     attr_reader :oauth_teams, :domain, :bot_login
 
-    def initialize(config)
+    def initialize(organization, config)
       super()
+      @organization = organization
       @config = (config || {}).with_indifferent_access
       @domain = @config[:domain] || DOMAIN
       @webhook_secret = @config[:webhook_secret].presence
@@ -92,10 +93,11 @@ module Shipit
     end
 
     def fetch_new_token
+      cache_key = @organization.nil? ? '' : "#{@organization.downcase}:"
       # Rails can add 5 minutes to the cache entry expiration time when any TTL is provided,
       # so our TTL setting can be lower, and TTL + expires_in should be lower than the GitHub token expiration.
       Rails.cache.fetch(
-        'github:integration:access-token',
+        "github:integration:#{cache_key}access-token",
         expires_in: GITHUB_TOKEN_RAILS_CACHE_LIFETIME,
         race_condition_ttl: 4.minutes,
       ) do
@@ -181,15 +183,15 @@ module Shipit
     end
 
     def app_id
-      @app_id ||= @config.fetch(:app_id)
+      @config.fetch(:app_id)
     end
 
     def installation_id
-      @installation_id ||= @config.fetch(:installation_id)
+      @config.fetch(:installation_id)
     end
 
     def private_key
-      @private_key ||= @config.fetch(:private_key)
+      @config.fetch(:private_key)
     end
 
     def authentication_payload

data/lib/shipit/octokit_iterator.rb

@@ -3,12 +3,12 @@ module Shipit
   class OctokitIterator
     include Enumerable
 
-    def initialize(relation = nil)
+    def initialize(relation = nil, github_api: nil)
       if relation
         @response = relation.get(per_page: 100)
       else
-        data = yield Shipit.github.api
-        @response = Shipit.github.api.last_response if data.present?
+        data = yield github_api
+        @response = github_api.last_response if data.present?
       end
     end
 

data/lib/shipit/simple_message_verifier.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 module Shipit
   class SimpleMessageVerifier < ActiveSupport::MessageVerifier
-    def initialize(secret, options = {})
+    def initialize(secret, **options)
       options[:serializer] ||= ToS
-      super(secret, options)
+      super(secret, **options)
     end
 
     private

data/lib/shipit/stack_commands.rb

@@ -15,19 +15,25 @@ module Shipit
 
     def fetch
       create_directories
-      if Dir.exist?(@stack.git_path)
+      if valid_git_repository?(@stack.git_path)
         git('fetch', 'origin', '--tags', @stack.branch, 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 fetched?(commit)
-      git_dir = File.join(@stack.git_path, '.git')
-      if Dir.exist?(git_dir)
+      if valid_git_repository?(@stack.git_path)
         git('rev-parse', '--quiet', '--verify', "#{commit.sha}^{commit}", env: env, chdir: @stack.git_path)
       else
-        Command.new('test', '-d', git_dir, env: env, chdir: @stack.deploys_path)
+        # When the stack's git cache is not valid, the commit is
+        # NOT fetched. To keep the interface of this method
+        # consistent, we must return a Shipit::Command whose #success?
+        # method returns false - has a non-zero exit status. We utilize
+        # the POSIX 'test' command with no arguments which should
+        # always have an exit status of 1.
+        Command.new('test', env: env, chdir: @stack.deploys_path)
       end
     end
 
@@ -71,6 +77,18 @@ module Shipit
       end
     end
 
+    def valid_git_repository?(path)
+      path.exist? &&
+        !path.empty? &&
+        git_cmd_succeeds?(path)
+    end
+
+    def git_cmd_succeeds?(path)
+      git("rev-parse", "--git-dir", chdir: path)
+        .tap(&:run)
+        .success?
+    end
+
     def git_clone(url, path, branch: 'master', **kwargs)
       git('clone', *modern_git_args, '--recursive', '--branch', branch, url, path, **kwargs)
     end
@@ -83,5 +101,11 @@ module Shipit
     def create_directories
       FileUtils.mkdir_p(@stack.deploys_path)
     end
+
+    private
+
+    def github
+      Shipit.github(organization: @stack.repository.owner)
+    end
   end
 end

data/lib/shipit/task_commands.rb

@@ -88,5 +88,11 @@ module Shipit
         @task.working_directory
       end
     end
+
+    private
+
+    def github
+      Shipit.github(organization: @stack.repository.owner)
+    end
   end
 end

data/lib/shipit/version.rb

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

data/lib/snippets/publish-lerna-independent-packages

@@ -1,39 +1,40 @@
 #!/usr/bin/env node
-const {resolve} = require('path');
-const {execSync} = require('child_process')
-const Repository = require(resolve('.', 'node_modules', 'lerna', 'lib', 'Repository'));
-const PackageUtilities = require(resolve('.', 'node_modules', 'lerna', 'lib', 'PackageUtilities'));
-
-function npmTag(version) {
-  const isNext = ['-beta', '-alpha', '-rc', '-next'].some(distributionType =>
-    version.includes(distributionType),
-  );
-  return isNext ? 'next' : 'latest';
-}
+const { execSync } = require("child_process");
 
-const taggedPackages = execSync('git tag --points-at HEAD')
+const taggedPackages = execSync("git tag --points-at HEAD")
   .toString()
   .trim()
-  .split('\n')
-  .map(tag => {
-    if (tag.startsWith('@')) {
-      return `@${tag.split('@')[1]}`;
-    }
-    return tag.split('@')[0];
-  });
-
-const repository = new Repository('.');
-const unsortedPackages = PackageUtilities.getPackages({rootPath: '.', packageConfigs: repository.packageConfigs});
-const packages = PackageUtilities.topologicallyBatchPackages(unsortedPackages, true)
-  .reduce((acc, packageGroup) => [...acc, ...packageGroup], [])
-  .filter(({name}) => taggedPackages.includes(name));
-
-packages.forEach(({name, version}) => {
-  const command = `node_modules/.bin/lerna publish --yes --npm-client=npm --skip-npm=false --skip-git --force-publish=${name} --repo-version=${version} --scope=${name} --npm-tag=${npmTag(
-    version,
-  )}`;
-
-  // eslint-disable-next-line no-console
-  console.log(command);
-  require('child_process').execSync(command);
+  .split("\n");
+
+// anything that matches `-` after MAJOR.MINOR.PATCH
+const validPattern = new RegExp(/\d+\.\d+\.\d+-(\w+)/);
+
+// Ensure that all releases use the same prerelease suffix.
+// We want to only release all final versions, or all betas etc
+const allPrereleaseSuffixes =  taggedPackages.map((version) => {
+  const result = validPattern.exec(version);
+  return result ? result[1] : '';
 });
+if ((new Set(allPrereleaseSuffixes)).size > 1) {
+  throw Error("All packages must be of the same type of release. Versions cannot be mixed.");
+}
+
+// set this using machine.environment.SHIPIT_LERNA_PUBLISH_MECHANISM in your shipit.yml
+const publishMechanism = process.env.SHIPIT_LERNA_PUBLISH_MECHANISM || 'from-git';
+
+if (!['from-package', 'from-git'].includes(publishMechanism)) {
+  throw Error("SHIPIT_LERNA_PUBLISH_MECHANISM must be 'from-package' or 'from-git'.");
+}
+
+const command = [
+  "node_modules/.bin/lerna publish",
+  publishMechanism,
+  "--yes",
+  "--dist-tag latest",
+  "--pre-dist-tag next",
+];
+
+const commandString = command.join(" ");
+
+console.log(`${commandString}`);
+execSync(commandString);

data/lib/snippets/publish-lerna-independent-packages-legacy

@@ -0,0 +1,39 @@
+#!/usr/bin/env node
+const {resolve} = require('path');
+const {execSync} = require('child_process')
+const Repository = require(resolve('.', 'node_modules', 'lerna', 'lib', 'Repository'));
+const PackageUtilities = require(resolve('.', 'node_modules', 'lerna', 'lib', 'PackageUtilities'));
+
+function npmTag(version) {
+  const isNext = ['-beta', '-alpha', '-rc', '-next'].some(distributionType =>
+    version.includes(distributionType),
+  );
+  return isNext ? 'next' : 'latest';
+}
+
+const taggedPackages = execSync('git tag --points-at HEAD')
+  .toString()
+  .trim()
+  .split('\n')
+  .map(tag => {
+    if (tag.startsWith('@')) {
+      return `@${tag.split('@')[1]}`;
+    }
+    return tag.split('@')[0];
+  });
+
+const repository = new Repository('.');
+const unsortedPackages = PackageUtilities.getPackages({rootPath: '.', packageConfigs: repository.packageConfigs});
+const packages = PackageUtilities.topologicallyBatchPackages(unsortedPackages, true)
+  .reduce((acc, packageGroup) => [...acc, ...packageGroup], [])
+  .filter(({name}) => taggedPackages.includes(name));
+
+packages.forEach(({name, version}) => {
+  const command = `node_modules/.bin/lerna publish --yes --npm-client=npm --skip-npm=false --skip-git --force-publish=${name} --repo-version=${version} --scope=${name} --npm-tag=${npmTag(
+    version,
+  )}`;
+
+  // eslint-disable-next-line no-console
+  console.log(command);
+  require('child_process').execSync(command);
+});

data/test/controllers/api/ccmenu_controller_test.rb

@@ -44,7 +44,7 @@ module Shipit
       end
 
       test "stacks with no deploys render correctly" do
-        stack = Stack.create!(repository: Repository.new(owner: "foo", name: "bar"))
+        stack = Stack.create!(repository: Repository.new(owner: "foo", name: "bar"), branch: 'main')
         get :show, params: { stack_id: stack.to_param }
         assert_payload 'lastBuildStatus', 'Success'
       end

data/test/controllers/api/deploys_controller_test.rb

@@ -83,6 +83,23 @@ module Shipit
         assert_response :conflict
       end
 
+      test "#create refuses to deploy unsuccessful commits if the require_ci flag is passed" do
+        Commit.any_instance.expects(:deployable?).returns(false)
+
+        assert_no_difference -> { @stack.deploys.count } do
+          post :create, params: { stack_id: @stack.to_param, sha: @commit.sha, require_ci: true }
+        end
+        assert_response :unprocessable_entity
+        assert_json 'errors.require_ci', ["Commit is not deployable"]
+      end
+
+      test "#create deploys failing commits if the require_ci flag is not passed" do
+        Commit.any_instance.expects(:deployable?).returns(false)
+
+        post :create, params: { stack_id: @stack.to_param, sha: @commit.sha }
+        assert_response :accepted
+      end
+
       test "#create refuses to deploy locked stacks" do
         @stack.update!(lock_reason: 'Something broken')
 

data/test/controllers/api/stacks_controller_test.rb

@@ -23,7 +23,7 @@ module Shipit
 
       test "#create fails with invalid stack" do
         assert_no_difference "Stack.count" do
-          post :create, params: { repo_owner: 'some', repo_name: 'owner/path' }
+          post :create, params: { repo_owner: 'some', repo_name: 'owner/path', branch: 'main' }
         end
         assert_response :unprocessable_entity
         assert_json 'errors', 'repository' => ['is invalid']
@@ -48,12 +48,12 @@ module Shipit
 
         assert_no_difference -> { Stack.count } do
           post :create,
-               params: {
-                 repo_name: existing_stack.repo_name,
-                 repo_owner: existing_stack.repo_owner,
-                 environment: existing_stack.environment,
-                 branch: existing_stack.branch,
-               }
+            params: {
+              repo_name: existing_stack.repo_name,
+              repo_owner: existing_stack.repo_owner,
+              environment: existing_stack.environment,
+              branch: existing_stack.branch,
+            }
         end
 
         assert_response :unprocessable_entity
@@ -82,6 +82,20 @@ module Shipit
         assert_equal true, @stack.continuous_deployment
       end
 
+      test "#update allows changing the branch name" do
+        assert_equal 'master', @stack.branch
+
+        patch :update, params: {
+          id: @stack.to_param,
+          branch: 'test',
+        }
+
+        assert_response :ok
+        @stack.reload
+
+        assert_equal 'test', @stack.branch
+      end
+
       test "#index returns a list of stacks" do
         stack = Stack.last
         get :index

data/test/controllers/webhooks_controller_test.rb

@@ -22,14 +22,15 @@ module Shipit
     test ":push with the target branch queues a GithubSyncJob" do
       request.headers['X-Github-Event'] = 'push'
 
+      body = JSON.parse(payload(:push_master)).to_json
       assert_enqueued_with(job: GithubSyncJob, args: [stack_id: @stack.id]) do
-        post :create, body: payload(:push_master), as: :json
+        post :create, body: body, as: :json
       end
     end
 
     test ":push does not enqueue a job if not the target branch" do
       request.headers['X-Github-Event'] = 'push'
-      params = payload(:push_not_master)
+      params = JSON.parse(payload(:push_not_master)).to_json
       assert_no_enqueued_jobs do
         post :create, body: params, as: :json
       end
@@ -40,8 +41,9 @@ module Shipit
 
       commit = shipit_commits(:first)
 
+      body = JSON.parse(payload(:status_master)).merge(repository_params).to_json
       assert_difference 'commit.statuses.count', 1 do
-        post :create, body: payload(:status_master), as: :json
+        post :create, body: body, as: :json
       end
 
       status = commit.statuses.last
@@ -55,14 +57,14 @@ module Shipit
 
     test ":state with a unexisting commit respond with 200 OK" do
       request.headers['X-Github-Event'] = 'status'
-      params = { 'sha' => 'notarealcommit', 'state' => 'pending', 'branches' => [{ 'name' => 'master' }] }.to_json
+      params = { 'sha' => 'notarealcommit', 'state' => 'pending', 'branches' => [{ 'name' => 'master' }] }.merge(repository_params).to_json
       post :create, body: params, as: :json
       assert_response :ok
     end
 
     test ":state in an untracked branche bails out" do
       request.headers['X-Github-Event'] = 'status'
-      params = { 'sha' => 'notarealcommit', 'state' => 'pending', 'branches' => [] }.to_json
+      params = { 'sha' => 'notarealcommit', 'state' => 'pending', 'branches' => [] }.merge(repository_params).to_json
       post :create, body: params, as: :json
       assert_response :ok
     end
@@ -70,8 +72,9 @@ module Shipit
     test ":check_suite with the target branch queues a RefreshCheckRunsJob" do
       request.headers['X-Github-Event'] = 'check_suite'
 
+      body = JSON.parse(payload(:check_suite_master)).to_json
       assert_enqueued_with(job: RefreshCheckRunsJob) do
-        post :create, body: payload(:check_suite_master), as: :json
+        post :create, body: body, as: :json
         assert_response :ok
       end
     end
@@ -88,13 +91,13 @@ module Shipit
     test "verifies webhook signature" do
       commit = shipit_commits(:first)
 
-      payload = { "sha" => commit.sha, "state" => "pending", "target_url" => "https://ci.example.com/1000/output" }.to_json
+      payload = { "sha" => commit.sha, "state" => "pending", "target_url" => "https://ci.example.com/1000/output" }.merge(repository_params).to_json
       signature = 'sha1=4848deb1c9642cd938e8caa578d201ca359a8249'
 
       @request.headers['X-Github-Event'] = 'push'
       @request.headers['X-Hub-Signature'] = signature
 
-      Shipit.github.expects(:verify_webhook_signature).with(signature, payload).returns(false)
+      Shipit.github(organization: 'shopify').expects(:verify_webhook_signature).with(signature, payload).returns(false)
 
       post :create, body: payload, as: :json
       assert_response :unprocessable_entity
@@ -157,7 +160,7 @@ module Shipit
     test "other events trigger custom handlers" do
       event = 'pull_request'
       mock_handler = mock
-      mock_handler.expects(:call).with(pull_request_params.stringify_keys).once
+      mock_handler.expects(:call).with(pull_request_params.deep_stringify_keys).once
       Shipit::Webhooks.handlers["pull_request"] = [mock_handler]
 
       @request.headers['X-Github-Event'] = event
@@ -165,20 +168,32 @@ module Shipit
       assert_response :ok
     end
 
+    test "events with no handler are dropped" do
+      event = 'not_a_real_event'
+
+      @request.headers['X-Github-Event'] = event
+      post :create, body: pull_request_params.to_json, as: :json
+      assert_response 204
+    end
+
     private
 
     def pull_request_params
-      { action: 'opened', number: 2, pull_request: 'foobar' }
+      { action: 'opened', number: 2, pull_request: 'foobar' }.merge(repository_params)
     end
 
     def membership_params
-      { action: 'added', team: team_params, organization: { login: 'shopify' }, member: { login: 'walrus' } }
+      { action: 'added', team: team_params, organization: { login: 'shopify' }, member: { login: 'walrus' } }.merge(repository_params)
     end
 
     def team_params
       { id: shipit_teams(:shopify_developers).id, slug: 'developers', name: 'Developers', url: 'http://example.com' }
     end
 
+    def repository_params
+      { repository: { owner: { login: 'shopify' } } }
+    end
+
     def george
       stub(
         id: 42,