summaryrefslogtreecommitdiff
path: root/pkgtools/pkglint/files/vartypecheck_test.go
blob: e338f924341c270e3411d7f28a1fe7c59a0b2600 (plain)
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
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
package main

import (
	"fmt"

	check "gopkg.in/check.v1"
)

func (s *Suite) Test_VartypeCheck_AwkCommand(c *check.C) {
	runVartypeChecks("PLIST_AWK", opAssignAppend, (*VartypeCheck).AwkCommand,
		"{print $0}",
		"{print $$0}")

	c.Check(s.Output(), equals, "WARN: fname:1: $0 is ambiguous. Use ${0} if you mean a Makefile variable or $$0 if you mean a shell variable.\n")
}

func (s *Suite) Test_VartypeCheck_BasicRegularExpression(c *check.C) {
	runVartypeChecks("REPLACE_FILES.pl", opAssign, (*VartypeCheck).BasicRegularExpression,
		".*\\.pl$",
		".*\\.pl$$")

	c.Check(s.Output(), equals, "WARN: fname:1: Pkglint parse error in MkLine.Tokenize at \"$\".\n")
}

func (s *Suite) Test_VartypeCheck_BuildlinkDepmethod(c *check.C) {
	runVartypeChecks("BUILDLINK_DEPMETHOD.libc", opAssignDefault, (*VartypeCheck).BuildlinkDepmethod,
		"full",
		"unknown")

	c.Check(s.Output(), equals, "WARN: fname:2: Invalid dependency method \"unknown\". Valid methods are \"build\" or \"full\".\n")
}

func (s *Suite) Test_VartypeCheck_Category(c *check.C) {
	s.CreateTmpFile(c, "filesyscategory/Makefile", "# empty\n")
	s.CreateTmpFile(c, "wip/Makefile", "# empty\n")
	G.CurrentDir = s.tmpdir
	G.CurPkgsrcdir = "."

	runVartypeChecks("CATEGORIES", opAssign, (*VartypeCheck).Category,
		"chinese",
		"arabic",
		"filesyscategory",
		"wip")

	c.Check(s.Output(), equals, ""+
		"ERROR: fname:2: Invalid category \"arabic\".\n"+
		"ERROR: fname:4: Invalid category \"wip\".\n")
}

func (s *Suite) Test_VartypeCheck_CFlag(c *check.C) {
	runVartypeChecks("CFLAGS", opAssignAppend, (*VartypeCheck).CFlag,
		"-Wall",
		"/W3",
		"target:sparc64",
		"-std=c99",
		"-XX:+PrintClassHistogramAfterFullGC",
		"`pkg-config pidgin --cflags`")

	c.Check(s.Output(), equals, ""+
		"WARN: fname:2: Compiler flag \"/W3\" should start with a hyphen.\n"+
		"WARN: fname:3: Compiler flag \"target:sparc64\" should start with a hyphen.\n"+
		"WARN: fname:5: Unknown compiler flag \"-XX:+PrintClassHistogramAfterFullGC\".\n")
}

func (s *Suite) Test_VartypeCheck_Comment(c *check.C) {
	runVartypeChecks("COMMENT", opAssign, (*VartypeCheck).Comment,
		"Versatile Programming Language",
		"TODO: Short description of the package",
		"A great package.",
		"some packages need a very very long comment to explain their basic usefulness")

	c.Check(s.Output(), equals, ""+
		"ERROR: fname:2: COMMENT must be set.\n"+
		"WARN: fname:3: COMMENT should not begin with \"A\".\n"+
		"WARN: fname:3: COMMENT should not end with a period.\n"+
		"WARN: fname:4: COMMENT should start with a capital letter.\n"+
		"WARN: fname:4: COMMENT should not be longer than 70 characters.\n")
}

