parse_test.go 20.7 KB
Newer Older
1 2 3
package cli

import (
4 5
	"context"
	"fmt"
6 7
	"io"
	"io/ioutil"
jmank88's avatar
jmank88 committed
8
	"net/url"
9
	"os"
10
	"path"
rht's avatar
rht committed
11 12
	"strings"
	"testing"
Matt Bell's avatar
Matt Bell committed
13

Hector Sanjuan's avatar
Hector Sanjuan committed
14 15
	files "github.com/ipfs/go-ipfs-files"

16
	cmds "github.com/ipfs/go-ipfs-cmds"
17 18
)

19 20 21 22
type kvs map[string]interface{}
type words []string

func sameWords(a words, b words) bool {
23 24 25
	if len(a) != len(b) {
		return false
	}
26 27 28 29 30 31 32 33 34 35 36 37 38
	for i, w := range a {
		if w != b[i] {
			return false
		}
	}
	return true
}

func sameKVs(a kvs, b kvs) bool {
	if len(a) != len(b) {
		return false
	}
	for k, v := range a {
39 40 41 42 43 44 45 46
		if ks, ok := v.([]string); ok {
			bks, _ := b[k].([]string)
			for i := 0; i < len(ks); i++ {
				if ks[i] != bks[i] {
					return false
				}
			}
		} else if v != b[k] {
47 48 49 50 51 52
			return false
		}
	}
	return true
}

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
func TestSameWords(t *testing.T) {
	a := []string{"v1", "v2"}
	b := []string{"v1", "v2", "v3"}
	c := []string{"v2", "v3"}
	d := []string{"v2"}
	e := []string{"v2", "v3"}
	f := []string{"v2", "v1"}

	test := func(a words, b words, v bool) {
		if sameWords(a, b) != v {
			t.Errorf("sameWords('%v', '%v') != %v", a, b, v)
		}
	}

	test(a, b, false)
	test(a, a, true)
	test(a, c, false)
	test(b, c, false)
	test(c, d, false)
	test(c, e, true)
	test(b, e, false)
	test(a, b, false)
	test(a, f, false)
	test(e, f, false)
	test(f, f, true)
}

80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97
func testOptionHelper(t *testing.T, cmd *cmds.Command, args string, expectedOpts kvs, expectedWords words, expectErr bool) {
	req := &cmds.Request{}
	err := parse(req, strings.Split(args, " "), cmd)
	if err == nil {
		err = req.FillDefaults()
	}
	if expectErr {
		if err == nil {
			t.Errorf("Command line '%v' parsing should have failed", args)
		}
	} else if err != nil {
		t.Errorf("Command line '%v' failed to parse: %v", args, err)
	} else if !sameWords(req.Arguments, expectedWords) || !sameKVs(kvs(req.Options), expectedOpts) {
		t.Errorf("Command line '%v':\n  parsed as  %v %v\n  instead of %v %v",
			args, req.Options, req.Arguments, expectedOpts, expectedWords)
	}
}

