Set locales in test environment to avoid failed specs

[PierreMesure]

References

• Closes Translatable spec should pass even if some languages are disabled #3526

Objectives

A few different specs fail when you inactivate certain languages.

This is a problem because you want people to keep a clean test suite for their forks but they might want to disable languages.

We solve this by overriding the available languages for the test environment.

Notes

• Right now, I am setting only the necessary languages (en, es, fr, nl, pt-BR). This is open to discussion.

[javierm]

I really like the idea of setting only the necessary languages 👍. We definitely need pt-BR (or a similar language) available in the test environment so we make sure we handle language names containing a - properly. Maybe in the future we find a way for our tests to dynamically choose which languages to use among the ones enabled, or just use imaginary languages which are added during a test, but for now I think this idea is simple and does the job really well.

[javierm]

There's only a small problem after applying these changes to current master: the tests for remote translations assume a few more languages are available. @taitus What do you think about changing the remote translations spec to use less languages? For example:

diff --git a/spec/features/remote_translations_spec.rb b/spec/features/remote_translations_spec.rb
index 1ff98d9..92a16d1 100644
--- a/spec/features/remote_translations_spec.rb
+++ b/spec/features/remote_translations_spec.rb
@@ -5,8 +5,7 @@ describe "Remote Translations" do
   before do
     Setting["feature.remote_translations"] = true
     create(:proposal)
-    available_locales_response = ["ar", "de", "en", "es", "fa", "fr", "he", "it", "nl", "pl",
-                                  "pt", "sv", "zh-Hans", "zh-Hant"]
+    available_locales_response = %w[de en es fr pt zh-Hans]
     expect(RemoteTranslations::Microsoft::AvailableLocales).to receive(:available_locales).
                                                             and_return(available_locales_response)
   end
@@ -27,18 +26,14 @@ describe "Remote Translations" do
       end
 
       scenario "should display text in English" do
-        available_locales_with_fallback_en = [:ar, :de, :fa, :he, :nl, :pl, :sv]
-
-        visit root_path(locale: available_locales_with_fallback_en.sample)
+        visit root_path(locale: :de)
 
         expect(page).to have_css ".remote-translations-button"
         expect(page).to have_content "The content of this page is not available in your language"
       end
 
       scenario "should display text in English after parse key" do
-        available_locales_with_fallback_en = [:"zh-CN", :"zh-TW"]
-
-        visit root_path(locale: available_locales_with_fallback_en.sample)
+        visit root_path(locale: :"zh-CN")
 
         expect(page).to have_css ".remote-translations-button"
         expect(page).to have_content "The content of this page is not available in your language"
@@ -53,9 +48,7 @@ describe "Remote Translations" do
       end
 
       scenario "with locale that has :es fallback" do
-        available_locales_with_fallback_es = [:es, :fr, :it]
-
-        visit root_path(locale: available_locales_with_fallback_es.sample)
+        visit root_path(locale: :fr)
 
         expect(page).to have_css ".remote-translations-button"
         expect(page).to have_content "El contenido de esta página no está disponible en tu idioma"
@@ -72,9 +65,7 @@ describe "Remote Translations" do
   end
 
   scenario "Not display remote translation button when locale is not included in microsoft translate client" do
-    not_available_locales = [:val, :gl, :sq]
-
-    visit root_path(locale: not_available_locales.sample)
+    visit root_path(locale: :nl)
 
     expect(page).not_to have_css ".remote-translations-button"
   end

[PierreMesure]

Hey Javier, great that you're looking at this! I just applied the changes you requested!

[javierm]

@PierreMesure Here's a patch which will (hopefully) make the remote translation tests compatible with this pull request. You can apply it using git am 0001-Reduce-locales-used-in-remote-translations-tests.txt.

0001-Reduce-locales-used-in-remote-translations-tests.txt

Once you apply the patch, push the changes and then I think we can safely merge this pull request 🎉.

[javierm]

@PierreMesure Awesome! Thank you very much! 🎉