    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

    use filetime::{self, FileTime};

    use std::cell::RefCell;
    use std::env;
    use std::fs;
    use std::io::{self, ErrorKind};
    use std::path::{Path, PathBuf};
    use std::process::Command;
    use std::sync::atomic::{AtomicUsize, Ordering};
    use std::sync::Mutex;
    use std::sync::OnceLock;

    static CARGO_INTEGRATION_TEST_DIR: &str = "cit";

    static GLOBAL_ROOT: OnceLock<Mutex<Option<PathBuf>>> = OnceLock::new();

    /// This is used when running cargo is pre-CARGO_TARGET_TMPDIR
    /// TODO: Remove when CARGO_TARGET_TMPDIR grows old enough.
    fn global_root_legacy() -> PathBuf {
        let mut path = t!(env::current_exe());
        path.pop(); // chop off exe name
        path.pop(); // chop off "deps"
        path.push("tmp");
        path.mkdir_p();
        path
    }

    fn set_global_root(tmp_dir: Option<&'static str>) {
        let mut lock = GLOBAL_ROOT
            .get_or_init(|| Default::default())
            .lock()
            .unwrap();
        if lock.is_none() {
            let mut root = match tmp_dir {
                Some(tmp_dir) => PathBuf::from(tmp_dir),
                None => global_root_legacy(),
            };

            root.push(CARGO_INTEGRATION_TEST_DIR);
            *lock = Some(root);
        }
    }

    pub fn global_root() -> PathBuf {
        let lock = GLOBAL_ROOT
            .get_or_init(|| Default::default())
            .lock()
            .unwrap();
        match lock.as_ref() {
            Some(p) => p.clone(),
            None => unreachable!("GLOBAL_ROOT not set yet"),
        }
    }

    // We need to give each test a unique id. The test name could serve this
    // purpose, but the `test` crate doesn't have a way to obtain the current test
    // name.[*] Instead, we used the `cargo-test-macro` crate to automatically
    // insert an init function for each test that sets the test name in a thread
    // local variable.
    //
    // [*] It does set the thread name, but only when running concurrently. If not
    // running concurrently, all tests are run on the main thread.
    thread_local! {
        static TEST_ID: RefCell<Option<usize>> = RefCell::new(None);
    }

    pub struct TestIdGuard {
        _private: (),
    }

    pub fn init_root(tmp_dir: Option<&'static str>) -> TestIdGuard {
        static NEXT_ID: AtomicUsize = AtomicUsize::new(0);

        let id = NEXT_ID.fetch_add(1, Ordering::SeqCst);
        TEST_ID.with(|n| *n.borrow_mut() = Some(id));

        let guard = TestIdGuard { _private: () };

        set_global_root(tmp_dir);
        let r = root();
        r.rm_rf();
        r.mkdir_p();

        guard
    }

    impl Drop for TestIdGuard {
        fn drop(&mut self) {
            TEST_ID.with(|n| *n.borrow_mut() = None);
        }
    }

    pub fn root() -> PathBuf {
        let id = TEST_ID.with(|n| {
            n.borrow().expect(
                "Tests must use the `#[cargo_test]` attribute in \
                 order to be able to use the crate root.",
            )
        });

        let mut root = global_root();
        root.push(&format!("t{}", id));
        root
    }

    pub fn home() -> PathBuf {
        let mut path = root();
        path.push("home");
        path.mkdir_p();
        path
    }

    pub trait CargoPathExt {
        fn rm_rf(&self);
        fn mkdir_p(&self);

        /// Returns a list of all files and directories underneath the given
        /// directory, recursively, including the starting path.
        fn ls_r(&self) -> Vec<PathBuf>;

        fn move_into_the_past(&self) {
            self.move_in_time(|sec, nsec| (sec - 3600, nsec))
        }

        fn move_into_the_future(&self) {
            self.move_in_time(|sec, nsec| (sec + 3600, nsec))
        }

        fn move_in_time<F>(&self, travel_amount: F)
        where
            F: Fn(i64, u32) -> (i64, u32);
    }

    impl CargoPathExt for Path {
        fn rm_rf(&self) {
            let meta = match self.symlink_metadata() {
                Ok(meta) => meta,
                Err(e) => {
                    if e.kind() == ErrorKind::NotFound {
                        return;
                    }
                    panic!("failed to remove {:?}, could not read: {:?}", self, e);
                }
            };
            // There is a race condition between fetching the metadata and
            // actually performing the removal, but we don't care all that much
            // for our tests.
            if meta.is_dir() {
                if let Err(e) = fs::remove_dir_all(self) {
                    panic!("failed to remove {:?}: {:?}", self, e)
                }
            } else if let Err(e) = fs::remove_file(self) {
                panic!("failed to remove {:?}: {:?}", self, e)
            }
        }

        fn mkdir_p(&self) {
            fs::create_dir_all(self)
                .unwrap_or_else(|e| panic!("failed to mkdir_p {}: {}", self.display(), e))
        }

        fn ls_r(&self) -> Vec<PathBuf> {
            walkdir::WalkDir::new(self)
                .sort_by_file_name()
                .into_iter()
                .filter_map(|e| e.map(|e| e.path().to_owned()).ok())
                .collect()
        }

        fn move_in_time<F>(&self, travel_amount: F)
        where
            F: Fn(i64, u32) -> (i64, u32),
        {
            if self.is_file() {
                time_travel(self, &travel_amount);
            } else {
                recurse(self, &self.join("target"), &travel_amount);
            }

            fn recurse<F>(p: &Path, bad: &Path, travel_amount: &F)
            where
                F: Fn(i64, u32) -> (i64, u32),
            {
                if p.is_file() {
                    time_travel(p, travel_amount)
                } else if !p.starts_with(bad) {
                    for f in t!(fs::read_dir(p)) {
                        let f = t!(f).path();
                        recurse(&f, bad, travel_amount);
                    }
                }
            }

            fn time_travel<F>(path: &Path, travel_amount: &F)
            where
                F: Fn(i64, u32) -> (i64, u32),
            {
                let stat = t!(path.symlink_metadata());

                let mtime = FileTime::from_last_modification_time(&stat);

                let (sec, nsec) = travel_amount(mtime.unix_seconds(), mtime.nanoseconds());
                let newtime = FileTime::from_unix_time(sec, nsec);

                // Sadly change_file_times has a failure mode where a readonly file
                // cannot have its times changed on windows.
                do_op(path, "set file times", |path| {
                    filetime::set_file_times(path, newtime, newtime)
                });
            }
        }
    }

    fn do_op<F>(path: &Path, desc: &str, mut f: F)
    where
        F: FnMut(&Path) -> io::Result<()>,
    {
        match f(path) {
            Ok(()) => {}
            Err(ref e) if e.kind() == ErrorKind::PermissionDenied => {
                let mut p = t!(path.metadata()).permissions();
                p.set_readonly(false);
                t!(fs::set_permissions(path, p));

                // Unix also requires the parent to not be readonly for example when
                // removing files
                let parent = path.parent().unwrap();
                let mut p = t!(parent.metadata()).permissions();
                p.set_readonly(false);
                t!(fs::set_permissions(parent, p));

                f(path).unwrap_or_else(|e| {
                    panic!("failed to {} {}: {}", desc, path.display(), e);
                })
            }
            Err(e) => {
                panic!("failed to {} {}: {}", desc, path.display(), e);
            }
        }
    }

    /// Get the filename for a library.
    ///
    /// `kind` should be one of: "lib", "rlib", "staticlib", "dylib", "proc-macro"
    ///
    /// For example, dynamic library named "foo" would return:
    /// - macOS: "libfoo.dylib"
    /// - Windows: "foo.dll"
    /// - Unix: "libfoo.so"
    pub fn get_lib_filename(name: &str, kind: &str) -> String {
        let prefix = get_lib_prefix(kind);
        let extension = get_lib_extension(kind);
        format!("{}{}.{}", prefix, name, extension)
    }

    pub fn get_lib_prefix(kind: &str) -> &str {
        match kind {
            "lib" | "rlib" => "lib",
            "staticlib" | "dylib" | "proc-macro" => {
                if cfg!(windows) {
                    ""
                } else {
                    "lib"
                }
            }
            _ => unreachable!(),
        }
    }

    pub fn get_lib_extension(kind: &str) -> &str {
        match kind {
            "lib" | "rlib" => "rlib",
            "staticlib" => {
                if cfg!(windows) {
                    "lib"
                } else {
                    "a"
                }
            }
            "dylib" | "proc-macro" => {
                if cfg!(windows) {
                    "dll"
                } else if cfg!(target_os = "macos") {
                    "dylib"
                } else {
                    "so"
                }
            }
            _ => unreachable!(),
        }
    }

    /// Returns the sysroot as queried from rustc.
    pub fn sysroot() -> String {
        let output = Command::new("rustc")
            .arg("--print=sysroot")
            .output()
            .expect("rustc to run");
        assert!(output.status.success());
        let sysroot = String::from_utf8(output.stdout).unwrap();
        sysroot.trim().to_string()
    }

    /// Returns true if names such as aux.* are allowed.
    ///
    /// Traditionally, Windows did not allow a set of file names (see `is_windows_reserved`
    /// for a list). More recent versions of Windows have relaxed this restriction. This test
    /// determines whether we are running in a mode that allows Windows reserved names.
    #[cfg(windows)]
    pub fn windows_reserved_names_are_allowed() -> bool {
        use cargo_util::is_ci;

        // Ensure tests still run in CI until we need to migrate.
        if is_ci() {
            return false;
        }

        use std::ffi::OsStr;
        use std::os::windows::ffi::OsStrExt;
        use std::ptr;
        use windows_sys::Win32::Storage::FileSystem::GetFullPathNameW;

        let test_file_name: Vec<_> = OsStr::new("aux.rs").encode_wide().collect();

        let buffer_length =
            unsafe { GetFullPathNameW(test_file_name.as_ptr(), 0, ptr::null_mut(), ptr::null_mut()) };

        if buffer_length == 0 {
            // This means the call failed, so we'll conservatively assume reserved names are not allowed.
            return false;
        }

        let mut buffer = vec![0u16; buffer_length as usize];

        let result = unsafe {
            GetFullPathNameW(
                test_file_name.as_ptr(),
                buffer_length,
                buffer.as_mut_ptr(),
                ptr::null_mut(),
            )
        };

        if result == 0 {
            // Once again, conservatively assume reserved names are not allowed if the
            // GetFullPathNameW call failed.
            return false;
        }

        // Under the old rules, a file name like aux.rs would get converted into \\.\aux, so
        // we detect this case by checking if the string starts with \\.\
        //
        // Otherwise, the filename will be something like C:\Users\Foo\Documents\aux.rs
        let prefix: Vec<_> = OsStr::new("\\\\.\\").encode_wide().collect();
        if buffer.starts_with(&prefix) {
            false
        } else {
            true
        }
    }