-
Notifications
You must be signed in to change notification settings - Fork 10.3k
/
test-plugin-options-schema.ts
202 lines (187 loc) · 6.51 KB
/
test-plugin-options-schema.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
import { testPluginOptionsSchema } from "../test-plugin-options-schema"
import { ObjectSchema } from "../joi"
describe(`testPluginOptionsSchema`, () => {
it(`should partially validate one value of a schema`, async () => {
const pluginSchema = ({ Joi }): ObjectSchema =>
Joi.object({
str: Joi.string(),
nb: Joi.number(),
toVerify: Joi.boolean(),
})
const { isValid, errors } = await testPluginOptionsSchema(pluginSchema, {
toVerify: `abcd`,
})
expect(isValid).toBe(false)
expect(errors).toMatchInlineSnapshot(`
Array [
"\\"toVerify\\" must be a boolean",
]
`)
})
it(`should partially validate multiples value of a schema`, async () => {
const pluginSchema = ({ Joi }): ObjectSchema =>
Joi.object({
str: Joi.string(),
nb: Joi.number(),
toVerify: Joi.boolean(),
})
const { isValid, errors } = await testPluginOptionsSchema(pluginSchema, {
toVerify: `abcd`,
nb: `invalid value`,
})
expect(isValid).toBe(false)
expect(errors).toMatchInlineSnapshot(`
Array [
"\\"nb\\" must be a number",
"\\"toVerify\\" must be a boolean",
]
`)
})
it(`should validate half of a real world plugin schema`, async () => {
const pluginSchema = ({ Joi }): ObjectSchema =>
Joi.object({
trackingId: Joi.string()
.required()
.description(
`The property ID; the tracking code won't be generated without it`
),
head: Joi.boolean()
.default(false)
.description(
`Defines where to place the tracking script - \`true\` in the head and \`false\` in the body`
),
anonymize: Joi.boolean().default(false),
respectDNT: Joi.boolean().default(false),
exclude: Joi.array()
.items(Joi.string())
.default([])
.description(`Avoids sending pageview hits from custom paths`),
pageTransitionDelay: Joi.number()
.default(0)
.description(
`Delays sending pageview hits on route update (in milliseconds)`
),
optimizeId: Joi.string().description(
`Enables Google Optimize using your container Id`
),
experimentId: Joi.string().description(
`Enables Google Optimize Experiment ID`
),
variationId: Joi.string().description(
`Set Variation ID. 0 for original 1,2,3....`
),
defer: Joi.boolean().description(
`Defers execution of google analytics script after page load`
),
sampleRate: Joi.number(),
siteSpeedSampleRate: Joi.number(),
cookieDomain: Joi.string(),
})
const { isValid, errors } = await testPluginOptionsSchema(pluginSchema, {
trackingId: undefined,
head: `invalid boolean value`,
anonymize: `invalid boolean value`,
respectDNT: `invalid boolean value`,
exclude: [0, 1, 2],
})
expect(isValid).toBe(false)
expect(errors).toMatchInlineSnapshot(`
Array [
"\\"trackingId\\" is required",
"\\"head\\" must be a boolean",
"\\"anonymize\\" must be a boolean",
"\\"respectDNT\\" must be a boolean",
"\\"exclude[0]\\" must be a string",
"\\"exclude[1]\\" must be a string",
"\\"exclude[2]\\" must be a string",
]
`)
})
it(`should validate an entire real world plugin schema`, async () => {
const pluginSchema = ({ Joi }): ObjectSchema =>
Joi.object({
trackingId: Joi.string()
.required()
.description(
`The property ID; the tracking code won't be generated without it`
),
head: Joi.boolean()
.default(false)
.description(
`Defines where to place the tracking script - \`true\` in the head and \`false\` in the body`
),
anonymize: Joi.boolean().default(false),
respectDNT: Joi.boolean().default(false),
exclude: Joi.array()
.items(Joi.string())
.default([])
.description(`Avoids sending pageview hits from custom paths`),
pageTransitionDelay: Joi.number()
.default(0)
.description(
`Delays sending pageview hits on route update (in milliseconds)`
),
optimizeId: Joi.string().description(
`Enables Google Optimize using your container Id`
),
experimentId: Joi.string().description(
`Enables Google Optimize Experiment ID`
),
variationId: Joi.string().description(
`Set Variation ID. 0 for original 1,2,3....`
),
defer: Joi.boolean().description(
`Defers execution of google analytics script after page load`
),
sampleRate: Joi.number(),
siteSpeedSampleRate: Joi.number(),
cookieDomain: Joi.string(),
})
const { isValid, errors } = await testPluginOptionsSchema(pluginSchema, {
trackingId: undefined,
head: `invalid boolean value`,
anonymize: `invalid boolean value`,
respectDNT: `invalid boolean value`,
exclude: [0, 1, 2],
pageTransitionDelay: `invalid number value`,
optimizeId: 123,
experimentId: 456,
variationId: 789,
defer: `invalid boolean value`,
sampleRate: `invalid number value`,
siteSpeedSampleRate: `invalid number value`,
cookieDomain: 9797,
})
expect(isValid).toBe(false)
expect(errors).toMatchInlineSnapshot(`
Array [
"\\"trackingId\\" is required",
"\\"head\\" must be a boolean",
"\\"anonymize\\" must be a boolean",
"\\"respectDNT\\" must be a boolean",
"\\"exclude[0]\\" must be a string",
"\\"exclude[1]\\" must be a string",
"\\"exclude[2]\\" must be a string",
"\\"pageTransitionDelay\\" must be a number",
"\\"optimizeId\\" must be a string",
"\\"experimentId\\" must be a string",
"\\"variationId\\" must be a string",
"\\"defer\\" must be a boolean",
"\\"sampleRate\\" must be a number",
"\\"siteSpeedSampleRate\\" must be a number",
"\\"cookieDomain\\" must be a string",
]
`)
})
it(`should check the validity of a schema`, async () => {
const pluginSchema = ({ Joi }): ObjectSchema =>
Joi.object({
toVerify: Joi.boolean(),
})
const { isValid, errors } = await testPluginOptionsSchema(pluginSchema, {
toVerify: false,
})
expect(isValid).toBe(true)
expect(errors).toEqual([])
})
})