aboutsummaryrefslogtreecommitdiff
path: root/test/functional/lua/version_spec.lua
blob: b68727ca7773c43fdaa60204c7584deee94f20e8 (plain) (blame)
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
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
local helpers = require('test.functional.helpers')(after_each)
local clear = helpers.clear
local eq = helpers.eq
local exec_lua = helpers.exec_lua
local matches = helpers.matches
local pcall_err = helpers.pcall_err

local version = require('vim.version')

local function quote_empty(s)
  return tostring(s) == '' and '""' or tostring(s)
end

describe('version', function()
  it('package', function()
    clear()
    eq({ major = 42, minor = 3, patch = 99 }, exec_lua("return vim.version.parse('v42.3.99')"))
  end)

  describe('cmp()', function()
    local testcases = {
      {
        desc = '(v1 < v2)',
        v1 = 'v0.0.99',
        v2 = 'v9.0.0',
        want = -1,
      },
      {
        desc = '(v1 < v2)',
        v1 = 'v0.4.0',
        v2 = 'v0.9.99',
        want = -1,
      },
      {
        desc = '(v1 < v2)',
        v1 = 'v0.2.8',
        v2 = 'v1.0.9',
        want = -1,
      },
      {
        desc = '(v1 == v2)',
        v1 = 'v0.0.0',
        v2 = 'v0.0.0',
        want = 0,
      },
      {
        desc = '(v1 > v2)',
        v1 = 'v9.0.0',
        v2 = 'v0.9.0',
        want = 1,
      },
      {
        desc = '(v1 > v2)',
        v1 = 'v0.9.0',
        v2 = 'v0.0.0',
        want = 1,
      },
      {
        desc = '(v1 > v2)',
        v1 = 'v0.0.9',
        v2 = 'v0.0.0',
        want = 1,
      },
      {
        desc = '(v1 < v2) when v1 has prerelease',
        v1 = 'v1.0.0-alpha',
        v2 = 'v1.0.0',
        want = -1,
      },
      {
        desc = '(v1 > v2) when v2 has prerelease',
        v1 = '1.0.0',
        v2 = '1.0.0-alpha',
        want = 1,
      },
      {
        desc = '(v1 > v2) when v1 has a higher number identifier',
        v1 = '1.0.0-2',
        v2 = '1.0.0-1',
        want = 1,
      },
      {
        desc = '(v1 < v2) when v2 has a higher number identifier',
        v1 = '1.0.0-2',
        v2 = '1.0.0-9',
        want = -1,
      },
      {
        desc = '(v1 < v2) when v2 has more identifiers',
        v1 = '1.0.0-2',
        v2 = '1.0.0-2.0',
        want = -1,
      },
      {
        desc = '(v1 > v2) when v1 has more identifiers',
        v1 = '1.0.0-2.0',
        v2 = '1.0.0-2',
        want = 1,
      },
      {
        desc = '(v1 == v2) when v2 has same numeric identifiers',
        v1 = '1.0.0-2.0',
        v2 = '1.0.0-2.0',
        want = 0,
      },
      {
        desc = '(v1 == v2) when v2 has same alphabet identifiers',
        v1 = '1.0.0-alpha',
        v2 = '1.0.0-alpha',
        want = 0,
      },
      {
        desc = '(v1 < v2) when v2 has an alphabet identifier with higher ASCII sort order',
        v1 = '1.0.0-alpha',
        v2 = '1.0.0-beta',
        want = -1,
      },
      {
        desc = '(v1 > v2) when v1 has an alphabet identifier with higher ASCII sort order',
        v1 = '1.0.0-beta',
        v2 = '1.0.0-alpha',
        want = 1,
      },
      {
        desc = '(v1 < v2) when v2 has prerelease and number identifer',
        v1 = '1.0.0-alpha',
        v2 = '1.0.0-alpha.1',
        want = -1,
      },
      {
        desc = '(v1 > v2) when v1 has prerelease and number identifer',
        v1 = '1.0.0-alpha.1',
        v2 = '1.0.0-alpha',
        want = 1,
      },
      {
        desc = '(v1 > v2) when v1 has an additional alphabet identifier',
        v1 = '1.0.0-alpha.beta',
        v2 = '1.0.0-alpha',
        want = 1,
      },
      {
        desc = '(v1 < v2) when v2 has an additional alphabet identifier',
        v1 = '1.0.0-alpha',
        v2 = '1.0.0-alpha.beta',
        want = -1,
      },
      {
        desc = '(v1 < v2) when v2 has an a first alphabet identifier with higher precedence',
        v1 = '1.0.0-alpha.beta',
        v2 = '1.0.0-beta',
        want = -1,
      },
      {
        desc = '(v1 > v2) when v1 has an a first alphabet identifier with higher precedence',
        v1 = '1.0.0-beta',
        v2 = '1.0.0-alpha.beta',
        want = 1,
      },
      {
        desc = '(v1 < v2) when v2 has an additional number identifer',
        v1 = '1.0.0-beta',
        v2 = '1.0.0-beta.2',
        want = -1,
      },
      {
        desc = '(v1 < v2) when v2 has same first alphabet identifier but has a higher number identifer',
        v1 = '1.0.0-beta.2',
        v2 = '1.0.0-beta.11',
        want = -1,
      },
      {
        desc = '(v1 < v2) when v2 has higher alphabet precedence',
        v1 = '1.0.0-beta.11',
        v2 = '1.0.0-rc.1',
        want = -1,
      },
    }
    for _, tc in ipairs(testcases) do
      it(
        string.format('%d %s (v1 = %s, v2 = %s)', tc.want, tc.desc, tc.v1, tc.v2),
        function()
          eq(tc.want, version.cmp(tc.v1, tc.v2, { strict = true }))
        end
      )
    end
  end)

  describe('parse()', function()
    describe('strict=true', function()
      local testcases = {
        {
          desc = 'version without leading "v"',
          version = '10.20.123',
          want = {
            major = 10,
            minor = 20,
            patch = 123,
            prerelease = nil,
            build = nil,
          },
        },
        {
          desc = 'valid version with leading "v"',
          version = 'v1.2.3',
          want = { major = 1, minor = 2, patch = 3 },
        },
        {
          desc = 'valid version with leading "v" and whitespace',
          version = '  v1.2.3',
          want = { major = 1, minor = 2, patch = 3 },
        },
        {
          desc = 'valid version with leading "v" and trailing whitespace',
          version = 'v1.2.3  ',
          want = { major = 1, minor = 2, patch = 3 },
        },
        {
          desc = 'version with prerelease',
          version = '1.2.3-alpha',
          want = { major = 1, minor = 2, patch = 3, prerelease = 'alpha' },
        },
        {
          desc = 'version with prerelease with additional identifiers',
          version = '1.2.3-alpha.1',
          want = { major = 1, minor = 2, patch = 3, prerelease = 'alpha.1' },
        },
        {
          desc = 'version with build',
          version = '1.2.3+build.15',
          want = { major = 1, minor = 2, patch = 3, build = 'build.15' },
        },
        {
          desc = 'version with prerelease and build',
          version = '1.2.3-rc1+build.15',
          want = {
            major = 1,
            minor = 2,
            patch = 3,
            prerelease = 'rc1',
            build = 'build.15',
          },
        },
      }
      for _, tc in ipairs(testcases) do
        it(
          string.format('for %q: version = %q', tc.desc, tc.version),
          function()
            eq(tc.want, version.parse(tc.version, { strict = true }))
          end
        )
      end
    end)

    describe('strict=false', function()
      local testcases = {
        {
          desc = 'version missing patch version',
          version = '1.2',
          want = { major = 1, minor = 2, patch = 0 },
        },
        {
          desc = 'version missing minor and patch version',
          version = '1',
          want = { major = 1, minor = 0, patch = 0 },
        },
        {
          desc = 'version missing patch version with prerelease',
          version = '1.1-0',
          want = { major = 1, minor = 1, patch = 0, prerelease = '0' },
        },
        {
          desc = 'version missing minor and patch version with prerelease',
          version = '1-1.0',
          want = { major = 1, minor = 0, patch = 0, prerelease = '1.0' },
        },
      }
      for _, tc in ipairs(testcases) do
        it(
          string.format('for %q: version = %q', tc.desc, tc.version),
          function()
            eq(tc.want, version.parse(tc.version, { strict = false }))
          end
        )
      end
    end)

    describe('invalid semver', function()
      local testcases = {
        { desc = 'a word', version = 'foo' },
        { desc = 'empty string', version = '' },
        { desc = 'trailing period character', version = '0.0.0.' },
        { desc = 'leading period character', version = '.0.0.0' },
        { desc = 'negative major version', version = '-1.0.0' },
        { desc = 'negative minor version', version = '0.-1.0' },
        { desc = 'negative patch version', version = '0.0.-1' },
        { desc = 'leading invalid string', version = 'foobar1.2.3' },
        { desc = 'trailing invalid string', version = '1.2.3foobar' },
        { desc = 'an invalid prerelease', version = '1.2.3-%?' },
        { desc = 'an invalid build', version = '1.2.3+%?' },
        { desc = 'build metadata before prerelease', version = '1.2.3+build.0-rc1' },
      }
      for _, tc in ipairs(testcases) do
        it(string.format('(%s): %s', tc.desc, quote_empty(tc.version)), function()
          eq(nil, version.parse(tc.version, { strict = true }))
        end)
      end
    end)

    describe('invalid shape', function()
      local testcases = {
        { desc = 'no parameters' },
        { desc = 'nil', version = nil },
        { desc = 'number', version = 0 },
        { desc = 'float', version = 0.01 },
        { desc = 'table', version = {} },
      }
      for _, tc in ipairs(testcases) do
        it(string.format('(%s): %s', tc.desc, tostring(tc.version)), function()
          local expected = string.format(type(tc.version) == 'string'
            and 'invalid version: "%s"' or 'invalid version: %s', tostring(tc.version))
          matches(expected, pcall_err(version.parse, tc.version, { strict = true }))
        end)
      end
    end)
  end)

  it('lt()', function()
    eq(true, version.lt('1', '2'))
  end)

  it('gt()', function()
    eq(true, version.gt('2', '1'))
  end)

  it('eq()', function()
    eq(true, version.eq('2', '2'))
  end)
end)