cargo/tests/testsuite/build_auth.rs
Alex Crichton bd7fe8914b Fix a deadlocking test with master libgit2
This commit fixes a test in Cargo to work around a seeming regression in
behavior in libgit2 around HTTP authentication. The expected flow for
HTTP authentication with git is that git sends an HTTP request and
receives an "unauthorized" response. It then sends another request with
authorization information and that's what we're testing is received in
the our test.

Previously libgit2 would issue a new HTTP connection if the previous one
was closed, but it looks like changes in libgit2 now require that the
same HTTP connection is used for the initial request and the subsequent
request with authorization information. This broke our test since it's
not using an HTTP compliant server at all and is just some handwritten
TCP reads/writes. The fix here is to basically stay with handwritten TCP
reads/writes but tweak how it happens so it's all on the same HTTP/TCP
connection to match what libgit2 is expecting.

Some extra assertions have also been added to try to prevent deadlocks
from happening in the future and instead make the test fail fast if this
situation comes up again.
2019-07-25 09:15:24 -07:00

264 lines
6.9 KiB
Rust

use std::collections::HashSet;
use std::io::prelude::*;
use std::io::BufReader;
use std::net::TcpListener;
use std::sync::atomic::{AtomicUsize, Ordering::SeqCst};
use std::sync::Arc;
use std::thread;
use crate::support::paths;
use crate::support::{basic_manifest, project};
use git2;
// Tests that HTTP auth is offered from `credential.helper`.
#[cargo_test]
fn http_auth_offered() {
let server = TcpListener::bind("127.0.0.1:0").unwrap();
let addr = server.local_addr().unwrap();
fn headers(rdr: &mut dyn BufRead) -> HashSet<String> {
let valid = ["GET", "Authorization", "Accept"];
rdr.lines()
.map(|s| s.unwrap())
.take_while(|s| s.len() > 2)
.map(|s| s.trim().to_string())
.filter(|s| valid.iter().any(|prefix| s.starts_with(*prefix)))
.collect()
}
let connections = Arc::new(AtomicUsize::new(0));
let connections2 = connections.clone();
let t = thread::spawn(move || {
let mut conn = BufReader::new(server.accept().unwrap().0);
let req = headers(&mut conn);
connections2.fetch_add(1, SeqCst);
conn.get_mut()
.write_all(
b"HTTP/1.1 401 Unauthorized\r\n\
WWW-Authenticate: Basic realm=\"wheee\"\r\n\
Content-Length: 0\r\n\
\r\n",
)
.unwrap();
assert_eq!(
req,
vec![
"GET /foo/bar/info/refs?service=git-upload-pack HTTP/1.1",
"Accept: */*",
]
.into_iter()
.map(|s| s.to_string())
.collect()
);
let req = headers(&mut conn);
connections2.fetch_add(1, SeqCst);
conn.get_mut()
.write_all(
b"HTTP/1.1 401 Unauthorized\r\n\
WWW-Authenticate: Basic realm=\"wheee\"\r\n\
\r\n",
)
.unwrap();
assert_eq!(
req,
vec![
"GET /foo/bar/info/refs?service=git-upload-pack HTTP/1.1",
"Authorization: Basic Zm9vOmJhcg==",
"Accept: */*",
]
.into_iter()
.map(|s| s.to_string())
.collect()
);
});
let script = project()
.at("script")
.file("Cargo.toml", &basic_manifest("script", "0.1.0"))
.file(
"src/main.rs",
r#"
fn main() {
println!("username=foo");
println!("password=bar");
}
"#,
)
.build();
script.cargo("build -v").run();
let script = script.bin("script");
let config = paths::home().join(".gitconfig");
let mut config = git2::Config::open(&config).unwrap();
config
.set_str(
"credential.helper",
// This is a bash script so replace `\` with `/` for Windows
&script.display().to_string().replace("\\", "/"),
)
.unwrap();
let p = project()
.file(
"Cargo.toml",
&format!(
r#"
[project]
name = "foo"
version = "0.0.1"
authors = []
[dependencies.bar]
git = "http://127.0.0.1:{}/foo/bar"
"#,
addr.port()
),
)
.file("src/main.rs", "")
.file(
".cargo/config",
"[net]
retry = 0
",
)
.build();
// This is a "contains" check because the last error differs by platform,
// may span multiple lines, and isn't relevant to this test.
p.cargo("build")
.with_status(101)
.with_stderr_contains(&format!(
"\
[UPDATING] git repository `http://{addr}/foo/bar`
[ERROR] failed to load source for a dependency on `bar`
Caused by:
Unable to update http://{addr}/foo/bar
Caused by:
failed to clone into: [..]
Caused by:
failed to authenticate when downloading repository
attempted to find username/password via `credential.helper`, but [..]
Caused by:
",
addr = addr
))
.run();
assert_eq!(connections.load(SeqCst), 2);
t.join().ok().unwrap();
}
// Boy, sure would be nice to have a TLS implementation in rust!
#[cargo_test]
fn https_something_happens() {
let server = TcpListener::bind("127.0.0.1:0").unwrap();
let addr = server.local_addr().unwrap();
let t = thread::spawn(move || {
let mut conn = server.accept().unwrap().0;
drop(conn.write(b"1234"));
drop(conn.shutdown(std::net::Shutdown::Write));
drop(conn.read(&mut [0; 16]));
});
let p = project()
.file(
"Cargo.toml",
&format!(
r#"
[project]
name = "foo"
version = "0.0.1"
authors = []
[dependencies.bar]
git = "https://127.0.0.1:{}/foo/bar"
"#,
addr.port()
),
)
.file("src/main.rs", "")
.file(
".cargo/config",
"[net]
retry = 0
",
)
.build();
p.cargo("build -v")
.with_status(101)
.with_stderr_contains(&format!(
"[UPDATING] git repository `https://{addr}/foo/bar`",
addr = addr
))
.with_stderr_contains(&format!(
"\
Caused by:
{errmsg}
",
errmsg = if cfg!(windows) {
"[..]failed to send request: [..]"
} else if cfg!(target_os = "macos") {
// macOS is difficult to tests as some builds may use Security.framework,
// while others may use OpenSSL. In that case, let's just not verify the error
// message here.
"[..]"
} else {
"[..]SSL error: [..]"
}
))
.run();
t.join().ok().unwrap();
}
// It would sure be nice to have an SSH implementation in Rust!
#[cargo_test]
fn ssh_something_happens() {
let server = TcpListener::bind("127.0.0.1:0").unwrap();
let addr = server.local_addr().unwrap();
let t = thread::spawn(move || {
drop(server.accept().unwrap());
});
let p = project()
.file(
"Cargo.toml",
&format!(
r#"
[project]
name = "foo"
version = "0.0.1"
authors = []
[dependencies.bar]
git = "ssh://127.0.0.1:{}/foo/bar"
"#,
addr.port()
),
)
.file("src/main.rs", "")
.build();
p.cargo("build -v")
.with_status(101)
.with_stderr_contains(&format!(
"[UPDATING] git repository `ssh://{addr}/foo/bar`",
addr = addr
))
.with_stderr_contains(
"\
Caused by:
[..]failed to start SSH session: Failed getting banner[..]
",
)
.run();
t.join().ok().unwrap();
}