Add subclasses of LocalDeviceEnvironment for ethernet connections.

- Subclasses call `adb connect` to set up device network connections. Specific subclasses provide the hostname for an environment, e.g. based off the Swarming bot id.

Change-Id: Ia80ff695513c5ac1ec62f202eb0edfc545912fd5
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/6109218
Reviewed-by: Haiyang Pan <hypan@google.com>
Reviewed-by: Andrew Grieve <agrieve@chromium.org>
Auto-Submit: Andrew Lamb <andrewlamb@chromium.org>
Commit-Queue: Andrew Grieve <agrieve@chromium.org>
Cr-Commit-Position: refs/heads/main@{#1399872}
NOKEYCHECK=True
GitOrigin-RevId: adb42e799e65b6378f683f663b7a48fa4420596d

Author: Andrew Lamb

android/pylib/base/environment_factory.py

@@ -2,9 +2,12 @@
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
+import os
 
 from pylib import constants
 from pylib.local.device import local_device_environment
+from pylib.local.device import skylab_environment
+
 from pylib.local.machine import local_machine_environment
 
 try:
@@ -26,6 +29,18 @@ def CreateEnvironment(args, output_manager, error_func):
           raise RuntimeError('error_func must call exit inside.')
         return local_emulator_environment.LocalEmulatorEnvironment(
             args, output_manager, error_func)
+
+      if args.connect_over_ethernet:
+        swarming_server = os.environ.get('SWARMING_SERVER', '')
+        if skylab_environment.SWARMING_SERVER not in swarming_server:
+          error_func(
+              'connect-over-ethernet is only supported for tasks running on '
+              f'{skylab_environment.SWARMING_SERVER}. '
+              f'SWARMING_SERVER={swarming_server}')
+          raise RuntimeError('error_func must call exit inside.')
+        return skylab_environment.SkylabEnvironment(args, output_manager,
+                                                    error_func)
+
       return local_device_environment.LocalDeviceEnvironment(
           args, output_manager, error_func)
     return local_machine_environment.LocalMachineEnvironment(

android/pylib/local/device/local_device_ethernet_environment.py

@@ -0,0 +1,28 @@
+# Copyright 2024 The Chromium Authors
+# Use of this source code is governed by a BSD-style license that can be
+# found in the LICENSE file.
+
+import logging
+
+from devil.android.sdk import adb_wrapper
+
+from pylib.local.device import local_device_environment
+
+
+class LocalDeviceEthernetEnvironment(
+    local_device_environment.LocalDeviceEnvironment):
+  """
+  A subclass of LocalDeviceEnvironment for devices connected over ethernet.
+
+  This class cannot be instantiated. Subclasses should implement the
+  GetDeviceHostname method, as this is specific to each environment.
+  """
+
+  def __init__(self, args, output_manager, error_func):
+    super().__init__(args, output_manager, error_func)
+    hostname = self.GetDeviceHostname()
+    logging.info('connecting to %s', hostname)
+    adb_wrapper.AdbWrapper.Connect(hostname)
+
+  def GetDeviceHostname(self):
+    raise NotImplementedError

android/pylib/local/device/skylab_environment.py

@@ -0,0 +1,31 @@
+# Copyright 2024 The Chromium Authors
+# Use of this source code is governed by a BSD-style license that can be
+# found in the LICENSE file.
+
+import os
+
+from pylib.local.device import local_device_ethernet_environment
+
+SWARMING_SERVER = 'chromeos-swarming.appspot.com'
+
+
+class SkylabEnvironment(
+    local_device_ethernet_environment.LocalDeviceEthernetEnvironment):
+  """
+  A subclass of LocalDeviceEthernetEnvironment for Skylab devices.
+  """
+
+  def GetDeviceHostname(self):
+    """Return the hostname based on the bot id.
+
+    Strips the first component of the bot id, e.g. 'cros-clank1' -> 'clank1'.
+
+    Gets the bot id from the SWARMING_BOT_ID envvar, see
+    https://chromium.googlesource.com/infra/luci/luci-py/+/HEAD/appengine/swarming/doc/Magic-Values.md#bot-environment-variables.
+    """
+    bot_id = os.environ.get('SWARMING_BOT_ID')
+    if not bot_id:
+      raise ValueError(
+          "device_arg is 'swarming' but SWARMING_BOT_ID is not set")
+
+    return bot_id[bot_id.index("-") + 1:]

android/test_runner.py

@@ -360,6 +360,12 @@ def AddDeviceOptions(parser):
       'to the id of the main user on device. Only use when the main user is a '
       'secondary user, e.g. Android Automotive OS.')
 
+  parser.add_argument(
+      '--connect-over-ethernet',
+      action='store_true',
+      help='Connect to devices over the network using "adb connect". Only '
+      'supported when running on chromeos-swarming')
+
 
 def AddEmulatorOptions(parser):
   """Adds emulator-specific options to |parser|."""

android/test_runner.pydeps

@@ -181,10 +181,12 @@ pylib/junit/junit_test_instance.py
 pylib/local/__init__.py
 pylib/local/device/__init__.py
 pylib/local/device/local_device_environment.py
+pylib/local/device/local_device_ethernet_environment.py
 pylib/local/device/local_device_gtest_run.py
 pylib/local/device/local_device_instrumentation_test_run.py
 pylib/local/device/local_device_monkey_test_run.py
 pylib/local/device/local_device_test_run.py
+pylib/local/device/skylab_environment.py
 pylib/local/emulator/__init__.py
 pylib/local/emulator/avd.py
 pylib/local/emulator/ini.py