pass through multiple build request configs (#1090)

* pass through multiple build request configs

* rename request/configs to request/preview

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, :sha, :merge_mode, :config, :token, prefix: :request
+    params :id, :message, :branch, :sha, :merge_mode, :config, :configs, :token, prefix: :request
 
     def find
       raise WrongParams, 'missing request.id'.freeze unless id
@@ -37,8 +37,10 @@ def schedule(repository, user)
         message: message,
         branch: branch || repository.default_branch.name,
         sha: sha,
+        configs: request_configs,
+        # BC, remove once everyone is on yml/configs, coordinate with Gatekeeper
         merge_mode: merge_mode,
-        config: config
+        config: to_str(config),
       }
 
       ::Travis::API::Sidekiq.gatekeeper(
@@ -51,6 +53,17 @@ def schedule(repository, user)
 
     private
 
+      def request_configs
+        configs = self.configs
+        configs.each { |config| config['config'] = to_str(config['config']) } if configs
+        configs ||= [{ config: to_str(config), merge_mode: merge_mode }] if config
+        configs
+      end
+
+      def to_str(config)
+        config.is_a?(Hash) ? JSON.dump(config) : config
+      end
+
       def create_request(repository)
         Models::Request.create!(
           event_type: :api,

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

@@ -2,7 +2,7 @@
 require 'faraday'
 
 module Travis::API::V3
-  class Queries::RequestConfigs < Query
+  class Queries::RequestPreview < Query
     attr_reader :user, :repo
 
     def expand(user, repo)

lib/travis/api/v3/renderer/request_configs.rb renamed to lib/travis/api/v3/renderer/request_preview.rb

@@ -1,5 +1,5 @@
 module Travis::API::V3
-  class Renderer::RequestConfigs < ModelRenderer
+  class Renderer::RequestPreview < ModelRenderer
     representation(:minimal, :raw_configs, :request_config, :job_configs, :messages, :full_messages)
     representation(:standard, *representations[:minimal])
   end

lib/travis/api/v3/routes.rb

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

lib/travis/api/v3/services/request/configs.rb renamed to lib/travis/api/v3/services/request/preview.rb

@@ -1,14 +1,14 @@
 module Travis::API::V3
-  class Services::Request::Configs < Service
-    result_type :request_configs
+  class Services::Request::Preview < Service
+    result_type :request_preview
     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)
+      result query(:request_preview).expand(user, repo)
     end
 
     private

spec/v3/services/request/configs_spec.rb renamed to spec/v3/services/request/preview_spec.rb

@@ -1,4 +1,4 @@
-describe Travis::API::V3::Services::Request::Configs, set_app: true do
+describe Travis::API::V3::Services::Request::Preview, 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 } }
@@ -24,7 +24,7 @@ def parse(str)
   end
 
   describe 'not authenticated' do
-    before { post("/v3/repo/#{repo.id}/request/configs") }
+    before { post("/v3/repo/#{repo.id}/request/preview") }
     it { expect(status).to eq 403 }
     it do
       expect(body).to eq(
@@ -47,7 +47,7 @@ def parse(str)
 
     it do
       expect(body).to eq(
-        '@type': 'request_configs',
+        '@type': 'request_preview',
         '@representation': 'standard',
         raw_configs: [
           '@type': 'request_raw_configuration',

spec/v3/services/requests/create_spec.rb

@@ -136,7 +136,8 @@
       branch: 'master',
       sha: nil,
       merge_mode: nil,
-      config: nil
+      config: nil,
+      configs: nil
     }
   end
 
@@ -206,7 +207,7 @@
 
     describe 'overriding config' do
       let(:params) { { config: { script: 'true' } } }
-      it { expect(sidekiq_payload).to eq payload.merge(config: params[:config]) }
+      it { expect(sidekiq_payload).to eq payload.merge(config: '{"script":"true"}', configs: [config: '{"script":"true"}', merge_mode: nil]) }
     end
 
     describe 'overriding message' do