Skip to content

Fix Json Schema validations for optional fields #2611

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Mar 24, 2025
Merged

Fix Json Schema validations for optional fields #2611

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
4ee4541
add tests
abhishekkumams Mar 4, 2025
a8567e0
Merge branch 'main' into dev/abhishekkuma/fix-schema-validation-no-op…
abhishekkumams Mar 4, 2025
d1d066a
add test summary
abhishekkumams Mar 4, 2025
8c6e3c3
Merge branch 'dev/abhishekkuma/fix-schema-validation-no-optional-fiel…
abhishekkumams Mar 4, 2025
9b1236d
add another test case
Mar 13, 2025
7225543
Merge branch 'main' into dev/abhishekkuma/fix-schema-validation-no-op…
sezal98 Mar 19, 2025
fef4a69
Merge branch 'main' into dev/abhishekkuma/fix-schema-validation-no-op…
Aniruddh25 Mar 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions schemas/dab.draft.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -245,15 +245,15 @@
},
"mode": {
"description": "Set if running in Development or Production mode",
"type": "string",
"type": ["string", "null"],
"default": "production",
"enum": [
"production",
"development"
]
},
"cors": {
"type": "object",
"type": ["object", "null"],
"description": "Configure CORS",
"additionalProperties": false,
"properties": {
Expand All @@ -273,7 +273,7 @@
}
},
"authentication": {
"type": "object",
"type": ["object", "null"],
"additionalProperties": false,
"properties": {
"provider": {
Expand Down
121 changes: 121 additions & 0 deletions src/Service.Tests/Configuration/ConfigurationTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -467,6 +467,69 @@ type Moon {
}
";

public const string CONFIG_FILE_WITH_NO_OPTIONAL_FIELD = @"{
""$schema"":""https://github.com/Azure/data-api-builder/releases/download/vmajor.minor.patch-alpha/dab.draft.schema.json"",
""data-source"": {
""database-type"": ""mssql"",
""connection-string"": ""sample-conn-string""
},
""entities"":{ }
}";

public const string CONFIG_FILE_WITH_NO_AUTHENTICATION_FIELD = @"{
// Link for latest draft schema.
""$schema"":""https://github.com/Azure/data-api-builder/releases/download/vmajor.minor.patch-alpha/dab.draft.schema.json"",
""data-source"": {
""database-type"": ""mssql"",
""connection-string"": ""sample-conn-string""
},
""runtime"": {
""rest"": {
""enabled"": true,
""path"": ""/api""
},
""graphql"": {
""enabled"": true,
""path"": ""/graphql"",
""allow-introspection"": true
},
""host"": {
""cors"": {
""origins"": [
""http://localhost:5000""
],
""allow-credentials"": false
}
}
},
""entities"":{ }
}";
public const string CONFIG_FILE_WITH_NO_CORS_FIELD = @"{
// Link for latest draft schema.
""$schema"":""https://github.com/Azure/data-api-builder/releases/download/vmajor.minor.patch-alpha/dab.draft.schema.json"",
""data-source"": {
""database-type"": ""mssql"",
""connection-string"": ""sample-conn-string""
},
""runtime"": {
""rest"": {
""enabled"": true,
""path"": ""/api""
},
""graphql"": {
""enabled"": true,
""path"": ""/graphql"",
""allow-introspection"": true
},
""host"": {
""authentication"": {
""provider"": ""StaticWebApps""
}
}
},
""entities"":{ }
}";

[TestCleanup]
public void CleanupAfterEachTest()
{
Expand Down Expand Up @@ -1590,6 +1653,64 @@ public async Task TestConfigSchemaIsValid()
Times.Once);
}

/// <summary>
/// This test method validates a sample DAB runtime config file against DAB's JSON schema definition.
/// It asserts that the validation is successful and there are no validation failures when no optional fields are used.
/// It also verifies that the expected log message is logged.
/// </summary>
[DataTestMethod]
[DataRow(CONFIG_FILE_WITH_NO_OPTIONAL_FIELD, DisplayName = "Validates schema of the config file with no optional fields.")]
[DataRow(CONFIG_FILE_WITH_NO_AUTHENTICATION_FIELD, DisplayName = "Validates schema of the config file with no Authentication field.")]
[DataRow(CONFIG_FILE_WITH_NO_CORS_FIELD, DisplayName = "Validates schema of the config file with no Cors field.")]
public async Task TestBasicConfigSchemaWithNoOptionalFieldsIsValid(string jsonData)
{
Mock<ILogger<JsonConfigSchemaValidator>> schemaValidatorLogger = new();

string jsonSchema = File.ReadAllText("dab.draft.schema.json");

JsonConfigSchemaValidator jsonSchemaValidator = new(schemaValidatorLogger.Object, new MockFileSystem());

JsonSchemaValidationResult result = await jsonSchemaValidator.ValidateJsonConfigWithSchemaAsync(jsonSchema, jsonData);
Assert.IsTrue(result.IsValid);
Assert.IsTrue(EnumerableUtilities.IsNullOrEmpty(result.ValidationErrors));
schemaValidatorLogger.Verify(
x => x.Log(
LogLevel.Information,
It.IsAny<EventId>(),
It.Is<It.IsAnyType>((o, t) => o.ToString()!.Contains($"The config satisfies the schema requirements.")),
It.IsAny<Exception>(),
(Func<It.IsAnyType, Exception, string>)It.IsAny<object>()),
Times.Once);
}

/// <summary>
/// The config file does not contain any entity fields, which is expected to be invalid according to the schema.
/// The test asserts that the validation fails and there are validation errors.
/// It also verifies that the expected error message is logged, indicating that the 'entities' property is required.
[TestMethod]
public async Task TestBasicConfigSchemaWithNoEntityFieldsIsInvalid()
{
string jsonData = @"{
""$schema"":""https://github.com/Azure/data-api-builder/releases/download/vmajor.minor.patch-alpha/dab.draft.schema.json"",
""data-source"": {
""database-type"": ""mssql"",
""connection-string"": ""sample-conn-string""
}
}";

Mock<ILogger<JsonConfigSchemaValidator>> schemaValidatorLogger = new();

string jsonSchema = File.ReadAllText("dab.draft.schema.json");

JsonConfigSchemaValidator jsonSchemaValidator = new(schemaValidatorLogger.Object, new MockFileSystem());

JsonSchemaValidationResult result = await jsonSchemaValidator.ValidateJsonConfigWithSchemaAsync(jsonSchema, jsonData);
Assert.IsFalse(result.IsValid);
Assert.IsFalse(EnumerableUtilities.IsNullOrEmpty(result.ValidationErrors));
Assert.AreEqual(1, result.ErrorCount);
Assert.IsTrue(result.ErrorMessage.Contains("Total schema validation errors: 1\n> PropertyRequired: #/entities"));
}

/// <summary>
/// This test tries to validate a runtime config file that is not compliant with the runtime config JSON schema.
/// It validates no additional properties are defined in the config file.
Expand Down