func (s *Suite) Test_VartypeCheck_Dependency(c *check.C) {
	runVartypeChecks("CONFLICTS", opAssignAppend, (*VartypeCheck).Dependency,
		"Perl",
		"perl5>=5.22",
		"perl5-*",
		"perl5-5.22.*",
		"perl5-[5.10-5.22]*",
		"py-docs",
		"perl5-5.22.*{,nb*}",
		"libkipi>=0.1.5<4.0",
		"gtk2+>=2.16",
		"perl-5.22",
		"perl-5*",
		"gtksourceview-sharp-2.0-[0-9]*",
		"perl-5.22{,nb*}",
		"perl-5.22{,nb[0-9]*}",
		"mbrola-301h{,nb[0-9]*}",
		"mpg123{,-esound,-nas}>=0.59.18",
		"mysql*-{client,server}-[0-9]*",
		"postgresql8[0-35-9]-${module}-[0-9]*",
		"ncurses-${NC_VERS}{,nb*}",
		"{ssh{,6}-[0-9]*,openssh-[0-9]*}",
		"gnome-control-center>=2.20.1{,nb*}")

	c.Check(s.Output(), equals, ""+
		"WARN: fname:1: Unknown dependency pattern \"Perl\".\n"+
		"WARN: fname:3: Please use \"perl5-[0-9]*\" instead of \"perl5-*\".\n"+
		"WARN: fname:5: Only [0-9]* is allowed in the numeric part of a dependency.\n"+
		"WARN: fname:5: The version pattern \"[5.10-5.22]*\" should not contain a hyphen.\n"+
		"WARN: fname:6: Unknown dependency pattern \"py-docs\".\n"+
		"WARN: fname:10: Please use \"5.22{,nb*}\" instead of \"5.22\" as the version pattern.\n"+
		"WARN: fname:11: Please use \"5.*\" instead of \"5*\" as the version pattern.\n"+
		"WARN: fname:12: The version pattern \"2.0-[0-9]*\" should not contain a hyphen.\n"+
		"WARN: fname:20: The version pattern \"[0-9]*,openssh-[0-9]*}\" should not contain a hyphen.\n"+ // XXX
		"WARN: fname:21: Dependency patterns of the form pkgbase>=1.0 don't need the \"{,nb*}\" extension.\n")
}

func (s *Suite) Test_VartypeCheck_DependencyWithPath(c *check.C) {
	s.CreateTmpFile(c, "x11/alacarte/Makefile", "# empty\n")
	s.CreateTmpFile(c, "category/package/Makefile", "# empty\n")
	G.globalData.Pkgsrcdir = s.tmpdir
	G.CurrentDir = s.tmpdir + "/category/package"
	G.CurPkgsrcdir = "../.."

	runVartypeChecks("DEPENDS", opAssignAppend, (*VartypeCheck).DependencyWithPath,
		"Perl",
		"perl5>=5.22:../perl5",
		"perl5>=5.24:../../lang/perl5",
		"broken0.12.1:../../x11/alacarte",
		"broken[0-9]*:../../x11/alacarte",
		"broken[0-9]*../../x11/alacarte",
		"broken>=:../../x11/alacarte",
		"broken=0:../../x11/alacarte",
		"broken=:../../x11/alacarte",
		"broken-:../../x11/alacarte",
		"broken>:../../x11/alacarte",
		"gtk2+>=2.16:../../x11/alacarte")

	c.Check(s.Output(), equals, ""+
		"WARN: fname:1: Unknown dependency pattern with path \"Perl\".\n"+
		"WARN: fname:2: Dependencies should have the form \"../../category/package\".\n"+
		"ERROR: fname:3: \"../../lang/perl5\" does not exist.\n"+
		"ERROR: fname:3: There is no package in \"lang/perl5\".\n"+
		"WARN: fname:3: Please use USE_TOOLS+=perl:run instead of this dependency.\n"+
		"WARN: fname:4: Unknown dependency pattern \"broken0.12.1\".\n"+
		"WARN: fname:5: Unknown dependency pattern \"broken[0-9]*\".\n"+
		"WARN: fname:6: Unknown dependency pattern with path \"broken[0-9]*../../x11/alacarte\".\n"+
		"WARN: fname:7: Unknown dependency pattern \"broken>=\".\n"+
		"WARN: fname:8: Unknown dependency pattern \"broken=0\".\n"+
		"WARN: fname:9: Unknown dependency pattern \"broken=\".\n"+
		"WARN: fname:10: Unknown dependency pattern \"broken-\".\n"+
		"WARN: fname:11: Unknown dependency pattern \"broken>\".\n")
}