98
func TestOptionParsing(t *testing.T) {
Jan Winkelmann's avatar
Jan Winkelmann committed
99
	cmd := &cmds.Command{
Steven Allen's avatar
Steven Allen committed
100 101
		Options: []cmds.Option{
			cmds.StringOption("string", "s", "a string"),
102
			cmds.StringOption("flag", "alias", "multiple long"),
Steven Allen's avatar
Steven Allen committed
103
			cmds.BoolOption("bool", "b", "a bool"),
104
			cmds.StringsOption("strings", "r", "strings array"),
105
			cmds.DelimitedStringsOption(",", "delimstrings", "d", "comma delimited string array"),
Juan Batiz-Benet's avatar
Juan Batiz-Benet committed
106
		},
Jan Winkelmann's avatar
Jan Winkelmann committed
107
		Subcommands: map[string]*cmds.Command{
108 109
			"test": &cmds.Command{},
			"defaults": &cmds.Command{
Steven Allen's avatar
Steven Allen committed
110 111
				Options: []cmds.Option{
					cmds.StringOption("opt", "o", "an option").WithDefault("def"),
112 113
				},
			},
Matt Bell's avatar
Matt Bell committed
114
		},
Juan Batiz-Benet's avatar
Juan Batiz-Benet committed
115
	}
116

Etienne Laurin's avatar
Etienne Laurin committed
117
	testFail := func(args string) {
118
		testOptionHelper(t, cmd, args, kvs{}, words{}, true)
Juan Batiz-Benet's avatar
Juan Batiz-Benet committed
119
	}
Etienne Laurin's avatar
Etienne Laurin committed
120 121

	test := func(args string, expectedOpts kvs, expectedWords words) {
122
		testOptionHelper(t, cmd, args, expectedOpts, expectedWords, false)
Matt Bell's avatar
Matt Bell committed
123
	}
Etienne Laurin's avatar
Etienne Laurin committed
124

125
	test("test -", kvs{}, words{"-"})
Etienne Laurin's avatar
Etienne Laurin committed
126 127 128
	testFail("-b -b")
	test("test beep boop", kvs{}, words{"beep", "boop"})
	testFail("-s")
129 130 131 132 133 134 135
	test("-s foo", kvs{"string": "foo"}, words{})
	test("-sfoo", kvs{"string": "foo"}, words{})
	test("-s=foo", kvs{"string": "foo"}, words{})
	test("-b", kvs{"bool": true}, words{})
	test("-bs foo", kvs{"bool": true, "string": "foo"}, words{})
	test("-sb", kvs{"string": "b"}, words{})
	test("-b test foo", kvs{"bool": true}, words{"foo"})
136
	test("--bool test foo", kvs{"bool": true}, words{"foo"})
Etienne Laurin's avatar
Etienne Laurin committed
137 138 139 140 141
	testFail("--bool=foo")
	testFail("--string")
	test("--string foo", kvs{"string": "foo"}, words{})
	test("--string=foo", kvs{"string": "foo"}, words{})
	test("-- -b", kvs{}, words{"-b"})
142 143 144 145 146
	test("test foo -b", kvs{"bool": true}, words{"foo"})
	test("-b=false", kvs{"bool": false}, words{})
	test("-b=true", kvs{"bool": true}, words{})
	test("-b=false test foo", kvs{"bool": false}, words{"foo"})
	test("-b=true test foo", kvs{"bool": true}, words{"foo"})
147 148
	test("--bool=true test foo", kvs{"bool": true}, words{"foo"})
	test("--bool=false test foo", kvs{"bool": false}, words{"foo"})
149 150 151 152 153 154 155 156
	test("-b test true", kvs{"bool": true}, words{"true"})
	test("-b test false", kvs{"bool": true}, words{"false"})
	test("-b=FaLsE test foo", kvs{"bool": false}, words{"foo"})
	test("-b=TrUe test foo", kvs{"bool": true}, words{"foo"})
	test("-b test true", kvs{"bool": true}, words{"true"})
	test("-b test false", kvs{"bool": true}, words{"false"})
	test("-b --string foo test bar", kvs{"bool": true, "string": "foo"}, words{"bar"})
	test("-b=false --string bar", kvs{"bool": false, "string": "bar"}, words{})
157
	test("--strings a --strings b", kvs{"strings": []string{"a", "b"}}, words{})
158 159 160 161 162 163 164

	test("--delimstrings a,b", kvs{"delimstrings": []string{"a", "b"}}, words{})
	test("--delimstrings=a,b", kvs{"delimstrings": []string{"a", "b"}}, words{})
	test("-d a,b", kvs{"delimstrings": []string{"a", "b"}}, words{})
	test("-d=a,b", kvs{"delimstrings": []string{"a", "b"}}, words{})
	test("-d=a,b -d c --delimstrings d", kvs{"delimstrings": []string{"a", "b", "c", "d"}}, words{})

165
	testFail("foo test")
166 167
	test("defaults", kvs{"opt": "def"}, words{})
	test("defaults -o foo", kvs{"opt": "foo"}, words{})
168

169 170 171 172 173
	test("--flag=foo", kvs{"flag": "foo"}, words{})
	test("--alias=foo", kvs{"flag": "foo"}, words{})
	testFail("--flag=bar --alias=foo")
	testFail("--alias=bar --flag=foo")

174 175 176 177 178
	testFail("--bad-flag")
	testFail("--bad-flag=")
	testFail("--bad-flag=xyz")
	testFail("-z")
	testFail("-zz--- --")
179
}
180 181

