zypper_repository: preserve attributes enabled, autorefresh and gpgcheck if provided from the task parameters #9108

TobiasZeuch181 · 2024-11-08T11:36:57Z

… task parameters

Currently, the values are overridden with the data found on the file system Instead, these values should only be updated, if they were not provided in the parameters. That way, repositories on the system could be enabled/disabled and the flags could be updated again

SUMMARY

The code currently looks up the repo-file on the local disk and if it exists, it load the optional attributes enabled, autorefresh and gpgcheck and these values are used to fill up the repository-object that is later written to disk.
Unfortunately, these values are overriding the attributes, if they were provided from the task in ansible - which makes it impossible to modify the values for a repository that is already registered on the system.
So I changed the code, to:

only update the object attributes the default values, if provided by the task log (so we can check later if they were provided)
only udpate the attribute with the values from the file, if it wasn't already filled
Finally set the default values, if a new object is created

I considered changing the order of the statements to

write default values
override with existing values from file
override with attributes from the ansible task configuration
but I thought it was better to stay with the current structure, because the change is smaller and we need the code to read the ansible-parameters at the beginning to check, if there parameters would introduce a change.

Fixes 8783

ISSUE TYPE

Bugfix Pull Request

COMPONENT NAME

zupper_repository

ADDITIONAL INFORMATION

Register a repostory, e.g. via ansible
use ansible to modify any of the parameters. The task will not change them

… parameters Currently, the values are overridden with the data found on the file system Instead, these values should only be updated, if they were not provided in the parameters. That way, repositories on the system could be enabled/disabled and the flags could be updated again

if the values are not provided from the task-input nor read from an existing file

ansibullbot · 2024-11-08T11:49:03Z

cc @AnderEnder @alxgu @andytom @commel @evrardjp @lrupp @sealor @toabctl
click here for bot help

felixfontein

Thanks for your contribution! I've added some first comments.

felixfontein · 2024-11-10T12:34:46Z

plugins/modules/zypper_repository.py

+        if module.params['autorefresh']:
+            repodata['autorefresh'] = '1'
+        else:
+            repodata['autorefresh'] = '0'


module.params always contains all possible module options, so 'xxx' in module.params will always evaluate to True (if xxx is a valid module option). Also these three options have defaults, so even if the user did not provide them, they will always be set to their default value in module.params.

If you want to test whether the values have been provided by the user or not, you need to remove the defaults, and check for None instead (like if module.params['autorefresh'] is not None:).

Interesting. I thought, I had tested it locally and adding the condition works. I'll give this another try and I'll also try to add some tests

On the other hand I think this might break the logic where the plugin compares the configuration passed via module.params against what is found on the file system - not passing a value might result in the code detecting a change in configuration....

Also: is this the default behaviour in ansible-modules: not passing a parameter that has a default configured will change an existing configuration that was configured against the default value? That's something, I wouldn't expect

Also: is this the default behaviour in ansible-modules: not passing a parameter that has a default configured will change an existing configuration that was configured against the default value? That's something, I wouldn't expect

That depends on whether options have a default value or not. Having a default for options that are used for idempotency checks have this side-effect, which is usually not what the user wants. That's why it's best to only have default values for options that are not used for idempotency check, but never have defaults for options that are used for idempotency checks. (Unless there are very good reasons for a specific option; which can happen, but is not very likely.)

To fix this, it's usually best to remove the default values, and change the code so that if the user does not provide the option, the old default value is used when something is created.

Also please note that you are changing the behavior of the module, as I understand it, which is a breaking change. You need to control the behavior by a new option so that existing tasks will behave exactly as before.

module.params always contains all possible module options, so 'xxx' in module.params will always evaluate to True (if xxx is a valid module option). Also these three options have defaults, so even if the user did not provide them, they will always be set to their default value in module.params.

