Allow posting multiple configs, pass through merge_mode and sha (#1081)

* reformat request/create_spec

* allow passing merge_mode and sha

* allow posting multiple configs

Author: svenfuchs

lib/travis/api/v3/queries/request.rb

@@ -1,6 +1,6 @@
 module Travis::API::V3
   class Queries::Request < Query
-    params  :id, :message, :branch, :config, :token, prefix: :request
+    params :id, :message, :branch, :sha, :merge_mode, :config, :token, prefix: :request
 
     def find
       raise WrongParams, 'missing request.id'.freeze unless id
@@ -19,9 +19,9 @@ def messages(request)
 
     def schedule(repository, user)
       raise ServerError, 'repository does not have a provider id'.freeze unless repository.vcs_id || repository.github_id
-      raise WrongParams, 'missing user'.freeze                         unless user and user.id
+      raise WrongParams, 'missing user'.freeze unless user and user.id
 
-      record = create_request(repository)
+      request = create_request(repository)
 
       payload = {
         repository: {
@@ -30,11 +30,15 @@ def schedule(repository, user)
           owner_name: repository.owner_name,
           name: repository.name ,
         },
-        user:       { id: user.id },
-        id:         record.id,
-        message:    message,
-        branch:     branch || repository.default_branch_name,
-        config:     config || {}
+        user: {
+          id: user.id
+        },
+        id: request.id,
+        message: message,
+        branch: branch,
+        sha: sha,
+        merge_mode: merge_mode,
+        config: config
       }
 
       ::Travis::API::Sidekiq.gatekeeper(
@@ -47,14 +51,14 @@ def schedule(repository, user)
 
     private
 
-    def create_request(repository)
-      Models::Request.create!(
-        event_type: :api,
-        state:      :pending,
-        repository: repository,
-        owner:      repository.owner,
-        private:    repository.private
-      )
-    end
+      def create_request(repository)
+        Models::Request.create!(
+          event_type: :api,
+          state: :pending,
+          repository: repository,
+          owner: repository.owner,
+          private: repository.private
+        )
+      end
   end
 end

lib/travis/api/v3/queries/request_config.rb renamed to lib/travis/api/v3/queries/request_configs.rb

@@ -2,7 +2,7 @@
 require 'faraday'
 
 module Travis::API::V3
-  class Queries::RequestConfig < Query
+  class Queries::RequestConfigs < Query
     attr_reader :user, :repo
 
     def expand(user, repo)
@@ -73,7 +73,7 @@ def handle_errors(resp)
       end
 
       def params
-        only(super.deep_symbolize_keys, :ref, :config, :mode, :data)
+        only(super.deep_symbolize_keys, :ref, :configs, :data)
       end
 
       def only(hash, *keys)

lib/travis/api/v3/routes.rb

@@ -174,7 +174,7 @@ module Routes
       resource :request do
         route '/request/{request.id}'
         get  :find
-        post :config
+        post :configs
 
         resource :messages do
           route '/messages'

lib/travis/api/v3/services/request/config.rb

@@ -0,0 +1,26 @@
+module Travis::API::V3
+  class Services::Request::Configs < Service
+    result_type :request_configs
+    params :ref, :configs, :data
+    params :config, :mode # BC
+
+    def run
+      repository = check_login_and_find(:repository)
+      access_control.permissions(repository).create_request!
+      user = access_control.user
+      result query(:request_configs).expand(user, repo)
+    end
+
+    private
+
+      def params
+        @params = super.tap do |params|
+          params['configs'] = [{ config: params['config'], mode: params['mode'] }] if params['config'] # BC
+        end
+      end
+
+      def repo
+        @repo ||= find(:repository)
+      end
+  end
+end

lib/travis/api/v3/services/request/configs.rb

@@ -5,7 +5,7 @@ class Services::Requests::Create < Service
     private_constant :TIME_FRAME, :LIMIT
 
     result_type :request
-    params "request", "user", :config, :message, :branch, :token
+    params "request", "user", :merge_mode, :config, :message, :branch, :sha, :token
 
     def run
       repository = check_login_and_find(:repository)
@@ -14,9 +14,9 @@ def run
 
       raise RepositoryInactive, repository: repository unless repository.active?
 
-      user      = find(:user) if access_control.full_access? and params_for? 'user'.freeze
-      user    ||= access_control.user
-      max       = limit(repository)
+      user = find(:user) if access_control.full_access? and params_for? 'user'.freeze
+      user ||= access_control.user
+      max = limit(repository)
       remaining = remaining_requests(max, repository)
 
       raise RequestLimitReached, repository: repository, max_requests: max, per_seconds: TIME_FRAME.to_i if remaining == 0

lib/travis/api/v3/services/requests/create.rb

@@ -17,6 +17,7 @@
 require 'multi_json'
 require 'pry'
 require 'stackprof'
+require 'sidekiq/testing'
 require 'webmock/rspec'
 
 require 'active_record'

spec/spec_helper.rb

@@ -74,7 +74,14 @@ module Routes
               "@type"=>"template",
               "request_method"=>"POST",
               "uri_template"=>"#{path}repo/{repository.id}/requests",
-              "accepted_params" => ["request.config", "request.message", "request.branch", "request.token"]
+              "accepted_params" => %w(
+                request.merge_mode
+                request.config
+                request.message
+                request.branch
+                request.sha
+                request.token
+              )
             )
           end
         end

spec/v3/service_index_spec.rb

@@ -1,4 +1,4 @@
-describe Travis::API::V3::Services::Request::Config, set_app: true do
+describe Travis::API::V3::Services::Request::Configs, set_app: true do
   let(:repo) { FactoryBot.create(:repository_without_last_build, owner_name: 'svenfuchs', name: 'minimal') }
   let(:request) { Travis::API::V3::Models::Request.last }
   let(:env_var) { { id: nil, name: 'ONE', value: Travis::Settings::EncryptedValue.new('one'), public: true, branch: 'foo', repository_id: repo.id } }
@@ -36,7 +36,7 @@ def parse(str)
   end
 
   describe 'authenticated' do
-    let(:params) { { ref: 'master', config: '', mode: :deep_merge } }
+    let(:params) { { ref: 'master', configs: [config: '', mode: :deep_merge] } }
     let(:token) { Travis::Api::App::AccessToken.create(user: repo.owner, app_id: 1) }
     let(:headers) { { 'HTTP_AUTHORIZATION' => "token #{token}" } }
 
@@ -106,8 +106,10 @@ def parse(str)
             private_key: nil
           },
           ref: 'master',
-          config: '',
-          mode: 'deep_merge',
+          configs: [
+            config: '',
+            mode: 'deep_merge',
+          ],
           data: {
             repo: repo.slug,
             fork: false,