func (s *Suite) Test_VartypeCheck_DistSuffix(c *check.C) {
	runVartypeChecks("EXTRACT_SUFX", opAssign, (*VartypeCheck).DistSuffix,
		".tar.gz",
		".tar.bz2")

	c.Check(s.Output(), equals, "NOTE: fname:1: EXTRACT_SUFX is \".tar.gz\" by default, so this definition may be redundant.\n")
}

func (s *Suite) Test_VartypeCheck_EmulPlatform(c *check.C) {
	runVartypeChecks("EMUL_PLATFORM", opAssign, (*VartypeCheck).EmulPlatform,
		"linux-i386",
		"nextbsd-8087",
		"${LINUX}")

	c.Check(s.Output(), equals, ""+
		"WARN: fname:2: \"nextbsd\" is not valid for the operating system part of EMUL_PLATFORM. Use one of { bitrig bsdos cygwin darwin dragonfly freebsd haiku hpux interix irix linux mirbsd netbsd openbsd osf1 solaris sunos } instead.\n"+
		"WARN: fname:2: \"8087\" is not valid for the hardware architecture part of EMUL_PLATFORM. Use one of { aarch64 aarch64eb alpha amd64 arc arm arm26 arm32 cobalt coldfire convex dreamcast earm earmeb earmhf earmhfeb earmv4 earmv4eb earmv5 earmv5eb earmv6 earmv6eb earmv6hf earmv6hfeb earmv7 earmv7eb earmv7hf earmv7hfeb evbarm hpcmips hpcsh hppa hppa64 i386 i586 i686 ia64 m68000 m68k m88k mips mips64 mips64eb mips64el mipseb mipsel mipsn32 mlrisc ns32k pc532 pmax powerpc powerpc64 rs6000 s390 sh3eb sh3el sparc sparc64 vax x86_64 } instead.\n"+
		"WARN: fname:3: \"${LINUX}\" is not a valid emulation platform.\n")
}

func (s *Suite) Test_VartypeCheck_Enum(c *check.C) {
	runVartypeMatchChecks("JDK", enum("jdk1 jdk2 jdk4").checker,
		"*",
		"jdk*",
		"sun-jdk*",
		"${JDKNAME}")

	c.Check(s.Output(), equals, "WARN: fname:3: The pattern \"sun-jdk*\" cannot match any of { jdk1 jdk2 jdk4 } for JDK.\n")
}

func (s *Suite) Test_VartypeCheck_FetchURL(c *check.C) {
	s.RegisterMasterSite("MASTER_SITE_GNU", "http://ftp.gnu.org/pub/gnu/")
	s.RegisterMasterSite("MASTER_SITE_GITHUB", "https://github.com/")

	runVartypeChecks("MASTER_SITES", opAssign, (*VartypeCheck).FetchURL,
		"https://github.com/example/project/",
		"http://ftp.gnu.org/pub/gnu/bison", // Missing a slash at the end
		"${MASTER_SITE_GNU:=bison}",
		"${MASTER_SITE_INVALID:=subdir/}")

	c.Check(s.Output(), equals, ""+
		"WARN: fname:1: Please use ${MASTER_SITE_GITHUB:=example/} instead of \"https://github.com/example/project/\" and run \""+confMake+" help topic=github\" for further tips.\n"+
		"WARN: fname:2: Please use ${MASTER_SITE_GNU:=bison} instead of \"http://ftp.gnu.org/pub/gnu/bison\".\n"+
		"ERROR: fname:3: The subdirectory in MASTER_SITE_GNU must end with a slash.\n"+
		"ERROR: fname:4: The site MASTER_SITE_INVALID does not exist.\n")

	// PR 46570, keyword gimp-fix-ca
	runVartypeChecks("MASTER_SITES", opAssign, (*VartypeCheck).FetchURL,
		"https://example.org/download.cgi?fname=fname&sha1=12341234")

	c.Check(s.Output(), equals, "")

	runVartypeChecks("MASTER_SITES", opAssign, (*VartypeCheck).FetchURL,
		"http://example.org/distfiles/",
		"http://example.org/download?fname=distfile;version=1.0",
		"http://example.org/download?fname=<distfile>;version=<version>")

	c.Check(s.Output(), equals, "WARN: fname:3: \"http://example.org/download?fname=<distfile>;version=<version>\" is not a valid URL.\n")
}

