File: options_spec.lua

package info (click to toggle)
luacheck 1.2.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,704 kB
  • sloc: sh: 106; makefile: 96; python: 35
file content (232 lines) | stat: -rw-r--r-- 7,580 bytes parent folder | download | duplicates (5)
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
local options = require "luacheck.options"

describe("options", function()
   describe("validate", function()
      it("returns true if options are empty", function()
         assert.is_true(options.validate(options.all_options))
      end)

      it("returns true if options are valid", function()
         assert.is_true(options.validate(options.all_options, {
            globals = {"foo"},
            compat = false,
            unrelated = function() end
         }))
      end)

      it("returns false and an error message if options are invalid", function()
         local ok, err = options.validate(options.all_options, {
            globals = 3,
            redefined = false
         })
         assert.is_false(ok)
         assert.equal("invalid value of option 'globals': table expected, got number", err)

         ok, err = options.validate(options.all_options, {
            globals = {3}
         })
         assert.is_false(ok)
         assert.equal(
            "invalid value of option 'globals': in field [1]: string expected as global name, got number", err)

         ok, err = options.validate(options.all_options, function() end)
         assert.is_false(ok)
         assert.equal("option table expected, got function", err)

         ok, err = options.validate(options.all_options, {
            unused = 0
         })
         assert.is_false(ok)
         assert.equal("invalid value of option 'unused': boolean expected, got number", err)

         ok, err = options.validate(options.all_options, {
            max_line_length = true,
            redefined = false
         })
         assert.is_false(ok)
         assert.equal("invalid value of option 'max_line_length': number or false expected, got true", err)

         ok, err = options.validate(options.all_options, {
            max_line_length = "foo",
            redefined = false
         })
         assert.is_false(ok)
         assert.equal("invalid value of option 'max_line_length': number or false expected, got string", err)

         ok, err = options.validate(options.all_options, {
            std = "+lua51+luaaot",
            redefined = false
         })
         assert.is_false(ok)
         assert.equal("invalid value of option 'std': unknown std 'luaaot'", err)

         ok, err = options.validate(options.all_options, {
            std = {read_globals = {1}},
            redefined = false
         })
         assert.is_false(ok)
         assert.equal(
            "invalid value of option 'std': in field .read_globals[1]: string expected as global name, got number", err)

         ok, err = options.validate(options.all_options, {
            std = 123,
            redefined = false
         })
         assert.is_false(ok)
         assert.equal("invalid value of option 'std': string or table expected, got number", err)
      end)
   end)

   describe("normalize", function()
      it("applies default values", function()
         local opts = options.normalize({})
         assert.same(opts, options.normalize({{}}))

         assert.is_true(opts.unused_secondaries)
         assert.is_false(opts.module)
         assert.is_false(opts.allow_defined)
         assert.is_false(opts.allow_defined_top)
         assert.is_table(opts.std)
         assert.same({}, opts.rules)
      end)

      it("considers simple boolean options", function()
         local opts = options.normalize({
            {
               module = false,
               unused_secondaries = true
            }, {
               module = true,
               allow_defined = false
            }
         })

         assert.is_true(opts.module)
         assert.is_true(opts.unused_secondaries)
         assert.is_false(opts.allow_defined)
      end)

      it("considers opts.std and opts.compat", function()
         assert.same({fields = {
            baz = {read_only = false, other_fields = true}
         }}, options.normalize({
            {
               std = "none"
            }, {
               globals = {"foo", "bar"},
               compat = true
            }, {
               new_globals = {"baz"},
               compat = false
            }
         }).std)
      end)

      it("allows compound std unions", function()
         assert.same(options.normalize({
            {
               std = "max"
            },
         }).globals, options.normalize({
            {
               std = "lua51+lua52+lua53+luajit"
            },
         }).globals)
      end)

      it("allows std addition", function()
         assert.same(options.normalize({
            {
               std = "lua52 + busted"
            },
         }).globals, options.normalize({
            {
               std = "max"
            },
            {
               std = "none"
            },
            {
               std = "+lua52+busted"
            }
         }).globals)
      end)

      it("considers read-only and regular globals", function()
         local opts = options.normalize({
            {
               std = "lua52",
               globals = {"foo", "bar", "removed"},
               read_globals = {"baz"}
            }, {
               new_read_globals = {"quux"},
               not_globals = {"removed", "unrelated", "print"}
            }
         })
         local std = opts.std
         assert.is_table(std)
         assert.is_table(std.fields)

         assert.is_same({read_only = false, other_fields = true}, std.fields.foo)
         assert.is_same({read_only = false, other_fields = true}, std.fields.bar)
         assert.is_nil(std.fields.baz)
         assert.is_same({read_only = true, deep_read_only = true, other_fields = true}, std.fields.quux)
         assert.is_table(std.fields.string)
         assert.is_true(std.fields.string.deep_read_only)
         assert.is_nil(std.fields.string.other_fields)
      end)

      it("considers read-only and regular field definitions", function()
         local opts = options.normalize({
            {
               std = "none",
               globals = {"foo", "bar.nested", "baz.nested.deeply"},
               read_globals = {"bar", "foo.nested"}
            }, {
               not_globals = {"baz.nested", "unrelated.field"}
            }
         })
         assert.same({
            fields = {
               foo = {
                  read_only = false,
                  other_fields = true,
                  fields = {
                     nested = {deep_read_only = true, read_only = true, other_fields = true}
                  }
               },
               bar = {
                  read_only = true,
                  other_fields = true,
                  fields = {
                     nested = {read_only = false, other_fields = true}
                  }
               },
               baz = {deep_read_only = true, read_only = false, fields = {}}
            }
         }, opts.std)
      end)

      it("considers macros, ignore, enable and only", function()
         assert.same({
               {{{nil, "^foo$"}}, "only"},
               {{{"^21[23]", nil}}, "disable"},
               {{{"^[23]", nil}}, "enable"},
               {{{"^511", nil}}, "enable"},
               {{{"^412", nil}, {"1$", "^bar$"}}, "disable"}
            }, options.normalize({
            {
               unused = false
            }, {
               ignore = {"412", "1$/bar"}
            }, {
               unused = true,
               unused_args = false,
               enable = {"511"}
            }, {
               only = {"foo"}
            }
         }).rules)
      end)
   end)
end)