File: remote_debugging_server_unittest.cc

package info (click to toggle)
chromium 145.0.7632.159-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 5,976,224 kB
  • sloc: cpp: 36,198,469; ansic: 7,634,080; javascript: 3,564,060; python: 1,649,622; xml: 838,470; asm: 717,087; pascal: 185,708; sh: 88,786; perl: 88,718; objc: 79,984; sql: 59,811; cs: 42,452; fortran: 24,101; makefile: 21,144; tcl: 15,277; php: 14,022; yacc: 9,066; ruby: 7,553; awk: 3,720; lisp: 3,233; lex: 1,328; ada: 727; jsp: 228; sed: 36
file content (167 lines) | stat: -rw-r--r-- 6,980 bytes parent folder | download | duplicates (3)
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
155
156
157
158
159
160
161
162
163
164
165
166
167
// Copyright 2025 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include "chrome/browser/devtools/remote_debugging_server.h"

#include "base/command_line.h"
#include "base/files/file_util.h"
#include "base/files/scoped_temp_dir.h"
#include "base/memory/ptr_util.h"
#include "base/run_loop.h"
#include "base/test/scoped_feature_list.h"
#include "chrome/browser/devtools/features.h"
#include "chrome/common/pref_names.h"
#include "chrome/test/base/testing_browser_process.h"
#include "chrome/test/base/testing_profile_manager.h"
#include "components/policy/core/browser/browser_policy_connector.h"
#include "components/policy/core/common/mock_configuration_policy_provider.h"
#include "components/policy/core/common/policy_map.h"
#include "components/policy/policy_constants.h"
#include "components/prefs/pref_change_registrar.h"
#include "components/prefs/pref_registry_simple.h"
#include "components/prefs/testing_pref_service.h"
#include "content/public/browser/devtools_agent_host.h"
#include "content/public/browser/devtools_socket_factory.h"
#include "content/public/common/content_constants.h"
#include "content/public/test/browser_task_environment.h"
#include "testing/gmock/include/gmock/gmock.h"
#include "testing/gtest/include/gtest/gtest.h"

using testing::_;
using testing::NiceMock;
using testing::Return;

class MockRemoteDebuggingServer : public RemoteDebuggingServer {
 public:
  MOCK_METHOD(void,
              StartHttpServer,
              (std::unique_ptr<content::DevToolsSocketFactory>,
               const base::FilePath&,
               const base::FilePath&,
               content::DevToolsAgentHost::RemoteDebuggingServerMode),
              (override));
  MOCK_METHOD(void, StopHttpServer, (), (override));
  MOCK_METHOD(void, StartPipeHandler, (), (override));
  MOCK_METHOD(void, StopPipeHandler, (), (override));
};

class RemoteDebuggingServerTest : public testing::Test {
 public:
  RemoteDebuggingServerTest()
      : profile_manager_(TestingBrowserProcess::GetGlobal()) {
    feature_list_.InitAndEnableFeature(
        features::kDevToolsAcceptDebuggingConnections);
  }

  void SetUp() override {
    ASSERT_TRUE(profile_manager_.SetUp());
    base::CommandLine::ForCurrentProcess()->InitFromArgv({});
  }

 protected:
  content::BrowserTaskEnvironment task_environment_;
  TestingProfileManager profile_manager_;
  base::test::ScopedFeatureList feature_list_;
};

TEST_F(RemoteDebuggingServerTest, StartsAndStopsWithPref) {
  TestingPrefServiceSimple* local_state =
      TestingBrowserProcess::GetGlobal()->GetTestingLocalState();
  auto server = std::make_unique<NiceMock<MockRemoteDebuggingServer>>();

  EXPECT_CALL(*server, StartHttpServer).Times(0);
  server->StartHttpServerInApprovalMode(local_state);
  testing::Mock::VerifyAndClearExpectations(server.get());

  base::RunLoop start_run_loop;
  EXPECT_CALL(*server, StartHttpServer)
      .WillOnce(testing::WithoutArgs(
          testing::Invoke(&start_run_loop, &base::RunLoop::Quit)));
  local_state->SetUserPref(prefs::kDevToolsRemoteDebuggingEnabled,
                           std::make_unique<base::Value>(true));
  start_run_loop.Run();
  testing::Mock::VerifyAndClearExpectations(server.get());

  base::RunLoop stop_run_loop;
  EXPECT_CALL(*server, StopHttpServer)
      .WillOnce(testing::Invoke(&stop_run_loop, &base::RunLoop::Quit));
  local_state->SetUserPref(prefs::kDevToolsRemoteDebuggingEnabled,
                           std::make_unique<base::Value>(false));
  stop_run_loop.Run();
  testing::Mock::VerifyAndClearExpectations(server.get());
}