func (s *Suite) Test_VartypeCheck_Filename(c *check.C) {
	runVartypeChecks("FNAME", opAssign, (*VartypeCheck).Filename,
		"Filename with spaces.docx",
		"OS/2-manual.txt")

	c.Check(s.Output(), equals, ""+
		"WARN: fname:1: \"Filename with spaces.docx\" is not a valid filename.\n"+
		"WARN: fname:2: A filename should not contain a slash.\n")
}

func (s *Suite) Test_VartypeCheck_LdFlag(c *check.C) {
	runVartypeChecks("LDFLAGS", opAssignAppend, (*VartypeCheck).LdFlag,
		"-lc",
		"-L/usr/lib64",
		"`pkg-config pidgin --ldflags`",
		"-unknown")

	c.Check(s.Output(), equals, "WARN: fname:4: Unknown linker flag \"-unknown\".\n")
}

func (s *Suite) Test_VartypeCheck_License(c *check.C) {
	runVartypeChecks("LICENSE", opAssign, (*VartypeCheck).License,
		"gnu-gpl-v2",
		"AND mit")

	c.Check(s.Output(), equals, ""+
		"WARN: fname:1: License file /licenses/gnu-gpl-v2 does not exist.\n"+
		"ERROR: fname:2: Parse error for license condition \"AND mit\".\n")

	runVartypeChecks("LICENSE", opAssignAppend, (*VartypeCheck).License,
		"gnu-gpl-v2",
		"AND mit")

	c.Check(s.Output(), equals, ""+
		"ERROR: fname:1: Parse error for appended license condition \"gnu-gpl-v2\".\n"+
		"WARN: fname:2: License file /licenses/mit does not exist.\n")
}

func (s *Suite) Test_VartypeCheck_MachineGnuPlatform(c *check.C) {
	runVartypeMatchChecks("MACHINE_GNU_PLATFORM", (*VartypeCheck).MachineGnuPlatform,
		"x86_64-pc-cygwin",
		"Cygwin-*-amd64")

	c.Check(s.Output(), equals, ""+
		"WARN: fname:2: The pattern \"Cygwin\" cannot match any of { aarch64 aarch64_be alpha amd64 arc arm armeb armv4 armv4eb armv6 armv6eb armv7 armv7eb cobalt convex dreamcast hpcmips hpcsh hppa hppa64 i386 i486 ia64 m5407 m68010 m68k m88k mips mips64 mips64el mipseb mipsel mipsn32 mlrisc ns32k pc532 pmax powerpc powerpc64 rs6000 s390 sh shle sparc sparc64 vax x86_64 } for the hardware architecture part of MACHINE_GNU_PLATFORM.\n"+
		"WARN: fname:2: The pattern \"amd64\" cannot match any of { bitrig bsdos cygwin darwin dragonfly freebsd haiku hpux interix irix linux mirbsd netbsd openbsd osf1 solaris sunos } for the operating system part of MACHINE_GNU_PLATFORM.\n")
}

func (s *Suite) Test_VartypeCheck_MailAddress(c *check.C) {
	runVartypeChecks("MAINTAINER", opAssign, (*VartypeCheck).MailAddress,
		"pkgsrc-users@netbsd.org")

	c.Check(s.Output(), equals, "WARN: fname:1: Please write \"NetBSD.org\" instead of \"netbsd.org\".\n")
}

func (s *Suite) Test_VartypeCheck_Message(c *check.C) {
	runVartypeChecks("SUBST_MESSAGE.id", opAssign, (*VartypeCheck).Message,
		"\"Correct paths\"",
		"Correct paths")

	c.Check(s.Output(), equals, "WARN: fname:1: SUBST_MESSAGE.id should not be quoted.\n")
}

