Fix tests to handle parsing errors.

Added some more comments for folks.

Author: daveshanley

datamodel/spec_info.go

@@ -108,14 +108,16 @@ func ExtractSpecInfoWithDocumentCheck(spec []byte, bypass bool) (*SpecInfo, erro
 	parseJSON := func(bytes []byte, spec *SpecInfo, parsedNode *yaml.Node) error {
 		var jsonSpec map[string]interface{}
 		if utils.IsYAML(string(bytes)) {
+			// Decode YAML to map - this is critical to catch structural errors like duplicate keys
 			if err := parsedNode.Decode(&jsonSpec); err != nil {
 				return fmt.Errorf("failed to decode YAML to JSON: %w", err)
 			}
+			// Marshal to JSON - if this fails due to unsupported types (e.g. map[interface{}]interface{}),
+			// we tolerate it as it doesn't indicate spec invalidity, just YAML/JSON incompatibility
 			b, err := json.Marshal(&jsonSpec)
-			if err != nil {
-				return fmt.Errorf("failed to marshal JSON: %w", err)
+			if err == nil {
+				spec.SpecJSONBytes = &b
 			}
-			spec.SpecJSONBytes = &b
 			spec.SpecJSON = &jsonSpec
 		} else {
 			if err := json.Unmarshal(bytes, &jsonSpec); err != nil {

document_examples_test.go

@@ -360,7 +360,8 @@ func TestExampleCompareDocuments_swagger(t *testing.T) {
 }
 
 func TestDocument_Paths_As_Array(t *testing.T) {
-	// paths can now be wrapped in an array.
+	// This test has invalid JSON (paths as array with object literal inside)
+	// Testing that we properly reject invalid JSON after fix for issue #355
 	spec := `{
     "openapi": "3.1.0",
     "paths": [
@@ -372,12 +373,9 @@ func TestDocument_Paths_As_Array(t *testing.T) {
 `
 	// create a new document from specification bytes
 	doc, err := NewDocument([]byte(spec))
-	// if anything went wrong, an error is thrown
-	if err != nil {
-		panic(fmt.Sprintf("cannot create new document: %e", err))
-	}
-	v3Model, _ := doc.BuildV3Model()
-	assert.NotNil(t, v3Model)
+	// After fix #355, invalid JSON should now produce an error
+	assert.Error(t, err, "Invalid JSON should produce an error")
+	assert.Nil(t, doc, "Document should be nil when JSON is invalid")
 }
 
 // If you want to know more about circular references that have been found

document_test.go

@@ -564,14 +564,15 @@ func TestDocument_BuildModelBad(t *testing.T) {
 }
 
 func TestDocument_Serialize_JSON_Modified(t *testing.T) {
-	json := `{ 'openapi': '3.0',
- 'info': {
-   'title': 'The magic API'
+	json := `{ "openapi": "3.0",
+ "info": {
+   "title": "The magic API"
  }
 }
 `
 	jsonModified := `{"info":{"title":"The magic API - but now, altered!"},"openapi":"3.0"}`
-	doc, _ := NewDocument([]byte(json))
+	doc, err := NewDocument([]byte(json))
+	assert.NoError(t, err)
 
 	v3Doc, _ := doc.BuildV3Model()
 

test_specs/swagger-circular-tests.yaml

@@ -11,25 +11,25 @@ definitions:
     description: "test one"
     properties:
       things:
-        "$ref": "#/definitions/Two"
+        $ref: "#/definitions/Two"
     required:
       - things
   Two:
     description: "test two"
     properties:
       testThing:
-        "$ref": "#/definitions/One"
+        $ref: "#/definitions/One"
     required:
       - testThing
   Three:
     description: "test three"
     properties:
       tester:
-        "$ref": "#/definitions/Four"
+        $ref: "#/definitions/Four"
       bester:
-        "$ref": "#/definitions/Seven"
+        $ref: "#/definitions/Seven"
       yester:
-        "$ref": "#/definitions/Seven"
+        $ref: "#/definitions/Seven"
     required:
       - tester
       - bester
@@ -38,32 +38,32 @@ definitions:
     description: "test four"
     properties:
       lemons:
-        "$ref": "#/definitions/Nine"
+        $ref: "#/definitions/Nine"
     required:
       - lemons
   Five:
     properties:
       rice:
-        "$ref": "#/definitions/Six"
+        $ref: "#/definitions/Six"
     required:
       - rice
   Six:
     properties:
       mints:
-        "$ref": "#/definitions/Nine"
+        $ref: "#/definitions/Nine"
     required:
       - mints
   Seven:
     properties:
       wow:
-        "$ref": "#/definitions/Three"
+        $ref: "#/definitions/Three"
     required:
       - wow
   Nine:
     description: done.
   Ten:
     properties:
       yeah:
-        "$ref": "#/definitions/Ten"
+        $ref: "#/definitions/Ten"
     required:
       - yeah