func TestArgumentParsing(t *testing.T) {
Jan Winkelmann's avatar
Jan Winkelmann committed
182 183
	rootCmd := &cmds.Command{
		Subcommands: map[string]*cmds.Command{
rht's avatar
rht committed
184 185
			"noarg": {},
			"onearg": {
Steven Allen's avatar
Steven Allen committed
186 187
				Arguments: []cmds.Argument{
					cmds.StringArg("a", true, false, "some arg"),
188 189
				},
			},
rht's avatar
rht committed
190
			"twoargs": {
Steven Allen's avatar
Steven Allen committed
191 192 193
				Arguments: []cmds.Argument{
					cmds.StringArg("a", true, false, "some arg"),
					cmds.StringArg("b", true, false, "another arg"),
194 195
				},
			},
rht's avatar
rht committed
196
			"variadic": {
Steven Allen's avatar
Steven Allen committed
197 198
				Arguments: []cmds.Argument{
					cmds.StringArg("a", true, true, "some arg"),
199 200
				},
			},
rht's avatar
rht committed
201
			"optional": {
Steven Allen's avatar
Steven Allen committed
202 203
				Arguments: []cmds.Argument{
					cmds.StringArg("b", false, true, "another arg"),
204 205
				},
			},
206
			"optionalsecond": {
Steven Allen's avatar
Steven Allen committed
207 208 209
				Arguments: []cmds.Argument{
					cmds.StringArg("a", true, false, "some arg"),
					cmds.StringArg("b", false, false, "another arg"),
210 211
				},
			},
rht's avatar
rht committed
212
			"reversedoptional": {
Steven Allen's avatar
Steven Allen committed
213 214 215
				Arguments: []cmds.Argument{
					cmds.StringArg("a", false, false, "some arg"),
					cmds.StringArg("b", true, false, "another arg"),
216 217 218 219 220
				},
			},
		},
	}

221
	test := func(cmd words, f *os.File, res words) {
222
		if f != nil {
Hector Sanjuan's avatar
Hector Sanjuan committed
223
			if _, err := f.Seek(0, io.SeekStart); err != nil {
224 225 226
				t.Fatal(err)
			}
		}
227 228
		ctx := context.Background()
		req, err := Parse(ctx, cmd, f, rootCmd)
229
		if err != nil {
230
			t.Errorf("Command '%v' should have passed parsing: %v", cmd, err)
231
		}
232 233
		if !sameWords(req.Arguments, res) {
			t.Errorf("Arguments parsed from '%v' are '%v' instead of '%v'", cmd, req.Arguments, res)
234
		}
235
	}
236

Jeromy's avatar
Jeromy committed
237
	testFail := func(cmd words, fi *os.File, msg string) {
238
		_, err := Parse(context.Background(), cmd, nil, rootCmd)
239 240 241
		if err == nil {
			t.Errorf("Should have failed: %v", msg)
		}
242 243
	}

244
	test([]string{"noarg"}, nil, []string{})
Jeromy's avatar
Jeromy committed
245
	testFail([]string{"noarg", "value!"}, nil, "provided an arg, but command didn't define any")
246

247
	test([]string{"onearg", "value!"}, nil, []string{"value!"})
Jeromy's avatar
Jeromy committed
248
	testFail([]string{"onearg"}, nil, "didn't provide any args, arg is required")
249

250
	test([]string{"twoargs", "value1", "value2"}, nil, []string{"value1", "value2"})
Jeromy's avatar
Jeromy committed
251 252
	testFail([]string{"twoargs", "value!"}, nil, "only provided 1 arg, needs 2")
	testFail([]string{"twoargs"}, nil, "didn't provide any args, 2 required")
253

254 255
	test([]string{"variadic", "value!"}, nil, []string{"value!"})
	test([]string{"variadic", "value1", "value2", "value3"}, nil, []string{"value1", "value2", "value3"})
Jeromy's avatar
Jeromy committed
256
	testFail([]string{"variadic"}, nil, "didn't provide any args, 1 required")
257

258 259
	test([]string{"optional", "value!"}, nil, []string{"value!"})
	test([]string{"optional"}, nil, []string{})
260 261 262 263
	test([]string{"optional", "value1", "value2"}, nil, []string{"value1", "value2"})

	test([]string{"optionalsecond", "value!"}, nil, []string{"value!"})
	test([]string{"optionalsecond", "value1", "value2"}, nil, []string{"value1", "value2"})
Jeromy's avatar
Jeromy committed
264 265
	testFail([]string{"optionalsecond"}, nil, "didn't provide any args, 1 required")
	testFail([]string{"optionalsecond", "value1", "value2", "value3"}, nil, "provided too many args, takes 2 maximum")
266 267 268

	test([]string{"reversedoptional", "value1", "value2"}, nil, []string{"value1", "value2"})
	test([]string{"reversedoptional", "value!"}, nil, []string{"value!"})
269

Jeromy's avatar
Jeromy committed
270 271
	testFail([]string{"reversedoptional"}, nil, "didn't provide any args, 1 required")
	testFail([]string{"reversedoptional", "value1", "value2", "value3"}, nil, "provided too many args, only takes 1")
272

273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291
}

