CF-3930 : Return structured savepoint schema from create -o json/yaml to match describe/list#3396
Open
Paras Negi (paras-negi-flink) wants to merge 2 commits into
Open
Conversation
… to match describe/list
|
🎉 All Contributor License Agreements have been signed. Ready to merge. |
Copilot started reviewing on behalf of
Paras Negi (paras-negi-flink)
July 5, 2026 21:26
View session
There was a problem hiding this comment.
Pull request overview
Aligns CMF (on-prem) Flink savepoint create commands’ serialized (-o json|yaml) output with the structured resource schema used by related commands, improving schema consistency for automation.
Changes:
- Updated
flink savepoint createandflink detached-savepoint createto print human/table output only for--output human, and otherwise serialize the structuredLocalSavepointshape. - Added integration test cases for
savepoint createanddetached-savepoint createwith--output json|yaml. - Added new golden fixtures for the new serialized outputs.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
internal/flink/command_savepoint_create.go |
Branches output by format; uses structured LocalSavepoint for serialized output. |
internal/flink/command_detached_savepoint_create.go |
Branches output by format; uses structured LocalSavepoint for serialized output. |
test/flink_onprem_test.go |
Adds --output json/--output yaml integration cases for both create commands. |
test/fixtures/output/flink/savepoint/create-savepoint-json.golden |
New expected JSON output for savepoint create. |
test/fixtures/output/flink/savepoint/create-savepoint-yaml.golden |
New expected YAML output for savepoint create. |
test/fixtures/output/flink/detached-savepoint/create-savepoint-json.golden |
New expected JSON output for detached-savepoint create. |
test/fixtures/output/flink/detached-savepoint/create-savepoint-yaml.golden |
New expected YAML output for detached-savepoint create. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+131
to
+132
| localSavepoint := convertSdkSavepointToLocalSavepoint(savepointCreated) | ||
| return output.SerializedOutput(cmd, localSavepoint) |
Contributor
There was a problem hiding this comment.
Can you please check if the nil check can be handled elegantly using the SDK in some way.
Comment on lines
133
to
140
| func (s *CLITestSuite) TestFlinkSavepointCreate() { | ||
| tests := []CLITest{ | ||
| {args: "flink savepoint create savepoint1 --environment default --application application1", fixture: "flink/savepoint/create-savepoint.golden"}, | ||
| {args: "flink savepoint create savepoint1 --environment default --application application1 --output json", fixture: "flink/savepoint/create-savepoint-json.golden"}, | ||
| {args: "flink savepoint create savepoint1 --environment default --application application1 --output yaml", fixture: "flink/savepoint/create-savepoint-yaml.golden"}, | ||
| {args: "flink savepoint create --environment default --application application2", fixture: "flink/savepoint/create-savepoint-no-name.golden"}, | ||
| {args: "flink savepoint create savepointS --environment default --statement test-stmt", fixture: "flink/savepoint/create-savepoint-statement.golden"}, | ||
| {args: "flink savepoint create savepointS --environment default --statement test-stmt --path abc/def --format NATIVE --backoff-limit 10", fixture: "flink/savepoint/create-savepoint-statement-values.golden"}, |
Contributor
There was a problem hiding this comment.
Can you check if making additional --output yaml makes sense here?
Contributor
Author
Manual CLI validationLocal CMF ( Before — released
|
…ized create tests
|
Paras Negi (paras-negi-flink)
marked this pull request as ready for review
July 7, 2026 06:06
| Kind: sdkSavepoint.Kind, | ||
| Metadata: LocalSavepointMetadata{ | ||
| Name: *sdkSavepoint.Metadata.Name, | ||
| Name: sdkSavepoint.Metadata.GetName(), |
Contributor
There was a problem hiding this comment.
Why not:
CreationTimestamp: sdkSavepoint.Metadata.GetCreationTimestamp() for the line below and similar fields?
The idea is try to be consistent across the table everywhere.
| Kind: sdkSavepoint.Kind, | ||
| Metadata: LocalSavepointMetadata{ | ||
| Name: *sdkSavepoint.Metadata.Name, | ||
| Name: sdkSavepoint.Metadata.GetName(), |
Contributor
There was a problem hiding this comment.
Please check the above comment and see if we can apply the same idea here.
Comment on lines
+131
to
+132
| localSavepoint := convertSdkSavepointToLocalSavepoint(savepointCreated) | ||
| return output.SerializedOutput(cmd, localSavepoint) |
Contributor
There was a problem hiding this comment.
Can you please check if the nil check can be handled elegantly using the SDK in some way.
| {args: "flink savepoint create --environment default --application application2", fixture: "flink/savepoint/create-savepoint-no-name.golden"}, | ||
| {args: "flink savepoint create --environment default --application application2 --output json", fixture: "flink/savepoint/create-savepoint-no-name-json.golden"}, | ||
| {args: "flink savepoint create savepointS --environment default --statement test-stmt", fixture: "flink/savepoint/create-savepoint-statement.golden"}, | ||
| {args: "flink savepoint create savepointS --environment default --statement test-stmt --output json", fixture: "flink/savepoint/create-savepoint-statement-json.golden"}, |
Contributor
There was a problem hiding this comment.
Is the optional savepoint name savepointS a typo?
Comment on lines
133
to
140
| func (s *CLITestSuite) TestFlinkSavepointCreate() { | ||
| tests := []CLITest{ | ||
| {args: "flink savepoint create savepoint1 --environment default --application application1", fixture: "flink/savepoint/create-savepoint.golden"}, | ||
| {args: "flink savepoint create savepoint1 --environment default --application application1 --output json", fixture: "flink/savepoint/create-savepoint-json.golden"}, | ||
| {args: "flink savepoint create savepoint1 --environment default --application application1 --output yaml", fixture: "flink/savepoint/create-savepoint-yaml.golden"}, | ||
| {args: "flink savepoint create --environment default --application application2", fixture: "flink/savepoint/create-savepoint-no-name.golden"}, | ||
| {args: "flink savepoint create savepointS --environment default --statement test-stmt", fixture: "flink/savepoint/create-savepoint-statement.golden"}, | ||
| {args: "flink savepoint create savepointS --environment default --statement test-stmt --path abc/def --format NATIVE --backoff-limit 10", fixture: "flink/savepoint/create-savepoint-statement-values.golden"}, |
Contributor
There was a problem hiding this comment.
Can you check if making additional --output yaml makes sense here?
Contributor
|
Do we want to update the detach operation as well? |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Release Notes
Breaking Changes
New Features
Bug Fixes
confluent flink savepoint createanddetached-savepoint createnow return the same structured JSON/YAML schema (apiVersion/kind/metadata/spec/status) asdescribe/list, instead of a flat snake_case shape.Checklist
Whatsection below whether this PR applies to Confluent Cloud, Confluent Platform, or both.Test & Reviewsection below.Blast Radiussection below.What
Confluent Platform (CP Flink / CMF on-prem).
savepoint/detached-savepoint createalways rendered the flat snake_case struct and ignored-o, whiledescribe/listemit the structuredapiVersion/kind/metadata/spec/statusshape -- same resource, two schemas.createnow branches on output format likedescribe/list, reusing the existingconvertSdk*ToLocalSavepointconverters. Human/table output is unchanged.Blast Radius
-o json/-o yamloutput of the twocreatecommands changes from flat snake_case to the structured shape; scripts readingbackoff_limit/creation_timestamp/formatmust switch tospec.backoffLimit/metadata.creationTimestamp/spec.formatType.References
Test & Review
Environment: local CMF
cmf-app 2.4-SNAPSHOT(HTTP,--cmf.k8s.enabled=false); CLI built from this branch vs releasedconfluent v4.54.0.Manual CLI validation: attached in the comment below.