Merge lp:~rsalveti/ubuntu-system-image/production-factory-reset into lp:~registry/ubuntu-system-image/client

[Ricardo Salveti]

Adding support for production factory reset

Adding support for production factory reset

[Barry Warsaw (barry)]

Other than the one comment, LGTM! Thanks. I will merge and test.

review: Approve

=== modified file 'NEWS.rst'
--- NEWS.rst	2015-02-05 02:49:43 +0000
+++ NEWS.rst	2015-02-07 02:56:01 +0000
@@ -44,6 +44,8 @@
  * As part of LP: #1417176, the ``--no-reboot`` switch for
    ``system-image-cli(1)`` has been deprecated.  Use ``--no-apply`` instead
    (``-g`` is still the shortcut).
+ * Support production factory resets.  `system-image-cli --production-reset`
+   and a new D-Bus API method `ProductionReset()` are added. (LP: #1419027)
 
 2.5.1 (2014-10-21)
 ==================

=== modified file 'dbus-manpage.rst'
--- dbus-manpage.rst	2015-02-05 00:48:59 +0000
+++ dbus-manpage.rst	2015-02-07 02:56:01 +0000
@@ -161,6 +161,13 @@
 
     *New in system-image 2.3*.
 
+``ProductionReset()``
+    This is a **synchronous** call which wipes the data partition, sets a flag
+    for factory wipe (used in production), and issue a reboot to recovery.
+    A ``Rebooting`` signal may be sent, depending on timing.
+
+    *New in system-image 3.0*.
+
 ``SetSetting(key, value)``
     This is a **synchronous** call to write or update a setting.  ``key`` and
     ``value`` are strings.  While any key/value pair may be set, some keys

=== modified file 'systemimage/api.py'
--- systemimage/api.py	2015-02-05 00:48:59 +0000
+++ systemimage/api.py	2015-02-07 02:56:01 +0000
@@ -121,3 +121,6 @@
 
     def factory_reset(self):
         factory_reset()
+
+    def production_reset(self):
+        factory_reset(True)

=== modified file 'systemimage/apply.py'
--- systemimage/apply.py	2015-02-05 00:48:59 +0000
+++ systemimage/apply.py	2015-02-07 02:56:01 +0000
@@ -63,11 +63,16 @@
         pass
 
 
-def factory_reset():
+def factory_reset(production_reset=False):
     """Perform a factory reset."""
     command_file = os.path.join(
         config.updater.cache_partition, 'ubuntu_command')
     with atomic(command_file) as fp:
         print('format data', file=fp)
-    log.info('Performing a factory reset')
+        if production_reset:
+            print('enable factory_wipe', file=fp)
+    if production_reset:
+        log.info('Performing a production factory reset')
+    else:
+        log.info('Performing a factory reset')
     config.hooks.apply().apply()

=== modified file 'systemimage/dbus.py'
--- systemimage/dbus.py	2015-02-05 00:48:59 +0000
+++ systemimage/dbus.py	2015-02-07 02:56:01 +0000
@@ -390,6 +390,14 @@
 
     @log_and_exit
     @method('com.canonical.SystemImage')
+    def ProductionReset(self):
+        self._api.production_reset()
+        # This code may or may not run.  We're racing against the system
+        # reboot procedure.
+        self.Rebooting(True)
+
+    @log_and_exit
+    @method('com.canonical.SystemImage')
     def Exit(self):
         """Quit the daemon immediately."""
         self.loop.quit()

=== modified file 'systemimage/main.py'
--- systemimage/main.py	2015-02-05 00:48:59 +0000
+++ systemimage/main.py	2015-02-07 02:56:01 +0000
@@ -109,6 +109,12 @@
                         help="""Perform a destructive factory reset and
                                 reboot.  WARNING: this will wipe all user data
                                 on the device!""")
+    parser.add_argument('--production-reset',
+                        default=False, action='store_true',
+                        help="""Perform a destructive production reset
+                                (similar to factory reset) and reboot.
+                                WARNING: this will wipe all user data
+                                on the device!""")
     parser.add_argument('--switch',
                         default=None, action='store', metavar='CHANNEL',
                         help="""Switch to the given channel.  This is
@@ -155,8 +161,8 @@
         config.skip_gpg_verification = True
 
     # Perform a factory reset.
-    if args.factory_reset:
-        factory_reset()
+    if args.factory_reset or args.production_reset:
+        factory_reset(args.production_reset)
         # We should never get here, except possibly during the testing
         # process, so just return as normal.
         return 0

=== modified file 'systemimage/tests/test_api.py'
--- systemimage/tests/test_api.py	2015-02-05 00:48:59 +0000
+++ systemimage/tests/test_api.py	2015-02-07 02:56:01 +0000
@@ -205,6 +205,20 @@
             """))
 
     @configuration
