Jan Høydahl created SOLR-18514:
----------------------------------
Summary: Port HealthcheckTool to PicoCli
Key: SOLR-18514
URL: https://issues.apache.org/jira/browse/SOLR-18514
Project: Solr
Issue Type: Improvement
Components: cli
Reporter: Jan Høydahl
Port {{HealthcheckTool}} to picocli, adding the picocli code path alongside the
existing commons-cli one.
*Covers:* {{bin/solr healthcheck}}
The command reports the health of the collection named by {{\-c}} /
{{\-\-name}} and has no sub-commands, so its option surface is essentially the
shared connection and credential mixins. Note that it currently requires
SolrCloud mode and exits 1 otherwise; preserve that.
The ref guide gained a dedicated healthcheck page in SOLR-18417 — keep the
generated CLI page consistent with it.
*Acceptance criteria*
* {{bin/solr healthcheck}} and all its options work with {{SOLR_PICOCLI=true}},
and the commons-cli path is left behaviourally unchanged.
* {{HealthcheckTool}} is registered in {{SolrCLI}}'s picocli {{subcommands}}
list and {{ToolBase.callTool()}} is implemented, replacing the
{{UnsupportedOperationException}} stub.
* Shared options reuse the existing mixins ({{ConnectionOptions}},
{{CredentialsOptions}}, {{HelpMixin}}) rather than redeclaring them.
* An {{HealthcheckToolPicocliTest}} subclasses the existing test and overrides
only the {{runTool}} hook, so the inherited assertions run through both parsers.
* {{./gradlew :solr:solr-ref-guide:generateCliDocs}} is re-run and the
generated {{cli/solr-healthcheck.adoc}} page is committed, so
{{checkCliDocsUpToDate}} passes.
*AI assistance:* a coding-agent prompt template encoding the patterns already
established by the ported tools is available at
[https://gist.github.com/janhoy/a3fe0dbcaadf24b3493558946cc549d9] — name
{{HealthcheckTool}} in its Assignment line up front and the rest of the prompt
adapts. Please review agent output as carefully as hand-written code.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
