Merge lp:~allenap/maas/remove-old-atomic-delete-and-write into lp:~maas-committers/maas/trunk

[Gavin Panella]

Remove the old AtomicDeleteScript and AtomicWriteScript.

[Blake Rouse (blake-rouse)]

Looks good.

review: Approve

=== modified file 'src/provisioningserver/__main__.py'
--- src/provisioningserver/__main__.py	2016-09-29 18:40:44 +0000
+++ src/provisioningserver/__main__.py	2017-03-23 08:48:30 +0000
@@ -14,16 +14,10 @@
 import provisioningserver.utils.avahi
 import provisioningserver.utils.dhcp
 import provisioningserver.utils.scan_network
-from provisioningserver.utils.script import (
-    AtomicDeleteScript,
-    AtomicWriteScript,
-    MainScript,
-)
+from provisioningserver.utils.script import MainScript
 
 
 script_commands = {
-    'atomic-write': AtomicWriteScript,
-    'atomic-delete': AtomicDeleteScript,
     'check-for-shared-secret': security.CheckForSharedSecretScript,
     'config': provisioningserver.cluster_config_command,
     'install-shared-secret': security.InstallSharedSecretScript,

=== modified file 'src/provisioningserver/utils/script.py'
--- src/provisioningserver/utils/script.py	2016-08-09 00:14:06 +0000
+++ src/provisioningserver/utils/script.py	2017-03-23 08:48:30 +0000
@@ -5,7 +5,6 @@
 
 __all__ = [
     'ActionScript',
-    'AtomicWriteScript',
     'MainScript',
     ]
 
@@ -18,11 +17,6 @@
 from subprocess import CalledProcessError
 import sys
 
-from provisioningserver.utils.fs import (
-    atomic_delete,
-    atomic_write,
-)
-
 
 class ActionScriptError(ValueError):
     """Exception which should be printed to `stderr` if raised."""
@@ -109,62 +103,3 @@
 
 class MainScript(ActionScript):
     """An `ActionScript` denoting the main script in an application."""
-
-
-class AtomicWriteScript:
-    """Wrap the atomic_write function turning it into an ActionScript.
-
-    To use:
-    >>> main = MainScript(atomic_write.__doc__)
-    >>> main.register("myscriptname", AtomicWriteScript)
-    >>> main()
-    """
-
-    @staticmethod
-    def add_arguments(parser):
-        """Initialise options for writing files atomically.
-
-        :param parser: An instance of :class:`ArgumentParser`.
-        """
-        parser.add_argument(
-            "--no-overwrite", action="store_true", required=False,
-            default=False, help="Don't overwrite file if it exists")
-        parser.add_argument(
-            "--filename", action="store", required=True, help=(
-                "The name of the file in which to store contents of stdin"))
-        parser.add_argument(
-            "--mode", action="store", required=False, default="0600", help=(
-                "They permissions to set on the file. If not set "
-                "will be r/w only to owner"))
-
-    @staticmethod
-    def run(args):
-        """Take content from stdin and write it atomically to a file."""
-        atomic_write(
-            sys.stdin.buffer.read(), args.filename, mode=int(args.mode, 8),
-            overwrite=(not args.no_overwrite))
-
-
-class AtomicDeleteScript:
-    """Wrap the atomic_delete function turning it into an ActionScript.
-
-    To use:
-    >>> main = MainScript(atomic_delete.__doc__)
-    >>> main.register("myscriptname", AtomicDeleteScript)
-    >>> main()
-    """
-
-    @staticmethod
-    def add_arguments(parser):
-        """Initialise options for deleting files atomically.
-
-        :param parser: An instance of :class:`ArgumentParser`.
-        """
-        parser.add_argument(
-            "--filename", action="store", required=True, help=(
-                "The name of the file to delete."))
-
-    @staticmethod
-    def run(args):
-        """Delete the file atomically."""
-        atomic_delete(args.filename)

=== modified file 'src/provisioningserver/utils/tests/test_script.py'
--- src/provisioningserver/utils/tests/test_script.py	2016-08-09 00:14:06 +0000
+++ src/provisioningserver/utils/tests/test_script.py	2017-03-23 08:48:30 +0000
@@ -9,39 +9,19 @@
     ArgumentParser,
     Namespace,
 )
-import io
-import os
 from random import randint
-import stat
-from subprocess import (
-    CalledProcessError,
-    PIPE,
-    Popen,
-)
-import sys
+from subprocess import CalledProcessError
 import types
 
-from maastesting import bindir
 from maastesting.factory import factory
 from maastesting.fixtures import CaptureStandardIO
-from maastesting.matchers import (
-    FileContains,
-    MockCalledOnceWith,
-)
 from maastesting.testcase import MAASTestCase
-import provisioningserver.utils
 from provisioningserver.utils import script as script_module
 from provisioningserver.utils.script import (
     ActionScript,
     ActionScriptError,
-    AtomicDeleteScript,
-    AtomicWriteScript,
-)
-from provisioningserver.utils.shell import select_c_utf8_locale
-from testtools.matchers import (
-    Equals,
-    MatchesStructure,
-)
+)
+from testtools.matchers import Equals
 from testtools.testcase import ExpectedException
 
 