+    def test_production_reset(self):
+        mediator = Mediator()
+        with patch('systemimage.apply.Reboot.apply') as mock:
+            mediator.production_reset()
+        self.assertTrue(mock.called)
+        path = Path(config.updater.cache_partition) / 'ubuntu_command'
+        with path.open('r', encoding='utf-8') as fp:
+            command = fp.read()
+        self.assertMultiLineEqual(command, dedent("""\
+            format data
+            enable factory_wipe
+            """))
+
+    @configuration
     def test_cancel(self):
         # When we get to the step of downloading the files, cancel it.
         self._setup_server_keyrings()

=== modified file 'systemimage/tests/test_dbus.py'
--- systemimage/tests/test_dbus.py	2015-02-05 02:49:43 +0000
+++ systemimage/tests/test_dbus.py	2015-02-07 02:56:01 +0000
@@ -23,6 +23,7 @@
     'TestDBusDownload',
     'TestDBusDownloadBigFiles',
     'TestDBusFactoryReset',
+    'TestDBusProductionReset',
     'TestDBusGetSet',
     'TestDBusInfo',
     'TestDBusMiscellaneous',
@@ -55,6 +56,7 @@
 from dbus.exceptions import DBusException
 from functools import partial
 from pathlib import Path
+from textwrap import dedent
 from systemimage.config import Configuration
 from systemimage.helpers import MiB, safe_remove
 from systemimage.reactor import Reactor
@@ -1577,6 +1579,28 @@
         self.assertEqual(command, 'format data\n')
 
 
+class TestDBusProductionReset(_LiveTesting):
+    def test_production_reset(self):
+        # A production factory reset is applied.
+        command_file = os.path.join(
+            self.config.updater.cache_partition, 'ubuntu_command')
+        self.assertFalse(os.path.exists(self.reboot_log))
+        self.assertFalse(os.path.exists(command_file))
+        reactor = SignalCapturingReactor('Rebooting')
+        reactor.run(self.iface.ProductionReset)
+        self.assertEqual(len(reactor.signals), 1)
+        self.assertTrue(reactor.signals[0])
+        with open(self.reboot_log, encoding='utf-8') as fp:
+            reboot = fp.read()
+        self.assertEqual(reboot, '/sbin/reboot -f recovery')
+        with open(command_file, encoding='utf-8') as fp:
+            command = fp.read()
+        self.assertMultiLineEqual(command, dedent("""\
+            format data
+            enable factory_wipe
+            """))
+
+
 class TestDBusProgress(_LiveTesting):
     def test_progress(self):
         self.download_manually()

=== modified file 'systemimage/tests/test_main.py'
--- systemimage/tests/test_main.py	2015-02-05 00:48:59 +0000
+++ systemimage/tests/test_main.py	2015-02-07 02:56:01 +0000
@@ -18,6 +18,7 @@
 __all__ = [
     'TestCLIDuplicateDestinations',
     'TestCLIFactoryReset',
+    'TestCLIProductionReset',
     'TestCLIFilters',
     'TestCLIListChannels',
     'TestCLIMain',
@@ -1016,6 +1017,30 @@
             """))
 
 
+class TestCLIProductionReset(unittest.TestCase):
+    """Test the --production-reset option for production factory resets."""
+
+    @configuration
+    def test_production_reset(self, config_d):
+        # system-image-cli --production-reset
+        capture = StringIO()
+        with ExitStack() as resources:
+            resources.enter_context(capture_print(capture))
+            mock = resources.enter_context(
+                patch('systemimage.apply.Reboot.apply'))
+            resources.enter_context(argv('-C', config_d, '--production-reset'))
+            cli_main()
+        # A reboot was issued.
+        self.assertTrue(mock.called)
+        path = os.path.join(config.updater.cache_partition, 'ubuntu_command')
+        with open(path, 'r', encoding='utf-8') as fp:
+            command = fp.read()
+        self.assertMultiLineEqual(command, dedent("""\
+            format data
+            enable factory_wipe
+            """))
+
+
 class TestCLISettings(unittest.TestCase):
     """Test settings command line options."""