Skip to content

fix: replace env defaults for stored procedures #3652

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

Open
nanookclaw wants to merge 1 commit into
base: main
Choose a base branch
from
+180 −3
Open

fix: replace env defaults for stored procedures #3652

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 10 additions & 3 deletions src/Config/Converters/EntitySourceConverterFactory.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ public EntitySourceConverter(DeserializationVariableReplacementSettings? replace
List<ParameterMetadata> paramList = [];
foreach (JsonProperty prop in parametersElement.EnumerateObject())
{
string? defaultValue = GetClrValue(prop.Value)?.ToString();
string? defaultValue = GetClrValue(prop.Value, _replacementSettings)?.ToString();
paramList.Add(new ParameterMetadata
{
Name = prop.Name,
Expand Down Expand Up @@ -112,18 +112,25 @@ public EntitySourceConverter(DeserializationVariableReplacementSettings? replace
}
}

private static object GetClrValue(JsonElement element)
private static object GetClrValue(JsonElement element, DeserializationVariableReplacementSettings? replacementSettings)
{
return element.ValueKind switch
{
JsonValueKind.String => element.GetString() ?? string.Empty,
JsonValueKind.String => DeserializeStringValue(element, replacementSettings) ?? string.Empty,
JsonValueKind.Number => GetNumberValue(element),
JsonValueKind.True => true,
JsonValueKind.False => false,
_ => element.ToString()
};
}

private static string? DeserializeStringValue(JsonElement element, DeserializationVariableReplacementSettings? replacementSettings)
{
Utf8JsonReader reader = new(JsonSerializer.SerializeToUtf8Bytes(element.GetString()));
reader.Read();
return reader.DeserializeString(replacementSettings);
}
Comment on lines +127 to +132

/// <summary>
/// Attempts to get the correct numeric value from the <see cref="JsonElement"/>.
/// If all possible numeric values are exhausted, the raw text is returned.
Expand Down
56 changes: 56 additions & 0 deletions src/Service.Tests/UnitTests/RuntimeConfigLoaderJsonDeserializerTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,6 +165,62 @@ public void TestConfigParsingWithEnvVarReplacement(bool replaceEnvVar, string da
ClearEnvironmentVariablesFromDictionary(_environmentFileContentDict);
}

[DataTestMethod]
[DataRow(false, "@env('year-end')", DisplayName = "Do not replace stored procedure parameter default environment variable.")]
[DataRow(true, "2024-06-30", DisplayName = "Replace stored procedure parameter default environment variable.")]
public void TestStoredProcedureParameterDefaultEnvVarReplacement(bool replaceEnvVar, string expectedDefaultValue)
{
const string envVarName = "year-end";
Environment.SetEnvironmentVariable(envVarName, "2024-06-30");

try
{
string configJson = @"
{
""data-source"": {
""database-type"": ""mssql"",
""connection-string"": ""Server=tcp:127.0.0.1,1433;Persist Security Info=False;Trusted_Connection=True;TrustServerCertificate=True;MultipleActiveResultSets=False;Connection Timeout=5;""
},
""entities"": {
""GetRecordsByDate"": {
""source"": {
""object"": ""get_records_by_date"",
""type"": ""stored-procedure"",
""parameters"": {
""YearEndDate"": ""@env('year-end')""
}
},
""permissions"": [
{
""role"": ""anonymous"",
""actions"": [
{
""action"": ""execute""
}
]
}
]
}
}
}";

bool isParsingSuccessful = RuntimeConfigLoader.TryParseConfig(
configJson,
out RuntimeConfig runtimeConfig,
replacementSettings: new DeserializationVariableReplacementSettings(
azureKeyVaultOptions: null,
doReplaceEnvVar: replaceEnvVar,
doReplaceAkvVar: false));

Assert.IsTrue(isParsingSuccessful);
Assert.AreEqual(expectedDefaultValue, runtimeConfig.Entities["GetRecordsByDate"].Source.Parameters[0].Default);
}
finally
{
Environment.SetEnvironmentVariable(envVarName, null);
}
Comment on lines +173 to +221
}

/// <summary>
/// Test the parsing of DataSource section in runtime config for cosmosdb_nosql
/// where under cosmosDb options has database as null, container is not provided, and schema is an empty string.
Expand Down
114 changes: 114 additions & 0 deletions src/Service.Tests/UnitTests/SqlExecuteStructureUnitTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,114 @@
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.

using System;
using System.Collections.Generic;
using System.Data;
using Azure.DataApiBuilder.Auth;
using Azure.DataApiBuilder.Config;
using Azure.DataApiBuilder.Config.DatabasePrimitives;
using Azure.DataApiBuilder.Config.ObjectModel;
using Azure.DataApiBuilder.Core.Models;
using Azure.DataApiBuilder.Core.Resolvers;
using Azure.DataApiBuilder.Core.Services;
using Microsoft.VisualStudio.TestTools.UnitTesting;
using Moq;

namespace Azure.DataApiBuilder.Service.Tests.UnitTests
{
[TestClass]
public class SqlExecuteStructureUnitTests
{
[TestMethod]
public void ConfigDefaultDateTimeParameterIsResolvedAsDateTime()
{
const string entityName = "GetRecordsByDate";
const string parameterName = "YearEndDate";
const string envVarName = "year-end";
DateTime expectedDate = new(year: 2024, month: 6, day: 30, hour: 0, minute: 0, second: 0, kind: DateTimeKind.Utc);

Environment.SetEnvironmentVariable(envVarName, "2024-06-30");
try
{
Assert.IsTrue(RuntimeConfigLoader.TryParseConfig(
GetStoredProcedureConfigWithEnvDefault(),
out RuntimeConfig runtimeConfig,
replacementSettings: new DeserializationVariableReplacementSettings(
azureKeyVaultOptions: null,
doReplaceEnvVar: true,
doReplaceAkvVar: false)));

StoredProcedureDefinition storedProcedureDefinition = new();
storedProcedureDefinition.Parameters.Add(
parameterName,
new ParameterDefinition
{
SystemType = typeof(DateTime),
DbType = DbType.DateTime,
HasConfigDefault = true,
ConfigDefaultValue = runtimeConfig.Entities[entityName].Source.Parameters[0].Default
});

DatabaseStoredProcedure storedProcedure = new(schemaName: "dbo", tableName: "get_records_by_date")
{
SourceType = EntitySourceType.StoredProcedure,
StoredProcedureDefinition = storedProcedureDefinition
};

Mock<ISqlMetadataProvider> metadataProvider = new();
metadataProvider.SetupGet(x => x.EntityToDatabaseObject).Returns(new Dictionary<string, DatabaseObject>
{
{ entityName, storedProcedure }
});
metadataProvider.Setup(x => x.GetStoredProcedureDefinition(entityName)).Returns(storedProcedureDefinition);
metadataProvider.Setup(x => x.GetSourceDefinition(entityName)).Returns(storedProcedureDefinition);

SqlExecuteStructure executeStructure = new(
entityName,
metadataProvider.Object,
Mock.Of<IAuthorizationResolver>(),
null,
new Dictionary<string, object?>());

string dbConnectionParameterName = (string)executeStructure.ProcedureParameters[parameterName];
Assert.AreEqual(expectedDate, executeStructure.Parameters[dbConnectionParameterName].Value);
}
finally
{
Environment.SetEnvironmentVariable(envVarName, null);
}
Comment on lines +30 to +79
}

private static string GetStoredProcedureConfigWithEnvDefault()
{
return @"
{
""data-source"": {
""database-type"": ""mssql"",
""connection-string"": ""Server=tcp:127.0.0.1,1433;Persist Security Info=False;Trusted_Connection=True;TrustServerCertificate=True;MultipleActiveResultSets=False;Connection Timeout=5;""
},
""entities"": {
""GetRecordsByDate"": {
""source"": {
""object"": ""get_records_by_date"",
""type"": ""stored-procedure"",
""parameters"": {
""YearEndDate"": ""@env('year-end')""
}
},
""permissions"": [
{
""role"": ""anonymous"",
""actions"": [
{
""action"": ""execute""
}
]
}
]
}
}
}";
}
}
}
Loading