Skip to content

feat: Run setup checks by category or class#49978

Merged
artonge merged 2 commits into
masterfrom
jtr-feat-setupchecks-limit-type
Jun 11, 2026
Merged

feat: Run setup checks by category or class#49978
artonge merged 2 commits into
masterfrom
jtr-feat-setupchecks-limit-type

Conversation

@joshtrichards

Copy link
Copy Markdown
Member

Summary

This PR adds the ability to run:

  • a specific category of setup checks
  • an individual check

Implementation:

  • Existing setup check category names are used for running checks in a specific category (e.g. network)
  • Existing class names are used for running individual checks
  • All checks still run otherwise by default so not a breaking change in behavior

Examples:

Run all checks in a specific category - e.g. the network related tests:

./occ setupchecks network

RESULT:

www-data@83e3407f887c:~/html$ ./occ setupchecks network
	network:
		✓ WebDAV endpoint: Your web server is properly set up to allow file synchronization over WebDAV.
		✓ Data directory protected
		✓ Internet connectivity
		✓ JavaScript source map support
		✓ JavaScript modules support
		✓ OCS provider resolving
		✓ .well-known URLs: Your server is correctly configured to serve `.well-known` URLs.
		✓ Font file loading
www-data@83e3407f887c:~/html$ 

Run a specific individual check - e.g. the InternetConnectivity test:

./occ setupcheck OCA\\Settings\\SetupChecks\\InternetConnectivity

RESULT:

www-data@83e3407f887c:~/html$ ./occ setupcheck OCA\\Settings\\SetupChecks\\InternetConnectivity
	network:
		✓ Internet connectivity
www-data@83e3407f887c:~/html$ 

If an unrecognized category / class is specified inform the user:

www-data@83e3407f887c:~/html$ ./occ setupchecks xxx    
Invalid type specified (or no results for that type)
www-data@83e3407f887c:~/html$ 

TODO

Checklist

@joshtrichards joshtrichards added this to the Nextcloud 31 milestone Dec 27, 2024
@joshtrichards joshtrichards requested review from a team, artonge, come-nc and yemkareems and removed request for a team December 27, 2024 17:49
@joshtrichards joshtrichards force-pushed the jtr-feat-setupchecks-limit-type branch from 63f03c8 to 6221951 Compare December 28, 2024 16:57

@come-nc come-nc left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@blizzz blizzz mentioned this pull request Jan 8, 2025
This was referenced Jan 14, 2025
@Altahrim Altahrim mentioned this pull request Jan 21, 2025
Comment thread core/Command/SetupChecks.php Outdated
Comment thread core/Command/SetupChecks.php Outdated
@Altahrim Altahrim mentioned this pull request Jan 23, 2025
@blizzz blizzz mentioned this pull request Jan 29, 2025
1 task
@blizzz blizzz modified the milestones: Nextcloud 31, Nextcloud 32 Jan 29, 2025
This was referenced Aug 22, 2025
This was referenced Sep 2, 2025
@blizzz blizzz modified the milestones: Nextcloud 33, Nextcloud 34 Feb 16, 2026
@DorraJaouad DorraJaouad requested a review from a team as a code owner April 23, 2026 09:41
@DorraJaouad DorraJaouad requested review from Altahrim, ArtificialOwl, CarlSchwan and icewind1991 and removed request for a team and yemkareems April 23, 2026 09:41
This was referenced Jun 5, 2026
@susnux susnux added the community pull requests from community label Jun 9, 2026
@susnux susnux removed this from the Nextcloud 34.0.1 milestone Jun 9, 2026
@susnux susnux force-pushed the jtr-feat-setupchecks-limit-type branch from 6221951 to 5322c99 Compare June 11, 2026 10:24
Signed-off-by: Josh <josh.t.richards@gmail.com>
Signed-off-by: Josh <josh.t.richards@gmail.com>
@susnux susnux force-pushed the jtr-feat-setupchecks-limit-type branch from 5322c99 to 69e3b94 Compare June 11, 2026 10:24
@joshtrichards joshtrichards added this to the Nextcloud 35 milestone Jun 11, 2026
@artonge artonge merged commit 97df391 into master Jun 11, 2026
156 of 169 checks passed
@artonge artonge deleted the jtr-feat-setupchecks-limit-type branch June 11, 2026 14:58
susnux added a commit to nextcloud/documentation that referenced this pull request Jun 11, 2026
susnux added a commit to nextcloud/documentation that referenced this pull request Jun 12, 2026
- for nextcloud/server#49978

Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants