shell_service_protocol_test.cpp revision b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7
1b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell/* 2b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell * Copyright (C) 2015 The Android Open Source Project 3b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell * 4b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell * Licensed under the Apache License, Version 2.0 (the "License"); 5b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell * you may not use this file except in compliance with the License. 6b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell * You may obtain a copy of the License at 7b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell * 8b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell * http://www.apache.org/licenses/LICENSE-2.0 9b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell * 10b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell * Unless required by applicable law or agreed to in writing, software 11b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell * distributed under the License is distributed on an "AS IS" BASIS, 12b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell * See the License for the specific language governing permissions and 14b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell * limitations under the License. 15b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell */ 16b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell 17b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell#include "shell_service.h" 18b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell 19b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell#include <gtest/gtest.h> 20b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell 21b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell#include <signal.h> 22b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell#include <string.h> 23b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell 24b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell#include "sysdeps.h" 25b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell 26b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursellclass ShellProtocolTest : public ::testing::Test { 27b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell public: 28b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell static void SetUpTestCase() { 29b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell#if !defined(_WIN32) 30b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell // This is normally done in main.cpp. 31b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell saved_sigpipe_handler_ = signal(SIGPIPE, SIG_IGN); 32b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell#endif 33b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell } 34b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell 35b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell static void TearDownTestCase() { 36b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell#if !defined(_WIN32) 37b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell signal(SIGPIPE, saved_sigpipe_handler_); 38b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell#endif 39b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell } 40b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell 41b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell // Initializes the socketpair and ShellProtocols needed for testing. 42b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell void SetUp() { 43b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell int fds[2]; 44b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell ASSERT_EQ(0, adb_socketpair(fds)); 45b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell read_fd_ = fds[0]; 46b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell write_fd_ = fds[1]; 47b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell 48b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell write_protocol_ = new ShellProtocol(write_fd_); 49b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell ASSERT_TRUE(write_protocol_ != nullptr); 50b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell 51b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell read_protocol_ = new ShellProtocol(read_fd_); 52b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell ASSERT_TRUE(read_protocol_ != nullptr); 53b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell } 54b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell 55b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell // Cleans up FDs and ShellProtocols. If an FD is closed manually during a 56b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell // test, set it to -1 to prevent TearDown() trying to close it again. 57b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell void TearDown() { 58b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell for (int fd : {read_fd_, write_fd_}) { 59b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell if (fd >= 0) { 60b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell adb_close(fd); 61b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell } 62b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell } 63b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell for (ShellProtocol* protocol : {read_protocol_, write_protocol_}) { 64b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell if (protocol) { 65b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell delete protocol; 66b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell } 67b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell } 68b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell } 69b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell 70b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell // Fakes the buffer size so we can test filling buffers. 71b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell void SetReadDataCapacity(size_t size) { 72b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell read_protocol_->buffer_end_ = read_protocol_->data() + size; 73b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell } 74b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell 75b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell static sig_t saved_sigpipe_handler_; 76b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell 77b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell int read_fd_ = -1, write_fd_ = -1; 78b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell ShellProtocol *read_protocol_ = nullptr, *write_protocol_ = nullptr; 79b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell}; 80b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell 81b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursellsig_t ShellProtocolTest::saved_sigpipe_handler_ = nullptr; 82b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell 83b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursellnamespace { 84b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell 85b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell// Returns true if the packet contains the given values. 86b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursellbool PacketEquals(const ShellProtocol* protocol, ShellProtocol::Id id, 87b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell const void* data, size_t data_length) { 88b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell return (protocol->id() == id && 89b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell protocol->data_length() == data_length && 90b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell !memcmp(data, protocol->data(), data_length)); 91b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell} 92b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell 93b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell} // namespace 94b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell 95b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell// Tests data that can fit in a single packet. 96b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David PursellTEST_F(ShellProtocolTest, FullPacket) { 97b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell ShellProtocol::Id id = ShellProtocol::kIdStdout; 98b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell char data[] = "abc 123 \0\r\n"; 99b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell 100b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell memcpy(write_protocol_->data(), data, sizeof(data)); 101b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell ASSERT_TRUE(write_protocol_->Write(id, sizeof(data))); 102b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell 103b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell ASSERT_TRUE(read_protocol_->Read()); 104b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell ASSERT_TRUE(PacketEquals(read_protocol_, id, data, sizeof(data))); 105b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell} 106b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell 107b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell// Tests data that has to be read multiple times due to smaller read buffer. 108b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David PursellTEST_F(ShellProtocolTest, ReadBufferOverflow) { 109b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell ShellProtocol::Id id = ShellProtocol::kIdStdin; 110b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell 111b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell memcpy(write_protocol_->data(), "1234567890", 10); 112b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell ASSERT_TRUE(write_protocol_->Write(id, 10)); 113b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell 114b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell SetReadDataCapacity(4); 115b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell ASSERT_TRUE(read_protocol_->Read()); 116b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell ASSERT_TRUE(PacketEquals(read_protocol_, id, "1234", 4)); 117b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell ASSERT_TRUE(read_protocol_->Read()); 118b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell ASSERT_TRUE(PacketEquals(read_protocol_, id, "5678", 4)); 119b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell ASSERT_TRUE(read_protocol_->Read()); 120b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell ASSERT_TRUE(PacketEquals(read_protocol_, id, "90", 2)); 121b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell} 122b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell 123b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell// Tests a zero length packet. 124b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David PursellTEST_F(ShellProtocolTest, ZeroLengthPacket) { 125b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell ShellProtocol::Id id = ShellProtocol::kIdStderr; 126b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell 127b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell ASSERT_TRUE(write_protocol_->Write(id, 0)); 128b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell ASSERT_TRUE(read_protocol_->Read()); 129b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell ASSERT_TRUE(PacketEquals(read_protocol_, id, nullptr, 0)); 130b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell} 131b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell 132b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell// Tests exit code packets. 133b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David PursellTEST_F(ShellProtocolTest, ExitCodePacket) { 134b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell write_protocol_->data()[0] = 20; 135b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell ASSERT_TRUE(write_protocol_->Write(ShellProtocol::kIdExit, 1)); 136b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell 137b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell ASSERT_TRUE(read_protocol_->Read()); 138b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell ASSERT_EQ(ShellProtocol::kIdExit, read_protocol_->id()); 139b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell ASSERT_EQ(20, read_protocol_->data()[0]); 140b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell} 141b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell 142b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell// Tests writing to a closed pipe. 143b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David PursellTEST_F(ShellProtocolTest, WriteToClosedPipeFail) { 144b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell adb_close(read_fd_); 145b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell read_fd_ = -1; 146b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell 147b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell ASSERT_FALSE(write_protocol_->Write(ShellProtocol::kIdStdout, 0)); 148b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell} 149b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell 150b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell// Tests writing to a closed FD. 151b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David PursellTEST_F(ShellProtocolTest, WriteToClosedFdFail) { 152b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell adb_close(write_fd_); 153b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell write_fd_ = -1; 154b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell 155b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell ASSERT_FALSE(write_protocol_->Write(ShellProtocol::kIdStdout, 0)); 156b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell} 157b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell 158b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell// Tests reading from a closed pipe. 159b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David PursellTEST_F(ShellProtocolTest, ReadFromClosedPipeFail) { 160b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell adb_close(write_fd_); 161b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell write_fd_ = -1; 162b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell 163b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell ASSERT_FALSE(read_protocol_->Read()); 164b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell} 165b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell 166b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell// Tests reading from a closed FD. 167b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David PursellTEST_F(ShellProtocolTest, ReadFromClosedFdFail) { 168b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell adb_close(read_fd_); 169b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell read_fd_ = -1; 170b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell 171b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell ASSERT_FALSE(read_protocol_->Read()); 172b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell} 173b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell 174b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell// Tests reading from a closed pipe that has a packet waiting. This checks that 175b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell// even if the pipe closes before we can fully read its contents we will still 176b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell// be able to access the last packets. 177b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David PursellTEST_F(ShellProtocolTest, ReadPacketFromClosedPipe) { 178b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell ShellProtocol::Id id = ShellProtocol::kIdStdout; 179b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell char data[] = "foo bar"; 180b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell 181b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell memcpy(write_protocol_->data(), data, sizeof(data)); 182b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell ASSERT_TRUE(write_protocol_->Write(id, sizeof(data))); 183b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell adb_close(write_fd_); 184b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell write_fd_ = -1; 185b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell 186b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell // First read should grab the packet. 187b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell ASSERT_TRUE(read_protocol_->Read()); 188b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell ASSERT_TRUE(PacketEquals(read_protocol_, id, data, sizeof(data))); 189b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell 190b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell // Second read should fail. 191b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell ASSERT_FALSE(read_protocol_->Read()); 192b9e2e84e7e3cc5c9f30d63ef7d1337363437d2c7David Pursell} 193