Merge pull request #427 from wordpress-mobile/upload_to_s3-skip_if_exists

Allow `upload_to_s3` not to crash if file exists

Author: AliSoftware

CHANGELOG.md

@@ -12,7 +12,7 @@
 
 ### New Features
 
-_None_
+- Allow `upload_to_s3` action to just log instead of crash (using new `skip_if_exists` parameter) when the file already exists in the S3 bucket. [#427]
 
 ### Bug Fixes
 

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

@@ -20,7 +20,15 @@ def self.run(params)
           key = [file_name_hash, key].join('/')
         end
 
-        UI.user_error!("File already exists in S3 bucket #{bucket} at #{key}") if file_is_already_uploaded?(bucket, key)
+        if file_is_already_uploaded?(bucket, key)
+          message = "File already exists in S3 bucket #{bucket} at #{key}"
+          if params[:skip_if_exists]
+            UI.important("#{message}. Skipping upload.")
+            return key
+          else
+            UI.user_error!(message)
+          end
+        end
 
         UI.message("Uploading #{file_path} to: #{key}")
 
@@ -101,6 +109,13 @@ def self.available_options
             default_value: true,
             type: Boolean
           ),
+          FastlaneCore::ConfigItem.new(
+            key: :skip_if_exists,
+            description: 'If the file already exists in the S3 bucket, skip the upload (and report it in the logs), instead of failing with `user_error!`',
+            optional: true,
+            default_value: false,
+            type: Boolean
+          ),
         ]
       end
 

spec/upload_to_s3_spec.rb

@@ -144,18 +144,39 @@ def stub_s3_response_for_file(key, exists: true)
       end.to raise_error(FastlaneCore::Interface::FastlaneError, 'Path `this-file-does-not-exist.txt` does not exist.')
     end
 
-    it 'fails if the file already exists on S3' do
-      expected_key = 'a62f2225bf70bfaccbc7f1ef2a397836717377de/key'
-      stub_s3_response_for_file(expected_key)
+    context 'when the file already exists on S3' do
+      it 'fails if skip_if_exists:false' do
+        expected_key = 'a62f2225bf70bfaccbc7f1ef2a397836717377de/key'
+        stub_s3_response_for_file(expected_key)
+
+        with_tmp_file(named: 'key') do |file_path|
+          expect do
+            run_described_fastlane_action(
+              bucket: test_bucket,
+              key: 'key',
+              file: file_path
+            )
+          end.to raise_error(FastlaneCore::Interface::FastlaneError, "File already exists in S3 bucket #{test_bucket} at #{expected_key}")
+        end
+      end
 
-      with_tmp_file(named: 'key') do |file_path|
-        expect do
-          run_described_fastlane_action(
+      it 'logs a message without failing if skip_if_exists:true' do
+        expected_key = 'a62f2225bf70bfaccbc7f1ef2a397836717377de/key'
+        stub_s3_response_for_file(expected_key)
+
+        warnings = []
+        allow(FastlaneCore::UI).to receive(:important) { |message| warnings << message }
+
+        with_tmp_file(named: 'key') do |file_path|
+          key = run_described_fastlane_action(
             bucket: test_bucket,
             key: 'key',
-            file: file_path
+            file: file_path,
+            skip_if_exists: true
           )
-        end.to raise_error(FastlaneCore::Interface::FastlaneError, "File already exists in S3 bucket #{test_bucket} at #{expected_key}")
+          expect(warnings).to eq(["File already exists in S3 bucket #{test_bucket} at #{expected_key}. Skipping upload."])
+          expect(key).to eq(expected_key)
+        end
       end
     end
   end