Ignore tests that need Administrator privileges on Windows.

This patch allows you to run them when wanted with ``--ignored`` on Windows.

Author: thomwiggers

ci/azure-test-all.yml

@@ -26,3 +26,10 @@ steps:
 # fix the link errors.
 - bash: cargo test --features 'deny-warnings curl/force-system-lib-on-osx'
   displayName: "cargo test"
+
+# Run any tests that have been marked ignore.
+#
+# `--include-ignored` is only supported on nightly so far, so we have to call
+# this separately for now.
+- bash: cargo test --features 'deny-warnings curl/force-system-lib-on-osx' -- --ignored
+  displayName: "cargo test -- --ignored"

tests/testsuite/build.rs

@@ -1495,12 +1495,12 @@ package `test v0.0.0 ([CWD])`",
 }
 
 #[cargo_test]
+#[cfg_attr(windows, ignore)]
+/// Make sure ignored symlinks don't break the build
+///
+/// This test is marked ``ignore`` on Windows because it needs admin permissions.
+/// Run it with ``--ignored``.
 fn ignore_broken_symlinks() {
-    // windows and symlinks don't currently agree that well
-    if cfg!(windows) {
-        return;
-    }
-
     let p = project()
         .file("Cargo.toml", &basic_bin_manifest("foo"))
         .file("src/foo.rs", &main_file(r#""i am foo""#, &[]))

tests/testsuite/package.rs

@@ -505,25 +505,39 @@ fn package_git_submodule() {
 }
 
 #[cargo_test]
+#[cfg_attr(windows, ignore)]
+/// Tests if a symlink to a git submodule is properly handled.
+///
+/// This test is ignored on Windows, because it needs Administrator
+/// permissions to run. If you do want to run this test, please
+/// run the tests with ``--ignored``, e.g.
+///
+/// ```text
+/// cargo test -- --ignored
+/// ```
 fn package_symlink_to_submodule() {
     #[cfg(unix)]
-    use std::os::unix::fs::symlink as symlink;
+    use std::os::unix::fs::symlink;
     #[cfg(windows)]
     use std::os::windows::fs::symlink_dir as symlink;
 
     let project = git::new("foo", |project| {
-        project
-            .file("src/lib.rs", "pub fn foo() {}")
-        }).unwrap();
+        project.file("src/lib.rs", "pub fn foo() {}")
+    })
+    .unwrap();
 
     let library = git::new("submodule", |library| {
         library.no_manifest().file("Makefile", "all:")
-    }).unwrap();
+    })
+    .unwrap();
 
     let repository = git2::Repository::open(&project.root()).unwrap();
     let url = path2url(library.root()).to_string();
     git::add_submodule(&repository, &url, Path::new("submodule"));
-    t!(symlink(&project.root().join("submodule"), &project.root().join("submodule-link")));
+    t!(symlink(
+        &project.root().join("submodule"),
+        &project.root().join("submodule-link")
+    ));
     git::add(&repository);
     git::commit(&repository);
 
@@ -532,8 +546,9 @@ fn package_symlink_to_submodule() {
         .reset(
             &repository.revparse_single("HEAD").unwrap(),
             git2::ResetType::Hard,
-            None
-        ).unwrap();
+            None,
+        )
+        .unwrap();
 
     project
         .cargo("package --no-verify -v")
@@ -697,9 +712,19 @@ See [..]
 }
 
 #[cargo_test]
+#[cfg_attr(windows, ignore)]
+/// Tests if a broken symlink is properly handled when packaging.
+///
+/// This test is ignored on Windows, because it needs Administrator
+/// permissions to run. If you do want to run this test, please
+/// run the tests with ``--ignored``, e.g.
+///
+/// ```text
+/// cargo test -- --ignored
+/// ```
 fn broken_symlink() {
     #[cfg(unix)]
-    use std::os::unix::fs::symlink as symlink;
+    use std::os::unix::fs::symlink;
     #[cfg(windows)]
     use std::os::windows::fs::symlink_dir as symlink;
 
@@ -739,6 +764,16 @@ Caused by:
 }
 
 #[cargo_test]
+#[cfg_attr(windows, ignore)]
+/// Tests if a symlink to a directory is proberly included.
+///
+/// This test is ignored on Windows, because it needs Administrator
+/// permissions to run. If you do want to run this test, please
+/// run the tests with ``--ignored``, e.g.
+///
+/// ```text
+/// cargo test -- --ignored
+/// ```
 fn package_symlink_to_dir() {
     project()
         .file("src/main.rs", r#"fn main() { println!("hello"); }"#)

tests/testsuite/support/mod.rs

@@ -183,11 +183,19 @@ struct SymlinkBuilder {
 
 impl SymlinkBuilder {
     pub fn new(dst: PathBuf, src: PathBuf) -> SymlinkBuilder {
-        SymlinkBuilder { dst, src, src_is_dir: false }
+        SymlinkBuilder {
+            dst,
+            src,
+            src_is_dir: false,
+        }
     }
 
     pub fn new_dir(dst: PathBuf, src: PathBuf) -> SymlinkBuilder {
-        SymlinkBuilder { dst, src, src_is_dir: true }
+        SymlinkBuilder {
+            dst,
+            src,
+            src_is_dir: true,
+        }
     }
 
     #[cfg(unix)]
@@ -273,9 +281,9 @@ impl ProjectBuilder {
     /// Create a symlink to a directory
     pub fn symlink_dir<T: AsRef<Path>>(mut self, dst: T, src: T) -> Self {
         self.symlinks.push(SymlinkBuilder::new_dir(
-                self.root.root().join(dst),
-                self.root.root().join(src),
-            ));
+            self.root.root().join(dst),
+            self.root.root().join(src),
+        ));
         self
     }