octo
/
Zebra
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improve docs and panic messages for zebra_test::command (#2406)

This commit is contained in:
teor 2021-06-28 23:35:56 +10:00 committed by GitHub
parent bb974fd282
commit 0d5e5bec3c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
zebra-test/src/command.rs
View File

@ -212,7 +212,7 @@ impl<T> TestChild<T> {
/// Checks each line of the child's stdout against `regex`, and returns Ok /// Checks each line of the child's stdout against `regex`, and returns Ok
/// if a line matches. /// if a line matches.
/// ///
/// Kills the child after the configured timeout has elapsed. /// Kills the child on error, or after the configured timeout has elapsed.
/// See `expect_line_matching` for details. /// See `expect_line_matching` for details.
#[instrument(skip(self))] #[instrument(skip(self))]
pub fn expect_stdout_line_matches(&mut self, regex: &str) -> Result<&mut Self> { pub fn expect_stdout_line_matches(&mut self, regex: &str) -> Result<&mut Self> {
@ -228,7 +228,7 @@ impl<T> TestChild<T> {
let mut lines = self let mut lines = self
.stdout .stdout
.take() .take()
.expect("child must capture stdout to call expect_stdout_line_matches"); .expect("child must capture stdout to call expect_stdout_line_matches, and it can't be called again after an error");
match self.expect_line_matching(&mut lines, regex, "stdout") { match self.expect_line_matching(&mut lines, regex, "stdout") {
Ok(()) => { Ok(()) => {
@ -242,7 +242,7 @@ impl<T> TestChild<T> {
/// Checks each line of the child's stderr against `regex`, and returns Ok /// Checks each line of the child's stderr against `regex`, and returns Ok
/// if a line matches. /// if a line matches.
/// ///
/// Kills the child after the configured timeout has elapsed. /// Kills the child on error, or after the configured timeout has elapsed.
/// See `expect_line_matching` for details. /// See `expect_line_matching` for details.
#[instrument(skip(self))] #[instrument(skip(self))]
pub fn expect_stderr_line_matches(&mut self, regex: &str) -> Result<&mut Self> { pub fn expect_stderr_line_matches(&mut self, regex: &str) -> Result<&mut Self> {
@ -258,7 +258,7 @@ impl<T> TestChild<T> {
let mut lines = self let mut lines = self
.stderr .stderr
.take() .take()
.expect("child must capture stderr to call expect_stderr_line_matches"); .expect("child must capture stderr to call expect_stderr_line_matches, and it can't be called again after an error");
match self.expect_line_matching(&mut lines, regex, "stderr") { match self.expect_line_matching(&mut lines, regex, "stderr") {
Ok(()) => { Ok(()) => {
@ -272,7 +272,7 @@ impl<T> TestChild<T> {
/// Checks each line in `lines` against `regex`, and returns Ok if a line /// Checks each line in `lines` against `regex`, and returns Ok if a line
/// matches. Uses `stream_name` as the name for `lines` in error reports. /// matches. Uses `stream_name` as the name for `lines` in error reports.
/// ///
/// Kills the child after the configured timeout has elapsed. /// Kills the child on error, or after the configured timeout has elapsed.
/// Note: the timeout is only checked after each full line is received from /// Note: the timeout is only checked after each full line is received from
/// the child. /// the child.
#[instrument(skip(self, lines))] #[instrument(skip(self, lines))]