shipit-engine 0.28.0 → 0.32.0

data/test/test_command_integration.rb

@@ -1,8 +1,9 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 path = './fixtures/timeout'
 buffer = []
-command = Shipit::Command.new({path => {'timeout' => 2}}, env: {}, chdir: __dir__)
+command = Shipit::Command.new({ path => { 'timeout' => 2 } }, env: {}, chdir: __dir__)
 begin
   command.stream! do |chunk|
     buffer << chunk
@@ -24,5 +25,5 @@ unless buffer.join == expected_output.join
   puts "Got: ------------"
   puts buffer.map(&:inspect).join("\n")
   puts "-----------------"
-  exit 1
+  exit(1)
 end

data/test/test_helper.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
 ENV["RAILS_ENV"] ||= "test"
 
 require 'simplecov'
-SimpleCov.start 'rails'
+SimpleCov.start('rails') do
+  enable_coverage :branch
+end
 
-require 'fakeweb'
-FakeWeb.allow_net_connect = false
+require 'webmock/minitest'
 
 require File.expand_path('../../test/dummy/config/environment.rb', __FILE__)
 ActiveRecord::Migrator.migrations_paths = [
@@ -12,13 +14,13 @@ ActiveRecord::Migrator.migrations_paths = [
   File.expand_path('../../db/migrate', __FILE__),
 ]
 require 'rails/test_help'
-require 'mocha/mini_test'
+require 'mocha/minitest'
 require 'spy/integration'
 
 # Load fixtures from the engine
 if ActiveSupport::TestCase.respond_to?(:fixture_path=)
   ActiveSupport::TestCase.fixture_path = File.expand_path("../fixtures", __FILE__)
-  ActiveSupport::TestCase.fixtures :all
+  ActiveSupport::TestCase.fixtures(:all)
 end
 
 Dir[File.expand_path('../helpers/**/*.rb', __FILE__)].each do |helper|
@@ -30,41 +32,43 @@ begin
 rescue LoadError
 end
 
-class ActiveSupport::TestCase
-  include PayloadsHelper
-  include FixtureAliasesHelper
-  include QueriesHelper
-  include JSONHelper
-  include LinksHelper
-  include ApiHelper
-  include HooksHelper
-  include ActiveJob::TestHelper
+module ActiveSupport
+  class TestCase
+    include PayloadsHelper
+    include FixtureAliasesHelper
+    include QueriesHelper
+    include JSONHelper
+    include LinksHelper
+    include ApiHelper
+    include HooksHelper
+    include ActiveJob::TestHelper
 
-  setup do
-    @routes = Shipit::Engine.routes
-    Shipit.github.api.stubs(:login).returns('shipit')
-  end
+    setup do
+      @routes = Shipit::Engine.routes
+      Shipit.github.api.stubs(:login).returns('shipit')
+    end
 
-  teardown do
-    Shipit.redis.flushdb
-    Shipit.instance_variable_names.each do |name|
-      next if %w(@mocha @redis).include?(name)
-      Shipit.remove_instance_variable(name)
+    teardown do
+      Shipit.redis.flushdb
+      Shipit.instance_variable_names.each do |name|
+        next if %w(@mocha @redis).include?(name)
+        Shipit.remove_instance_variable(name)
+      end
     end
-  end
 
-  ActiveRecord::Migration.check_pending!
+    ActiveRecord::Migration.check_pending!
 
-  # Setup all fixtures in test/fixtures/*.yml for all tests in alphabetical order.
-  #
-  # Note: You'll currently still have to declare fixtures explicitly in integration tests
-  # -- they do not yet inherit this setting
-  fixtures :all
+    # Setup all fixtures in test/fixtures/*.yml for all tests in alphabetical order.
+    #
+    # Note: You'll currently still have to declare fixtures explicitly in integration tests
+    # -- they do not yet inherit this setting
+    fixtures :all
 
-  # Add more helper methods to be used by all tests here...
-  private
+    # Add more helper methods to be used by all tests here...
+    private
 
-  def resource(data)
-    Sawyer::Resource.new(Sawyer::Agent.new('http://example.com'), data)
+    def resource(data)
+      Sawyer::Resource.new(Sawyer::Agent.new('http://example.com'), data)
+    end
   end
 end

data/test/unit/anonymous_user_serializer_test.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+require 'test_helper'
+
+module Shipit
+  class AnonymousUserSerializerTest < ActiveSupport::TestCase
+    test 'sets anonymous to true' do
+      user = AnonymousUser.new
+      serializer = ActiveModel::Serializer.serializer_for(user)
+      assert_equal AnonymousUserSerializer, serializer
+      serialized = serializer.new(user).to_json
+      assert_json("anonymous", true, document: serialized)
+    end
+  end
+end

data/test/unit/command_test.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 module Shipit
@@ -9,28 +10,32 @@ module Shipit
     end
 
     test "#interpolate_environment_variables replace environment variables by their value" do
-      command = Command.new('cap $ENVIRONMENT deploy', env: {'ENVIRONMENT' => 'production'}, chdir: '.')
+      command = Command.new('cap $ENVIRONMENT deploy', env: { 'ENVIRONMENT' => 'production' }, chdir: '.')
       assert_equal [%(cap production deploy)], command.interpolated_arguments
     end
 
     test "#interpolate_environment_variables coerce nil to empty string" do
-      command = Command.new('cap $FOO deploy', env: {'ENVIRONMENT' => 'production'}, chdir: '.')
+      command = Command.new('cap $FOO deploy', env: { 'ENVIRONMENT' => 'production' }, chdir: '.')
       assert_equal [%(cap '' deploy)], command.interpolated_arguments
     end
 
     test '#interpolate_environment_variables escape the variable contents' do
       malicious_string = '$(echo pwnd)'
-      command = Command.new('echo $FOO', env: {'FOO' => malicious_string}, chdir: '.')
+      command = Command.new('echo $FOO', env: { 'FOO' => malicious_string }, chdir: '.')
       assert_equal malicious_string, command.run.chomp
     end
 
     test "#interpolate_environment_variables fallback to ENV" do
-      command = Command.new('cap $LANG deploy', env: {'ENVIRONMENT' => 'production'}, chdir: '.')
-      assert_equal [%(cap #{ENV['LANG']} deploy)], command.interpolated_arguments
+      previous = ENV['SHIPIT_TEST']
+      ENV['SHIPIT_TEST'] = 'quux'
+      command = Command.new('cap $SHIPIT_TEST deploy', env: { 'ENVIRONMENT' => 'production' }, chdir: '.')
+      assert_equal([%(cap quux deploy)], command.interpolated_arguments)
+    ensure
+      ENV['SHIPIT_TEST'] = previous
     end
 
     test "#timeout is 5 minutes by default" do
-      command = Command.new('cap $LANG deploy', env: {'ENVIRONMENT' => 'production'}, chdir: '.')
+      command = Command.new('cap $LANG deploy', env: { 'ENVIRONMENT' => 'production' }, chdir: '.')
       assert_equal 5.minutes.to_i, command.timeout
     end
 
@@ -40,7 +45,7 @@ module Shipit
     end
 
     test "#timeout returns the command option timeout over the `default_timeout` if present" do
-      command = Command.new({'cap $LANG deploy' => {'timeout' => 10}}, default_timeout: 5, env: {}, chdir: '.')
+      command = Command.new({ 'cap $LANG deploy' => { 'timeout' => 10 } }, default_timeout: 5, env: {}, chdir: '.')
       assert_equal 10, command.timeout
     end
 

data/test/unit/commands_test.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 module Shipit

data/test/unit/commit_serializer_test.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+require 'test_helper'
+
+module Shipit
+  class CommitSerializerTest < ActiveSupport::TestCase
+    test 'commit includes author object' do
+      commit = shipit_commits(:first)
+
+      serializer = ActiveModel::Serializer.serializer_for(commit)
+      assert_equal CommitSerializer, serializer
+      serialized = serializer.new(commit).to_json
+
+      assert_json("author.name", commit.author.name, document: serialized)
+    end
+  end
+end

data/test/unit/csv_serializer_test.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 module Shipit
@@ -28,7 +29,7 @@ module Shipit
     def assert_dumped(expected, object)
       message = "Expected CSVSerializer.dump(#{object.inspect}) to eq #{expected.inspect}"
       if expected.nil?
-        assert_nil Shipit::CSVSerializer.dump(object), message
+        assert_nil(Shipit::CSVSerializer.dump(object), message)
       else
         assert_equal(expected, Shipit::CSVSerializer.dump(object), message)
       end
@@ -37,7 +38,7 @@ module Shipit
     def assert_loaded(expected, payload)
       message = "Expected CSVSerializer.load(#{payload.inspect}) to eq #{expected.inspect}"
       if expected.nil?
-        assert_nil Shipit::CSVSerializer.load(payload), message
+        assert_nil(Shipit::CSVSerializer.load(payload), message)
       else
         assert_equal(expected, Shipit::CSVSerializer.load(payload), message)
       end

data/test/unit/deploy_commands_test.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 module Shipit
@@ -10,7 +11,7 @@ module Shipit
         dependencies_steps!: ['bundle install --some-args'],
         deploy_steps!: ['bundle exec cap $ENVIRONMENT deploy'],
         rollback_steps!: ['bundle exec cap $ENVIRONMENT deploy:rollback'],
-        machine_env: {'GLOBAL' => '1'},
+        machine_env: { 'GLOBAL' => '1' },
         directory: nil,
         clear_working_directory?: true,
       )
@@ -62,8 +63,8 @@ module Shipit
       commands = @commands.clone
       assert_equal 2, commands.size
       clone_args = [
-        'git', 'clone', '--local',
-        '--origin', 'cache',
+        'git', 'clone', '--quiet',
+        '--local', '--origin', 'cache',
         @stack.git_path, @deploy.working_directory
       ]
       assert_equal clone_args, commands.first.args
@@ -190,7 +191,7 @@ module Shipit
     end
 
     test "the deploy's `env` is merged in ENVIRONMENT" do
-      @deploy.env = {'FOO' => 'BAR'}
+      @deploy.env = { 'FOO' => 'BAR' }
       command = @commands.install_dependencies.first
       assert_equal 'BAR', command.env['FOO']
     end
@@ -212,6 +213,15 @@ module Shipit
       assert_equal walrus.name, @commands.env['GIT_COMMITTER_NAME']
     end
 
+    test "GitHub repo details are exposed" do
+      assert_equal 'shopify', @commands.env['GITHUB_REPO_OWNER']
+      assert_equal 'shipit-engine', @commands.env['GITHUB_REPO_NAME']
+    end
+
+    test "Stack DEPLOY_URL is exposed" do
+      assert_equal "https://shipit.shopify.com", @commands.env['DEPLOY_URL']
+    end
+
     test "#clear_working_directory rm -rf the working directory" do
       FileUtils.expects(:rm_rf).with(@deploy.working_directory)
       @commands.clear_working_directory

data/test/unit/deploy_serializer_test.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+require 'test_helper'
+
+module Shipit
+  class DeploySerializerTest < ActiveSupport::TestCase
+    test 'deploy commits includes author object' do
+      deploy = shipit_deploys(:shipit)
+      first_commit_author = deploy.commits.first.author
+
+      serializer = ActiveModel::Serializer.serializer_for(deploy)
+      assert_equal DeploySerializer, serializer
+      serialized = serializer.new(deploy).to_json
+
+      assert_json("commits.0.author.name", first_commit_author.name, document: serialized)
+    end
+  end
+end

data/test/unit/environment_variables_test.rb

@@ -1,11 +1,12 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 module Shipit
   class EnvironmentVariablesTest < ActiveSupport::TestCase
     def setup
       variable_defs = [
-        {"name" => "FOO", "title" => "Set to 0 to foo", "default" => 1},
-        {"name" => "BAR", "title" => "Set to 1 to bar", "default" => 0},
+        { "name" => "FOO", "title" => "Set to 0 to foo", "default" => 1 },
+        { "name" => "BAR", "title" => "Set to 1 to bar", "default" => 0 },
       ]
       @variable_definitions = variable_defs.map(&VariableDefinition.method(:new))
     end
@@ -16,7 +17,7 @@ module Shipit
     end
 
     test 'correctly sanitizes env variables' do
-      env = {'FOO' => 1, 'BAR' => 1}
+      env = { 'FOO' => 1, 'BAR' => 1 }
       assert_equal env, EnvironmentVariables.with(env).permit(@variable_definitions)
     end
 
@@ -27,7 +28,7 @@ module Shipit
     end
 
     test 'throws an exception when a variable is not whitelisted' do
-      env = {'UNSAFE_VARIABLE' => 1}
+      env = { 'UNSAFE_VARIABLE' => 1 }
       assert_raises(EnvironmentVariables::NotPermitted) do
         EnvironmentVariables.with(env).permit(@variable_definitions)
       end

data/test/unit/github_app_test.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 module Shipit
@@ -5,6 +6,14 @@ module Shipit
     setup do
       @github = app
       @enterprise = app(domain: 'github.example.com')
+      @rails_env = Rails.env
+      @token_cache_key = 'github:integration:access-token'
+      Rails.cache.delete(@token_cache_key)
+    end
+
+    teardown do
+      Rails.env = @rails_env
+      Rails.cache.delete(@token_cache_key)
     end
 
     test "#initialize doesn't raise if given an empty config" do
@@ -13,6 +22,34 @@ module Shipit
       end
     end
 
+    test "#api_status" do
+      stub_request(:get, "https://www.githubstatus.com/api/v2/components.json").to_return(
+        status: 200,
+        body: %(
+          {
+            "page":{},
+            "components":[
+              {
+                "id":"brv1bkgrwx7q",
+                "name":"API Requests",
+                "status":"operational",
+                "created_at":"2017-01-31T20:01:46.621Z",
+                "updated_at":"2019-07-23T18:41:18.197Z",
+                "position":2,
+                "description":"Requests for GitHub APIs",
+                "showcase":false,
+                "group_id":null,
+                "page_id":"kctbh9vrtdwd",
+                "group":false,
+                "only_show_if_degraded":false
+              }
+            ]
+          }
+        ),
+      )
+      assert_equal "operational", app.api_status[:status]
+    end
+
     test "#domain defaults to github.com" do
       assert_equal 'github.com', @github.domain
     end
@@ -23,6 +60,11 @@ module Shipit
       assert_equal 'https://github.example.com/foo/bar/baz', @enterprise.url('foo/bar', 'baz')
     end
 
+    test "#new_client retruns an Octokit::Client configured to use the github installation" do
+      assert_equal 'https://github.example.com/', @enterprise.new_client.web_endpoint
+      assert_equal 'https://github.example.com/api/v3/', @enterprise.new_client.api_endpoint
+    end
+
     test "#oauth_config.last[:client_options] is nil if domain is not overriden" do
       assert_nil @github.oauth_config.last[:client_options][:site]
     end
@@ -31,6 +73,129 @@ module Shipit
       assert_equal 'https://github.example.com/api/v3/', @enterprise.oauth_config.last[:client_options][:site]
     end
 
+    test "#github token is refreshed after expiration" do
+      Rails.env = 'not_test'
+      config = {
+        app_id: "test_id",
+        installation_id: "test_installation_id",
+        private_key: "test_private_key",
+      }
+      initial_token = OpenStruct.new(
+        token: "some_initial_github_token",
+        expires_at: Time.now.utc + 60.minutes,
+      )
+      second_token = OpenStruct.new(
+        token: "some_new_github_token",
+        expires_at: initial_token.expires_at + 60.minutes,
+      )
+      auth_payload = "test_auth_payload"
+
+      GitHubApp.any_instance.expects(:authentication_payload).twice.returns(auth_payload)
+      valid_app = app(config)
+
+      freeze_time do
+        Octokit::Client
+          .any_instance
+          .expects(:create_app_installation_access_token).twice.with(config[:installation_id], anything)
+          .returns(initial_token, second_token)
+
+        initial_token = valid_app.token
+        initial_cached_token = Rails.cache.fetch(@token_cache_key)
+        assert_equal initial_token, initial_cached_token.to_s
+
+        travel 5.minutes
+        assert_equal initial_token, valid_app.token
+
+        travel_to initial_cached_token.expires_at + 5.minutes
+        assert_equal second_token.token, valid_app.token
+      end
+    end
+
+    test "#github token is refreshed in refresh window before expiry" do
+      Rails.env = 'not_test'
+      config = {
+        app_id: "test_id",
+        installation_id: "test_installation_id",
+        private_key: "test_private_key",
+      }
+      initial_token = OpenStruct.new(
+        token: "some_initial_github_token",
+        expires_at: Time.now.utc + 60.minutes,
+      )
+      second_token = OpenStruct.new(
+        token: "some_new_github_token",
+        expires_at: initial_token.expires_at + 60.minutes,
+      )
+      auth_payload = "test_auth_payload"
+
+      GitHubApp.any_instance.expects(:authentication_payload).twice.returns(auth_payload)
+      valid_app = app(config)
+
+      freeze_time do
+        Octokit::Client
+          .any_instance
+          .expects(:create_app_installation_access_token).twice.with(config[:installation_id], anything)
+          .returns(initial_token, second_token)
+
+        initial_token = valid_app.token
+        initial_cached_token = Rails.cache.fetch(@token_cache_key)
+        assert_equal initial_token, initial_cached_token.to_s
+
+        # Travel forward, but before the token is refreshed, so the cached value should be the same.
+        travel 40.minutes
+        assert_equal initial_token, valid_app.token
+
+        # Travel to when the token should refresh, but is not expired, which should result in our cache.fetch update block.
+        travel 15.minutes
+        updated_token = valid_app.token
+        assert_not_equal initial_token, updated_token
+
+        cached_token = Rails.cache.fetch(@token_cache_key)
+        assert_operator cached_token.expires_at, :>, initial_cached_token.expires_at
+      end
+    end
+
+    test "#github token is missing refresh_at field" do
+      # $debugging = true
+      Rails.env = 'not_test'
+      config = {
+        app_id: "test_id",
+        installation_id: "test_installation_id",
+        private_key: "test_private_key",
+      }
+      initial_cached_token = Shipit::GitHubApp::Token.new("some_initial_github_token", Time.now.utc - 1.minute)
+      initial_cached_token.instance_variable_set(:@refresh_at, nil)
+
+      second_token = OpenStruct.new(
+        token: "some_new_github_token",
+        expires_at: initial_cached_token.expires_at + 60.minutes,
+      )
+      auth_payload = "test_auth_payload"
+
+      GitHubApp.any_instance.expects(:authentication_payload).returns(auth_payload)
+      valid_app = app(config)
+
+      freeze_time do
+        valid_app.instance_variable_set(:@token, initial_cached_token)
+        Rails.cache.write(@token_cache_key, initial_cached_token, expires_in: 1.minute)
+
+        Octokit::Client
+          .any_instance
+          .expects(:create_app_installation_access_token).with(config[:installation_id], anything)
+          .returns(second_token)
+
+        first_token = valid_app.token
+
+        first_cached_token = Rails.cache.fetch(@token_cache_key)
+        assert_equal first_token, first_cached_token.to_s
+
+        travel_to first_cached_token.expires_at + 5.minutes
+        new_token = valid_app.token
+
+        assert_equal second_token.token, new_token
+      end
+    end
+
     private
 
     def app(extra_config = {})