@@ -170,141 +150,3 @@
             self.patch(script_module.ActionScript, 'setup')
             script(['smash'])
         self.assertThat(self.stdio.getError(), Equals("Towel.\n"))
-
-
-class TestAtomicWriteScript(MAASTestCase):
-
-    def setUp(self):
-        super(TestAtomicWriteScript, self).setUp()
-        # ArgumentParser sometimes likes to print to stdout/err.
-        self.stdio = self.useFixture(CaptureStandardIO())
-
-    def get_parser(self):
-        parser = ArgumentParser()
-        AtomicWriteScript.add_arguments(parser)
-        return parser
-
-    def get_and_run_mocked_script(self, content, filename, *args):
-        self.stdio.addInput(content)
-        parser = self.get_parser()
-        parsed_args = parser.parse_args(*args)
-        mocked_atomic_write = self.patch(
-            provisioningserver.utils.script, 'atomic_write')
-        AtomicWriteScript.run(parsed_args)
-        return mocked_atomic_write
-
-    def test_arg_setup(self):
-        parser = self.get_parser()
-        filename = factory.make_string()
-        args = parser.parse_args((
-            '--no-overwrite',
-            '--filename', filename,
-            '--mode', "111"))
-        self.assertThat(
-            args, MatchesStructure.byEquality(
-                no_overwrite=True,
-                filename=filename,
-                mode="111"))
-
-    def test_filename_arg_required(self):
-        parser = self.get_parser()
-        self.assertRaises(SystemExit, parser.parse_args, ('--no-overwrite',))
-
-    def test_no_overwrite_defaults_to_false(self):
-        parser = self.get_parser()
-        filename = factory.make_string()
-        args = parser.parse_args(('--filename', filename))
-        self.assertFalse(args.no_overwrite)
-
-    def test_script_executable(self):
-        content = factory.make_string()
-        script = [os.path.join(bindir, "maas-rack"), 'atomic-write']
-        target_file = self.make_file()
-        script.extend(('--filename', target_file, '--mode', '615'))
-        cmd = Popen(script, stdin=PIPE, env=select_c_utf8_locale())
-        cmd.communicate(content.encode("ascii"))
-        self.assertThat(target_file, FileContains(content, encoding="ascii"))
-        self.assertEqual(0o615, stat.S_IMODE(os.stat(target_file).st_mode))
-
-    def test_passes_overwrite_flag(self):
-        content = factory.make_string()
-        filename = factory.make_string()
-        mocked_atomic_write = self.get_and_run_mocked_script(
-            content, filename,
-            ('--filename', filename, '--no-overwrite'))
-
-        self.assertThat(
-            mocked_atomic_write,
-            MockCalledOnceWith(
-                content.encode("ascii"), filename,
-                mode=0o600, overwrite=False))
-
-    def test_passes_mode_flag(self):
-        content = factory.make_string()
-        filename = factory.make_string()
-        # Mode that's unlikely to occur in the wild.
-        mode = 0o377
-        mocked_atomic_write = self.get_and_run_mocked_script(
-            content, filename,
-            ('--filename', filename, '--mode', oct(mode)))
-
-        self.assertThat(
-            mocked_atomic_write,
-            MockCalledOnceWith(
-                content.encode("ascii"), filename, mode=mode, overwrite=True))
-
-    def test_default_mode(self):
-        content = factory.make_string()
-        filename = factory.make_string()
-        mocked_atomic_write = self.get_and_run_mocked_script(
-            content, filename,
-            ('--filename', filename))
-
-        self.assertThat(
-            mocked_atomic_write,
-            MockCalledOnceWith(
-                content.encode("ascii"), filename, mode=0o600, overwrite=True))
-
-
-class TestAtomicDeleteScript(MAASTestCase):
-
-    def setUp(self):
-        super(TestAtomicDeleteScript, self).setUp()
-        # Silence ArgumentParser.
-        self.patch(sys, "stdout", io.StringIO())
-        self.patch(sys, "stderr", io.StringIO())
-
-    def get_parser(self):
-        parser = ArgumentParser()
-        AtomicDeleteScript.add_arguments(parser)
-        return parser
-
-    def get_and_run_mocked_script(self, *args):
-        parser = self.get_parser()
-        parsed_args = parser.parse_args(*args)
-        mocked_atomic_delete = self.patch(
-            provisioningserver.utils.script, 'atomic_delete')
-        AtomicDeleteScript.run(parsed_args)
-        return mocked_atomic_delete
-
-    def test_arg_setup(self):
-        parser = self.get_parser()
-        filename = factory.make_string()
-        args = parser.parse_args((
-            '--filename', filename))
-        self.assertThat(
-            args, MatchesStructure.byEquality(
-                filename=filename))
-
-    def test_filename_arg_required(self):
-        parser = self.get_parser()
-        self.assertRaises(SystemExit, parser.parse_args, tuple())
-
-    def test_calls_atomic_delete_with_filename(self):
-        filename = factory.make_string()
-        mocked_atomic_delete = self.get_and_run_mocked_script(
-            ('--filename', filename))
-
-        self.assertThat(
-            mocked_atomic_delete,
-            MockCalledOnceWith(filename))