Skip to content
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

Throw proper exception when TypeNameMatch expression is missing #176

Merged
merged 1 commit into from
Mar 14, 2022
Merged

Throw proper exception when TypeNameMatch expression is missing #176

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
1 change: 0 additions & 1 deletion src/lib/Microsoft.Health.Fhir.Ingest.Template/IotJsonPathContentTemplateFactory.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
// -------------------------------------------------------------------------------------------------

using EnsureThat;
using Microsoft.Health.Fhir.Ingest.Template;
using Newtonsoft.Json.Linq;

namespace Microsoft.Health.Fhir.Ingest.Template
Expand Down
2 changes: 1 addition & 1 deletion src/lib/Microsoft.Health.Fhir.Ingest.Template/IotJsonPathLegacyMeasurementExtractor.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ namespace Microsoft.Health.Fhir.Ingest.Template
{
public class IotJsonPathLegacyMeasurementExtractor : LegacyMeasurementExtractor
{
private IotJsonPathContentTemplate _template;
private readonly IotJsonPathContentTemplate _template;

public IotJsonPathLegacyMeasurementExtractor(
IotJsonPathContentTemplate template)
Expand Down
2 changes: 1 addition & 1 deletion src/lib/Microsoft.Health.Fhir.Ingest.Template/JsonPathExpressionEvaluatorFactory.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ public class JsonPathExpressionEvaluatorFactory : IExpressionEvaluatorFactory
{
public IExpressionEvaluator Create(TemplateExpression expression)
{
EnsureArg.IsNotEmptyOrWhiteSpace(expression?.Value, nameof(expression.Value));
EnsureArg.IsNotNullOrWhiteSpace(expression?.Value, nameof(expression.Value));

var expressionLanguage = expression.Language ?? TemplateExpressionLanguage.JsonPath;
if (expressionLanguage != TemplateExpressionLanguage.JsonPath)
Expand Down
2 changes: 1 addition & 1 deletion src/lib/Microsoft.Health.Fhir.Ingest.Template/LegacyMeasurementExtractor.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ public LegacyMeasurementExtractor(
protected override IEnumerable<JToken> MatchTypeTokens(JObject token)
{
EnsureArg.IsNotNull(token, nameof(token));
var evaluator = ExpressionEvaluatorFactory.Create(Template.TypeMatchExpression);
var evaluator = CreateRequiredExpressionEvaluator(Template.TypeMatchExpression, nameof(Template.TypeMatchExpression));

return evaluator.SelectTokens(token);
}
Expand Down
15 changes: 14 additions & 1 deletion src/lib/Microsoft.Health.Fhir.Ingest.Template/MeasurementExtractor.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ protected static bool IsExpressionDefined(params TemplateExpression[] expression
protected virtual IEnumerable<JToken> MatchTypeTokens(JObject token)
{
EnsureArg.IsNotNull(token, nameof(token));
var evaluator = ExpressionEvaluatorFactory.Create(Template.TypeMatchExpression);
var evaluator = CreateRequiredExpressionEvaluator(Template.TypeMatchExpression, nameof(Template.TypeMatchExpression));

foreach (var extractedToken in evaluator.SelectTokens(token))
{
Expand All @@ -134,6 +134,19 @@ protected virtual IEnumerable<JToken> MatchTypeTokens(JObject token)
}
}

protected IExpressionEvaluator CreateRequiredExpressionEvaluator(TemplateExpression expression, string expressionName)
{
EnsureArg.IsNotNullOrWhiteSpace(expressionName, nameof(expressionName));

// If the expression object or its value aren't set, throw a detailed exception
if (string.IsNullOrWhiteSpace(expression?.Value))
{
throw new IncompatibleDataException($"An expression must be set for [{expressionName}]");
}

return ExpressionEvaluatorFactory.Create(Template.TypeMatchExpression);
}

private Measurement CreateMeasurementFromToken(JToken token)
{
// Current assumption is that the expressions should match a single element and will error otherwise.
Expand Down
2 changes: 1 addition & 1 deletion src/lib/Microsoft.Health.Fhir.Ingest.Template/TemplateExpressionEvaluatorFactory.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ public TemplateExpressionEvaluatorFactory(JmesPath jmesPath)

public IExpressionEvaluator Create(TemplateExpression expression)
{
EnsureArg.IsNotEmptyOrWhiteSpace(expression?.Value, nameof(expression.Value));
EnsureArg.IsNotNullOrWhiteSpace(expression?.Value, nameof(expression.Value));
EnsureArg.IsNotNull(expression?.Language, nameof(expression.Language));

return expression.Language switch
Expand Down
32 changes: 31 additions & 1 deletion test/Microsoft.Health.Fhir.Ingest.Template.UnitTests/IotJsonPathContentTemplateTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@

using System.Collections.Generic;
using System.Linq;
using Microsoft.Health.Fhir.Ingest.Template;
using Microsoft.Health.Tests.Common;
using Newtonsoft.Json;
using Newtonsoft.Json.Linq;
Expand Down Expand Up @@ -36,6 +35,16 @@ public class IotJsonPathContentTemplateTests
},
});

private static readonly IContentTemplate SingleValueMissingTypeNameTemplate = BuildMeasurementExtractor(new IotJsonPathContentTemplate
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: This field doesn't seem to be referenced in Line 73's test or anywhere else.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You are correct; I forgot to delete this. I'll remove it in my next PR

{
TypeName = "heartrate",
TypeMatchExpression = "$..[?(@Body.heartrate)]",
Values = new List<JsonPathValueExpression>
{
new JsonPathValueExpression { ValueName = "hr", ValueExpression = "$.Body.heartrate", Required = true },
},
});

[Theory]
[FileData(@"TestInput/data_IotHubPayloadExample.json")]
public void GivenTemplateAndSingleValidToken_WhenGetMeasurements_ThenSingleMeasurementReturned_Test(string eventJson)
Expand All @@ -57,6 +66,27 @@ public void GivenTemplateAndSingleValidToken_WhenGetMeasurements_ThenSingleMeasu
});
}

[Theory]
[InlineData(null)]
[InlineData("")]
[InlineData(" ")]
public void GivenTemplateAndMissingTypeNameToken_WhenGetMeasurements_ThenExceptionIsThrown_Test(string typeMatchExpression)
{
var token = JToken.FromObject(new { heartrate = "60", device = "abc" });
var template = BuildMeasurementExtractor(new IotJsonPathContentTemplate
{
TypeName = "heartrate",
TypeMatchExpression = typeMatchExpression,
Values = new List<JsonPathValueExpression>
{
new JsonPathValueExpression { ValueName = "hr", ValueExpression = "$.Body.heartrate", Required = true },
},
});

var ex = Assert.Throws<IncompatibleDataException>(() => template.GetMeasurements(token).ToArray());
Assert.Equal("An expression must be set for [TypeMatchExpression]", ex.Message);
}

[Theory]
[FileData(@"TestInput/data_IotHubPayloadMultiValueExample.json")]
public void GivenTemplateAndSingleMultiValueValidToken_WhenGetMeasurements_ThenSingleMeasurementReturned_Test(string eventJson)
Expand Down
27 changes: 26 additions & 1 deletion test/Microsoft.Health.Fhir.Ingest.Template.UnitTests/JsonPathContentTemplateTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -412,7 +412,32 @@ public void GivenPropertyWithSpace_WhenGetMeasurements_ThenSingleMeasurementRetu
Assert.Equal("data", p.Value);
});
});
}
}

[Theory]
[InlineData(null)]
[InlineData("")]
[InlineData(" ")]
public void GivenInvalidTypeMatchExpression_WhenGetMeasurements_ThenExceptionIsThrown_Test(string typeMatchExpression)
{
var time = DateTime.UtcNow;
var token = JToken.FromObject(new JsonWidget { MyProperty = "data", Time = time });

var template = new JsonPathContentTemplate
{
TypeName = "space",
TypeMatchExpression = typeMatchExpression,
DeviceIdExpression = "$.['My Property']",
TimestampExpression = "$.Time",
Values = new List<JsonPathValueExpression>
{
new JsonPathValueExpression { ValueName = "prop", ValueExpression = "$.['My Property']", Required = false },
},
};

var ex = Assert.Throws<IncompatibleDataException>(() => BuildMeasurementExtractor(template).GetMeasurements(token).ToArray());
Assert.Equal("An expression must be set for [TypeMatchExpression]", ex.Message);
}

[Fact]
public void GivenSingleValueCompoundAndTemplateAndPartialToken_WhenGetMeasurements_ThenEmptyIEnumerableReturned_Test()
Expand Down