community.general.osx_defaults: Include stderr in error messages

changelogs/fragments/6011-osx-defaults-errors.yml

@@ -0,0 +1,2 @@
+bugfixes:
+  - "osx_defaults - include stderr in error messages (https://github.com/ansible-collections/community.general/pull/6011)."

plugins/modules/osx_defaults.py

@@ -71,48 +71,53 @@
 '''
 
 EXAMPLES = r'''
-# TODO: Describe what happens in each example
-
+# Set Boolean Valued Key for Application Domain
 - community.general.osx_defaults:
     domain: com.apple.Safari
     key: IncludeInternalDebugMenu
     type: bool
     value: true
     state: present
 
+# Set String Valued Key for Global Domain
 - community.general.osx_defaults:
     domain: NSGlobalDomain
     key: AppleMeasurementUnits
     type: string
     value: Centimeters
     state: present
 
+# Set Int Valued Key for arbitrary plist
 - community.general.osx_defaults:
     domain: /Library/Preferences/com.apple.SoftwareUpdate
     key: AutomaticCheckEnabled
     type: int
     value: 1
   become: true
 
+# Set Int Valued Key only for the current host
 - community.general.osx_defaults:
     domain: com.apple.screensaver
     host: currentHost
     key: showClock
     type: int
     value: 1
 
+# Defaults to Global Domain and Setting value
 - community.general.osx_defaults:
     key: AppleMeasurementUnits
     type: string
     value: Centimeters
 
+# Setting an Array valued key
 - community.general.osx_defaults:
     key: AppleLanguages
     type: array
     value:
       - en
       - nl
 
+# Removing a key
 - community.general.osx_defaults:
     domain: com.geekchimp.macable
     key: ExampleKeyToRemove
@@ -257,7 +262,7 @@ def read(self):
 
         # If the RC is not 0, then terrible happened! Ooooh nooo!
         if rc != 0:
-            raise OSXDefaultsException("An error occurred while reading key type from defaults: %s" % out)
+            raise OSXDefaultsException("An error occurred while reading key type from defaults: %s" % err)
 
         # Ok, lets parse the type from output
         data_type = out.strip().replace('Type is ', '')
@@ -268,9 +273,9 @@ def read(self):
         # Strip output
         out = out.strip()
 
-        # An non zero RC at this point is kinda strange...
+        # A non zero RC at this point is kinda strange...
         if rc != 0:
-            raise OSXDefaultsException("An error occurred while reading key value from defaults: %s" % out)
+            raise OSXDefaultsException("An error occurred while reading key value from defaults: %s" % err)
 
         # Convert string to list when type is array
         if data_type == "array":
@@ -308,13 +313,13 @@ def write(self):
                                                expand_user_and_vars=False)
 
         if rc != 0:
-            raise OSXDefaultsException('An error occurred while writing value to defaults: %s' % out)
+            raise OSXDefaultsException('An error occurred while writing value to defaults: %s' % err)
 
     def delete(self):
         """ Deletes defaults key from domain """
         rc, out, err = self.module.run_command(self._base_command() + ['delete', self.domain, self.key])
         if rc != 0:
-            raise OSXDefaultsException("An error occurred while deleting key from defaults: %s" % out)
+            raise OSXDefaultsException("An error occurred while deleting key from defaults: %s" % err)
 
     # /commands ----------------------------------------------------------- }}}