Add option to return an exit-code when occ status signals an update is needed

[leegarrett]

Signed-off-by: Lee Garrett lgarrett@rocketjump.eu

• Resolves: Implement occ status command via return codes  #35704

Summary

This is an improved version of my earlier PR #35830. This is now a parameter to status, so it allows for adding more return codes later, which can then for example be consumed in systemd units, or monitoring checks.

It adds a parameter that can be used in scripts. ./occ status -e returns 0 when operating normally, and 1 if there is maintenance mode, 2 if ./occ upgrade is required.

TODO

• Test coverage?

Checklist

• Code is properly formatted
• Sign-off message is added to all commits
• Tests (unit, integration, api and/or acceptance) are included
• Screenshots before/after for front-end changes
• Documentation (manuals or wiki) has been updated or is not required
• Backports requested where applicable (ex: critical bugfixes)

[nickvergessen]

Otherwise you would need to add a tab on each line

[come-nc]

@leegarrett Code style checker still complains, this time about empty lines and spacing: https://github.com/nextcloud/server/actions/runs/3824719618/jobs/6507559027

Also for the comments I’d prefer if you avoid using #.

[come-nc]

Also last commit is missing signoff and DCO complains: https://github.com/nextcloud/server/pull/35873/checks?check_run_id=10400685089

[leegarrett]

@leegarrett Code style checker still complains, this time about empty lines and spacing: https://github.com/nextcloud/server/actions/runs/3824719618/jobs/6507559027

Also for the comments I’d prefer if you avoid using #.

I've hopefully fixed the issue now. Since the 2nd commit wasn't signed off, I've now just squashed it with the first, removed the extra whitespace, and removed the comments. They didn't add much information, anyway.

[come-nc]

See my question on output, but otherwise looks good, codesniffer and DCO are both happy. Failure in drone is unrelated.

[leegarrett]

Not sure if resolved conversations get notified, so here's a copy/paste of it:

Yes, you don't want output e.g. in ExecCondition for a system service, as this will also be logged in the unit every time and pollutes the logs unnecessarily. We can however add it back conditionally with -v if you see any use of this output.

[nickvergessen]

Not sure if resolved conversations get notified, so here's a copy/paste of it:

They do,

Yes, you don't want output e.g. in ExecCondition for a system service, as this will also be logged in the unit every time and pollutes the logs unnecessarily. We can however add it back conditionally with -v if you see any use of this output.

That makes sense. Will make it so.

[welcome]

Thanks for your first pull request and welcome to the community! Feel free to keep them coming! If you are looking for issues to tackle then have a look at this selection: https://github.com/nextcloud/server/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22

[leegarrett]

Hello, can we also get this backported to v25?

[nickvergessen]

usually we only backport bugfixes, but it's arguable here. I will ask some people

[nickvergessen]

/backport to stable25

[solracsf]

No documentation on this?

[nickvergessen]

Should be added to https://docs.nextcloud.com/server/latest/admin_manual/configuration_server/occ_command.html yes.
@leegarrett could you extend the documentation at https://github.com/nextcloud/documentation/blob/master/admin_manual/configuration_server/occ_command.rst
Otherwise raising an issue in https://github.com/nextcloud/documentation/issues with a link to this PR would be helpful too.

[leegarrett]

FYI, the doc update PR is at nextcloud/documentation#9583

[DaphneMuller]

hello @leegarrett
Thank you so much for your work on this pull request! This ticket seems to still have the tag 'pending documentation'.
Is there any chance you could clarify what documentation is missing? Is this for admins or for app developers?

[nickvergessen]

It's linked above nextcloud/documentation#9583