Skip to content

Commit 287a6c2

Browse files
baywetbaywet
committed
test(assertions): use nameof for equivalency excludes
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 4a641408-bb75-484a-a8b1-25aa38f42105
1 parent 81eb164 commit 287a6c2

17 files changed

Lines changed: 37 additions & 36 deletions

‎test/Microsoft.OpenApi.Readers.Tests/V2Tests/ComparisonTests.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ public async Task EquivalentV2AndV3DocumentsShouldProduceEquivalentObjects(strin
2727
var result1 = await OpenApiDocument.LoadAsync(Path.Join(SampleFolderPath, $"{fileName}.v2.yaml"), SettingsFixture.ReaderSettings, token: TestContext.Current.CancellationToken);
2828
var result2 = await OpenApiDocument.LoadAsync(Path.Join(SampleFolderPath, $"{fileName}.v3.yaml"), SettingsFixture.ReaderSettings, token: TestContext.Current.CancellationToken);
2929

30-
OpenApiTestAssert.Equivalent(result1.Document, result2.Document, "Workspace", "BaseUri");
30+
OpenApiTestAssert.Equivalent(result1.Document, result2.Document, nameof(OpenApiDocument.Workspace), nameof(OpenApiDocument.BaseUri));
3131

3232
Assert.Equivalent(result2.Diagnostic.Errors, result1.Diagnostic.Errors);
3333
}

‎test/Microsoft.OpenApi.Readers.Tests/V2Tests/OpenApiDocumentTests.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -220,7 +220,7 @@ public async Task ShouldParseProducesInAnyOrder()
220220
["Error"] = errorSchema
221221
}
222222
}
223-
}, result.Document, "BaseUri");
223+
}, result.Document, nameof(OpenApiDocument.BaseUri));
224224
}
225225

226226
[Fact]

‎test/Microsoft.OpenApi.Readers.Tests/V2Tests/OpenApiHeaderTests.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ public void ParseHeaderWithDefaultShouldSucceed()
4040
}
4141
},
4242
header,
43-
"Parent");
43+
nameof(JsonNode.Parent));
4444
}
4545

4646
[Fact]
@@ -71,7 +71,7 @@ public void ParseHeaderWithEnumShouldSucceed()
7171
new JsonNodeExtension(9).Node
7272
]
7373
}
74-
}, header, "Parent");
74+
}, header, nameof(JsonNode.Parent));
7575
}
7676
}
7777
}

‎test/Microsoft.OpenApi.Readers.Tests/V2Tests/OpenApiOperationTests.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -242,7 +242,7 @@ public void ParseOperationWithResponseExamplesShouldSucceed()
242242
}
243243
}}
244244
}
245-
}, operation, "Parent", "Root");
245+
}, operation, nameof(JsonNode.Parent), nameof(JsonNode.Root));
246246
}
247247

248248
[Fact]

‎test/Microsoft.OpenApi.Readers.Tests/V2Tests/OpenApiParameterTests.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -237,7 +237,7 @@ public void ParseParameterWithDefaultShouldSucceed()
237237
Format = "float",
238238
Default = new JsonNodeExtension(5).Node
239239
}
240-
}, parameter, "Parent");
240+
}, parameter, nameof(JsonNode.Parent));
241241
}
242242

243243
[Fact]
@@ -272,7 +272,7 @@ public void ParseParameterWithEnumShouldSucceed()
272272
};
273273

274274
// Assert
275-
OpenApiTestAssert.Equivalent(expected, parameter, "Parent");
275+
OpenApiTestAssert.Equivalent(expected, parameter, nameof(JsonNode.Parent));
276276
}
277277

278278
[Fact]

‎test/Microsoft.OpenApi.Readers.Tests/V2Tests/OpenApiSchemaTests.cs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ public void ParseSchemaWithDefaultShouldSucceed()
3838
Type = JsonSchemaType.Number,
3939
Format = "float",
4040
Default = 5
41-
}, schema, "Parent");
41+
}, schema, nameof(JsonNode.Parent));
4242
}
4343

4444
[Fact]
@@ -61,7 +61,7 @@ public void ParseSchemaWithExampleShouldSucceed()
6161
Type = JsonSchemaType.Number,
6262
Format = "float",
6363
Example = 5
64-
}, schema, "Parent");
64+
}, schema, nameof(JsonNode.Parent));
6565
}
6666

6767
[Fact]
@@ -90,7 +90,7 @@ public void ParseSchemaWithEnumShouldSucceed()
9090
]
9191
};
9292