I beg to differ, @felixfontein . If the value of the parameter is None, then that stmt is equivalent to if None:, which evaluates to False. He's not checking whether the parameter exists, he is using the parameter value, and None is... False-ish.

The statement if 'xxx' in module.params: is not equivalent to if None if module.params['xxx'] is None.

You're right of course. I was mislead by the fact that the lines of code selected for this comment do not include that part. Re-reading I see I missed some bits, and I have even submitted a suggestion fixing that up.

changelogs/fragments/8783-preserve-parameters-provided-from-task-in-zypper-module.yaml

I think, this is the right approach: # fill the boolean entries with default # override the values with what is found in the repo-file (remote or locally on the file) # finally override the values with what is provided in the module-params then we can check if the data has changed compared to the local data

I had copied and edited the data but not saved the changes

adding tests: * modifying a repository should work (disabling) * modifying a different parameter doesn't change configuation that was not specified - although it has a different default-value, than what is currenctly configured

felixfontein · 2024-11-30T14:06:01Z

changelogs/fragments/8783-preserve-parameters-provided-from-task-in-zypper-module.yaml

@@ -0,0 +1,2 @@
+bugfixes:
+  - zypper-module - only read attributes ``enabled``, ``disable_gpg_check`` and ``autorefresh`` from local repo files, if the parameters weren't already provided by the task parameters


Suggested change

- zypper-module - only read attributes ``enabled``, ``disable_gpg_check`` and ``autorefresh`` from local repo files, if the parameters weren't already provided by the task parameters

