bugfix: fix ignore logic (#242)

BREAKING-CHANGES.md

@@ -39,7 +39,7 @@ Sometimes, you may want to ignore certain breaking changes.
 The new Breaking Changes method allows you define breaking changes that you want to ignore in a configuration file.  
 You can specify the configuration file name in the oasdiff command-line with the `-warn-ignore` flag for WARNINGS or the `-err-ignore` flag for ERRORS.  
 Each line in the configuration file should contain two parts:
-1. method and path
+1. method and path (the first field in the line beginning with slash)
 2. description of the breaking change
 
 For example:

checker/ignore.go

@@ -8,6 +8,24 @@ import (
 	"github.com/TwiN/go-color"
 )
 
+func ignoreLinePath(ignoreLine string) string {
+	ignoreComponents := strings.Fields(ignoreLine)
+	pathIndex := -1
+
+	for i, component := range ignoreComponents {
+		if strings.HasPrefix(component, "/") {
+			pathIndex = i
+			break
+		}
+	}
+
+	if pathIndex == -1 {
+		return ""
+	}
+
+	return ignoreComponents[pathIndex]
+}
+
 func ProcessIgnoredBackwardCompatibilityErrors(level int, errs []BackwardCompatibilityError, ignoreFile string) ([]BackwardCompatibilityError, error) {
 	result := make([]BackwardCompatibilityError, 0)
 
@@ -21,6 +39,12 @@ func ProcessIgnoredBackwardCompatibilityErrors(level int, errs []BackwardCompati
 	ignoredErrs := make([]bool, len(errs))
 	for ignoreScanner.Scan() {
 		ignoreLine := strings.ToLower(ignoreScanner.Text())
+
+		ignorePath := ignoreLinePath(ignoreLine)
+		if ignorePath == "" {
+			continue
+		}
+
 		for errIndex, err := range errs {
 			if err.Level != level {
 				continue
@@ -29,10 +53,10 @@ func ProcessIgnoredBackwardCompatibilityErrors(level int, errs []BackwardCompati
 			uncolorizedText := strings.ReplaceAll(err.Text, color.Bold, "")
 			uncolorizedText = strings.ReplaceAll(uncolorizedText, color.Reset, "")
 
-			if strings.Contains(ignoreLine, strings.ToLower(err.Operation+" "+err.Path)) &&
+			if ignorePath == strings.ToLower(err.Path) &&
+				strings.Contains(ignoreLine, strings.ToLower(err.Operation+" "+err.Path)) &&
 				strings.Contains(ignoreLine, strings.ToLower(uncolorizedText)) {
 				ignoredErrs[errIndex] = true
-				break
 			}
 		}
 	}

checker/ignore_test.go

@@ -21,3 +21,32 @@ func TestIgnore(t *testing.T) {
 	require.NoError(t, err)
 	require.Equal(t, 5, len(errs))
 }
+
+func TestIgnoreSubpath(t *testing.T) {
+	s1 := l(t, 6)
+	s2 := l(t, 7)
+
+	d, osm, err := diff.GetWithOperationsSourcesMap(&diff.Config{}, &s1, &s2)
+	require.NoError(t, err)
+	errs := checker.CheckBackwardCompatibility(checker.GetDefaultChecks(), d, osm)
+	require.Equal(t, 3, len(errs))
+
+	errs, err = checker.ProcessIgnoredBackwardCompatibilityErrors(checker.ERR, errs, "../data/ignore-err-example-2.txt")
+	require.NoError(t, err)
+	require.Equal(t, 0, len(errs))
+}
+
+func TestIgnoreOnlyIncludedSubpaths(t *testing.T) {
+	s1 := l(t, 8)
+	s2 := l(t, 7)
+
+	d, osm, err := diff.GetWithOperationsSourcesMap(&diff.Config{}, &s1, &s2)
+	require.NoError(t, err)
+	errs := checker.CheckBackwardCompatibility(checker.GetDefaultChecks(), d, osm)
+	require.Equal(t, 2, len(errs)) // detect new and newest were deleted
+
+	errs, err = checker.ProcessIgnoredBackwardCompatibilityErrors(checker.ERR, errs, "../data/ignore-err-example-3.txt")
+	require.NoError(t, err)
+	require.Equal(t, 1, len(errs))
+	require.Contains(t, errs[0].Path, "/resource/new") //see that new breaking change was kept even though it is a substring of newest
+}

data/ignore-err-example-2.txt

@@ -0,0 +1,3 @@
+API get /health api path removed without deprecation
+get /health/live api path removed without deprecation
+get /health/ready api path removed without deprecation

data/ignore-err-example-3.txt

@@ -0,0 +1 @@
+get /resource/newest api path removed without deprecation

data/openapi-test6.yaml

@@ -0,0 +1,23 @@
+openapi: "3.0.0"
+info:
+  title: "Test API"
+  version: "1.0.0"
+paths:
+  /health:
+    get:
+      summary: "Get health status"
+      responses:
+        200:
+          description: "Success"
+  /health/live:
+    get:
+      summary: "Get live health status"
+      responses:
+        200:
+          description: "Success"
+  /health/ready:
+    get:
+      summary: "Get readiness status"
+      responses:
+        200:
+          description: "Success"

data/openapi-test7.yaml

@@ -0,0 +1,5 @@
+openapi: "3.0.0"
+info:
+  title: "Test API"
+  version: "2.0.0"
+paths: {}

data/openapi-test8.yaml

@@ -0,0 +1,17 @@
+openapi: "3.0.0"
+info:
+  title: "Test API"
+  version: "1.0.0"
+paths:
+  /resource/new:
+    get:
+      summary: "Get new resource"
+      responses:
+        200:
+          description: "Success"
+  /resource/newest:
+    get:
+      summary: "Get newest resource"
+      responses:
+        200:
+          description: "Success"