Rename function, tidy

Author: ameba23

src/attestation/measurements.rs

@@ -392,7 +392,7 @@ impl MeasurementPolicy {
 mod tests {
     use std::collections::HashSet;
 
-    use crate::test_helpers::default_dcap_measurements;
+    use crate::test_helpers::mock_dcap_measurements;
 
     use super::*;
 
@@ -436,7 +436,7 @@ mod tests {
         // Will not match mock measurements
         assert!(matches!(
             specific_measurements
-                .check_measurement(&default_dcap_measurements())
+                .check_measurement(&mock_dcap_measurements())
                 .unwrap_err(),
             AttestationError::MeasurementsNotAccepted
         ));
@@ -459,7 +459,7 @@ mod tests {
                 .unwrap();
 
         allowed_attestation_type
-            .check_measurement(&default_dcap_measurements())
+            .check_measurement(&mock_dcap_measurements())
             .unwrap();
 
         // Will not match another attestation type

src/lib.rs

@@ -861,8 +861,8 @@ mod tests {
 
     use super::*;
     use test_helpers::{
-        default_dcap_measurements, example_http_service, example_service,
-        generate_certificate_chain, generate_tls_config, generate_tls_config_with_client_auth,
+        example_http_service, generate_certificate_chain, generate_tls_config,
+        generate_tls_config_with_client_auth, mock_dcap_measurements,
     };
 
     // Server has mock DCAP, client has no attestation and no client auth
@@ -924,7 +924,7 @@ mod tests {
         let measurements =
             MultiMeasurements::from_header_format(measurements_json, AttestationType::DcapTdx)
                 .unwrap();
-        assert_eq!(measurements, default_dcap_measurements());
+        assert_eq!(measurements, mock_dcap_measurements());
 
         let res_body = res.text().await.unwrap();
         assert_eq!(res_body, "No measurements");
@@ -1008,7 +1008,7 @@ mod tests {
         // handler puts them there)
         let measurements =
             MultiMeasurements::from_header_format(&res_body, AttestationType::DcapTdx).unwrap();
-        assert_eq!(measurements, default_dcap_measurements());
+        assert_eq!(measurements, mock_dcap_measurements());
     }
 
     // Server has mock DCAP, client has mock DCAP and client auth
@@ -1077,7 +1077,7 @@ mod tests {
         let measurements =
             MultiMeasurements::from_header_format(measurements_json, AttestationType::DcapTdx)
                 .unwrap();
-        assert_eq!(measurements, default_dcap_measurements());
+        assert_eq!(measurements, mock_dcap_measurements());
 
         let attestation_type = headers
             .get(ATTESTATION_TYPE_HEADER)
@@ -1092,7 +1092,7 @@ mod tests {
         // handler puts them there)
         let measurements =
             MultiMeasurements::from_header_format(&res_body, AttestationType::DcapTdx).unwrap();
-        assert_eq!(measurements, default_dcap_measurements());
+        assert_eq!(measurements, mock_dcap_measurements());
 
         // Now do another request - to check that the connection has stayed open
         let res = reqwest::get(format!("http://{}", proxy_client_addr.to_string()))
@@ -1104,7 +1104,7 @@ mod tests {
         let measurements =
             MultiMeasurements::from_header_format(measurements_json, AttestationType::DcapTdx)
                 .unwrap();
-        assert_eq!(measurements, default_dcap_measurements());
+        assert_eq!(measurements, mock_dcap_measurements());
 
         let attestation_type = headers
             .get(ATTESTATION_TYPE_HEADER)
@@ -1119,13 +1119,13 @@ mod tests {
         // handler puts them there)
         let measurements =
             MultiMeasurements::from_header_format(&res_body, AttestationType::DcapTdx).unwrap();
-        assert_eq!(measurements, default_dcap_measurements());
+        assert_eq!(measurements, mock_dcap_measurements());
     }
 
     // Server has mock DCAP, client no attestation - just get the server certificate
     #[tokio::test]
     async fn test_get_tls_cert() {
-        let target_addr = example_service().await;
+        let target_addr = example_http_service().await;
 
         let (cert_chain, private_key) = generate_certificate_chain("127.0.0.1".parse().unwrap());
         let (server_config, client_config) = generate_tls_config(cert_chain.clone(), private_key);

src/test_helpers.rs

@@ -4,7 +4,6 @@ use std::{
     net::{IpAddr, SocketAddr},
     sync::Arc,
 };
-use tokio::io::AsyncWriteExt;
 use tokio::net::TcpListener;
 use tokio_rustls::rustls::{
     pki_types::{CertificateDer, PrivateKeyDer, PrivatePkcs8KeyDer},
@@ -121,6 +120,8 @@ pub fn generate_tls_config_with_client_auth(
     )
 }
 
+/// Given a TLS certificate, return a [WebPkiClientVerifier] and [RootCertStore] which will accept
+/// that certificate
 fn client_verifier_from_remote_cert(
     cert: CertificateDer<'static>,
 ) -> (Arc<dyn ClientCertVerifier>, RootCertStore) {
@@ -135,6 +136,8 @@ fn client_verifier_from_remote_cert(
     )
 }
 
+/// Simple http server used in tests which returns in the response the measurement header from the
+/// request
 pub async fn example_http_service() -> SocketAddr {
     let listener = TcpListener::bind("127.0.0.1:0").await.unwrap();
     let addr = listener.local_addr().unwrap();
@@ -156,21 +159,8 @@ async fn get_handler(headers: http::HeaderMap) -> impl IntoResponse {
         .to_string()
 }
 
-pub async fn example_service() -> SocketAddr {
-    let listener = TcpListener::bind("127.0.0.1:0").await.unwrap();
-    let addr = listener.local_addr().unwrap();
-
-    tokio::spawn(async move {
-        loop {
-            let (mut inbound, _client_addr) = listener.accept().await.unwrap();
-            inbound.write_all(b"some data").await.unwrap();
-        }
-    });
-
-    addr
-}
-
-pub fn default_dcap_measurements() -> MultiMeasurements {
+/// All-zero measurment values used in some tests
+pub fn mock_dcap_measurements() -> MultiMeasurements {
     MultiMeasurements::Dcap(HashMap::from([
         (DcapMeasurementRegister::MRTD, [0u8; 48]),
         (DcapMeasurementRegister::RTMR0, [0u8; 48]),