Standardize on mod test

Keep a consistent style of `mod test`, rather than a mix of that and
`mod tests`.  Enforce this new rule with a rudimentary check, added as
`xtask style`.

Author: pfmooney

.github/workflows/rust.yml

@@ -21,6 +21,8 @@ jobs:
       run: cargo fmt -- --version
     - name: Check style
       run: cargo fmt -- --check
+    - name: Check misc. style
+      run: cargo xtask style
   check-clippy:
     runs-on: ubuntu-latest
     steps:

bin/propolis-cli/src/main.rs

@@ -360,57 +360,6 @@ async fn stdin_to_websockets_task(
     }
 }
 
-#[tokio::test]
-async fn test_stdin_to_websockets_task() {
-    use tokio::sync::mpsc::error::TryRecvError;
-
-    let (stdintx, stdinrx) = tokio::sync::mpsc::channel(16);
-    let (wstx, mut wsrx) = tokio::sync::mpsc::channel(16);
-
-    tokio::spawn(async move { stdin_to_websockets_task(stdinrx, wstx).await });
-
-    // send characters, receive characters
-    stdintx
-        .send("test post please ignore".chars().map(|c| c as u8).collect())
-        .await
-        .unwrap();
-    let actual = wsrx.recv().await.unwrap();
-    assert_eq!(String::from_utf8(actual).unwrap(), "test post please ignore");
-
-    // don't send ctrl-a
-    stdintx.send("\x01".chars().map(|c| c as u8).collect()).await.unwrap();
-    assert_eq!(wsrx.try_recv(), Err(TryRecvError::Empty));
-
-    // the "t" here is sent "raw" because of last ctrl-a but that doesn't change anything
-    stdintx.send("test".chars().map(|c| c as u8).collect()).await.unwrap();
-    let actual = wsrx.recv().await.unwrap();
-    assert_eq!(String::from_utf8(actual).unwrap(), "test");
-
-    // ctrl-a ctrl-c = only ctrl-c sent
-    stdintx.send("\x01\x03".chars().map(|c| c as u8).collect()).await.unwrap();
-    let actual = wsrx.recv().await.unwrap();
-    assert_eq!(String::from_utf8(actual).unwrap(), "\x03");
-
-    // same as above, across two messages
-    stdintx.send("\x01".chars().map(|c| c as u8).collect()).await.unwrap();
-    stdintx.send("\x03".chars().map(|c| c as u8).collect()).await.unwrap();
-    assert_eq!(wsrx.try_recv(), Err(TryRecvError::Empty));
-    let actual = wsrx.recv().await.unwrap();
-    assert_eq!(String::from_utf8(actual).unwrap(), "\x03");
-
-    // ctrl-a ctrl-a = only ctrl-a sent
-    stdintx.send("\x01\x01".chars().map(|c| c as u8).collect()).await.unwrap();
-    let actual = wsrx.recv().await.unwrap();
-    assert_eq!(String::from_utf8(actual).unwrap(), "\x01");
-
-    // ctrl-c on its own means exit
-    stdintx.send("\x03".chars().map(|c| c as u8).collect()).await.unwrap();
-    assert_eq!(wsrx.try_recv(), Err(TryRecvError::Empty));
-
-    // channel is closed
-    assert!(wsrx.recv().await.is_none());
-}
-
 async fn serial(
     addr: SocketAddr,
     byte_offset: Option<i64>,
@@ -747,3 +696,70 @@ impl Drop for RawTermiosGuard {
         }
     }
 }
