return error in case of invalid OpenAPI 3.x spec

Author: guicassolato

pkg/i2gw/providers/openapi3/converter_test.go

@@ -24,6 +24,7 @@ import (
 	"os"
 	"path/filepath"
 	"regexp"
+	"strings"
 	"testing"
 
 	apiequality "k8s.io/apimachinery/pkg/api/equality"
@@ -43,9 +44,13 @@ const fixturesDir = "./fixtures"
 func TestFileConvertion(t *testing.T) {
 	ctx := context.Background()
 
-	//nolint:gofmt
-	providerConf := map[string]*i2gw.ProviderConf{
-		"default": &i2gw.ProviderConf{
+	type testData struct {
+		providerConf          *i2gw.ProviderConf
+		expectedReadFileError error
+	}
+
+	defaultTestData := testData{
+		providerConf: &i2gw.ProviderConf{
 			ProviderSpecificFlags: map[string]map[string]string{
 				"openapi3": {
 					"gateway-class-name": "external",
@@ -54,16 +59,24 @@ func TestFileConvertion(t *testing.T) {
 				},
 			},
 		},
-		"reference-grants.yaml": &i2gw.ProviderConf{
-			Namespace: "networking",
-			ProviderSpecificFlags: map[string]map[string]string{
-				"openapi3": {
-					"gateway-class-name": "external",
-					"gateway-tls-secret": "secrets/gateway-tls-cert",
-					"backend":            "apps/backend-1",
+	}
+
+	customTestData := map[string]testData{
+		"reference-grants.yaml": {
+			providerConf: &i2gw.ProviderConf{
+				Namespace: "networking",
+				ProviderSpecificFlags: map[string]map[string]string{
+					"openapi3": {
+						"gateway-class-name": "external",
+						"gateway-tls-secret": "secrets/gateway-tls-cert",
+						"backend":            "apps/backend-1",
+					},
 				},
 			},
 		},
+		"invalid-spec.yaml": {
+			expectedReadFileError: fmt.Errorf("failed to read resources from file: invalid OpenAPI 3.x spec"),
+		},
 	}
 
 	filepath.WalkDir(filepath.Join(fixturesDir, "input"), func(path string, d fs.DirEntry, err error) error {
@@ -74,15 +87,32 @@ func TestFileConvertion(t *testing.T) {
 			return nil
 		}
 
-		conf, ok := providerConf[regexp.MustCompile(`\d+-(.+\.(json|yaml))$`).FindAllStringSubmatch(d.Name(), -1)[0][1]]
-		if !ok {
-			conf = providerConf["default"]
+		providerConf := defaultTestData.providerConf
+		expectedReadFileError := defaultTestData.expectedReadFileError
+
+		inputFileName := regexp.MustCompile(`\d+-(.+\.(json|yaml))$`).FindAllStringSubmatch(d.Name(), -1)[0][1]
+		data, ok := customTestData[inputFileName]
+		if ok {
+			if data.providerConf != nil {
+				providerConf = data.providerConf
+			}
+			if data.expectedReadFileError != nil {
+				expectedReadFileError = data.expectedReadFileError
+			}
 		}
-		provider := NewProvider(conf)
 
-		err = provider.ReadResourcesFromFile(ctx, path)
-		if err != nil {
-			t.Fatalf("Failed to read input from file %v: %v", d.Name(), err.Error())
+		provider := NewProvider(providerConf)
+
+		if readFileErr := provider.ReadResourcesFromFile(ctx, path); readFileErr != nil {
+			if expectedReadFileError == nil {
+				t.Fatalf("unexpected error during reading test file %v: %v", d.Name(), readFileErr.Error())
+			} else if !strings.Contains(readFileErr.Error(), expectedReadFileError.Error()) {
+				t.Fatalf("unexpected error during reading test file %v: '%v' does not contain expected '%v'", d.Name(), readFileErr.Error(), expectedReadFileError.Error())
+			} else {
+				return nil // success
+			}
+		} else if expectedReadFileError != nil {
+			t.Fatalf("missing expected error during reading test file %v: %v", d.Name(), expectedReadFileError.Error())
 		}
 
 		gotGatewayResources, errList := provider.ToGatewayAPI()

pkg/i2gw/providers/openapi3/openapi.go

@@ -19,7 +19,6 @@ package openapi3
 import (
 	"context"
 	"fmt"
-	"log"
 
 	"github.com/getkin/kin-openapi/openapi3"
 	"k8s.io/apimachinery/pkg/util/validation/field"
@@ -103,8 +102,7 @@ func readSpecFromFile(ctx context.Context, filename string) (*openapi3.T, error)
 	}
 
 	if err := spec.Validate(ctx); err != nil {
-		log.Printf("%s provider: invalid OpenAPI 3.x spec: %v", ProviderName, err)
-		return nil, nil
+		return nil, fmt.Errorf("invalid OpenAPI 3.x spec: %w", err)
 	}
 
 	return spec, nil