e163298ef2
The test was assuming we still output the full help for every syntax error. While I'm here, make the diagnostics suck less. Bug: N/A Test: ran tests Change-Id: Idc28616f20c66391f32046cf4216f122998a84bd
243 lines
10 KiB
Python
243 lines
10 KiB
Python
#!/usr/bin/env python
|
|
#
|
|
# Copyright (C) 2015 The Android Open Source Project
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
#
|
|
"""Tests for the adb program itself.
|
|
|
|
This differs from things in test_device.py in that there is no API for these
|
|
things. Most of these tests involve specific error messages or the help text.
|
|
"""
|
|
from __future__ import print_function
|
|
|
|
import contextlib
|
|
import os
|
|
import random
|
|
import socket
|
|
import struct
|
|
import subprocess
|
|
import threading
|
|
import unittest
|
|
|
|
import adb
|
|
|
|
|
|
class NonApiTest(unittest.TestCase):
|
|
"""Tests for ADB that aren't a part of the AndroidDevice API."""
|
|
|
|
def test_help(self):
|
|
"""Make sure we get _something_ out of help."""
|
|
out = subprocess.check_output(
|
|
['adb', 'help'], stderr=subprocess.STDOUT)
|
|
self.assertGreater(len(out), 0)
|
|
|
|
def test_version(self):
|
|
"""Get a version number out of the output of adb."""
|
|
lines = subprocess.check_output(['adb', 'version']).splitlines()
|
|
version_line = lines[0]
|
|
self.assertRegexpMatches(
|
|
version_line, r'^Android Debug Bridge version \d+\.\d+\.\d+$')
|
|
if len(lines) == 2:
|
|
# Newer versions of ADB have a second line of output for the
|
|
# version that includes a specific revision (git SHA).
|
|
revision_line = lines[1]
|
|
self.assertRegexpMatches(
|
|
revision_line, r'^Revision [0-9a-f]{12}-android$')
|
|
|
|
def test_tcpip_error_messages(self):
|
|
p = subprocess.Popen(['adb', 'tcpip'], stdout=subprocess.PIPE,
|
|
stderr=subprocess.STDOUT)
|
|
out, _ = p.communicate()
|
|
self.assertEqual(1, p.returncode)
|
|
self.assertIn('requires an argument', out)
|
|
|
|
p = subprocess.Popen(['adb', 'tcpip', 'foo'], stdout=subprocess.PIPE,
|
|
stderr=subprocess.STDOUT)
|
|
out, _ = p.communicate()
|
|
self.assertEqual(1, p.returncode)
|
|
self.assertIn('invalid port', out)
|
|
|
|
# Helper method that reads a pipe until it is closed, then sets the event.
|
|
def _read_pipe_and_set_event(self, pipe, event):
|
|
x = pipe.read()
|
|
event.set()
|
|
|
|
# Test that launch_server() does not let the adb server inherit
|
|
# stdin/stdout/stderr handles which can cause callers of adb.exe to hang.
|
|
# This test also runs fine on unix even though the impetus is an issue
|
|
# unique to Windows.
|
|
def test_handle_inheritance(self):
|
|
# This test takes 5 seconds to run on Windows: if there is no adb server
|
|
# running on the the port used below, adb kill-server tries to make a
|
|
# TCP connection to a closed port and that takes 1 second on Windows;
|
|
# adb start-server does the same TCP connection which takes another
|
|
# second, and it waits 3 seconds after starting the server.
|
|
|
|
# Start adb client with redirected stdin/stdout/stderr to check if it
|
|
# passes those redirections to the adb server that it starts. To do
|
|
# this, run an instance of the adb server on a non-default port so we
|
|
# don't conflict with a pre-existing adb server that may already be
|
|
# setup with adb TCP/emulator connections. If there is a pre-existing
|
|
# adb server, this also tests whether multiple instances of the adb
|
|
# server conflict on adb.log.
|
|
|
|
port = 5038
|
|
# Kill any existing server on this non-default port.
|
|
subprocess.check_output(['adb', '-P', str(port), 'kill-server'],
|
|
stderr=subprocess.STDOUT)
|
|
|
|
try:
|
|
# Run the adb client and have it start the adb server.
|
|
p = subprocess.Popen(['adb', '-P', str(port), 'start-server'],
|
|
stdin=subprocess.PIPE, stdout=subprocess.PIPE,
|
|
stderr=subprocess.PIPE)
|
|
|
|
# Start threads that set events when stdout/stderr are closed.
|
|
stdout_event = threading.Event()
|
|
stdout_thread = threading.Thread(
|
|
target=self._read_pipe_and_set_event,
|
|
args=(p.stdout, stdout_event))
|
|
stdout_thread.daemon = True
|
|
stdout_thread.start()
|
|
|
|
stderr_event = threading.Event()
|
|
stderr_thread = threading.Thread(
|
|
target=self._read_pipe_and_set_event,
|
|
args=(p.stderr, stderr_event))
|
|
stderr_thread.daemon = True
|
|
stderr_thread.start()
|
|
|
|
# Wait for the adb client to finish. Once that has occurred, if
|
|
# stdin/stderr/stdout are still open, it must be open in the adb
|
|
# server.
|
|
p.wait()
|
|
|
|
# Try to write to stdin which we expect is closed. If it isn't
|
|
# closed, we should get an IOError. If we don't get an IOError,
|
|
# stdin must still be open in the adb server. The adb client is
|
|
# probably letting the adb server inherit stdin which would be
|
|
# wrong.
|
|
with self.assertRaises(IOError):
|
|
p.stdin.write('x')
|
|
|
|
# Wait a few seconds for stdout/stderr to be closed (in the success
|
|
# case, this won't wait at all). If there is a timeout, that means
|
|
# stdout/stderr were not closed and and they must be open in the adb
|
|
# server, suggesting that the adb client is letting the adb server
|
|
# inherit stdout/stderr which would be wrong.
|
|
self.assertTrue(stdout_event.wait(5), "adb stdout not closed")
|
|
self.assertTrue(stderr_event.wait(5), "adb stderr not closed")
|
|
finally:
|
|
# If we started a server, kill it.
|
|
subprocess.check_output(['adb', '-P', str(port), 'kill-server'],
|
|
stderr=subprocess.STDOUT)
|
|
|
|
# Use SO_LINGER to cause TCP RST segment to be sent on socket close.
|
|
def _reset_socket_on_close(self, sock):
|
|
# The linger structure is two shorts on Windows, but two ints on Unix.
|
|
linger_format = 'hh' if os.name == 'nt' else 'ii'
|
|
l_onoff = 1
|
|
l_linger = 0
|
|
|
|
sock.setsockopt(socket.SOL_SOCKET, socket.SO_LINGER,
|
|
struct.pack(linger_format, l_onoff, l_linger))
|
|
# Verify that we set the linger structure properly by retrieving it.
|
|
linger = sock.getsockopt(socket.SOL_SOCKET, socket.SO_LINGER, 16)
|
|
self.assertEqual((l_onoff, l_linger),
|
|
struct.unpack_from(linger_format, linger))
|
|
|
|
def test_emu_kill(self):
|
|
"""Ensure that adb emu kill works.
|
|
|
|
Bug: https://code.google.com/p/android/issues/detail?id=21021
|
|
"""
|
|
port = 12345
|
|
|
|
with contextlib.closing(
|
|
socket.socket(socket.AF_INET, socket.SOCK_STREAM)) as listener:
|
|
# Use SO_REUSEADDR so subsequent runs of the test can grab the port
|
|
# even if it is in TIME_WAIT.
|
|
listener.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
|
|
listener.bind(('127.0.0.1', port))
|
|
listener.listen(4)
|
|
|
|
# Now that listening has started, start adb emu kill, telling it to
|
|
# connect to our mock emulator.
|
|
p = subprocess.Popen(
|
|
['adb', '-s', 'emulator-' + str(port), 'emu', 'kill'],
|
|
stderr=subprocess.STDOUT)
|
|
|
|
accepted_connection, addr = listener.accept()
|
|
with contextlib.closing(accepted_connection) as conn:
|
|
# If WSAECONNABORTED (10053) is raised by any socket calls,
|
|
# then adb probably isn't reading the data that we sent it.
|
|
conn.sendall('Android Console: type \'help\' for a list ' +
|
|
'of commands\r\n')
|
|
conn.sendall('OK\r\n')
|
|
|
|
with contextlib.closing(conn.makefile()) as f:
|
|
self.assertEqual('kill\n', f.readline())
|
|
self.assertEqual('quit\n', f.readline())
|
|
|
|
conn.sendall('OK: killing emulator, bye bye\r\n')
|
|
|
|
# Use SO_LINGER to send TCP RST segment to test whether adb
|
|
# ignores WSAECONNRESET on Windows. This happens with the
|
|
# real emulator because it just calls exit() without closing
|
|
# the socket or calling shutdown(SD_SEND). At process
|
|
# termination, Windows sends a TCP RST segment for every
|
|
# open socket that shutdown(SD_SEND) wasn't used on.
|
|
self._reset_socket_on_close(conn)
|
|
|
|
# Wait for adb to finish, so we can check return code.
|
|
p.communicate()
|
|
|
|
# If this fails, adb probably isn't ignoring WSAECONNRESET when
|
|
# reading the response from the adb emu kill command (on Windows).
|
|
self.assertEqual(0, p.returncode)
|
|
|
|
def test_connect_ipv4_ipv6(self):
|
|
"""Ensure that `adb connect localhost:1234` will try both IPv4 and IPv6.
|
|
|
|
Bug: http://b/30313466
|
|
"""
|
|
ipv4 = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
|
|
ipv4.bind(('127.0.0.1', 0))
|
|
ipv4.listen(1)
|
|
|
|
ipv6 = socket.socket(socket.AF_INET6, socket.SOCK_STREAM)
|
|
ipv6.bind(('::1', ipv4.getsockname()[1] + 1))
|
|
ipv6.listen(1)
|
|
|
|
for s in (ipv4, ipv6):
|
|
port = s.getsockname()[1]
|
|
output = subprocess.check_output(
|
|
['adb', 'connect', 'localhost:{}'.format(port)])
|
|
|
|
self.assertEqual(
|
|
output.strip(), 'connected to localhost:{}'.format(port))
|
|
s.close()
|
|
|
|
|
|
def main():
|
|
random.seed(0)
|
|
if len(adb.get_devices()) > 0:
|
|
suite = unittest.TestLoader().loadTestsFromName(__name__)
|
|
unittest.TextTestRunner(verbosity=3).run(suite)
|
|
else:
|
|
print('Test suite must be run with attached devices')
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|