+
+#[cfg(test)]
+mod test {
+    use super::stdin_to_websockets_task;
+
+    #[tokio::test]
+    async fn test_stdin_to_websockets_task() {
+        use tokio::sync::mpsc::error::TryRecvError;
+
+        let (stdintx, stdinrx) = tokio::sync::mpsc::channel(16);
+        let (wstx, mut wsrx) = tokio::sync::mpsc::channel(16);
+
+        tokio::spawn(
+            async move { stdin_to_websockets_task(stdinrx, wstx).await },
+        );
+
+        // send characters, receive characters
+        stdintx
+            .send("test post please ignore".chars().map(|c| c as u8).collect())
+            .await
+            .unwrap();
+        let actual = wsrx.recv().await.unwrap();
+        assert_eq!(
+            String::from_utf8(actual).unwrap(),
+            "test post please ignore"
+        );
+
+        // don't send ctrl-a
+        stdintx.send("\x01".chars().map(|c| c as u8).collect()).await.unwrap();
+        assert_eq!(wsrx.try_recv(), Err(TryRecvError::Empty));
+
+        // the "t" here is sent "raw" because of last ctrl-a but that doesn't change anything
+        stdintx.send("test".chars().map(|c| c as u8).collect()).await.unwrap();
+        let actual = wsrx.recv().await.unwrap();
+        assert_eq!(String::from_utf8(actual).unwrap(), "test");
+
+        // ctrl-a ctrl-c = only ctrl-c sent
+        stdintx
+            .send("\x01\x03".chars().map(|c| c as u8).collect())
+            .await
+            .unwrap();
+        let actual = wsrx.recv().await.unwrap();
+        assert_eq!(String::from_utf8(actual).unwrap(), "\x03");
+
+        // same as above, across two messages
+        stdintx.send("\x01".chars().map(|c| c as u8).collect()).await.unwrap();
+        stdintx.send("\x03".chars().map(|c| c as u8).collect()).await.unwrap();
+        assert_eq!(wsrx.try_recv(), Err(TryRecvError::Empty));
+        let actual = wsrx.recv().await.unwrap();
+        assert_eq!(String::from_utf8(actual).unwrap(), "\x03");
+
+        // ctrl-a ctrl-a = only ctrl-a sent
+        stdintx
+            .send("\x01\x01".chars().map(|c| c as u8).collect())
+            .await
+            .unwrap();
+        let actual = wsrx.recv().await.unwrap();
+        assert_eq!(String::from_utf8(actual).unwrap(), "\x01");
+
+        // ctrl-c on its own means exit
+        stdintx.send("\x03".chars().map(|c| c as u8).collect()).await.unwrap();
+        assert_eq!(wsrx.try_recv(), Err(TryRecvError::Empty));
+
+        // channel is closed
+        assert!(wsrx.recv().await.is_none());
+    }
+}

bin/propolis-server/src/lib/migrate/protocol.rs

@@ -256,7 +256,7 @@ pub(super) fn select_protocol_from_offer(
 }
 
 #[cfg(test)]
-mod tests {
+mod test {
     use super::*;
 
     // N.B. The test protocol lists are sorted by version to meet the

bin/propolis-server/src/lib/serial/history_buffer.rs

@@ -218,7 +218,7 @@ impl HistoryBuffer {
 }
 
 #[cfg(test)]
-mod tests {
+mod test {
     use super::*;
     use SerialHistoryOffset::*;
 

bin/propolis-server/src/lib/server.rs

@@ -1147,7 +1147,7 @@ fn not_created_error() -> HttpError {
 }
 
 #[cfg(test)]
-mod tests {
+mod test {
     #[test]
     fn test_propolis_server_openapi() {
         let mut buf: Vec<u8> = vec![];

bin/propolis-server/src/lib/stats/virtual_machine.rs

@@ -395,7 +395,7 @@ fn produce_vcpu_usage<'a>(
 }
 
 #[cfg(test)]
-mod tests {
+mod test {
     use super::kstat_instance_from_instance_id;
     use super::kstat_microstate_to_state_name;
     use super::produce_vcpu_usage;

bin/propolis-server/src/lib/vm/request_queue.rs

@@ -444,7 +444,7 @@ impl ExternalRequestQueue {
 }
 
 #[cfg(test)]
-mod tests {
+mod test {
     use super::*;
 
     use uuid::Uuid;

bin/propolis-server/src/lib/vm/state_driver.rs

@@ -567,7 +567,7 @@ where
 }
 
 #[cfg(test)]
-mod tests {
+mod test {
     use anyhow::bail;
     use mockall::Sequence;
 

crates/propolis-server-config/src/lib.rs

@@ -143,7 +143,7 @@ pub fn parse<P: AsRef<Path>>(path: P) -> Result<Config, ParseError> {
 }
 
 #[cfg(test)]
-mod tests {
+mod test {
     use super::*;
 
     #[test]

lib/propolis-client/src/support.rs

@@ -449,7 +449,7 @@ fn _assert_impls() {
 }
 
 #[cfg(test)]
-mod tests {
+mod test {
     use super::InstanceSerialConsoleControlMessage;
     use super::InstanceSerialConsoleHelper;
     use super::Role;