[PR #9555/e2d19a96 backport][stable-10] Add cpanm option --with-recom…

…mends (#9574) Add cpanm option --with-recommends (#9555) * Add cpanm option --with-recommands Fix #9554 * With accepted suggestions * Use install_recommendations for cpanm option --with-recommends * Fix typo in changelogs/fragments/9554 recommands -> recommends * Doc for options users have for recommands and suggests dependencies * Add new args to the command runner. * Add test for cpanm --with-recommends (cherry picked from commit e2d19a9) Co-authored-by: Erwan Colin <[email protected]>
ansible-collections · Jan 15, 2025 · 6260d5f · 6260d5f
1 parent 6907ae5
commit 6260d5f
Show file tree

Hide file tree

Showing 3 changed files with 73 additions and 1 deletion.
diff --git a/changelogs/fragments/9554-add-cpanm-option_with-recommends-and-suggests.yml b/changelogs/fragments/9554-add-cpanm-option_with-recommends-and-suggests.yml
@@ -0,0 +1,3 @@
+minor_changes:
+  - cpanm - enable usage of option ``--with-recommends`` (https://github.com/ansible-collections/community.general/issues/9554, https://github.com/ansible-collections/community.general/pull/9555).
+  - cpanm - enable usage of option ``--with-suggests`` (https://github.com/ansible-collections/community.general/pull/9555).
diff --git a/plugins/modules/cpanm.py b/plugins/modules/cpanm.py
@@ -56,6 +56,22 @@
       - Only install dependencies.
     type: bool
     default: false
+  install_recommendations:
+    description:
+      - If V(true), installs dependencies declared as recommends per META spec.
+      - If V(false), it ensures the dependencies declared as recommends are not installed, overriding any decision made earlier in E(PERL_CPANM_OPT).
+      - If parameter is not set, C(cpanm) will use its existing defaults.
+      - When these dependencies fail to install, cpanm continues the installation, since they are just recommendation.
+    type: bool
+    version_added: 10.3.0
+  install_suggestions:
+    description:
+      - If V(true), installs dependencies declared as suggests per META spec.
+      - If V(false), it ensures the dependencies declared as suggests are not installed, overriding any decision made earlier in E(PERL_CPANM_OPT).
+      - If parameter is not set, C(cpanm) will use its existing defaults.
+      - When these dependencies fail to install, cpanm continues the installation, since they are just suggestion.
+    type: bool
+    version_added: 10.3.0
   version:
     description:
       - Version specification for the perl module. When O(mode) is V(new), C(cpanm) version operators are accepted.
@@ -167,6 +183,8 @@ class CPANMinus(ModuleHelper):
             mirror=dict(type='str'),
             mirror_only=dict(type='bool', default=False),
             installdeps=dict(type='bool', default=False),
+            install_recommendations=dict(type='bool'),
+            install_suggestions=dict(type='bool'),
             executable=dict(type='path'),
             mode=dict(type='str', default='new', choices=['compatibility', 'new']),
             name_check=dict(type='str')
@@ -181,6 +199,8 @@ class CPANMinus(ModuleHelper):
         mirror=cmd_runner_fmt.as_opt_val('--mirror'),
         mirror_only=cmd_runner_fmt.as_bool("--mirror-only"),
         installdeps=cmd_runner_fmt.as_bool("--installdeps"),
+        install_recommendations=cmd_runner_fmt.as_bool("--with-recommends", "--without-recommends", ignore_none=True),
+        install_suggestions=cmd_runner_fmt.as_bool("--with-suggests", "--without-suggests", ignore_none=True),
         pkg_spec=cmd_runner_fmt.as_list(),
         cpanm_version=cmd_runner_fmt.as_fixed("--version"),
     )
@@ -254,7 +274,16 @@ def process(rc, out, err):
                 return
             pkg_spec = self.sanitize_pkg_spec_version(v[pkg_param], v.version)
 
-        with self.runner(['notest', 'locallib', 'mirror', 'mirror_only', 'installdeps', 'pkg_spec'], output_process=process) as ctx:
+        with self.runner([
+            'notest',
+            'locallib',
+            'mirror',
+            'mirror_only',
+            'installdeps',
+            'install_recommendations',
+            'install_suggestions',
+            'pkg_spec'
+        ], output_process=process) as ctx:
             self.changed = ctx.run(pkg_spec=pkg_spec)
 
 

diff --git a/tests/unit/plugins/modules/test_cpanm.yaml b/tests/unit/plugins/modules/test_cpanm.yaml
@@ -361,3 +361,43 @@ test_cases:
         cpanm (App::cpanminus) version 1.7047 (/usr/local/bin/cpanm)
         perl version 5.041005 (/usr/local/bin/perl)
       err: ""
+- id: install_dancer_with_recommends
+  input:
+    name: Dancer2
+    install_recommendations: true
+  output:
+    changed: true
+  mocks:
+    run_command:
+    - command: [/testbin/cpanm, --version]
+      environ: *env-def-true
+      rc: 0
+      out: |
+        cpanm (App::cpanminus) version 1.7047 (/usr/local/bin/cpanm)
+        perl version 5.041005 (/usr/local/bin/perl)
+      err: ""
+    - command: [/testbin/cpanm, --with-recommends, Dancer2]
+      environ: *env-def-true
+      rc: 0
+      out: ""
+      err: ""
+- id: install_dancer_with_suggests
+  input:
+    name: Dancer2
+    install_suggestions: true
+  output:
+    changed: true
+  mocks:
+    run_command:
+    - command: [/testbin/cpanm, --version]
+      environ: *env-def-true
+      rc: 0
+      out: |
+        cpanm (App::cpanminus) version 1.7047 (/usr/local/bin/cpanm)
+        perl version 5.041005 (/usr/local/bin/perl)
+      err: ""
+    - command: [/testbin/cpanm, --with-suggests, Dancer2]
+      environ: *env-def-true
+      rc: 0
+      out: ""
+      err: ""