using ulp to improve TranslateManager GetTargetLanguage() and InitiateTranslation()

components/translate/core/browser/translate_manager_unittest.cc

 // Copyright 2015 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "components/translate/core/browser/translate_manager.h"
 
 #include "base/run_loop.h"
 #include "base/test/histogram_tester.h"
 #include "build/build_config.h"
 #include "components/infobars/core/infobar.h"
 #include "components/pref_registry/pref_registry_syncable.h"
 #include "components/pref_registry/testing_pref_service_syncable.h"
 #include "components/translate/core/browser/mock_translate_driver.h"
 #include "components/translate/core/browser/translate_browser_metrics.h"
 #include "components/translate/core/browser/translate_client.h"
 #include "components/translate/core/browser/translate_download_manager.h"
 #include "components/translate/core/browser/translate_prefs.h"
 #include "components/translate/core/common/translate_pref_names.h"
 #include "net/base/network_change_notifier.h"
 #include "testing/gmock/include/gmock/gmock.h"
 #include "testing/gtest/include/gtest/gtest.h"
 
+using testing::_;
+using testing::Return;
+using testing::SetArgPointee;
+
 namespace translate {
 
 namespace {
 
 #if defined(OS_CHROMEOS)
 const char kLanguagePreferredLanguages[] =
     "settings.language.preferred_languages";
 #else
 const char* kLanguagePreferredLanguages = nullptr;
 #endif
@@ skipping 98 matching lines @@
 #if defined(OS_CHROMEOS)
     prefs_.registry()->RegisterStringPref(kLanguagePreferredLanguages,
                                           std::string());
 #endif
     TranslatePrefs::RegisterProfilePrefs(prefs_.registry());
     // TODO(groby): Figure out RegisterProfilePrefs() should register this.
     prefs_.registry()->RegisterBooleanPref(
         prefs::kEnableTranslate, true,
         user_prefs::PrefRegistrySyncable::SYNCABLE_PREF);
     manager_->ResetForTesting();
+
+    base::FeatureList::ClearInstanceForTesting();
+    base::FeatureList::SetInstance(base::WrapUnique(new base::FeatureList()));
   }
   user_prefs::TestingPrefServiceSyncable prefs_;
 
   // TODO(groby): request TranslatePrefs from |mock_translate_client_| instead.
   TranslatePrefs translate_prefs_;
   TranslateDownloadManager* manager_;
 
   TestNetworkChangeNotifier network_notifier_;
   translate::testing::MockTranslateDriver driver_;
   ::testing::NiceMock<MockTranslateClient> mock_translate_client_;
   std::unique_ptr<TranslateManager> translate_manager_;
 
+  void TurnOnTranslateByULP() {
+    base::FeatureList::ClearInstanceForTesting();
+    std::unique_ptr<base::FeatureList> feature_list(new base::FeatureList);
+    feature_list->InitializeFromCommandLine(
+        translate::kTranslateLanguageByULP.name, std::string());
+    base::FeatureList::SetInstance(std::move(feature_list));
+  }
   void TearDown() override { manager_->ResetForTesting(); }
 };
 
 }  // namespace
 
 // Target language comes from application locale if the locale's language
 // is supported.
 TEST_F(TranslateManagerTest, GetTargetLanguageDefaultsToAppLocale) {
   // Ensure the locale is set to a supported language.
   ASSERT_TRUE(TranslateDownloadManager::IsSupportedLanguage("en"));
@@ skipping 55 matching lines @@
 
   // In the online case, InitiateTranslation will proceed past early out tests.
   network_notifier_.SimulateOnline();
   translate_manager_->InitiateTranslation("de");
   histogram_tester.ExpectUniqueSample(
       kMetricName,
       translate::TranslateBrowserMetrics::INITIATION_STATUS_DISABLED_BY_PREFS,
       1);
 }
 
