refactor(test): Tiny cleanup of MMDS unit tests

* Insert a line break with "\" after "\r\n" if another line follows
* Eliminate `request_bytes` and pass it directly to Request::try_from()
  as a literal, making the multi-line request body start at the (almost)
  same position
* Use test utility function if possible
* Remove duplicate test cases

Signed-off-by: Takahiro Itazuri <[email protected]>

Author: zulinx86

src/vmm/src/mmds/mod.rs

@@ -485,8 +485,9 @@ mod tests {
         );
 
         // Test resource not found.
-        let request_bytes = b"GET http://169.254.169.254/invalid HTTP/1.0\r\n\r\n";
-        let request = Request::try_from(request_bytes, None).unwrap();
+        let request =
+            Request::try_from(b"GET http://169.254.169.254/invalid HTTP/1.0\r\n\r\n", None)
+                .unwrap();
         let mut expected_response = Response::new(Version::Http10, StatusCode::NotFound);
         expected_response.set_content_type(MediaType::PlainText);
         expected_response.set_body(Body::new(
@@ -496,8 +497,7 @@ mod tests {
         assert_eq!(actual_response, expected_response);
 
         // Test NotImplemented.
-        let request_bytes = b"GET /age HTTP/1.1\r\n\r\n";
-        let request = Request::try_from(request_bytes, None).unwrap();
+        let request = Request::try_from(b"GET /age HTTP/1.1\r\n\r\n", None).unwrap();
         let mut expected_response = Response::new(Version::Http11, StatusCode::NotImplemented);
         expected_response.set_content_type(MediaType::PlainText);
         let body = "Cannot retrieve value. The value has an unsupported type.".to_string();
@@ -508,8 +508,11 @@ mod tests {
         // Test not allowed HTTP Method.
         let not_allowed_methods = ["PUT", "PATCH"];
         for method in not_allowed_methods.iter() {
-            let request_bytes = format!("{} http://169.254.169.255/ HTTP/1.0\r\n\r\n", method);
-            let request = Request::try_from(request_bytes.as_bytes(), None).unwrap();
+            let request = Request::try_from(
+                format!("{} http://169.254.169.255/ HTTP/1.0\r\n\r\n", method).as_bytes(),
+                None,
+            )
+            .unwrap();
             let mut expected_response =
                 Response::new(Version::Http10, StatusCode::MethodNotAllowed);
             expected_response.set_content_type(MediaType::PlainText);
@@ -520,32 +523,29 @@ mod tests {
         }
 
         // Test invalid (empty absolute path) URI.
-        let request_bytes = b"GET http:// HTTP/1.0\r\n\r\n";
-        let request = Request::try_from(request_bytes, None).unwrap();
+        let request = Request::try_from(b"GET http:// HTTP/1.0\r\n\r\n", None).unwrap();
         let mut expected_response = Response::new(Version::Http10, StatusCode::BadRequest);
         expected_response.set_content_type(MediaType::PlainText);
         expected_response.set_body(Body::new(VmmMmdsError::InvalidURI.to_string()));
         let actual_response = convert_to_response(mmds.clone(), request);
         assert_eq!(actual_response, expected_response);
 
         // Test invalid custom header value is ignored when V1 is configured.
-        let request_bytes = b"GET http://169.254.169.254/name/first HTTP/1.0\r\n\
-                                    Accept: application/json\r\n
-                                    X-metadata-token-ttl-seconds: application/json\r\n\r\n";
-        let request = Request::try_from(request_bytes, None).unwrap();
-        let mut expected_response = Response::new(Version::Http10, StatusCode::OK);
-        expected_response.set_body(Body::new("\"John\""));
+        let (request, expected_response) = generate_request_and_expected_response(
+            b"GET http://169.254.169.254/ HTTP/1.0\r\n\
+            Accept: application/json\r\n\
+            X-metadata-token-ttl-seconds: -60\r\n\r\n",
+            MediaType::ApplicationJson,
+        );
         let actual_response = convert_to_response(mmds.clone(), request);
         assert_eq!(actual_response, expected_response);
 
         // Test Ok path.
-        let request_bytes = b"GET http://169.254.169.254/ HTTP/1.0\r\n\
-                                    Accept: application/json\r\n\r\n";
-        let request = Request::try_from(request_bytes, None).unwrap();
-        let mut expected_response = Response::new(Version::Http10, StatusCode::OK);
-        let mut body = get_json_data().to_string();
-        body.retain(|c| !c.is_whitespace());
-        expected_response.set_body(Body::new(body));
+        let (request, expected_response) = generate_request_and_expected_response(
+            b"GET http://169.254.169.254/ HTTP/1.0\r\n\
+            Accept: application/json\r\n\r\n",
+            MediaType::ApplicationJson,
+        );
         let actual_response = convert_to_response(mmds, request);
         assert_eq!(actual_response, expected_response);
     }
@@ -566,8 +566,8 @@ mod tests {
         );
 
         // Test not allowed PATCH HTTP Method.
-        let request_bytes = b"PATCH http://169.254.169.255/ HTTP/1.0\r\n\r\n";
-        let request = Request::try_from(request_bytes, None).unwrap();
+        let request =
+            Request::try_from(b"PATCH http://169.254.169.255/ HTTP/1.0\r\n\r\n", None).unwrap();
         let mut expected_response = Response::new(Version::Http10, StatusCode::MethodNotAllowed);
         expected_response.set_content_type(MediaType::PlainText);
         expected_response.set_body(Body::new(VmmMmdsError::MethodNotAllowed.to_string()));
@@ -577,25 +577,30 @@ mod tests {
         assert_eq!(actual_response, expected_response);
 
         // Test invalid value for custom header.
-        let request_bytes = b"GET http://169.254.169.254/ HTTP/1.0\r\n\
-                                    Accept: application/json\r\n
-                                    X-metadata-token-ttl-seconds: application/json\r\n\r\n";
-        let request = Request::try_from(request_bytes, None).unwrap();
+        let request = Request::try_from(
+            b"GET http://169.254.169.254/ HTTP/1.0\r\n\
+            Accept: application/json\r\n\
+            X-metadata-token-ttl-seconds: -60\r\n\r\n",
+            None,
+        )
+        .unwrap();
         let mut expected_response = Response::new(Version::Http10, StatusCode::BadRequest);
         expected_response.set_content_type(MediaType::PlainText);
         expected_response.set_body(Body::new(
-            "Invalid header. Reason: Invalid value. Key:X-metadata-token-ttl-seconds; \
-             Value:application/json"
+            "Invalid header. Reason: Invalid value. Key:X-metadata-token-ttl-seconds; Value:-60"
                 .to_string(),
         ));
         let actual_response = convert_to_response(mmds.clone(), request);
         assert_eq!(actual_response, expected_response);
 
         // Test PUT requests.
         // Unsupported `X-Forwarded-For` header present.
-        let request_bytes = b"PUT http://169.254.169.254/latest/api/token HTTP/1.0\r\n\
-                                    X-Forwarded-For: 203.0.113.195\r\n\r\n";
-        let request = Request::try_from(request_bytes, None).unwrap();
+        let request = Request::try_from(
+            b"PUT http://169.254.169.254/latest/api/token HTTP/1.0\r\n\
+            X-Forwarded-For: 203.0.113.195\r\n\r\n",
+            None,
+        )
+        .unwrap();
         let mut expected_response = Response::new(Version::Http10, StatusCode::BadRequest);
         expected_response.set_content_type(MediaType::PlainText);
         expected_response.set_body(Body::new(
@@ -605,9 +610,12 @@ mod tests {
         assert_eq!(actual_response, expected_response);
 
         // Test invalid path.
-        let request_bytes = b"PUT http://169.254.169.254/token HTTP/1.0\r\n\
-                                    X-metadata-token-ttl-seconds: 60\r\n\r\n";
-        let request = Request::try_from(request_bytes, None).unwrap();
+        let request = Request::try_from(
+            b"PUT http://169.254.169.254/token HTTP/1.0\r\n\
+            X-metadata-token-ttl-seconds: 60\r\n\r\n",
+            None,
+        )
+        .unwrap();
         let mut expected_response = Response::new(Version::Http10, StatusCode::NotFound);
         expected_response.set_content_type(MediaType::PlainText);
         expected_response.set_body(Body::new(
@@ -619,12 +627,16 @@ mod tests {
         // Test invalid lifetime values for token.
         let invalid_values = [MIN_TOKEN_TTL_SECONDS - 1, MAX_TOKEN_TTL_SECONDS + 1];
         for invalid_value in invalid_values.iter() {
-            let request_bytes = format!(
-                "PUT http://169.254.169.254/latest/api/token \
-                 HTTP/1.0\r\nX-metadata-token-ttl-seconds: {}\r\n\r\n",
-                invalid_value
-            );
-            let request = Request::try_from(request_bytes.as_bytes(), None).unwrap();
+            let request = Request::try_from(
+                format!(
+                    "PUT http://169.254.169.254/latest/api/token HTTP/1.0\r\n\
+                    X-metadata-token-ttl-seconds: {}\r\n\r\n",
+                    invalid_value
+                )
+                .as_bytes(),
+                None,
+            )
+            .unwrap();
             let mut expected_response = Response::new(Version::Http10, StatusCode::BadRequest);
             expected_response.set_content_type(MediaType::PlainText);
             let error_msg = format!(
@@ -638,43 +650,54 @@ mod tests {
         }
 
         // Test no lifetime value provided for token.
-        let request_bytes = b"PUT http://169.254.169.254/latest/api/token HTTP/1.0\r\n\r\n";
-        let request = Request::try_from(request_bytes, None).unwrap();
+        let request = Request::try_from(
+            b"PUT http://169.254.169.254/latest/api/token HTTP/1.0\r\n\r\n",
+            None,
+        )
+        .unwrap();
         let mut expected_response = Response::new(Version::Http10, StatusCode::BadRequest);
         expected_response.set_content_type(MediaType::PlainText);
         expected_response.set_body(Body::new(VmmMmdsError::NoTtlProvided.to_string()));
         let actual_response = convert_to_response(mmds.clone(), request);
         assert_eq!(actual_response, expected_response);
 
         // Test valid PUT.
-        let request_bytes = b"PUT http://169.254.169.254/latest/api/token HTTP/1.0\r\n\
-                                    X-metadata-token-ttl-seconds: 60\r\n\r\n";
-        let request = Request::try_from(request_bytes, None).unwrap();
+        let request = Request::try_from(
+            b"PUT http://169.254.169.254/latest/api/token HTTP/1.0\r\n\
+            X-metadata-token-ttl-seconds: 60\r\n\r\n",
+            None,
+        )
+        .unwrap();
         let actual_response = convert_to_response(mmds.clone(), request);
         assert_eq!(actual_response.status(), StatusCode::OK);
         assert_eq!(actual_response.content_type(), MediaType::PlainText);
 
         // Test valid GET.
         let valid_token = String::from_utf8(actual_response.body().unwrap().body).unwrap();
-        let request_bytes = format!(
-            "GET http://169.254.169.254/ HTTP/1.0\r\nAccept: \
-             application/json\r\nX-metadata-token: {}\r\n\r\n",
-            valid_token
+        let (request, expected_response) = generate_request_and_expected_response(
+            format!(
+                "GET http://169.254.169.254/ HTTP/1.0\r\n\
+                Accept: application/json\r\n\
+                X-metadata-token: {}\r\n\r\n",
+                valid_token
+            )
+            .as_bytes(),
+            MediaType::ApplicationJson,
         );
-        let request = Request::try_from(request_bytes.as_bytes(), None).unwrap();
-        let mut expected_response = Response::new(Version::Http10, StatusCode::OK);
-        let mut body = get_json_data().to_string();
-        body.retain(|c| !c.is_whitespace());
-        expected_response.set_body(Body::new(body));
         let actual_response = convert_to_response(mmds.clone(), request);
         assert_eq!(actual_response, expected_response);
 
         // Test GET request towards unsupported value type.
-        let request_bytes = format!(
-            "GET /age HTTP/1.1\r\nX-metadata-token: {}\r\n\r\n",
-            valid_token
-        );
-        let request = Request::try_from(request_bytes.as_bytes(), None).unwrap();
+        let request = Request::try_from(
+            format!(
+                "GET /age HTTP/1.1\r\n\
+                X-metadata-token: {}\r\n\r\n",
+                valid_token
+            )
+            .as_bytes(),
+            None,
+        )
+        .unwrap();
         let mut expected_response = Response::new(Version::Http11, StatusCode::NotImplemented);
         expected_response.set_content_type(MediaType::PlainText);
         let body = "Cannot retrieve value. The value has an unsupported type.".to_string();
@@ -683,11 +706,16 @@ mod tests {
         assert_eq!(actual_response, expected_response);
 
         // Test GET request towards invalid resource.
-        let request_bytes = format!(
-            "GET http://169.254.169.254/invalid HTTP/1.0\r\nX-metadata-token: {}\r\n\r\n",
-            valid_token
-        );
-        let request = Request::try_from(request_bytes.as_bytes(), None).unwrap();
+        let request = Request::try_from(
+            format!(
+                "GET http://169.254.169.254/invalid HTTP/1.0\r\n\
+                X-metadata-token: {}\r\n\r\n",
+                valid_token
+            )
+            .as_bytes(),
+            None,
+        )
+        .unwrap();
         let mut expected_response = Response::new(Version::Http10, StatusCode::NotFound);
         expected_response.set_content_type(MediaType::PlainText);
         expected_response.set_body(Body::new(
@@ -697,43 +725,41 @@ mod tests {
         assert_eq!(actual_response, expected_response);
 
         // Test GET request without token should return Unauthorized status code.
-        let request_bytes = b"GET http://169.254.169.254/ HTTP/1.0\r\n\r\n";
-        let request = Request::try_from(request_bytes, None).unwrap();
+        let request =
+            Request::try_from(b"GET http://169.254.169.254/ HTTP/1.0\r\n\r\n", None).unwrap();
         let mut expected_response = Response::new(Version::Http10, StatusCode::Unauthorized);
         expected_response.set_content_type(MediaType::PlainText);
         expected_response.set_body(Body::new(VmmMmdsError::NoTokenProvided.to_string()));
         let actual_response = convert_to_response(mmds.clone(), request);
         assert_eq!(actual_response, expected_response);
 
-        // Test GET request with invalid token should return Unauthorized status code.
-        let request_bytes = b"GET http://169.254.169.254/ HTTP/1.0\r\n\
-                                    X-metadata-token: foo\r\n\r\n";
-        let request = Request::try_from(request_bytes, None).unwrap();
-        let mut expected_response = Response::new(Version::Http10, StatusCode::Unauthorized);
-        expected_response.set_content_type(MediaType::PlainText);
-        expected_response.set_body(Body::new(VmmMmdsError::InvalidToken.to_string()));
-        let actual_response = convert_to_response(mmds.clone(), request);
-        assert_eq!(actual_response, expected_response);
-
         // Create a new MMDS token that expires in one second.
-        let request_bytes = b"PUT http://169.254.169.254/latest/api/token HTTP/1.0\r\n\
-                                    X-metadata-token-ttl-seconds: 1\r\n\r\n";
-        let request = Request::try_from(request_bytes, None).unwrap();
+        let request = Request::try_from(
+            b"PUT http://169.254.169.254/latest/api/token HTTP/1.0\r\n\
+            X-metadata-token-ttl-seconds: 1\r\n\r\n",
+            None,
+        )
+        .unwrap();
         let actual_response = convert_to_response(mmds.clone(), request);
         assert_eq!(actual_response.status(), StatusCode::OK);
         assert_eq!(actual_response.content_type(), MediaType::PlainText);
 
         // Test GET request with invalid tokens.
         // `valid_token` will become invalid after one second, when it expires.
         let valid_token = String::from_utf8(actual_response.body().unwrap().body).unwrap();
-        let invalid_token = "a".repeat(58);
-        let tokens = [invalid_token, valid_token];
+        let invalid_token = "INVALID_TOKEN";
+        let tokens = [invalid_token, &valid_token];
         for token in tokens.iter() {
-            let request_bytes = format!(
-                "GET http://169.254.169.254/ HTTP/1.0\r\nX-metadata-token: {}\r\n\r\n",
-                token
-            );
-            let request = Request::try_from(request_bytes.as_bytes(), None).unwrap();
+            let request = Request::try_from(
+                format!(
+                    "GET http://169.254.169.254/ HTTP/1.0\r\n\
+                    X-metadata-token: {}\r\n\r\n",
+                    token
+                )
+                .as_bytes(),
+                None,
+            )
+            .unwrap();
             let mut expected_response = Response::new(Version::Http10, StatusCode::Unauthorized);
             expected_response.set_content_type(MediaType::PlainText);
             expected_response.set_body(Body::new(VmmMmdsError::InvalidToken.to_string()));