Merge pull request #11594 from rallytime/darwin_sysctl_test

Tests and added functionality for darwin_sysctl module

salt/modules/darwin_sysctl.py

@@ -55,7 +55,8 @@ def show():
         #
         # user.tzname_max = 255
         # kern.clockrate: hz = 100, tick = 10000, profhz = 100, stathz = 100
-        # kern.clockrate: { hz = 100, tick = 10000, tickadj = 2, profhz = 100, stathz = 100 }
+        # kern.clockrate: {hz = 100, tick = 10000, tickadj = 2, profhz = 100,
+        #                 stathz = 100}
         #
         # Yes. That's two `kern.clockrate`.
         #
@@ -76,6 +77,9 @@ def get(name):
     '''
     Return a single sysctl parameter for this minion
 
+    name
+        The name of the sysctl value to display.
+
     CLI Example:
 
     .. code-block:: bash
@@ -91,6 +95,12 @@ def assign(name, value):
     '''
     Assign a single sysctl parameter for this minion
 
+    name
+        The name of ths sysctl value to edit.
+
+    value
+        The sysctl value to apply.
+
     CLI Example:
 
     .. code-block:: bash
@@ -109,10 +119,24 @@ def assign(name, value):
     return ret
 
 
-def persist(name, value, config='/etc/sysctl.conf'):
+def persist(name, value, config='/etc/sysctl.conf', apply_change=False):
     '''
     Assign and persist a simple sysctl parameter for this minion
 
+    name
+        The name of the sysctl value to edit.
+
+    value
+        The sysctl value to apply.
+
+    config
+        The location of the sysctl configuration file.
+
+    apply_change
+        Default is False; Default behavior only creates or edits
+        the sysctl.conf file. If apply is set to True, the changes are
+        applied to the system.
+
     CLI Example:
 
     .. code-block:: bash
@@ -156,4 +180,8 @@ def persist(name, value, config='/etc/sysctl.conf'):
         nlines.append('{0}={1}'.format(name, value))
     with salt.utils.fopen(config, 'w+') as ofile:
         ofile.writelines(nlines)
+    # If apply_change=True, apply edits to system
+    if apply_change is True:
+        assign(name, value)
+        return 'Updated and applied'
     return 'Updated'

tests/integration/modules/darwin_sysctl.py

@@ -9,6 +9,7 @@ import random
 
 # Import Salt Libs
 import integration
+from salt.utils import mkstemp, fopen
 from salt.exceptions import CommandExecutionError
 
 # Import Salt Testing Libs
@@ -22,6 +23,7 @@ ensure_in_syspath('../../')
 
 # Module Variables
 ASSIGN_CMD = 'net.inet.icmp.icmplim'
+CONFIG = '/etc/sysctl.conf'
 
 
 class DarwinSysctlModuleTest(integration.ModuleCase):
@@ -41,8 +43,21 @@ class DarwinSysctlModuleTest(integration.ModuleCase):
                     **os_grain
                 )
             )
+        # Data needed for cleanup
+        self.has_conf = False
         self.val = self.run_function('sysctl.get', [ASSIGN_CMD])
 
+        # If sysctl file is present, make a copy
+        # Remove original file so we can replace it with test files
+        if os.path.isfile(CONFIG):
+            self.has_conf = True
+            try:
+                self.conf = self.__copy_sysctl()
+            except CommandExecutionError:
+                msg = 'Could not copy file: {0}'
+                raise CommandExecutionError(msg.format(CONFIG))
+            os.remove(CONFIG)
+
     @destructiveTest
     @skipIf(os.geteuid() != 0, 'You must be logged in as root to run this test')
     @requires_system_grains
@@ -65,6 +80,124 @@ class DarwinSysctlModuleTest(integration.ModuleCase):
             self.run_function('sysctl.assign', [ASSIGN_CMD, self.val])
             raise
 
+    @destructiveTest
+    @skipIf(os.geteuid() != 0, 'You must be logged in as root to run this test')
+    @requires_system_grains
+    def test_persist_new_file(self, grains=None):
+        '''
+        Tests assigning a sysctl value to a system without a sysctl.conf file
+        '''
+        # Always start with a clean/known sysctl.conf state
+        if os.path.isfile(CONFIG):
+            os.remove(CONFIG)
+        try:
+            self.run_function('sysctl.persist', [ASSIGN_CMD, 10])
+            line = '{0}={1}'.format(ASSIGN_CMD, 10)
+            found = self.__check_string(CONFIG, line)
+            try:
+                self.assertTrue(found)
+            except AssertionError:
+                raise
+        except CommandExecutionError:
+            os.remove(CONFIG)
+            raise
+
+    @destructiveTest
+    @skipIf(os.geteuid() != 0, 'You must be logged in as root to run this test')
+    @requires_system_grains
+    def test_persist_already_set(self, grains=None):
+        '''
+        Tests assigning a sysctl value that is already set in sysctl.conf file
+        '''
+        # Always start with a clean/known sysctl.conf state
+        if os.path.isfile(CONFIG):
+            os.remove(CONFIG)
+        try:
+            self.run_function('sysctl.persist', [ASSIGN_CMD, 50])
+            ret = self.run_function('sysctl.persist', [ASSIGN_CMD, 50])
+            try:
+                self.assertEqual(ret, 'Already set')
+            except AssertionError:
+                raise
+        except CommandExecutionError:
+            os.remove(CONFIG)
+            raise
+
+    @destructiveTest
+    @skipIf(os.geteuid() != 0, 'You must be logged in as root to run this test')
+    @requires_system_grains
+    def test_persist_apply_change(self, grains=None):
+        '''
+        Tests assigning a sysctl value and applying the change to system
+        '''
+        # Always start with a clean/known sysctl.conf state
+        if os.path.isfile(CONFIG):
+            os.remove(CONFIG)
+        try:
+            rand = random.randint(0, 500)
+            while rand == self.val:
+                rand = random.randint(0, 500)
+            self.run_function('sysctl.persist',
+                              [ASSIGN_CMD, rand],
+                              apply_change=True)
+            info = int(self.run_function('sysctl.get', [ASSIGN_CMD]))
+            try:
+                self.assertEqual(info, rand)
+            except AssertionError:
+                raise
+        except CommandExecutionError:
+            os.remove(CONFIG)
+            raise
+
+    def __copy_sysctl(self):
+        '''
+        Copies an existing sysconf file and returns temp file path. Copied
+        file will be restored in tearDown
+        '''
+        # Create new temporary file path and open needed files
+        org_conf = fopen(CONFIG, 'r')
+        temp_path = mkstemp()
+        temp_sysconf = open(temp_path, 'w')
+
+        # write sysctl lines to temp file
+        for line in org_conf:
+            temp_sysconf.write(line)
+        org_conf.close()
+        temp_sysconf.close()
+
+        return temp_path
+
+    def __restore_sysctl(self):
+        '''
+        Restores the original sysctl.conf file from temporary copy
+        '''
+        # If sysctl testing file exists, delete it
+        if os.path.isfile(CONFIG):
+            os.remove(CONFIG)
+        temp_sysctl = open(self.conf, 'r')
+        sysctl = open(CONFIG, 'w')
+
+        # write temp lines to sysctl file to restore
+        for line in temp_sysctl:
+            sysctl.write(line)
+        temp_sysctl.close()
+        sysctl.close()
+
+        # delete temporary file
+        os.remove(self.conf)
+
+    def __check_string(self, conf_file, to_find):
+        '''
+        Returns True if given line is present in file
+        '''
+        f_in = open(conf_file, 'r')
+        for line in f_in:
+            if to_find in line:
+                f_in.close()
+                return True
+        f_in.close()
+        return False
+
     @destructiveTest
     @skipIf(os.geteuid() != 0, 'You must be logged in as root to run this test')
     @requires_system_grains
@@ -72,7 +205,17 @@ class DarwinSysctlModuleTest(integration.ModuleCase):
         '''
         Clean up after tests
         '''
-        self.run_function('sysctl.assign', [ASSIGN_CMD, self.val])
+        ret = self.run_function('sysctl.get', [ASSIGN_CMD])
+        if ret != self.val:
+            self.run_function('sysctl.assign', [ASSIGN_CMD, self.val])
+
+        if self.has_conf is True:
+            # restore original sysctl file
+            self.__restore_sysctl()
+
+        if self.has_conf is False and os.path.isfile(CONFIG):
+            # remove sysctl.conf created by tests
+            os.remove(CONFIG)
 
 
 if __name__ == '__main__':