- zypper-module - only read attributes ``enabled``, ``disable_gpg_check`` and ``autorefresh`` from local repo files, if the parameters were not already provided by the task parameters (https://github.com/ansible-collections/community.general/pull/9108).

Hi @TobiasZeuch181 please add this modification as well.

felixfontein · 2024-11-30T14:12:53Z

plugins/modules/zypper_repository.py

+        if module.params['autorefresh']:
+            repodata['autorefresh'] = '1'
+        else:
+            repodata['autorefresh'] = '0'


Also: is this the default behaviour in ansible-modules: not passing a parameter that has a default configured will change an existing configuration that was configured against the default value? That's something, I wouldn't expect

That depends on whether options have a default value or not. Having a default for options that are used for idempotency checks have this side-effect, which is usually not what the user wants. That's why it's best to only have default values for options that are not used for idempotency check, but never have defaults for options that are used for idempotency checks. (Unless there are very good reasons for a specific option; which can happen, but is not very likely.)

To fix this, it's usually best to remove the default values, and change the code so that if the user does not provide the option, the old default value is used when something is created.

Also please note that you are changing the behavior of the module, as I understand it, which is a breaking change. You need to control the behavior by a new option so that existing tasks will behave exactly as before.

plugins/modules/zypper_repository.py

Co-authored-by: Alexei Znamensky <[email protected]>

russoz · 2024-12-06T22:31:45Z

Other than the small detail in the changelog fragment, LGTM

russoz · 2024-12-14T07:20:55Z

plugins/modules/zypper_repository.py

+    if 'enabled' in module.params:
+        if module.params['enabled']:
+            repodata['enabled'] = '1'
+        else:
+            repodata['enabled'] = '0'
+    if 'disable_gpg_check' in module.params:
+        if module.params['disable_gpg_check']:
+            repodata['gpgcheck'] = '0'
+        else:
+            repodata['gpgcheck'] = '1'
+    if 'autorefresh' in module.params:
+        if module.params['autorefresh']:
+            repodata['autorefresh'] = '1'
+        else:
+            repodata['autorefresh'] = '0'


This check if the key exists, however, is redundant. They will always exist. Please simplify this to:

Suggested change

if 'enabled' in module.params:

if module.params['enabled']:

repodata['enabled'] = '1'

else:

repodata['enabled'] = '0'

if 'disable_gpg_check' in module.params:

if module.params['disable_gpg_check']:

repodata['gpgcheck'] = '0'

else:

repodata['gpgcheck'] = '1'

if 'autorefresh' in module.params:

if module.params['autorefresh']:

repodata['autorefresh'] = '1'

else:

repodata['autorefresh'] = '0'

repodata['enabled'] = '1' if module.params['enabled'] else '0'

repodata['gpgcheck'] = '0' if module.params['disable_gpg_check'] else '1'

repodata['autorefresh'] = '1' if module.params['autorefresh'] else '0'

TobiasZeuch181 added 2 commits November 8, 2024 12:19

Adding code to set default values

ba8eca9

if the values are not provided from the task-input nor read from an existing file

ansibullbot added bug This issue/PR relates to a bug module module plugins plugin (any type) labels Nov 8, 2024

felixfontein changed the title ~~Preserve attributes enabled, autorefresh and gpgcheck if provided from the…~~ zypper_repository: preserve attributes enabled, autorefresh and gpgcheck if provided from the task parameters Nov 8, 2024

felixfontein added check-before-release PR will be looked at again shortly before release and merged if possible. backport-9 Automatically create a backport for the stable-9 branch backport-10 Automatically create a backport for the stable-10 branch labels Nov 8, 2024

felixfontein reviewed Nov 10, 2024

View reviewed changes

ansibullbot added the stale_ci CI is older than 7 days, rerun before merging label Nov 18, 2024

TobiasZeuch181 added 2 commits November 29, 2024 14:35

Updating the content of the changelog file

71df6f4

I had copied and edited the data but not saved the changes

Adding tests for modifying the repository

b5431b4

adding tests: * modifying a repository should work (disabling) * modifying a different parameter doesn't change configuation that was not specified - although it has a different default-value, than what is currenctly configured

felixfontein reviewed Nov 30, 2024

View reviewed changes

russoz reviewed Dec 5, 2024

View reviewed changes

plugins/modules/zypper_repository.py Outdated Show resolved Hide resolved

Remove extra line that breaks the PEP8 sanity check

2635f51

Co-authored-by: Alexei Znamensky <[email protected]>

ansibullbot removed needs_ci This PR requires CI testing to be performed. Please close and re-open this PR to trigger CI needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR labels Dec 5, 2024

ansibullbot added the stale_ci CI is older than 7 days, rerun before merging label Dec 14, 2024

russoz reviewed Dec 14, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

zypper_repository: preserve attributes enabled, autorefresh and gpgcheck if provided from the task parameters #9108

zypper_repository: preserve attributes enabled, autorefresh and gpgcheck if provided from the task parameters #9108

TobiasZeuch181 commented Nov 8, 2024

ansibullbot commented Nov 8, 2024

felixfontein left a comment

felixfontein Nov 10, 2024

TobiasZeuch181 Nov 29, 2024

TobiasZeuch181 Nov 29, 2024

felixfontein Nov 30, 2024

russoz Dec 14, 2024

felixfontein Dec 14, 2024

russoz Dec 15, 2024

felixfontein Nov 30, 2024

russoz Dec 6, 2024

felixfontein Nov 30, 2024

russoz commented Dec 6, 2024

russoz Dec 14, 2024

		@@ -0,0 +1,2 @@
		bugfixes:
		- zypper-module - only read attributes ``enabled``, ``disable_gpg_check`` and ``autorefresh`` from local repo files, if the parameters weren't already provided by the task parameters

zypper_repository: preserve attributes enabled, autorefresh and gpgcheck if provided from the task parameters #9108

Are you sure you want to change the base?

zypper_repository: preserve attributes enabled, autorefresh and gpgcheck if provided from the task parameters #9108

Conversation

TobiasZeuch181 commented Nov 8, 2024

SUMMARY

ISSUE TYPE

COMPONENT NAME

ADDITIONAL INFORMATION

ansibullbot commented Nov 8, 2024

felixfontein left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

russoz commented Dec 6, 2024

Choose a reason for hiding this comment