Lint and update

Author: blva

tools/cli/internal/openapi/errors/merge_conflict_error.go

@@ -14,7 +14,12 @@
 
 package errors
 
-import "fmt"
+import (
+	"encoding/json"
+	"fmt"
+
+	"github.com/tufin/oasdiff/diff"
+)
 
 type ParamConflictError struct {
 	Entry string
@@ -56,3 +61,26 @@ type TagConflictError struct {
 func (e TagConflictError) Error() string {
 	return fmt.Sprintf("there was a conflict with the Tag %q with the description: %q", e.Entry, e.Description)
 }
+
+type PathDocsDiffConflictError struct {
+	Entry string
+	Diff  *diff.Diff
+}
+
+func (e PathDocsDiffConflictError) Error() string {
+	var pathDiff []byte
+	_, ok := e.Diff.PathsDiff.Modified[e.Entry]
+	if ok {
+		pathDiff, _ = json.MarshalIndent(e.Diff.PathsDiff.Modified[e.Entry], "", "  ")
+	}
+
+	return fmt.Sprintf("the path: %q is enabled for merge but it has a diff between the base and external spec. See the diff:\n%s", e.Entry, pathDiff)
+}
+
+type AllowDocsDiffNotSupportedError struct {
+	Entry string
+}
+
+func (e AllowDocsDiffNotSupportedError) Error() string {
+	return fmt.Sprintf("the path: %q is enabled for merge but the flag to allow docs diff is not supported", e.Entry)
+}

tools/cli/internal/openapi/oasdiff.go

@@ -15,7 +15,6 @@
 package openapi
 
 import (
-	"encoding/json"
 	"log"
 	"slices"
 	"strings"
@@ -122,11 +121,7 @@ func (o OasDiff) mergePaths() error {
 			if err != nil {
 				return err
 			}
-
-			// if diff is not allowed and there is a diff, then fail
-			if !allOperationsAllowDocsDiff(originalPathData, path) {
-				basePaths.Set(path, removeExternalRefs(externalPathData))
-			}
+			basePaths.Set(path, removeExternalRefs(externalPathData))
 		}
 	}
 	o.base.Spec.Paths = basePaths
@@ -176,19 +171,33 @@ func (o OasDiff) handlePathConflict(basePath *openapi3.PathItem, basePathName st
 		}
 	}
 
+	var pathsAreIdentical bool
+	var err error
+	if pathsAreIdentical, err = o.arePathsIdenticalWithExcludeExtensions(basePathName); err != nil {
+		return err
+	}
+
 	log.Printf("Skipping conflict for path: %s", basePathName)
-	if o.arePathsIdenticalWithExcludeExtensions(basePathName) {
-		log.Printf("No doc diff detected for path %s, merging the paths", basePathName)
+	if pathsAreIdentical {
 		return nil
 	}
 
-	if !allOperationsAllowDocsDiff(basePath, basePathName) {
-		log.Printf("Doc diff detected failing as allowDocsDiff=true is not supported.")
-		return errors.PathConflictError{
+	// allowDocsDiff = true not supported
+	if allOperationsAllowDocsDiff(basePath) {
+		return errors.AllowDocsDiffNotSupportedError{
 			Entry: basePathName,
 		}
 	}
-	return nil
+
+	d, err := o.getDiffWithoutExtensions()
+	if err != nil {
+		return err
+	}
+
+	return errors.PathDocsDiffConflictError{
+		Entry: basePathName,
+		Diff:  d,
+	}
 }
 
 // shouldSkipConflict checks if the conflict should be skipped.
@@ -475,24 +484,24 @@ func (o OasDiff) areSchemaIdentical(name string) bool {
 }
 
 // arePathsIdenticalWithExcludeExtensions checks if the paths are identical with the extensions excluded
-func (o OasDiff) arePathsIdenticalWithExcludeExtensions(name string) bool {
+func (o OasDiff) arePathsIdenticalWithExcludeExtensions(name string) (bool, error) {
 	// If the diff only has extensions diff, then we consider the paths to be identical
-	exclude := []string{"extensions"}
-	customConfig := diff.NewConfig().WithExcludeElements(exclude)
-	d, err := diff.Get(customConfig, o.base.Spec, o.external.Spec)
+	d, err := o.getDiffWithoutExtensions()
 	if err != nil {
-		log.Fatalf("error in calculating the diff of the specs: %s", err)
+		return false, err
 	}
 
 	if d.Empty() || d.PathsDiff.Empty() {
-		return true
+		return true, nil
 	}
 	_, ok := d.PathsDiff.Modified[name]
-	if ok {
-		j, _ := json.MarshalIndent(d.PathsDiff.Modified[name], "", "  ")
-		log.Printf("arePathsIdenticalWithExcludeExtensions diff: %s", j)
-	}
-	return !ok
+	return !ok, nil
+}
+
+func (o OasDiff) getDiffWithoutExtensions() (*diff.Diff, error) {
+	exclude := []string{"extensions"}
+	customConfig := diff.NewConfig().WithExcludeElements(exclude)
+	return diff.Get(customConfig, o.base.Spec, o.external.Spec)
 }
 
 type ByName []*openapi3.Tag

tools/cli/internal/openapi/paths.go

@@ -74,7 +74,7 @@ func getOperationExtensionWithName(operation *openapi3.Operation, extensionName
 	return operation.Extensions[extensionName]
 }
 
-func allOperationsAllowDocsDiff(basePath *openapi3.PathItem, basePathName string) bool {
+func allOperationsAllowDocsDiff(basePath *openapi3.PathItem) bool {
 	if basePath.Operations() == nil || len(basePath.Operations()) == 0 {
 		return false
 	}

tools/cli/internal/openapi/paths_test.go

@@ -177,7 +177,7 @@ func TestAllOperationsAllowDocsDiff(t *testing.T) {
 
 	for _, test := range tests {
 		t.Run(test.name, func(t *testing.T) {
-			actual := allOperationsAllowDocsDiff(test.input, "/test")
+			actual := allOperationsAllowDocsDiff(test.input)
 			if actual != test.expected {
 				t.Errorf("Expected %t, got %t", test.expected, actual)
 			}