SuggestionsStore unittests not using real time.

components/suggestions/suggestions_store_unittest.cc

 // Copyright 2014 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/suggestions/suggestions_store.h"
 
+#include "base/test/simple_test_clock.h"
 #include "base/time/time.h"
 #include "components/pref_registry/testing_pref_service_syncable.h"
 #include "components/suggestions/proto/suggestions.pb.h"
 #include "testing/gtest/include/gtest/gtest.h"
 
 using user_prefs::TestingPrefServiceSyncable;
 
 namespace suggestions {
 
 namespace {
@@ skipping 10 matching lines @@
 }
 
 SuggestionsProfile CreateTestSuggestions() {
   SuggestionsProfile suggestions;
   ChromeSuggestion* suggestion = suggestions.add_suggestions();
   suggestion->set_url(kTestTitle);
   suggestion->set_title(kTestUrl);
   return suggestions;
 }
 
-SuggestionsProfile CreateTestSuggestionsProfileWithExpiry(int expired_count,
-                                                          int valid_count) {
-  int64 now_usec = (base::Time::NowFromSystemTime() - base::Time::UnixEpoch())
+SuggestionsProfile CreateTestSuggestionsProfileWithExpiry(
+   base::Time expiry_time, int expired_count, int valid_count) {

[Matt Giuca, 2014/12/18 22:51:14]

The name "expiry_time" is misleading. The expiry times are different for each
suggestion (computed inside the for loop below). This value is the simulated
"now" time.

Can you rename it to current_time (optionally with a comment that this is the
simulated time, not the actual time).

[gayane -on leave until 09-2017, 2014/12/22 16:29:38]

Done.

+int64 expiry_usec = (expiry_time - base::Time::UnixEpoch())

[Matt Giuca, 2014/12/18 22:51:13]

Indentation (git cl format).

[Matt Giuca, 2014/12/18 22:51:14]

As above, this is not an expiry time, it is a simulated "now". Rename back to
now_usec.

[gayane -on leave until 09-2017, 2014/12/22 16:29:38]

Done.

[gayane -on leave until 09-2017, 2014/12/22 16:29:38]

Renamed to current_time_usec, because having one now_usec and one current_time
variables might be misleading.

       .ToInternalValue();
   int64 offset_usec = 5 * base::Time::kMicrosecondsPerMinute;
 
   SuggestionsProfile suggestions;
   for (int i = 1; i <= valid_count; i++)
     AddSuggestion(&suggestions, kTestTitle, kTestUrl,
-        now_usec + offset_usec * i);
+        expiry_usec + offset_usec * i);
   for (int i = 1; i <= expired_count; i++)
     AddSuggestion(&suggestions, kTestTitle, kTestUrl,
-        now_usec - offset_usec * i);
+        expiry_usec - offset_usec * i);
 
   return suggestions;
 }
 
 void ValidateSuggestions(const SuggestionsProfile& expected,
                          const SuggestionsProfile& actual) {
   EXPECT_EQ(expected.suggestions_size(), actual.suggestions_size());
   for (int i = 0; i < expected.suggestions_size(); ++i) {
     EXPECT_EQ(expected.suggestions(i).url(), actual.suggestions(i).url());
     EXPECT_EQ(expected.suggestions(i).title(), actual.suggestions(i).title());
     EXPECT_EQ(expected.suggestions(i).expiry_ts(),
               actual.suggestions(i).expiry_ts());
     EXPECT_EQ(expected.suggestions(i).favicon_url(),
               actual.suggestions(i).favicon_url());
     EXPECT_EQ(expected.suggestions(i).thumbnail(),
               actual.suggestions(i).thumbnail());
   }
 }
 
 }  // namespace
 
 class SuggestionsStoreTest : public testing::Test {
  public:
   SuggestionsStoreTest()
     : pref_service_(new user_prefs::TestingPrefServiceSyncable) {}
 
   void SetUp() override {
     SuggestionsStore::RegisterProfilePrefs(pref_service_->registry());
     suggestions_store_.reset(new SuggestionsStore(pref_service_.get()));
+
+    base::SimpleTestClock* test_clock(new base::SimpleTestClock());
+    expiry_time = base::Time::FromInternalValue(13063394337546738);
+    test_clock->SetNow(expiry_time);
+    suggestions_store_->SetClockForTesting(scoped_ptr<base::Clock>(test_clock));
   }
 
  protected:
   scoped_ptr<user_prefs::TestingPrefServiceSyncable> pref_service_;
   scoped_ptr<SuggestionsStore> suggestions_store_;
+  base::Time expiry_time;

[Matt Giuca, 2014/12/18 22:51:14]

As above, this is not an expiry time. Rename to current_time.

[gayane -on leave until 09-2017, 2014/12/22 16:29:38]

Done.

 
   DISALLOW_COPY_AND_ASSIGN(SuggestionsStoreTest);
 };
 
 // Tests LoadSuggestions function to filter expired suggestions.
 TEST_F(SuggestionsStoreTest, LoadAllExpired) {
-  SuggestionsProfile suggestions = CreateTestSuggestionsProfileWithExpiry(5, 0);
+  SuggestionsProfile suggestions = CreateTestSuggestionsProfileWithExpiry(
+      expiry_time, 5, 0);
   SuggestionsProfile filtered_suggestions;
 
   // Store and load. Expired suggestions should not be loaded.
   EXPECT_TRUE(suggestions_store_->StoreSuggestions(suggestions));
   EXPECT_FALSE(suggestions_store_->LoadSuggestions(&filtered_suggestions));
   EXPECT_EQ(0, filtered_suggestions.suggestions_size());
 }
 
 // Tests LoadSuggestions function to filter expired suggestions.
 TEST_F(SuggestionsStoreTest, LoadValidAndExpired) {
-  SuggestionsProfile suggestions = CreateTestSuggestionsProfileWithExpiry(5, 3);
+  SuggestionsProfile suggestions = CreateTestSuggestionsProfileWithExpiry(
+      expiry_time, 5, 3);
   SuggestionsProfile filtered_suggestions;
 
   // Store and load. Expired suggestions should not be loaded.
   EXPECT_TRUE(suggestions_store_->StoreSuggestions(suggestions));
   EXPECT_TRUE(suggestions_store_->LoadSuggestions(&filtered_suggestions));
   EXPECT_EQ(3, filtered_suggestions.suggestions_size());
 }
 
 // Tests LoadSuggestions function to filter expired suggestions.
 TEST_F(SuggestionsStoreTest, CheckStoreAfterLoadExpired) {
-  SuggestionsProfile suggestions = CreateTestSuggestionsProfileWithExpiry(5, 3);
+  SuggestionsProfile suggestions = CreateTestSuggestionsProfileWithExpiry(
+      expiry_time, 5, 3);
   SuggestionsProfile filtered_suggestions;
 
   // Store and load. Expired suggestions should not be loaded.
   EXPECT_TRUE(suggestions_store_->StoreSuggestions(suggestions));
   EXPECT_TRUE(suggestions_store_->LoadSuggestions(&filtered_suggestions));
 
   SuggestionsProfile loaded_suggestions;
   EXPECT_TRUE(suggestions_store_->LoadSuggestions(&loaded_suggestions));
   EXPECT_EQ(3, loaded_suggestions.suggestions_size());
   ValidateSuggestions(filtered_suggestions, loaded_suggestions);
@@ skipping 13 matching lines @@
   EXPECT_TRUE(suggestions_store_->LoadSuggestions(&recovered_suggestions));
   ValidateSuggestions(suggestions, recovered_suggestions);
 
   // Clear.
   suggestions_store_->ClearSuggestions();
   EXPECT_FALSE(suggestions_store_->LoadSuggestions(&recovered_suggestions));
   ValidateSuggestions(empty_suggestions, recovered_suggestions);
 }
 
 }  // namespace suggestions