-
Notifications
You must be signed in to change notification settings - Fork 2
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.
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
Create duplicate invariant key validator #184
Merged
Merged
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
abdd1cf
Create duplicate invariant key validator
mmsmits e986cc2
Merge branch 'develop' into feature/143-validate-constraint-uniqueness
ewoutkramer cc5a7a8
Merge branch 'develop' into feature/143-validate-constraint-uniqueness
mmsmits 5d540a9
minor improvements
mmsmits be4d146
Merge branch 'develop' into feature/143-validate-constraint-uniqueness
ewoutkramer 2fcaa74
fixing review comments
mmsmits File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
20 changes: 20 additions & 0 deletions
20
...Fhir.Validation.Compilation.Shared/EnterpriseSchemaBuilders/StructureDefinitionBuilder.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
using Hl7.Fhir.Specification.Navigation; | ||
using System.Collections.Generic; | ||
|
||
namespace Firely.Fhir.Validation.Compilation | ||
{ | ||
/// <summary> | ||
/// The schema builder for the <see cref="ElementDefinitionValidator"/>. | ||
/// </summary> | ||
public class StructureDefinitionBuilder : ISchemaBuilder | ||
{ | ||
/// <inheritdoc/> | ||
public IEnumerable<IAssertion> Build(ElementDefinitionNavigator nav, ElementConversionMode? conversionMode = ElementConversionMode.Full) | ||
{ | ||
if (nav.Current.Path == "StructureDefinition") | ||
{ | ||
yield return new StructureDefinitionValidator(); | ||
}; | ||
} | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
68 changes: 68 additions & 0 deletions
68
src/Firely.Fhir.Validation/EnterpriseValidators/StructureDefinitionValidator.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,68 @@ | ||
using Hl7.Fhir.ElementModel; | ||
using Hl7.Fhir.Support; | ||
using Hl7.FhirPath.Sprache; | ||
using Newtonsoft.Json.Linq; | ||
using System.Collections.Generic; | ||
using System.Linq; | ||
using System.Runtime.Serialization; | ||
|
||
namespace Firely.Fhir.Validation | ||
{ | ||
/// <summary> | ||
/// An <see cref="ElementSchema"/> that represents a FHIR StructureDefinition | ||
/// </summary> | ||
[DataContract] | ||
public class StructureDefinitionValidator : IValidatable | ||
{ | ||
/// <inheritdoc/> | ||
public JToken ToJson() => new JProperty("elementDefinition", new JObject()); | ||
|
||
/// <inheritdoc/> | ||
public ResultReport Validate(ITypedElement input, ValidationContext vc, ValidationState state) | ||
{ | ||
//this can be expanded with other validate functionality | ||
var evidence = validateInvariantUniqueness(input, state).ToList(); | ||
|
||
return ResultReport.FromEvidence(evidence); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. No need to create a list:
If there are multiple steps in the future, you can just do
|
||
} | ||
|
||
/// <summary> | ||
/// Validates if the invariants defined in the snapshot and differentials have a unique key. | ||
/// Duplicate keys can exist when the element paths are also the same (e.g. in slices). | ||
/// </summary> | ||
/// <param name="input"></param> | ||
/// <param name="state"></param> | ||
/// <returns></returns> | ||
private static IEnumerable<ResultReport> validateInvariantUniqueness(ITypedElement input, ValidationState state) | ||
{ | ||
var snapshotElements = input.Children("snapshot").SelectMany(c => c.Children("element")); | ||
var diffElements = input.Children("differential").SelectMany(c => c.Children("element")); | ||
|
||
var snapshotEvidence = validateInvariantUniqueness(snapshotElements); | ||
var diffEvidence = validateInvariantUniqueness(diffElements); | ||
|
||
return snapshotEvidence.Concat(diffEvidence).Select(i => i.AsResult(input, state)); | ||
} | ||
|
||
private static List<IssueAssertion> validateInvariantUniqueness(IEnumerable<ITypedElement> elements) | ||
{ | ||
//Selects the combination of key and elementDefintion path for the duplicate keys where the paths are not also the same. | ||
|
||
IEnumerable<(string Key, string Path)> PathsPerInvariantKey = elements | ||
.SelectMany(e => e.Children("constraint") | ||
.Select(c => (Key: c.Children("key") | ||
.Single().Value.ToString(), | ||
Path: e.Children("path") | ||
.Single().Value.ToString()))); | ||
|
||
IEnumerable<(string Key, IEnumerable<string> Paths)> PathsPerDuplicateInvariantKey = PathsPerInvariantKey.GroupBy(pair => pair.Key) | ||
.Select(group => (Key: group.Key, Paths: group.Select(pair => pair.Path) // select all paths, per invariant key | ||
.Distinct())) //Distinct to remove paths that are encountered multiple times per invariant | ||
.Where(kv => kv.Paths.Count() > 1); //Remove entries that only have a single path. These are not incorrect. | ||
|
||
return PathsPerDuplicateInvariantKey.Select(c => new IssueAssertion(Issue.PROFILE_ELEMENTDEF_INCORRECT, $"Duplicate key '{c.Key}' in paths: {string.Join(", ", c.Paths)}")).ToList(); | ||
} | ||
} | ||
} | ||
|
||
#nullable restore |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
105 changes: 105 additions & 0 deletions
105
...rely.Fhir.Validation.Compilation.Tests.Shared/StructureDefinitionSchemaValidationTests.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,105 @@ | ||
using Firely.Fhir.Validation.Compilation.Tests; | ||
using FluentAssertions; | ||
using Hl7.Fhir.ElementModel; | ||
using Hl7.Fhir.Model; | ||
using System.Linq; | ||
using Xunit; | ||
|
||
namespace Firely.Fhir.Validation.Tests.Impl | ||
{ | ||
public class StructureDefinitionSchemaTests : IClassFixture<SchemaBuilderFixture> | ||
{ | ||
internal SchemaBuilderFixture _fixture; | ||
|
||
public StructureDefinitionSchemaTests(SchemaBuilderFixture fixture) => _fixture = fixture; | ||
|
||
|
||
[Fact] | ||
public void ValidateElementDefinitioninProfileValueType() | ||
{ | ||
var structureDefSchema = _fixture.SchemaResolver.GetSchema("http://hl7.org/fhir/StructureDefinition/StructureDefinition"); | ||
|
||
var elementDef1 = new ElementDefinition | ||
{ | ||
Path = "Patient.gender", | ||
Constraint = new() | ||
{ | ||
new() | ||
{ | ||
Key = "key1", | ||
Expression = "foo.bar" | ||
}, | ||
new() | ||
{ | ||
Key = "key2", | ||
Expression = "bar.foo" | ||
} | ||
} | ||
}; | ||
var elementDef2 = new ElementDefinition | ||
{ | ||
Path = "Patient.gender", | ||
Constraint = new() | ||
{ | ||
new() | ||
{ | ||
Key = "key1", | ||
Expression = "foo.bar" | ||
}, | ||
} | ||
}; | ||
var elementDef3 = new ElementDefinition | ||
{ | ||
Path = "Patient.birthdate", | ||
Constraint = new() | ||
{ | ||
new() | ||
{ | ||
Key = "key2", | ||
Expression = "bar.foo" | ||
} | ||
} | ||
}; | ||
var elementDef4 = new ElementDefinition | ||
{ | ||
Path = "Patient.birthdate", | ||
Constraint = new() | ||
{ | ||
new() | ||
{ | ||
Key = "key4", | ||
Expression = "bar.foo" | ||
} | ||
} | ||
}; | ||
|
||
var profile = new StructureDefinition | ||
{ | ||
Snapshot = new() | ||
{ | ||
Element = new() { | ||
|
||
elementDef1, | ||
elementDef2, | ||
elementDef3, | ||
elementDef4 | ||
} | ||
}, | ||
Differential = new() | ||
{ | ||
Element = new() { | ||
|
||
elementDef1, | ||
elementDef2, | ||
elementDef3, | ||
elementDef4 | ||
} | ||
} | ||
}; | ||
|
||
var results = structureDefSchema!.Validate(profile.ToTypedElement(), _fixture.NewValidationContext()); | ||
|
||
results.Warnings.Select(w => w.Message).Should().Contain($"Duplicate key 'key2' in paths: Patient.gender, Patient.birthdate"); | ||
} | ||
} | ||
} |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Your new function already returns a list now, so, this should not be necessary anymore!