Remove branch and commit parameters and add environment

Author: iangmaia

lib/fastlane/plugin/wpmreleasetoolkit/actions/common/buildkite_upload_pipeline_action.rb

@@ -2,31 +2,23 @@ module Fastlane
   module Actions
     class BuildkiteUploadPipelineAction < Action
       DEFAULT_ENV_FILE = File.join('.buildkite', 'shared-pipeline-vars').freeze
-      DEFAULT_COMMIT = 'HEAD'.freeze
 
       def self.run(params)
-        env_file = params[:env_file]
         pipeline_file = params[:pipeline_file]
-        branch = params[:branch]
-        commit = params[:commit]
+        env_file = params[:env_file]
+        environment = params[:environment]
 
         UI.user_error!("Pipeline file not found: #{pipeline_file}") unless File.exist?(pipeline_file)
-        UI.user_error!('You should not provide both `branch` and `commit`') if !branch.nil? && commit != DEFAULT_COMMIT
         UI.user_error!('This action can only be called from a Buildkite CI build') unless ENV['BUILDKITE'] == 'true'
 
-        UI.message "Adding steps from `#{pipeline_file}` to the current build (#{"branch: `#{branch}`, " if branch}commit: `#{commit}`)"
-
-        env_vars = {
-          'BUILDKITE_BRANCH' => branch,
-          'BUILDKITE_COMMIT' => commit
-        }.compact
+        UI.message "Adding steps from `#{pipeline_file}` to the current build"
 
         if env_file && File.exist?(env_file)
           UI.message(" - Sourcing environment file beforehand: #{env_file}")
 
-          sh(env_vars, "source #{env_file.shellescape} && buildkite-agent pipeline upload #{pipeline_file.shellescape}")
+          sh(environment, "source #{env_file.shellescape} && buildkite-agent pipeline upload #{pipeline_file.shellescape}")
         else
-          sh(env_vars, 'buildkite-agent', 'pipeline', 'upload', pipeline_file)
+          sh(environment, 'buildkite-agent', 'pipeline', 'upload', pipeline_file)
         end
       end
 
@@ -51,17 +43,10 @@ def self.available_options
             type: String
           ),
           FastlaneCore::ConfigItem.new(
-            key: :branch,
-            description: 'The branch you want to run the pipeline on',
-            optional: true,
-            type: String
-          ),
-          FastlaneCore::ConfigItem.new(
-            key: :commit,
-            description: 'The commit hash you want to run the pipeline on',
-            optional: true,
-            default_value: DEFAULT_COMMIT,
-            type: String
+            key: :environment,
+            description: 'Environment variables to load when running `pipeline upload`, to allow for variable substitution in the YAML pipeline',
+            type: Hash,
+            default_value: {}
           ),
         ]
       end

spec/buildkite_upload_pipeline_action_spec.rb

@@ -2,11 +2,10 @@
 
 describe Fastlane::Actions::BuildkiteUploadPipelineAction do
   let(:pipeline_file) { 'path/to/pipeline.yml' }
-  let(:branch) { 'feature-branch' }
-  let(:commit) { 'abc123' }
-  let(:commit_default) { Fastlane::Actions::BuildkiteUploadPipelineAction::DEFAULT_COMMIT }
   let(:env_file) { 'path/to/env_file' }
   let(:env_file_default) { Fastlane::Actions::BuildkiteUploadPipelineAction::DEFAULT_ENV_FILE }
+  let(:environment) { { 'AKEY' => 'AVALUE' } }
+  let(:environment_default) { {} }
 
   before do
     allow(File).to receive(:exist?).with(anything)
@@ -17,70 +16,58 @@
   describe 'parameter validation' do
     it 'raises an error when pipeline_file is not provided' do
       expect do
-        run_described_fastlane_action(branch: branch)
+        run_described_fastlane_action(
+          environment: environment
+        )
       end.to raise_error(FastlaneCore::Interface::FastlaneError, /pipeline_file/)
     end
 
     it 'raises an error when pipeline_file does not exist' do
       allow(File).to receive(:exist?).with(pipeline_file).and_return(false)
       expect do
-        run_described_fastlane_action(
-          pipeline_file: pipeline_file,
-          branch: branch
-        )
+        run_described_fastlane_action(pipeline_file: pipeline_file)
       end.to raise_error(FastlaneCore::Interface::FastlaneError, /Pipeline file not found/)
     end
 
-    it 'raises an error when both branch and commit are provided' do
+    it 'raises an error when not running on Buildkite' do
       allow(File).to receive(:exist?).with(pipeline_file).and_return(true)
+      allow(ENV).to receive(:[]).with('BUILDKITE').and_return(nil)
+
       expect do
-        run_described_fastlane_action(
-          pipeline_file: pipeline_file,
-          branch: branch,
-          commit: commit
-        )
-      end.to raise_error(FastlaneCore::Interface::FastlaneError, /You should not provide both `branch` and `commit`/)
+        run_described_fastlane_action(pipeline_file: pipeline_file)
+      end.to raise_error(FastlaneCore::Interface::FastlaneError, /This action can only be called from a Buildkite CI build/)
     end
 
-    it 'uses the default value for commit when not provided' do
+    it 'passes the environment hash to the shell command' do
       allow(File).to receive(:exist?).with(pipeline_file).and_return(true)
       expect(Fastlane::Action).to receive(:sh).with(
-        { 'BUILDKITE_BRANCH' => branch, 'BUILDKITE_COMMIT' => commit_default },
+        environment,
         'buildkite-agent', 'pipeline', 'upload', pipeline_file
       )
       expect_upload_pipeline_message
 
       run_described_fastlane_action(
         pipeline_file: pipeline_file,
-        branch: branch
+        environment: environment
       )
     end
 
