[make] Provide built command in the module output #6160

cjeanner · 2023-03-08T09:51:52Z

It may happen operator wants to get the built command instead of all the parameters. This change injects a new entry in the dict output, showing what command way actually launched.

SUMMARY

This change adds a new information to the community.general.make module output: the built command that way
launched by the run_command.

The goal here is to help operator debugging potential issues, or just allow them to store this information in a log, for
instance.

ISSUE TYPE

Feature Pull Request

COMPONENT NAME

make

ADDITIONAL INFORMATION

Before:

ok: [localhost] => {
    "make_output": {
        "changed": true,
        "chdir": "/tmp/foo",
        "failed": false,
        "file": null,
        "jobs": null,
        "params": null,
        "stderr": "",
        "stderr_lines": [],
        "stdout": "foo\ntouch /tmp/foo.done",
        "stdout_lines": [
            "foo",
            "touch /tmp/foo.done"
        ],
        "target": "test"
    }
}

After:

ok: [localhost] => {
    "make_output": {
        "changed": true,
        "chdir": "/tmp/foo",
        "command": "/usr/bin/gmake test",
        "failed": false,
        "file": null,
        "jobs": null,
        "params": null,
        "stderr": "",
        "stderr_lines": [],
        "stdout": "foo\ntouch /tmp/foo.done",
        "stdout_lines": [
            "foo",
            "touch /tmp/foo.done"
        ],
        "target": "test"
    }
}

ansibullbot · 2023-03-08T09:56:19Z

cc @LinusU
click here for bot help

cjeanner · 2023-03-08T10:11:30Z

/hold

We may want to wait for #6161 first. I'll rebase and add the appropriate doc entry.

changelogs/fragments/6160-add-command-make-output.yml

plugins/modules/make.py

cjeanner · 2023-03-08T13:20:00Z

Doc patch merged, this one is now rebased against main, and integrates the asked modifications. We can therefore continue with reviews here, should be ready.

github-actions · 2023-03-08T13:33:49Z

Docs Build 📝

Thank you for contribution!✨

This PR has been merged and your docs changes will be incorporated when they are next published.

The action plugin will make the whole thing faster. It requires a tiny change to the community.general.make module[1]. [1] ansible-collections/community.general#6160

felixfontein

Besides this, looks good to me.

plugins/modules/make.py

Replacing a whole role by a single action plugin allows a faster run, while reducing drastically the amount of tasks. Note that this action plugin requires a small change to the community.general.make module[1] - it should be merged in the following hours/days. [1] ansible-collections/community.general#6160

plugins/modules/make.py

It may happen operator wants to get the built command instead of all the parameters. This change injects a new entry in the dict output, showing what command way actually launched. This patch also takes the opportunity to add missing dots to some documentation lines.

Replacing a whole role by a single action plugin allows a faster run, while reducing drastically the amount of tasks. Note that this action plugin requires a small change to the community.general.make module[1] - it should be merged in the following hours/days. [1] ansible-collections/community.general#6160

felixfontein

Looks good to me. If nobody objects. I'll merge this beginning of next week.

Replacing a whole role by a single action plugin allows a faster run, while reducing drastically the amount of tasks. Note that this action plugin requires a small change to the community.general.make module[1] - it should be merged in the following hours/days. [1] ansible-collections/community.general#6160

patchback · 2023-03-14T19:44:12Z

Backport to stable-6: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-6/a49ad340af86680440ec502af65f667e8bbb6ff9/pr-6160

Backported as #6186

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

It may happen operator wants to get the built command instead of all the parameters. This change injects a new entry in the dict output, showing what command way actually launched. This patch also takes the opportunity to add missing dots to some documentation lines. (cherry picked from commit a49ad34)

felixfontein · 2023-03-14T19:44:24Z

@cjeanner thanks for your contribution!

