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 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265
|
// Copyright 2019 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "base/fuchsia/scoped_service_binding.h"
#include <lib/sys/cpp/component_context.h>
#include <lib/sys/cpp/outgoing_directory.h>
#include <lib/sys/cpp/service_directory.h>
#include "base/fuchsia/process_context.h"
#include "base/fuchsia/test_component_context_for_process.h"
#include "base/fuchsia/test_interface_impl.h"
#include "base/run_loop.h"
#include "base/test/bind.h"
#include "base/test/task_environment.h"
#include "testing/gtest/include/gtest/gtest.h"
namespace base {
class ScopedServiceBindingTest : public testing::Test {
protected:
ScopedServiceBindingTest() = default;
~ScopedServiceBindingTest() override = default;
const base::test::SingleThreadTaskEnvironment task_environment_{
base::test::SingleThreadTaskEnvironment::MainThreadType::IO};
TestComponentContextForProcess test_context_;
TestInterfaceImpl test_service_;
};
// Verifies that ScopedServiceBinding allows connection more than once.
TEST_F(ScopedServiceBindingTest, ConnectTwice) {
ScopedServiceBinding<testfidl::TestInterface> binding(
ComponentContextForProcess()->outgoing().get(), &test_service_);
auto stub =
test_context_.published_services()->Connect<testfidl::TestInterface>();
auto stub2 =
test_context_.published_services()->Connect<testfidl::TestInterface>();
EXPECT_EQ(VerifyTestInterface(stub), ZX_OK);
EXPECT_EQ(VerifyTestInterface(stub2), ZX_OK);
}
// Verifies that ScopedServiceBinding allows connection more than once.
TEST_F(ScopedServiceBindingTest, ConnectTwiceNewName) {
const char kInterfaceName[] = "fuchsia.TestInterface2";
ScopedServiceBinding<testfidl::TestInterface> new_service_binding(
ComponentContextForProcess()->outgoing().get(), &test_service_,
kInterfaceName);
testfidl::TestInterfacePtr stub, stub2;
test_context_.published_services()->Connect(kInterfaceName,
stub.NewRequest().TakeChannel());
test_context_.published_services()->Connect(kInterfaceName,
stub2.NewRequest().TakeChannel());
EXPECT_EQ(VerifyTestInterface(stub), ZX_OK);
EXPECT_EQ(VerifyTestInterface(stub2), ZX_OK);
}
// Verify that we can publish a debug service.
TEST_F(ScopedServiceBindingTest, ConnectDebugService) {
vfs::PseudoDir* const debug_dir =
ComponentContextForProcess()->outgoing()->debug_dir();
// Publish the test service to the "debug" directory.
ScopedServiceBinding<testfidl::TestInterface> debug_service_binding(
debug_dir, &test_service_);
// Connect a ServiceDirectory to the "debug" subdirectory.
fidl::InterfaceHandle<fuchsia::io::Directory> debug_handle;
debug_dir->Serve(fuchsia_io::wire::kPermReadable,
fidl::ServerEnd<fuchsia_io::Directory>(
debug_handle.NewRequest().TakeChannel()));
sys::ServiceDirectory debug_directory(std::move(debug_handle));
// Attempt to connect via the "debug" directory.
auto debug_stub = debug_directory.Connect<testfidl::TestInterface>();
EXPECT_EQ(VerifyTestInterface(debug_stub), ZX_OK);
// Verify that the service does not appear in the outgoing service directory.
auto release_stub =
test_context_.published_services()->Connect<testfidl::TestInterface>();
EXPECT_EQ(VerifyTestInterface(release_stub), ZX_ERR_NOT_FOUND);
}
// Verifies that ScopedSingleClientServiceBinding allows a different name.
TEST_F(ScopedServiceBindingTest, SingleClientConnectNewName) {
const char kInterfaceName[] = "fuchsia.TestInterface2";
ScopedSingleClientServiceBinding<testfidl::TestInterface> binding(
ComponentContextForProcess()->outgoing().get(), &test_service_,
kInterfaceName);
testfidl::TestInterfacePtr stub;
test_context_.published_services()->Connect(kInterfaceName,
stub.NewRequest().TakeChannel());
EXPECT_EQ(VerifyTestInterface(stub), ZX_OK);
}
// Verify that if we connect twice to a prefer-new bound service, the existing
// connection gets closed.
TEST_F(ScopedServiceBindingTest, SingleClientPreferNew) {
ScopedSingleClientServiceBinding<testfidl::TestInterface,
ScopedServiceBindingPolicy::kPreferNew>
binding(ComponentContextForProcess()->outgoing().get(), &test_service_);
// Connect the first client, and verify that it is functional.
auto existing_client =
test_context_.published_services()->Connect<testfidl::TestInterface>();
EXPECT_EQ(VerifyTestInterface(existing_client), ZX_OK);
// Connect the second client, so the existing one should be disconnected and
// the new should be functional.
auto new_client =
test_context_.published_services()->Connect<testfidl::TestInterface>();
RunLoop().RunUntilIdle();
EXPECT_FALSE(existing_client);
EXPECT_EQ(VerifyTestInterface(new_client), ZX_OK);
}
// Verify that if we connect twice to a prefer-existing bound service, the new
// connection gets closed.
TEST_F(ScopedServiceBindingTest, SingleClientPreferExisting) {
ScopedSingleClientServiceBinding<testfidl::TestInterface,
ScopedServiceBindingPolicy::kPreferExisting>
binding(ComponentContextForProcess()->outgoing().get(), &test_service_);
// Connect the first client, and verify that it is functional.
auto existing_client =
test_context_.published_services()->Connect<testfidl::TestInterface>();
EXPECT_EQ(VerifyTestInterface(existing_client), ZX_OK);
// Connect the second client, then verify that the it gets closed and the
// existing one remains functional.
auto new_client =
test_context_.published_services()->Connect<testfidl::TestInterface>();
RunLoop().RunUntilIdle();
EXPECT_FALSE(new_client);
EXPECT_EQ(VerifyTestInterface(existing_client), ZX_OK);
}
// Verify that the default single-client binding policy is prefer-new.
TEST_F(ScopedServiceBindingTest, SingleClientDefaultIsPreferNew) {
ScopedSingleClientServiceBinding<testfidl::TestInterface> binding(
ComponentContextForProcess()->outgoing().get(), &test_service_);
// Connect the first client, and verify that it is functional.
auto existing_client =
test_context_.published_services()->Connect<testfidl::TestInterface>();
EXPECT_EQ(VerifyTestInterface(existing_client), ZX_OK);
// Connect the second client, so the existing one should be disconnected and
// the new should be functional.
auto new_client =
test_context_.published_services()->Connect<testfidl::TestInterface>();
RunLoop().RunUntilIdle();
EXPECT_FALSE(existing_client);
EXPECT_EQ(VerifyTestInterface(new_client), ZX_OK);
}
// Verify that single-client bindings support publishing to a PseudoDir.
TEST_F(ScopedServiceBindingTest, SingleClientPublishToPseudoDir) {
vfs::PseudoDir* const debug_dir =
ComponentContextForProcess()->outgoing()->debug_dir();
ScopedSingleClientServiceBinding<testfidl::TestInterface> binding(
debug_dir, &test_service_);
// Connect a ServiceDirectory to the "debug" subdirectory.
fidl::InterfaceHandle<fuchsia::io::Directory> debug_handle;
debug_dir->Serve(fuchsia_io::wire::kPermReadable,
fidl::ServerEnd<fuchsia_io::Directory>(
debug_handle.NewRequest().TakeChannel()));
sys::ServiceDirectory debug_directory(std::move(debug_handle));
// Attempt to connect via the "debug" directory.
auto debug_stub = debug_directory.Connect<testfidl::TestInterface>();
EXPECT_EQ(VerifyTestInterface(debug_stub), ZX_OK);
// Verify that the service does not appear in the outgoing service directory.
auto release_stub =
test_context_.published_services()->Connect<testfidl::TestInterface>();
EXPECT_EQ(VerifyTestInterface(release_stub), ZX_ERR_NOT_FOUND);
}
TEST_F(ScopedServiceBindingTest, SingleBindingSetOnLastClientCallback) {
ScopedSingleClientServiceBinding<testfidl::TestInterface>
single_service_binding(ComponentContextForProcess()->outgoing().get(),
&test_service_);
base::RunLoop run_loop;
single_service_binding.SetOnLastClientCallback(run_loop.QuitClosure());
auto current_client =
test_context_.published_services()->Connect<testfidl::TestInterface>();
EXPECT_EQ(VerifyTestInterface(current_client), ZX_OK);
current_client = nullptr;
run_loop.Run();
}
// Test the kConnectOnce option for ScopedSingleClientServiceBinding properly
// stops publishing the service after a first disconnect.
TEST_F(ScopedServiceBindingTest, ConnectOnce_OnlyFirstConnectionSucceeds) {
ScopedSingleClientServiceBinding<testfidl::TestInterface,
ScopedServiceBindingPolicy::kConnectOnce>
binding(ComponentContextForProcess()->outgoing().get(), &test_service_);
// Connect the first client, and verify that it is functional.
auto existing_client =
test_context_.published_services()->Connect<testfidl::TestInterface>();
EXPECT_EQ(VerifyTestInterface(existing_client), ZX_OK);
// Connect the second client, then verify that it gets closed and the existing
// one remains functional.
auto new_client =
test_context_.published_services()->Connect<testfidl::TestInterface>();
RunLoop().RunUntilIdle();
EXPECT_FALSE(new_client);
EXPECT_EQ(VerifyTestInterface(existing_client), ZX_OK);
// Disconnect the first client.
existing_client.Unbind().TakeChannel().reset();
RunLoop().RunUntilIdle();
// Re-connect the second client, then verify that it gets closed.
new_client =
test_context_.published_services()->Connect<testfidl::TestInterface>();
RunLoop().RunUntilIdle();
EXPECT_FALSE(new_client);
}
// Test the last client callback is called every time the number of active
// clients reaches 0.
TEST_F(ScopedServiceBindingTest, MultipleLastClientCallback) {
ScopedServiceBinding<testfidl::TestInterface> binding(
ComponentContextForProcess()->outgoing().get(), &test_service_);
int disconnect_count = 0;
binding.SetOnLastClientCallback(
BindLambdaForTesting([&disconnect_count] { ++disconnect_count; }));
// Connect a client, verify it is functional.
auto stub =
test_context_.published_services()->Connect<testfidl::TestInterface>();
EXPECT_EQ(VerifyTestInterface(stub), ZX_OK);
// Disconnect the client, the callback should have been called once.
stub = nullptr;
RunLoop().RunUntilIdle();
EXPECT_EQ(disconnect_count, 1);
// Re-connect the client, verify it is functional.
stub = test_context_.published_services()->Connect<testfidl::TestInterface>();
EXPECT_EQ(VerifyTestInterface(stub), ZX_OK);
// Disconnect the client, the callback should have been called a second time.
stub = nullptr;
RunLoop().RunUntilIdle();
EXPECT_EQ(disconnect_count, 2);
}
} // namespace base
|