func errEq(err1, err2 error) bool {
	if err1 == nil && err2 == nil {
		return true
	}

	if err1 == nil || err2 == nil {
		return false
	}

	return err1.Error() == err2.Error()
}

func TestBodyArgs(t *testing.T) {
	rootCmd := &cmds.Command{
		Subcommands: map[string]*cmds.Command{
			"noarg": {},
			"stdinenabled": {
Steven Allen's avatar
Steven Allen committed
292 293
				Arguments: []cmds.Argument{
					cmds.StringArg("a", true, true, "some arg").EnableStdin(),
294 295 296
				},
			},
			"stdinenabled2args": &cmds.Command{
Steven Allen's avatar
Steven Allen committed
297 298 299
				Arguments: []cmds.Argument{
					cmds.StringArg("a", true, false, "some arg"),
					cmds.StringArg("b", true, true, "another arg").EnableStdin(),
300 301 302
				},
			},
			"stdinenablednotvariadic": &cmds.Command{
Steven Allen's avatar
Steven Allen committed
303 304
				Arguments: []cmds.Argument{
					cmds.StringArg("a", true, false, "some arg").EnableStdin(),
305 306 307
				},
			},
			"stdinenablednotvariadic2args": &cmds.Command{
Steven Allen's avatar
Steven Allen committed
308 309 310
				Arguments: []cmds.Argument{
					cmds.StringArg("a", true, false, "some arg"),
					cmds.StringArg("b", true, false, "another arg").EnableStdin(),
311 312 313
				},
			},
			"optionalsecond": {
Steven Allen's avatar
Steven Allen committed
314 315 316
				Arguments: []cmds.Argument{
					cmds.StringArg("a", true, false, "some arg"),
					cmds.StringArg("b", false, false, "another arg"),
317 318
				},
			},
319
			"optionalstdin": {
Steven Allen's avatar
Steven Allen committed
320 321 322
				Arguments: []cmds.Argument{
					cmds.StringArg("a", true, false, "some arg"),
					cmds.StringArg("b", false, false, "another arg").EnableStdin(),
323 324 325
				},
			},
			"optionalvariadicstdin": {
Steven Allen's avatar
Steven Allen committed
326 327 328
				Arguments: []cmds.Argument{
					cmds.StringArg("a", true, false, "some arg"),
					cmds.StringArg("b", false, true, "another arg").EnableStdin(),
329 330
				},
			},
331 332 333
		},
	}

334 335 336
	// Use a temp file to simulate stdin
	fileToSimulateStdin := func(t *testing.T, content string) *os.File {
		fstdin, err := ioutil.TempFile("", "")
337 338 339
		if err != nil {
			t.Fatal(err)
		}
340 341 342
		defer os.Remove(fstdin.Name())

		if _, err := io.WriteString(fstdin, content); err != nil {
343 344
			t.Fatal(err)
		}
345
		return fstdin
346
	}
347

348 349 350 351 352
	fstdin1 := fileToSimulateStdin(t, "stdin1")
	fstdin12 := fileToSimulateStdin(t, "stdin1\nstdin2")
	fstdin123 := fileToSimulateStdin(t, "stdin1\nstdin2\nstdin3")

	var tcs = []struct {
353 354 355 356 357
		cmd              words
		f                *os.File
		posArgs, varArgs words
		parseErr         error
		bodyArgs         bool
358 359 360 361
	}{
		{
			cmd: words{"stdinenabled", "value1", "value2"}, f: nil,
			posArgs: words{"value1", "value2"}, varArgs: nil,
362
			parseErr: nil, bodyArgs: false,
363 364 365
		},
		{
			cmd: words{"stdinenabled"}, f: fstdin1,
366 367
			posArgs: words{"stdin1"}, varArgs: words{},
			parseErr: nil, bodyArgs: true,
368 369 370 371
		},
		{
			cmd: words{"stdinenabled", "value1"}, f: fstdin1,
			posArgs: words{"value1"}, varArgs: words{},
372
			parseErr: nil, bodyArgs: false,
373 374 375 376
		},
		{
			cmd: words{"stdinenabled", "value1", "value2"}, f: fstdin1,
			posArgs: words{"value1", "value2"}, varArgs: words{},
377
			parseErr: nil, bodyArgs: false,
378 379 380
		},
		{
			cmd: words{"stdinenabled"}, f: fstdin12,
381 382
			posArgs: words{"stdin1"}, varArgs: words{"stdin2"},
			parseErr: nil, bodyArgs: true,
383 384 385
		},
		{
			cmd: words{"stdinenabled"}, f: fstdin123,
386 387
			posArgs: words{"stdin1"}, varArgs: words{"stdin2", "stdin3"},
			parseErr: nil, bodyArgs: true,
388 389 390 391
		},
		{
			cmd: words{"stdinenabled2args", "value1", "value2"}, f: nil,
			posArgs: words{"value1", "value2"}, varArgs: words{},
392
			parseErr: nil, bodyArgs: false,
393 394 395
		},
		{
			cmd: words{"stdinenabled2args", "value1"}, f: fstdin1,
396
			posArgs: words{"value1", "stdin1"}, varArgs: words{},
397
			parseErr: nil, bodyArgs: true,
398 399 400 401
		},
		{
			cmd: words{"stdinenabled2args", "value1", "value2"}, f: fstdin1,
			posArgs: words{"value1", "value2"}, varArgs: words{},
402
			parseErr: nil, bodyArgs: false,
403 404 405 406
		},
		{
			cmd: words{"stdinenabled2args", "value1", "value2", "value3"}, f: fstdin1,
			posArgs: words{"value1", "value2", "value3"}, varArgs: words{},
407
			parseErr: nil, bodyArgs: false,
408 409 410
		},
		{
			cmd: words{"stdinenabled2args", "value1"}, f: fstdin12,
411
			posArgs: words{"value1", "stdin1"}, varArgs: words{"stdin2"},
412
			parseErr: nil, bodyArgs: true,
413 414 415 416
		},
		{
			cmd: words{"stdinenablednotvariadic", "value1"}, f: nil,
			posArgs: words{"value1"}, varArgs: words{},
417
			parseErr: nil, bodyArgs: false,
418 419 420
		},
		{
			cmd: words{"stdinenablednotvariadic"}, f: fstdin1,
421 422
			posArgs: words{"stdin1"}, varArgs: words{},
			parseErr: nil, bodyArgs: true,
423 424 425 426
		},
		{
			cmd: words{"stdinenablednotvariadic", "value1"}, f: fstdin1,
			posArgs: words{"value1"}, varArgs: words{"value1"},
427
			parseErr: nil, bodyArgs: false,
428 429 430 431
		},
		{
			cmd: words{"stdinenablednotvariadic2args", "value1", "value2"}, f: nil,
			posArgs: words{"value1", "value2"}, varArgs: words{},
432
			parseErr: nil, bodyArgs: false,
433 434 435
		},
		{
			cmd: words{"stdinenablednotvariadic2args", "value1"}, f: fstdin1,
436
			posArgs: words{"value1", "stdin1"}, varArgs: words{},
437
			parseErr: nil, bodyArgs: true,
438 439 440 441
		},
		{
			cmd: words{"stdinenablednotvariadic2args", "value1", "value2"}, f: fstdin1,
			posArgs: words{"value1", "value2"}, varArgs: words{},
442
			parseErr: nil, bodyArgs: false,
443 444 445 446
		},
		{
			cmd: words{"stdinenablednotvariadic2args"}, f: fstdin1,
			posArgs: words{}, varArgs: words{},
447
			parseErr: fmt.Errorf(`argument %q is required`, "a"), bodyArgs: true,
448 449 450 451
		},
		{
			cmd: words{"stdinenablednotvariadic2args", "value1"}, f: nil,
			posArgs: words{"value1"}, varArgs: words{},
452
			parseErr: fmt.Errorf(`argument %q is required`, "b"), bodyArgs: true,
453 454 455 456
		},
		{
			cmd: words{"noarg"}, f: fstdin1,
			posArgs: words{}, varArgs: words{},
457
			parseErr: nil, bodyArgs: false,
458 459 460 461
		},
		{
			cmd: words{"optionalsecond", "value1", "value2"}, f: fstdin1,
			posArgs: words{"value1", "value2"}, varArgs: words{},
462
			parseErr: nil, bodyArgs: false,
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 492 493
		{
			cmd: words{"optionalstdin", "value1"}, f: fstdin1,
			posArgs: words{"value1"}, varArgs: words{"stdin1"},
			parseErr: nil, bodyArgs: true,
		},
		{
			cmd: words{"optionalstdin", "value1"}, f: nil,
			posArgs: words{"value1"}, varArgs: words{},
			parseErr: nil, bodyArgs: false,
		},
		{
			cmd: words{"optionalstdin"}, f: fstdin1,
			posArgs: words{"value1"}, varArgs: words{},
			parseErr: fmt.Errorf(`argument %q is required`, "a"), bodyArgs: false,
		},
		{
			cmd: words{"optionalvariadicstdin", "value1"}, f: nil,
			posArgs: words{"value1"}, varArgs: words{},
			parseErr: nil, bodyArgs: false,
		},
		{
			cmd: words{"optionalvariadicstdin", "value1"}, f: fstdin1,
			posArgs: words{"value1"}, varArgs: words{"stdin1"},
			parseErr: nil, bodyArgs: true,
		},
		{
			cmd: words{"optionalvariadicstdin", "value1"}, f: fstdin12,
			posArgs: words{"value1"}, varArgs: words{"stdin1", "stdin2"},
			parseErr: nil, bodyArgs: true,
		},
494
	}
495

496 497
	for _, tc := range tcs {
		if tc.f != nil {
Hector Sanjuan's avatar
Hector Sanjuan committed
498
			if _, err := tc.f.Seek(0, io.SeekStart); err != nil {
499 500 501
				t.Fatal(err)
			}
		}
502

503
		req, err := Parse(context.Background(), tc.cmd, tc.f, rootCmd)
504 505 506
		if err == nil {
			err = req.Command.CheckArguments(req)
		}
507 508 509 510 511 512
		if !errEq(err, tc.parseErr) {
			t.Fatalf("parsing request for cmd %q: expected error %q, got %q", tc.cmd, tc.parseErr, err)
		}
		if err != nil {
			continue
		}
513

514 515 516
		if !sameWords(req.Arguments, tc.posArgs) {
			t.Errorf("Arguments parsed from %v are %v instead of %v", tc.cmd, req.Arguments, tc.posArgs)
		}
517

518 519 520 521 522
		s := req.BodyArgs()
		if !tc.bodyArgs {
			if s != nil {
				t.Fatalf("expected no BodyArgs for cmd %q", tc.cmd)
			}
523 524 525
			continue
		}
		if s == nil {
526
			t.Fatalf("expected BodyArgs for cmd %q", tc.cmd)
527
		}
528

529
		var bodyArgs words
530 531 532 533 534
		for s.Scan() {
			bodyArgs = append(bodyArgs, s.Argument())
		}
		if err := s.Err(); err != nil {
			t.Fatal(err)
535
		}
536

537 538 539 540
		if !sameWords(bodyArgs, tc.varArgs) {
			t.Errorf("BodyArgs parsed from %v are %v instead of %v", tc.cmd, bodyArgs, tc.varArgs)
		}
	}
541
}
jmank88's avatar
jmank88 committed
542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562

func Test_isURL(t *testing.T) {
	for _, u := range []string{
		"http://www.example.com",
		"https://www.example.com",
	} {
		if isURL(u) == nil {
			t.Errorf("expected url: %s", u)
		}
	}

	for _, u := range []string{
		"adir/afile",
		"http:/ /afile",
		"http:/a/file",
	} {
		if isURL(u) != nil {
			t.Errorf("expected non-url: %s", u)
		}
	}
}
jmank88's avatar
jmank88 committed
563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580

func Test_urlBase(t *testing.T) {
	for _, test := range []struct{ url, base string }{
		{"http://host", "host"},
		{"http://host/test", "test"},
		{"http://host/test?param=val", "test"},
		{"http://host/test?param=val&param2=val", "test"},
	} {
		u, err := url.Parse(test.url)
		if err != nil {
			t.Errorf("failed to parse %q: %v", test.url, err)
			continue
		}
		if got := urlBase(u); got != test.base {
			t.Errorf("expected %q but got %q", test.base, got)
		}
	}
}
581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653

func TestFileArgs(t *testing.T) {
	rootCmd := &cmds.Command{
		Subcommands: map[string]*cmds.Command{
			"fileOp": {
				Arguments: []cmds.Argument{
					cmds.FileArg("path", true, true, "The path to the file to be operated upon.").EnableRecursive().EnableStdin(),
				},
				Options: []cmds.Option{
					cmds.OptionRecursivePath, // a builtin option that allows recursive paths (-r, --recursive)
					cmds.OptionHidden,
					cmds.OptionIgnoreRules,
					cmds.OptionIgnore,
				},
			},
		},
	}
	mkTempFile := func(t *testing.T, dir, pattern, content string) *os.File {
		pat := "test_tmpFile_"
		if pattern != "" {
			pat = pattern
		}
		tmpFile, err := ioutil.TempFile(dir, pat)
		if err != nil {
			t.Fatal(err)
		}

		if _, err := io.WriteString(tmpFile, content); err != nil {
			t.Fatal(err)
		}
		return tmpFile
	}
	tmpDir1, err := ioutil.TempDir("", "parsetest_fileargs_tmpdir_")
	if err != nil {
		t.Fatal(err)
	}
	tmpDir2, err := ioutil.TempDir("", "parsetest_utildir_")
	if err != nil {
		t.Fatal(err)
	}
	tmpFile1 := mkTempFile(t, "", "", "test1")
	tmpFile2 := mkTempFile(t, tmpDir1, "", "toBeIgnored")
	tmpFile3 := mkTempFile(t, tmpDir1, "", "test3")
	ignoreFile := mkTempFile(t, tmpDir2, "", path.Base(tmpFile2.Name()))
	tmpHiddenFile := mkTempFile(t, tmpDir1, ".test_hidden_file_*", "test")
	defer func() {
		for _, f := range []string{
			tmpDir1,
			tmpFile1.Name(),
			tmpFile2.Name(),
			tmpHiddenFile.Name(),
			tmpFile3.Name(),
			ignoreFile.Name(),
			tmpDir2,
		} {
			os.Remove(f)
		}
	}()
	var testCases = []struct {
		cmd      words
		f        *os.File
		args     words
		parseErr error
	}{
		{
			cmd:      words{"fileOp"},
			args:     nil,
			parseErr: fmt.Errorf("argument %q is required", "path"),
		},
		{
			cmd: words{"fileOp", "--ignore", path.Base(tmpFile2.Name()), tmpDir1, tmpFile1.Name()}, f: nil,
			args:     words{tmpDir1, tmpFile1.Name(), tmpFile3.Name()},
			parseErr: fmt.Errorf(notRecursiveFmtStr, tmpDir1, "r"),
654 655
		},
		{
656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727
			cmd: words{"fileOp", tmpFile1.Name(), "--ignore", path.Base(tmpFile2.Name()), "--ignore"}, f: nil,
			args:     words{tmpDir1, tmpFile1.Name(), tmpFile3.Name()},
			parseErr: fmt.Errorf("missing argument for option %q", "ignore"),
		},
		{
			cmd: words{"fileOp", "-r", "--ignore", path.Base(tmpFile2.Name()), tmpDir1, tmpFile1.Name()}, f: nil,
			args:     words{tmpDir1, tmpFile1.Name(), tmpFile3.Name()},
			parseErr: nil,
		},
		{
			cmd: words{"fileOp", "--hidden", "-r", "--ignore", path.Base(tmpFile2.Name()), tmpDir1, tmpFile1.Name()}, f: nil,
			args:     words{tmpDir1, tmpFile1.Name(), tmpFile3.Name(), tmpHiddenFile.Name()},
			parseErr: nil,
		},
		{
			cmd: words{"fileOp", "-r", "--ignore", path.Base(tmpFile2.Name()), tmpDir1, tmpFile1.Name(), "--ignore", "anotherRule"}, f: nil,
			args:     words{tmpDir1, tmpFile1.Name(), tmpFile3.Name()},
			parseErr: nil,
		},
		{
			cmd: words{"fileOp", "-r", "--ignore-rules-path", ignoreFile.Name(), tmpDir1, tmpFile1.Name()}, f: nil,
			args:     words{tmpDir1, tmpFile1.Name(), tmpFile3.Name()},
			parseErr: nil,
		},
	}

	for _, tc := range testCases {
		req, err := Parse(context.Background(), tc.cmd, tc.f, rootCmd)
		if err == nil {
			err = req.Command.CheckArguments(req)
		}
		if !errEq(err, tc.parseErr) {
			t.Fatalf("parsing request for cmd %q: expected error %q, got %q", tc.cmd, tc.parseErr, err)
		}
		if err != nil {
			continue
		}

		if len(tc.args) == 0 {
			continue
		}
		expectedFileMap := make(map[string]bool)
		for _, arg := range tc.args {
			expectedFileMap[path.Base(arg)] = false
		}
		it := req.Files.Entries()
		for it.Next() {
			name := it.Name()
			if _, ok := expectedFileMap[name]; ok {
				expectedFileMap[name] = true
			} else {
				t.Errorf("found unexpected file %q in request %v", name, req)
			}
			file := it.Node()
			files.Walk(file, func(fpath string, nd files.Node) error {
				if fpath != "" {
					if _, ok := expectedFileMap[fpath]; ok {
						expectedFileMap[fpath] = true
					} else {
						t.Errorf("found unexpected file %q in request file arguments", fpath)
					}
				}
				return nil
			})
		}
		for p, found := range expectedFileMap {
			if !found {
				t.Errorf("failed to find expected path %q in req %v", p, req)
			}
		}
	}
}