-    it 'uses the provided value for the commit' do
+    it 'passes the environment hash to the shell command also with an env_file' do
       allow(File).to receive(:exist?).with(pipeline_file).and_return(true)
+      allow(File).to receive(:exist?).with(env_file).and_return(true)
       expect(Fastlane::Action).to receive(:sh).with(
-        { 'BUILDKITE_COMMIT' => commit },
-        'buildkite-agent', 'pipeline', 'upload', pipeline_file
+        environment,
+        "source #{env_file.shellescape} && buildkite-agent pipeline upload #{pipeline_file.shellescape}"
       )
-      expect_upload_pipeline_message(expected_branch: nil, expected_commit: commit)
+      expect_upload_pipeline_message
+      expect_sourcing_env_file_message(env_file)
 
       run_described_fastlane_action(
         pipeline_file: pipeline_file,
-        commit: commit
+        environment: environment,
+        env_file: env_file
       )
     end
-
-    it 'raises an error when not running on Buildkite' do
-      allow(File).to receive(:exist?).with(pipeline_file).and_return(true)
-      allow(ENV).to receive(:[]).with('BUILDKITE').and_return(nil)
-
-      expect do
-        run_described_fastlane_action(
-          pipeline_file: pipeline_file,
-          branch: branch
-        )
-      end.to raise_error(FastlaneCore::Interface::FastlaneError, /This action can only be called from a Buildkite CI build/)
-    end
   end
 
   describe 'pipeline upload' do
@@ -90,61 +77,55 @@
 
     it 'calls the right command to upload the pipeline without env_file' do
       expect(Fastlane::Action).to receive(:sh).with(
-        { 'BUILDKITE_BRANCH' => branch, 'BUILDKITE_COMMIT' => commit_default },
+        environment_default,
         'buildkite-agent', 'pipeline', 'upload', pipeline_file
       )
       expect_upload_pipeline_message
 
-      run_described_fastlane_action(
-        pipeline_file: pipeline_file,
-        branch: branch
-      )
+      run_described_fastlane_action(pipeline_file: pipeline_file)
     end
 
     it 'calls the right command to upload the pipeline with env_file' do
       allow(File).to receive(:exist?).with(env_file).and_return(true)
       expect(Fastlane::Action).to receive(:sh).with(
-        { 'BUILDKITE_BRANCH' => branch, 'BUILDKITE_COMMIT' => commit_default },
+        environment_default,
         "source #{env_file.shellescape} && buildkite-agent pipeline upload #{pipeline_file.shellescape}"
       )
       expect_upload_pipeline_message
-      expect(Fastlane::UI).to receive(:message).with(/Sourcing environment file beforehand: #{env_file}/)
+      expect_sourcing_env_file_message(env_file)
 
       run_described_fastlane_action(
         pipeline_file: pipeline_file,
-        env_file: env_file,
-        branch: branch
+        env_file: env_file
       )
     end
 
     it 'skips sourcing env_file when it does not exist' do
       non_existent_env_file = 'path/to/non_existent_env_file'
       allow(File).to receive(:exist?).with(non_existent_env_file).and_return(false)
       expect(Fastlane::Action).to receive(:sh).with(
-        { 'BUILDKITE_BRANCH' => branch, 'BUILDKITE_COMMIT' => commit_default },
+        environment_default,
         'buildkite-agent', 'pipeline', 'upload', pipeline_file
       )
       expect(Fastlane::UI).not_to receive(:message).with(/Sourcing environment file/)
 
       run_described_fastlane_action(
         pipeline_file: pipeline_file,
-        env_file: non_existent_env_file,
-        branch: branch
+        env_file: non_existent_env_file
       )
     end
 
     it 'uses a default env_file when no env_file is provided' do
       allow(File).to receive(:exist?).with(env_file_default).and_return(true)
       expect(Fastlane::Action).to receive(:sh).with(
-        { 'BUILDKITE_BRANCH' => branch, 'BUILDKITE_COMMIT' => commit_default },
+        environment_default,
         "source #{env_file_default} && buildkite-agent pipeline upload #{pipeline_file.shellescape}"
       )
       expect_upload_pipeline_message
-      expect(Fastlane::UI).to receive(:message).with(/Sourcing environment file beforehand: #{env_file_default}/)
+      expect_sourcing_env_file_message(env_file_default)
 
       run_described_fastlane_action(
-        pipeline_file: pipeline_file,
-        branch: branch
+        pipeline_file: pipeline_file
       )
     end
   end
@@ -156,16 +137,21 @@
 
       expect do
         run_described_fastlane_action(
-          pipeline_file: pipeline_file,
-          branch: branch
+          pipeline_file: pipeline_file
         )
       end.to raise_error(StandardError, 'Upload failed')
     end
   end
 
-  def expect_upload_pipeline_message(expected_branch: branch, expected_commit: commit_default)
+  def expect_upload_pipeline_message
+    expect(Fastlane::UI).to receive(:message).with(
+      "Adding steps from `#{pipeline_file}` to the current build"
+    )
+  end
+
+  def expect_sourcing_env_file_message(env_file)
     expect(Fastlane::UI).to receive(:message).with(
-      "Adding steps from `#{pipeline_file}` to the current build (#{expected_branch ? "branch: `#{expected_branch}`, " : ''}commit: `#{expected_commit}`)"
+      /Sourcing environment file beforehand: #{env_file}/
     )
   end
 end