func (s *Suite) Test_VartypeCheck_Option(c *check.C) {
	G.globalData.PkgOptions = map[string]string{
		"documented":   "Option description",
		"undocumented": "",
	}

	runVartypeChecks("PKG_OPTIONS.pkgbase", opAssign, (*VartypeCheck).Option,
		"documented",
		"undocumented",
		"unknown")

	c.Check(s.Output(), equals, "WARN: fname:3: Unknown option \"unknown\".\n")
}

func (s *Suite) Test_VartypeCheck_Pathlist(c *check.C) {
	runVartypeChecks("PATH", opAssign, (*VartypeCheck).Pathlist,
		"/usr/bin:/usr/sbin:.:${LOCALBASE}/bin")

	c.Check(s.Output(), equals, "WARN: fname:1: All components of PATH (in this case \".\") should be absolute paths.\n")
}

func (s *Suite) Test_VartypeCheck_Perms(c *check.C) {
	runVartypeChecks("CONF_FILES_PERMS", opAssignAppend, (*VartypeCheck).Perms,
		"root",
		"${ROOT_USER}",
		"ROOT_USER",
		"${REAL_ROOT_USER}")

	c.Check(s.Output(), equals, "ERROR: fname:2: ROOT_USER must not be used in permission definitions. Use REAL_ROOT_USER instead.\n")
}

func (s *Suite) Test_VartypeCheck_PkgOptionsVar(c *check.C) {
	runVartypeChecks("PKG_OPTIONS_VAR.screen", opAssign, (*VartypeCheck).PkgOptionsVar,
		"PKG_OPTIONS.${PKGBASE}",
		"PKG_OPTIONS.anypkgbase")

	c.Check(s.Output(), equals, ""+
		"ERROR: fname:1: PKGBASE must not be used in PKG_OPTIONS_VAR.\n")
}

func (s *Suite) Test_VartypeCheck_PkgRevision(c *check.C) {
	runVartypeChecks("PKGREVISION", opAssign, (*VartypeCheck).PkgRevision,
		"3a")

	c.Check(s.Output(), equals, ""+
		"WARN: fname:1: PKGREVISION must be a positive integer number.\n"+
		"ERROR: fname:1: PKGREVISION only makes sense directly in the package Makefile.\n")

	runVartypeChecksFname("Makefile", "PKGREVISION", opAssign, (*VartypeCheck).PkgRevision,
		"3")

	c.Check(s.Output(), equals, "")
}

func (s *Suite) Test_VartypeCheck_MachinePlatformPattern(c *check.C) {
	runVartypeMatchChecks("ONLY_FOR_PLATFORM", (*VartypeCheck).MachinePlatformPattern,
		"linux-i386",
		"nextbsd-5.0-8087",
		"netbsd-7.0-l*",
		"NetBSD-1.6.2-i386",
		"FreeBSD*",
		"FreeBSD-*",
		"${LINUX}")

	c.Check(s.Output(), equals, ""+
		"WARN: fname:1: \"linux-i386\" is not a valid platform pattern.\n"+
		"WARN: fname:2: The pattern \"nextbsd\" cannot match any of { AIX BSDOS Bitrig Cygwin Darwin DragonFly FreeBSD FreeMiNT GNUkFreeBSD HPUX Haiku IRIX Interix Linux Minix MirBSD NetBSD OSF1 OpenBSD QNX SCO_SV SunOS UnixWare } for the operating system part of ONLY_FOR_PLATFORM.\n"+
		"WARN: fname:2: The pattern \"8087\" cannot match any of { aarch64 aarch64eb alpha amd64 arc arm arm26 arm32 cobalt coldfire convex dreamcast earm earmeb earmhf earmhfeb earmv4 earmv4eb earmv5 earmv5eb earmv6 earmv6eb earmv6hf earmv6hfeb earmv7 earmv7eb earmv7hf earmv7hfeb evbarm hpcmips hpcsh hppa hppa64 i386 i586 i686 ia64 m68000 m68k m88k mips mips64 mips64eb mips64el mipseb mipsel mipsn32 mlrisc ns32k pc532 pmax powerpc powerpc64 rs6000 s390 sh3eb sh3el sparc sparc64 vax x86_64 } for the hardware architecture part of ONLY_FOR_PLATFORM.\n"+
		"WARN: fname:3: The pattern \"netbsd\" cannot match any of { AIX BSDOS Bitrig Cygwin Darwin DragonFly FreeBSD FreeMiNT GNUkFreeBSD HPUX Haiku IRIX Interix Linux Minix MirBSD NetBSD OSF1 OpenBSD QNX SCO_SV SunOS UnixWare } for the operating system part of ONLY_FOR_PLATFORM.\n"+
		"WARN: fname:3: The pattern \"l*\" cannot match any of { aarch64 aarch64eb alpha amd64 arc arm arm26 arm32 cobalt coldfire convex dreamcast earm earmeb earmhf earmhfeb earmv4 earmv4eb earmv5 earmv5eb earmv6 earmv6eb earmv6hf earmv6hfeb earmv7 earmv7eb earmv7hf earmv7hfeb evbarm hpcmips hpcsh hppa hppa64 i386 i586 i686 ia64 m68000 m68k m88k mips mips64 mips64eb mips64el mipseb mipsel mipsn32 mlrisc ns32k pc532 pmax powerpc powerpc64 rs6000 s390 sh3eb sh3el sparc sparc64 vax x86_64 } for the hardware architecture part of ONLY_FOR_PLATFORM.\n"+
		"WARN: fname:5: \"FreeBSD*\" is not a valid platform pattern.\n")
}

