File: test_guest_view_manager.h

package info (click to toggle)
chromium 138.0.7204.157-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 6,071,864 kB
  • sloc: cpp: 34,936,859; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,953; asm: 946,768; xml: 739,967; pascal: 187,324; sh: 89,623; perl: 88,663; objc: 79,944; sql: 50,304; cs: 41,786; fortran: 24,137; makefile: 21,806; php: 13,980; tcl: 13,166; yacc: 8,925; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (154 lines) | stat: -rw-r--r-- 5,865 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
// Copyright 2014 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef COMPONENTS_GUEST_VIEW_BROWSER_TEST_GUEST_VIEW_MANAGER_H_
#define COMPONENTS_GUEST_VIEW_BROWSER_TEST_GUEST_VIEW_MANAGER_H_

#include <stddef.h>

#include <memory>

#include "base/functional/bind.h"
#include "base/gtest_prod_util.h"
#include "components/guest_view/browser/guest_view_manager.h"
#include "components/guest_view/browser/guest_view_manager_factory.h"
#include "components/guest_view/common/guest_view_constants.h"
#include "content/public/browser/render_frame_host.h"
#include "content/public/test/browser_test_utils.h"

namespace guest_view {

class TestGuestViewManager : public GuestViewManager {
 public:
  TestGuestViewManager(content::BrowserContext* context,
                       std::unique_ptr<GuestViewManagerDelegate> delegate);

  TestGuestViewManager(const TestGuestViewManager&) = delete;
  TestGuestViewManager& operator=(const TestGuestViewManager&) = delete;

  ~TestGuestViewManager() override;

  void WaitForAllGuestsDeleted();
  void WaitForFirstGuestDeleted();
  void WaitForLastGuestDeleted();

  // While the GuestViewBase directly represents a guest view, the
  // RenderFrameHost version exposes the guest view's main frame for the ease of
  // testing.
  GuestViewBase* WaitForSingleGuestViewCreated();
  content::RenderFrameHost* WaitForSingleGuestRenderFrameHostCreated();

  GuestViewBase* WaitForNextGuestViewCreated();
  content::RenderFrameHost* WaitForNextGuestRenderFrameHostCreated();

  void WaitForNumGuestsCreated(size_t count);

  void WaitForSingleViewGarbageCollected();

  GuestViewBase* GetLastGuestViewCreated();
  content::RenderFrameHost* GetLastGuestRenderFrameHostCreated();

  void WaitUntilAttached(GuestViewBase* guest_view);
  [[nodiscard]] bool WaitUntilAttachedAndLoaded(GuestViewBase* guest_view);

  // Returns the number of guests currently still alive at the time of calling
  // this method.
  size_t GetCurrentGuestCount() const;

  // Returns the size of the set of removed instance IDs.
  size_t GetNumRemovedInstanceIDs() const;

  // Returns the number of times EmbedderWillBeDestroyed() was called.
  int num_embedder_processes_destroyed() const {
    return num_embedder_processes_destroyed_;
  }

  // Returns the number of guests that have been created since the creation of
  // this GuestViewManager.
  size_t num_guests_created() const { return num_guests_created_; }

  // Returns the number of GuestViews that have been garbage collected in
  // JavaScript since the creation of this GuestViewManager.
  int num_views_garbage_collected() const {
    return num_views_garbage_collected_;
  }

  // Returns the last guest instance ID removed from the manager.
  int last_instance_id_removed() const { return last_instance_id_removed_; }

  // Returns the list of guests that were created by this manager.
  void GetGuestRenderFrameHostList(
      std::vector<content::RenderFrameHost*>* guest_render_frame_host_list);

  void SetWillAttachCallback(
      base::OnceCallback<void(GuestViewBase*)> callback) {
    // The callback will be called when the guest view has been created but is
    // not yet attached to the outer.
    will_attach_callback_ = std::move(callback);
  }

 private:
  FRIEND_TEST_ALL_PREFIXES(GuestViewManagerTest, AddRemove);
  FRIEND_TEST_ALL_PREFIXES(GuestViewManagerTest, ReuseIdForRecreatedGuestPage);

  // guest_view::GuestViewManager:
  void AddGuest(GuestViewBase* guest) override;
  void EmbedderProcessDestroyed(
      content::ChildProcessId embedder_process_id) override;
  void ViewGarbageCollected(content::ChildProcessId embedder_process_id,
                            int view_instance_id) override;
  void AttachGuest(content::ChildProcessId embedder_process_id,
                   int element_instance_id,
                   int guest_instance_id,
                   const base::Value::Dict& attach_params) override;
  void AttachGuest(int embedder_process_id,
                   int element_instance_id,
                   int guest_instance_id,
                   const base::Value::Dict& attach_params) override;

  void WaitForViewGarbageCollected();

  using GuestViewManager::last_instance_id_removed_;
  using GuestViewManager::removed_instance_ids_;

  int num_embedder_processes_destroyed_ = 0;
  size_t num_guests_created_ = 0;
  size_t expected_num_guests_created_ = 0;
  int num_views_garbage_collected_ = 0;

  // Tracks the life time of the GuestView's main FrameTreeNode. The main FTN
  // has the same lifesspan as the GuestView.
  std::vector<std::unique_ptr<content::FrameDeletedObserver>>
      guest_view_watchers_;
  std::unique_ptr<base::RunLoop> created_run_loop_;
  std::unique_ptr<base::RunLoop> num_created_run_loop_;
  int instance_waiting_for_attach_ = kInstanceIDNone;
  std::unique_ptr<base::RunLoop> attached_run_loop_;
  std::unique_ptr<base::RunLoop> gc_run_loop_;
  base::OnceCallback<void(GuestViewBase*)> will_attach_callback_;
};

// Test factory for creating test instances of GuestViewManager.
class TestGuestViewManagerFactory : public GuestViewManagerFactory {
 public:
  TestGuestViewManagerFactory();

  TestGuestViewManagerFactory(const TestGuestViewManagerFactory&) = delete;
  TestGuestViewManagerFactory& operator=(const TestGuestViewManagerFactory&) =
      delete;

  ~TestGuestViewManagerFactory() override;

  TestGuestViewManager* GetOrCreateTestGuestViewManager(
      content::BrowserContext* context,
      std::unique_ptr<GuestViewManagerDelegate> delegate);

  std::unique_ptr<GuestViewManager> CreateGuestViewManager(
      content::BrowserContext* context,
      std::unique_ptr<GuestViewManagerDelegate> delegate) override;
};

}  // namespace guest_view

#endif  // COMPONENTS_GUEST_VIEW_BROWSER_TEST_GUEST_VIEW_MANAGER_H_