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 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 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 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 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015
|
package kong_test
import (
"bytes"
"errors"
"fmt"
"strings"
"testing"
"github.com/alecthomas/assert/v2"
"github.com/alecthomas/repr"
"github.com/alecthomas/kong"
)
func mustNew(t *testing.T, cli interface{}, options ...kong.Option) *kong.Kong {
t.Helper()
options = append([]kong.Option{
kong.Name("test"),
kong.Exit(func(int) {
t.Helper()
t.Fatalf("unexpected exit()")
}),
}, options...)
parser, err := kong.New(cli, options...)
assert.NoError(t, err)
return parser
}
func TestPositionalArguments(t *testing.T) {
var cli struct {
User struct {
Create struct {
ID int `kong:"arg"`
First string `kong:"arg"`
Last string `kong:"arg"`
} `kong:"cmd"`
} `kong:"cmd"`
}
p := mustNew(t, &cli)
ctx, err := p.Parse([]string{"user", "create", "10", "Alec", "Thomas"})
assert.NoError(t, err)
assert.Equal(t, "user create <id> <first> <last>", ctx.Command())
t.Run("Missing", func(t *testing.T) {
_, err := p.Parse([]string{"user", "create", "10"})
assert.Error(t, err)
})
}
func TestBranchingArgument(t *testing.T) {
/*
app user create <id> <first> <last>
app user <id> delete
app user <id> rename <to>
*/
var cli struct {
User struct {
Create struct {
ID string `kong:"arg"`
First string `kong:"arg"`
Last string `kong:"arg"`
} `kong:"cmd"`
// Branching argument.
ID struct {
ID int `kong:"arg"`
Flag int
Delete struct{} `kong:"cmd"`
Rename struct {
To string
} `kong:"cmd"`
} `kong:"arg"`
} `kong:"cmd,help='User management.'"`
}
p := mustNew(t, &cli)
ctx, err := p.Parse([]string{"user", "10", "delete"})
assert.NoError(t, err)
assert.Equal(t, 10, cli.User.ID.ID)
assert.Equal(t, "user <id> delete", ctx.Command())
t.Run("Missing", func(t *testing.T) {
_, err = p.Parse([]string{"user"})
assert.Error(t, err)
})
}
func TestResetWithDefaults(t *testing.T) {
var cli struct {
Flag string
FlagWithDefault string `kong:"default='default'"`
}
cli.Flag = "BLAH"
cli.FlagWithDefault = "BLAH"
parser := mustNew(t, &cli)
_, err := parser.Parse([]string{})
assert.NoError(t, err)
assert.Equal(t, "", cli.Flag)
assert.Equal(t, "default", cli.FlagWithDefault)
}
func TestFlagSlice(t *testing.T) {
var cli struct {
Slice []int
}
parser := mustNew(t, &cli)
_, err := parser.Parse([]string{"--slice=1,2,3"})
assert.NoError(t, err)
assert.Equal(t, []int{1, 2, 3}, cli.Slice)
}
func TestFlagSliceWithSeparator(t *testing.T) {
var cli struct {
Slice []string
}
parser := mustNew(t, &cli)
_, err := parser.Parse([]string{`--slice=a\,b,c`})
assert.NoError(t, err)
assert.Equal(t, []string{"a,b", "c"}, cli.Slice)
}
func TestArgSlice(t *testing.T) {
var cli struct {
Slice []int `arg`
Flag bool
}
parser := mustNew(t, &cli)
_, err := parser.Parse([]string{"1", "2", "3", "--flag"})
assert.NoError(t, err)
assert.Equal(t, []int{1, 2, 3}, cli.Slice)
assert.Equal(t, true, cli.Flag)
}
func TestArgSliceWithSeparator(t *testing.T) {
var cli struct {
Slice []string `arg`
Flag bool
}
parser := mustNew(t, &cli)
_, err := parser.Parse([]string{"a,b", "c", "--flag"})
assert.NoError(t, err)
assert.Equal(t, []string{"a,b", "c"}, cli.Slice)
assert.Equal(t, true, cli.Flag)
}
func TestUnsupportedFieldErrors(t *testing.T) {
var cli struct {
Keys struct{}
}
_, err := kong.New(&cli)
assert.Error(t, err)
}
func TestMatchingArgField(t *testing.T) {
var cli struct {
ID struct {
NotID int `kong:"arg"`
} `kong:"arg"`
}
_, err := kong.New(&cli)
assert.Error(t, err)
}
func TestCantMixPositionalAndBranches(t *testing.T) {
var cli struct {
Arg string `kong:"arg"`
Command struct {
} `kong:"cmd"`
}
_, err := kong.New(&cli)
assert.Error(t, err)
}
func TestPropagatedFlags(t *testing.T) {
var cli struct {
Flag1 string
Command1 struct {
Flag2 bool
Command2 struct{} `kong:"cmd"`
} `kong:"cmd"`
}
parser := mustNew(t, &cli)
_, err := parser.Parse([]string{"command-1", "command-2", "--flag-2", "--flag-1=moo"})
assert.NoError(t, err)
assert.Equal(t, "moo", cli.Flag1)
assert.Equal(t, true, cli.Command1.Flag2)
}
func TestRequiredFlag(t *testing.T) {
var cli struct {
Flag string `kong:"required"`
}
parser := mustNew(t, &cli)
_, err := parser.Parse([]string{})
assert.Error(t, err)
}
func TestOptionalArg(t *testing.T) {
var cli struct {
Arg string `kong:"arg,optional"`
}
parser := mustNew(t, &cli)
_, err := parser.Parse([]string{})
assert.NoError(t, err)
}
func TestOptionalArgWithDefault(t *testing.T) {
var cli struct {
Arg string `kong:"arg,optional,default='moo'"`
}
parser := mustNew(t, &cli)
_, err := parser.Parse([]string{})
assert.NoError(t, err)
assert.Equal(t, "moo", cli.Arg)
}
func TestArgWithDefaultIsOptional(t *testing.T) {
var cli struct {
Arg string `kong:"arg,default='moo'"`
}
parser := mustNew(t, &cli)
_, err := parser.Parse([]string{})
assert.NoError(t, err)
assert.Equal(t, "moo", cli.Arg)
}
func TestRequiredArg(t *testing.T) {
var cli struct {
Arg string `kong:"arg"`
}
parser := mustNew(t, &cli)
_, err := parser.Parse([]string{})
assert.Error(t, err)
}
func TestInvalidRequiredAfterOptional(t *testing.T) {
var cli struct {
ID int `kong:"arg,optional"`
Name string `kong:"arg"`
}
_, err := kong.New(&cli)
assert.Error(t, err)
}
func TestOptionalStructArg(t *testing.T) {
var cli struct {
Name struct {
Name string `kong:"arg,optional"`
Enabled bool
} `kong:"arg,optional"`
}
parser := mustNew(t, &cli)
t.Run("WithFlag", func(t *testing.T) {
_, err := parser.Parse([]string{"gak", "--enabled"})
assert.NoError(t, err)
assert.Equal(t, "gak", cli.Name.Name)
assert.Equal(t, true, cli.Name.Enabled)
})
t.Run("WithoutFlag", func(t *testing.T) {
_, err := parser.Parse([]string{"gak"})
assert.NoError(t, err)
assert.Equal(t, "gak", cli.Name.Name)
})
t.Run("WithNothing", func(t *testing.T) {
_, err := parser.Parse([]string{})
assert.NoError(t, err)
})
}
func TestMixedRequiredArgs(t *testing.T) {
var cli struct {
Name string `kong:"arg"`
ID int `kong:"arg,optional"`
}
parser := mustNew(t, &cli)
t.Run("SingleRequired", func(t *testing.T) {
_, err := parser.Parse([]string{"gak", "5"})
assert.NoError(t, err)
assert.Equal(t, "gak", cli.Name)
assert.Equal(t, 5, cli.ID)
})
t.Run("ExtraOptional", func(t *testing.T) {
_, err := parser.Parse([]string{"gak"})
assert.NoError(t, err)
assert.Equal(t, "gak", cli.Name)
})
}
func TestInvalidDefaultErrors(t *testing.T) {
var cli struct {
Flag int `kong:"default='foo'"`
}
p := mustNew(t, &cli)
_, err := p.Parse(nil)
assert.Error(t, err)
}
func TestCommandMissingTagIsInvalid(t *testing.T) {
var cli struct {
One struct{}
}
_, err := kong.New(&cli)
assert.Error(t, err)
}
func TestDuplicateFlag(t *testing.T) {
var cli struct {
Flag bool
Cmd struct {
Flag bool
} `kong:"cmd"`
}
_, err := kong.New(&cli)
assert.Error(t, err)
}
func TestDuplicateFlagOnPeerCommandIsOkay(t *testing.T) {
var cli struct {
Cmd1 struct {
Flag bool
} `kong:"cmd"`
Cmd2 struct {
Flag bool
} `kong:"cmd"`
}
_, err := kong.New(&cli)
assert.NoError(t, err)
}
func TestTraceErrorPartiallySucceeds(t *testing.T) {
var cli struct {
One struct {
Two struct {
} `kong:"cmd"`
} `kong:"cmd"`
}
p := mustNew(t, &cli)
ctx, err := kong.Trace(p, []string{"one", "bad"})
assert.NoError(t, err)
assert.Error(t, ctx.Error)
assert.Equal(t, "one", ctx.Command())
}
type commandWithNegatableFlag struct {
Flag bool `kong:"default='true',negatable"`
ran bool
}
func (c *commandWithNegatableFlag) Run() error {
c.ran = true
return nil
}
func TestNegatableFlag(t *testing.T) {
tests := []struct {
name string
args []string
expected bool
}{
{
name: "no flag",
args: []string{"cmd"},
expected: true,
},
{
name: "boolean flag",
args: []string{"cmd", "--flag"},
expected: true,
},
{
name: "inverted boolean flag",
args: []string{"cmd", "--flag=false"},
expected: false,
},
{
name: "negated boolean flag",
args: []string{"cmd", "--no-flag"},
expected: false,
},
{
name: "inverted negated boolean flag",
args: []string{"cmd", "--no-flag=false"},
expected: true,
},
}
for _, tt := range tests {
tt := tt
t.Run(tt.name, func(t *testing.T) {
var cli struct {
Cmd commandWithNegatableFlag `kong:"cmd"`
}
p := mustNew(t, &cli)
kctx, err := p.Parse(tt.args)
assert.NoError(t, err)
assert.Equal(t, tt.expected, cli.Cmd.Flag)
err = kctx.Run()
assert.NoError(t, err)
assert.Equal(t, tt.expected, cli.Cmd.Flag)
assert.True(t, cli.Cmd.ran)
})
}
}
func TestExistingNoFlag(t *testing.T) {
var cli struct {
Cmd struct {
Flag bool `kong:"default='true'"`
NoFlag string
} `kong:"cmd"`
}
p := mustNew(t, &cli)
_, err := p.Parse([]string{"cmd", "--no-flag=none"})
assert.NoError(t, err)
assert.Equal(t, true, cli.Cmd.Flag)
assert.Equal(t, "none", cli.Cmd.NoFlag)
}
func TestInvalidNegatedNonBool(t *testing.T) {
var cli struct {
Cmd struct {
Flag string `kong:"negatable"`
} `kong:"cmd"`
}
_, err := kong.New(&cli)
assert.Error(t, err)
}
type hookContext struct {
cmd bool
values []string
}
type hookValue string
func (h *hookValue) BeforeApply(ctx *hookContext) error {
ctx.values = append(ctx.values, "before:"+string(*h))
return nil
}
func (h *hookValue) AfterApply(ctx *hookContext) error {
ctx.values = append(ctx.values, "after:"+string(*h))
return nil
}
type hookCmd struct {
Two hookValue `kong:"arg,optional"`
Three hookValue
}
func (h *hookCmd) BeforeApply(ctx *hookContext) error {
ctx.cmd = true
return nil
}
func (h *hookCmd) AfterApply(ctx *hookContext) error {
ctx.cmd = true
return nil
}
func TestHooks(t *testing.T) {
var tests = []struct {
name string
input string
values hookContext
}{
{"Command", "one", hookContext{true, nil}},
{"Arg", "one two", hookContext{true, []string{"before:", "after:two"}}},
{"Flag", "one --three=THREE", hookContext{true, []string{"before:", "after:THREE"}}},
{"ArgAndFlag", "one two --three=THREE", hookContext{true, []string{"before:", "before:", "after:two", "after:THREE"}}},
}
var cli struct {
One hookCmd `cmd:""`
}
ctx := &hookContext{}
p := mustNew(t, &cli, kong.Bind(ctx))
for _, test := range tests {
test := test
*ctx = hookContext{}
cli.One = hookCmd{}
t.Run(test.name, func(t *testing.T) {
_, err := p.Parse(strings.Split(test.input, " "))
assert.NoError(t, err)
assert.Equal(t, &test.values, ctx)
})
}
}
func TestShort(t *testing.T) {
var cli struct {
Bool bool `short:"b"`
String string `short:"s"`
}
app := mustNew(t, &cli)
_, err := app.Parse([]string{"-b", "-shello"})
assert.NoError(t, err)
assert.True(t, cli.Bool)
assert.Equal(t, "hello", cli.String)
}
func TestAlias(t *testing.T) {
var cli struct {
String string `aliases:"str"`
}
app := mustNew(t, &cli)
_, err := app.Parse([]string{"--str", "hello"})
assert.NoError(t, err)
assert.Equal(t, "hello", cli.String)
}
func TestDuplicateFlagChoosesLast(t *testing.T) {
var cli struct {
Flag int
}
_, err := mustNew(t, &cli).Parse([]string{"--flag=1", "--flag=2"})
assert.NoError(t, err)
assert.Equal(t, 2, cli.Flag)
}
func TestDuplicateSliceAccumulates(t *testing.T) {
var cli struct {
Flag []int
}
args := []string{"--flag=1,2", "--flag=3,4"}
_, err := mustNew(t, &cli).Parse(args)
assert.NoError(t, err)
assert.Equal(t, []int{1, 2, 3, 4}, cli.Flag)
}
func TestMapFlag(t *testing.T) {
var cli struct {
Set map[string]int
}
_, err := mustNew(t, &cli).Parse([]string{"--set", "a=10", "--set", "b=20"})
assert.NoError(t, err)
assert.Equal(t, map[string]int{"a": 10, "b": 20}, cli.Set)
}
func TestMapFlagWithSliceValue(t *testing.T) {
var cli struct {
Set map[string][]int
}
_, err := mustNew(t, &cli).Parse([]string{"--set", "a=1,2", "--set", "b=3"})
assert.NoError(t, err)
assert.Equal(t, map[string][]int{"a": {1, 2}, "b": {3}}, cli.Set)
}
type embeddedFlags struct {
Embedded string
}
func TestEmbeddedStruct(t *testing.T) {
var cli struct {
embeddedFlags
NotEmbedded string
}
_, err := mustNew(t, &cli).Parse([]string{"--embedded=moo", "--not-embedded=foo"})
assert.NoError(t, err)
assert.Equal(t, "moo", cli.Embedded)
assert.Equal(t, "foo", cli.NotEmbedded)
}
func TestSliceWithDisabledSeparator(t *testing.T) {
var cli struct {
Flag []string `sep:"none"`
}
_, err := mustNew(t, &cli).Parse([]string{"--flag=a,b", "--flag=b,c"})
assert.NoError(t, err)
assert.Equal(t, []string{"a,b", "b,c"}, cli.Flag)
}
func TestMultilineMessage(t *testing.T) {
w := &bytes.Buffer{}
var cli struct{}
p := mustNew(t, &cli, kong.Writers(w, w))
p.Printf("hello\nworld")
assert.Equal(t, "test: hello\n world\n", w.String())
}
type cmdWithRun struct {
Arg string `arg:""`
}
func (c *cmdWithRun) Run(key string) error {
c.Arg += key
if key == "ERROR" {
return fmt.Errorf("ERROR")
}
return nil
}
type parentCmdWithRun struct {
Flag string
SubCommand struct {
Arg string `arg:""`
} `cmd:""`
}
func (p *parentCmdWithRun) Run(key string) error {
p.SubCommand.Arg += key
return nil
}
type grammarWithRun struct {
One cmdWithRun `cmd:""`
Two cmdWithRun `cmd:""`
Three parentCmdWithRun `cmd:""`
}
func TestRun(t *testing.T) {
cli := &grammarWithRun{}
p := mustNew(t, cli)
ctx, err := p.Parse([]string{"one", "two"})
assert.NoError(t, err)
err = ctx.Run("hello")
assert.NoError(t, err)
assert.Equal(t, "twohello", cli.One.Arg)
ctx, err = p.Parse([]string{"two", "three"})
assert.NoError(t, err)
err = ctx.Run("ERROR")
assert.Error(t, err)
ctx, err = p.Parse([]string{"three", "sub-command", "arg"})
assert.NoError(t, err)
err = ctx.Run("ping")
assert.NoError(t, err)
assert.Equal(t, "argping", cli.Three.SubCommand.Arg)
}
type failCmd struct{}
func (f failCmd) Run() error {
return errors.New("this command failed")
}
func TestPassesThroughOriginalCommandError(t *testing.T) {
var cli struct {
Fail failCmd `kong:"cmd"`
}
p := mustNew(t, &cli)
ctx, _ := p.Parse([]string{"fail"})
err := ctx.Run()
assert.Error(t, err)
assert.Equal(t, err.Error(), "this command failed")
}
func TestInterpolationIntoModel(t *testing.T) {
var cli struct {
Flag string `default:"${default_value}" help:"Help, I need ${somebody}" enum:"${enum}"`
EnumRef string `enum:"a,b" required:"" help:"One of ${enum}"`
EnvRef string `env:"${env}" help:"God ${env}"`
}
_, err := kong.New(&cli)
assert.Error(t, err)
p, err := kong.New(&cli, kong.Vars{
"default_value": "Some default value.",
"somebody": "chickens!",
"enum": "a,b,c,d",
"env": "SAVE_THE_QUEEN",
})
assert.NoError(t, err)
assert.Equal(t, 4, len(p.Model.Flags))
flag := p.Model.Flags[1]
flag2 := p.Model.Flags[2]
flag3 := p.Model.Flags[3]
assert.Equal(t, "Some default value.", flag.Default)
assert.Equal(t, "Help, I need chickens!", flag.Help)
assert.Equal(t, map[string]bool{"a": true, "b": true, "c": true, "d": true}, flag.EnumMap())
assert.Equal(t, []string{"a", "b", "c", "d"}, flag.EnumSlice())
assert.Equal(t, "One of a,b", flag2.Help)
assert.Equal(t, []string{"SAVE_THE_QUEEN"}, flag3.Envs)
assert.Equal(t, "God SAVE_THE_QUEEN", flag3.Help)
}
func TestIssue244(t *testing.T) {
type Config struct {
Project string `short:"p" env:"CI_PROJECT_ID" help:"Environment variable: ${env}"`
}
w := &strings.Builder{}
k := mustNew(t, &Config{}, kong.Exit(func(int) {}), kong.Writers(w, w))
_, err := k.Parse([]string{"--help"})
assert.NoError(t, err)
assert.Contains(t, w.String(), `Environment variable: CI_PROJECT_ID`)
}
func TestErrorMissingArgs(t *testing.T) {
var cli struct {
One string `arg:""`
Two string `arg:""`
}
p := mustNew(t, &cli)
_, err := p.Parse(nil)
assert.Error(t, err)
assert.Equal(t, "expected \"<one> <two>\"", err.Error())
}
func TestBoolOverride(t *testing.T) {
var cli struct {
Flag bool `default:"true"`
}
p := mustNew(t, &cli)
_, err := p.Parse([]string{"--flag=false"})
assert.NoError(t, err)
_, err = p.Parse([]string{"--flag", "false"})
assert.Error(t, err)
}
func TestAnonymousPrefix(t *testing.T) {
type Anonymous struct {
Flag string
}
var cli struct {
Anonymous `prefix:"anon-"`
}
p := mustNew(t, &cli)
_, err := p.Parse([]string{"--anon-flag=moo"})
assert.NoError(t, err)
assert.Equal(t, "moo", cli.Flag)
}
type TestInterface interface {
SomeMethod()
}
type TestImpl struct {
Flag string
}
func (t *TestImpl) SomeMethod() {}
func TestEmbedInterface(t *testing.T) {
type CLI struct {
SomeFlag string
TestInterface
}
cli := &CLI{TestInterface: &TestImpl{}}
p := mustNew(t, cli)
_, err := p.Parse([]string{"--some-flag=foo", "--flag=yes"})
assert.NoError(t, err)
assert.Equal(t, "foo", cli.SomeFlag)
assert.Equal(t, "yes", cli.TestInterface.(*TestImpl).Flag) //nolint
}
func TestExcludedField(t *testing.T) {
var cli struct {
Flag string
Excluded string `kong:"-"`
}
p := mustNew(t, &cli)
_, err := p.Parse([]string{"--flag=foo"})
assert.NoError(t, err)
_, err = p.Parse([]string{"--excluded=foo"})
assert.Error(t, err)
}
func TestUnnamedFieldEmbeds(t *testing.T) {
type Embed struct {
Flag string
}
var cli struct {
One Embed `prefix:"one-" embed:""`
Two Embed `prefix:"two-" embed:""`
}
buf := &strings.Builder{}
p := mustNew(t, &cli, kong.Writers(buf, buf), kong.Exit(func(int) {}))
_, err := p.Parse([]string{"--help"})
assert.NoError(t, err)
assert.Contains(t, buf.String(), `--one-flag=STRING`)
assert.Contains(t, buf.String(), `--two-flag=STRING`)
}
func TestHooksCalledForDefault(t *testing.T) {
var cli struct {
Flag hookValue `default:"default"`
}
ctx := &hookContext{}
_, err := mustNew(t, &cli, kong.Bind(ctx)).Parse(nil)
assert.NoError(t, err)
assert.Equal(t, "default", string(cli.Flag))
assert.Equal(t, []string{"before:default", "after:default"}, ctx.values)
}
func TestEnum(t *testing.T) {
var cli struct {
Flag string `enum:"a,b,c" required:""`
}
_, err := mustNew(t, &cli).Parse([]string{"--flag", "d"})
assert.EqualError(t, err, "--flag must be one of \"a\",\"b\",\"c\" but got \"d\"")
}
func TestEnumMeaningfulOrder(t *testing.T) {
var cli struct {
Flag string `enum:"first,second,third,fourth,fifth" required:""`
}
_, err := mustNew(t, &cli).Parse([]string{"--flag", "sixth"})
assert.EqualError(t, err, "--flag must be one of \"first\",\"second\",\"third\",\"fourth\",\"fifth\" but got \"sixth\"")
}
type commandWithHook struct {
value string
}
func (c *commandWithHook) AfterApply(cli *cliWithHook) error {
c.value = cli.Flag
return nil
}
type cliWithHook struct {
Flag string
Command commandWithHook `cmd:""`
}
func (c *cliWithHook) AfterApply(ctx *kong.Context) error {
ctx.Bind(c)
return nil
}
func TestParentBindings(t *testing.T) {
cli := &cliWithHook{}
_, err := mustNew(t, cli).Parse([]string{"command", "--flag=foo"})
assert.NoError(t, err)
assert.Equal(t, "foo", cli.Command.value)
}
func TestNumericParamErrors(t *testing.T) {
var cli struct {
Name string
}
parser := mustNew(t, &cli)
_, err := parser.Parse([]string{"--name", "-10"})
assert.EqualError(t, err, `--name: expected string value but got "-10" (short flag); perhaps try --name="-10"?`)
}
func TestDefaultValueIsHyphen(t *testing.T) {
var cli struct {
Flag string `default:"-"`
}
p := mustNew(t, &cli)
_, err := p.Parse(nil)
assert.NoError(t, err)
assert.Equal(t, "-", cli.Flag)
}
func TestDefaultEnumValidated(t *testing.T) {
var cli struct {
Flag string `default:"invalid" enum:"valid"`
}
p := mustNew(t, &cli)
_, err := p.Parse(nil)
assert.EqualError(t, err, "--flag must be one of \"valid\" but got \"invalid\"")
}
func TestEnvarEnumValidated(t *testing.T) {
restore := tempEnv(map[string]string{
"FLAG": "invalid",
})
defer restore()
var cli struct {
Flag string `env:"FLAG" required:"" enum:"valid"`
}
p := mustNew(t, &cli)
_, err := p.Parse(nil)
assert.EqualError(t, err, "--flag must be one of \"valid\" but got \"invalid\"")
}
func TestXor(t *testing.T) {
var cli struct {
Hello bool `xor:"another"`
One bool `xor:"group"`
Two string `xor:"group"`
}
p := mustNew(t, &cli)
_, err := p.Parse([]string{"--hello", "--one", "--two=hi"})
assert.EqualError(t, err, "--one and --two can't be used together")
p = mustNew(t, &cli)
_, err = p.Parse([]string{"--one", "--hello"})
assert.NoError(t, err)
}
func TestXorChild(t *testing.T) {
var cli struct {
One bool `xor:"group"`
Cmd struct {
Two string `xor:"group"`
Three string `xor:"group"`
} `cmd`
}
p := mustNew(t, &cli)
_, err := p.Parse([]string{"--one", "cmd", "--two=hi"})
assert.NoError(t, err)
p = mustNew(t, &cli)
_, err = p.Parse([]string{"--two=hi", "cmd", "--three"})
assert.Error(t, err, "--two and --three can't be used together")
}
func TestMultiXor(t *testing.T) {
var cli struct {
Hello bool `xor:"one,two"`
One bool `xor:"one"`
Two string `xor:"two"`
}
p := mustNew(t, &cli)
_, err := p.Parse([]string{"--hello", "--one"})
assert.EqualError(t, err, "--hello and --one can't be used together")
p = mustNew(t, &cli)
_, err = p.Parse([]string{"--hello", "--two=foo"})
assert.EqualError(t, err, "--hello and --two can't be used together")
}
func TestXorRequired(t *testing.T) {
var cli struct {
One bool `xor:"one,two" required:""`
Two bool `xor:"one" required:""`
Three bool `xor:"two" required:""`
Four bool `required:""`
}
p := mustNew(t, &cli)
_, err := p.Parse([]string{"--one"})
assert.EqualError(t, err, "missing flags: --four")
p = mustNew(t, &cli)
_, err = p.Parse([]string{"--two"})
assert.EqualError(t, err, "missing flags: --four, --one or --three")
p = mustNew(t, &cli)
_, err = p.Parse([]string{})
assert.EqualError(t, err, "missing flags: --four, --one or --three, --one or --two")
}
func TestXorRequiredMany(t *testing.T) {
var cli struct {
One bool `xor:"one" required:""`
Two bool `xor:"one" required:""`
Three bool `xor:"one" required:""`
}
p := mustNew(t, &cli)
_, err := p.Parse([]string{"--one"})
assert.NoError(t, err)
p = mustNew(t, &cli)
_, err = p.Parse([]string{"--three"})
assert.NoError(t, err)
p = mustNew(t, &cli)
_, err = p.Parse([]string{})
assert.EqualError(t, err, "missing flags: --one or --two or --three")
}
func TestEnumSequence(t *testing.T) {
var cli struct {
State []string `enum:"a,b,c" default:"a"`
}
p := mustNew(t, &cli)
_, err := p.Parse(nil)
assert.NoError(t, err)
assert.Equal(t, []string{"a"}, cli.State)
}
func TestIssue40EnumAcrossCommands(t *testing.T) {
var cli struct {
One struct {
OneArg string `arg:"" required:""`
} `cmd:""`
Two struct {
TwoArg string `arg:"" enum:"a,b,c" required:"" env:"FOO"`
} `cmd:""`
Three struct {
ThreeArg string `arg:"" optional:"" default:"a" enum:"a,b,c"`
} `cmd:""`
}
p := mustNew(t, &cli)
_, err := p.Parse([]string{"one", "two"})
assert.NoError(t, err)
_, err = p.Parse([]string{"two", "d"})
assert.Error(t, err)
_, err = p.Parse([]string{"three", "d"})
assert.Error(t, err)
_, err = p.Parse([]string{"three", "c"})
assert.NoError(t, err)
}
func TestIssue179(t *testing.T) {
type A struct {
Enum string `required:"" enum:"1,2"`
}
type B struct{}
var root struct {
A A `cmd`
B B `cmd`
}
p := mustNew(t, &root)
_, err := p.Parse([]string{"b"})
assert.NoError(t, err)
}
func TestIssue153(t *testing.T) {
type LsCmd struct {
Paths []string `arg required name:"path" help:"Paths to list." env:"CMD_PATHS"`
}
var cli struct {
Debug bool `help:"Enable debug mode."`
Ls LsCmd `cmd help:"List paths."`
}
p, revert := newEnvParser(t, &cli, envMap{
"CMD_PATHS": "hello",
})
defer revert()
_, err := p.Parse([]string{"ls"})
assert.NoError(t, err)
assert.Equal(t, []string{"hello"}, cli.Ls.Paths)
}
func TestEnumArg(t *testing.T) {
var cli struct {
Nested struct {
One string `arg:"" enum:"a,b,c" required:""`
Two string `arg:""`
} `cmd:""`
}
p := mustNew(t, &cli)
_, err := p.Parse([]string{"nested", "a", "b"})
assert.NoError(t, err)
assert.Equal(t, "a", cli.Nested.One)
assert.Equal(t, "b", cli.Nested.Two)
}
func TestDefaultCommand(t *testing.T) {
var cli struct {
One struct{} `cmd:"" default:"1"`
Two struct{} `cmd:""`
}
p := mustNew(t, &cli)
ctx, err := p.Parse([]string{})
assert.NoError(t, err)
assert.Equal(t, "one", ctx.Command())
}
func TestMultipleDefaultCommands(t *testing.T) {
var cli struct {
One struct{} `cmd:"" default:"1"`
Two struct{} `cmd:"" default:"1"`
}
_, err := kong.New(&cli)
assert.EqualError(t, err, "<anonymous struct>.Two: can't have more than one default command under <command>")
}
func TestDefaultCommandWithSubCommand(t *testing.T) {
var cli struct {
One struct {
Two struct{} `cmd:""`
} `cmd:"" default:"1"`
}
_, err := kong.New(&cli)
assert.EqualError(t, err, "<anonymous struct>.One: default command one <command> must not have subcommands or arguments")
}
func TestDefaultCommandWithAllowedSubCommand(t *testing.T) {
var cli struct {
One struct {
Two struct{} `cmd:""`
} `cmd:"" default:"withargs"`
}
p := mustNew(t, &cli)
ctx, err := p.Parse([]string{"two"})
assert.NoError(t, err)
assert.Equal(t, "one two", ctx.Command())
}
func TestDefaultCommandWithArgument(t *testing.T) {
var cli struct {
One struct {
Arg string `arg:""`
} `cmd:"" default:"1"`
}
_, err := kong.New(&cli)
assert.EqualError(t, err, "<anonymous struct>.One: default command one <arg> must not have subcommands or arguments")
}
func TestDefaultCommandWithAllowedArgument(t *testing.T) {
var cli struct {
One struct {
Arg string `arg:""`
Flag string
} `cmd:"" default:"withargs"`
}
p := mustNew(t, &cli)
_, err := p.Parse([]string{"arg", "--flag=value"})
assert.NoError(t, err)
assert.Equal(t, "arg", cli.One.Arg)
assert.Equal(t, "value", cli.One.Flag)
}
func TestDefaultCommandWithBranchingArgument(t *testing.T) {
var cli struct {
One struct {
Two struct {
Two string `arg:""`
} `arg:""`
} `cmd:"" default:"1"`
}
_, err := kong.New(&cli)
assert.EqualError(t, err, "<anonymous struct>.One: default command one <command> must not have subcommands or arguments")
}
func TestDefaultCommandWithAllowedBranchingArgument(t *testing.T) {
var cli struct {
One struct {
Two struct {
Two string `arg:""`
Flag string
} `arg:""`
} `cmd:"" default:"withargs"`
}
p := mustNew(t, &cli)
_, err := p.Parse([]string{"arg", "--flag=value"})
assert.NoError(t, err)
assert.Equal(t, "arg", cli.One.Two.Two)
assert.Equal(t, "value", cli.One.Two.Flag)
}
func TestDefaultCommandPrecedence(t *testing.T) {
var cli struct {
Two struct {
Arg string `arg:""`
Flag bool
} `cmd:"" default:"withargs"`
One struct{} `cmd:""`
}
p := mustNew(t, &cli)
// A named command should take precedence over a default command with arg
ctx, err := p.Parse([]string{"one"})
assert.NoError(t, err)
assert.Equal(t, "one", ctx.Command())
// An explicitly named command with arg should parse, even if labeled default:"witharg"
ctx, err = p.Parse([]string{"two", "arg"})
assert.NoError(t, err)
assert.Equal(t, "two <arg>", ctx.Command())
// An arg to a default command that does not match another command should select the default
ctx, err = p.Parse([]string{"arg"})
assert.NoError(t, err)
assert.Equal(t, "two <arg>", ctx.Command())
// A flag on a default command should not be valid on a sibling command
_, err = p.Parse([]string{"one", "--flag"})
assert.EqualError(t, err, "unknown flag --flag")
}
func TestLoneHpyhen(t *testing.T) {
var cli struct {
Flag string
Arg string `arg:"" optional:""`
}
p := mustNew(t, &cli)
_, err := p.Parse([]string{"-"})
assert.NoError(t, err)
assert.Equal(t, "-", cli.Arg)
_, err = p.Parse([]string{"--flag", "-"})
assert.NoError(t, err)
assert.Equal(t, "-", cli.Flag)
}
func TestPlugins(t *testing.T) {
var pluginOne struct {
One string
}
var pluginTwo struct {
Two string
}
var cli struct {
Base string
kong.Plugins
}
cli.Plugins = kong.Plugins{&pluginOne, &pluginTwo}
p := mustNew(t, &cli)
_, err := p.Parse([]string{"--base=base", "--one=one", "--two=two"})
assert.NoError(t, err)
assert.Equal(t, "base", cli.Base)
assert.Equal(t, "one", pluginOne.One)
assert.Equal(t, "two", pluginTwo.Two)
}
type validateCmd struct{}
func (v *validateCmd) Validate() error { return errors.New("cmd error") }
type validateCli struct {
Cmd validateCmd `cmd:""`
}
func (v *validateCli) Validate() error { return errors.New("app error") }
type validateFlag string
func (v *validateFlag) Validate() error { return errors.New("flag error") }
func TestValidateApp(t *testing.T) {
cli := validateCli{}
p := mustNew(t, &cli)
_, err := p.Parse([]string{})
assert.EqualError(t, err, "app error")
}
func TestValidateCmd(t *testing.T) {
cli := struct {
Cmd validateCmd `cmd:""`
}{}
p := mustNew(t, &cli)
_, err := p.Parse([]string{"cmd"})
assert.EqualError(t, err, "cmd: cmd error")
}
func TestValidateFlag(t *testing.T) {
cli := struct {
Flag validateFlag
}{}
p := mustNew(t, &cli)
_, err := p.Parse([]string{"--flag=one"})
assert.EqualError(t, err, "--flag: flag error")
}
func TestValidateArg(t *testing.T) {
cli := struct {
Arg validateFlag `arg:""`
}{}
p := mustNew(t, &cli)
_, err := p.Parse([]string{"one"})
assert.EqualError(t, err, "<arg>: flag error")
}
func TestPointers(t *testing.T) {
cli := struct {
Mapped *mappedValue
JSON *jsonUnmarshalerValue
}{}
p := mustNew(t, &cli)
_, err := p.Parse([]string{"--mapped=mapped", "--json=\"foo\""})
assert.NoError(t, err)
assert.NotZero(t, cli.Mapped)
assert.Equal(t, "mapped", cli.Mapped.decoded)
assert.NotZero(t, cli.JSON)
assert.Equal(t, "FOO", string(*cli.JSON))
}
type dynamicCommand struct {
Flag string
ran bool
}
func (d *dynamicCommand) Run() error {
d.ran = true
return nil
}
func TestDynamicCommands(t *testing.T) {
cli := struct {
One struct{} `cmd:"one"`
}{}
help := &strings.Builder{}
two := &dynamicCommand{}
three := &dynamicCommand{}
p := mustNew(t, &cli,
kong.DynamicCommand("two", "", "", &two),
kong.DynamicCommand("three", "", "", three, "hidden"),
kong.Writers(help, help),
kong.Exit(func(int) {}))
kctx, err := p.Parse([]string{"two", "--flag=flag"})
assert.NoError(t, err)
assert.Equal(t, "flag", two.Flag)
assert.False(t, two.ran)
err = kctx.Run()
assert.NoError(t, err)
assert.True(t, two.ran)
_, err = p.Parse([]string{"--help"})
assert.EqualError(t, err, `expected one of "one", "two"`)
assert.NotContains(t, help.String(), "three", help.String())
}
func TestDuplicateShortflags(t *testing.T) {
cli := struct {
Flag1 bool `short:"t"`
Flag2 bool `short:"t"`
}{}
_, err := kong.New(&cli)
assert.EqualError(t, err, "<anonymous struct>.Flag2: duplicate short flag -t")
}
func TestDuplicateAliases(t *testing.T) {
cli1 := struct {
Flag1 string `aliases:"flag"`
Flag2 string `aliases:"flag"`
}{}
_, err := kong.New(&cli1)
assert.EqualError(t, err, "<anonymous struct>.Flag2: duplicate flag --flag")
}
func TestDuplicateAliasLong(t *testing.T) {
cli2 := struct {
Flag string ``
Flag2 string `aliases:"flag"` // duplicates Flag
}{}
_, err := kong.New(&cli2)
assert.EqualError(t, err, "<anonymous struct>.Flag2: duplicate flag --flag")
}
func TestDuplicateNestedShortFlags(t *testing.T) {
cli := struct {
Flag1 bool `short:"t"`
Cmd struct {
Flag2 bool `short:"t"`
} `cmd:""`
}{}
_, err := kong.New(&cli)
assert.EqualError(t, err, "<anonymous struct>.Flag2: duplicate short flag -t")
}
func TestHydratePointerCommandsAndEmbeds(t *testing.T) {
type cmd struct {
Flag bool
}
type embed struct {
Embed bool
}
var cli struct {
Cmd *cmd `cmd:""`
Embed *embed `embed:""`
}
k := mustNew(t, &cli)
_, err := k.Parse([]string{"--embed", "cmd", "--flag"})
assert.NoError(t, err)
assert.Equal(t, &cmd{Flag: true}, cli.Cmd)
assert.Equal(t, &embed{Embed: true}, cli.Embed)
}
//nolint:revive
type testIgnoreFields struct {
Foo struct {
Bar bool
Sub struct {
SubFlag1 bool `kong:"name=subflag1"`
XXX_SubFlag2 bool `kong:"name=subflag2"` //nolint:stylecheck
} `kong:"cmd"`
} `kong:"cmd"`
XXX_Baz struct { //nolint:stylecheck
Boo bool
} `kong:"cmd,name=baz"`
}
func TestIgnoreRegex(t *testing.T) {
cli := testIgnoreFields{}
k, err := kong.New(&cli, kong.IgnoreFields(`.*\.XXX_.+`))
assert.NoError(t, err)
_, err = k.Parse([]string{"foo", "sub"})
assert.NoError(t, err)
_, err = k.Parse([]string{"foo", "sub", "--subflag1"})
assert.NoError(t, err)
_, err = k.Parse([]string{"foo", "sub", "--subflag2"})
assert.Error(t, err)
assert.Contains(t, err.Error(), "unknown flag --subflag2")
_, err = k.Parse([]string{"baz"})
assert.Error(t, err)
assert.Contains(t, err.Error(), "unexpected argument baz")
}
// Verify that passing a nil regex will work
func TestIgnoreRegexEmpty(t *testing.T) {
cli := testIgnoreFields{}
_, err := kong.New(&cli, kong.IgnoreFields(""))
assert.Error(t, err)
assert.Contains(t, "regex input cannot be empty", err.Error())
}
type optionWithErr struct{}
func (o *optionWithErr) Apply(k *kong.Kong) error {
return errors.New("option returned err")
}
func TestOptionReturnsErr(t *testing.T) {
cli := struct {
Test bool
}{}
optWithError := &optionWithErr{}
_, err := kong.New(cli, optWithError)
assert.Error(t, err)
assert.Equal(t, "option returned err", err.Error())
}
func TestEnumValidation(t *testing.T) {
tests := []struct {
name string
cli interface{}
fail bool
}{
{
"Arg",
&struct {
Enum string `arg:"" enum:"one,two"`
}{},
false,
},
{
"RequiredArg",
&struct {
Enum string `required:"" arg:"" enum:"one,two"`
}{},
false,
},
{
"OptionalArg",
&struct {
Enum string `optional:"" arg:"" enum:"one,two"`
}{},
true,
},
{
"RepeatedArgs",
&struct {
Enum []string `arg:"" enum:"one,two"`
}{},
false,
},
{
"RequiredRepeatedArgs",
&struct {
Enum []string `required:"" arg:"" enum:"one,two"`
}{},
false,
},
{
"OptionalRepeatedArgs",
&struct {
Enum []string `optional:"" arg:"" enum:"one,two"`
}{},
false,
},
{
"EnumWithEmptyDefault",
&struct {
Flag string `enum:"one,two," default:""`
}{},
false,
},
}
for _, test := range tests {
test := test
t.Run(test.name, func(t *testing.T) {
_, err := kong.New(test.cli)
if test.fail {
assert.Error(t, err, repr.String(test.cli))
} else {
assert.NoError(t, err, repr.String(test.cli))
}
})
}
}
func TestPassthroughCmd(t *testing.T) {
tests := []struct {
name string
args []string
flag string
cmdArgs []string
}{
{
"Simple",
[]string{"--flag", "foobar", "command", "something"},
"foobar",
[]string{"something"},
},
{
"DashDash",
[]string{"--flag", "foobar", "command", "--", "something"},
"foobar",
[]string{"--", "something"},
},
{
"Flag",
[]string{"command", "--flag", "foobar"},
"",
[]string{"--flag", "foobar"},
},
{
"FlagAndFlag",
[]string{"--flag", "foobar", "command", "--flag", "foobar"},
"foobar",
[]string{"--flag", "foobar"},
},
{
"NoArgs",
[]string{"--flag", "foobar", "command"},
"foobar",
[]string(nil),
},
}
for _, test := range tests {
test := test
t.Run(test.name, func(t *testing.T) {
var cli struct {
Flag string
Command struct {
Args []string `arg:"" optional:""`
} `cmd:"" passthrough:""`
}
p := mustNew(t, &cli)
_, err := p.Parse(test.args)
assert.NoError(t, err)
assert.Equal(t, test.flag, cli.Flag)
assert.Equal(t, test.cmdArgs, cli.Command.Args)
})
}
}
func TestPassthroughCmdOnlyArgs(t *testing.T) {
var cli struct {
Command struct {
Flag string
Args []string `arg:"" optional:""`
} `cmd:"" passthrough:""`
}
_, err := kong.New(&cli)
assert.EqualError(t, err, "<anonymous struct>.Command: passthrough command command [<args> ...] [flags] must not have subcommands or flags")
}
func TestPassthroughCmdOnlyStringArgs(t *testing.T) {
var cli struct {
Command struct {
Args []int `arg:"" optional:""`
} `cmd:"" passthrough:""`
}
_, err := kong.New(&cli)
assert.EqualError(t, err, "<anonymous struct>.Command: passthrough command command [<args> ...] must contain exactly one positional argument of []string type")
}
func TestHelpShouldStillWork(t *testing.T) {
type CLI struct {
Dir string `type:"existingdir" default:"missing-dir"`
File string `type:"existingfile" default:"testdata/missing.txt"`
}
var cli CLI
w := &strings.Builder{}
k := mustNew(t, &cli, kong.Writers(w, w))
rc := -1 // init nonzero to help assert help hook was called
k.Exit = func(i int) {
rc = i
}
_, err := k.Parse([]string{"--help"})
t.Log(w.String())
// checking return code validates the help hook was called
assert.Zero(t, rc)
// allow for error propagation from other validation (only for the
// sake of this test, due to the exit function not actually exiting the
// program; errors will not propagate in the real world).
assert.Error(t, err)
}
func TestVersionFlagShouldStillWork(t *testing.T) {
type CLI struct {
Dir string `type:"existingdir" default:"missing-dir"`
File string `type:"existingfile" default:"testdata/missing.txt"`
Version kong.VersionFlag
}
var cli CLI
w := &strings.Builder{}
k := mustNew(t, &cli, kong.Writers(w, w))
rc := -1 // init nonzero to help assert help hook was called
k.Exit = func(i int) {
rc = i
}
_, err := k.Parse([]string{"--version"})
t.Log(w.String())
// checking return code validates the help hook was called
assert.Zero(t, rc)
// allow for error propagation from other validation (only for the
// sake of this test, due to the exit function not actually exiting the
// program; errors will not propagate in the real world).
assert.Error(t, err)
}
func TestSliceDecoderHelpfulErrorMsg(t *testing.T) {
tests := []struct {
name string
cli interface{}
args []string
err string
}{
{
"DefaultRune",
&struct {
Stuff []string
}{},
[]string{"--stuff"},
`--stuff: missing value, expecting "<arg>,..."`,
},
{
"SpecifiedRune",
&struct {
Stuff []string `sep:","`
}{},
[]string{"--stuff"},
`--stuff: missing value, expecting "<arg>,..."`,
},
{
"SpaceRune",
&struct {
Stuff []string `sep:" "`
}{},
[]string{"--stuff"},
`--stuff: missing value, expecting "<arg> ..."`,
},
{
"OtherRune",
&struct {
Stuff []string `sep:"_"`
}{},
[]string{"--stuff"},
`--stuff: missing value, expecting "<arg>_..."`,
},
}
for _, test := range tests {
test := test
t.Run(test.name, func(t *testing.T) {
p := mustNew(t, test.cli)
_, err := p.Parse(test.args)
assert.EqualError(t, err, test.err)
})
}
}
func TestMapDecoderHelpfulErrorMsg(t *testing.T) {
tests := []struct {
name string
cli interface{}
args []string
expected string
}{
{
"DefaultRune",
&struct {
Stuff map[string]int
}{},
[]string{"--stuff"},
`--stuff: missing value, expecting "<key>=<value>;..."`,
},
{
"SpecifiedRune",
&struct {
Stuff map[string]int `mapsep:";"`
}{},
[]string{"--stuff"},
`--stuff: missing value, expecting "<key>=<value>;..."`,
},
{
"SpaceRune",
&struct {
Stuff map[string]int `mapsep:" "`
}{},
[]string{"--stuff"},
`--stuff: missing value, expecting "<key>=<value> ..."`,
},
{
"OtherRune",
&struct {
Stuff map[string]int `mapsep:","`
}{},
[]string{"--stuff"},
`--stuff: missing value, expecting "<key>=<value>,..."`,
},
}
for _, test := range tests {
test := test
t.Run(test.name, func(t *testing.T) {
p := mustNew(t, test.cli)
_, err := p.Parse(test.args)
assert.EqualError(t, err, test.expected)
})
}
}
func TestDuplicateName(t *testing.T) {
var cli struct {
DupA struct{} `cmd:"" name:"duplicate"`
DupB struct{} `cmd:"" name:"duplicate"`
}
_, err := kong.New(&cli)
assert.Error(t, err)
}
func TestDuplicateChildName(t *testing.T) {
var cli struct {
A struct {
DupA struct{} `cmd:"" name:"duplicate"`
DupB struct{} `cmd:"" name:"duplicate"`
} `cmd:""`
B struct{} `cmd:""`
}
_, err := kong.New(&cli)
assert.Error(t, err)
}
func TestChildNameCanBeDuplicated(t *testing.T) {
var cli struct {
A struct {
A struct{} `cmd:"" name:"duplicateA"`
B struct{} `cmd:"" name:"duplicateB"`
} `cmd:"" name:"duplicateA"`
B struct{} `cmd:"" name:"duplicateB"`
}
mustNew(t, &cli)
}
func TestCumulativeArgumentLast(t *testing.T) {
var cli struct {
Arg1 string `arg:""`
Arg2 []string `arg:""`
}
_, err := kong.New(&cli)
assert.NoError(t, err)
}
func TestCumulativeArgumentNotLast(t *testing.T) {
var cli struct {
Arg2 []string `arg:""`
Arg1 string `arg:""`
}
_, err := kong.New(&cli)
assert.Error(t, err)
}
func TestStringPointer(t *testing.T) {
var cli struct {
Foo *string
}
k, err := kong.New(&cli)
assert.NoError(t, err)
assert.NotZero(t, k)
ctx, err := k.Parse([]string{"--foo", "wtf"})
assert.NoError(t, err)
assert.NotZero(t, ctx)
assert.NotZero(t, cli.Foo)
assert.Equal(t, "wtf", *cli.Foo)
}
func TestStringPointerNoValue(t *testing.T) {
var cli struct {
Foo *string
}
k, err := kong.New(&cli)
assert.NoError(t, err)
assert.NotZero(t, k)
ctx, err := k.Parse([]string{})
assert.NoError(t, err)
assert.NotZero(t, ctx)
assert.Zero(t, cli.Foo)
}
func TestStringPointerDefault(t *testing.T) {
var cli struct {
Foo *string `default:"stuff"`
}
k, err := kong.New(&cli)
assert.NoError(t, err)
assert.NotZero(t, k)
ctx, err := k.Parse([]string{})
assert.NoError(t, err)
assert.NotZero(t, ctx)
assert.NotZero(t, cli.Foo)
assert.Equal(t, "stuff", *cli.Foo)
}
func TestStringPointerAliasNoValue(t *testing.T) {
type Foo string
var cli struct {
F *Foo
}
k, err := kong.New(&cli)
assert.NoError(t, err)
assert.NotZero(t, k)
ctx, err := k.Parse([]string{})
assert.NoError(t, err)
assert.NotZero(t, ctx)
assert.Zero(t, cli.F)
}
func TestStringPointerAlias(t *testing.T) {
type Foo string
var cli struct {
F *Foo
}
k, err := kong.New(&cli)
assert.NoError(t, err)
assert.NotZero(t, k)
ctx, err := k.Parse([]string{"--f=value"})
assert.NoError(t, err)
assert.NotZero(t, ctx)
assert.NotZero(t, cli.F)
assert.Equal(t, Foo("value"), *cli.F)
}
func TestStringPointerEmptyValue(t *testing.T) {
var cli struct {
F *string
G *string
}
k, err := kong.New(&cli)
assert.NoError(t, err)
assert.NotZero(t, k)
ctx, err := k.Parse([]string{"--f", "", "--g="})
assert.NoError(t, err)
assert.NotZero(t, ctx)
assert.NotZero(t, cli.F)
assert.NotZero(t, cli.G)
assert.Equal(t, "", *cli.F)
assert.Equal(t, "", *cli.G)
}
func TestIntPtr(t *testing.T) {
var cli struct {
F *int
G *int
}
k, err := kong.New(&cli)
assert.NoError(t, err)
assert.NotZero(t, k)
ctx, err := k.Parse([]string{"--f=6"})
assert.NoError(t, err)
assert.NotZero(t, ctx)
assert.NotZero(t, cli.F)
assert.Zero(t, cli.G)
assert.Equal(t, 6, *cli.F)
}
func TestBoolPtr(t *testing.T) {
var cli struct {
X *bool
}
k, err := kong.New(&cli)
assert.NoError(t, err)
assert.NotZero(t, k)
ctx, err := k.Parse([]string{"--x"})
assert.NoError(t, err)
assert.NotZero(t, ctx)
assert.NotZero(t, cli.X)
assert.Equal(t, true, *cli.X)
}
func TestBoolPtrFalse(t *testing.T) {
var cli struct {
X *bool
}
k, err := kong.New(&cli)
assert.NoError(t, err)
assert.NotZero(t, k)
ctx, err := k.Parse([]string{"--x=false"})
assert.NoError(t, err)
assert.NotZero(t, ctx)
assert.NotZero(t, cli.X)
assert.Equal(t, false, *cli.X)
}
func TestBoolPtrNegated(t *testing.T) {
var cli struct {
X *bool `negatable:""`
}
k, err := kong.New(&cli)
assert.NoError(t, err)
assert.NotZero(t, k)
ctx, err := k.Parse([]string{"--no-x"})
assert.NoError(t, err)
assert.NotZero(t, ctx)
assert.NotZero(t, cli.X)
assert.Equal(t, false, *cli.X)
}
func TestNilNegatableBoolPtr(t *testing.T) {
var cli struct {
X *bool `negatable:""`
}
k, err := kong.New(&cli)
assert.NoError(t, err)
assert.NotZero(t, k)
ctx, err := k.Parse([]string{})
assert.NoError(t, err)
assert.NotZero(t, ctx)
assert.Zero(t, cli.X)
}
func TestBoolPtrNil(t *testing.T) {
var cli struct {
X *bool
}
k, err := kong.New(&cli)
assert.NoError(t, err)
assert.NotZero(t, k)
ctx, err := k.Parse([]string{})
assert.NoError(t, err)
assert.NotZero(t, ctx)
assert.Zero(t, cli.X)
}
func TestUnsupportedPtr(t *testing.T) {
type Foo struct {
x int //nolint
y int //nolint
}
var cli struct {
F *Foo
}
k, err := kong.New(&cli)
assert.NoError(t, err)
assert.NotZero(t, k)
ctx, err := k.Parse([]string{"--f=whatever"})
assert.Zero(t, ctx)
assert.Error(t, err)
assert.Equal(t, "--f: cannot find mapper for kong_test.Foo", err.Error())
}
func TestEnumPtr(t *testing.T) {
var cli struct {
X *string `enum:"A,B,C" default:"C"`
}
k, err := kong.New(&cli)
assert.NoError(t, err)
assert.NotZero(t, k)
ctx, err := k.Parse([]string{"--x=A"})
assert.NoError(t, err)
assert.NotZero(t, ctx)
assert.NotZero(t, cli.X)
assert.Equal(t, "A", *cli.X)
}
func TestEnumPtrOmitted(t *testing.T) {
var cli struct {
X *string `enum:"A,B,C" default:"C"`
}
k, err := kong.New(&cli)
assert.NoError(t, err)
assert.NotZero(t, k)
ctx, err := k.Parse([]string{})
assert.NoError(t, err)
assert.NotZero(t, ctx)
assert.NotZero(t, cli.X)
assert.Equal(t, "C", *cli.X)
}
func TestEnumPtrOmittedNoDefault(t *testing.T) {
var cli struct {
X *string `enum:"A,B,C"`
}
k, err := kong.New(&cli)
assert.NoError(t, err)
assert.NotZero(t, k)
ctx, err := k.Parse([]string{})
assert.NoError(t, err)
assert.NotZero(t, ctx)
assert.Zero(t, cli.X)
}
|