/
common.ts
152 lines (145 loc) · 3.46 KB
/
common.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
import { CustomResource } from 'aws-cdk-lib/core';
import { IApiCall } from './api-call-base';
/**
* Represents the "actual" results to compare
*/
export abstract class ActualResult {
/**
* Get the actual results from a CustomResource
*/
public static fromCustomResource(customResource: CustomResource, attribute: string): ActualResult {
return {
result: customResource.getAttString(attribute),
};
}
/**
* Get the actual results from a AwsApiCall
*/
public static fromAwsApiCall(query: IApiCall, attribute: string): ActualResult {
return {
result: query.getAttString(attribute),
};
}
/**
* The actual results as a string
*/
public abstract result: string;
}
/**
* Represents the "expected" results to compare
*/
export abstract class ExpectedResult {
/**
* The actual results must match exactly. Missing data
* will result in a failure
*
* @example
* // actual results
* const actual = {
* stringParam: 'hello',
* numberParam: 3,
* booleanParam: true,
* };
* // pass
* ExpectedResult.exact({
* stringParam: 'hello',
* numberParam: 3,
* booleanParam: true,
* })
*
* // fail
* ExpectedResult.exact({
* stringParam: 'hello',
* });
*
* @see https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.assertions.Match.html#static-exactpattern
*/
public static exact(expected: any): ExpectedResult {
return {
result: JSON.stringify({
$Exact: expected,
}),
};
}
/**
* The expected results must be a subset of the
* actual results.
*
* @example
* // actual results
* const actual = {
* stringParam: 'hello',
* numberParam: 3,
* booleanParam: true,
* objectParam: { prop1: 'value', prop2: 'value' },
* };
* // pass
* ExpectedResult.objectLike({
* stringParam: 'hello',
* objectParam: { prop1: 'value' },
* });
*
* @see https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.assertions.Match.html#static-objectwbrlikepattern
*/
public static objectLike(expected: { [key: string]: any }): ExpectedResult {
return {
result: JSON.stringify({
$ObjectLike: expected,
}),
};
}
/**
* The actual results must be a list and must contain
* an item with the expected results.
*
* @example
* // actual results
* const actual = [
* {
* stringParam: 'hello',
* },
* {
* stringParam: 'world',
* },
* ];
* // pass
* ExpectedResult.arrayWith([
* {
* stringParam: 'hello',
* },
* ]);
*
* @see https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.assertions.Match.html#static-arraywbrwithpattern
*/
public static arrayWith(expected: any[]): ExpectedResult {
return {
result: JSON.stringify({
$ArrayWith: expected,
}),
};
}
/**
* Actual results is a string that matches
* the Expected result regex
*
* @example
* // actual results
* const actual = 'some string value';
*
* // pass
* ExpectedResult.stringLikeRegexp('value');
*
* @see https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.assertions.Match.html#static-stringwbrlikewbrregexppattern
*/
public static stringLikeRegexp(expected: string): ExpectedResult {
return {
result: JSON.stringify({
$StringLike: expected,
}),
};
}
/**
* The expected results encoded as a string
*/
public abstract result: string;
}