93-
OpenApiTestAssert.Equivalent(expected, schema, "Parent");
93+
OpenApiTestAssert.Equivalent(expected, schema, nameof(JsonNode.Parent));
9494
}
9595

9696
[Fact]

‎test/Microsoft.OpenApi.Readers.Tests/V31Tests/OpenApiDocumentTests.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -243,7 +243,7 @@ public async Task ParseDocumentWithWebhooksShouldSucceed()
243243

244244
// Assert
245245
Assert.Equivalent(new OpenApiDiagnostic() { SpecificationVersion = OpenApiSpecVersion.OpenApi3_1, Format = OpenApiConstants.Yaml }, actual.Diagnostic);
246-
OpenApiTestAssert.Equivalent(expected, actual.Document, "Workspace", "BaseUri");
246+
OpenApiTestAssert.Equivalent(expected, actual.Document, nameof(OpenApiDocument.Workspace), nameof(OpenApiDocument.BaseUri));
247247
}
248248

249249
[Fact]
@@ -445,7 +445,7 @@ public async Task ParseDocumentsWithReusablePathItemInWebhooksSucceeds()
445445
};
446446

447447
// Assert
448-
OpenApiTestAssert.Equivalent(expected, actual.Document, "Workspace", "BaseUri");
448+
OpenApiTestAssert.Equivalent(expected, actual.Document, nameof(OpenApiDocument.Workspace), nameof(OpenApiDocument.BaseUri));
449449
Assert.Equivalent(
450450
new OpenApiDiagnostic() { SpecificationVersion = OpenApiSpecVersion.OpenApi3_1, Format = OpenApiConstants.Yaml }, actual.Diagnostic);
451451
}

‎test/Microsoft.OpenApi.Readers.Tests/V31Tests/OpenApiMediaTypeTests.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ public async Task ParseMediaTypeWithExampleShouldSucceed()
3333
Type = JsonSchemaType.Number,
3434
Format = "float"
3535
}
36-
}, mediaType, "Parent");
36+
}, mediaType, nameof(JsonNode.Parent));
3737
}
3838

3939
[Fact]
@@ -62,7 +62,7 @@ public async Task ParseMediaTypeWithExamplesShouldSucceed()
6262
Type = JsonSchemaType.Number,
6363
Format = "float"
6464
}
65-
}, mediaType, "Parent");
65+
}, mediaType, nameof(JsonNode.Parent));
6666
}
6767

6868
[Fact]

‎test/Microsoft.OpenApi.Readers.Tests/V31Tests/OpenApiSchemaTests.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -290,7 +290,7 @@ public async Task ParseAdvancedV31SchemaShouldSucceed()
290290
};
291291

292292
// Assert
293-
OpenApiTestAssert.Equivalent(expectedSchema, schema, "Parent");
293+
OpenApiTestAssert.Equivalent(expectedSchema, schema, nameof(JsonNode.Parent));
294294
}
295295

296296
[Fact]

‎test/Microsoft.OpenApi.Readers.Tests/V3Tests/OpenApiDocumentTests.cs‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ public void ParseDocumentFromInlineStringShouldSucceed()
6363
Version = "0.9.1"
6464
},
6565
Paths = new OpenApiPaths()
66-
}, result.Document, "Workspace", "BaseUri");
66+
}, result.Document, nameof(OpenApiDocument.Workspace), nameof(OpenApiDocument.BaseUri));
6767

6868
Assert.Equivalent(
6969
new OpenApiDiagnostic()
@@ -117,7 +117,7 @@ public async Task ParseBasicDocumentWithMultipleServersShouldSucceed()
117117
}
118118
],
119119
Paths = new OpenApiPaths()
120-
}, result.Document, "Workspace", "BaseUri");
120+
}, result.Document, nameof(OpenApiDocument.Workspace), nameof(OpenApiDocument.BaseUri));
121121
}
122122
[Fact]
123123
public async Task ParseBrokenMinimalDocumentShouldYieldExpectedDiagnostic()
@@ -138,7 +138,7 @@ public async Task ParseBrokenMinimalDocumentShouldYieldExpectedDiagnostic()
138138
Version = "0.9"
139139
},
140140
Paths = new OpenApiPaths()
141-
}, result.Document, "Workspace", "BaseUri");
141+
}, result.Document, nameof(OpenApiDocument.Workspace), nameof(OpenApiDocument.BaseUri));
142142

143143
Assert.Equivalent(
144144
new OpenApiDiagnostic
@@ -200,7 +200,7 @@ public async Task ParseMinimalDocumentShouldSucceed()
200200
Version = "0.9.1"
201201
},
202202
Paths = new OpenApiPaths()
203-
}, result.Document, "Workspace", "BaseUri");
203+
}, result.Document, nameof(OpenApiDocument.Workspace), nameof(OpenApiDocument.BaseUri));
204204

