CLI: pull flash functionality into common module.
This CL pulls common functionality into cli/flash.py so that `cros` and
`brillo` flash only need to implement their particular CLI handling and
then call into the common functions.
This is just a structural change; for now both tools still behave
identically, but it paves the way for differences in future CLs.
BUG=brillo:622
TEST=cbuildbot/run_tests
TEST=cros flash --board=panther usb://
TEST=brillo flash <IP>
Change-Id: I67e1ae7da704ad46afd24387a1a1ca3d4547a83a
Reviewed-on: https://chromium-review.googlesource.com/262732
Trybot-Ready: David Pursell <dpursell@chromium.org>
Tested-by: David Pursell <dpursell@chromium.org>
Reviewed-by: Don Garrett <dgarrett@chromium.org>
Commit-Queue: David Pursell <dpursell@chromium.org>
diff --git a/cli/flash_unittest.py b/cli/flash_unittest.py
new file mode 100644
index 0000000..70eed5c
--- /dev/null
+++ b/cli/flash_unittest.py
@@ -0,0 +1,227 @@
+# Copyright 2015 The Chromium OS Authors. All rights reserved.
+# Use of this source code is governed by a BSD-style license that can be
+# found in the LICENSE file.
+
+"""Unit tests for the flash module."""
+
+from __future__ import print_function
+
+import mock
+import os
+
+from chromite.cli import flash
+from chromite.lib import brick_lib
+from chromite.lib import commandline
+from chromite.lib import cros_build_lib
+from chromite.lib import cros_test_lib
+from chromite.lib import dev_server_wrapper
+from chromite.lib import partial_mock
+from chromite.lib import remote_access
+
+
+class RemoteDeviceUpdaterMock(partial_mock.PartialCmdMock):
+ """Mock out RemoteDeviceUpdater."""
+ TARGET = 'chromite.cli.flash.RemoteDeviceUpdater'
+ ATTRS = ('UpdateStateful', 'UpdateRootfs', 'SetupRootfsUpdate', 'Verify')
+
+ def __init__(self):
+ partial_mock.PartialCmdMock.__init__(self)
+
+ def UpdateStateful(self, _inst, *_args, **_kwargs):
+ """Mock out UpdateStateful."""
+
+ def UpdateRootfs(self, _inst, *_args, **_kwargs):
+ """Mock out UpdateRootfs."""
+
+ def SetupRootfsUpdate(self, _inst, *_args, **_kwargs):
+ """Mock out SetupRootfsUpdate."""
+
+ def Verify(self, _inst, *_args, **_kwargs):
+ """Mock out SetupRootfsUpdate."""
+
+
+class BrickMock(partial_mock.PartialMock):
+ """Mock out brick_lib.Brick."""
+ TARGET = 'chromite.lib.brick_lib.Brick'
+ ATTRS = ('Inherits')
+
+ def __init__(self):
+ partial_mock.PartialMock.__init__(self)
+
+ def Inherits(self, _inst, *_args, **_kwargs):
+ """Mock out Inherits."""
+ return True
+
+
+class RemoteDeviceUpdaterTest(cros_test_lib.MockTempDirTestCase):
+ """Test the flow of flash.Flash() with RemoteDeviceUpdater."""
+
+ IMAGE = '/path/to/image'
+ DEVICE = commandline.Device(scheme=commandline.DEVICE_SCHEME_SSH,
+ hostname='1.1.1.1')
+
+ def setUp(self):
+ """Patches objects."""
+ self.updater_mock = self.StartPatcher(RemoteDeviceUpdaterMock())
+ self.PatchObject(dev_server_wrapper, 'GenerateXbuddyRequest',
+ return_value='xbuddy/local/latest')
+ self.PatchObject(dev_server_wrapper, 'DevServerWrapper')
+ self.PatchObject(dev_server_wrapper, 'GetImagePathWithXbuddy',
+ return_value='taco-paladin/R36/chromiumos_test_image.bin')
+ self.PatchObject(dev_server_wrapper, 'GetUpdatePayloads')
+ self.PatchObject(remote_access, 'CHECK_INTERVAL', new=0)
+ self.PatchObject(remote_access, 'ChromiumOSDevice')
+
+ def testUpdateAll(self):
+ """Tests that update methods are called correctly."""
+ proj = BrickMock()
+ with mock.patch('os.path.exists', return_value=True):
+ with mock.patch('chromite.lib.brick_lib.FindBrickByName',
+ return_value=proj):
+ flash.Flash(self.DEVICE, self.IMAGE)
+ self.assertTrue(self.updater_mock.patched['UpdateStateful'].called)
+ self.assertTrue(self.updater_mock.patched['UpdateRootfs'].called)
+
+ def testUpdateStateful(self):
+ """Tests that update methods are called correctly."""
+ proj = BrickMock()
+ with mock.patch('os.path.exists', return_value=True):
+ with mock.patch('chromite.lib.brick_lib.FindBrickByName',
+ return_value=proj):
+ flash.Flash(self.DEVICE, self.IMAGE, rootfs_update=False)
+ self.assertTrue(self.updater_mock.patched['UpdateStateful'].called)
+ self.assertFalse(self.updater_mock.patched['UpdateRootfs'].called)
+
+ def testUpdateRootfs(self):
+ """Tests that update methods are called correctly."""
+ proj = BrickMock()
+ with mock.patch('os.path.exists', return_value=True):
+ with mock.patch('chromite.lib.brick_lib.FindBrickByName',
+ return_value=proj):
+ flash.Flash(self.DEVICE, self.IMAGE, stateful_update=False)
+ self.assertFalse(self.updater_mock.patched['UpdateStateful'].called)
+ self.assertTrue(self.updater_mock.patched['UpdateRootfs'].called)
+
+ def testMissingPayloads(self):
+ """Tests we raise FlashError when payloads are missing."""
+ with mock.patch('os.path.exists', return_value=False):
+ self.assertRaises(flash.FlashError, flash.Flash, self.DEVICE, self.IMAGE)
+
+ def testProjectSdk(self):
+ """Tests that Project SDK flashing invoked as expected."""
+ proj = BrickMock()
+ with mock.patch('os.path.exists', return_value=True):
+ with mock.patch('chromite.lib.brick_lib.FindBrickByName',
+ return_value=proj):
+ with mock.patch('chromite.lib.project_sdk.FindVersion',
+ return_value='1.2.3'):
+ flash.Flash(self.DEVICE, self.IMAGE, project_sdk_image=True)
+ dev_server_wrapper.GetImagePathWithXbuddy.assert_called_with(
+ 'project_sdk', mock.ANY, version='1.2.3', static_dir=mock.ANY,
+ lookup_only=True)
+ self.assertTrue(self.updater_mock.patched['UpdateStateful'].called)
+ self.assertTrue(self.updater_mock.patched['UpdateRootfs'].called)
+
+
+class USBImagerMock(partial_mock.PartialCmdMock):
+ """Mock out USBImager."""
+ TARGET = 'chromite.cli.flash.USBImager'
+ ATTRS = ('CopyImageToDevice', 'InstallImageToDevice',
+ 'ChooseRemovableDevice', 'ListAllRemovableDevices',
+ 'GetRemovableDeviceDescription', 'IsFilePathGPTDiskImage')
+ VALID_IMAGE = True
+
+ def __init__(self):
+ partial_mock.PartialCmdMock.__init__(self)
+
+ def CopyImageToDevice(self, _inst, *_args, **_kwargs):
+ """Mock out CopyImageToDevice."""
+
+ def InstallImageToDevice(self, _inst, *_args, **_kwargs):
+ """Mock out InstallImageToDevice."""
+
+ def ChooseRemovableDevice(self, _inst, *_args, **_kwargs):
+ """Mock out ChooseRemovableDevice."""
+
+ def ListAllRemovableDevices(self, _inst, *_args, **_kwargs):
+ """Mock out ListAllRemovableDevices."""
+ return ['foo', 'taco', 'milk']
+
+ def GetRemovableDeviceDescription(self, _inst, *_args, **_kwargs):
+ """Mock out GetRemovableDeviceDescription."""
+
+ def IsFilePathGPTDiskImage(self, _inst, *_args, **_kwargs):
+ """Mock out IsFilePathGPTDiskImage."""
+ return self.VALID_IMAGE
+
+
+class USBImagerTest(cros_test_lib.MockTempDirTestCase):
+ """Test the flow of flash.Flash() with USBImager."""
+ IMAGE = '/path/to/image'
+
+ def Device(self, path):
+ """Create a USB device for passing to flash.Flash()."""
+ return commandline.Device(scheme=commandline.DEVICE_SCHEME_USB,
+ path=path)
+
+ def setUp(self):
+ """Patches objects."""
+ self.usb_mock = USBImagerMock()
+ self.imager_mock = self.StartPatcher(self.usb_mock)
+ self.PatchObject(dev_server_wrapper, 'GenerateXbuddyRequest',
+ return_value='xbuddy/local/latest')
+ self.PatchObject(dev_server_wrapper, 'DevServerWrapper')
+ self.PatchObject(dev_server_wrapper, 'GetImagePathWithXbuddy',
+ return_value='taco-paladin/R36/chromiumos_test_image.bin')
+ self.PatchObject(os.path, 'exists', return_value=True)
+ self.PatchObject(brick_lib, 'FindBrickInPath', return_value=None)
+
+ def testLocalImagePathCopy(self):
+ """Tests that imaging methods are called correctly."""
+ with mock.patch('os.path.isfile', return_value=True):
+ flash.Flash(self.Device('/dev/foo'), self.IMAGE)
+ self.assertTrue(self.imager_mock.patched['CopyImageToDevice'].called)
+
+ def testLocalImagePathInstall(self):
+ """Tests that imaging methods are called correctly."""
+ with mock.patch('os.path.isfile', return_value=True):
+ flash.Flash(self.Device('/dev/foo'), self.IMAGE, board='taco',
+ install=True)
+ self.assertTrue(self.imager_mock.patched['InstallImageToDevice'].called)
+
+ def testLocalBadImagePath(self):
+ """Tests that using an image not having the magic bytes has prompt."""
+ self.usb_mock.VALID_IMAGE = False
+ with mock.patch('os.path.isfile', return_value=True):
+ with mock.patch.object(cros_build_lib, 'BooleanPrompt') as mock_prompt:
+ mock_prompt.return_value = False
+ flash.Flash(self.Device('/dev/foo'), self.IMAGE)
+ self.assertTrue(mock_prompt.called)
+
+ def testNonLocalImagePath(self):
+ """Tests that we try to get the image path using xbuddy."""
+ with mock.patch.object(
+ dev_server_wrapper,
+ 'GetImagePathWithXbuddy',
+ return_value='translated/xbuddy/path') as mock_xbuddy:
+ with mock.patch('os.path.isfile', return_value=False):
+ with mock.patch('os.path.isdir', return_value=False):
+ flash.Flash(self.Device('/dev/foo'), self.IMAGE)
+ self.assertTrue(mock_xbuddy.called)
+
+ def testConfirmNonRemovableDevice(self):
+ """Tests that we ask user to confirm if the device is not removable."""
+ with mock.patch.object(cros_build_lib, 'BooleanPrompt') as mock_prompt:
+ flash.Flash(self.Device('/dev/dummy'), self.IMAGE)
+ self.assertTrue(mock_prompt.called)
+
+ def testSkipPromptNonRemovableDevice(self):
+ """Tests that we skip the prompt for non-removable with --yes."""
+ with mock.patch.object(cros_build_lib, 'BooleanPrompt') as mock_prompt:
+ flash.Flash(self.Device('/dev/dummy'), self.IMAGE, yes=True)
+ self.assertFalse(mock_prompt.called)
+
+ def testChooseRemovableDevice(self):
+ """Tests that we ask user to choose a device if none is given."""
+ flash.Flash(self.Device(''), self.IMAGE)
+ self.assertTrue(self.imager_mock.patched['ChooseRemovableDevice'].called)