commit 3bd3e5ec3a906e3b4c16a67b1af563897b379d0e
author Ben Pastene <bpastene@chromium.org> Mon Aug 10 14:40:43 2020 -0700
committer Commit Bot <commit-bot@chromium.org> Thu Aug 13 12:41:05 2020 +0000
tree bf3a66feaaf5b25221c4366c584491e0148924c6
parent 2209d0b5e18a25c25d16a313a1106678f6e21c61

deploy_chrome: Deprecate '--to' and replace it with '--device'.

The "--device" arg is more common for tools & tests, and deploy_chrome
appears to be the only script that uses "--to" instead of "--device".

So this adds support for "--device" and prints a warning if "--to" is
used.

BUG=chromium:1115724
TEST=deploy_chrome --to localhost --port 9222
TEST=deploy_chrome --device localhost:9222

Change-Id: I4714ffb9d7833d6b586e3f5aa2dfeaf11301a51e
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/chromite/+/2347391
Commit-Queue: Ben Pastene <bpastene@chromium.org>
Tested-by: Ben Pastene <bpastene@chromium.org>
Reviewed-by: Achuith Bhandarkar <achuith@chromium.org>

scripts/deploy_chrome.py

diff --git a/scripts/deploy_chrome.py b/scripts/deploy_chrome.py
index b2e7be5..7473393 100644
--- a/scripts/deploy_chrome.py
+++ b/scripts/deploy_chrome.py
@@ -136,7 +136,13 @@
     self.options = options
     self.staging_dir = staging_dir
     if not self.options.staging_only:
-      self.device = remote.ChromiumOSDevice(options.to, port=options.port,
+      if options.device:
+        hostname = options.device.hostname
+        port = options.device.port
+      else:
+        hostname = options.to
+        port = options.port
+      self.device = remote.ChromiumOSDevice(hostname, port=port,
                                             ping=options.ping,
                                             private_key=options.private_key,
                                             include_dev_paths=False)
@@ -567,9 +573,15 @@
                       help="Don't strip binaries during deployment.  Warning: "
                            'the resulting binaries will be very large!')
   parser.add_argument('-p', '--port', type=int, default=remote.DEFAULT_SSH_PORT,
-                      help='Port of the target device to connect to.')
-  parser.add_argument('-t', '--to',
-                      help='The IP address of the CrOS device to deploy to.')
+                      help='This arg is deprecated. Please use --device '
+                           'instead.')
+  parser.add_argument('-t', '--to', deprecated='Use --device instead',
+                      help='This arg is deprecated. Please use --device '
+                           'instead.')
+  parser.add_argument(
+      '-d', '--device',
+      type=commandline.DeviceParser(commandline.DEVICE_SCHEME_SSH),
+      help='Device hostname or IP in the format hostname[:port].')
   parser.add_argument('--mount-dir', type='path', default=None,
                       help='Deploy Chrome in target directory and bind it '
                            'to the directory specified by this flag.'
@@ -684,8 +696,8 @@
       parser.error('--board is required')
   if options.gs_path and options.local_pkg_path:
     parser.error('Cannot specify both --gs-path and --local-pkg-path')
-  if not (options.staging_only or options.to):
-    parser.error('Need to specify --to')
+  if not (options.staging_only or options.to or options.device):
+    parser.error('Need to specify --device')
   if options.staging_flags and not options.build_dir:
     parser.error('--staging-flags require --build-dir to be set.')
 
@@ -704,6 +716,14 @@
   if options.mount and not options.mount_dir:
     options.mount_dir = _CHROME_DIR
 
+  if options.to:
+    if options.device:
+      parser.error('--to and --device are mutually exclusive.')
+    else:
+      logging.warning(
+          "The args '--to' & '--port' are deprecated. Please use '--device' "
+          'instead.')
+
   return options