Bug 2216608

The problem here seems to be that we call the function get_cmd_output_path() with the default values, here:

        logpath = self.get_cmd_output_path()


And by default it tries to create the directory, which in our case has been already created, if I'm reading it correctly:

	def get_cmd_output_path(self, name=None, make=True):                     <-- default is to create dir
		"""Get the path where this plugin will save command output

		:param name: Optionally specify a filename to use as part of the
					 command output path
		:type name: ``str`` or ``None``

		:param make: Attempt to create the command output path
		:type make: ``bool``

		:returns: The path where the plugin will write command output data
				  within the archive
		:rtype: ``str``
		"""
		cmd_output_path = os.path.join(self.archive.get_tmp_dir(),
									   'sos_commands', self.name())
		if name:
			cmd_output_path = os.path.join(cmd_output_path, name)
		if make:
			os.makedirs(cmd_output_path)                    <-- So we end up here attempting to create an already existing dir

I have a couple of ideas about how to solve this, but will need to test them first.

(In reply to Jose Castillo from comment #1)
> The problem here seems to be that we call the function get_cmd_output_path()
> with the default values, here:
> 
>         logpath = self.get_cmd_output_path()
> 
> 
> And by default it tries to create the directory, which in our case has been
> already created, if I'm reading it correctly:
> 
> 	def get_cmd_output_path(self, name=None, make=True):                    
> <-- default is to create dir
> 		"""Get the path where this plugin will save command output
> 
> 		:param name: Optionally specify a filename to use as part of the
> 					 command output path
> 		:type name: ``str`` or ``None``
> 
> 		:param make: Attempt to create the command output path
> 		:type make: ``bool``
> 
> 		:returns: The path where the plugin will write command output data
> 				  within the archive
> 		:rtype: ``str``
> 		"""
> 		cmd_output_path = os.path.join(self.archive.get_tmp_dir(),
> 									   'sos_commands', self.name())
> 		if name:
> 			cmd_output_path = os.path.join(cmd_output_path, name)
> 		if make:
> 			os.makedirs(cmd_output_path)                    <-- So we end up here
> attempting to create an already existing dir
> 
> I have a couple of ideas about how to solve this, but will need to test them
> first.

Three *possible* ideas (dont saying the best ones):

1) enhance get_cmd_output_path by optional parameter skip_if_present and call os.makedirs with exist_ok=skip_if_present option (to have plugins the ability to configure it (is there a need for it..?))
2) call the os.makedirs always with exist_ok=True (pragmatically saying, we just want to make it created, right?)
3) put the os.makedirs call into try-catch block and raise a warning in catch branch (likewise 2) but with an extra warn log)

I'm testing exist_ok=True, because that will catch if the dir has been created up to the point when we call os.makedirs(), because I think this may help better to avoid race conditions.

Upstream PR can be found here:

https://github.com/sosreport/sos/pull/3285

Will you be able to test this fix for us when we will have release candidate?

*** Bug 2221103 has been marked as a duplicate of this bug. ***

Hello Jan,

Have shared the links to the new package with the customer and requested that they test it.

Regards

Since the problem described in this bug report should be
resolved in a recent advisory, it has been closed with a
resolution of ERRATA.

For information on the advisory (sos bug fix and enhancement update), and where to find the updated
files, follow the link below.

If the solution does not work for you, open a new bug report.

https://access.redhat.com/errata/RHBA-2023:4279