configure-pages/src/config-parser.test.js at main · actions/configure-pages · GitHub

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
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
const fs = require('fs')
const core = require('@actions/core')

const { ConfigParser } = require('./config-parser')
const { getTempFolder, compareFiles } = require('./test-helpers')

// Get the temp folder
const tempFolder = getTempFolder()

// Cases to test
const cases = [
  //
  // Direct default export
  //
  {
    property: 'property',
    source: 'export default {}',
    expected: 'export default { property: "value" }'
  },
  {
    property: 'property',
    source: 'export default { property: 0 }', // property exists and is a number
    expected: 'export default { property: "value" }'
  },
  {
    property: 'property',
    source: 'export default { property: false }', // property exists and is a boolean
    expected: 'export default { property: "value" }'
  },
  {
    property: 'property',
    source: 'export default { property: "test" }', // property exists and is a string
    expected: 'export default { property: "value" }'
  },
  {
    property: 'property',
    source: 'export default { property: [1,2] }', // property exists and is an array
    expected: 'export default { property: "value" }'
  },
  {
    property: 'property',
    source: 'export default { property: null }', // property exists and is null
    expected: 'export default { property: "value" }'
  },
  {
    property: 'property',
    source: 'export default { property: { } }', // property exists and is an object
    expected: 'export default { property: "value" }'
  },

  // Deep properties (injection 1)
  {
    property: 'property.b.c',
    source: 'export default {}',
    expected: 'export default { property: { b: { c: "value"  } } }'
  },
  {
    property: 'property.b.c',
    source: 'export default { property: 0 }', // property exists and is a number
    expected: 'export default { property: { b: { c: "value"  } } }'
  },
  {
    property: 'property.b.c',
    source: 'export default { property: { } }', // property exists and is an object
    expected: 'export default { property: { b: { c: "value"  } } }'
  },

  // Deep properties (injection 2)
  {
    property: 'property.b.c',
    source: 'export default { property: { b: 0  } }', // property exists and is a number
    expected: 'export default { property: { b: { c: "value"  } } }'
  },
  {
    property: 'property.b.c',
    source: 'export default { property: { b: { } } }', // property exists and is an object
    expected: 'export default { property: { b: { c: "value"  } } }'
  },
  {
    property: 'property.b.c',
    source: 'export default { property: { b: { hello: 123 } } }', // property exists and is a non-empty object
    expected: 'export default { property: { b: { c: "value", hello: 123  } } }'
  },

  // Deep properties (existing properties)
  {
    property: 'a1.a2',
    source: 'export default { a2: false, a1: { a3: [12] } }', // property exists and is a non-empty object
    expected: 'export default { a2: false, a1: { a2: "value", a3: [12] } }'
  },

  //
  // Indirect default export
  //
  {
    property: 'property',
    source: 'const config = {}; export default config',
    expected: 'const config = { property: "value"}; export default config'
  },
  // with more than 1 declaration chained together
  {
    property: 'property',
    source: 'var temp = {}, config = {}; export default config',
    expected: 'var temp = {}, config = { property: "value"}; export default config'
  },
  // deeper
  {
    property: 'a.b.c',
    source: 'var config = {}; export default config',
    expected: 'var config = { a: { b: { c: "value" } } }; export default config'
  },
  {
    property: 'a.b.c',
    source: 'var config = { a: { b: [], c: "hello" } }; export default config',
    expected: 'var config = { a: { b: { c: "value"}, c: "hello" } }; export default config'
  },

  //
  // Direct module exports
  //
  {
    property: 'property',
    source: 'module.exports = {}',
    expected: 'module.exports = { property: "value"}'
  },
  {
    property: 'property',
    source: 'module.exports = { p1: 0}',
    expected: 'module.exports = { property: "value", p1: 0}'
  },
  {
    property: 'a.b.c',
    source: 'module.exports = { p1: 0}',
    expected: 'module.exports = { a: { b: { c: "value"  } }, p1: 0}'
  },

  //
  // Indirect module exports
  //
  {
    property: 'property',
    source: 'const config = {}; module.exports = config',
    expected: 'const config = { property: "value"}; module.exports = config'
  },
  // with more than 1 declaration chained together
  {
    property: 'property',
    source: 'var temp = {}, config = {}; module.exports = config',
    expected: 'var temp = {}, config = { property: "value"}; module.exports = config'
  },
  // deeper
  {
    property: 'a.b.c',
    source: 'var config = {}; module.exports = config',
    expected: 'var config = { a: { b: { c: "value" } } }; module.exports = config'
  },
  {
    property: 'a.b.c',
    source: 'var config = { a: { b: [], c: "hello" } }; module.exports = config',
    expected: 'var config = { a: { b: { c: "value"}, c: "hello" } }; module.exports = config'
  },

  //
  // Direct default export with wrapping call
  //
  {
    property: 'property',
    source: 'import { defineConfig } from "astro/config"; export default defineConfig({ p1: 0 })',
    expected: 'import { defineConfig } from "astro/config"; export default defineConfig({ property: "value", p1: 0 })',
    allowWrappingCall: true
  },

  //
  // Direct module exports with wrapping call
  //
  {
    property: 'property',
    source: 'const { defineConfig } = require("astro/config"); module.exports = defineConfig({ p1: 0 })',
    expected:
      'const { defineConfig } = require("astro/config"); module.exports = defineConfig({ property: "value", p1: 0 })',
    allowWrappingCall: true
  },

  //
  // Indirect default export with wrapping call at the definition
  //
  {
    property: 'property',
    source: 'import { defineConfig } from "astro/config"; const config = defineConfig({}); export default config',
    expected:
      'import { defineConfig } from "astro/config"; const config = defineConfig({ property: "value" }); export default config',
    allowWrappingCall: true
  },
  // with more than 1 declaration chained together
  {
    property: 'property',
    source:
      'import { defineConfig } from "astro/config"; const temp = {}, config = defineConfig({}); export default config',
    expected:
      'import { defineConfig } from "astro/config"; const temp = {}, config = defineConfig({ property: "value" }); export default config',
    allowWrappingCall: true
  },

  //
  // Indirect default export with wrapping call at the export
  //
  {
    property: 'property',
    source: 'import { defineConfig } from "astro/config"; const config = {}; export default defineConfig(config)',
    expected:
      'import { defineConfig } from "astro/config"; const config = { property: "value" }; export default defineConfig(config)',
    allowWrappingCall: true
  },
  // with more than 1 declaration chained together
  {
    property: 'property',
    source:
      'import { defineConfig } from "astro/config"; const temp = {}, config = {}; export default defineConfig(config)',
    expected:
      'import { defineConfig } from "astro/config"; const temp = {}, config = { property: "value" }; export default defineConfig(config)',
    allowWrappingCall: true
  },

  //
  // Indirect module exports with wrapping call at the definition
  //
  {
    property: 'property',
    source:
      'const { defineConfig } = require("astro/config"); const config = defineConfig({}); module.exports = config',
    expected:
      'const { defineConfig } = require("astro/config"); const config = defineConfig({ property: "value"}); module.exports = config',
    allowWrappingCall: true
  },
  // with more than 1 declaration chained together
  {
    property: 'property',
    source:
      'const { defineConfig } = require("astro/config"); const temp = {}, config = defineConfig({}); module.exports = config',
    expected:
      'const { defineConfig } = require("astro/config"); const temp = {}, config = defineConfig({ property: "value"}); module.exports = config',
    allowWrappingCall: true
  },

  //
  // Indirect module exports with wrapping call at the export
  //
  {
    property: 'property',
    source:
      'const { defineConfig } = require("astro/config"); const config = {}; module.exports = defineConfig(config)',
    expected:
      'const { defineConfig } = require("astro/config"); const config = { property: "value"}; module.exports = defineConfig(config)',
    allowWrappingCall: true
  },
  // with more than 1 declaration chained together
  {
    property: 'property',
    source:
      'const { defineConfig } = require("astro/config"); const temp = {}, config = {}; module.exports = defineConfig(config)',
    expected:
      'const { defineConfig } = require("astro/config"); const temp = {}, config = { property: "value"}; module.exports = defineConfig(config)',
    allowWrappingCall: true
  }
]

describe('config-parser', () => {
  beforeEach(() => {
    jest.restoreAllMocks()

    // Mock error/warning/info/debug to silence their output
    jest.spyOn(core, 'error').mockImplementation(jest.fn())
    jest.spyOn(core, 'warning').mockImplementation(jest.fn())
    jest.spyOn(core, 'info').mockImplementation(jest.fn())
    jest.spyOn(core, 'debug').mockImplementation(jest.fn())
  })

  cases.forEach(({ property, source, expected, allowWrappingCall = false }, index) => {
    it(`injects path properly for case #${index}`, () => {
      // Write the source file
      const sourceFile = `${tempFolder}/source.js`
      fs.writeFileSync(sourceFile, source, { encoding: 'utf8' })

      // Write the expected file
      const expectedFile = `${tempFolder}/expected.js`
      fs.writeFileSync(expectedFile, expected, { encoding: 'utf8' })

      // Update the settings and do the injection
      new ConfigParser({
        configurationFile: sourceFile,
        allowWrappingCall
      }).inject(property, 'value')

      // Compare the files
      compareFiles(sourceFile, expectedFile)
    })
  })
})