catch when there are no changes in revert (#7308)

* catch when there are no changes in revert * added flag to allow empty reverts * pr changes
treeverse · Feb 7, 2024 · eab29ed · eab29ed
1 parent f545705
commit eab29ed
Show file tree

Hide file tree

Showing 21 changed files with 125 additions and 12 deletions.
diff --git a/api/swagger.yml b/api/swagger.yml
@@ -473,6 +473,10 @@ components:
         force:
           type: boolean
           default: false
+        allow_empty:
+          type: boolean
+          default: false
+          description: allow empty commit (revert without changes)
 
     CherryPickCreation:
       type: object

diff --git a/clients/java-legacy/api/openapi.yaml b/clients/java-legacy/api/openapi.yaml
diff --git a/clients/java-legacy/docs/RevertCreation.md b/clients/java-legacy/docs/RevertCreation.md
diff --git a/clients/java-legacy/src/main/java/io/lakefs/clients/api/model/RevertCreation.java b/clients/java-legacy/src/main/java/io/lakefs/clients/api/model/RevertCreation.java
diff --git a/clients/java-legacy/src/test/java/io/lakefs/clients/api/model/RevertCreationTest.java b/clients/java-legacy/src/test/java/io/lakefs/clients/api/model/RevertCreationTest.java
diff --git a/clients/java/api/openapi.yaml b/clients/java/api/openapi.yaml
diff --git a/clients/java/docs/RevertCreation.md b/clients/java/docs/RevertCreation.md
diff --git a/clients/java/src/main/java/io/lakefs/clients/sdk/model/RevertCreation.java b/clients/java/src/main/java/io/lakefs/clients/sdk/model/RevertCreation.java
diff --git a/clients/java/src/test/java/io/lakefs/clients/sdk/model/RevertCreationTest.java b/clients/java/src/test/java/io/lakefs/clients/sdk/model/RevertCreationTest.java
diff --git a/clients/python-legacy/docs/BranchesApi.md b/clients/python-legacy/docs/BranchesApi.md
diff --git a/clients/python-legacy/docs/RevertCreation.md b/clients/python-legacy/docs/RevertCreation.md
diff --git a/clients/python-legacy/lakefs_client/model/revert_creation.py b/clients/python-legacy/lakefs_client/model/revert_creation.py
diff --git a/clients/python/docs/RevertCreation.md b/clients/python/docs/RevertCreation.md
diff --git a/clients/python/lakefs_sdk/models/revert_creation.py b/clients/python/lakefs_sdk/models/revert_creation.py
diff --git a/clients/python/test/test_revert_creation.py b/clients/python/test/test_revert_creation.py
diff --git a/cmd/lakectl/cmd/branch_revert.go b/cmd/lakectl/cmd/branch_revert.go
@@ -32,6 +32,7 @@ var branchRevertCmd = &cobra.Command{
 		fmt.Println("Branch:", u)
 		hasParentNumber := cmd.Flags().Changed(ParentNumberFlagName)
 		parentNumber := Must(cmd.Flags().GetInt(ParentNumberFlagName))
+		allowEmptyRevert := Must(cmd.Flags().GetBool(allowEmptyCommit))
 		if hasParentNumber && parentNumber <= 0 {
 			Die("parent number must be number greater than 0, if specified", 1)
 		}
@@ -46,6 +47,7 @@ var branchRevertCmd = &cobra.Command{
 			resp, err := clt.RevertBranchWithResponse(cmd.Context(), u.Repository, u.Ref, apigen.RevertBranchJSONRequestBody{
 				ParentNumber: parentNumber,
 				Ref:          commitRef,
+				AllowEmpty:   &allowEmptyRevert,
 			})
 			DieOnErrorOrUnexpectedStatusCode(resp, err, http.StatusNoContent)
 			fmt.Printf("commit %s successfully reverted\n", commitRef)
@@ -58,6 +60,7 @@ func init() {
 	AssignAutoConfirmFlag(branchRevertCmd.Flags())
 
 	branchRevertCmd.Flags().IntP(ParentNumberFlagName, "m", 0, "the parent number (starting from 1) of the mainline. The revert will reverse the change relative to the specified parent.")
+	branchRevertCmd.Flags().Bool(allowEmptyCommit, false, "allow empty commit (revert without changes)")
 
 	branchCmd.AddCommand(branchRevertCmd)
 }
diff --git a/docs/assets/js/swagger.yml b/docs/assets/js/swagger.yml
@@ -473,6 +473,10 @@ components:
         force:
           type: boolean
           default: false
+        allow_empty:
+          type: boolean
+          default: false
+          description: allow empty commit (revert without changes)
 
     CherryPickCreation:
       type: object

diff --git a/docs/reference/cli.md b/docs/reference/cli.md
@@ -1648,9 +1648,10 @@ lakectl branch revert lakefs://example-repo/example-branch commitA
 {:.no_toc}
 
 ```
-  -h, --help                help for revert
-  -m, --parent-number int   the parent number (starting from 1) of the mainline. The revert will reverse the change relative to the specified parent.
-  -y, --yes                 Automatically say yes to all confirmations
+      --allow-empty-commit   allow empty commit (revert without changes)
+  -h, --help                 help for revert
+  -m, --parent-number int    the parent number (starting from 1) of the mainline. The revert will reverse the change relative to the specified parent.
+  -y, --yes                  Automatically say yes to all confirmations
 ```
 
 

diff --git a/pkg/api/controller.go b/pkg/api/controller.go
@@ -3301,6 +3301,7 @@ func (c *Controller) RevertBranch(w http.ResponseWriter, r *http.Request, body a
 		Reference:    body.Ref,
 		Committer:    user.Committer(),
 		ParentNumber: body.ParentNumber,
+		AllowEmpty:   swag.BoolValue(body.AllowEmpty),
 	}, graveler.WithForce(swag.BoolValue(body.Force)))
 	if c.handleAPIError(ctx, w, r, err) {
 		return

diff --git a/pkg/catalog/catalog.go b/pkg/catalog/catalog.go
@@ -148,6 +148,7 @@ type RevertParams struct {
 	Reference    string // the commit to revert
 	ParentNumber int    // if reverting a merge commit, the change will be reversed relative to this parent number (1-based).
 	Committer    string
+	AllowEmpty   bool // allow empty commit (revert without changes)
 }
 
 type CherryPickParams struct {
@@ -1638,8 +1639,9 @@ func (c *Catalog) Revert(ctx context.Context, repositoryID string, branch string
 	branchID := graveler.BranchID(branch)
 	reference := graveler.Ref(params.Reference)
 	commitParams := graveler.CommitParams{
-		Committer: params.Committer,
-		Message:   fmt.Sprintf("Revert %s", params.Reference),
+		Committer:  params.Committer,
+		Message:    fmt.Sprintf("Revert %s", params.Reference),
+		AllowEmpty: params.AllowEmpty,
 	}
 	parentNumber := params.ParentNumber
 	if err := validator.Validate([]validator.ValidateArg{