Add high-level tests for the current .po generation behavior (#326)

Author: mokagio

.rubocop.yml

@@ -67,6 +67,7 @@ Metrics/BlockLength:
   Max: 80
   Exclude:
    - spec/**/*_spec.rb
+   - spec/**/shared_examples_*.rb
 
 Metrics/ClassLength:
   Max: 300

.rubocop_todo.yml

@@ -132,6 +132,7 @@ RSpec/FilePath:
     - 'spec/android_merge_translators_strings_spec.rb'
     - 'spec/android_version_helper_spec.rb'
     - 'spec/an_metadata_update_helper_spec.rb'
+    - 'spec/an_update_metadata_source_spec.rb'
     - 'spec/configuration_spec.rb'
     - 'spec/configure_helper_spec.rb'
     - 'spec/encryption_helper_spec.rb'
@@ -145,6 +146,7 @@ RSpec/FilePath:
     - 'spec/ios_generate_strings_file_from_code_spec.rb'
     - 'spec/ios_l10n_helper_spec.rb'
     - 'spec/ios_merge_strings_files_spec.rb'
+    - 'spec/gp_update_metadata_source_spec.rb'
 
 # Offense count: 8
 # Cop supports --auto-correct.

spec/an_update_metadata_source_spec.rb

@@ -0,0 +1,6 @@
+require 'spec_helper'
+require 'shared_examples_for_update_metadata_source_action'
+
+describe Fastlane::Actions::AnUpdateMetadataSourceAction do
+  include_examples 'update_metadata_source_action', whats_new_fails: true
+end

spec/gp_update_metadata_source_spec.rb

@@ -0,0 +1,6 @@
+require 'spec_helper'
+require 'shared_examples_for_update_metadata_source_action'
+
+describe Fastlane::Actions::GpUpdateMetadataSourceAction do
+  include_examples 'update_metadata_source_action', whats_new_fails: false
+end

spec/shared_examples_for_update_metadata_source_action.rb

@@ -0,0 +1,161 @@
+require 'spec_helper'
+
+RSpec.shared_examples 'update_metadata_source_action' do |options|
+  it 'updates any block in a given .po file with the values from the given sources' do
+    Dir.mktmpdir do |dir|
+      output_path = File.join(dir, 'output.po')
+      dummy_text = <<~PO
+        msgctxt "key1"
+        msgid "this value should change"
+        msgstr ""
+        msgctxt "key2"
+        msgid "this value should change, too"
+        msgstr ""
+      PO
+      File.write(output_path, dummy_text)
+
+      file_1_path = File.join(dir, '1.txt')
+      File.write(file_1_path, 'value 1')
+      file_2_path = File.join(dir, '2.txt')
+      File.write(file_2_path, 'value 2')
+
+      described_class.run(
+        po_file_path: output_path,
+        source_files: {
+          key1: file_1_path,
+          key2: file_2_path
+        }
+      )
+
+      expected = <<~PO
+        msgctxt "key1"
+        msgid "value 1"
+        msgstr ""
+
+        msgctxt "key2"
+        msgid "value 2"
+        msgstr ""
+
+      PO
+      expect(File.read(output_path)).to eq(expected)
+    end
+  end
+
+  it 'combines the given `release_version` and `whats_new` parameter into a new block' do
+    pending 'this currently fails; in the long run, we might consolidate `whats_new` with `release_notes`' if options[:whats_new_fails]
+
+    Dir.mktmpdir do |dir|
+      output_path = File.join(dir, 'output.po')
+      dummy_text = <<~PO
+        msgctxt "v1.0-whats-new"
+        msgid "this will not change"
+        msgstr ""
+      PO
+      File.write(output_path, dummy_text)
+
+      whats_new_path = File.join(dir, 'whats_new.txt')
+      File.write(whats_new_path, "- something new\n- something else new")
+
+      described_class.run(
+        po_file_path: output_path,
+        release_version: '1.23',
+        source_files: {
+          whats_new: whats_new_path
+        }
+      )
+
+      expected = <<~'PO'
+        msgctxt "v1.23-whats-new"
+        msgid ""
+        "- something new\n"
+        "- something else new\n"
+        msgstr ""
+
+      PO
+      expect(File.read(output_path)).to eq(expected)
+    end
+  end
+
+  it 'adds entries passed as input even if not part of the original `.po` file' do
+    pending 'this currently fails and will be addressed as part of the upcoming refactor/rewrite of the functionality'
+
+    Dir.mktmpdir do |dir|
+      output_path = File.join(dir, 'output.po')
+      dummy_text = <<~PO
+        msgctxt "key1"
+        msgid "this value should change"
+        msgstr ""
+      PO
+      File.write(output_path, dummy_text)
+
+      # 2: Create source files with value to insert in the .po
+      file_1_path = File.join(dir, '1.txt')
+      File.write(file_1_path, 'value 1')
+      file_2_path = File.join(dir, '2.txt')
+      File.write(file_2_path, 'value 2')
+
+      described_class.run(
+        po_file_path: output_path,
+        source_files: {
+          key1: file_1_path,
+          key2: file_2_path
+        }
+      )
+
+      expected = <<~PO
+        msgctxt "key1"
+        msgid "value 1"
+        msgstr ""
+
+        msgctxt "key2"
+        msgid "value 2"
+        msgstr ""
+
+      PO
+      expect(File.read(output_path)).to eq(expected)
+    end
+  end
+
+  it 'combines the given `release_version` and `release_notes` in a new block, keeps the n-1 ones, and deletes the others' do
+    Dir.mktmpdir do |dir|
+      output_path = File.join(dir, 'output.po')
+      dummy_text = <<~PO
+        msgctxt "release_note_0122"
+        msgid "previous version notes required to have current one added"
+        msgstr ""
+        msgctxt "release_note_0121"
+        msgid "this older release notes block should be removed"
+        msgstr ""
+        msgctxt "release_note_0120"
+        msgid "this older release notes block should be removed"
+        msgstr ""
+      PO
+      File.write(output_path, dummy_text)
+
+      release_notes_path = File.join(dir, 'release_notes.txt')
+      File.write(release_notes_path, "- release notes\n- more release notes")
+
+      described_class.run(
+        po_file_path: output_path,
+        release_version: '1.23',
+        source_files: {
+          release_note: release_notes_path
+        }
+      )
+
+      expected = <<~'PO'
+        msgctxt "release_note_0123"
+        msgid ""
+        "1.23:\n"
+        "- release notes\n"
+        "- more release notes\n"
+        msgstr ""
+
+        msgctxt "release_note_0122"
+        msgid "previous version notes required to have current one added"
+        msgstr ""
+      PO
+      expect(File.read(output_path).inspect).to eq(expected.inspect)
+    end
+  end
+end