205205
Assert.Equivalent(
206206
new OpenApiDiagnostic()
@@ -590,7 +590,7 @@ public async Task ParseStandardPetStoreDocumentShouldSucceed()
590590
Components = components
591591
};
592592

593-
OpenApiTestAssert.Equivalent(expectedDoc, actual.Document, "Workspace", "BaseUri");
593+
OpenApiTestAssert.Equivalent(expectedDoc, actual.Document, nameof(OpenApiDocument.Workspace), nameof(OpenApiDocument.BaseUri));
594594

595595
Assert.Equivalent(
596596
new OpenApiDiagnostic() { SpecificationVersion = OpenApiSpecVersion.OpenApi3_0, Format = OpenApiConstants.Yaml }, actual.Diagnostic);
@@ -1060,9 +1060,9 @@ [new OpenApiSecuritySchemeReference("securitySchemeName2")] =
10601060
expected.SetReferenceHostDocument();
10611061

10621062
OpenApiTestAssert.Equivalent(expected, actual.Document, path =>
1063-
path.MemberName is "Workspace" or "BaseUri"
1064-
|| path.Value.Contains("Paths[/pets].Operations[Get].Tags")
1065-
|| path.Value.Contains("Paths[/pets].Operations[Post].Tags"));
1063+
path.MemberName is nameof(OpenApiDocument.Workspace) or nameof(OpenApiDocument.BaseUri)
1064+
|| path.Value.Contains($"{nameof(OpenApiDocument.Paths)}[/pets].{nameof(OpenApiPathItem.Operations)}[{HttpMethod.Get}].{nameof(OpenApiOperation.Tags)}")
1065+
|| path.Value.Contains($"{nameof(OpenApiDocument.Paths)}[/pets].{nameof(OpenApiPathItem.Operations)}[{HttpMethod.Post}].{nameof(OpenApiOperation.Tags)}"));
10661066

10671067
Assert.Equivalent(
10681068
new OpenApiDiagnostic() { SpecificationVersion = OpenApiSpecVersion.OpenApi3_0, Format = OpenApiConstants.Yaml }, actual.Diagnostic);
@@ -1112,7 +1112,7 @@ public async Task HeaderParameterShouldAllowExample()
11121112
Type = JsonSchemaType.String,
11131113
Format = "uuid"
11141114
},
1115-
}, exampleHeader, "Parent");
1115+
}, exampleHeader, nameof(JsonNode.Parent));
11161116

11171117
var examplesHeader = result.Document.Components?.Headers?["examples-header"];
11181118
Assert.NotNull(examplesHeader);
@@ -1144,7 +1144,7 @@ public async Task HeaderParameterShouldAllowExample()
11441144
Type = JsonSchemaType.String,
11451145
Format = "uuid"
11461146
},
1147-
}, examplesHeader, "Parent");
1147+
}, examplesHeader, nameof(JsonNode.Parent));
11481148
}
11491149

11501150
[Fact]
@@ -1424,7 +1424,7 @@ public async Task ParseDocWithRefsUsingProxyReferencesSucceeds()
14241424
var actualParamReference = Assert.IsType<OpenApiParameterReference>(actualParam);
14251425

14261426
// Assert
1427-
OpenApiTestAssert.Equivalent(expectedParamReference, actualParamReference, "Reference", "Target", "RecursiveTarget", "Parent", "Options");
1427+
OpenApiTestAssert.Equivalent(expectedParamReference, actualParamReference, nameof(OpenApiParameterReference.Reference), nameof(OpenApiParameterReference.Target), nameof(OpenApiParameterReference.RecursiveTarget), nameof(JsonNode.Parent), nameof(JsonNode.Options));
14281428
Assert.Equal(expectedSerializedDoc.MakeLineBreaksEnvironmentNeutral(), outputDoc);
14291429
}
14301430

@@ -1475,7 +1475,7 @@ public void ParseBasicDocumentWithServerVariableShouldSucceed()
14751475
Format = OpenApiConstants.Yaml
14761476
}, result.Diagnostic);
14771477

1478-
OpenApiTestAssert.Equivalent(expected, result.Document, "BaseUri");
1478+
OpenApiTestAssert.Equivalent(expected, result.Document, nameof(OpenApiDocument.BaseUri));
14791479
}
14801480

14811481
[Fact]

0 commit comments

Comments
 (0)