Skip to content

Fix diagnostic locations for inherited bicepparam values #20085

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
Engin Polat (polatengin) wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Fix diagnostic locations for inherited bicepparam values #20085

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a266b9a
test: add diagnostics for invalid inherited user-defined type in exte…
polatengin Jul 23, 2026
0cfa4ba
test: add validation for inherited user-defined type compilation
polatengin Jul 23, 2026
0418b7c
test: add validation for error severity in invalid inherited user-def…
polatengin Jul 23, 2026
b224aa6
test: add diagnostic for nested invalid inherited user-defined type o…
polatengin Jul 23, 2026
147b40e
fix: correct severity and message for invalid UDT parameter in extend…
polatengin Jul 23, 2026
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
154 changes: 154 additions & 0 deletions src/Bicep.Core.IntegrationTests/ParametersTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -419,6 +419,160 @@ public void Valid_extends_should_not_fail()
result.ExcludingLinterDiagnostics().Should().NotHaveAnyDiagnostics();
}

[TestMethod]
public void Invalid_inherited_user_defined_type_should_report_diagnostics_on_extends_path()
{
var result = CompilationHelper.CompileParams(
("parameters.bicepparam", """
using 'main.bicep'
extends 'shared.bicepparam'
"""),
("shared.bicepparam", """
using none

param person = {
test: 'testing'
}
"""),
("main.bicep", """
param person personType

type personType = {
name: string
age: int
address: string
}
"""));

var extendsPath = result.Compilation.GetEntrypointSemanticModel().SourceFile.ProgramSyntax.Declarations
.OfType<ExtendsDeclarationSyntax>()
.Single()
.Path;
var diagnostics = result.ExcludingLinterDiagnostics().Diagnostics.ToArray();

diagnostics.Should().HaveDiagnostics([
("BCP035", DiagnosticLevel.Error, "The specified \"param\" declaration is missing the following required properties: \"address\", \"age\", \"name\"."),
("BCP037", DiagnosticLevel.Warning, "The property \"test\" is not allowed on objects of type \"{ name: string, age: int, address: string }\". Permissible properties include \"address\", \"age\", \"name\"."),
]);
diagnostics.Should().AllSatisfy(diagnostic =>
{
diagnostic.Span.Should().Be(extendsPath.Span);
diagnostic.Should().BeOfType<Diagnostic>().Which.Fixes.Should().BeEmpty();
});
}

[TestMethod]
public void Valid_inherited_user_defined_type_should_compile()
{
var result = CompilationHelper.CompileParams(
("parameters.bicepparam", """
using 'main.bicep'
extends 'shared.bicepparam'
"""),
("shared.bicepparam", """
using none

param person = {
name: 'Ada'
age: 36
address: 'London'
}
"""),
("main.bicep", """
param person personType

type personType = {
name: string
age: int
address: string
}
"""));

result.ExcludingLinterDiagnostics().Should().NotHaveAnyDiagnostics();
result.Parameters.Should().HaveJsonAtPath("parameters.person.value", """
{
"name": "Ada",
"age": 36,
"address": "London"
}
""");
}

[TestMethod]
public void Sealed_invalid_inherited_user_defined_type_should_preserve_error_severity()
{
var result = CompilationHelper.CompileParams(
("parameters.bicepparam", """
using 'main.bicep'
extends 'shared.bicepparam'
"""),
("shared.bicepparam", """
using none

param person = {
test: 'testing'
}
"""),
("main.bicep", """
param person personType

@sealed()
type personType = {
name: string
}
"""));

var extendsPath = result.Compilation.GetEntrypointSemanticModel().SourceFile.ProgramSyntax.Declarations
.OfType<ExtendsDeclarationSyntax>()
.Single()
.Path;
var diagnostics = result.ExcludingLinterDiagnostics().Diagnostics.ToArray();

diagnostics.Should().HaveDiagnostics([
("BCP035", DiagnosticLevel.Error, "The specified \"param\" declaration is missing the following required properties: \"name\"."),
("BCP037", DiagnosticLevel.Error, "The property \"test\" is not allowed on objects of type \"{ name: string }\". Permissible properties include \"name\"."),
]);
diagnostics.Should().AllSatisfy(diagnostic => diagnostic.Span.Should().Be(extendsPath.Span));
}

[TestMethod]
public void Nested_invalid_inherited_user_defined_type_should_report_diagnostic_on_direct_extends_path()
{
var result = CompilationHelper.CompileParams(
("parameters.bicepparam", """
using 'main.bicep'
extends 'middle.bicepparam'
"""),
("middle.bicepparam", """
using none
extends 'base.bicepparam'
"""),
("base.bicepparam", """
using none

param person = {
name: 42
}
"""),
("main.bicep", """
param person personType

type personType = {
name: string
}
"""));

var extendsPath = result.Compilation.GetEntrypointSemanticModel().SourceFile.ProgramSyntax.Declarations
.OfType<ExtendsDeclarationSyntax>()
.Single()
.Path;
var diagnostic = result.ExcludingLinterDiagnostics().Diagnostics.Should().ContainSingle().Subject;

diagnostic.Should().HaveCodeAndSeverity("BCP036", DiagnosticLevel.Error)
.And.HaveMessage("The property \"name\" expected a value of type \"string\" but the provided value is of type \"42\".");
diagnostic.Span.Should().Be(extendsPath.Span);
}

[TestMethod]
public void Invalid_extends_reference_does_not_exist_should_fail()
{
Expand Down
6 changes: 5 additions & 1 deletion src/Bicep.Core/Semantics/SemanticModel.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -706,6 +706,8 @@ private IEnumerable<IDiagnostic> GatherMissingRequiredExtensionConfigAssignmentD

private IEnumerable<IDiagnostic> GatherTypeMismatchDiagnostics()
{
var extendsPath = SourceFile.ProgramSyntax.Declarations.OfType<ExtendsDeclarationSyntax>().FirstOrDefault()?.Path;

foreach (var assignmentSymbol in Root.ParameterAssignments)
{
var isFromSameFile = assignmentSymbol.Context.SourceFile == Root.Context.SourceFile;
Expand Down Expand Up @@ -733,7 +735,9 @@ private IEnumerable<IDiagnostic> GatherTypeMismatchDiagnostics()

foreach (var diagnostic in diagnostics.GetDiagnostics())
{
yield return diagnostic;
yield return !isFromSameFile && extendsPath is not null && diagnostic is Diagnostic concreteDiagnostic
? concreteDiagnostic with { Span = extendsPath.Span, Fixes = [] }
: diagnostic;
}
}
}
Expand Down
Loading