func (s *Suite) Test_VartypeCheck_PythonDependency(c *check.C) {
	runVartypeChecks("PYTHON_VERSIONED_DEPENDENCIES", opAssign, (*VartypeCheck).PythonDependency,
		"cairo",
		"${PYDEP}",
		"cairo,X")

	c.Check(s.Output(), equals, ""+
		"WARN: fname:2: Python dependencies should not contain variables.\n"+
		"WARN: fname:3: Invalid Python dependency \"cairo,X\".\n")
}

func (s *Suite) Test_VartypeCheck_Restricted(c *check.C) {
	runVartypeChecks("NO_BIN_ON_CDROM", opAssign, (*VartypeCheck).Restricted,
		"May only be distributed free of charge")

	c.Check(s.Output(), equals, "WARN: fname:1: The only valid value for NO_BIN_ON_CDROM is ${RESTRICTED}.\n")
}

func (s *Suite) Test_VartypeCheck_SedCommands(c *check.C) {
	runVartypeChecks("SUBST_SED.dummy", opAssign, (*VartypeCheck).SedCommands,
		"s,@COMPILER@,gcc,g",
		"-e s,a,b, -e a,b,c,",
		"-e \"s,#,comment ,\"",
		"-e \"s,\\#,comment ,\"")

	c.Check(s.Output(), equals, ""+
		"NOTE: fname:1: Please always use \"-e\" in sed commands, even if there is only one substitution.\n"+
		"NOTE: fname:2: Each sed command should appear in an assignment of its own.\n")
}

func (s *Suite) Test_VartypeCheck_ShellCommands(c *check.C) {
	runVartypeChecks("GENERATE_PLIST", opAssign, (*VartypeCheck).ShellCommands,
		"echo bin/program",
		"echo bin/program;")

	c.Check(s.Output(), equals, "WARN: fname:1: This shell command list should end with a semicolon.\n")
}

func (s *Suite) Test_VartypeCheck_Stage(c *check.C) {
	runVartypeChecks("SUBST_STAGE.dummy", opAssign, (*VartypeCheck).Stage,
		"post-patch",
		"post-modern",
		"pre-test")

	c.Check(s.Output(), equals, "WARN: fname:2: Invalid stage name \"post-modern\". Use one of {pre,do,post}-{extract,patch,configure,build,test,install}.\n")
}

func (s *Suite) Test_VartypeCheck_VariableName(c *check.C) {
	runVartypeChecks("BUILD_DEFS", opAssign, (*VartypeCheck).VariableName,
		"VARBASE",
		"VarBase",
		"PKG_OPTIONS_VAR.pkgbase",
		"${INDIRECT}")

	c.Check(s.Output(), equals, "WARN: fname:2: \"VarBase\" is not a valid variable name.\n")
}

