public void Casing_issues_are_corrected()
{
var bicepFile = @"
resource resA 'My.Rp/resA@2020-01-01' = {
name: 'resA'
properties: {
lowerCaseProp: 'abc'
camelcaseprop: 'def'
'lowerCaseQuoted=+.Prop': 'ghi'
'camelcasequoted=+.prop': 'jkl'
lowerCaseEnumProp: 'MyEnum'
pascalCaseEnumProp: 'myenum'
lowerCaseEnumUnionProp: 'MyEnum'
pascalCaseEnumUnionProp: 'myenum'
}
}
output myObj object = {
lowerCaseProp: resA.properties.lowerCaseProp
camelcaseprop: resA.properties.camelcaseprop
}
";
var typeDefinition = ResourceTypeProviderHelper.CreateCustomResourceType("My.Rp/resA", "2020-01-01", TypeSymbolValidationFlags.WarnOnTypeMismatch,
new TypeProperty("lowercaseprop", LanguageConstants.String),
new TypeProperty("camelCaseProp", LanguageConstants.String),
new TypeProperty("lowercasequoted=+.prop", LanguageConstants.String),
new TypeProperty("camelCaseQuoted=+.Prop", LanguageConstants.String),
new TypeProperty("lowerCaseEnumProp", new StringLiteralType("myenum")),
new TypeProperty("pascalCaseEnumProp", new StringLiteralType("MyEnum")),
new TypeProperty("lowerCaseEnumUnionProp", UnionType.Create(new StringLiteralType("myenum"), new StringLiteralType("blahblah"))),
new TypeProperty("pascalCaseEnumUnionProp", UnionType.Create(new StringLiteralType("MyEnum"), new StringLiteralType("BlahBlah"))));
var typeProvider = ResourceTypeProviderHelper.CreateMockTypeProvider(typeDefinition.AsEnumerable());
var(_, _, compilation) = CompilationHelper.Compile(typeProvider, ("main.bicep", bicepFile));
var rewriter = new TypeCasingFixerRewriter(compilation.GetEntrypointSemanticModel());
var newProgramSyntax = rewriter.Rewrite(compilation.SyntaxTreeGrouping.EntryPoint.ProgramSyntax);
PrintHelper.PrettyPrint(newProgramSyntax).Should().Be(
@"resource resA 'My.Rp/resA@2020-01-01' = {
name: 'resA'
properties: {
lowercaseprop: 'abc'
camelCaseProp: 'def'
'lowercasequoted=+.prop': 'ghi'
'camelCaseQuoted=+.Prop': 'jkl'
lowerCaseEnumProp: 'myenum'
pascalCaseEnumProp: 'MyEnum'
lowerCaseEnumUnionProp: 'myenum'
pascalCaseEnumUnionProp: 'MyEnum'
}
}
output myObj object = {
lowerCaseProp: resA.properties.lowercaseprop
camelcaseprop: resA.properties.camelCaseProp
}");
}
private static SemanticModel GetSemanticModelForTest(string programText, IEnumerable <ResourceType> definedTypes)
{
var typeProvider = ResourceTypeProviderHelper.CreateMockTypeProvider(definedTypes);
var compilation = new Compilation(typeProvider, SyntaxFactory.CreateFromText(programText));
return(compilation.GetEntrypointSemanticModel());
}
public void Type_validation_runs_on_compilation_successfully(TypeSymbolValidationFlags validationFlags, DiagnosticLevel expectedDiagnosticLevel)
{
var customTypes = new [] {
ResourceTypeProviderHelper.CreateCustomResourceType("My.Rp/myType", "2020-01-01", validationFlags),
};
var program = @"
resource myRes 'My.Rp/myType@2020-01-01' = {
name: 'steve'
properties: { }
}
";
var model = GetSemanticModelForTest(program, customTypes);
model.GetAllDiagnostics().Should().BeEmpty();
}
public void Existing_resources_can_be_referenced_at_other_scopes()
{
var typeName = "My.Rp/myResource@2020-01-01";
var typeProvider = ResourceTypeProviderHelper.CreateAzResourceTypeProvider(factory => {
var stringType = factory.Create(() => new Azure.Bicep.Types.Concrete.BuiltInType(BuiltInTypeKind.String));
var objectType = factory.Create(() => new Azure.Bicep.Types.Concrete.ObjectType(typeName, new Dictionary <string, ObjectProperty> {
["name"] = new ObjectProperty(factory.GetReference(stringType), ObjectPropertyFlags.DeployTimeConstant),
["kind"] = new ObjectProperty(factory.GetReference(stringType), ObjectPropertyFlags.ReadOnly),
}, null));
var resourceType = factory.Create(() => new Azure.Bicep.Types.Concrete.ResourceType(typeName, ScopeType.ResourceGroup, factory.GetReference(objectType)));
});
// explicitly pass a valid scope
var(template, _, _) = CompilationHelper.Compile(typeProvider, ("main.bicep", @"
resource resourceA 'My.Rp/myResource@2020-01-01' existing = {
name: 'resourceA'
scope: resourceGroup()
}
output resourceARef string = resourceA.kind
"));
template !.Should().NotBeNull();
using (new AssertionScope())
{
template !.SelectToken("$.outputs['resourceARef'].value") !.Should().DeepEqual("[reference(extensionResourceId(resourceGroup().id, 'My.Rp/myResource', 'resourceA'), '2020-01-01', 'full').kind]");
}
// use a valid targetScope without setting the scope property
(template, _, _) = CompilationHelper.Compile(typeProvider, ("main.bicep", @"
targetScope = 'resourceGroup'
resource resourceA 'My.Rp/myResource@2020-01-01' existing = {
name: 'resourceA'
}
output resourceARef string = resourceA.kind
"));
template !.Should().NotBeNull();
using (new AssertionScope())
{
template !.SelectToken("$.outputs['resourceARef'].value") !.Should().DeepEqual("[reference(resourceId('My.Rp/myResource', 'resourceA'), '2020-01-01', 'full').kind]");
}
}
public void Type_validation_narrowing_on_union_types(TypeSymbolValidationFlags validationFlags, DiagnosticLevel expectedDiagnosticLevel)
{
var customTypes = new [] {
ResourceTypeProviderHelper.CreateCustomResourceType("My.Rp/myType", "2020-01-01", validationFlags,
new TypeProperty("stringOrInt", UnionType.Create(LanguageConstants.String, LanguageConstants.Int)),
new TypeProperty("unspecifiedStringOrInt", UnionType.Create(LanguageConstants.String, LanguageConstants.Int)),
new TypeProperty("abcOrDef", UnionType.Create(new StringLiteralType("abc"), new StringLiteralType("def"))),
new TypeProperty("unspecifiedAbcOrDef", UnionType.Create(new StringLiteralType("abc"), new StringLiteralType("def")))),
ResourceTypeProviderHelper.CreateCustomResourceType("My.Rp/myDependentType", "2020-01-01", validationFlags,
new TypeProperty("stringOnly", LanguageConstants.String),
new TypeProperty("abcOnly", new StringLiteralType("abc")),
new TypeProperty("abcOnlyUnNarrowed", new StringLiteralType("abc")),
new TypeProperty("stringOrIntUnNarrowed", UnionType.Create(LanguageConstants.String, LanguageConstants.Int)),
new TypeProperty("abcOrDefUnNarrowed", UnionType.Create(new StringLiteralType("abc"), new StringLiteralType("def"), new StringLiteralType("ghi")))),
};
var program = @"
resource myRes 'My.Rp/myType@2020-01-01' = {
name: 'steve'
properties: {
stringOrInt: 'abc'
abcOrDef: 'abc'
}
}
resource myDependentRes 'My.Rp/myDependentType@2020-01-01' = {
name: 'steve'
properties: {
stringOnly: myRes.properties.stringOrInt // should be allowed
abcOnly: myRes.properties.abcOrDef
abcOnlyUnNarrowed: myRes.properties.unspecifiedAbcOrDef
stringOrIntUnNarrowed: myRes.properties.unspecifiedStringOrInt
abcOrDefUnNarrowed: myRes.properties.abcOrDef
}
}
";
var model = GetSemanticModelForTest(program, customTypes);
model.GetAllDiagnostics().Should().SatisfyRespectively(
x => x.Should().HaveCodeAndSeverity("BCP036", expectedDiagnosticLevel).And.HaveMessage("The property \"abcOnlyUnNarrowed\" expected a value of type \"'abc'\" but the provided value is of type \"'abc' | 'def'\".")
);
}
public void Errors_are_raised_for_existing_resources_at_invalid_scopes()
{
var typeName = "My.Rp/myResource@2020-01-01";
var typeProvider = ResourceTypeProviderHelper.CreateAzResourceTypeProvider(factory => {
var stringType = factory.Create(() => new Azure.Bicep.Types.Concrete.BuiltInType(BuiltInTypeKind.String));
var objectType = factory.Create(() => new Azure.Bicep.Types.Concrete.ObjectType(typeName, new Dictionary <string, ObjectProperty> {
["name"] = new ObjectProperty(factory.GetReference(stringType), ObjectPropertyFlags.DeployTimeConstant),
}, null));
var resourceType = factory.Create(() => new Azure.Bicep.Types.Concrete.ResourceType(typeName, ScopeType.ResourceGroup, factory.GetReference(objectType)));
});
// explicitly pass an invalid scope
var(_, diags, _) = CompilationHelper.Compile(typeProvider, ("main.bicep", @"
resource resourceA 'My.Rp/myResource@2020-01-01' existing = {
name: 'resourceA'
scope: subscription()
}
"));
diags.Should().HaveDiagnostics(new[] {
public void Type_validation_runs_on_compilation_common_failures(TypeSymbolValidationFlags validationFlags, DiagnosticLevel expectedDiagnosticLevel)
{
var customTypes = new [] {
ResourceTypeProviderHelper.CreateCustomResourceType("My.Rp/myType", "2020-01-01", validationFlags,
new TypeProperty("readOnlyProp", LanguageConstants.String, TypePropertyFlags.ReadOnly),
new TypeProperty("writeOnlyProp", LanguageConstants.String, TypePropertyFlags.WriteOnly),
new TypeProperty("requiredProp", LanguageConstants.String, TypePropertyFlags.Required),
new TypeProperty("additionalProps", new NamedObjectType(
"additionalProps",
validationFlags,
new [] {
new TypeProperty("propA", LanguageConstants.String, TypePropertyFlags.Required),
new TypeProperty("propB", LanguageConstants.String),
},
LanguageConstants.Int
)),
new TypeProperty("nestedObj", new NamedObjectType(
"nestedObj",
validationFlags,
new [] {
new TypeProperty("readOnlyNestedProp", LanguageConstants.String, TypePropertyFlags.ReadOnly),
new TypeProperty("writeOnlyNestedProp", LanguageConstants.String, TypePropertyFlags.WriteOnly),
new TypeProperty("requiredNestedProp", LanguageConstants.String, TypePropertyFlags.Required),
},
null
))),
};
var program = @"
resource myRes 'My.Rp/myType@2020-01-01' = {
name: 'steve'
properties: {
readOnlyProp: 123
writeOnlyProp: 456
additionalProps: {
propB: 123
}
nestedObj: {
readOnlyNestedProp: 123
writeOnlyNestedProp: 456
}
}
}
output writeOnlyOutput string = myRes.properties.writeOnlyProp
output writeOnlyOutput2 string = myRes.properties.nestedObj.writeOnlyProp
output missingOutput string = myRes.properties.missingOutput
output missingOutput2 string = myRes.properties.nestedObj.missingOutput
output incorrectTypeOutput int = myRes.properties.readOnlyProp
output incorrectTypeOutput2 int = myRes.properties.nestedObj.readOnlyProp
";
var model = GetSemanticModelForTest(program, customTypes);
model.GetAllDiagnostics().Should().SatisfyRespectively(
x => x.Should().HaveCodeAndSeverity("BCP035", expectedDiagnosticLevel).And.HaveMessage("The specified \"object\" declaration is missing the following required properties: \"requiredProp\"."),
x => x.Should().HaveCodeAndSeverity("BCP073", expectedDiagnosticLevel).And.HaveMessage("The property \"readOnlyProp\" is read-only. Expressions cannot be assigned to read-only properties."),
x => x.Should().HaveCodeAndSeverity("BCP036", expectedDiagnosticLevel).And.HaveMessage("The property \"writeOnlyProp\" expected a value of type \"string\" but the provided value is of type \"int\"."),
x => x.Should().HaveCodeAndSeverity("BCP035", expectedDiagnosticLevel).And.HaveMessage("The specified \"object\" declaration is missing the following required properties: \"propA\"."),
x => x.Should().HaveCodeAndSeverity("BCP036", expectedDiagnosticLevel).And.HaveMessage("The property \"propB\" expected a value of type \"string\" but the provided value is of type \"int\"."),
x => x.Should().HaveCodeAndSeverity("BCP035", expectedDiagnosticLevel).And.HaveMessage("The specified \"object\" declaration is missing the following required properties: \"requiredNestedProp\"."),
x => x.Should().HaveCodeAndSeverity("BCP073", expectedDiagnosticLevel).And.HaveMessage("The property \"readOnlyNestedProp\" is read-only. Expressions cannot be assigned to read-only properties."),
x => x.Should().HaveCodeAndSeverity("BCP036", expectedDiagnosticLevel).And.HaveMessage("The property \"writeOnlyNestedProp\" expected a value of type \"string\" but the provided value is of type \"int\"."),
x => x.Should().HaveCodeAndSeverity("BCP077", expectedDiagnosticLevel).And.HaveMessage("The property \"writeOnlyProp\" on type \"properties\" is write-only. Write-only properties cannot be accessed."),
x => x.Should().HaveCodeAndSeverity("BCP053", expectedDiagnosticLevel).And.HaveMessage("The type \"nestedObj\" does not contain property \"writeOnlyProp\". Available properties include \"readOnlyNestedProp\", \"requiredNestedProp\"."),
x => x.Should().HaveCodeAndSeverity("BCP053", expectedDiagnosticLevel).And.HaveMessage("The type \"properties\" does not contain property \"missingOutput\". Available properties include \"additionalProps\", \"nestedObj\", \"readOnlyProp\", \"requiredProp\"."),
x => x.Should().HaveCodeAndSeverity("BCP053", expectedDiagnosticLevel).And.HaveMessage("The type \"nestedObj\" does not contain property \"missingOutput\". Available properties include \"readOnlyNestedProp\", \"requiredNestedProp\"."),
x => x.Should().HaveCodeAndSeverity("BCP026", DiagnosticLevel.Error).And.HaveMessage("The output expects a value of type \"int\" but the provided value is of type \"string\"."),
x => x.Should().HaveCodeAndSeverity("BCP053", expectedDiagnosticLevel).And.HaveMessage("The type \"nestedObj\" does not contain property \"readOnlyProp\". Available properties include \"readOnlyNestedProp\", \"requiredNestedProp\".")
);
}
public void Type_validation_narrowing_on_discriminated_object_types(TypeSymbolValidationFlags validationFlags, DiagnosticLevel expectedDiagnosticLevel)
{
var customTypes = new [] {
ResourceTypeProviderHelper.CreateCustomResourceType("My.Rp/myType", "2020-01-01", validationFlags,
new TypeProperty("myDisc1", new DiscriminatedObjectType("myDisc1", validationFlags, "discKey", new [] {
new NamedObjectType("choiceA", validationFlags, new [] {
new TypeProperty("discKey", new StringLiteralType("choiceA"), TypePropertyFlags.Required),
new TypeProperty("valueA", LanguageConstants.String, TypePropertyFlags.Required),
}, null),
new NamedObjectType("choiceB", validationFlags, new [] {
new TypeProperty("discKey", new StringLiteralType("choiceB"), TypePropertyFlags.Required),
new TypeProperty("valueB", LanguageConstants.String, TypePropertyFlags.Required),
}, null),
}
))),
};
{
// missing discriminator key
var program = @"
resource myRes 'My.Rp/myType@2020-01-01' = {
name: 'steve'
properties: {
myDisc1: {
valueA: 'abc'
}
}
}
";
var model = GetSemanticModelForTest(program, customTypes);
model.GetAllDiagnostics().Should().SatisfyRespectively(
x => x.Should().HaveCodeAndSeverity("BCP078", expectedDiagnosticLevel).And.HaveMessage("The property \"discKey\" requires a value of type \"'choiceA' | 'choiceB'\", but none was supplied.")
);
}
{
// incorrect discriminator key case
var program = @"
resource myRes 'My.Rp/myType@2020-01-01' = {
name: 'steve'
properties: {
myDisc1: {
DiscKey: 'choiceA'
}
}
}
";
var model = GetSemanticModelForTest(program, customTypes);
model.GetAllDiagnostics().Should().SatisfyRespectively(
x => x.Should().HaveCodeAndSeverity("BCP078", expectedDiagnosticLevel).And.HaveMessage("The property \"discKey\" requires a value of type \"'choiceA' | 'choiceB'\", but none was supplied."),
x => x.Should().HaveCodeAndSeverity("BCP089", expectedDiagnosticLevel).And.HaveMessage("The property \"DiscKey\" is not allowed on objects of type \"'choiceA' | 'choiceB'\". Did you mean \"discKey\"?")
);
}
{
// incorrect discriminator key
var program = @"
resource myRes 'My.Rp/myType@2020-01-01' = {
name: 'steve'
properties: {
myDisc1: {
discKey: 'foo'
}
}
}
";
var model = GetSemanticModelForTest(program, customTypes);
model.GetAllDiagnostics().Should().SatisfyRespectively(
x => x.Should().HaveCodeAndSeverity("BCP036", expectedDiagnosticLevel).And.HaveMessage("The property \"discKey\" expected a value of type \"'choiceA' | 'choiceB'\" but the provided value is of type \"'foo'\".")
);
}
{
// incorrect discriminator key with suggestion
var program = @"
resource myRes 'My.Rp/myType@2020-01-01' = {
name: 'steve'
properties: {
myDisc1: {
discKey: 'choiceC'
}
}
}
";
var model = GetSemanticModelForTest(program, customTypes);
model.GetAllDiagnostics().Should().SatisfyRespectively(
x => x.Should().HaveCodeAndSeverity("BCP088", expectedDiagnosticLevel).And.HaveMessage("The property \"discKey\" expected a value of type \"'choiceA' | 'choiceB'\" but the provided value is of type \"'choiceC'\". Did you mean \"'choiceA'\"?")
);
}
{
// discriminator key supplied, required value omitted
var program = @"
resource myRes 'My.Rp/myType@2020-01-01' = {
name: 'steve'
properties: {
myDisc1: {
discKey: 'choiceA'
}
}
}
";
var model = GetSemanticModelForTest(program, customTypes);
model.GetAllDiagnostics().Should().SatisfyRespectively(
x => x.Should().HaveCodeAndSeverity("BCP035", expectedDiagnosticLevel).And.HaveMessage("The specified \"object\" declaration is missing the following required properties: \"valueA\".")
);
}
{
// discriminator key supplied, case of required property is incorrect
var program = @"
resource myRes 'My.Rp/myType@2020-01-01' = {
name: 'steve'
properties: {
myDisc1: {
discKey: 'choiceA'
ValueA: 'hello'
}
}
}
";
var model = GetSemanticModelForTest(program, customTypes);
model.GetAllDiagnostics().Should().SatisfyRespectively(
x => x.Should().HaveCodeAndSeverity("BCP035", expectedDiagnosticLevel).And.HaveMessage("The specified \"object\" declaration is missing the following required properties: \"valueA\"."),
x => x.Should().HaveCodeAndSeverity("BCP089", expectedDiagnosticLevel).And.HaveMessage("The property \"ValueA\" is not allowed on objects of type \"choiceA\". Did you mean \"valueA\"?")
);
}
{
// all good, incorrect property access
var program = @"
resource myRes 'My.Rp/myType@2020-01-01' = {
name: 'steve'
properties: {
myDisc1: {
discKey: 'choiceA'
valueA: 'hello'
}
}
}
output valueA string = myRes.properties.myDisc1.valueA
output valueB string = myRes.properties.myDisc1.valuuuueB
";
var model = GetSemanticModelForTest(program, customTypes);
model.GetAllDiagnostics().Should().SatisfyRespectively(
x => x.Should().HaveCodeAndSeverity("BCP053", expectedDiagnosticLevel).And.HaveMessage("The type \"choiceA\" does not contain property \"valuuuueB\". Available properties include \"discKey\", \"valueA\".")
);
}
{
// all good, incorrect property access with suggestion
var program = @"
resource myRes 'My.Rp/myType@2020-01-01' = {
name: 'steve'
properties: {
myDisc1: {
discKey: 'choiceA'
valueA: 'hello'
}
}
}
output valueA string = myRes.properties.myDisc1.valueA
output valueB string = myRes.properties.myDisc1.valueB
";
var model = GetSemanticModelForTest(program, customTypes);
model.GetAllDiagnostics().Should().SatisfyRespectively(
x => x.Should().HaveCodeAndSeverity("BCP083", expectedDiagnosticLevel).And.HaveMessage("The type \"choiceA\" does not contain property \"valueB\". Did you mean \"valueA\"?")
);
}
}
public void Nested_casing_issues_take_multiple_passes_to_correct()
{
var bicepFile = @"
resource resA 'My.Rp/resA@2020-01-01' = {
name: 'resA'
properties: {
lowerCaseObj: {
lowerCaseStr: 'test'
}
}
}
output myObj object = {
lowerCaseProp: resA.properties.lowerCaseObj.lowerCaseStr
}
";
var typeDefinition = ResourceTypeProviderHelper.CreateCustomResourceType("My.Rp/resA", "2020-01-01", TypeSymbolValidationFlags.WarnOnTypeMismatch,
new TypeProperty("lowercaseobj", new NamedObjectType("lowercaseobj", TypeSymbolValidationFlags.Default, new [] {
new TypeProperty("lowercasestr", LanguageConstants.String)
}, null)));
var typeProvider = ResourceTypeProviderHelper.CreateMockTypeProvider(typeDefinition.AsEnumerable());
var(_, _, compilation) = CompilationHelper.Compile(typeProvider, ("main.bicep", bicepFile));
var rewriter = new TypeCasingFixerRewriter(compilation.GetEntrypointSemanticModel());
var newProgramSyntax = rewriter.Rewrite(compilation.SyntaxTreeGrouping.EntryPoint.ProgramSyntax);
var firstPassBicepFile = PrintHelper.PrettyPrint(newProgramSyntax);
firstPassBicepFile.Should().Be(
@"resource resA 'My.Rp/resA@2020-01-01' = {
name: 'resA'
properties: {
lowercaseobj: {
lowerCaseStr: 'test'
}
}
}
output myObj object = {
lowerCaseProp: resA.properties.lowercaseobj.lowerCaseStr
}");
(_, _, compilation) = CompilationHelper.Compile(typeProvider, ("main.bicep", firstPassBicepFile));
rewriter = new TypeCasingFixerRewriter(compilation.GetEntrypointSemanticModel());
newProgramSyntax = rewriter.Rewrite(compilation.SyntaxTreeGrouping.EntryPoint.ProgramSyntax);
PrintHelper.PrettyPrint(newProgramSyntax).Should().Be(
@"resource resA 'My.Rp/resA@2020-01-01' = {
name: 'resA'
properties: {
lowercaseobj: {
lowercasestr: 'test'
}
}
}
output myObj object = {
lowerCaseProp: resA.properties.lowercaseobj.lowercasestr
}");
}
