forked from Azure/bicep
-
Notifications
You must be signed in to change notification settings - Fork 0
/
OutputsTests.cs
255 lines (226 loc) · 9 KB
/
OutputsTests.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using System.Diagnostics.CodeAnalysis;
using Bicep.Core.Configuration;
using Bicep.Core.Diagnostics;
using Bicep.Core.IntegrationTests.Extensibility;
using Bicep.Core.TypeSystem.Types;
using Bicep.Core.UnitTests;
using Bicep.Core.UnitTests.Assertions;
using Bicep.Core.UnitTests.Utils;
using FluentAssertions;
using Microsoft.VisualStudio.TestTools.UnitTesting;
using Newtonsoft.Json.Linq;
namespace Bicep.Core.IntegrationTests
{
[TestClass]
public class OutputsTests
{
private ServiceBuilder ServicesWithResourceTyped => new ServiceBuilder()
.WithFeatureOverrides(new(TestContext, ResourceTypedParamsAndOutputsEnabled: true));
[NotNull]
public TestContext? TestContext { get; set; }
private ServiceBuilder ServicesWithExtensibility => new ServiceBuilder()
.WithFeatureOverrides(new(TestContext, ExtensibilityEnabled: true, ResourceTypedParamsAndOutputsEnabled: true))
.WithConfigurationPatch(c => c.WithProvidersConfiguration("""
{
"az": "builtin:",
"kubernetes": "builtin:",
"microsoftGraph": "builtin:",
"foo": "builtin:",
"bar": "builtin:"
}
"""))
.WithNamespaceProvider(new TestExtensibilityNamespaceProvider(BicepTestConstants.ResourceTypeProviderFactory));
[TestMethod]
public void Output_can_have_inferred_resource_type()
{
var result = CompilationHelper.Compile(ServicesWithResourceTyped,
"""
resource resource 'Microsoft.Storage/storageAccounts@2019-06-01' = {
name: 'test'
location: 'eastus'
kind: 'StorageV2'
sku: {
name: 'Standard_LRS'
}
identity: {
type: 'SystemAssigned'
}
properties:{
accessTier: 'Cool'
}
}
output out resource = resource
""");
result.ExcludingLinterDiagnostics().Should().NotHaveAnyDiagnostics();
var model = result.Compilation.GetEntrypointSemanticModel();
var @out = model.Root.OutputDeclarations.Should().ContainSingle().Subject;
var typeInfo = model.GetTypeInfo(@out.DeclaringSyntax);
typeInfo.Should().BeOfType<ResourceType>().Which.TypeReference.FormatName().Should().BeEquivalentTo("Microsoft.Storage/storageAccounts@2019-06-01");
result.Template.Should().HaveValueAtPath("$.outputs.out", new JObject()
{
["type"] = "string",
["value"] = "[resourceId('Microsoft.Storage/storageAccounts', 'test')]",
["metadata"] = new JObject()
{
["resourceType"] = new JValue("Microsoft.Storage/storageAccounts@2019-06-01"),
},
});
}
[TestMethod]
public void Output_can_have_specified_resource_type()
{
var result = CompilationHelper.Compile(ServicesWithResourceTyped,
"""
resource resource 'Microsoft.Storage/storageAccounts@2019-06-01' = {
name: 'test'
location: 'eastus'
kind: 'StorageV2'
sku: {
name: 'Standard_LRS'
}
identity: {
type: 'SystemAssigned'
}
properties:{
accessTier: 'Cool'
}
}
output out resource 'Microsoft.Storage/storageAccounts@2019-06-01' = resource
""");
result.ExcludingLinterDiagnostics().Should().NotHaveAnyDiagnostics();
var model = result.Compilation.GetEntrypointSemanticModel();
var @out = model.Root.OutputDeclarations.Should().ContainSingle().Subject;
var typeInfo = model.GetTypeInfo(@out.DeclaringSyntax);
typeInfo.Should().BeOfType<ResourceType>().Which.TypeReference.FormatName().Should().BeEquivalentTo("Microsoft.Storage/storageAccounts@2019-06-01");
result.Template.Should().HaveValueAtPath("$.outputs.out", new JObject()
{
["type"] = "string",
["value"] = "[resourceId('Microsoft.Storage/storageAccounts', 'test')]",
["metadata"] = new JObject()
{
["resourceType"] = new JValue("Microsoft.Storage/storageAccounts@2019-06-01"),
},
});
}
// Object-typed outputs should work the same way regardless of whether resource-typed outputs are enabled.
[DataTestMethod]
[DataRow(true)]
[DataRow(false)]
public void Output_can_have_object_type(bool enableResourceTypeParameters)
{
var services = enableResourceTypeParameters ? ServicesWithResourceTyped : new ServiceBuilder();
var result = CompilationHelper.Compile(services,
"""
resource resource 'Microsoft.Storage/storageAccounts@2019-06-01' = {
name: 'test'
location: 'eastus'
kind: 'StorageV2'
sku: {
name: 'Standard_LRS'
}
identity: {
type: 'SystemAssigned'
}
properties:{
accessTier: 'Cool'
}
}
output out object = resource
""");
result.ExcludingLinterDiagnostics().Should().NotHaveAnyDiagnostics();
result.Template.Should().HaveValueAtPath("$.outputs.out", new JObject()
{
["type"] = "object",
["value"] = "[reference(resourceId('Microsoft.Storage/storageAccounts', 'test'), '2019-06-01', 'full')]",
});
}
[TestMethod]
public void Output_can_have_decorators()
{
var result = CompilationHelper.Compile(ServicesWithResourceTyped,
"""
resource resource 'Microsoft.Storage/storageAccounts@2019-06-01' = {
name: 'test'
location: 'eastus'
kind: 'StorageV2'
sku: {
name: 'Standard_LRS'
}
identity: {
type: 'SystemAssigned'
}
properties:{
accessTier: 'Cool'
}
}
@description('cool beans')
output out resource 'Microsoft.Storage/storageAccounts@2019-06-01' = resource
""");
result.ExcludingLinterDiagnostics().Should().NotHaveAnyDiagnostics();
result.Template.Should().HaveValueAtPath("$.outputs.out", new JObject()
{
["type"] = "string",
["value"] = "[resourceId('Microsoft.Storage/storageAccounts', 'test')]",
["metadata"] = new JObject()
{
["resourceType"] = new JValue("Microsoft.Storage/storageAccounts@2019-06-01"),
["description"] = new JValue("cool beans"),
},
});
}
[TestMethod]
public void Output_can_have_warnings_for_missing_type()
{
var result = CompilationHelper.Compile(ServicesWithResourceTyped,
"""
resource resource 'Some.Fake/Type@2019-06-01' = {
name: 'test'
}
output out resource 'Some.Fake/Type@2019-06-01' = resource
""");
result.ExcludingLinterDiagnostics().Should().HaveDiagnostics(new[]
{
// There are two warnings because there are two places in code to correct the missing type.
("BCP081", DiagnosticLevel.Warning, "Resource type \"Some.Fake/Type@2019-06-01\" does not have types available. Bicep is unable to validate resource properties prior to deployment, but this will not block the resource from being deployed."),
("BCP081", DiagnosticLevel.Warning, "Resource type \"Some.Fake/Type@2019-06-01\" does not have types available. Bicep is unable to validate resource properties prior to deployment, but this will not block the resource from being deployed."),
});
}
[TestMethod]
public void Output_can_have_warnings_for_missing_type_but_we_dont_duplicate_them_when_type_is_inferred()
{
// As a special case we don't show a warning on the output when the type is inferred
// the user only has one location in code to correct.
var result = CompilationHelper.Compile(ServicesWithResourceTyped,
"""
resource resource 'Some.Fake/Type@2019-06-01' = {
name: 'test'
}
output out resource = resource
""");
result.ExcludingLinterDiagnostics().Should().HaveDiagnostics(new[]
{
("BCP081", DiagnosticLevel.Warning, "Resource type \"Some.Fake/Type@2019-06-01\" does not have types available. Bicep is unable to validate resource properties prior to deployment, but this will not block the resource from being deployed."),
});
}
[TestMethod]
public void Output_cannot_use_extensibility_resource_type()
{
var result = CompilationHelper.Compile(ServicesWithExtensibility,
"""
provider bar with {
connectionString: 'asdf'
} as stg
resource container 'stg:container' = {
name: 'myblob'
}
output out resource = container
""");
result.ExcludingLinterDiagnostics().Should().HaveDiagnostics(new[]
{
("BCP227", DiagnosticLevel.Error, "The type \"container\" cannot be used as a parameter or output type. Extensibility types are currently not supported as parameters or outputs."),
});
}
}
}