#
cargo_test_support/
registry.rs

    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

    //! Interact with the [`TestRegistry`]
    //!
    //! # Example
    //!
    //! ```no_run
    //! use cargo_test_support::registry::Package;
    //! use cargo_test_support::project;
    //! use cargo_test_support::str;
    //!
    //! // Publish package "a" depending on "b".
    //! Package::new("a", "1.0.0")
    //!     .dep("b", "1.0.0")
    //!     .file("src/lib.rs", r#"
    //!         extern crate b;
    //!         pub fn f() -> i32 { b::f() * 2 }
    //!     "#)
    //!     .publish();
    //!
    //! // Publish package "b".
    //! Package::new("b", "1.0.0")
    //!     .file("src/lib.rs", r#"
    //!         pub fn f() -> i32 { 12 }
    //!     "#)
    //!     .publish();
    //!
    //! // Create a project that uses package "a".
    //! let p = project()
    //!     .file("Cargo.toml", r#"
    //!         [package]
    //!         name = "foo"
    //!         version = "0.0.1"
    //!
    //!         [dependencies]
    //!         a = "1.0"
    //!     "#)
    //!     .file("src/main.rs", r#"
    //!         extern crate a;
    //!         fn main() { println!("{}", a::f()); }
    //!     "#)
    //!     .build();
    //!
    //! p.cargo("run").with_stdout_data(str!["24"]).run();
    //! ```

    use crate::git::repo;
    use crate::paths;
    use crate::publish::{create_index_line, write_to_index};
    use cargo_util::paths::append;
    use cargo_util::Sha256;
    use flate2::write::GzEncoder;
    use flate2::Compression;
    use pasetors::keys::{AsymmetricPublicKey, AsymmetricSecretKey};
    use pasetors::paserk::FormatAsPaserk;
    use pasetors::token::UntrustedToken;
    use std::collections::{BTreeMap, HashMap};
    use std::fmt;
    use std::fs::{self, File};
    use std::io::{BufRead, BufReader, Read, Write};
    use std::net::{SocketAddr, TcpListener, TcpStream};
    use std::path::{Path, PathBuf};
    use std::thread::{self, JoinHandle};
    use tar::{Builder, Header};
    use time::format_description::well_known::Rfc3339;
    use time::{Duration, OffsetDateTime};
    use url::Url;

    /// Path to the local index for psuedo-crates.io.
    ///
    /// This is a Git repo
    /// initialized with a `config.json` file pointing to `dl_path` for downloads
    /// and `api_path` for uploads.
    ///
    /// ex: `$CARGO_TARGET_TMPDIR/cit/t0/registry`
    pub fn registry_path() -> PathBuf {
        generate_path("registry")
    }

    /// Path to the local web API uploads
    ///
    /// Cargo will place the contents of a web API
    /// request here. For example, `api/v1/crates/new` is the result of publishing a crate.
    ///
    /// ex: `$CARGO_TARGET_TMPDIR/cit/t0/api`
    pub fn api_path() -> PathBuf {
        generate_path("api")
    }

    /// Path to download `.crate` files using the web API endpoint.
    ///
    /// Crates
    /// should be organized as `{name}/{version}/download` to match the web API
    /// endpoint. This is rarely used and must be manually set up.
    ///
    /// ex: `$CARGO_TARGET_TMPDIR/cit/t0/dl`
    pub fn dl_path() -> PathBuf {
        generate_path("dl")
    }

    /// Path to the alternative-registry version of [`registry_path`]
    ///
    /// ex: `$CARGO_TARGET_TMPDIR/cit/t0/alternative-registry`
    pub fn alt_registry_path() -> PathBuf {
        generate_path("alternative-registry")
    }

    /// URL to the alternative-registry version of `registry_url`
    fn alt_registry_url() -> Url {
        generate_url("alternative-registry")
    }

    /// Path to the alternative-registry version of [`dl_path`]
    ///
    /// ex: `$CARGO_TARGET_TMPDIR/cit/t0/alternative-dl`
    pub fn alt_dl_path() -> PathBuf {
        generate_path("alternative-dl")
    }

    /// Path to the alternative-registry version of [`api_path`]
    ///
    /// ex: `$CARGO_TARGET_TMPDIR/cit/t0/alternative-api`
    pub fn alt_api_path() -> PathBuf {
        generate_path("alternative-api")
    }

    fn generate_path(name: &str) -> PathBuf {
        paths::root().join(name)
    }
    fn generate_url(name: &str) -> Url {
        Url::from_file_path(generate_path(name)).ok().unwrap()
    }

    /// Auth-token for publishing, see [`RegistryBuilder::token`]
    #[derive(Clone)]
    pub enum Token {
        Plaintext(String),
        Keys(String, Option<String>),
    }

    impl Token {
        /// This is a valid PASETO secret key.
        ///
        /// This one is already publicly available as part of the text of the RFC so is safe to use for tests.
        pub fn rfc_key() -> Token {
            Token::Keys(
                "k3.secret.fNYVuMvBgOlljt9TDohnaYLblghqaHoQquVZwgR6X12cBFHZLFsaU3q7X3k1Zn36"
                    .to_string(),
                Some("sub".to_string()),
            )
        }
    }

    type RequestCallback = Box<dyn Send + Fn(&Request, &HttpServer) -> Response>;

    /// Prepare a local [`TestRegistry`] fixture
    ///
    /// See also [`init`] and [`alt_init`]
    pub struct RegistryBuilder {
        /// If set, configures an alternate registry with the given name.
        alternative: Option<String>,
        /// The authorization token for the registry.
        token: Option<Token>,
        /// If set, the registry requires authorization for all operations.
        auth_required: bool,
        /// If set, serves the index over http.
        http_index: bool,
        /// If set, serves the API over http.
        http_api: bool,
        /// If set, config.json includes 'api'
        api: bool,
        /// Write the token in the configuration.
        configure_token: bool,
        /// Write the registry in configuration.
        configure_registry: bool,
        /// API responders.
        custom_responders: HashMap<String, RequestCallback>,
        /// Handler for 404 responses.
        not_found_handler: RequestCallback,
        /// If nonzero, the git index update to be delayed by the given number of seconds.
        delayed_index_update: usize,
        /// Credential provider in configuration
        credential_provider: Option<String>,
    }

    /// A local registry fixture
    ///
    /// Most tests won't need to call this directly but instead interact with [`Package`]
    pub struct TestRegistry {
        server: Option<HttpServerHandle>,
        index_url: Url,
        path: PathBuf,
        api_url: Url,
        dl_url: Url,
        token: Token,
    }

    impl TestRegistry {
        pub fn index_url(&self) -> &Url {
            &self.index_url
        }

        pub fn api_url(&self) -> &Url {
            &self.api_url
        }

        pub fn token(&self) -> &str {
            match &self.token {
                Token::Plaintext(s) => s,
                Token::Keys(_, _) => panic!("registry was not configured with a plaintext token"),
            }
        }

        pub fn key(&self) -> &str {
            match &self.token {
                Token::Plaintext(_) => panic!("registry was not configured with a secret key"),
                Token::Keys(s, _) => s,
            }
        }

        /// Shutdown the server thread and wait for it to stop.
        /// `Drop` automatically stops the server, but this additionally
        /// waits for the thread to stop.
        pub fn join(self) {
            if let Some(mut server) = self.server {
                server.stop();
                let handle = server.handle.take().unwrap();
                handle.join().unwrap();
            }
        }
    }

    impl RegistryBuilder {
        #[must_use]
        pub fn new() -> RegistryBuilder {
            let not_found = |_req: &Request, _server: &HttpServer| -> Response {
                Response {
                    code: 404,
                    headers: vec![],
                    body: b"not found".to_vec(),
                }
            };
            RegistryBuilder {
                alternative: None,
                token: None,
                auth_required: false,
                http_api: false,
                http_index: false,
                api: true,
                configure_registry: true,
                configure_token: true,
                custom_responders: HashMap::new(),
                not_found_handler: Box::new(not_found),
                delayed_index_update: 0,
                credential_provider: None,
            }
        }

        /// Adds a custom HTTP response for a specific url
        #[must_use]
        pub fn add_responder<R: 'static + Send + Fn(&Request, &HttpServer) -> Response>(
            mut self,
            url: impl Into<String>,
            responder: R,
        ) -> Self {
            self.custom_responders
                .insert(url.into(), Box::new(responder));
            self
        }

        #[must_use]
        pub fn not_found_handler<R: 'static + Send + Fn(&Request, &HttpServer) -> Response>(
            mut self,
            responder: R,
        ) -> Self {
            self.not_found_handler = Box::new(responder);
            self
        }

        /// Configures the git index update to be delayed by the given number of seconds.
        #[must_use]
        pub fn delayed_index_update(mut self, delay: usize) -> Self {
            self.delayed_index_update = delay;
            self
        }

        /// Sets whether or not to initialize as an alternative registry.
        #[must_use]
        pub fn alternative_named(mut self, alt: &str) -> Self {
            self.alternative = Some(alt.to_string());
            self
        }

        /// Sets whether or not to initialize as an alternative registry.
        #[must_use]
        pub fn alternative(self) -> Self {
            self.alternative_named("alternative")
        }

        /// Prevents placing a token in the configuration
        #[must_use]
        pub fn no_configure_token(mut self) -> Self {
            self.configure_token = false;
            self
        }

        /// Prevents adding the registry to the configuration.
        #[must_use]
        pub fn no_configure_registry(mut self) -> Self {
            self.configure_registry = false;
            self
        }

        /// Sets the token value
        #[must_use]
        pub fn token(mut self, token: Token) -> Self {
            self.token = Some(token);
            self
        }

        /// Sets this registry to require the authentication token for
        /// all operations.
        #[must_use]
        pub fn auth_required(mut self) -> Self {
            self.auth_required = true;
            self
        }

        /// Operate the index over http
        #[must_use]
        pub fn http_index(mut self) -> Self {
            self.http_index = true;
            self
        }

        /// Operate the api over http
        #[must_use]
        pub fn http_api(mut self) -> Self {
            self.http_api = true;
            self
        }

        /// The registry has no api.
        #[must_use]
        pub fn no_api(mut self) -> Self {
            self.api = false;
            self
        }

        /// The credential provider to configure for this registry.
        #[must_use]
        pub fn credential_provider(mut self, provider: &[&str]) -> Self {
            self.credential_provider = Some(format!("['{}']", provider.join("','")));
            self
        }

        /// Initializes the registry.
        #[must_use]
        pub fn build(self) -> TestRegistry {
            let config_path = paths::cargo_home().join("config.toml");
            t!(fs::create_dir_all(config_path.parent().unwrap()));
            let prefix = if let Some(alternative) = &self.alternative {
                format!("{alternative}-")
            } else {
                String::new()
            };
            let registry_path = generate_path(&format!("{prefix}registry"));
            let index_url = generate_url(&format!("{prefix}registry"));
            let api_url = generate_url(&format!("{prefix}api"));
            let dl_url = generate_url(&format!("{prefix}dl"));
            let dl_path = generate_path(&format!("{prefix}dl"));
            let api_path = generate_path(&format!("{prefix}api"));
            let token = self
                .token
                .unwrap_or_else(|| Token::Plaintext(format!("{prefix}sekrit")));

            let (server, index_url, api_url, dl_url) = if !self.http_index && !self.http_api {
                // No need to start the HTTP server.
                (None, index_url, api_url, dl_url)
            } else {
                let server = HttpServer::new(
                    registry_path.clone(),
                    dl_path,
                    api_path.clone(),
                    token.clone(),
                    self.auth_required,
                    self.custom_responders,
                    self.not_found_handler,
                    self.delayed_index_update,
                );
                let index_url = if self.http_index {
                    server.index_url()
                } else {
                    index_url
                };
                let api_url = if self.http_api {
                    server.api_url()
                } else {
                    api_url
                };
                let dl_url = server.dl_url();
                (Some(server), index_url, api_url, dl_url)
            };

            let registry = TestRegistry {
                api_url,
                index_url,
                server,
                dl_url,
                path: registry_path,
                token,
            };

            if self.configure_registry {
                if let Some(alternative) = &self.alternative {
                    append(
                        &config_path,
                        format!(
                            "
                            [registries.{alternative}]
                            index = '{}'",
                            registry.index_url
                        )
                        .as_bytes(),
                    )
                    .unwrap();
                    if let Some(p) = &self.credential_provider {
                        append(
                            &config_path,
                            &format!(
                                "
                            credential-provider = {p}
                            "
                            )
                            .as_bytes(),
                        )
                        .unwrap()
                    }
                } else {
                    append(
                        &config_path,
                        format!(
                            "
                            [source.crates-io]
                            replace-with = 'dummy-registry'

                            [registries.dummy-registry]
                            index = '{}'",
                            registry.index_url
                        )
                        .as_bytes(),
                    )
                    .unwrap();

                    if let Some(p) = &self.credential_provider {
                        append(
                            &config_path,
                            &format!(
                                "
                            [registry]
                            credential-provider = {p}
                            "
                            )
                            .as_bytes(),
                        )
                        .unwrap()
                    }
                }
            }

            if self.configure_token {
                let credentials = paths::cargo_home().join("credentials.toml");
                match &registry.token {
                    Token::Plaintext(token) => {
                        if let Some(alternative) = &self.alternative {
                            append(
                                &credentials,
                                format!(
                                    r#"
                                        [registries.{alternative}]
                                        token = "{token}"
                                    "#
                                )
                                .as_bytes(),
                            )
                            .unwrap();
                        } else {
                            append(
                                &credentials,
                                format!(
                                    r#"
                                        [registry]
                                        token = "{token}"
                                    "#
                                )
                                .as_bytes(),
                            )
                            .unwrap();
                        }
                    }
                    Token::Keys(key, subject) => {
                        let mut out = if let Some(alternative) = &self.alternative {
                            format!("\n[registries.{alternative}]\n")
                        } else {
                            format!("\n[registry]\n")
                        };
                        out += &format!("secret-key = \"{key}\"\n");
                        if let Some(subject) = subject {
                            out += &format!("secret-key-subject = \"{subject}\"\n");
                        }

                        append(&credentials, out.as_bytes()).unwrap();
                    }
                }
            }

            let auth = if self.auth_required {
                r#","auth-required":true"#
            } else {
                ""
            };
            let api = if self.api {
                format!(r#","api":"{}""#, registry.api_url)
            } else {
                String::new()
            };
            // Initialize a new registry.
            repo(&registry.path)
                .file(
                    "config.json",
                    &format!(r#"{{"dl":"{}"{api}{auth}}}"#, registry.dl_url),
                )
                .build();
            fs::create_dir_all(api_path.join("api/v1/crates")).unwrap();

            registry
        }
    }

    /// Published package builder for [`TestRegistry`]
    ///
    /// This uses "source replacement" using an automatically generated
    /// `.cargo/config` file to ensure that dependencies will use these packages
    /// instead of contacting crates.io. See `source-replacement.md` for more
    /// details on how source replacement works.
    ///
    /// Call [`Package::publish`] to finalize and create the package.
    ///
    /// If no files are specified, an empty `lib.rs` file is automatically created.
    ///
    /// The `Cargo.toml` file is automatically generated based on the methods
    /// called on `Package` (for example, calling [`Package::dep()`] will add to the
    /// `[dependencies]` automatically). You may also specify a `Cargo.toml` file
    /// to override the generated one.
    ///
    /// This supports different registry types:
    /// - Regular source replacement that replaces `crates.io` (the default).
    /// - A "local registry" which is a subset for vendoring (see
    ///   [`Package::local`]).
    /// - An "alternative registry" which requires specifying the registry name
    ///   (see [`Package::alternative`]).
    ///
    /// This does not support "directory sources". See `directory.rs` for
    /// `VendorPackage` which implements directory sources.
    #[must_use]
    pub struct Package {
        name: String,
        vers: String,
        deps: Vec<Dependency>,
        files: Vec<PackageFile>,
        yanked: bool,
        features: FeatureMap,
        local: bool,
        alternative: bool,
        invalid_index_line: bool,
        index_line: Option<String>,
        edition: Option<String>,
        resolver: Option<String>,
        proc_macro: bool,
        links: Option<String>,
        rust_version: Option<String>,
        cargo_features: Vec<String>,
        v: Option<u32>,
    }

    pub(crate) type FeatureMap = BTreeMap<String, Vec<String>>;

    /// Published package dependency builder, see [`Package::add_dep`]
    #[derive(Clone)]
    pub struct Dependency {
        name: String,
        vers: String,
        kind: String,
        artifact: Option<String>,
        bindep_target: Option<String>,
        lib: bool,
        target: Option<String>,
        features: Vec<String>,
        registry: Option<String>,
        package: Option<String>,
        optional: bool,
        default_features: bool,
        public: bool,
    }

    /// Entry with data that corresponds to [`tar::EntryType`].
    #[non_exhaustive]
    enum EntryData {
        Regular(String),
        Symlink(PathBuf),
    }

    /// A file to be created in a package.
    struct PackageFile {
        path: String,
        contents: EntryData,
        /// The Unix mode for the file. Note that when extracted on Windows, this
        /// is mostly ignored since it doesn't have the same style of permissions.
        mode: u32,
        /// If `true`, the file is created in the root of the tarfile, used for
        /// testing invalid packages.
        extra: bool,
    }

    const DEFAULT_MODE: u32 = 0o644;

    /// Setup a local psuedo-crates.io [`TestRegistry`]
    ///
    /// This is implicitly called by [`Package::new`].
    ///
    /// When calling `cargo publish`, see instead [`crate::publish`].
    pub fn init() -> TestRegistry {
        RegistryBuilder::new().build()
    }

    /// Setup a local "alternative" [`TestRegistry`]
    ///
    /// When calling `cargo publish`, see instead [`crate::publish`].
    pub fn alt_init() -> TestRegistry {
        init();
        RegistryBuilder::new().alternative().build()
    }

    pub struct HttpServerHandle {
        addr: SocketAddr,
        handle: Option<JoinHandle<()>>,
    }

    impl HttpServerHandle {
        pub fn index_url(&self) -> Url {
            Url::parse(&format!("sparse+http://{}/index/", self.addr.to_string())).unwrap()
        }

        pub fn api_url(&self) -> Url {
            Url::parse(&format!("http://{}/", self.addr.to_string())).unwrap()
        }

        pub fn dl_url(&self) -> Url {
            Url::parse(&format!("http://{}/dl", self.addr.to_string())).unwrap()
        }

        fn stop(&self) {
            if let Ok(mut stream) = TcpStream::connect(self.addr) {
                // shutdown the server
                let _ = stream.write_all(b"stop");
                let _ = stream.flush();
            }
        }
    }

    impl Drop for HttpServerHandle {
        fn drop(&mut self) {
            self.stop();
        }
    }

    /// Request to the test http server
    #[derive(Clone)]
    pub struct Request {
        pub url: Url,
        pub method: String,
        pub body: Option<Vec<u8>>,
        pub authorization: Option<String>,
        pub if_modified_since: Option<String>,
        pub if_none_match: Option<String>,
    }

    impl fmt::Debug for Request {
        fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
            // body is not included as it can produce long debug outputs
            f.debug_struct("Request")
                .field("url", &self.url)
                .field("method", &self.method)
                .field("authorization", &self.authorization)
                .field("if_modified_since", &self.if_modified_since)
                .field("if_none_match", &self.if_none_match)
                .finish()
        }
    }

    /// Response from the test http server
    pub struct Response {
        pub code: u32,
        pub headers: Vec<String>,
        pub body: Vec<u8>,
    }

    pub struct HttpServer {
        listener: TcpListener,
        registry_path: PathBuf,
        dl_path: PathBuf,
        api_path: PathBuf,
        addr: SocketAddr,
        token: Token,
        auth_required: bool,
        custom_responders: HashMap<String, RequestCallback>,
        not_found_handler: RequestCallback,
        delayed_index_update: usize,
    }

    /// A helper struct that collects the arguments for [`HttpServer::check_authorized`].
    /// Based on looking at the request, these are the fields that the authentication header should attest to.
    struct Mutation<'a> {
        mutation: &'a str,
        name: Option<&'a str>,
        vers: Option<&'a str>,
        cksum: Option<&'a str>,
    }

    impl HttpServer {
        pub fn new(
            registry_path: PathBuf,
            dl_path: PathBuf,
            api_path: PathBuf,
            token: Token,
            auth_required: bool,
            custom_responders: HashMap<String, RequestCallback>,
            not_found_handler: RequestCallback,
            delayed_index_update: usize,
        ) -> HttpServerHandle {
            let listener = TcpListener::bind("127.0.0.1:0").unwrap();
            let addr = listener.local_addr().unwrap();
            let server = HttpServer {
                listener,
                registry_path,
                dl_path,
                api_path,
                addr,
                token,
                auth_required,
                custom_responders,
                not_found_handler,
                delayed_index_update,
            };
            let handle = Some(thread::spawn(move || server.start()));
            HttpServerHandle { addr, handle }
        }

        fn start(&self) {
            let mut line = String::new();
            'server: loop {
                let (socket, _) = self.listener.accept().unwrap();
                let mut buf = BufReader::new(socket);
                line.clear();
                if buf.read_line(&mut line).unwrap() == 0 {
                    // Connection terminated.
                    continue;
                }
                // Read the "GET path HTTP/1.1" line.
                let mut parts = line.split_ascii_whitespace();
                let method = parts.next().unwrap().to_ascii_lowercase();
                if method == "stop" {
                    // Shutdown the server.
                    return;
                }
                let addr = self.listener.local_addr().unwrap();
                let url = format!(
                    "http://{}/{}",
                    addr,
                    parts.next().unwrap().trim_start_matches('/')
                );
                let url = Url::parse(&url).unwrap();

                // Grab headers we care about.
                let mut if_modified_since = None;
                let mut if_none_match = None;
                let mut authorization = None;
                let mut content_len = None;
                loop {
                    line.clear();
                    if buf.read_line(&mut line).unwrap() == 0 {
                        continue 'server;
                    }
                    if line == "\r\n" {
                        // End of headers.
                        line.clear();
                        break;
                    }
                    let (name, value) = line.split_once(':').unwrap();
                    let name = name.trim().to_ascii_lowercase();
                    let value = value.trim().to_string();
                    match name.as_str() {
                        "if-modified-since" => if_modified_since = Some(value),
                        "if-none-match" => if_none_match = Some(value),
                        "authorization" => authorization = Some(value),
                        "content-length" => content_len = Some(value),
                        _ => {}
                    }
                }

                let mut body = None;
                if let Some(con_len) = content_len {
                    let len = con_len.parse::<u64>().unwrap();
                    let mut content = vec![0u8; len as usize];
                    buf.read_exact(&mut content).unwrap();
                    body = Some(content)
                }

                let req = Request {
                    authorization,
                    if_modified_since,
                    if_none_match,
                    method,
                    url,
                    body,
                };
                println!("req: {:#?}", req);
                let response = self.route(&req);
                let buf = buf.get_mut();
                write!(buf, "HTTP/1.1 {}\r\n", response.code).unwrap();
                write!(buf, "Content-Length: {}\r\n", response.body.len()).unwrap();
                write!(buf, "Connection: close\r\n").unwrap();
                for header in response.headers {
                    write!(buf, "{}\r\n", header).unwrap();
                }
                write!(buf, "\r\n").unwrap();
                buf.write_all(&response.body).unwrap();
                buf.flush().unwrap();
            }
        }

        fn check_authorized(&self, req: &Request, mutation: Option<Mutation<'_>>) -> bool {
            let (private_key, private_key_subject) = if mutation.is_some() || self.auth_required {
                match &self.token {
                    Token::Plaintext(token) => return Some(token) == req.authorization.as_ref(),
                    Token::Keys(private_key, private_key_subject) => {
                        (private_key.as_str(), private_key_subject)
                    }
                }
            } else {
                assert!(req.authorization.is_none(), "unexpected token");
                return true;
            };

            macro_rules! t {
                ($e:expr) => {
                    match $e {
                        Some(e) => e,
                        None => return false,
                    }
                };
            }

            let secret: AsymmetricSecretKey<pasetors::version3::V3> = private_key.try_into().unwrap();
            let public: AsymmetricPublicKey<pasetors::version3::V3> = (&secret).try_into().unwrap();
            let pub_key_id: pasetors::paserk::Id = (&public).into();
            let mut paserk_pub_key_id = String::new();
            FormatAsPaserk::fmt(&pub_key_id, &mut paserk_pub_key_id).unwrap();
            // https://github.com/rust-lang/rfcs/blob/master/text/3231-cargo-asymmetric-tokens.md#how-the-registry-server-will-validate-an-asymmetric-token

            // - The PASETO is in v3.public format.
            let authorization = t!(&req.authorization);
            let untrusted_token = t!(
                UntrustedToken::<pasetors::Public, pasetors::version3::V3>::try_from(authorization)
                    .ok()
            );

            // - The PASETO validates using the public key it looked up based on the key ID.
            #[derive(serde::Deserialize, Debug)]
            struct Footer<'a> {
                url: &'a str,
                kip: &'a str,
            }
            let footer: Footer<'_> =
                t!(serde_json::from_slice(untrusted_token.untrusted_footer()).ok());
            if footer.kip != paserk_pub_key_id {
                return false;
            }
            let trusted_token =
                t!(
                    pasetors::version3::PublicToken::verify(&public, &untrusted_token, None, None,)
                        .ok()
                );

            // - The URL matches the registry base URL
            if footer.url != "https://github.com/rust-lang/crates.io-index"
                && footer.url != &format!("sparse+http://{}/index/", self.addr.to_string())
            {
                return false;
            }

            // - The PASETO is still within its valid time period.
            #[derive(serde::Deserialize)]
            struct Message<'a> {
                iat: &'a str,
                sub: Option<&'a str>,
                mutation: Option<&'a str>,
                name: Option<&'a str>,
                vers: Option<&'a str>,
                cksum: Option<&'a str>,
                _challenge: Option<&'a str>, // todo: PASETO with challenges
                v: Option<u8>,
            }
            let message: Message<'_> = t!(serde_json::from_str(trusted_token.payload()).ok());
            let token_time = t!(OffsetDateTime::parse(message.iat, &Rfc3339).ok());
            let now = OffsetDateTime::now_utc();
            if (now - token_time) > Duration::MINUTE {
                return false;
            }
            if private_key_subject.as_deref() != message.sub {
                return false;
            }
            // - If the claim v is set, that it has the value of 1.
            if let Some(v) = message.v {
                if v != 1 {
                    return false;
                }
            }
            // - If the server issues challenges, that the challenge has not yet been answered.
            // todo: PASETO with challenges
            // - If the operation is a mutation:
            if let Some(mutation) = mutation {
                //  - That the operation matches the mutation field and is one of publish, yank, or unyank.
                if message.mutation != Some(mutation.mutation) {
                    return false;
                }
                //  - That the package, and version match the request.
                if message.name != mutation.name {
                    return false;
                }
                if message.vers != mutation.vers {
                    return false;
                }
                //  - If the mutation is publish, that the version has not already been published, and that the hash matches the request.
                if mutation.mutation == "publish" {
                    if message.cksum != mutation.cksum {
                        return false;
                    }
                }
            } else {
                // - If the operation is a read, that the mutation field is not set.
                if message.mutation.is_some()
                    || message.name.is_some()
                    || message.vers.is_some()
                    || message.cksum.is_some()
                {
                    return false;
                }
            }
            true
        }

        /// Route the request
        fn route(&self, req: &Request) -> Response {
            // Check for custom responder
            if let Some(responder) = self.custom_responders.get(req.url.path()) {
                return responder(&req, self);
            }
            let path: Vec<_> = req.url.path()[1..].split('/').collect();
            match (req.method.as_str(), path.as_slice()) {
                ("get", ["index", ..]) => {
                    if !self.check_authorized(req, None) {
                        self.unauthorized(req)
                    } else {
                        self.index(&req)
                    }
                }
                ("get", ["dl", ..]) => {
                    if !self.check_authorized(req, None) {
                        self.unauthorized(req)
                    } else {
                        self.dl(&req)
                    }
                }
                // publish
                ("put", ["api", "v1", "crates", "new"]) => self.check_authorized_publish(req),
                // The remainder of the operators in the test framework do nothing other than responding 'ok'.
                //
                // Note: We don't need to support anything real here because there are no tests that
                // currently require anything other than publishing via the http api.

                // yank / unyank
                ("delete" | "put", ["api", "v1", "crates", crate_name, version, mutation]) => {
                    if !self.check_authorized(
                        req,
                        Some(Mutation {
                            mutation,
                            name: Some(crate_name),
                            vers: Some(version),
                            cksum: None,
                        }),
                    ) {
                        self.unauthorized(req)
                    } else {
                        self.ok(&req)
                    }
                }
                // owners
                ("get" | "put" | "delete", ["api", "v1", "crates", crate_name, "owners"]) => {
                    if !self.check_authorized(
                        req,
                        Some(Mutation {
                            mutation: "owners",
                            name: Some(crate_name),
                            vers: None,
                            cksum: None,
                        }),
                    ) {
                        self.unauthorized(req)
                    } else {
                        self.ok(&req)
                    }
                }
                _ => self.not_found(&req),
            }
        }

        /// Unauthorized response
        pub fn unauthorized(&self, _req: &Request) -> Response {
            Response {
                code: 401,
                headers: vec![
                    r#"WWW-Authenticate: Cargo login_url="https://test-registry-login/me""#.to_string(),
                ],
                body: b"Unauthorized message from server.".to_vec(),
            }
        }

        /// Not found response
        pub fn not_found(&self, req: &Request) -> Response {
            (self.not_found_handler)(req, self)
        }

        /// Respond OK without doing anything
        pub fn ok(&self, _req: &Request) -> Response {
            Response {
                code: 200,
                headers: vec![],
                body: br#"{"ok": true, "msg": "completed!"}"#.to_vec(),
            }
        }

        /// Return an internal server error (HTTP 500)
        pub fn internal_server_error(&self, _req: &Request) -> Response {
            Response {
                code: 500,
                headers: vec![],
                body: br#"internal server error"#.to_vec(),
            }
        }

        /// Serve the download endpoint
        pub fn dl(&self, req: &Request) -> Response {
            let file = self
                .dl_path
                .join(req.url.path().strip_prefix("/dl/").unwrap());
            println!("{}", file.display());
            if !file.exists() {
                return self.not_found(req);
            }
            return Response {
                body: fs::read(&file).unwrap(),
                code: 200,
                headers: vec![],
            };
        }

        /// Serve the registry index
        pub fn index(&self, req: &Request) -> Response {
            let file = self
                .registry_path
                .join(req.url.path().strip_prefix("/index/").unwrap());
            if !file.exists() {
                return self.not_found(req);
            } else {
                // Now grab info about the file.
                let data = fs::read(&file).unwrap();
                let etag = Sha256::new().update(&data).finish_hex();
                let last_modified = format!("{:?}", file.metadata().unwrap().modified().unwrap());

                // Start to construct our response:
                let mut any_match = false;
                let mut all_match = true;
                if let Some(expected) = &req.if_none_match {
                    if &etag != expected {
                        all_match = false;
                    } else {
                        any_match = true;
                    }
                }
                if let Some(expected) = &req.if_modified_since {
                    // NOTE: Equality comparison is good enough for tests.
                    if &last_modified != expected {
                        all_match = false;
                    } else {
                        any_match = true;
                    }
                }

                if any_match && all_match {
                    return Response {
                        body: Vec::new(),
                        code: 304,
                        headers: vec![],
                    };
                } else {
                    return Response {
                        body: data,
                        code: 200,
                        headers: vec![
                            format!("ETag: \"{}\"", etag),
                            format!("Last-Modified: {}", last_modified),
                        ],
                    };
                }
            }
        }

        pub fn check_authorized_publish(&self, req: &Request) -> Response {
            if let Some(body) = &req.body {
                // Mimic the publish behavior for local registries by writing out the request
                // so tests can verify publishes made to either registry type.
                let path = self.api_path.join("api/v1/crates/new");
                t!(fs::create_dir_all(path.parent().unwrap()));
                t!(fs::write(&path, body));

                // Get the metadata of the package
                let (len, remaining) = body.split_at(4);
                let json_len = u32::from_le_bytes(len.try_into().unwrap());
                let (json, remaining) = remaining.split_at(json_len as usize);
                let new_crate = serde_json::from_slice::<crates_io::NewCrate>(json).unwrap();
                // Get the `.crate` file
                let (len, remaining) = remaining.split_at(4);
                let file_len = u32::from_le_bytes(len.try_into().unwrap());
                let (file, _remaining) = remaining.split_at(file_len as usize);
                let file_cksum = cksum(&file);

                if !self.check_authorized(
                    req,
                    Some(Mutation {
                        mutation: "publish",
                        name: Some(&new_crate.name),
                        vers: Some(&new_crate.vers),
                        cksum: Some(&file_cksum),
                    }),
                ) {
                    return self.unauthorized(req);
                }

                let dst = self
                    .dl_path
                    .join(&new_crate.name)
                    .join(&new_crate.vers)
                    .join("download");

                if self.delayed_index_update == 0 {
                    save_new_crate(dst, new_crate, file, file_cksum, &self.registry_path);
                } else {
                    let delayed_index_update = self.delayed_index_update;
                    let registry_path = self.registry_path.clone();
                    let file = Vec::from(file);
                    thread::spawn(move || {
                        thread::sleep(std::time::Duration::new(delayed_index_update as u64, 0));
                        save_new_crate(dst, new_crate, &file, file_cksum, &registry_path);
                    });
                }

                self.ok(&req)
            } else {
                Response {
                    code: 400,
                    headers: vec![],
                    body: b"The request was missing a body".to_vec(),
                }
            }
        }
    }

    fn save_new_crate(
        dst: PathBuf,
        new_crate: crates_io::NewCrate,
        file: &[u8],
        file_cksum: String,
        registry_path: &Path,
    ) {
        // Write the `.crate`
        t!(fs::create_dir_all(dst.parent().unwrap()));
        t!(fs::write(&dst, file));

        let deps = new_crate
            .deps
            .iter()
            .map(|dep| {
                let (name, package) = match &dep.explicit_name_in_toml {
                    Some(explicit) => (explicit.to_string(), Some(dep.name.to_string())),
                    None => (dep.name.to_string(), None),
                };
                serde_json::json!({
                    "name": name,
                    "req": dep.version_req,
                    "features": dep.features,
                    "default_features": dep.default_features,
                    "target": dep.target,
                    "optional": dep.optional,
                    "kind": dep.kind,
                    "registry": dep.registry,
                    "package": package,
                    "artifact": dep.artifact,
                    "bindep_target": dep.bindep_target,
                    "lib": dep.lib,
                })
            })
            .collect::<Vec<_>>();

        let line = create_index_line(
            serde_json::json!(new_crate.name),
            &new_crate.vers,
            deps,
            &file_cksum,
            new_crate.features,
            false,
            new_crate.links,
            new_crate.rust_version.as_deref(),
            None,
        );

        write_to_index(registry_path, &new_crate.name, line, false);
    }

    impl Package {
        /// Creates a new package builder.
        /// Call `publish()` to finalize and build the package.
        pub fn new(name: &str, vers: &str) -> Package {
            let config = paths::cargo_home().join("config.toml");
            if !config.exists() {
                init();
            }
            Package {
                name: name.to_string(),
                vers: vers.to_string(),
                deps: Vec::new(),
                files: Vec::new(),
                yanked: false,
                features: BTreeMap::new(),
                local: false,
                alternative: false,
                invalid_index_line: false,
                index_line: None,
                edition: None,
                resolver: None,
                proc_macro: false,
                links: None,
                rust_version: None,
                cargo_features: Vec::new(),
                v: None,
            }
        }

        /// Call with `true` to publish in a "local registry".
        ///
        /// See `source-replacement.html#local-registry-sources` for more details
        /// on local registries. See `local_registry.rs` for the tests that use
        /// this.
        pub fn local(&mut self, local: bool) -> &mut Package {
            self.local = local;
            self
        }

        /// Call with `true` to publish in an "alternative registry".
        ///
        /// The name of the alternative registry is called "alternative".
        ///
        /// See `src/doc/src/reference/registries.md` for more details on
        /// alternative registries. See `alt_registry.rs` for the tests that use
        /// this.
        ///
        /// **Requires:** [`alt_init`]
        pub fn alternative(&mut self, alternative: bool) -> &mut Package {
            self.alternative = alternative;
            self
        }

        /// Adds a file to the package.
        pub fn file(&mut self, name: &str, contents: &str) -> &mut Package {
            self.file_with_mode(name, DEFAULT_MODE, contents)
        }

        /// Adds a file with a specific Unix mode.
        pub fn file_with_mode(&mut self, path: &str, mode: u32, contents: &str) -> &mut Package {
            self.files.push(PackageFile {
                path: path.to_string(),
                contents: EntryData::Regular(contents.into()),
                mode,
                extra: false,
            });
            self
        }

        /// Adds a symlink to a path to the package.
        pub fn symlink(&mut self, dst: &str, src: &str) -> &mut Package {
            self.files.push(PackageFile {
                path: dst.to_string(),
                contents: EntryData::Symlink(src.into()),
                mode: DEFAULT_MODE,
                extra: false,
            });
            self
        }

        /// Adds an "extra" file that is not rooted within the package.
        ///
        /// Normal files are automatically placed within a directory named
        /// `$PACKAGE-$VERSION`. This allows you to override that behavior,
        /// typically for testing invalid behavior.
        pub fn extra_file(&mut self, path: &str, contents: &str) -> &mut Package {
            self.files.push(PackageFile {
                path: path.to_string(),
                contents: EntryData::Regular(contents.to_string()),
                mode: DEFAULT_MODE,
                extra: true,
            });
            self
        }

        /// Adds a normal dependency. Example:
        /// ```toml
        /// [dependencies]
        /// foo = {version = "1.0"}
        /// ```
        pub fn dep(&mut self, name: &str, vers: &str) -> &mut Package {
            self.add_dep(&Dependency::new(name, vers))
        }

        /// Adds a dependency with the given feature. Example:
        /// ```toml
        /// [dependencies]
        /// foo = {version = "1.0", "features": ["feat1", "feat2"]}
        /// ```
        pub fn feature_dep(&mut self, name: &str, vers: &str, features: &[&str]) -> &mut Package {
            self.add_dep(Dependency::new(name, vers).enable_features(features))
        }

        /// Adds a platform-specific dependency. Example:
        /// ```toml
        /// [target.'cfg(windows)'.dependencies]
        /// foo = {version = "1.0"}
        /// ```
        pub fn target_dep(&mut self, name: &str, vers: &str, target: &str) -> &mut Package {
            self.add_dep(Dependency::new(name, vers).target(target))
        }

        /// Adds a dependency to the alternative registry.
        pub fn registry_dep(&mut self, name: &str, vers: &str) -> &mut Package {
            self.add_dep(Dependency::new(name, vers).registry("alternative"))
        }

        /// Adds a dev-dependency. Example:
        /// ```toml
        /// [dev-dependencies]
        /// foo = {version = "1.0"}
        /// ```
        pub fn dev_dep(&mut self, name: &str, vers: &str) -> &mut Package {
            self.add_dep(Dependency::new(name, vers).dev())
        }

        /// Adds a build-dependency. Example:
        /// ```toml
        /// [build-dependencies]
        /// foo = {version = "1.0"}
        /// ```
        pub fn build_dep(&mut self, name: &str, vers: &str) -> &mut Package {
            self.add_dep(Dependency::new(name, vers).build())
        }

        pub fn add_dep(&mut self, dep: &Dependency) -> &mut Package {
            self.deps.push(dep.clone());
            self
        }

        /// Specifies whether or not the package is "yanked".
        pub fn yanked(&mut self, yanked: bool) -> &mut Package {
            self.yanked = yanked;
            self
        }

        /// Specifies `package.edition`
        pub fn edition(&mut self, edition: &str) -> &mut Package {
            self.edition = Some(edition.to_owned());
            self
        }

        /// Specifies `package.resolver`
        pub fn resolver(&mut self, resolver: &str) -> &mut Package {
            self.resolver = Some(resolver.to_owned());
            self
        }

        /// Specifies whether or not this is a proc macro.
        pub fn proc_macro(&mut self, proc_macro: bool) -> &mut Package {
            self.proc_macro = proc_macro;
            self
        }

        /// Adds an entry in the `[features]` section.
        pub fn feature(&mut self, name: &str, deps: &[&str]) -> &mut Package {
            let deps = deps.iter().map(|s| s.to_string()).collect();
            self.features.insert(name.to_string(), deps);
            self
        }

        /// Specify a minimal Rust version.
        pub fn rust_version(&mut self, rust_version: &str) -> &mut Package {
            self.rust_version = Some(rust_version.into());
            self
        }

        /// Causes the JSON line emitted in the index to be invalid, presumably
        /// causing Cargo to skip over this version.
        pub fn invalid_index_line(&mut self, invalid: bool) -> &mut Package {
            self.invalid_index_line = invalid;
            self
        }

        /// Override the auto-generated index line
        ///
        /// This can give more control over error cases than [`Package::invalid_index_line`]
        pub fn index_line(&mut self, line: &str) -> &mut Package {
            self.index_line = Some(line.to_owned());
            self
        }

        pub fn links(&mut self, links: &str) -> &mut Package {
            self.links = Some(links.to_string());
            self
        }

        pub fn cargo_feature(&mut self, feature: &str) -> &mut Package {
            self.cargo_features.push(feature.to_owned());
            self
        }

        /// Sets the index schema version for this package.
        ///
        /// See `cargo::sources::registry::IndexPackage` for more information.
        pub fn schema_version(&mut self, version: u32) -> &mut Package {
            self.v = Some(version);
            self
        }

        /// Creates the package and place it in the registry.
        ///
        /// This does not actually use Cargo's publishing system, but instead
        /// manually creates the entry in the registry on the filesystem.
        ///
        /// Returns the checksum for the package.
        pub fn publish(&self) -> String {
            self.make_archive();

            // Figure out what we're going to write into the index.
            let deps = self
                .deps
                .iter()
                .map(|dep| {
                    // In the index, the `registry` is null if it is from the same registry.
                    // In Cargo.toml, it is None if it is from crates.io.
                    let registry_url = match (self.alternative, dep.registry.as_deref()) {
                        (false, None) => None,
                        (false, Some("alternative")) => Some(alt_registry_url().to_string()),
                        (true, None) => {
                            Some("https://github.com/rust-lang/crates.io-index".to_string())
                        }
                        (true, Some("alternative")) => None,
                        _ => panic!("registry_dep currently only supports `alternative`"),
                    };
                    let artifact = if let Some(artifact) = &dep.artifact {
                        serde_json::json!([artifact])
                    } else {
                        serde_json::json!(null)
                    };
                    serde_json::json!({
                        "name": dep.name,
                        "req": dep.vers,
                        "features": dep.features,
                        "default_features": dep.default_features,
                        "target": dep.target,
                        "artifact": artifact,
                        "bindep_target": dep.bindep_target,
                        "lib": dep.lib,
                        "optional": dep.optional,
                        "kind": dep.kind,
                        "registry": registry_url,
                        "package": dep.package,
                        "public": dep.public,
                    })
                })
                .collect::<Vec<_>>();
            let cksum = {
                let c = t!(fs::read(&self.archive_dst()));
                cksum(&c)
            };
            let line = if let Some(line) = self.index_line.clone() {
                line
            } else {
                let name = if self.invalid_index_line {
                    serde_json::json!(1)
                } else {
                    serde_json::json!(self.name)
                };
                create_index_line(
                    name,
                    &self.vers,
                    deps,
                    &cksum,
                    self.features.clone(),
                    self.yanked,
                    self.links.clone(),
                    self.rust_version.as_deref(),
                    self.v,
                )
            };

            let registry_path = if self.alternative {
                alt_registry_path()
            } else {
                registry_path()
            };

            write_to_index(&registry_path, &self.name, line, self.local);

            cksum
        }

        fn make_archive(&self) {
            let dst = self.archive_dst();
            t!(fs::create_dir_all(dst.parent().unwrap()));
            let f = t!(File::create(&dst));
            let mut a = Builder::new(GzEncoder::new(f, Compression::none()));
            a.sparse(false);

            if !self
                .files
                .iter()
                .any(|PackageFile { path, .. }| path == "Cargo.toml")
            {
                self.append_manifest(&mut a);
            }
            if self.files.is_empty() {
                self.append(
                    &mut a,
                    "src/lib.rs",
                    DEFAULT_MODE,
                    &EntryData::Regular("".into()),
                );
            } else {
                for PackageFile {
                    path,
                    contents,
                    mode,
                    extra,
                } in &self.files
                {
                    if *extra {
                        self.append_raw(&mut a, path, *mode, contents);
                    } else {
                        self.append(&mut a, path, *mode, contents);
                    }
                }
            }
        }

        fn append_manifest<W: Write>(&self, ar: &mut Builder<W>) {
            let mut manifest = String::new();

            if !self.cargo_features.is_empty() {
                let mut features = String::new();
                serde::Serialize::serialize(
                    &self.cargo_features,
                    toml::ser::ValueSerializer::new(&mut features),
                )
                .unwrap();
                manifest.push_str(&format!("cargo-features = {}\n\n", features));
            }

            manifest.push_str(&format!(
                r#"
                [package]
                name = "{}"
                version = "{}"
                authors = []
            "#,
                self.name, self.vers
            ));

            if let Some(version) = &self.rust_version {
                manifest.push_str(&format!("rust-version = \"{}\"\n", version));
            }

            if let Some(edition) = &self.edition {
                manifest.push_str(&format!("edition = \"{}\"\n", edition));
            }

            if let Some(resolver) = &self.resolver {
                manifest.push_str(&format!("resolver = \"{}\"\n", resolver));
            }

            if !self.features.is_empty() {
                let features: Vec<String> = self
                    .features
                    .iter()
                    .map(|(feature, features)| {
                        if features.is_empty() {
                            format!("{} = []", feature)
                        } else {
                            format!(
                                "{} = [{}]",
                                feature,
                                features
                                    .iter()
                                    .map(|s| format!("\"{}\"", s))
                                    .collect::<Vec<_>>()
                                    .join(", ")
                            )
                        }
                    })
                    .collect();

                manifest.push_str(&format!("\n[features]\n{}", features.join("\n")));
            }

            for dep in self.deps.iter() {
                let target = match dep.target {
                    None => String::new(),
                    Some(ref s) => format!("target.'{}'.", s),
                };
                let kind = match &dep.kind[..] {
                    "build" => "build-",
                    "dev" => "dev-",
                    _ => "",
                };
                manifest.push_str(&format!(
                    r#"
                    [{}{}dependencies.{}]
                    version = "{}"
                "#,
                    target, kind, dep.name, dep.vers
                ));
                if dep.optional {
                    manifest.push_str("optional = true\n");
                }
                if let Some(artifact) = &dep.artifact {
                    manifest.push_str(&format!("artifact = \"{}\"\n", artifact));
                }
                if let Some(target) = &dep.bindep_target {
                    manifest.push_str(&format!("target = \"{}\"\n", target));
                }
                if dep.lib {
                    manifest.push_str("lib = true\n");
                }
                if let Some(registry) = &dep.registry {
                    assert_eq!(registry, "alternative");
                    manifest.push_str(&format!("registry-index = \"{}\"", alt_registry_url()));
                }
                if !dep.default_features {
                    manifest.push_str("default-features = false\n");
                }
                if !dep.features.is_empty() {
                    let mut features = String::new();
                    serde::Serialize::serialize(
                        &dep.features,
                        toml::ser::ValueSerializer::new(&mut features),
                    )
                    .unwrap();
                    manifest.push_str(&format!("features = {}\n", features));
                }
                if let Some(package) = &dep.package {
                    manifest.push_str(&format!("package = \"{}\"\n", package));
                }
            }
            if self.proc_macro {
                manifest.push_str("[lib]\nproc-macro = true\n");
            }

            self.append(
                ar,
                "Cargo.toml",
                DEFAULT_MODE,
                &EntryData::Regular(manifest.into()),
            );
        }

        fn append<W: Write>(&self, ar: &mut Builder<W>, file: &str, mode: u32, contents: &EntryData) {
            self.append_raw(
                ar,
                &format!("{}-{}/{}", self.name, self.vers, file),
                mode,
                contents,
            );
        }

        fn append_raw<W: Write>(
            &self,
            ar: &mut Builder<W>,
            path: &str,
            mode: u32,
            contents: &EntryData,
        ) {
            let mut header = Header::new_ustar();
            let contents = match contents {
                EntryData::Regular(contents) => contents.as_str(),
                EntryData::Symlink(src) => {
                    header.set_entry_type(tar::EntryType::Symlink);
                    t!(header.set_link_name(src));
                    "" // Symlink has no contents.
                }
            };
            header.set_size(contents.len() as u64);
            t!(header.set_path(path));
            header.set_mode(mode);
            header.set_cksum();
            t!(ar.append(&header, contents.as_bytes()));
        }

        /// Returns the path to the compressed package file.
        pub fn archive_dst(&self) -> PathBuf {
            if self.local {
                let path = if self.alternative {
                    alt_registry_path()
                } else {
                    registry_path()
                };
                path.join(format!("{}-{}.crate", self.name, self.vers))
            } else if self.alternative {
                alt_dl_path()
                    .join(&self.name)
                    .join(&self.vers)
                    .join("download")
            } else {
                dl_path().join(&self.name).join(&self.vers).join("download")
            }
        }
    }

    /// Generate a checksum
    pub fn cksum(s: &[u8]) -> String {
        Sha256::new().update(s).finish_hex()
    }

    impl Dependency {
        pub fn new(name: &str, vers: &str) -> Dependency {
            Dependency {
                name: name.to_string(),
                vers: vers.to_string(),
                kind: "normal".to_string(),
                artifact: None,
                bindep_target: None,
                lib: false,
                target: None,
                features: Vec::new(),
                package: None,
                optional: false,
                registry: None,
                default_features: true,
                public: false,
            }
        }

        /// Changes this to `[build-dependencies]`.
        pub fn build(&mut self) -> &mut Self {
            self.kind = "build".to_string();
            self
        }

        /// Changes this to `[dev-dependencies]`.
        pub fn dev(&mut self) -> &mut Self {
            self.kind = "dev".to_string();
            self
        }

        /// Changes this to `[target.$target.dependencies]`.
        pub fn target(&mut self, target: &str) -> &mut Self {
            self.target = Some(target.to_string());
            self
        }

        /// Change the artifact to be of the given kind, like "bin", or "staticlib",
        /// along with a specific target triple if provided.
        pub fn artifact(&mut self, kind: &str, target: Option<String>) -> &mut Self {
            self.artifact = Some(kind.to_string());
            self.bindep_target = target;
            self
        }

        /// Adds `registry = $registry` to this dependency.
        pub fn registry(&mut self, registry: &str) -> &mut Self {
            self.registry = Some(registry.to_string());
            self
        }

        /// Adds `features = [ ... ]` to this dependency.
        pub fn enable_features(&mut self, features: &[&str]) -> &mut Self {
            self.features.extend(features.iter().map(|s| s.to_string()));
            self
        }

        /// Adds `package = ...` to this dependency.
        pub fn package(&mut self, pkg: &str) -> &mut Self {
            self.package = Some(pkg.to_string());
            self
        }

        /// Changes this to an optional dependency.
        pub fn optional(&mut self, optional: bool) -> &mut Self {
            self.optional = optional;
            self
        }

        /// Changes this to an public dependency.
        pub fn public(&mut self, public: bool) -> &mut Self {
            self.public = public;
            self
        }

        /// Adds `default-features = false` if the argument is `false`.
        pub fn default_features(&mut self, default_features: bool) -> &mut Self {
            self.default_features = default_features;
            self
        }
    }