+class MockTranslatePrefs : public TranslatePrefs {

[groby-ooo-7-16, 2016/08/02 00:38:21]

Please don't mock translate prefs. This seems to just repeat the test from
TranslatePrefs as far as I can tell?

But even if it doesn't, you already have TestingPrefSyncable available via
prefs_/translate_prefs_

[ftang, 2016/08/03 02:01:18]

I have to mock the TranslatePrefs so I can test the logic (considering the
threshold, etc) in TranslateManager.cc . There are no repeated test.

+ public:
+  MockTranslatePrefs()
+      : TranslatePrefs(nullptr, kAcceptLanguages, kLanguagePreferredLanguages) {
+  }
+
+  virtual ~MockTranslatePrefs() {}
+  MOCK_CONST_METHOD1(GetReadingFromUserLanguageProfile,
+                     double(LanguageProbabilityList* list));
+  MOCK_CONST_METHOD1(GetWritingFromUserLanguageProfile,
+                     double(LanguageProbabilityList* list));
+};
+
+TEST_F(TranslateManagerTest, TestGetTargetLanguageFromULP) {
+  // Test 6 different cases:
+  // Case 1. The feature is turn OFF. Expect to return "".
+  // Case 2-6 The feature is turn ON.
+  // Case 2. The confidence of the reading list is 0.0. Expect to return "".
+  // Case 3. The confidence of the reading list is low. Expect to return "".
+  // Case 4. The confidence of the reading list is high enough but there
+  //         are somehow no items in the list. Expect to return "".
+  // Case 5. The confidence of the reading list is high enough and
+  //         the first item is "fr" with high probability. Expect to return
+  //         "fr".
+  // Case 6. The confidence of the reading list is high enough and the first
+  //         item is "pl" with low probability. Expect to return "".
+
+  ::testing::NiceMock<MockTranslatePrefs> mock_translate_prefs;
+
+  // For case 4- no items in the list.
+  TranslatePrefs::LanguageProbabilityList list4;
+
+  // For case 5 - "fr" with high (0.9) probability on the list.
+  TranslatePrefs::LanguageProbabilityList list5;
+  list5.push_back(std::make_pair("fr", 0.9));
+
+  // For case 6 - "pl" with low (0.25) probability on the list.
+  TranslatePrefs::LanguageProbabilityList list6;
+  list6.push_back(std::make_pair("pl", 0.25));
+
+  // Only be called for case 2-6.
+  EXPECT_CALL(mock_translate_prefs,
+              GetReadingFromUserLanguageProfile(_))
+      .Times(5)
+      .WillOnce(Return(0.0))                                   // For case 2.
+      .WillOnce(Return(0.2))                                   // For case 3.
+      .WillOnce(DoAll(SetArgPointee<0>(list4), Return(0.9)))   // For case 4.
+      .WillOnce(DoAll(SetArgPointee<0>(list5), Return(0.9)))   // For case 5.
+      .WillOnce(DoAll(SetArgPointee<0>(list6), Return(0.9)));  // For case 6.
+
+  // Case 1. The feature is turn OFF. Expect to return "".
+  EXPECT_TRUE(TranslateManager::GetTargetLanguageFromULP(&mock_translate_prefs)
+                  .empty());
+
+  // Case 2-6 The feature is turn ON.
+  TurnOnTranslateByULP();
+
+  // Case 2. The confidence of the reading list is 0.0. Expect to return "".
+  EXPECT_TRUE(TranslateManager::GetTargetLanguageFromULP(&mock_translate_prefs)
+                  .empty());
+
+  // Case 3. The confidence of the reading list is low. Expect to return "".
+  EXPECT_TRUE(TranslateManager::GetTargetLanguageFromULP(&mock_translate_prefs)
+                  .empty());
+
+  // Case 4. The confidence of the reading list is high enough but there are
+  //         somehow no items in the list. Expect to return "".
+  EXPECT_TRUE(TranslateManager::GetTargetLanguageFromULP(&mock_translate_prefs)
+                  .empty());
+
+  // Case 5. The confidence of the reading list is high enough and the first
+  //         item is "fr" with high probability. Expect to return "fr".
+  EXPECT_STREQ("fr",
+               TranslateManager::GetTargetLanguageFromULP(&mock_translate_prefs)
+                   .c_str());
+
+  // Case 6. The confidence of the reading list is high enough and the first
+  //         item is "pl" with low probability. Expect to return "".
+  EXPECT_TRUE(TranslateManager::GetTargetLanguageFromULP(&mock_translate_prefs)
+                  .empty());
+}
+
+TEST_F(TranslateManagerTest, TestLanguageInULP) {
+  // Case Return Feature       Writing List         Reading List
+  //                        Confid. Lang. Prob.  Confid. Lang. Prob.
+  // 1     false  OFF
+  // 2     false   ON        Low                 Low
+  // 3      ture   ON        High   1st   High
+  // 4     false   ON        High   2nd   Low    High    2nd   Low
+  // 5     false   ON        High   2nd   Low    High    2nd   High
+
+  ::testing::NiceMock<MockTranslatePrefs> mock_translate_prefs;
+  TranslateManager::SetIgnoreMissingKeyForTesting(true);
+  translate_manager_.reset(new translate::TranslateManager(
+      &mock_translate_client_, kAcceptLanguages));
+
+  // For case 3 - "fr" with high (0.7) probability on the writing list.
+  TranslatePrefs::LanguageProbabilityList wlist3;
+  wlist3.push_back(std::make_pair("fr", 0.7));
+
+  // For case 4 & 5 - "fr" with low (0.1) probability on the writing list.
+  TranslatePrefs::LanguageProbabilityList wlist4_5;
+  wlist4_5.push_back(std::make_pair("en", 0.9));
+  wlist4_5.push_back(std::make_pair("fr", 0.1));
+
+  // For case 4 - "fr" with low (0.1) probability on the reading list.
+  TranslatePrefs::LanguageProbabilityList rlist4;
+  rlist4.push_back(std::make_pair("en", 0.9));
+  rlist4.push_back(std::make_pair("fr", 0.1));
+
+  // For case 5 - "fr" with high (0.49) probability on the reading list.
+  TranslatePrefs::LanguageProbabilityList rlist5;
+  rlist5.push_back(std::make_pair("en", 0.51));
+  rlist5.push_back(std::make_pair("fr", 0.49));
+
+  // Call for case 2-5
+  EXPECT_CALL(mock_translate_prefs,
+              GetWritingFromUserLanguageProfile(_))
+      .Times(4)
+      .WillOnce(Return(0.1))                                      // For case 2.
+      .WillOnce(DoAll(SetArgPointee<0>(wlist3), Return(0.9)))     // For case 3.
+      .WillOnce(DoAll(SetArgPointee<0>(wlist4_5), Return(0.9)))   // For case 4.
+      .WillOnce(DoAll(SetArgPointee<0>(wlist4_5), Return(0.9)));  // For case 5.
+
+  // Call for case 2, 4, 5
+  EXPECT_CALL(mock_translate_prefs,
+              GetReadingFromUserLanguageProfile(_))
+      .Times(3)
+      .WillOnce(Return(0.1))                                    // For case 2.
+      .WillOnce(DoAll(SetArgPointee<0>(rlist4), Return(0.9)))   // For case 4.
+      .WillOnce(DoAll(SetArgPointee<0>(rlist5), Return(0.9)));  // For case 5.
+
+  EXPECT_FALSE(translate_manager_->LanguageInULP(&mock_translate_prefs, "fr"));
+  // Case 2-5 The feature is turn ON.
+  TurnOnTranslateByULP();
+  EXPECT_FALSE(translate_manager_->LanguageInULP(&mock_translate_prefs, "fr"));
+  EXPECT_TRUE(translate_manager_->LanguageInULP(&mock_translate_prefs, "fr"));
+  EXPECT_FALSE(translate_manager_->LanguageInULP(&mock_translate_prefs, "fr"));
+  EXPECT_FALSE(translate_manager_->LanguageInULP(&mock_translate_prefs, "fr"));
+}
+
 }  // namespace translate