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 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138
|
// Copyright (c) HashiCorp, Inc.
// SPDX-License-Identifier: MPL-2.0
package raft
import (
"bytes"
"encoding/json"
"errors"
"fmt"
"os"
"path/filepath"
"reflect"
"strings"
"sync"
"sync/atomic"
"testing"
"time"
"github.com/hashicorp/go-hclog"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
func TestRaft_StartStop(t *testing.T) {
c := MakeCluster(1, t, nil)
c.Close()
}
func TestRaft_AfterShutdown(t *testing.T) {
c := MakeCluster(1, t, nil)
c.Close()
raft := c.rafts[0]
// Everything should fail now
if f := raft.Apply(nil, 0); f.Error() != ErrRaftShutdown {
t.Fatalf("should be shutdown: %v", f.Error())
}
// TODO (slackpad) - Barrier, VerifyLeader, and GetConfiguration can get
// stuck if the buffered channel consumes the future but things are shut
// down so they never get processed.
if f := raft.AddVoter(ServerID("id"), ServerAddress("addr"), 0, 0); f.Error() != ErrRaftShutdown {
t.Fatalf("should be shutdown: %v", f.Error())
}
if f := raft.AddNonvoter(ServerID("id"), ServerAddress("addr"), 0, 0); f.Error() != ErrRaftShutdown {
t.Fatalf("should be shutdown: %v", f.Error())
}
if f := raft.RemoveServer(ServerID("id"), 0, 0); f.Error() != ErrRaftShutdown {
t.Fatalf("should be shutdown: %v", f.Error())
}
if f := raft.DemoteVoter(ServerID("id"), 0, 0); f.Error() != ErrRaftShutdown {
t.Fatalf("should be shutdown: %v", f.Error())
}
if f := raft.Snapshot(); f.Error() != ErrRaftShutdown {
t.Fatalf("should be shutdown: %v", f.Error())
}
// Should be idempotent
if f := raft.Shutdown(); f.Error() != nil {
t.Fatalf("shutdown should be idempotent")
}
}
func TestRaft_LiveBootstrap(t *testing.T) {
// Make the cluster.
c := MakeClusterNoBootstrap(3, t, nil)
defer c.Close()
// Build the configuration.
configuration := Configuration{}
for _, r := range c.rafts {
server := Server{
ID: r.localID,
Address: r.localAddr,
}
configuration.Servers = append(configuration.Servers, server)
}
// Bootstrap one of the nodes live.
boot := c.rafts[0].BootstrapCluster(configuration)
if err := boot.Error(); err != nil {
t.Fatalf("bootstrap err: %v", err)
}
// Should be one leader.
c.Followers()
leader := c.Leader()
c.EnsureLeader(t, leader.localAddr)
// Should be able to apply.
future := leader.Apply([]byte("test"), c.conf.CommitTimeout)
if err := future.Error(); err != nil {
t.Fatalf("apply err: %v", err)
}
c.WaitForReplication(1)
// Make sure the live bootstrap fails now that things are started up.
boot = c.rafts[0].BootstrapCluster(configuration)
if err := boot.Error(); err != ErrCantBootstrap {
t.Fatalf("bootstrap should have failed: %v", err)
}
}
func TestRaft_LiveBootstrap_From_NonVoter(t *testing.T) {
// Make the cluster.
c := MakeClusterNoBootstrap(2, t, nil)
defer c.Close()
// Build the configuration.
configuration := Configuration{}
for i, r := range c.rafts {
server := Server{
ID: r.localID,
Address: r.localAddr,
}
if i == 0 {
server.Suffrage = Nonvoter
}
configuration.Servers = append(configuration.Servers, server)
}
// Bootstrap one of the nodes live (the non-voter).
boot := c.rafts[0].BootstrapCluster(configuration)
if err := boot.Error(); err != ErrNotVoter {
t.Fatalf("bootstrap should have failed: %v", err)
}
}
func TestRaft_RecoverCluster_NoState(t *testing.T) {
c := MakeClusterNoBootstrap(1, t, nil)
defer c.Close()
r := c.rafts[0]
configuration := Configuration{
Servers: []Server{
{
ID: r.localID,
Address: r.localAddr,
},
},
}
cfg := r.config()
err := RecoverCluster(&cfg, &MockFSM{}, r.logs, r.stable,
r.snapshots, r.trans, configuration)
if err == nil || !strings.Contains(err.Error(), "no initial state") {
t.Fatalf("should have failed for no initial state: %v", err)
}
}
func TestRaft_RecoverCluster(t *testing.T) {
snapshotThreshold := 5
runRecover := func(t *testing.T, applies int) {
var err error
conf := inmemConfig(t)
conf.TrailingLogs = 10
conf.SnapshotThreshold = uint64(snapshotThreshold)
c := MakeCluster(3, t, conf)
defer c.Close()
// Perform some commits.
c.logger.Debug("running with", "applies", applies)
leader := c.Leader()
for i := 0; i < applies; i++ {
future := leader.Apply([]byte(fmt.Sprintf("test%d", i)), 0)
if err = future.Error(); err != nil {
t.Fatalf("[ERR] apply err: %v", err)
}
}
// Snap the configuration.
future := leader.GetConfiguration()
if err = future.Error(); err != nil {
t.Fatalf("[ERR] get configuration err: %v", err)
}
configuration := future.Configuration()
// Shut down the cluster.
for _, sec := range c.rafts {
if err = sec.Shutdown().Error(); err != nil {
t.Fatalf("[ERR] shutdown err: %v", err)
}
}
// Recover the cluster. We need to replace the transport and we
// replace the FSM so no state can carry over.
for i, r := range c.rafts {
var before []*SnapshotMeta
before, err = r.snapshots.List()
if err != nil {
t.Fatalf("snapshot list err: %v", err)
}
cfg := r.config()
if err = RecoverCluster(&cfg, &MockFSM{}, r.logs, r.stable,
r.snapshots, r.trans, configuration); err != nil {
t.Fatalf("recover err: %v", err)
}
// Make sure the recovery looks right.
var after []*SnapshotMeta
after, err = r.snapshots.List()
if err != nil {
t.Fatalf("snapshot list err: %v", err)
}
if len(after) != len(before)+1 {
t.Fatalf("expected a new snapshot, %d vs. %d", len(before), len(after))
}
var first uint64
first, err = r.logs.FirstIndex()
if err != nil {
t.Fatalf("first log index err: %v", err)
}
var last uint64
last, err = r.logs.LastIndex()
if err != nil {
t.Fatalf("last log index err: %v", err)
}
if first != 0 || last != 0 {
t.Fatalf("expected empty logs, got %d/%d", first, last)
}
// Fire up the recovered Raft instance. We have to patch
// up the cluster state manually since this is an unusual
// operation.
_, trans := NewInmemTransport(r.localAddr)
var r2 *Raft
r2, err = NewRaft(&cfg, &MockFSM{}, r.logs, r.stable, r.snapshots, trans)
if err != nil {
t.Fatalf("new raft err: %v", err)
}
c.rafts[i] = r2
c.trans[i] = r2.trans.(*InmemTransport)
c.fsms[i] = r2.fsm.(*MockFSM)
}
c.FullyConnect()
time.Sleep(c.propagateTimeout * 3)
// Let things settle and make sure we recovered.
c.EnsureLeader(t, c.Leader().localAddr)
c.EnsureSame(t)
c.EnsureSamePeers(t)
}
t.Run("no snapshot, no trailing logs", func(t *testing.T) {
runRecover(t, 0)
})
t.Run("no snapshot, some trailing logs", func(t *testing.T) {
runRecover(t, snapshotThreshold-1)
})
t.Run("snapshot, with trailing logs", func(t *testing.T) {
runRecover(t, snapshotThreshold+20)
})
}
func TestRaft_HasExistingState(t *testing.T) {
// Test fails intermittently on amd64, possibly others.
t.Skip("Skipping unreliable test")
var err error
// Make a cluster.
c := MakeCluster(2, t, nil)
defer c.Close()
// Make a new cluster of 1.
c1 := MakeClusterNoBootstrap(1, t, nil)
// Make sure the initial state is clean.
var hasState bool
hasState, err = HasExistingState(c1.rafts[0].logs, c1.rafts[0].stable, c1.rafts[0].snapshots)
if err != nil || hasState {
t.Fatalf("should not have any existing state, %v", err)
}
// Merge clusters.
c.Merge(c1)
c.FullyConnect()
// Join the new node in.
future := c.Leader().AddVoter(c1.rafts[0].localID, c1.rafts[0].localAddr, 0, 0)
if err = future.Error(); err != nil {
t.Fatalf("[ERR] err: %v", err)
}
// Check the FSMs.
c.EnsureSame(t)
// Check the peers.
c.EnsureSamePeers(t)
// Ensure one leader.
c.EnsureLeader(t, c.Leader().localAddr)
// Make sure it's not clean.
hasState, err = HasExistingState(c1.rafts[0].logs, c1.rafts[0].stable, c1.rafts[0].snapshots)
if err != nil || !hasState {
t.Fatalf("should have some existing state, %v", err)
}
}
func TestRaft_SingleNode(t *testing.T) {
conf := inmemConfig(t)
c := MakeCluster(1, t, conf)
defer c.Close()
raft := c.rafts[0]
// Watch leaderCh for change
select {
case v := <-raft.LeaderCh():
if !v {
t.Fatalf("should become leader")
}
case <-time.After(conf.HeartbeatTimeout * 3):
t.Fatalf("timeout becoming leader")
}
// Should be leader
if s := raft.State(); s != Leader {
t.Fatalf("expected leader: %v", s)
}
// Should be able to apply
future := raft.Apply([]byte("test"), c.conf.HeartbeatTimeout)
if err := future.Error(); err != nil {
t.Fatalf("err: %v", err)
}
// Check the response
if future.Response().(int) != 1 {
t.Fatalf("bad response: %v", future.Response())
}
// Check the index
if idx := future.Index(); idx == 0 {
t.Fatalf("bad index: %d", idx)
}
// Check that it is applied to the FSM
if len(getMockFSM(c.fsms[0]).logs) != 1 {
t.Fatalf("did not apply to FSM!")
}
}
func TestRaft_TripleNode(t *testing.T) {
// Make the cluster
c := MakeCluster(3, t, nil)
defer c.Close()
// Should be one leader
c.Followers()
leader := c.Leader()
c.EnsureLeader(t, leader.localAddr)
// Should be able to apply
future := leader.Apply([]byte("test"), c.conf.CommitTimeout)
if err := future.Error(); err != nil {
t.Fatalf("err: %v", err)
}
c.WaitForReplication(1)
}
func TestRaft_LeaderFail(t *testing.T) {
// Make the cluster
c := MakeCluster(3, t, nil)
defer c.Close()
// Should be one leader
c.Followers()
leader := c.Leader()
// Should be able to apply
future := leader.Apply([]byte("test"), c.conf.CommitTimeout)
if err := future.Error(); err != nil {
t.Fatalf("err: %v", err)
}
c.WaitForReplication(1)
// Disconnect the leader now
t.Logf("[INFO] Disconnecting %v", leader)
leaderTerm := leader.getCurrentTerm()
c.Disconnect(leader.localAddr)
// Wait for new leader
limit := time.Now().Add(c.longstopTimeout)
var newLead *Raft
for time.Now().Before(limit) && newLead == nil {
c.WaitEvent(nil, c.conf.CommitTimeout)
leaders := c.GetInState(Leader)
if len(leaders) == 1 && leaders[0] != leader {
newLead = leaders[0]
}
}
if newLead == nil {
t.Fatalf("expected new leader")
}
// Ensure the term is greater
if newLead.getCurrentTerm() <= leaderTerm {
t.Fatalf("expected newer term! %d %d (%v, %v)", newLead.getCurrentTerm(), leaderTerm, newLead, leader)
}
// Apply should work not work on old leader
future1 := leader.Apply([]byte("fail"), c.conf.CommitTimeout)
// Apply should work on newer leader
future2 := newLead.Apply([]byte("apply"), c.conf.CommitTimeout)
// Future2 should work
if err := future2.Error(); err != nil {
t.Fatalf("err: %v", err)
}
// Reconnect the networks
t.Logf("[INFO] Reconnecting %v", leader)
c.FullyConnect()
// Future1 should fail
if err := future1.Error(); err != ErrLeadershipLost && err != ErrNotLeader {
t.Fatalf("err: %v", err)
}
// Wait for log replication
c.EnsureSame(t)
// Check two entries are applied to the FSM
for _, fsmRaw := range c.fsms {
fsm := getMockFSM(fsmRaw)
fsm.Lock()
if len(fsm.logs) != 2 {
t.Fatalf("did not apply both to FSM! %v", fsm.logs)
}
require.Equal(t, fsm.logs[0], []byte("test"))
require.Equal(t, fsm.logs[1], []byte("apply"))
fsm.Unlock()
}
}
func TestRaft_BehindFollower(t *testing.T) {
// Make the cluster
c := MakeCluster(3, t, nil)
defer c.Close()
// Disconnect one follower
leader := c.Leader()
followers := c.Followers()
behind := followers[0]
c.Disconnect(behind.localAddr)
// Commit a lot of things
var future Future
for i := 0; i < 100; i++ {
future = leader.Apply([]byte(fmt.Sprintf("test%d", i)), 0)
}
// Wait for the last future to apply
if err := future.Error(); err != nil {
t.Fatalf("err: %v", err)
} else {
t.Logf("[INFO] Finished apply without behind follower")
}
// Check that we have a non zero last contact
if behind.LastContact().IsZero() {
t.Fatalf("expected previous contact")
}
// Reconnect the behind node
c.FullyConnect()
// Ensure all the logs are the same
c.EnsureSame(t)
// Ensure one leader
leader = c.Leader()
c.EnsureLeader(t, leader.localAddr)
}
func TestRaft_ApplyNonLeader(t *testing.T) {
// Make the cluster
c := MakeCluster(3, t, nil)
defer c.Close()
// Wait for a leader
c.Leader()
// Try to apply to them
followers := c.GetInState(Follower)
if len(followers) != 2 {
t.Fatalf("Expected 2 followers")
}
follower := followers[0]
// Try to apply
future := follower.Apply([]byte("test"), c.conf.CommitTimeout)
if future.Error() != ErrNotLeader {
t.Fatalf("should not apply on follower")
}
// Should be cached
if future.Error() != ErrNotLeader {
t.Fatalf("should not apply on follower")
}
}
func TestRaft_ApplyConcurrent(t *testing.T) {
// Make the cluster
conf := inmemConfig(t)
conf.HeartbeatTimeout = 2 * conf.HeartbeatTimeout
conf.ElectionTimeout = 2 * conf.ElectionTimeout
c := MakeCluster(3, t, conf)
defer c.Close()
// Wait for a leader
leader := c.Leader()
// Create a wait group
const sz = 100
var group sync.WaitGroup
group.Add(sz)
applyF := func(i int) {
defer group.Done()
future := leader.Apply([]byte(fmt.Sprintf("test%d", i)), 0)
if err := future.Error(); err != nil {
c.Failf("[ERR] err: %v", err)
}
}
// Concurrently apply
for i := 0; i < sz; i++ {
go applyF(i)
}
// Wait to finish
doneCh := make(chan struct{})
go func() {
group.Wait()
close(doneCh)
}()
select {
case <-doneCh:
case <-time.After(c.longstopTimeout):
t.Fatalf("timeout")
}
// If anything failed up to this point then bail now, rather than do a
// confusing compare.
if t.Failed() {
t.Fatalf("One or more of the apply operations failed")
}
// Check the FSMs
c.EnsureSame(t)
}
func TestRaft_ApplyConcurrent_Timeout(t *testing.T) {
// Make the cluster
conf := inmemConfig(t)
conf.CommitTimeout = 1 * time.Millisecond
conf.HeartbeatTimeout = 2 * conf.HeartbeatTimeout
conf.ElectionTimeout = 2 * conf.ElectionTimeout
c := MakeCluster(1, t, conf)
defer c.Close()
// Wait for a leader
leader := c.Leader()
// Enough enqueues should cause at least one timeout...
var didTimeout int32
for i := 0; (i < 5000) && (atomic.LoadInt32(&didTimeout) == 0); i++ {
go func(i int) {
future := leader.Apply([]byte(fmt.Sprintf("test%d", i)), time.Microsecond)
if future.Error() == ErrEnqueueTimeout {
atomic.StoreInt32(&didTimeout, 1)
}
}(i)
// Give the leader loop some other things to do in order to
// increase the odds of a timeout.
if i%5 == 0 {
leader.VerifyLeader()
}
}
// Loop until we see a timeout, or give up.
limit := time.Now().Add(c.longstopTimeout)
for time.Now().Before(limit) {
if atomic.LoadInt32(&didTimeout) != 0 {
return
}
c.WaitEvent(nil, c.propagateTimeout)
}
t.Fatalf("Timeout waiting to detect apply timeouts")
}
func TestRaft_JoinNode(t *testing.T) {
// Make a cluster
c := MakeCluster(2, t, nil)
defer c.Close()
// Make a new cluster of 1
c1 := MakeClusterNoBootstrap(1, t, nil)
// Merge clusters
c.Merge(c1)
c.FullyConnect()
// Join the new node in
future := c.Leader().AddVoter(c1.rafts[0].localID, c1.rafts[0].localAddr, 0, 0)
if err := future.Error(); err != nil {
t.Fatalf("err: %v", err)
}
// Ensure one leader
c.EnsureLeader(t, c.Leader().localAddr)
// Check the FSMs
c.EnsureSame(t)
// Check the peers
c.EnsureSamePeers(t)
}
func TestRaft_JoinNode_ConfigStore(t *testing.T) {
// Make a cluster
conf := inmemConfig(t)
c := makeCluster(t, &MakeClusterOpts{
Peers: 1,
Bootstrap: true,
Conf: conf,
ConfigStoreFSM: true,
})
defer c.Close()
// Make a new nodes
c1 := makeCluster(t, &MakeClusterOpts{
Peers: 1,
Bootstrap: false,
Conf: conf,
ConfigStoreFSM: true,
})
c2 := makeCluster(t, &MakeClusterOpts{
Peers: 1,
Bootstrap: false,
Conf: conf,
ConfigStoreFSM: true,
})
// Merge clusters
c.Merge(c1)
c.Merge(c2)
c.FullyConnect()
// Join the new node in
future := c.Leader().AddVoter(c1.rafts[0].localID, c1.rafts[0].localAddr, 0, 0)
if err := future.Error(); err != nil {
t.Fatalf("err: %v", err)
}
// Join the new node in
future = c.Leader().AddVoter(c2.rafts[0].localID, c2.rafts[0].localAddr, 0, 0)
if err := future.Error(); err != nil {
t.Fatalf("err: %v", err)
}
// Ensure one leader
c.EnsureLeader(t, c.Leader().localAddr)
// Check the FSMs
c.EnsureSame(t)
// Check the peers
c.EnsureSamePeers(t)
// Check the fsm holds the correct config logs
for _, fsmRaw := range c.fsms {
fsm := getMockFSM(fsmRaw)
if len(fsm.configurations) != 3 {
t.Fatalf("unexpected number of configuration changes: %d", len(fsm.configurations))
}
if len(fsm.configurations[0].Servers) != 1 {
t.Fatalf("unexpected number of servers in config change: %v", fsm.configurations[0].Servers)
}
if len(fsm.configurations[1].Servers) != 2 {
t.Fatalf("unexpected number of servers in config change: %v", fsm.configurations[1].Servers)
}
if len(fsm.configurations[2].Servers) != 3 {
t.Fatalf("unexpected number of servers in config change: %v", fsm.configurations[2].Servers)
}
}
}
func TestRaft_RemoveFollower(t *testing.T) {
// Make a cluster
c := MakeCluster(3, t, nil)
defer c.Close()
// Get the leader
leader := c.Leader()
// Wait until we have 2 followers
limit := time.Now().Add(c.longstopTimeout)
var followers []*Raft
for time.Now().Before(limit) && len(followers) != 2 {
c.WaitEvent(nil, c.conf.CommitTimeout)
followers = c.GetInState(Follower)
}
if len(followers) != 2 {
t.Fatalf("expected two followers: %v", followers)
}
// Remove a follower
follower := followers[0]
future := leader.RemoveServer(follower.localID, 0, 0)
if err := future.Error(); err != nil {
t.Fatalf("err: %v", err)
}
// Wait a while
time.Sleep(c.propagateTimeout)
// Other nodes should have fewer peers
if configuration := c.getConfiguration(leader); len(configuration.Servers) != 2 {
t.Fatalf("too many peers")
}
if configuration := c.getConfiguration(followers[1]); len(configuration.Servers) != 2 {
t.Fatalf("too many peers")
}
// The removed node should remain in a follower state
require.Equal(t, Follower, follower.getState())
}
func TestRaft_RemoveLeader(t *testing.T) {
// Make a cluster
c := MakeCluster(3, t, nil)
defer c.Close()
// Get the leader
leader := c.Leader()
// Wait until we have 2 followers
limit := time.Now().Add(c.longstopTimeout)
var followers []*Raft
for time.Now().Before(limit) && len(followers) != 2 {
c.WaitEvent(nil, c.conf.CommitTimeout)
followers = c.GetInState(Follower)
}
if len(followers) != 2 {
t.Fatalf("expected two followers: %v", followers)
}
// Remove the leader
f := leader.RemoveServer(leader.localID, 0, 0)
// Wait for the future to complete
if f.Error() != nil {
t.Fatalf("RemoveServer() returned error %v", f.Error())
}
// Wait a bit for log application
time.Sleep(c.propagateTimeout)
// Should have a new leader
time.Sleep(c.propagateTimeout)
newLeader := c.Leader()
if newLeader == leader {
t.Fatalf("removed leader is still leader")
}
// Other nodes should have fewer peers
if configuration := c.getConfiguration(newLeader); len(configuration.Servers) != 2 {
t.Fatalf("wrong number of peers %d", len(configuration.Servers))
}
// Old leader should be shutdown
if leader.State() != Shutdown {
t.Fatalf("old leader should be shutdown")
}
}
func TestRaft_RemoveLeader_NoShutdown(t *testing.T) {
// Make a cluster
conf := inmemConfig(t)
conf.ShutdownOnRemove = false
c := MakeCluster(3, t, conf)
defer c.Close()
// Get the leader
c.Followers()
leader := c.Leader()
// Remove the leader
for i := byte(0); i < 100; i++ {
if i == 80 {
removeFuture := leader.RemoveServer(leader.localID, 0, 0)
if err := removeFuture.Error(); err != nil {
t.Fatalf("err: %v, remove leader failed", err)
}
}
future := leader.Apply([]byte{i}, 0)
if i > 80 {
if err := future.Error(); err == nil || err != ErrNotLeader {
t.Fatalf("err: %v, future entries should fail", err)
}
}
}
// Wait a while
time.Sleep(c.propagateTimeout)
// Should have a new leader
newLeader := c.Leader()
// Wait a bit for log application
time.Sleep(c.propagateTimeout)
// Other nodes should have pulled the leader.
configuration := c.getConfiguration(newLeader)
if len(configuration.Servers) != 2 {
t.Fatalf("too many peers")
}
if hasVote(configuration, leader.localID) {
t.Fatalf("old leader should no longer have a vote")
}
// Old leader should be a follower.
if leader.State() != Follower {
t.Fatalf("leader should be follower")
}
// Old leader should not include itself in its peers.
configuration = c.getConfiguration(leader)
if len(configuration.Servers) != 2 {
t.Fatalf("too many peers")
}
if hasVote(configuration, leader.localID) {
t.Fatalf("old leader should no longer have a vote")
}
// Other nodes should have the same state
c.EnsureSame(t)
}
func TestRaft_RemoveFollower_SplitCluster(t *testing.T) {
// Make a cluster.
conf := inmemConfig(t)
c := MakeCluster(4, t, conf)
defer c.Close()
// Wait for a leader to get elected.
leader := c.Leader()
// Wait to make sure knowledge of the 4th server is known to all the
// peers.
numServers := 0
limit := time.Now().Add(c.longstopTimeout)
for time.Now().Before(limit) && numServers != 4 {
time.Sleep(c.propagateTimeout)
configuration := c.getConfiguration(leader)
numServers = len(configuration.Servers)
}
if numServers != 4 {
t.Fatalf("Leader should have 4 servers, got %d", numServers)
}
c.EnsureSamePeers(t)
// Isolate two of the followers.
followers := c.Followers()
if len(followers) != 3 {
t.Fatalf("Expected 3 followers, got %d", len(followers))
}
c.Partition([]ServerAddress{followers[0].localAddr, followers[1].localAddr})
// Try to remove the remaining follower that was left with the leader.
future := leader.RemoveServer(followers[2].localID, 0, 0)
if err := future.Error(); err == nil {
t.Fatalf("Should not have been able to make peer change")
}
}
func TestRaft_AddKnownPeer(t *testing.T) {
// Make a cluster
c := MakeCluster(3, t, nil)
defer c.Close()
// Get the leader
leader := c.Leader()
followers := c.GetInState(Follower)
configReq := &configurationsFuture{}
configReq.init()
leader.configurationsCh <- configReq
if err := configReq.Error(); err != nil {
t.Fatalf("err: %v", err)
}
startingConfig := configReq.configurations.committed
startingConfigIdx := configReq.configurations.committedIndex
// Add a follower
future := leader.AddVoter(followers[0].localID, followers[0].localAddr, 0, 0)
if err := future.Error(); err != nil {
t.Fatalf("AddVoter() err: %v", err)
}
configReq = &configurationsFuture{}
configReq.init()
leader.configurationsCh <- configReq
if err := configReq.Error(); err != nil {
t.Fatalf("err: %v", err)
}
newConfig := configReq.configurations.committed
newConfigIdx := configReq.configurations.committedIndex
if newConfigIdx <= startingConfigIdx {
t.Fatalf("AddVoter should have written a new config entry, but configurations.commitedIndex still %d", newConfigIdx)
}
if !reflect.DeepEqual(newConfig, startingConfig) {
t.Fatalf("[ERR} AddVoter with existing peer shouldn't have changed config, was %#v, but now %#v", startingConfig, newConfig)
}
}
func TestRaft_RemoveUnknownPeer(t *testing.T) {
// Make a cluster
c := MakeCluster(3, t, nil)
defer c.Close()
// Get the leader
leader := c.Leader()
configReq := &configurationsFuture{}
configReq.init()
leader.configurationsCh <- configReq
if err := configReq.Error(); err != nil {
t.Fatalf("err: %v", err)
}
startingConfig := configReq.configurations.committed
startingConfigIdx := configReq.configurations.committedIndex
// Remove unknown
future := leader.RemoveServer(ServerID(NewInmemAddr()), 0, 0)
// nothing to do, should be a new config entry that's the same as before
if err := future.Error(); err != nil {
t.Fatalf("RemoveServer() err: %v", err)
}
configReq = &configurationsFuture{}
configReq.init()
leader.configurationsCh <- configReq
if err := configReq.Error(); err != nil {
t.Fatalf("err: %v", err)
}
newConfig := configReq.configurations.committed
newConfigIdx := configReq.configurations.committedIndex
if newConfigIdx <= startingConfigIdx {
t.Fatalf("RemoveServer should have written a new config entry, but configurations.commitedIndex still %d", newConfigIdx)
}
if !reflect.DeepEqual(newConfig, startingConfig) {
t.Fatalf("[ERR} RemoveServer with unknown peer shouldn't of changed config, was %#v, but now %#v", startingConfig, newConfig)
}
}
func TestRaft_SnapshotRestore(t *testing.T) {
// Make the cluster
conf := inmemConfig(t)
conf.TrailingLogs = 10
c := MakeCluster(1, t, conf)
defer c.Close()
// Commit a lot of things
leader := c.Leader()
var future Future
for i := 0; i < 100; i++ {
future = leader.Apply([]byte(fmt.Sprintf("test%d", i)), 0)
}
// Wait for the last future to apply
if err := future.Error(); err != nil {
t.Fatalf("err: %v", err)
}
// Take a snapshot
snapFuture := leader.Snapshot()
if err := snapFuture.Error(); err != nil {
t.Fatalf("err: %v", err)
}
// Check for snapshot
snaps, _ := leader.snapshots.List()
if len(snaps) != 1 {
t.Fatalf("should have a snapshot")
}
snap := snaps[0]
// Logs should be trimmed
if idx, _ := leader.logs.FirstIndex(); idx != snap.Index-conf.TrailingLogs+1 {
t.Fatalf("should trim logs to %d: but is %d", snap.Index-conf.TrailingLogs+1, idx)
}
// Shutdown
shutdown := leader.Shutdown()
if err := shutdown.Error(); err != nil {
t.Fatalf("err: %v", err)
}
// Restart the Raft
r := leader
// Can't just reuse the old transport as it will be closed
_, trans2 := NewInmemTransport(r.trans.LocalAddr())
cfg := r.config()
r, err := NewRaft(&cfg, r.fsm, r.logs, r.stable, r.snapshots, trans2)
if err != nil {
t.Fatalf("err: %v", err)
}
c.rafts[0] = r
// We should have restored from the snapshot!
if last := r.getLastApplied(); last != snap.Index {
t.Fatalf("bad last index: %d, expecting %d", last, snap.Index)
}
}
func TestRaft_RestoreSnapshotOnStartup_Monotonic(t *testing.T) {
// Make the cluster
conf := inmemConfig(t)
conf.TrailingLogs = 10
opts := &MakeClusterOpts{
Peers: 1,
Bootstrap: true,
Conf: conf,
MonotonicLogs: true,
}
c := MakeClusterCustom(t, opts)
defer c.Close()
leader := c.Leader()
// Commit a lot of things
var future Future
for i := 0; i < 100; i++ {
future = leader.Apply([]byte(fmt.Sprintf("test%d", i)), 0)
}
// Wait for the last future to apply
if err := future.Error(); err != nil {
t.Fatalf("err: %v", err)
}
// Take a snapshot
snapFuture := leader.Snapshot()
if err := snapFuture.Error(); err != nil {
t.Fatalf("err: %v", err)
}
// Check for snapshot
snaps, _ := leader.snapshots.List()
if len(snaps) != 1 {
t.Fatalf("should have a snapshot")
}
snap := snaps[0]
// Logs should be trimmed
firstIdx, err := leader.logs.FirstIndex()
if err != nil {
t.Fatalf("err: %v", err)
}
lastIdx, err := leader.logs.LastIndex()
if err != nil {
t.Fatalf("err: %v", err)
}
if firstIdx != snap.Index-conf.TrailingLogs+1 {
t.Fatalf("should trim logs to %d: but is %d", snap.Index-conf.TrailingLogs+1, firstIdx)
}
// Shutdown
shutdown := leader.Shutdown()
if err := shutdown.Error(); err != nil {
t.Fatalf("err: %v", err)
}
// Restart the Raft
r := leader
// Can't just reuse the old transport as it will be closed
_, trans2 := NewInmemTransport(r.trans.LocalAddr())
cfg := r.config()
r, err = NewRaft(&cfg, r.fsm, r.logs, r.stable, r.snapshots, trans2)
if err != nil {
t.Fatalf("err: %v", err)
}
c.rafts[0] = r
// We should have restored from the snapshot!
if last := r.getLastApplied(); last != snap.Index {
t.Fatalf("bad last index: %d, expecting %d", last, snap.Index)
}
// Verify that logs have not been reset
first, _ := r.logs.FirstIndex()
last, _ := r.logs.LastIndex()
assert.Equal(t, firstIdx, first)
assert.Equal(t, lastIdx, last)
}
func TestRaft_SnapshotRestore_Progress(t *testing.T) {
// Make the cluster
conf := inmemConfig(t)
conf.TrailingLogs = 10
c := MakeCluster(1, t, conf)
defer c.Close()
// Commit a lot of things
leader := c.Leader()
var future Future
for i := 0; i < 100; i++ {
future = leader.Apply([]byte(fmt.Sprintf("test%d", i)), 0)
}
// Wait for the last future to apply
if err := future.Error(); err != nil {
t.Fatalf("err: %v", err)
}
// Take a snapshot
snapFuture := leader.Snapshot()
if err := snapFuture.Error(); err != nil {
t.Fatalf("err: %v", err)
}
// Check for snapshot
snaps, _ := leader.snapshots.List()
if len(snaps) != 1 {
t.Fatalf("should have a snapshot")
}
snap := snaps[0]
// Logs should be trimmed
if idx, _ := leader.logs.FirstIndex(); idx != snap.Index-conf.TrailingLogs+1 {
t.Fatalf("should trim logs to %d: but is %d", snap.Index-conf.TrailingLogs+1, idx)
}
// Shutdown
shutdown := leader.Shutdown()
if err := shutdown.Error(); err != nil {
t.Fatalf("err: %v", err)
}
// Restart the Raft
r := leader
// Can't just reuse the old transport as it will be closed
_, trans2 := NewInmemTransport(r.trans.LocalAddr())
cfg := r.config()
// Intercept logs and look for specific log messages.
var logbuf lockedBytesBuffer
cfg.Logger = hclog.New(&hclog.LoggerOptions{
Name: "test",
JSONFormat: true,
Level: hclog.Info,
Output: &logbuf,
})
r, err := NewRaft(&cfg, r.fsm, r.logs, r.stable, r.snapshots, trans2)
if err != nil {
t.Fatalf("err: %v", err)
}
c.rafts[0] = r
// We should have restored from the snapshot!
if last := r.getLastApplied(); last != snap.Index {
t.Fatalf("bad last index: %d, expecting %d", last, snap.Index)
}
{
dec := json.NewDecoder(strings.NewReader(logbuf.String()))
found := false
type partialRecord struct {
Message string `json:"@message"`
PercentComplete string `json:"percent-complete"`
}
for !found {
var record partialRecord
if err := dec.Decode(&record); err != nil {
t.Fatalf("error while decoding json logs: %v", err)
}
if record.Message == "snapshot restore progress" && record.PercentComplete == "100.00%" {
found = true
break
}
}
if !found {
t.Fatalf("could not find a log line indicating that snapshot restore progress was being logged")
}
}
}
type lockedBytesBuffer struct {
mu sync.Mutex
buf bytes.Buffer
}
func (b *lockedBytesBuffer) Write(p []byte) (n int, err error) {
b.mu.Lock()
defer b.mu.Unlock()
return b.buf.Write(p)
}
func (b *lockedBytesBuffer) String() string {
b.mu.Lock()
defer b.mu.Unlock()
return b.buf.String()
}
// TODO: Need a test that has a previous format Snapshot and check that it can
// be read/installed on the new code.
// TODO: Need a test to process old-style entries in the Raft log when starting
// up.
func TestRaft_NoRestoreOnStart(t *testing.T) {
conf := inmemConfig(t)
conf.TrailingLogs = 10
conf.NoSnapshotRestoreOnStart = true
c := MakeCluster(1, t, conf)
// Commit a lot of things.
leader := c.Leader()
var future Future
for i := 0; i < 100; i++ {
future = leader.Apply([]byte(fmt.Sprintf("test%d", i)), 0)
}
// Wait for the last future to apply
if err := future.Error(); err != nil {
t.Fatalf("err: %v", err)
}
// Take a snapshot.
snapFuture := leader.Snapshot()
if err := snapFuture.Error(); err != nil {
t.Fatalf("err: %v", err)
}
// Shutdown.
shutdown := leader.Shutdown()
if err := shutdown.Error(); err != nil {
t.Fatalf("err: %v", err)
}
_, trans := NewInmemTransport(leader.localAddr)
newFSM := &MockFSM{}
cfg := leader.config()
_, err := NewRaft(&cfg, newFSM, leader.logs, leader.stable, leader.snapshots, trans)
if err != nil {
t.Fatalf("err: %v", err)
}
if len(newFSM.logs) != 0 {
t.Fatalf("expected empty FSM, got %v", newFSM)
}
}
func TestRaft_SnapshotRestore_PeerChange(t *testing.T) {
// Test fails intermittently on amd64, possibly others.
t.Skip("Skipping unreliable test")
var err error
// Make the cluster.
conf := inmemConfig(t)
conf.ProtocolVersion = 1
conf.TrailingLogs = 10
c := MakeCluster(3, t, conf)
defer c.Close()
// Commit a lot of things.
leader := c.Leader()
var future Future
for i := 0; i < 100; i++ {
future = leader.Apply([]byte(fmt.Sprintf("test%d", i)), 0)
}
// Wait for the last future to apply
if err = future.Error(); err != nil {
t.Fatalf("[ERR] err: %v", err)
}
// Take a snapshot.
snapFuture := leader.Snapshot()
if err = snapFuture.Error(); err != nil {
t.Fatalf("[ERR] err: %v", err)
}
// Shutdown.
shutdown := leader.Shutdown()
if err = shutdown.Error(); err != nil {
t.Fatalf("[ERR] err: %v", err)
}
// Make a separate cluster.
c2 := MakeClusterNoBootstrap(2, t, conf)
defer c2.Close()
// Kill the old cluster.
for _, sec := range c.rafts {
if sec != leader {
if err = sec.Shutdown().Error(); err != nil {
t.Fatalf("[ERR] shutdown err: %v", err)
}
}
}
// Restart the Raft with new peers.
r := leader
// Gather the new peer address list.
var peers []string
peers = append(peers, fmt.Sprintf("%q", leader.trans.LocalAddr()))
for _, sec := range c2.rafts {
peers = append(peers, fmt.Sprintf("%q", sec.trans.LocalAddr()))
}
content := []byte(fmt.Sprintf("[%s]", strings.Join(peers, ",")))
// Perform a manual recovery on the cluster.
base, err := os.MkdirTemp("", "")
if err != nil {
t.Fatalf("err: %v", err)
}
defer os.RemoveAll(base)
peersFile := filepath.Join(base, "peers.json")
if err = os.WriteFile(peersFile, content, 0666); err != nil {
t.Fatalf("[ERR] err: %v", err)
}
configuration, err := ReadPeersJSON(peersFile)
if err != nil {
t.Fatalf("err: %v", err)
}
cfg := r.config()
if err = RecoverCluster(&cfg, &MockFSM{}, r.logs, r.stable,
r.snapshots, r.trans, configuration); err != nil {
t.Fatalf("err: %v", err)
}
// Can't just reuse the old transport as it will be closed. We also start
// with a fresh FSM for good measure so no state can carry over.
_, trans := NewInmemTransport(r.localAddr)
r, err = NewRaft(&cfg, &MockFSM{}, r.logs, r.stable, r.snapshots, trans)
if err != nil {
t.Fatalf("err: %v", err)
}
c.rafts[0] = r
c2.rafts = append(c2.rafts, r)
c2.trans = append(c2.trans, r.trans.(*InmemTransport))
c2.fsms = append(c2.fsms, r.fsm.(*MockFSM))
c2.FullyConnect()
// Wait a while.
time.Sleep(c.propagateTimeout)
// Ensure we elect a leader, and that we replicate to our new followers.
c2.EnsureSame(t)
// We should have restored from the snapshot! Note that there's one
// index bump from the noop the leader tees up when it takes over.
if last := r.getLastApplied(); last != 103 {
t.Fatalf("bad last: %v", last)
}
// Check the peers.
c2.EnsureSamePeers(t)
}
func TestRaft_AutoSnapshot(t *testing.T) {
// Make the cluster
conf := inmemConfig(t)
conf.SnapshotInterval = conf.CommitTimeout * 2
conf.SnapshotThreshold = 50
conf.TrailingLogs = 10
c := MakeCluster(1, t, conf)
defer c.Close()
// Commit a lot of things
leader := c.Leader()
var future Future
for i := 0; i < 100; i++ {
future = leader.Apply([]byte(fmt.Sprintf("test%d", i)), 0)
}
// Wait for the last future to apply
if err := future.Error(); err != nil {
t.Fatalf("err: %v", err)
}
// Wait for a snapshot to happen
time.Sleep(c.propagateTimeout)
// Check for snapshot
if snaps, _ := leader.snapshots.List(); len(snaps) == 0 {
t.Fatalf("should have a snapshot")
}
}
func TestRaft_UserSnapshot(t *testing.T) {
// Make the cluster.
conf := inmemConfig(t)
conf.SnapshotThreshold = 50
conf.TrailingLogs = 10
c := MakeCluster(1, t, conf)
defer c.Close()
// With nothing committed, asking for a snapshot should return an error.
leader := c.Leader()
if userSnapshotErrorsOnNoData {
if err := leader.Snapshot().Error(); err != ErrNothingNewToSnapshot {
t.Fatalf("Request for Snapshot failed: %v", err)
}
}
// Commit some things.
var future Future
for i := 0; i < 10; i++ {
future = leader.Apply([]byte(fmt.Sprintf("test %d", i)), 0)
}
if err := future.Error(); err != nil {
t.Fatalf("Error Apply new log entries: %v", err)
}
// Now we should be able to ask for a snapshot without getting an error.
if err := leader.Snapshot().Error(); err != nil {
t.Fatalf("Request for Snapshot failed: %v", err)
}
// Check for snapshot
if snaps, _ := leader.snapshots.List(); len(snaps) == 0 {
t.Fatalf("should have a snapshot")
}
}
// snapshotAndRestore does a snapshot and restore sequence and applies the given
// offset to the snapshot index, so we can try out different situations.
func snapshotAndRestore(t *testing.T, offset uint64, monotonicLogStore bool, restoreNewCluster bool) {
t.Helper()
// Make the cluster.
conf := inmemConfig(t)
// snapshot operations perform some file IO operations.
// increase times out to account for that
conf.HeartbeatTimeout = 500 * time.Millisecond
conf.ElectionTimeout = 500 * time.Millisecond
conf.LeaderLeaseTimeout = 500 * time.Millisecond
var c *cluster
numPeers := 3
optsMonotonic := &MakeClusterOpts{
Peers: numPeers,
Bootstrap: true,
Conf: conf,
MonotonicLogs: true,
}
if monotonicLogStore {
c = MakeClusterCustom(t, optsMonotonic)
} else {
c = MakeCluster(numPeers, t, conf)
}
defer c.Close()
// Wait for things to get stable and commit some things.
leader := c.Leader()
var future Future
for i := 0; i < 10; i++ {
future = leader.Apply([]byte(fmt.Sprintf("test %d", i)), 0)
}
if err := future.Error(); err != nil {
t.Fatalf("Error Apply new log entries: %v", err)
}
// Take a snapshot.
snap := leader.Snapshot()
if err := snap.Error(); err != nil {
t.Fatalf("Request for Snapshot failed: %v", err)
}
// Commit some more things.
for i := 10; i < 20; i++ {
future = leader.Apply([]byte(fmt.Sprintf("test %d", i)), 0)
}
if err := future.Error(); err != nil {
t.Fatalf("Error Apply new log entries: %v", err)
}
// Get the last index before the restore.
preIndex := leader.getLastIndex()
if restoreNewCluster {
var c2 *cluster
if monotonicLogStore {
c2 = MakeClusterCustom(t, optsMonotonic)
} else {
c2 = MakeCluster(numPeers, t, conf)
}
c = c2
leader = c.Leader()
}
// Restore the snapshot, twiddling the index with the offset.
meta, reader, err := snap.Open()
meta.Index += offset
if err != nil {
t.Fatalf("Snapshot open failed: %v", err)
}
defer reader.Close()
if err := leader.Restore(meta, reader, 5*time.Second); err != nil {
t.Fatalf("Restore failed: %v", err)
}
// Make sure the index was updated correctly. We add 2 because we burn
// an index to create a hole, and then we apply a no-op after the
// restore.
var expected uint64
if !restoreNewCluster && meta.Index < preIndex {
expected = preIndex + 2
} else {
// restoring onto a new cluster should always have a last index based
// off of the snaphsot meta index
expected = meta.Index + 2
}
lastIndex := leader.getLastIndex()
if lastIndex != expected {
t.Fatalf("Index was not updated correctly: %d vs. %d", lastIndex, expected)
}
// Ensure raft logs are removed for monotonic log stores but remain
// untouched for non-monotic (BoltDB) logstores.
// When first index = 1, then logs have remained untouched.
// When first indext is set to the next commit index / last index, then
// it means logs have been removed.
raftNodes := make([]*Raft, 0, numPeers+1)
raftNodes = append(raftNodes, leader)
raftNodes = append(raftNodes, c.Followers()...)
for _, raftNode := range raftNodes {
firstLogIndex, err := raftNode.logs.FirstIndex()
require.NoError(t, err)
lastLogIndex, err := raftNode.logs.LastIndex()
require.NoError(t, err)
if monotonicLogStore {
require.Equal(t, expected, firstLogIndex)
} else {
require.Equal(t, uint64(1), firstLogIndex)
}
require.Equal(t, expected, lastLogIndex)
}
// Ensure all the fsm logs are the same and that we have everything that was
// part of the original snapshot, and that the contents after were
// reverted.
c.EnsureSame(t)
fsm := getMockFSM(c.fsms[0])
fsm.Lock()
if len(fsm.logs) != 10 {
t.Fatalf("Log length bad: %d", len(fsm.logs))
}
for i, entry := range fsm.logs {
expected := []byte(fmt.Sprintf("test %d", i))
require.Equal(t, entry, expected)
}
fsm.Unlock()
// Commit some more things.
for i := 20; i < 30; i++ {
future = leader.Apply([]byte(fmt.Sprintf("test %d", i)), 0)
}
if err := future.Error(); err != nil {
t.Fatalf("Error Apply new log entries: %v", err)
}
c.EnsureSame(t)
}
func TestRaft_UserRestore(t *testing.T) {
cases := []uint64{
0,
1,
2,
// Snapshots from the future
100,
1000,
10000,
}
restoreToNewClusterCases := []bool{false, true}
for _, c := range cases {
for _, restoreNewCluster := range restoreToNewClusterCases {
t.Run(fmt.Sprintf("case %v | restored to new cluster: %t", c, restoreNewCluster), func(t *testing.T) {
snapshotAndRestore(t, c, false, restoreNewCluster)
})
t.Run(fmt.Sprintf("monotonic case %v | restored to new cluster: %t", c, restoreNewCluster), func(t *testing.T) {
snapshotAndRestore(t, c, true, restoreNewCluster)
})
}
}
}
func TestRaft_SendSnapshotFollower(t *testing.T) {
// Make the cluster
conf := inmemConfig(t)
conf.TrailingLogs = 10
c := MakeCluster(3, t, conf)
defer c.Close()
// Disconnect one follower
followers := c.Followers()
leader := c.Leader()
behind := followers[0]
c.Disconnect(behind.localAddr)
// Commit a lot of things
var future Future
for i := 0; i < 100; i++ {
future = leader.Apply([]byte(fmt.Sprintf("test%d", i)), 0)
}
// Wait for the last future to apply
if err := future.Error(); err != nil {
t.Fatalf("err: %v", err)
} else {
t.Logf("[INFO] Finished apply without behind follower")
}
// Snapshot, this will truncate logs!
for _, r := range c.rafts {
future = r.Snapshot()
// the disconnected node will have nothing to snapshot, so that's expected
if err := future.Error(); err != nil && err != ErrNothingNewToSnapshot {
t.Fatalf("err: %v", err)
}
}
// Reconnect the behind node
c.FullyConnect()
// Ensure all the logs are the same
c.EnsureSame(t)
}
func TestRaft_SendSnapshotAndLogsFollower(t *testing.T) {
// Make the cluster
conf := inmemConfig(t)
conf.TrailingLogs = 10
c := MakeCluster(3, t, conf)
defer c.Close()
// Disconnect one follower
followers := c.Followers()
leader := c.Leader()
behind := followers[0]
c.Disconnect(behind.localAddr)
// Commit a lot of things
var future Future
for i := 0; i < 100; i++ {
future = leader.Apply([]byte(fmt.Sprintf("test%d", i)), 0)
}
// Wait for the last future to apply
if err := future.Error(); err != nil {
t.Fatalf("err: %v", err)
} else {
t.Logf("[INFO] Finished apply without behind follower")
}
// Snapshot, this will truncate logs!
for _, r := range c.rafts {
future = r.Snapshot()
// the disconnected node will have nothing to snapshot, so that's expected
if err := future.Error(); err != nil && err != ErrNothingNewToSnapshot {
t.Fatalf("err: %v", err)
}
}
// Commit more logs past the snapshot.
for i := 100; i < 200; i++ {
future = leader.Apply([]byte(fmt.Sprintf("test%d", i)), 0)
}
// Wait for the last future to apply
if err := future.Error(); err != nil {
t.Fatalf("err: %v", err)
} else {
t.Logf("[INFO] Finished apply without behind follower")
}
// Reconnect the behind node
c.FullyConnect()
// Ensure all the logs are the same
c.EnsureSame(t)
}
func TestRaft_ReJoinFollower(t *testing.T) {
// Enable operation after a remove.
conf := inmemConfig(t)
conf.ShutdownOnRemove = false
c := MakeCluster(3, t, conf)
defer c.Close()
// Get the leader.
leader := c.Leader()
// Wait until we have 2 followers.
limit := time.Now().Add(c.longstopTimeout)
var followers []*Raft
for time.Now().Before(limit) && len(followers) != 2 {
c.WaitEvent(nil, c.conf.CommitTimeout)
followers = c.GetInState(Follower)
}
if len(followers) != 2 {
t.Fatalf("expected two followers: %v", followers)
}
// Remove a follower.
follower := followers[0]
future := leader.RemoveServer(follower.localID, 0, 0)
if err := future.Error(); err != nil {
t.Fatalf("err: %v", err)
}
// Other nodes should have fewer peers.
time.Sleep(c.propagateTimeout)
if configuration := c.getConfiguration(leader); len(configuration.Servers) != 2 {
t.Fatalf("too many peers: %v", configuration)
}
if configuration := c.getConfiguration(followers[1]); len(configuration.Servers) != 2 {
t.Fatalf("too many peers: %v", configuration)
}
// Get the leader. We can't use the normal stability checker here because
// the removed server will be trying to run an election but will be
// ignored. The stability check will think this is off nominal because
// the RequestVote RPCs won't stop firing.
limit = time.Now().Add(c.longstopTimeout)
var leaders []*Raft
for time.Now().Before(limit) && len(leaders) != 1 {
c.WaitEvent(nil, c.conf.CommitTimeout)
leaders, _ = c.pollState(Leader)
}
if len(leaders) != 1 {
t.Fatalf("expected a leader")
}
leader = leaders[0]
// Rejoin. The follower will have a higher term than the leader,
// this will cause the leader to step down, and a new round of elections
// to take place. We should eventually re-stabilize.
future = leader.AddVoter(follower.localID, follower.localAddr, 0, 0)
if err := future.Error(); err != nil && err != ErrLeadershipLost {
t.Fatalf("err: %v", err)
}
// We should level back up to the proper number of peers. We add a
// stability check here to make sure the cluster gets to a state where
// there's a solid leader.
leader = c.Leader()
if configuration := c.getConfiguration(leader); len(configuration.Servers) != 3 {
t.Fatalf("missing peers: %v", configuration)
}
if configuration := c.getConfiguration(followers[1]); len(configuration.Servers) != 3 {
t.Fatalf("missing peers: %v", configuration)
}
// Should be a follower now.
if follower.State() != Follower {
t.Fatalf("bad state: %v", follower.State())
}
}
func TestRaft_LeaderLeaseExpire(t *testing.T) {
// Make a cluster
conf := inmemConfig(t)
c := MakeCluster(2, t, conf)
defer c.Close()
// Get the leader
leader := c.Leader()
// Wait until we have a followers
limit := time.Now().Add(c.longstopTimeout)
var followers []*Raft
for time.Now().Before(limit) && len(followers) != 1 {
c.WaitEvent(nil, c.conf.CommitTimeout)
followers = c.GetInState(Follower)
}
if len(followers) != 1 {
t.Fatalf("expected a followers: %v", followers)
}
// Disconnect the follower now
follower := followers[0]
t.Logf("[INFO] Disconnecting %v", follower)
c.Disconnect(follower.localAddr)
// Watch the leaderCh
timeout := time.After(conf.LeaderLeaseTimeout * 2)
LOOP:
for {
select {
case v := <-leader.LeaderCh():
if !v {
break LOOP
}
case <-timeout:
t.Fatalf("timeout stepping down as leader")
}
}
// Ensure the last contact of the leader is non-zero
if leader.LastContact().IsZero() {
t.Fatalf("expected non-zero contact time")
}
// Should be no leaders
if len(c.GetInState(Leader)) != 0 {
t.Fatalf("expected step down")
}
// Verify no further contact
last := follower.LastContact()
time.Sleep(c.propagateTimeout)
// Check that last contact has not changed
if last != follower.LastContact() {
t.Fatalf("unexpected further contact")
}
// Ensure both have cleared their leader
if l, id := leader.LeaderWithID(); l != "" && id != "" {
t.Fatalf("bad: %v", l)
}
if l, id := follower.LeaderWithID(); l != "" && id != "" {
t.Fatalf("bad: %v", l)
}
}
func TestRaft_Barrier(t *testing.T) {
// Make the cluster
c := MakeCluster(3, t, nil)
defer c.Close()
// Get the leader
leader := c.Leader()
// Commit a lot of things
for i := 0; i < 100; i++ {
leader.Apply([]byte(fmt.Sprintf("test%d", i)), 0)
}
// Wait for a barrier complete
barrier := leader.Barrier(0)
// Wait for the barrier future to apply
if err := barrier.Error(); err != nil {
t.Fatalf("err: %v", err)
}
// Ensure all the logs are the same
c.EnsureSame(t)
if len(getMockFSM(c.fsms[0]).logs) != 100 {
t.Fatalf(fmt.Sprintf("Bad log length: %d", len(getMockFSM(c.fsms[0]).logs)))
}
}
func TestRaft_VerifyLeader(t *testing.T) {
// Make the cluster
c := MakeCluster(3, t, nil)
defer c.Close()
// Get the leader
leader := c.Leader()
// Verify we are leader
verify := leader.VerifyLeader()
// Wait for the verify to apply
if err := verify.Error(); err != nil {
t.Fatalf("err: %v", err)
}
}
func TestRaft_VerifyLeader_Single(t *testing.T) {
// Make the cluster
c := MakeCluster(1, t, nil)
defer c.Close()
// Get the leader
leader := c.Leader()
// Verify we are leader
verify := leader.VerifyLeader()
// Wait for the verify to apply
if err := verify.Error(); err != nil {
t.Fatalf("err: %v", err)
}
}
func TestRaft_VerifyLeader_Fail(t *testing.T) {
// Make a cluster
conf := inmemConfig(t)
c := MakeCluster(2, t, conf)
defer c.Close()
leader := c.Leader()
// Remove the leader election notification from the channel buffer
<-leader.LeaderCh()
// Wait until we have a followers
followers := c.Followers()
// Force follower to different term
follower := followers[0]
follower.setCurrentTerm(follower.getCurrentTerm() + 1)
// Wait for the leader to step down
select {
case v := <-leader.LeaderCh():
if v {
t.Fatalf("expected the leader to step down")
}
case <-time.After(conf.HeartbeatTimeout * 3):
c.FailNowf("timeout waiting for leader to step down")
}
// Verify we are leader
verify := leader.VerifyLeader()
if err := verify.Error(); err != ErrNotLeader && err != ErrLeadershipLost {
t.Fatalf("err: %v", err)
}
// Ensure the known leader is cleared
if l, _ := leader.LeaderWithID(); l != "" {
t.Fatalf("bad: %v", l)
}
}
func TestRaft_VerifyLeader_PartialConnect(t *testing.T) {
// Make a cluster
conf := inmemConfig(t)
c := MakeCluster(3, t, conf)
defer c.Close()
// Get the leader
leader := c.Leader()
// Wait until we have a followers
limit := time.Now().Add(c.longstopTimeout)
var followers []*Raft
for time.Now().Before(limit) && len(followers) != 2 {
c.WaitEvent(nil, c.conf.CommitTimeout)
followers = c.GetInState(Follower)
}
if len(followers) != 2 {
t.Fatalf("expected two followers but got: %v", followers)
}
// Force partial disconnect
follower := followers[0]
t.Logf("[INFO] Disconnecting %v", follower)
c.Disconnect(follower.localAddr)
// Verify we are leader
verify := leader.VerifyLeader()
// Wait for the leader to step down
if err := verify.Error(); err != nil {
t.Fatalf("err: %v", err)
}
}
func TestRaft_NotifyCh(t *testing.T) {
ch := make(chan bool, 1)
conf := inmemConfig(t)
conf.NotifyCh = ch
c := MakeCluster(1, t, conf)
defer c.Close()
// Watch leaderCh for change
select {
case v := <-ch:
if !v {
t.Fatalf("should become leader")
}
case <-time.After(conf.HeartbeatTimeout * 8):
t.Fatalf("timeout becoming leader")
}
// Close the cluster
c.Close()
// Watch leaderCh for change
select {
case v := <-ch:
if v {
t.Fatalf("should step down as leader")
}
case <-time.After(conf.HeartbeatTimeout * 6):
t.Fatalf("timeout on step down as leader")
}
}
func TestRaft_AppendEntry(t *testing.T) {
c := MakeCluster(3, t, nil)
defer c.Close()
followers := c.Followers()
ldr := c.Leader()
ldrT := c.trans[c.IndexOf(ldr)]
reqAppendEntries := AppendEntriesRequest{
RPCHeader: ldr.getRPCHeader(),
Term: ldr.getCurrentTerm() + 1,
PrevLogEntry: 0,
PrevLogTerm: ldr.getCurrentTerm(),
Leader: nil,
Entries: []*Log{
{
Index: 1,
Term: ldr.getCurrentTerm() + 1,
Type: LogCommand,
Data: []byte("log 1"),
},
},
LeaderCommitIndex: 90,
}
// a follower that thinks there's a leader should vote for that leader.
var resp AppendEntriesResponse
if err := ldrT.AppendEntries(followers[0].localID, followers[0].localAddr, &reqAppendEntries, &resp); err != nil {
t.Fatalf("RequestVote RPC failed %v", err)
}
require.True(t, resp.Success)
headers := ldr.getRPCHeader()
headers.ID = nil
headers.Addr = nil
reqAppendEntries = AppendEntriesRequest{
RPCHeader: headers,
Term: ldr.getCurrentTerm() + 1,
PrevLogEntry: 0,
PrevLogTerm: ldr.getCurrentTerm(),
Leader: ldr.trans.EncodePeer(ldr.config().LocalID, ldr.localAddr),
Entries: []*Log{
{
Index: 1,
Term: ldr.getCurrentTerm() + 1,
Type: LogCommand,
Data: []byte("log 1"),
},
},
LeaderCommitIndex: 90,
}
// a follower that thinks there's a leader should vote for that leader.
var resp2 AppendEntriesResponse
if err := ldrT.AppendEntries(followers[0].localID, followers[0].localAddr, &reqAppendEntries, &resp2); err != nil {
t.Fatalf("RequestVote RPC failed %v", err)
}
require.True(t, resp2.Success)
}
func TestRaft_VotingGrant_WhenLeaderAvailable(t *testing.T) {
conf := inmemConfig(t)
conf.ProtocolVersion = 3
c := MakeCluster(3, t, conf)
defer c.Close()
followers := c.Followers()
ldr := c.Leader()
ldrT := c.trans[c.IndexOf(ldr)]
reqVote := RequestVoteRequest{
RPCHeader: ldr.getRPCHeader(),
Term: ldr.getCurrentTerm() + 10,
LastLogIndex: ldr.LastIndex(),
Candidate: ldrT.EncodePeer(ldr.localID, ldr.localAddr),
LastLogTerm: ldr.getCurrentTerm(),
LeadershipTransfer: false,
}
// a follower that thinks there's a leader should vote for that leader.
var resp RequestVoteResponse
if err := ldrT.RequestVote(followers[0].localID, followers[0].localAddr, &reqVote, &resp); err != nil {
t.Fatalf("RequestVote RPC failed %v", err)
}
if !resp.Granted {
t.Fatalf("expected vote to be granted, but wasn't %+v", resp)
}
// a follower that thinks there's a leader shouldn't vote for a different candidate
reqVote.Addr = ldrT.EncodePeer(followers[0].localID, followers[0].localAddr)
reqVote.Candidate = ldrT.EncodePeer(followers[0].localID, followers[0].localAddr)
if err := ldrT.RequestVote(followers[1].localID, followers[1].localAddr, &reqVote, &resp); err != nil {
t.Fatalf("RequestVote RPC failed %v", err)
}
if resp.Granted {
t.Fatalf("expected vote not to be granted, but was %+v", resp)
}
// a follower that thinks there's a leader, but the request has the leadership transfer flag, should
// vote for a different candidate
reqVote.LeadershipTransfer = true
reqVote.Addr = ldrT.EncodePeer(followers[0].localID, followers[0].localAddr)
reqVote.Candidate = ldrT.EncodePeer(followers[0].localID, followers[0].localAddr)
if err := ldrT.RequestVote(followers[1].localID, followers[1].localAddr, &reqVote, &resp); err != nil {
t.Fatalf("RequestVote RPC failed %v", err)
}
if !resp.Granted {
t.Fatalf("expected vote to be granted, but wasn't %+v", resp)
}
}
func TestRaft_ProtocolVersion_RejectRPC(t *testing.T) {
c := MakeCluster(3, t, nil)
defer c.Close()
followers := c.Followers()
ldr := c.Leader()
ldrT := c.trans[c.IndexOf(ldr)]
reqVote := RequestVoteRequest{
RPCHeader: RPCHeader{
ProtocolVersion: ProtocolVersionMax + 1,
Addr: ldrT.EncodePeer(ldr.localID, ldr.localAddr),
},
Term: ldr.getCurrentTerm() + 10,
LastLogIndex: ldr.LastIndex(),
LastLogTerm: ldr.getCurrentTerm(),
}
// Reject a message from a future version we don't understand.
var resp RequestVoteResponse
err := ldrT.RequestVote(followers[0].localID, followers[0].localAddr, &reqVote, &resp)
if err == nil || !strings.Contains(err.Error(), "protocol version") {
t.Fatalf("expected RPC to get rejected: %v", err)
}
// Reject a message that's too old.
reqVote.RPCHeader.ProtocolVersion = followers[0].protocolVersion - 2
err = ldrT.RequestVote(followers[0].localID, followers[0].localAddr, &reqVote, &resp)
if err == nil || !strings.Contains(err.Error(), "protocol version") {
t.Fatalf("expected RPC to get rejected: %v", err)
}
}
func TestRaft_ProtocolVersion_Upgrade_1_2(t *testing.T) {
// Test fails intermittently on armel, i386, s390x.
t.Skip("Skipping unreliable test")
// Make a cluster back on protocol version 1.
conf := inmemConfig(t)
conf.ProtocolVersion = 1
c := MakeCluster(2, t, conf)
defer c.Close()
// Set up another server speaking protocol version 2.
conf = inmemConfig(t)
conf.ProtocolVersion = 2
c1 := MakeClusterNoBootstrap(1, t, conf)
// Merge clusters.
c.Merge(c1)
c.FullyConnect()
// Make sure the new ID-based operations aren't supported in the old
// protocol.
future := c.Leader().AddNonvoter(c1.rafts[0].localID, c1.rafts[0].localAddr, 0, 1*time.Second)
if err := future.Error(); err != ErrUnsupportedProtocol {
t.Fatalf("err: %v", err)
}
future = c.Leader().DemoteVoter(c1.rafts[0].localID, 0, 1*time.Second)
if err := future.Error(); err != ErrUnsupportedProtocol {
t.Fatalf("err: %v", err)
}
// Now do the join using the old address-based API.
if future := c.Leader().AddPeer(c1.rafts[0].localAddr); future.Error() != nil {
t.Fatalf("err: %v", future.Error())
}
// Sanity check the cluster.
c.EnsureSame(t)
c.EnsureSamePeers(t)
c.EnsureLeader(t, c.Leader().localAddr)
// Now do the remove using the old address-based API.
if future := c.Leader().RemovePeer(c1.rafts[0].localAddr); future.Error() != nil {
t.Fatalf("err: %v", future.Error())
}
}
func TestRaft_ProtocolVersion_Upgrade_2_3(t *testing.T) {
// Test fails intermittently on armel, i386, s390x.
t.Skip("Skipping unreliable test")
// Make a cluster back on protocol version 2.
conf := inmemConfig(t)
conf.ProtocolVersion = 2
c := MakeCluster(2, t, conf)
defer c.Close()
oldAddr := c.Followers()[0].localAddr
// Set up another server speaking protocol version 3.
conf = inmemConfig(t)
conf.ProtocolVersion = 3
c1 := MakeClusterNoBootstrap(1, t, conf)
// Merge clusters.
c.Merge(c1)
c.FullyConnect()
// Use the new ID-based API to add the server with its ID.
future := c.Leader().AddVoter(c1.rafts[0].localID, c1.rafts[0].localAddr, 0, 1*time.Second)
if err := future.Error(); err != nil {
t.Fatalf("err: %v", err)
}
// Sanity check the cluster.
c.EnsureSame(t)
c.EnsureSamePeers(t)
c.EnsureLeader(t, c.Leader().localAddr)
// Remove an old server using the old address-based API.
if future := c.Leader().RemovePeer(oldAddr); future.Error() != nil {
t.Fatalf("err: %v", future.Error())
}
}
func TestRaft_LeaderID_Propagated(t *testing.T) {
// Make a cluster on protocol version 3.
conf := inmemConfig(t)
c := MakeCluster(3, t, conf)
defer c.Close()
err := waitForLeader(c)
require.NoError(t, err)
for _, n := range c.rafts {
require.Equal(t, ProtocolVersion(3), n.protocolVersion)
addr, id := n.LeaderWithID()
require.NotEmpty(t, id)
require.NotEmpty(t, addr)
}
for i := 0; i < 5; i++ {
future := c.Leader().Apply([]byte(fmt.Sprintf("test%d", i)), 0)
if err := future.Error(); err != nil {
t.Fatalf("[ERR] err: %v", err)
}
}
// Wait a while
time.Sleep(c.propagateTimeout)
// Sanity check the cluster.
c.EnsureSame(t)
c.EnsureSamePeers(t)
c.EnsureLeader(t, c.Leader().localAddr)
}
func TestRaft_LeadershipTransferInProgress(t *testing.T) {
r := &Raft{leaderState: leaderState{}}
r.setupLeaderState()
if r.getLeadershipTransferInProgress() != false {
t.Errorf("should be true after setup")
}
r.setLeadershipTransferInProgress(true)
if r.getLeadershipTransferInProgress() != true {
t.Errorf("should be true because we set it before")
}
r.setLeadershipTransferInProgress(false)
if r.getLeadershipTransferInProgress() != false {
t.Errorf("should be false because we set it before")
}
}
func pointerToString(s string) *string {
return &s
}
func TestRaft_LeadershipTransferPickServer(t *testing.T) {
type variant struct {
lastLogIndex int
servers map[string]uint64
expected *string
}
leaderID := "z"
variants := []variant{
{lastLogIndex: 10, servers: map[string]uint64{}, expected: nil},
{lastLogIndex: 10, servers: map[string]uint64{leaderID: 11, "a": 9}, expected: pointerToString("a")},
{lastLogIndex: 10, servers: map[string]uint64{leaderID: 11, "a": 9, "b": 8}, expected: pointerToString("a")},
{lastLogIndex: 10, servers: map[string]uint64{leaderID: 11, "c": 9, "b": 8, "a": 8}, expected: pointerToString("c")},
{lastLogIndex: 10, servers: map[string]uint64{leaderID: 11, "a": 7, "b": 11, "c": 8}, expected: pointerToString("b")},
}
for i, v := range variants {
servers := []Server{}
replState := map[ServerID]*followerReplication{}
for id, idx := range v.servers {
servers = append(servers, Server{ID: ServerID(id)})
replState[ServerID(id)] = &followerReplication{nextIndex: idx}
}
r := Raft{leaderState: leaderState{}, localID: ServerID(leaderID), configurations: configurations{latest: Configuration{Servers: servers}}}
r.lastLogIndex = uint64(v.lastLogIndex)
r.leaderState.replState = replState
actual := r.pickServer()
if v.expected == nil && actual == nil {
continue
} else if v.expected == nil && actual != nil {
t.Errorf("case %d: actual: %v doesn't match expected: %v", i, actual, v.expected)
} else if actual == nil && v.expected != nil {
t.Errorf("case %d: actual: %v doesn't match expected: %v", i, actual, v.expected)
} else if string(actual.ID) != *v.expected {
t.Errorf("case %d: actual: %v doesn't match expected: %v", i, actual.ID, *v.expected)
}
}
}
func TestRaft_LeadershipTransfer(t *testing.T) {
c := MakeCluster(3, t, nil)
defer c.Close()
oldLeader := string(c.Leader().localID)
err := c.Leader().LeadershipTransfer()
if err.Error() != nil {
t.Fatalf("Didn't expect error: %v", err.Error())
}
newLeader := string(c.Leader().localID)
if oldLeader == newLeader {
t.Error("Leadership should have been transitioned to another peer.")
}
}
func TestRaft_LeadershipTransferWithOneNode(t *testing.T) {
c := MakeCluster(1, t, nil)
defer c.Close()
future := c.Leader().LeadershipTransfer()
if future.Error() == nil {
t.Fatal("leadership transfer should err")
}
expected := "cannot find peer"
actual := future.Error().Error()
if !strings.Contains(actual, expected) {
t.Errorf("leadership transfer should err with: %s", expected)
}
}
func TestRaft_LeadershipTransferWithSevenNodes(t *testing.T) {
c := MakeCluster(7, t, nil)
defer c.Close()
oldLeader := c.Leader().localID
follower := c.GetInState(Follower)[0]
future := c.Leader().LeadershipTransferToServer(follower.localID, follower.localAddr)
if future.Error() != nil {
t.Fatalf("Didn't expect error: %v", future.Error())
}
if oldLeader == c.Leader().localID {
t.Error("Leadership should have been transitioned to specified server.")
}
}
func TestRaft_LeadershipTransferToInvalidID(t *testing.T) {
c := MakeCluster(3, t, nil)
defer c.Close()
future := c.Leader().LeadershipTransferToServer(ServerID("abc"), ServerAddress("localhost"))
if future.Error() == nil {
t.Fatal("leadership transfer should err")
}
expected := "cannot find replication state"
actual := future.Error().Error()
if !strings.Contains(actual, expected) {
t.Errorf("leadership transfer should err with: %s", expected)
}
}
func TestRaft_LeadershipTransferToInvalidAddress(t *testing.T) {
c := MakeCluster(3, t, nil)
defer c.Close()
follower := c.GetInState(Follower)[0]
future := c.Leader().LeadershipTransferToServer(follower.localID, ServerAddress("localhost"))
if future.Error() == nil {
t.Fatal("leadership transfer should err")
}
expected := "failed to make TimeoutNow RPC"
actual := future.Error().Error()
if !strings.Contains(actual, expected) {
t.Errorf("leadership transfer should err with: %s", expected)
}
}
func TestRaft_LeadershipTransferToBehindServer(t *testing.T) {
c := MakeCluster(3, t, nil)
defer c.Close()
l := c.Leader()
behind := c.GetInState(Follower)[0]
// Commit a lot of things
for i := 0; i < 1000; i++ {
l.Apply([]byte(fmt.Sprintf("test%d", i)), 0)
}
future := l.LeadershipTransferToServer(behind.localID, behind.localAddr)
if future.Error() != nil {
t.Fatalf("This is not supposed to error: %v", future.Error())
}
if c.Leader().localID != behind.localID {
t.Fatal("Behind server did not get leadership")
}
}
func TestRaft_LeadershipTransferToItself(t *testing.T) {
c := MakeCluster(3, t, nil)
defer c.Close()
l := c.Leader()
future := l.LeadershipTransferToServer(l.localID, l.localAddr)
if future.Error() == nil {
t.Fatal("leadership transfer should err")
}
expected := "cannot transfer leadership to itself"
actual := future.Error().Error()
if !strings.Contains(actual, expected) {
t.Errorf("leadership transfer should err with: %s", expected)
}
}
func TestRaft_LeadershipTransferLeaderRejectsClientRequests(t *testing.T) {
c := MakeCluster(3, t, nil)
defer c.Close()
l := c.Leader()
l.setLeadershipTransferInProgress(true)
// tests for API > protocol version 3 is missing here because leadership transfer
// is only available for protocol version >= 3
// TODO: is something missing here?
futures := []Future{
l.AddNonvoter(ServerID(""), ServerAddress(""), 0, 0),
l.AddVoter(ServerID(""), ServerAddress(""), 0, 0),
l.Apply([]byte("test"), 0),
l.Barrier(0),
l.DemoteVoter(ServerID(""), 0, 0),
// the API is tested, but here we are making sure we reject any config change.
l.requestConfigChange(configurationChangeRequest{}, 100*time.Millisecond),
}
futures = append(futures, l.LeadershipTransfer())
for i, f := range futures {
t.Logf("waiting on future %v", i)
if f.Error() != ErrLeadershipTransferInProgress {
t.Errorf("case %d: should have errored with: %s, instead of %s", i, ErrLeadershipTransferInProgress, f.Error())
}
}
f := l.LeadershipTransferToServer(ServerID(""), ServerAddress(""))
if f.Error() != ErrLeadershipTransferInProgress {
t.Errorf("should have errored with: %s, instead of %s", ErrLeadershipTransferInProgress, f.Error())
}
}
func TestRaft_LeadershipTransferLeaderReplicationTimeout(t *testing.T) {
c := MakeCluster(3, t, nil)
defer c.Close()
l := c.Leader()
behind := c.GetInState(Follower)[0]
// Commit a lot of things, so that the timeout can kick in
for i := 0; i < 10000; i++ {
l.Apply([]byte(fmt.Sprintf("test%d", i)), 0)
}
// set ElectionTimeout really short because this is used to determine
// how long a transfer is allowed to take.
cfg := l.config()
cfg.ElectionTimeout = 1 * time.Nanosecond
l.conf.Store(cfg)
future := l.LeadershipTransferToServer(behind.localID, behind.localAddr)
if future.Error() == nil {
t.Log("This test is fishing for a replication timeout, but this is not guaranteed to happen.")
} else {
expected := "leadership transfer timeout"
actual := future.Error().Error()
if !strings.Contains(actual, expected) {
t.Errorf("leadership transfer should err with: %s", expected)
}
}
}
func TestRaft_LeadershipTransferIgnoresNonvoters(t *testing.T) {
c := MakeCluster(2, t, nil)
defer c.Close()
follower := c.Followers()[0]
demoteFuture := c.Leader().DemoteVoter(follower.localID, 0, 0)
if demoteFuture.Error() != nil {
t.Fatalf("demote voter err'd: %v", demoteFuture.Error())
}
future := c.Leader().LeadershipTransfer()
if future.Error() == nil {
t.Fatal("leadership transfer should err")
}
expected := "cannot find peer"
actual := future.Error().Error()
if !strings.Contains(actual, expected) {
t.Errorf("leadership transfer should err with: %s", expected)
}
}
func TestRaft_LeadershipTransferStopRightAway(t *testing.T) {
r := Raft{leaderState: leaderState{}}
r.setupLeaderState()
stopCh := make(chan struct{})
doneCh := make(chan error, 1)
close(stopCh)
r.leadershipTransfer(ServerID("a"), ServerAddress(""), &followerReplication{}, stopCh, doneCh)
err := <-doneCh
if err != nil {
t.Errorf("leadership shouldn't have started, but instead it error with: %v", err)
}
}
func TestRaft_GetConfigurationNoBootstrap(t *testing.T) {
c := MakeCluster(2, t, nil)
defer c.Close()
// Should be one leader
c.Followers()
leader := c.Leader()
c.EnsureLeader(t, leader.localAddr)
// Should be able to apply
future := leader.Apply([]byte("test"), c.conf.CommitTimeout)
if err := future.Error(); err != nil {
t.Fatalf("[ERR] err: %v", err)
}
c.WaitForReplication(1)
// Get configuration via GetConfiguration of a running node
cfgf := c.rafts[0].GetConfiguration()
if err := cfgf.Error(); err != nil {
t.Fatal(err)
}
expected := cfgf.Configuration()
// Obtain the same configuration via GetConfig
logs := c.stores[0]
store := c.stores[0]
snap := c.snaps[0]
trans := c.trans[0]
observed, err := GetConfiguration(c.conf, c.fsms[0], logs, store, snap, trans)
if err != nil {
t.Fatal(err)
}
if !reflect.DeepEqual(observed, expected) {
t.Errorf("GetConfiguration result differ from Raft.GetConfiguration: observed %+v, expected %+v", observed, expected)
}
}
func TestRaft_LogStoreIsMonotonic(t *testing.T) {
c := MakeCluster(1, t, nil)
defer c.Close()
// Should be one leader
leader := c.Leader()
c.EnsureLeader(t, leader.localAddr)
// Test the monotonic type assertion on the InmemStore.
_, ok := leader.logs.(MonotonicLogStore)
assert.False(t, ok)
var log LogStore
// Wrapping the non-monotonic store as a LogCache should make it pass the
// type assertion, but the underlying store is still non-monotonic.
log, _ = NewLogCache(100, leader.logs)
mcast, ok := log.(MonotonicLogStore)
require.True(t, ok)
assert.False(t, mcast.IsMonotonic())
// Now create a new MockMonotonicLogStore using the leader logs and expect
// it to work.
log = &MockMonotonicLogStore{s: leader.logs}
mcast, ok = log.(MonotonicLogStore)
require.True(t, ok)
assert.True(t, mcast.IsMonotonic())
// Wrap the mock logstore in a LogCache and check again.
log, _ = NewLogCache(100, log)
mcast, ok = log.(MonotonicLogStore)
require.True(t, ok)
assert.True(t, mcast.IsMonotonic())
}
func TestRaft_CacheLogWithStoreError(t *testing.T) {
c := MakeCluster(2, t, nil)
defer c.Close()
// Should be one leader
follower := c.Followers()[0]
leader := c.Leader()
c.EnsureLeader(t, leader.localAddr)
// There is no lock to protect this assignment I am afraid.
es := &errorStore{LogStore: follower.logs}
cl, _ := NewLogCache(100, es)
follower.logs = cl
// Commit some logs
for i := 0; i < 5; i++ {
future := leader.Apply([]byte(fmt.Sprintf("test%d", i)), 0)
if err := future.Error(); err != nil {
t.Fatalf("[ERR] err: %v", err)
}
}
// Make the next fail
es.failNext(1)
leader.Apply([]byte("test6"), 0)
leader.Apply([]byte("test7"), 0)
future := leader.Apply([]byte("test8"), 0)
// Wait for the last future to apply
if err := future.Error(); err != nil {
t.Fatalf("[ERR] err: %v", err)
}
// Shutdown follower
if f := follower.Shutdown(); f.Error() != nil {
t.Fatalf("error shuting down follower: %v", f.Error())
}
// Try to restart the follower and make sure it does not fail with a LogNotFound error
_, trans := NewInmemTransport(follower.localAddr)
follower.logs = es.LogStore
conf := follower.config()
n, err := NewRaft(&conf, &MockFSM{}, follower.logs, follower.stable, follower.snapshots, trans)
if err != nil {
t.Fatalf("error restarting follower: %v", err)
}
n.Shutdown()
}
func TestRaft_ReloadConfig(t *testing.T) {
conf := inmemConfig(t)
conf.LeaderLeaseTimeout = 40 * time.Millisecond
c := MakeCluster(1, t, conf)
defer c.Close()
raft := c.rafts[0]
// Make sure the reloadable values are as expected before
require.Equal(t, uint64(10240), raft.config().TrailingLogs)
require.Equal(t, 120*time.Second, raft.config().SnapshotInterval)
require.Equal(t, uint64(8192), raft.config().SnapshotThreshold)
// Reload with different values
newCfg := ReloadableConfig{
TrailingLogs: 12345,
SnapshotInterval: 234 * time.Second,
SnapshotThreshold: 6789,
HeartbeatTimeout: 45 * time.Millisecond,
ElectionTimeout: 46 * time.Millisecond,
}
require.NoError(t, raft.ReloadConfig(newCfg))
// Now we should have new values
require.Equal(t, newCfg.TrailingLogs, raft.config().TrailingLogs)
require.Equal(t, newCfg.SnapshotInterval, raft.config().SnapshotInterval)
require.Equal(t, newCfg.SnapshotThreshold, raft.config().SnapshotThreshold)
require.Equal(t, newCfg.HeartbeatTimeout, raft.config().HeartbeatTimeout)
require.Equal(t, newCfg.ElectionTimeout, raft.config().ElectionTimeout)
}
func TestRaft_ReloadConfigValidates(t *testing.T) {
conf := inmemConfig(t)
c := MakeCluster(1, t, conf)
defer c.Close()
raft := c.rafts[0]
// Make sure the reloadable values are as expected before
require.Equal(t, uint64(10240), raft.config().TrailingLogs)
require.Equal(t, 120*time.Second, raft.config().SnapshotInterval)
require.Equal(t, uint64(8192), raft.config().SnapshotThreshold)
// Reload with different values that are invalid per ValidateConfig
newCfg := ReloadableConfig{
TrailingLogs: 12345,
SnapshotInterval: 1 * time.Millisecond, // must be >= 5 millisecond
SnapshotThreshold: 6789,
}
require.Error(t, raft.ReloadConfig(newCfg))
// Now we should have same values
require.Equal(t, uint64(10240), raft.config().TrailingLogs)
require.Equal(t, 120*time.Second, raft.config().SnapshotInterval)
require.Equal(t, uint64(8192), raft.config().SnapshotThreshold)
}
// TODO: These are test cases we'd like to write for appendEntries().
// Unfortunately, it's difficult to do so with the current way this file is
// tested.
//
// Term check:
// - m.term is too small: no-op.
// - m.term is too large: update term, become follower, process request.
// - m.term is right but we're candidate: become follower, process request.
//
// Previous entry check:
// - prev is within the snapshot, before the snapshot's index: assume match.
// - prev is within the snapshot, exactly the snapshot's index: check
// snapshot's term.
// - prev is a log entry: check entry's term.
// - prev is past the end of the log: return fail.
//
// New entries:
// - new entries are all new: add them all.
// - new entries are all duplicate: ignore them all without ever removing dups.
// - new entries some duplicate, some new: add the new ones without ever
// removing dups.
// - new entries all conflict: remove the conflicting ones, add their
// replacements.
// - new entries some duplicate, some conflict: remove the conflicting ones,
// add their replacement, without ever removing dups.
//
// Storage errors handled properly.
// Commit index updated properly.
func TestRaft_InstallSnapshot_InvalidPeers(t *testing.T) {
_, transport := NewInmemTransport("")
r := &Raft{
trans: transport,
logger: hclog.New(nil),
}
req := &InstallSnapshotRequest{
Peers: []byte("invalid msgpack"),
}
chResp := make(chan RPCResponse, 1)
rpc := RPC{
Reader: new(bytes.Buffer),
RespChan: chResp,
}
r.installSnapshot(rpc, req)
resp := <-chResp
require.Error(t, resp.Error)
require.Contains(t, resp.Error.Error(), "failed to decode peers")
}
func TestRaft_VoteNotGranted_WhenNodeNotInCluster(t *testing.T) {
// Make a cluster
c := MakeCluster(3, t, nil)
defer c.Close()
// Get the leader
leader := c.Leader()
// Wait until we have 2 followers
limit := time.Now().Add(c.longstopTimeout)
var followers []*Raft
for time.Now().Before(limit) && len(followers) != 2 {
c.WaitEvent(nil, c.conf.CommitTimeout)
followers = c.GetInState(Follower)
}
if len(followers) != 2 {
t.Fatalf("expected two followers: %v", followers)
}
// Remove a follower
followerRemoved := followers[0]
future := leader.RemoveServer(followerRemoved.localID, 0, 0)
if err := future.Error(); err != nil {
t.Fatalf("err: %v", err)
}
// Wait a while
time.Sleep(c.propagateTimeout)
// Other nodes should have fewer peers
if configuration := c.getConfiguration(leader); len(configuration.Servers) != 2 {
t.Fatalf("too many peers")
}
if configuration := c.getConfiguration(followers[1]); len(configuration.Servers) != 2 {
t.Fatalf("too many peers")
}
waitForState(followerRemoved, Follower)
// The removed node should be still in Follower state
require.Equal(t, Follower, followerRemoved.getState())
// Prepare a Vote request from the removed follower
follower := followers[1]
followerRemovedT := c.trans[c.IndexOf(followerRemoved)]
reqVote := RequestVoteRequest{
RPCHeader: followerRemoved.getRPCHeader(),
Term: followerRemoved.getCurrentTerm() + 10,
LastLogIndex: followerRemoved.LastIndex(),
LastLogTerm: followerRemoved.getCurrentTerm(),
LeadershipTransfer: false,
}
// a follower that thinks there's a leader should vote for that leader.
var resp RequestVoteResponse
// partiton the leader to simulate an unstable cluster
c.Partition([]ServerAddress{leader.localAddr})
time.Sleep(c.propagateTimeout)
// wait for the remaining follower to trigger an election
waitForState(follower, Candidate)
require.Equal(t, Candidate, follower.getState())
// send a vote request from the removed follower to the Candidate follower
if err := followerRemovedT.RequestVote(follower.localID, follower.localAddr, &reqVote, &resp); err != nil {
t.Fatalf("RequestVote RPC failed %v", err)
}
// the vote request should not be granted, because the voter is not part of the cluster anymore
if resp.Granted {
t.Fatalf("expected vote to not be granted, but it was %+v", resp)
}
}
func TestRaft_ClusterCanRegainStability_WhenNonVoterWithHigherTermJoin(t *testing.T) {
// Make a cluster
c := MakeCluster(3, t, nil)
defer c.Close()
// Get the leader
leader := c.Leader()
// Wait until we have 2 followers
limit := time.Now().Add(c.longstopTimeout)
var followers []*Raft
for time.Now().Before(limit) && len(followers) != 2 {
c.WaitEvent(nil, c.conf.CommitTimeout)
followers = c.GetInState(Follower)
}
if len(followers) != 2 {
t.Fatalf("expected two followers: %v", followers)
}
// Remove a follower
followerRemoved := followers[0]
c.Disconnect(followerRemoved.localAddr)
time.Sleep(c.propagateTimeout)
future := leader.RemoveServer(followerRemoved.localID, 0, 0)
if err := future.Error(); err != nil {
t.Fatalf("err: %v", err)
}
//set that follower term to higher term to faster simulate a partitioning
newTerm := leader.getCurrentTerm() + 20
followerRemoved.setCurrentTerm(newTerm)
//Add the node back as NonVoter
future = leader.AddNonvoter(followerRemoved.localID, followerRemoved.localAddr, 0, 0)
if err := future.Error(); err != nil {
t.Fatalf("err: %v", err)
}
c.FullyConnect()
// Wait a while
time.Sleep(c.propagateTimeout)
// Check the term is now a new term
leader = c.Leader()
currentTerm := leader.getCurrentTerm()
if newTerm > currentTerm {
t.Fatalf("term should have changed,%d < %d", newTerm, currentTerm)
}
// check nonVoter is not elected
if leader.localID == followerRemoved.localID {
t.Fatalf("Should not be leader %s", followerRemoved.localID)
}
//Write some logs to ensure they replicate
for i := 0; i < 100; i++ {
future := leader.Apply([]byte(fmt.Sprintf("test%d", i)), 0)
if err := future.Error(); err != nil {
t.Fatalf("[ERR] apply err: %v", err)
}
}
c.WaitForReplication(100)
//Remove the server and add it back as Voter
future = leader.RemoveServer(followerRemoved.localID, 0, 0)
if err := future.Error(); err != nil {
t.Fatalf("err: %v", err)
}
leader.AddVoter(followerRemoved.localID, followerRemoved.localAddr, 0, 0)
// Wait a while
time.Sleep(c.propagateTimeout * 10)
//Write some logs to ensure they replicate
for i := 100; i < 200; i++ {
future := leader.Apply([]byte(fmt.Sprintf("test%d", i)), 0)
if err := future.Error(); err != nil {
t.Fatalf("[ERR] apply err: %v", err)
}
}
c.WaitForReplication(200)
// Check leader stable
newLeader := c.Leader()
if newLeader.leaderID != leader.leaderID {
t.Fatalf("leader changed")
}
}
// TestRaft_FollowerRemovalNoElection ensures that a leader election is not
// started when a standby is shut down and restarted.
func TestRaft_FollowerRemovalNoElection(t *testing.T) {
// Make a cluster
inmemConf := inmemConfig(t)
inmemConf.HeartbeatTimeout = 100 * time.Millisecond
inmemConf.ElectionTimeout = 100 * time.Millisecond
c := MakeCluster(3, t, inmemConf)
defer c.Close()
err := waitForLeader(c)
require.NoError(t, err)
leader := c.Leader()
// Wait until we have 2 followers
limit := time.Now().Add(c.longstopTimeout)
var followers []*Raft
for time.Now().Before(limit) && len(followers) != 2 {
c.WaitEvent(nil, c.conf.CommitTimeout)
followers = c.GetInState(Follower)
}
if len(followers) != 2 {
t.Fatalf("expected two followers: %v", followers)
}
// Disconnect one of the followers and wait for the heartbeat timeout
i := 0
follower := c.rafts[i]
if follower == c.Leader() {
i = 1
follower = c.rafts[i]
}
logs := follower.logs
t.Logf("[INFO] restarting %v", follower)
// Shutdown follower
if f := follower.Shutdown(); f.Error() != nil {
t.Fatalf("error shuting down follower: %v", f.Error())
}
_, trans := NewInmemTransport(follower.localAddr)
conf := follower.config()
n, err := NewRaft(&conf, &MockFSM{}, logs, follower.stable, follower.snapshots, trans)
if err != nil {
t.Fatalf("error restarting follower: %v", err)
}
c.rafts[i] = n
c.trans[i] = n.trans.(*InmemTransport)
c.fsms[i] = n.fsm.(*MockFSM)
c.FullyConnect()
// There should be no re-election during this sleep
time.Sleep(250 * time.Millisecond)
// Let things settle and make sure we recovered.
c.EnsureLeader(t, leader.localAddr)
c.EnsureSame(t)
c.EnsureSamePeers(t)
n.Shutdown()
}
func TestRaft_VoteWithNoIDNoAddr(t *testing.T) {
// Make a cluster
c := MakeCluster(3, t, nil)
defer c.Close()
err := waitForLeader(c)
require.NoError(t, err)
leader := c.Leader()
// Wait until we have 2 followers
limit := time.Now().Add(c.longstopTimeout)
var followers []*Raft
for time.Now().Before(limit) && len(followers) != 2 {
c.WaitEvent(nil, c.conf.CommitTimeout)
followers = c.GetInState(Follower)
}
if len(followers) != 2 {
t.Fatalf("expected two followers: %v", followers)
}
follower := followers[0]
headers := follower.getRPCHeader()
headers.ID = nil
headers.Addr = nil
reqVote := RequestVoteRequest{
RPCHeader: headers,
Term: follower.getCurrentTerm() + 10,
LastLogIndex: follower.LastIndex(),
LastLogTerm: follower.getCurrentTerm(),
Candidate: follower.trans.EncodePeer(follower.config().LocalID, follower.localAddr),
LeadershipTransfer: false,
}
// a follower that thinks there's a leader should vote for that leader.
var resp RequestVoteResponse
followerT := c.trans[c.IndexOf(followers[1])]
c.Partition([]ServerAddress{leader.localAddr})
time.Sleep(c.propagateTimeout)
// wait for the remaining follower to trigger an election
waitForState(follower, Candidate)
require.Equal(t, Candidate, follower.getState())
// send a vote request from the removed follower to the Candidate follower
if err := followerT.RequestVote(follower.localID, follower.localAddr, &reqVote, &resp); err != nil {
t.Fatalf("RequestVote RPC failed %v", err)
}
// the vote request should not be granted, because the voter is not part of the cluster anymore
if !resp.Granted {
t.Fatalf("expected vote to not be granted, but it was %+v", resp)
}
}
func waitForState(follower *Raft, state RaftState) {
count := 0
for follower.getState() != state && count < 1000 {
count++
time.Sleep(1 * time.Millisecond)
}
}
func waitForLeader(c *cluster) error {
count := 0
for count < 100 {
r := c.GetInState(Leader)
if len(r) >= 1 {
return nil
}
count++
time.Sleep(50 * time.Millisecond)
}
return errors.New("no leader elected")
}
func TestRaft_runFollower_State_Transition(t *testing.T) {
type fields struct {
conf *Config
servers []Server
serverID ServerID
}
tests := []struct {
name string
fields fields
expectedState RaftState
}{
{"NonVoter", fields{conf: DefaultConfig(), servers: []Server{{Nonvoter, "first", ""}}, serverID: "first"}, Follower},
{"Voter", fields{conf: DefaultConfig(), servers: []Server{{Voter, "first", ""}}, serverID: "first"}, Candidate},
{"Not in Config", fields{conf: DefaultConfig(), servers: []Server{{Voter, "second", ""}}, serverID: "first"}, Follower},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
// set timeout to tests specific
tt.fields.conf.LocalID = tt.fields.serverID
tt.fields.conf.HeartbeatTimeout = 50 * time.Millisecond
tt.fields.conf.ElectionTimeout = 50 * time.Millisecond
tt.fields.conf.LeaderLeaseTimeout = 50 * time.Millisecond
tt.fields.conf.CommitTimeout = 5 * time.Millisecond
tt.fields.conf.SnapshotThreshold = 100
tt.fields.conf.TrailingLogs = 10
tt.fields.conf.skipStartup = true
// Create a raft instance and set the latest configuration
env1 := MakeRaft(t, tt.fields.conf, false)
env1.raft.setLatestConfiguration(Configuration{Servers: tt.fields.servers}, 1)
env1.raft.setState(Follower)
// run the follower loop exclusively
go env1.raft.runFollower()
// wait enough time to have HeartbeatTimeout
time.Sleep(tt.fields.conf.HeartbeatTimeout * 3)
// Check the follower loop set the right state
require.Equal(t, tt.expectedState, env1.raft.getState())
})
}
}
func TestRaft_runFollower_ReloadTimeoutConfigs(t *testing.T) {
conf := DefaultConfig()
conf.LocalID = ServerID("first")
conf.HeartbeatTimeout = 500 * time.Millisecond
conf.ElectionTimeout = 500 * time.Millisecond
conf.LeaderLeaseTimeout = 50 * time.Millisecond
conf.CommitTimeout = 5 * time.Millisecond
conf.SnapshotThreshold = 100
conf.TrailingLogs = 10
conf.skipStartup = true
env := MakeRaft(t, conf, false)
servers := []Server{{Voter, "first", ""}}
env.raft.setLatestConfiguration(Configuration{Servers: servers}, 1)
env.raft.setState(Follower)
// run the follower loop exclusively
go env.raft.runFollower()
newCfg := ReloadableConfig{
TrailingLogs: conf.TrailingLogs,
SnapshotInterval: conf.SnapshotInterval,
SnapshotThreshold: conf.SnapshotThreshold,
HeartbeatTimeout: 50 * time.Millisecond,
ElectionTimeout: 50 * time.Millisecond,
}
require.NoError(t, env.raft.ReloadConfig(newCfg))
// wait enough time to have HeartbeatTimeout
time.Sleep(3 * newCfg.HeartbeatTimeout)
// Check the follower loop set the right state
require.Equal(t, Candidate, env.raft.getState())
}
|