fix(cmd/main.py): use correct return value

[sshedi]

Proposed Commit Message

fix(cmd/main.py): use correct return value

Additional Context

$ cloud-init -d modules -m init
Above command returns non zero exit status

Test Steps

root@ph4dev [ ~/cloud-init ]# cloud-init -d modules -m init
2024-02-22 19:10:07,659 - handlers.py[DEBUG]: start: modules-init: running modules for init
2024-02-22 19:10:07,659 - util.py[DEBUG]: Reading from /proc/uptime (quiet=False)
...
Cloud-init v. 23.4 running 'modules:init' at Thu, 22 Feb 2024 19:10:07 +0000. Up 26599.38 seconds.
[]

root@ph4dev [ ~/cloud-init ]# echo $?
1

Checklist

• My code follows the process laid out in the documentation
• [] I have updated or added any unit tests accordingly
• I have updated or added any documentation accordingly

Merge type

• Squash merge using "Proposed Commit Message"
• Rebase and merge unique commits. Requires commit messages per-commit each referencing the pull request number (#<PR_NUM>)

[sshedi]

I'm not sure how to add a test for this. Any inputs on the same would be helpful. Thanks.

[a-dubs]

What is the purpose of this change? The new code is functionally identical to the code it replaces.

[sshedi]

errors can be an integer value here, not always a list.

[sshedi]

Indeed there was in issue in the code change, fixed it. Thanks.

[a-dubs]

Also, could you please modify your proposed commit message section so that your commit message appears as a code block like the following:

fix(cmd/main.py): use correct return value

And could you move the

$ cloud-init -d modules -m init
Above command returns non zero exit status

information in the PR description to the Additional Context section and add some more context for why this change is needed and what the change is seeking to accomplish?

Thanks!

[holmanb]

@sshedi Do you use this for something? This doesn't normally run during boot, so I'm curious what you use it for.

[sshedi]

@sshedi Do you use this for something? This doesn't normally run during boot, so I'm curious what you use it for.

In one of our CI/CD pipelines, I tried adding:

echo -e "\nRun cloud-init with all configured modules"
for m in init config final; do
  cmd="cloud-init --file user-data -d modules --mode $m"
  if $cmd; then
    echo -e "\nPASS: $cmd"
  else
    echo -e "\nFAIL: $cmd" 1>&2
  fi
done

And caught this issue. Nothing major, but I think the return value should be appropriate.

[sshedi]

Also, could you please modify your proposed commit message section so that your commit message appears as a code block like the following:

fix(cmd/main.py): use correct return value

And could you move the

$ cloud-init -d modules -m init
Above command returns non zero exit status

information in the PR description to the Additional Context section and add some more context for why this change is needed and what the change is seeking to accomplish?

Thanks!

Thanks for the input and suggestions. Previously while raising PRs, this section was simple. I feel it's a bit complex now.
I understand the intent behind this but writing good commit message is already a hard task and filling this template is a bit confusing.

I will try.

[aciba90]

Thanks, @sshedi, for raising this issue and proposing a fix. I am closing this one in favor of #5017, which includes a correct fix and integration tests. I hope that's okay from your side.

[sshedi]

Thanks, @sshedi, for raising this issue and proposing a fix. I am closing this one in favor of #5017, which includes a correct fix and integration tests. I hope that's okay from your side.

No problem. Thanks for fixing it.