Add cli command to show CMF system-info by paras-negi-flink · Pull Request #3316 · confluentinc/cli

Paras Negi (paras-negi-flink) · 2026-04-11T03:58:16Z

Release Notes

Breaking Changes

None

New Features

Added confluent flink system-info command to display CMF system information (version and revision) in Confluent Platform.

Bug Fixes

None

Checklist

What

This PR implements CF-3139 — Show CMF system information for the Confluent CLI, targeting Confluent Platform / CP Flink (CMF on-prem):

Adds a new command under confluent flink:
- confluent flink system-info
Wires this command to the CMF system information REST API:
- GET /cmf/api/v1/system-information
Adds a CmfRestClient wrapper (GetSystemInformation) and corresponding local types/output formatting (human, json, yaml), following existing patterns used for catalogs, databases, and compute pools.
Hardening (from review feedback):
- Guards against a nil status in the human-output path, so a status-less CMF response fails gracefully instead of panicking.
- Normalizes the CMF base URL (trims a trailing slash) before building the request path, avoiding malformed //cmf/api/... requests.

Blast Radius

Scope is limited to the new confluent flink system-info command; existing CLI behavior is unchanged.
If something goes wrong:
- Impact is confined to users running confluent flink system-info.
- The command may fail or surface CMF errors, or not show the correct version/revision; CMF remains the source of truth.
There are no breaking changes to existing commands, flags, or APIs. Reverting is straightforward (command + client wrapper).

References

Test & Review

Environment

Repo: confluentinc/cli
Branch: CF-3139
CMF: 2.3-SNAPSHOT
Verified via the CLI integration test suite (TestFlinkSystemInfo, run in both on-prem and cloud-logout modes against the CMF test server); make build and go vet are clean.

CLI output (test server returns version 1.0.0, revision abc1234def5678)

Help

% ./confluent flink system-info --help
Display CMF system information.

Usage:
  confluent flink system-info [flags]

Flags:
      --url string                          Base URL of the Confluent Manager for Apache Flink (CMF). Environment variable "CONFLUENT_CMF_URL" may be set in place of this flag.
      --client-key-path string              Path to client private key for mTLS authentication. Environment variable "CONFLUENT_CMF_CLIENT_KEY_PATH" may be set in place of this flag.
      --client-cert-path string             Path to client cert to be verified by Confluent Manager for Apache Flink. Include for mTLS authentication. Environment variable "CONFLUENT_CMF_CLIENT_CERT_PATH" may be set in place of this flag.
      --certificate-authority-path string   Path to a PEM-encoded Certificate Authority to verify the Confluent Manager for Apache Flink connection. Environment variable "CONFLUENT_CMF_CERTIFICATE_AUTHORITY_PATH" may be set in place of this flag.
  -o, --output string                       Specify the output format as "human", "json", or "yaml". (default "human")

Human / JSON / YAML output

% ./confluent flink system-info --url http://localhost:8080
+----------+----------------+
| Version  | 1.0.0          |
| Revision | abc1234def5678 |
+----------+----------------+

% ./confluent flink system-info --url http://localhost:8080 --output json
{
  "status": {
    "version": "1.0.0",
    "revision": "abc1234def5678"
  }
}

% ./confluent flink system-info --url http://localhost:8080 --output yaml
status:
    version: 1.0.0
    revision: abc1234def5678

confluent-cla-assistant · 2026-04-11T03:58:27Z

🎉 All Contributor License Agreements have been signed. Ready to merge.
_{Please push an empty commit if you would like to re-run the checks to verify CLA status for all contributors.}

Copilot

Pull request overview

Adds a new on-prem Flink CLI subcommand to display CMF “system information” (version/revision), backed by a new CMF REST client call and test-server route/fixtures.

Changes:

Introduce flink system-info command with human + JSON/YAML output.
Add CMF client support for /cmf/api/v1/system-information and corresponding test-server handler/route.
Add integration tests and golden fixtures for system-info output and update on-prem flink help output.

Reviewed changes

Copilot reviewed 11 out of 11 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
`internal/flink/command.go`	Registers the new `system-info` subcommand under `flink` (on-prem specific commands).
`internal/flink/command_system_info.go`	Implements `flink system-info` command, parsing and output formatting.
`pkg/flink/cmf_rest_client.go`	Adds `GetSystemInformation` method to call CMF system-information endpoint.
`pkg/flink/test/mock/cmf_client_mock.go`	Updates gomock client interface with `GetSystemInformation`.
`test/test-server/flink_onprem_router.go`	Wires new system-information route into the on-prem test router.
`test/test-server/flink_onprem_handler.go`	Adds handler returning stubbed system info payload for tests.
`test/flink_onprem_test.go`	Adds integration test coverage for `flink system-info` across output formats.
`test/fixtures/output/flink/system-info.golden`	Golden fixture for human/table output.
`test/fixtures/output/flink/system-info-json.golden`	Golden fixture for JSON output.
`test/fixtures/output/flink/system-info-yaml.golden`	Golden fixture for YAML output.
`test/fixtures/output/flink/help-onprem.golden`	Updates on-prem `flink --help` to include `system-info`.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-04-11T04:02:14Z