func (s *Suite) Test_VartypeCheck_Version(c *check.C) {
	runVartypeChecks("PERL5_REQD", opAssignAppend, (*VartypeCheck).Version,
		"0",
		"1.2.3.4.5.6",
		"4.1nb17",
		"4.1-SNAPSHOT",
		"4pre7")

	c.Check(s.Output(), equals, "WARN: fname:4: Invalid version number \"4.1-SNAPSHOT\".\n")
}

func (s *Suite) Test_VartypeCheck_Yes(c *check.C) {
	runVartypeChecks("APACHE_MODULE", opAssign, (*VartypeCheck).Yes,
		"yes",
		"no",
		"${YESVAR}")

	c.Check(s.Output(), equals, ""+
		"WARN: fname:2: APACHE_MODULE should be set to YES or yes.\n"+
		"WARN: fname:3: APACHE_MODULE should be set to YES or yes.\n")

	runVartypeMatchChecks("PKG_DEVELOPER", (*VartypeCheck).Yes,
		"yes",
		"no",
		"${YESVAR}")

	c.Check(s.Output(), equals, ""+
		"WARN: fname:1: PKG_DEVELOPER should only be used in a \".if defined(...)\" conditional.\n"+
		"WARN: fname:2: PKG_DEVELOPER should only be used in a \".if defined(...)\" conditional.\n"+
		"WARN: fname:3: PKG_DEVELOPER should only be used in a \".if defined(...)\" conditional.\n")
}

func (s *Suite) Test_VartypeCheck_YesNo(c *check.C) {
	runVartypeChecks("GNU_CONFIGURE", opAssign, (*VartypeCheck).YesNo,
		"yes",
		"no",
		"ja",
		"${YESVAR}")

	c.Check(s.Output(), equals, ""+
		"WARN: fname:3: GNU_CONFIGURE should be set to YES, yes, NO, or no.\n"+
		"WARN: fname:4: GNU_CONFIGURE should be set to YES, yes, NO, or no.\n")
}

func (s *Suite) Test_VartypeCheck_YesNoIndirectly(c *check.C) {
	runVartypeChecks("GNU_CONFIGURE", opAssign, (*VartypeCheck).YesNoIndirectly,
		"yes",
		"no",
		"ja",
		"${YESVAR}")

	c.Check(s.Output(), equals, ""+
		"WARN: fname:3: GNU_CONFIGURE should be set to YES, yes, NO, or no.\n")
}

func runVartypeChecks(varname string, op MkOperator, checker func(*VartypeCheck), values ...string) {
	if !contains(op.String(), "=") {
		panic("runVartypeChecks needs an assignment operator")
	}
	for i, value := range values {
		mkline := NewMkLine(NewLine("fname", i+1, varname+op.String()+value, nil))
		valueNovar := mkline.withoutMakeVariables(mkline.Value())
		vc := &VartypeCheck{mkline, mkline.Line, mkline.Varname(), mkline.Op(), mkline.Value(), valueNovar, "", false}
		checker(vc)
	}
}

func runVartypeMatchChecks(varname string, checker func(*VartypeCheck), values ...string) {
	for i, value := range values {
		text := fmt.Sprintf(".if ${%s:M%s} == \"\"", varname, value)
		mkline := NewMkLine(NewLine("fname", i+1, text, nil))
		valueNovar := mkline.withoutMakeVariables(value)
		vc := &VartypeCheck{mkline, mkline.Line, varname, opUseMatch, value, valueNovar, "", false}
		checker(vc)
	}
}

func runVartypeChecksFname(fname, varname string, op MkOperator, checker func(*VartypeCheck), values ...string) {
	for i, value := range values {
		mkline := NewMkLine(NewLine(fname, i+1, varname+op.String()+value, nil))
		valueNovar := mkline.withoutMakeVariables(value)
		vc := &VartypeCheck{mkline, mkline.Line, varname, op, value, valueNovar, "", false}
		checker(vc)
	}
}