…n the module output (#6186) [make] Provide built command in the module output (#6160) It may happen operator wants to get the built command instead of all the parameters. This change injects a new entry in the dict output, showing what command way actually launched. This patch also takes the opportunity to add missing dots to some documentation lines. (cherry picked from commit a49ad34) Co-authored-by: Cédric Jeanneret <39397510+cjeanner@users.noreply.github.com>

Replacing a whole role by a single action plugin allows a faster run, while reducing drastically the amount of tasks. Note that this action plugin requires a small change to the community.general.make module[1] - it should be merged in the following hours/days. [1] ansible-collections/community.general#6160

Replacing a whole role by a single action plugin allows a faster run, while reducing drastically the amount of tasks. We also expose the "plugins" directory at the root of the repository for an easier consumption. Note that this action plugin requires a small change to the community.general.make module[1] - it should be merged in the following hours/days. [1] ansible-collections/community.general#6160

Replacing a whole role by a single action plugin allows a faster run, while reducing drastically the amount of tasks. We also expose the "plugins" directory at the root of the repository for an easier consumption. You want to ensure you're using latest community.general ansible collection, in order to get the new "command" output value[1]. [1] ansible-collections/community.general#6160

cjeanner force-pushed the make/command branch from 38fd72e to 1fe0b10 Compare March 8, 2023 09:53

ansibullbot added feature This issue/PR relates to a feature request module module new_contributor Help guide this first time contributor plugins plugin (any type) system labels Mar 8, 2023

felixfontein reviewed Mar 8, 2023

View reviewed changes

changelogs/fragments/6160-add-command-make-output.yml Outdated Show resolved Hide resolved

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

cjeanner force-pushed the make/command branch from 1fe0b10 to 73dc8bb Compare March 8, 2023 13:18

ansibullbot removed the new_contributor Help guide this first time contributor label Mar 8, 2023

cjeanner requested a review from felixfontein March 8, 2023 15:58

felixfontein added check-before-release PR will be looked at again shortly before release and merged if possible. backport-6 labels Mar 8, 2023

felixfontein reviewed Mar 8, 2023

View reviewed changes

plugins/modules/make.py Show resolved Hide resolved

cjeanner force-pushed the make/command branch from 73dc8bb to 87e387b Compare March 9, 2023 07:46

cjeanner requested a review from felixfontein March 9, 2023 07:47

felixfontein reviewed Mar 9, 2023

View reviewed changes

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

cjeanner force-pushed the make/command branch from 87e387b to 99dfe36 Compare March 9, 2023 12:12

cjeanner requested a review from felixfontein March 9, 2023 12:48

cjeanner mentioned this pull request Mar 9, 2023

Ansible/ci make action openstack-k8s-operators/ci-framework#39

Merged

2 tasks

felixfontein approved these changes Mar 9, 2023

View reviewed changes

felixfontein merged commit a49ad34 into ansible-collections:main Mar 14, 2023

felixfontein removed the check-before-release PR will be looked at again shortly before release and merged if possible. label Mar 14, 2023

patchback bot mentioned this pull request Mar 14, 2023

[PR #6160/a49ad340 backport][stable-6] [make] Provide built command in the module output #6186

Merged

cjeanner deleted the make/command branch March 14, 2023 19:54

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[make] Provide built command in the module output #6160

[make] Provide built command in the module output #6160

cjeanner commented Mar 8, 2023

ansibullbot commented Mar 8, 2023

cjeanner commented Mar 8, 2023

cjeanner commented Mar 8, 2023

github-actions bot commented Mar 8, 2023 •

edited

Loading

felixfontein left a comment

felixfontein left a comment

patchback bot commented Mar 14, 2023 •

edited

Loading

felixfontein commented Mar 14, 2023

[make] Provide built command in the module output #6160

[make] Provide built command in the module output #6160

Conversation

cjeanner commented Mar 8, 2023

SUMMARY

ISSUE TYPE

COMPONENT NAME

ADDITIONAL INFORMATION

ansibullbot commented Mar 8, 2023

cjeanner commented Mar 8, 2023

cjeanner commented Mar 8, 2023

github-actions bot commented Mar 8, 2023 • edited Loading

Docs Build 📝

felixfontein left a comment

Choose a reason for hiding this comment

felixfontein left a comment

Choose a reason for hiding this comment

patchback bot commented Mar 14, 2023 • edited Loading

Backport to stable-6: 💚 backport PR created

felixfontein commented Mar 14, 2023

github-actions bot commented Mar 8, 2023 •

edited

Loading

patchback bot commented Mar 14, 2023 •

edited

Loading