+		table := output.NewTable(cmd)
+		table.Add(&systemInfoOut{
+			Version:  derefString(sysInfo.Status.Version),
+			Revision: derefString(sysInfo.Status.Revision),


sysInfo.Status can be nil when the CMF response is missing/invalid status, but the human-output branch unconditionally dereferences sysInfo.Status.Version/Revision, which will panic. Guard against sysInfo.Status == nil (or initialize a non-nil status before dereferencing) so the command fails gracefully instead of crashing.

Suggested change

table := output.NewTable(cmd)

table.Add(&systemInfoOut{

Version: derefString(sysInfo.Status.Version),

Revision: derefString(sysInfo.Status.Revision),

status := &localSystemInformationStatus{}

if sysInfo.Status != nil {

status = sysInfo.Status

}

table := output.NewTable(cmd)

table.Add(&systemInfoOut{

Version: derefString(status.Version),

Revision: derefString(status.Revision),

Copilot · 2026-04-11T04:02:15Z

+func (c *command) newSystemInfoCommand() *cobra.Command {
+	cmd := &cobra.Command{
+		Use:         "system-info",
+		Short:       "Display CMF system information.",
+		Args:        cobra.NoArgs,
+		RunE:        c.systemInfo,
+		Annotations: map[string]string{pcmd.RunRequirement: pcmd.RequireCloudLogout},
+	}
+
+	addCmfFlagSet(cmd)
+	pcmd.AddOutputFlag(cmd)
+
+	return cmd
+}


The recursive help golden tests expect a fixture for the leaf command help output (e.g., test/fixtures/output/flink/system-info-help-onprem.golden). Adding this command without the corresponding help fixture will cause TestHelp to fail for the on-prem configuration.

Copilot · 2026-04-11T04:02:15Z

 }

+func (cmfClient *CmfRestClient) GetSystemInformation(ctx context.Context) (map[string]interface{}, error) {
+	baseURL := cmfClient.GetConfig().Servers[0].URL


Building the request URL via string concatenation can produce an invalid path when the configured base URL ends with / (resulting in //cmf/api/...). Prefer joining/normalizing the base URL (e.g., trimming the trailing slash or using url.JoinPath) to ensure the request is well-formed.

Suggested change

baseURL := cmfClient.GetConfig().Servers[0].URL

baseURL := strings.TrimRight(cmfClient.GetConfig().Servers[0].URL, "/")

- Remove quotes around version in YAML golden (YAML serializer doesn't quote version-like strings) - Reorder help-onprem.golden so system-info sorts after statement (cobra alphabetical ordering) - Add missing system-info-help-onprem.golden for auto-generated help tests Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

sonarqube-confluent · 2026-04-11T05:31:56Z

Quality Gate passed

Issues
1 New issue
0 Fixed issues
0 Accepted issues

Measures
0 Security Hotspots
81.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

Avoid a nil-pointer panic in human output when the CMF response has no status, and trim a trailing slash from the base URL before building the system-information request path. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

sonarqube-confluent · 2026-06-23T19:36:36Z

Quality Gate passed

Issues
1 New issue
0 Fixed issues
0 Accepted issues

Measures
0 Security Hotspots
80.3% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube

Add cli command to show CMF system-info

1b8e2cf

Copilot AI review requested due to automatic review settings April 11, 2026 03:58

Copilot started reviewing on behalf of Paras Negi (paras-negi-flink) April 11, 2026 03:58 View session

Copilot AI reviewed Apr 11, 2026

View reviewed changes

Paras Negi (paras-negi-flink) and others added 2 commits June 24, 2026 00:36

Merge remote-tracking branch 'origin/main' into CF-3139

8648c79

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

Paras Negi (paras-negi-flink) marked this pull request as ready for review June 23, 2026 19:14

Paras Negi (paras-negi-flink) requested a review from a team as a code owner June 23, 2026 19:14

Steven Gagniere (sgagniere) approved these changes Jun 26, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add cli command to show CMF system-info#3316

Add cli command to show CMF system-info#3316
Paras Negi (paras-negi-flink) wants to merge 4 commits into
mainfrom
CF-3139

Paras Negi (paras-negi-flink) commented Apr 11, 2026 •

edited

Loading

Uh oh!

confluent-cla-assistant Bot commented Apr 11, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Apr 11, 2026

Uh oh!

Paras Negi (paras-negi-flink) Jun 24, 2026

Uh oh!

Copilot AI Apr 11, 2026

Uh oh!

Copilot AI Apr 11, 2026

Uh oh!

Paras Negi (paras-negi-flink) Jun 24, 2026

Uh oh!

sonarqube-confluent Bot commented Apr 11, 2026

Uh oh!

sonarqube-confluent Bot commented Jun 23, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	baseURL := cmfClient.GetConfig().Servers[0].URL
	baseURL := strings.TrimRight(cmfClient.GetConfig().Servers[0].URL, "/")

Uh oh!

Conversation

Paras Negi (paras-negi-flink) commented Apr 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Release Notes

Checklist

What

Blast Radius

References

Test & Review

Uh oh!

confluent-cla-assistant Bot commented Apr 11, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Apr 11, 2026

Choose a reason for hiding this comment

Uh oh!

Paras Negi (paras-negi-flink) Jun 24, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 11, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 11, 2026

Choose a reason for hiding this comment

Uh oh!

Paras Negi (paras-negi-flink) Jun 24, 2026

Choose a reason for hiding this comment

Uh oh!

sonarqube-confluent Bot commented Apr 11, 2026

Quality Gate passed

Uh oh!

sonarqube-confluent Bot commented Jun 23, 2026

Quality Gate passed

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Paras Negi (paras-negi-flink) commented Apr 11, 2026 •

edited

Loading