-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
mocks.ts
232 lines (198 loc) · 8.21 KB
/
mocks.ts
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
// Copyright 2016-2018, Pulumi Corporation.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
import { deserializeProperties, serializeProperties } from "./rpc";
import { getProject, getStack, setMockOptions } from "./settings";
const provproto = require("../proto/provider_pb.js");
const resproto = require("../proto/resource_pb.js");
const structproto = require("google-protobuf/google/protobuf/struct_pb.js");
/**
* MockResourceArgs is a used to construct a newResource Mock
*/
export interface MockResourceArgs {
/**
* The token that indicates which resource type is being constructed. This token is of the form "package:module:type".
*/
type: string;
/**
* The logical name of the resource instance.
*/
name: string;
/**
* The inputs for the resource.
*/
inputs: any;
/**
* If provided, the identifier of the provider instance being used to manage this resource.
*/
provider?: string;
/**
* Specifies whether or not the resource is Custom (i.e. managed by a resource provider).
*/
custom?: boolean;
/**
* If provided, the physical identifier of an existing resource to read or import.
*/
id?: string;
}
/**
* MockResourceArgs is used to construct call Mock
*/
export interface MockCallArgs {
/**
* The token that indicates which function is being called. This token is of the form "package:module:function".
*/
token: string;
/**
* The arguments provided to the function call.
*/
inputs: any;
/**
* If provided, the identifier of the provider instance being used to make the call.
*/
provider?: string;
}
/**
* Mocks is an abstract class that allows subclasses to replace operations normally implemented by the Pulumi engine with
* their own implementations. This can be used during testing to ensure that calls to provider functions and resource constructors
* return predictable values.
*/
export interface Mocks {
/**
* Mocks provider-implemented function calls (e.g. aws.get_availability_zones).
*
* @param args: MockCallArgs
*/
call(args: MockCallArgs): Record<string, any>;
/**
* Mocks resource construction calls. This function should return the physical identifier and the output properties
* for the resource being constructed.
* @param args: MockResourceArgs
*/
newResource(args: MockResourceArgs): { id: string | undefined; state: Record<string, any> };
}
export class MockMonitor {
readonly resources = new Map<string, { urn: string; id: string | undefined; state: any }>();
constructor(readonly mocks: Mocks) {
}
private newUrn(parent: string, type: string, name: string): string {
if (parent) {
const qualifiedType = parent.split("::")[2];
const parentType = qualifiedType.split("$").pop();
type = parentType + "$" + type;
}
return "urn:pulumi:" + [getStack(), getProject(), type, name].join("::");
}
public async invoke(req: any, callback: (err: any, innerResponse: any) => void) {
try {
const tok = req.getTok();
const inputs = deserializeProperties(req.getArgs());
if (tok === "pulumi:pulumi:getResource") {
const registeredResource = this.resources.get(inputs.urn);
if (!registeredResource) {
throw new Error(`unknown resource ${inputs.urn}`);
}
const resp = new provproto.InvokeResponse();
resp.setReturn(structproto.Struct.fromJavaScript(registeredResource));
callback(null, resp);
return;
}
const result = this.mocks.call({
token: tok,
inputs: inputs,
provider: req.getProvider(),
});
const response = new provproto.InvokeResponse();
response.setReturn(structproto.Struct.fromJavaScript(await serializeProperties("", result)));
callback(null, response);
} catch (err) {
callback(err, undefined);
}
}
public async readResource(req: any, callback: (err: any, innterResponse: any) => void) {
try {
const result = this.mocks.newResource({
type: req.getType(),
name: req.getName(),
inputs: deserializeProperties(req.getProperties()),
provider: req.getProvider(),
custom: req.getCustom(),
id: req.getId(),
});
const urn = this.newUrn(req.getParent(), req.getType(), req.getName());
const serializedState = await serializeProperties("", result.state);
this.resources.set(urn, { urn, id: result.id, state: serializedState });
const response = new resproto.ReadResourceResponse();
response.setUrn(urn);
response.setProperties(structproto.Struct.fromJavaScript(serializedState));
callback(null, response);
} catch (err) {
callback(err, undefined);
}
}
public async registerResource(req: any, callback: (err: any, innerResponse: any) => void) {
try {
const result = this.mocks.newResource({
type: req.getType(),
name: req.getName(),
inputs: deserializeProperties(req.getObject()),
provider: req.getProvider(),
custom: req.getCustom(),
id: req.getImportid(),
});
const urn = this.newUrn(req.getParent(), req.getType(), req.getName());
const serializedState = await serializeProperties("", result.state);
this.resources.set(urn, { urn, id: result.id, state: serializedState });
const response = new resproto.RegisterResourceResponse();
response.setUrn(urn);
response.setId(result.id);
response.setObject(structproto.Struct.fromJavaScript(serializedState));
callback(null, response);
} catch (err) {
callback(err, undefined);
}
}
public registerResourceOutputs(req: any, callback: (err: any, innerResponse: any) => void) {
try {
const registeredResource = this.resources.get(req.getUrn());
if (!registeredResource) {
throw new Error(`unknown resource ${req.getUrn()}`);
}
registeredResource.state = req.getOutputs();
callback(null, {});
} catch (err) {
callback(err, undefined);
}
}
public supportsFeature(req: any, callback: (err: any, innerResponse: any) => void) {
const id = req.getId();
// Support for "outputValues" is deliberately disabled for the mock monitor so
// instances of `Output` don't show up in `MockResourceArgs` inputs.
const hasSupport = id === "secrets" || id === "resourceReferences";
callback(null, {
getHassupport: () => hasSupport,
});
}
}
/**
* setMocks configures the Pulumi runtime to use the given mocks for testing.
*
* @param mocks: The mocks to use for calls to provider functions and resource consrtuction.
* @param project: If provided, the name of the Pulumi project. Defaults to "project".
* @param stack: If provided, the name of the Pulumi stack. Defaults to "stack".
* @param preview: If provided, indicates whether or not the program is running a preview. Defaults to false.
* @param organization: If provided, the name of the Pulumi organization. Defaults to nothing.
*/
export function setMocks(mocks: Mocks, project?: string, stack?: string, preview?: boolean, organization?: string) {
setMockOptions(new MockMonitor(mocks), project, stack, preview, organization);
}