TEST_F(RemoteDebuggingServerTest, DoesNotStartWhenFeatureDisabled) {
  base::test::ScopedFeatureList feature_list;
  feature_list.InitAndDisableFeature(
      features::kDevToolsAcceptDebuggingConnections);
  TestingPrefServiceSimple* local_state =
      TestingBrowserProcess::GetGlobal()->GetTestingLocalState();
  auto server = RemoteDebuggingServer::GetInstance(local_state);
  EXPECT_EQ(server.error(),
            RemoteDebuggingServer::NotStartedReason::kNotRequested);
}

TEST_F(RemoteDebuggingServerTest, DoesNotStartWhenDisallowedByPolicy) {
  NiceMock<policy::MockConfigurationPolicyProvider> policy_provider;
  policy_provider.SetDefaultReturns(
      /*is_initialization_complete_return=*/true,
      /*is_first_policy_load_complete_return=*/true);
  policy::BrowserPolicyConnector::SetPolicyProviderForTesting(&policy_provider);
  TestingPrefServiceSimple* local_state =
      TestingBrowserProcess::GetGlobal()->GetTestingLocalState();
  local_state->SetManagedPref(prefs::kDevToolsRemoteDebuggingAllowed,
                              std::make_unique<base::Value>(false));
  auto server = RemoteDebuggingServer::GetInstance(local_state);
  EXPECT_EQ(server.error(),
            RemoteDebuggingServer::NotStartedReason::kDisabledByPolicy);
  policy::BrowserPolicyConnector::SetPolicyProviderForTesting(nullptr);
}

TEST_F(RemoteDebuggingServerTest, GetPortFromUserDataDir) {
  base::ScopedTempDir temp_dir;
  ASSERT_TRUE(temp_dir.CreateUniqueTempDir());
  base::FilePath active_port_file =
      temp_dir.GetPath().Append(content::kDevToolsActivePortFileName);

  // Test with a valid port file.
  ASSERT_TRUE(base::WriteFile(active_port_file, "12345"));
  EXPECT_EQ(12345,
            RemoteDebuggingServer::GetPortFromUserDataDir(temp_dir.GetPath()));

  // Test with an empty port file.
  ASSERT_TRUE(base::WriteFile(active_port_file, ""));
  EXPECT_EQ(RemoteDebuggingServer::kDefaultDevToolsPort,
            RemoteDebuggingServer::GetPortFromUserDataDir(temp_dir.GetPath()));

  // Test with a malformed port file.
  ASSERT_TRUE(base::WriteFile(active_port_file, "hello"));
  EXPECT_EQ(RemoteDebuggingServer::kDefaultDevToolsPort,
            RemoteDebuggingServer::GetPortFromUserDataDir(temp_dir.GetPath()));

  // Test with a port file that has extra content.
  ASSERT_TRUE(base::WriteFile(active_port_file, "12345\nfoo"));
  EXPECT_EQ(12345,
            RemoteDebuggingServer::GetPortFromUserDataDir(temp_dir.GetPath()));

  // Test with a negative port.
  ASSERT_TRUE(base::WriteFile(active_port_file, "-1"));
  EXPECT_EQ(RemoteDebuggingServer::kDefaultDevToolsPort,
            RemoteDebuggingServer::GetPortFromUserDataDir(temp_dir.GetPath()));

  // Test with a valid port at the upper boundary.
  ASSERT_TRUE(base::WriteFile(active_port_file, "65535"));
  EXPECT_EQ(65535,
            RemoteDebuggingServer::GetPortFromUserDataDir(temp_dir.GetPath()));

  // Test with an out of bounds port.
  ASSERT_TRUE(base::WriteFile(active_port_file, "65536"));
  EXPECT_EQ(RemoteDebuggingServer::kDefaultDevToolsPort,
            RemoteDebuggingServer::GetPortFromUserDataDir(temp_dir.GetPath()));

  // Test with no port file.
  ASSERT_TRUE(base::DeleteFile(active_port_file));
  EXPECT_EQ(RemoteDebuggingServer::kDefaultDevToolsPort,
            RemoteDebuggingServer::GetPortFromUserDataDir(temp_dir.GetPath()));
}