Apache2 module workaround for Shibboleth needs updating

[peter-]

SUMMARY

The workaround for Shibboleth previously added in #20341 no longer works (on Debian 10) since the module name has meanwhile been changed from shib2 (for which a workaround currently exists) to shib (to account for the increasingly unfortunate naming shib2 when the software currently has a major version of 3) which is not covered by the workaround.

Since upstream is unable to change the module identifer (easily, without causing breakage) the obvious and simple fix would be to amend the existing workaround to also match the current (and likely to remain that way in the future) module name, taking into account that different versions of the module may be in use:

# web_infrastructure/apache2_module.py
    # a2enmod name replacement to apache2ctl -M names
    text_workarounds = [
-       ('shib2', 'mod_shib'),
+       ('shib', 'mod_shib'),
+       ('shib2', 'mod_shib'),
        ('evasive', 'evasive20_module'),
    ]

Once (if ever) the module identifier changes upstream to match the Apache httpd convension the workaround can be removed.

ISSUE TYPE

• Bug Report

COMPONENT NAME

apache2_module

ANSIBLE VERSION

Current main branch.

STEPS TO REPRODUCE

See #20288, i.e., the behaviour matches the pre-workaround one exactly since the module name is no longer matched.
Ansible again fails with "Maybe the module identifier (shib) was guessed incorrectly":

failed: [filesender.lab.aco.net] (item=shib) => changed=false 
  ansible_loop_var: item
  item: shib
  msg: |-
    Failed to set module   shib
     to enabled:
    Module shib already enabled
  
    Maybe the module identifier (shib) was guessed incorrectly.Consider setting the "identifier" option.
  rc: 0
  stderr: ''
  stderr_lines: <omitted>
  stdout: |-
    Module shib already enabled
  stdout_lines: <omitted>

[ansibullbot]

Files identified in the description:

• plugins/modules/web_infrastructure/apache2_module.py

If these files are inaccurate, please update the component name section of the description or use the !component bot command.

click here for bot help

[ansibullbot]

cc @berendt @n0trax @nerzhul @robinro
click here for bot help

[felixfontein]

Feel free to create a PR. (If you do, please include a changelog fragment.)

[peter-]

Feel free to create a PR. (If you do, please include a changelog fragment.)

@felixfontein: Btw, how would I create a changelog fragment named after the PR number ("To create a changelog entry, create a new file with a unique name in the changelogs/fragments/ directory of the corresponding repository. The file name should include the PR number") when I add and commit the fragment file before ever creating the PR and hence don't know the PR number at the time I commit the changes? Create file with bogus name, commit, create PR with bogus file name, git rename file based on assignd PR number, push changes to feature branch, possibly forcing push? All that for a single line PR?

[felixfontein]

@peter- you could just create the PR without the fragment, and then add another commit with the fragment.

[thizmo]

Good morning,

i happen to have the problem still with ansible 2.9.27 on Ubuntu 20.04.LTS

When i add the fix manually to the module, the problem is fixed.

Thx.

[felixfontein]

@thizmo are you using the modules from the community.general collection (which have been fixed a long time ago), or are you the modules included in Ansible 2.9 (which have not been fixed and will never get fixed)?