[sync] Add Sessions integration tests

chrome/browser/sync/test/integration/sessions_helper.h

 // Copyright (c) 2012 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.
 
 #ifndef CHROME_BROWSER_SYNC_TEST_INTEGRATION_SESSIONS_HELPER_H_
 #define CHROME_BROWSER_SYNC_TEST_INTEGRATION_SESSIONS_HELPER_H_
 
 #include <algorithm>
 #include <map>
 #include <memory>
 #include <string>
 #include <vector>
 
 #include "base/compiler_specific.h"
 #include "chrome/browser/sync/test/integration/multi_client_status_change_checker.h"
 #include "chrome/browser/sync/test/integration/sync_test.h"
 #include "components/sessions/core/session_types.h"
 #include "components/sync/syncable/nigori_util.h"
 #include "components/sync_sessions/synced_session.h"
 
 class GURL;
 
 namespace sessions_helper {
 
 using SyncedSessionVector = std::vector<const sync_sessions::SyncedSession*>;
 using SessionWindowMap = std::map<SessionID::id_type, sessions::SessionWindow*>;
 using ScopedWindowMap =
     std::map<SessionID::id_type, std::unique_ptr<sessions::SessionWindow>>;
 
-// Copies the local session windows of profile |index| to |local_windows|.
-// Returns true if successful.
+// Copies the local session windows of profile at |index| to
+// |local_windows|.  Returns true if successful.

[skym, 2017/02/27 19:42:50]

This now wraps too early.

[Patrick Noland, 2017/02/27 23:37:07]

Done.

 bool GetLocalWindows(int index, ScopedWindowMap* local_windows);
 
-// Creates and verifies the creation of a new window for profile |index| with
-// one tab displaying |url|. Copies the SessionWindow associated with the new
-// window to |local_windows|. Returns true if successful. This call results in
-// multiple sessions changes, and performs synchronous blocking. It is rare, but
-// possible, that multiple sync cycle commits occur as a result of this call.
-// Test cases should be written to handle this possibility, otherwise they may
-// flake.
-bool OpenTabAndGetLocalWindows(int index,
-                               const GURL& url,
-                               ScopedWindowMap* local_windows);
-
 // Checks that window count and foreign session count are 0.
 bool CheckInitialState(int index);
 
 // Returns number of open windows for a profile.
 int GetNumWindows(int index);
 
 // Returns number of foreign sessions for a profile.
 int GetNumForeignSessions(int index);
 
 // Fills the sessions vector with the model associator's foreign session data.
@@ skipping 22 matching lines @@
 //    3. number of tab navigations per tab,
 //    4. actual tab navigations contents
 // - false otherwise.
 bool WindowsMatch(const ScopedWindowMap& win1, const ScopedWindowMap& win2);
 bool WindowsMatch(const SessionWindowMap& win1, const ScopedWindowMap& win2);
 
 // Retrieves the foreign sessions for a particular profile and compares them
 // with a reference SessionWindow list.
 // Returns true if the session windows of the foreign session matches the
 // reference.
-bool CheckForeignSessionsAgainst(
-    int index,
-    const std::vector<ScopedWindowMap>& windows);
+bool CheckForeignSessionsAgainst(int index,
+                                 const std::vector<ScopedWindowMap>& windows);
 
-// Open a single tab and block until the session model associator is aware
-// of it. Returns true upon success, false otherwise.
+// Open a single tab  in the browser at |index| and block until the
+// session model associator is aware of it. Returns true upon success, false
+// otherwise.
 bool OpenTab(int index, const GURL& url);
 
+// See OpenTab, except that the tab is opened in position |tab_index|.
+// If |tab_index| is -1 or greater than the number of tabs, the tab will be

[skym, 2017/02/27 19:42:50]

Do we need to supposed -1 or greater? Can we just crash bad tests that do this?
Oh it looks like this is just the default behavior of chrome::AddTabAt? Does it
make sense to document this here? Do we use this?

[Patrick Noland, 2017/02/27 23:37:07]

We don't use it but I wanted to honestly document the behavior. It's not
inconceivable someone would want to use it, is it?

+// appended to the end of the strip. i.e. if tab_index is 3 for a tab strip of
+// size 1, the new tab will be in position 1.
+bool OpenTabAtIndex(int index, int tab_index, const GURL& url);
+
+// Moves the tab in position |tab_index| in the TabStrip for browser at
+// |from_index| to the TabStrip for browser at |to_index|.
+void MoveTab(int from_index, int to_index, int tab_index);

[skym, 2017/02/27 19:42:50]

Do all these navigate methods block?

[Patrick Noland, 2017/02/27 23:37:07]

No, of the Navigate* functions, only NavigateTab blocks. I'll document that. 

+
+// Navigate the active tab for browser in position |index| to the given
+// url.
+bool NavigateTab(int index, const GURL& url);
+
+// Navigate the active tab for browser in position |index| back by one;
+// if this isn't possible, does nothing
+void NavigateTabBack(int index);
+
+// Navigate the active tab for browser in position |index| forward by
+// one; if this isn't possible, does nothing
+void NavigateTabForward(int index);
+
 // Open multiple tabs and block until the session model associator is aware
 // of all of them.  Returns true on success, false on failure.
 bool OpenMultipleTabs(int index, const std::vector<GURL>& urls);
 
 // Wait for a session change to propagate to the model associator.  Will not
 // return until each url in |urls| has been found.
 bool WaitForTabsToLoad(int index, const std::vector<GURL>& urls);
 
 // Check if the session model associator's knows that the current open tab
 // has this url.
@@ skipping 22 matching lines @@
   // StatusChangeChecker implementation.
   bool IsExitConditionSatisfied() override;
   std::string GetDebugMessage() const override;
 
  private:
   int index_;
   const std::vector<sessions_helper::ScopedWindowMap>& windows_;
 };
 
 #endif  // CHROME_BROWSER_SYNC_TEST_INTEGRATION_SESSIONS_HELPER_H_