api: make ht_enabled optional

Signed-off-by: alindima <[email protected]>

Author: alindima

CHANGELOG.md

@@ -58,6 +58,8 @@
   by adding the network interface's ID to the `network_interfaces` field of PUT
   `/mmds/config` request's body.
 - Configuring `ht_enabled: true` on aarch64 via the API is forbidden.
+- `ht_enabled` field is now optional on PUT `/machine-config`, defaulting to
+  `false`.
 
 ### Fixed
 

docs/getting-started.md

@@ -216,8 +216,7 @@ curl --unix-socket /tmp/firecracker.socket -i  \
   -H 'Content-Type: application/json'      \
   -d '{
       "vcpu_count": 2,
-      "mem_size_mib": 1024,
-      "ht_enabled": false
+      "mem_size_mib": 1024
   }'
 ```
 

src/api_server/src/parsed_request.rs

@@ -788,8 +788,7 @@ pub(crate) mod tests {
         let mut connection = HttpConnection::new(receiver);
         let body = "{ \
             \"vcpu_count\": 0, \
-            \"mem_size_mib\": 0, \
-            \"ht_enabled\": false \
+            \"mem_size_mib\": 0 \
         }";
         sender
             .write_all(http_request("PUT", "/machine-config", Some(&body)).as_bytes())
@@ -1009,8 +1008,7 @@ pub(crate) mod tests {
         let mut connection = HttpConnection::new(receiver);
         let body = "{ \
             \"vcpu_count\": 0, \
-            \"mem_size_mib\": 0, \
-            \"ht_enabled\": false \
+            \"mem_size_mib\": 0 \
         }";
         sender
             .write_all(http_request("PATCH", "/machine-config", Some(&body)).as_bytes())

src/api_server/src/request/machine_configuration.rs

@@ -22,13 +22,17 @@ pub(crate) fn parse_put_machine_config(body: &Body) -> Result<ParsedRequest, Err
     #[cfg(target_arch = "aarch64")]
     check_unsupported_fields(&vm_config)?;
 
-    if vm_config.vcpu_count.is_none()
-        || vm_config.mem_size_mib.is_none()
-        || vm_config.ht_enabled.is_none()
-    {
+    if vm_config.vcpu_count.is_none() {
+        return Err(Error::Generic(
+            StatusCode::BadRequest,
+            "Missing mandatory field: `vcpu_count`.".to_string(),
+        ));
+    }
+
+    if vm_config.mem_size_mib.is_none() {
         return Err(Error::Generic(
             StatusCode::BadRequest,
-            "Missing mandatory fields.".to_string(),
+            "Missing mandatory field: `mem_size_mib`.".to_string(),
         ));
     }
 
@@ -99,30 +103,39 @@ mod tests {
 
         // 2. Test case for mandatory fields.
         let body = r#"{
-                "mem_size_mib": 1024,
-                "ht_enabled": false
+                "mem_size_mib": 1024
               }"#;
         assert!(parse_put_machine_config(&Body::new(body)).is_err());
 
         let body = r#"{
-                "vcpu_count": 8,
-                "ht_enabled": false
+                "vcpu_count": 8
                 }"#;
         assert!(parse_put_machine_config(&Body::new(body)).is_err());
 
+        // 3. Test case for success scenarios for both architectures.
         let body = r#"{
                 "vcpu_count": 8,
                 "mem_size_mib": 1024
               }"#;
-        assert!(parse_put_machine_config(&Body::new(body)).is_err());
+        let expected_config = VmConfig {
+            vcpu_count: Some(8),
+            mem_size_mib: Some(1024),
+            ht_enabled: None,
+            cpu_template: None,
+            track_dirty_pages: false,
+        };
+
+        match vmm_action_from_request(parse_put_machine_config(&Body::new(body)).unwrap()) {
+            VmmAction::SetVmConfiguration(config) => assert_eq!(config, expected_config),
+            _ => panic!("Test failed."),
+        }
 
-        // 3. Test case a success scenario for both architectures.
         let body = r#"{
                 "vcpu_count": 8,
                 "mem_size_mib": 1024,
                 "ht_enabled": false,
                 "track_dirty_pages": true
-              }"#;
+            }"#;
         let expected_config = VmConfig {
             vcpu_count: Some(8),
             mem_size_mib: Some(1024),

src/api_server/swagger/firecracker.yaml

@@ -928,7 +928,6 @@ definitions:
       Describes the number of vCPUs, memory size, Hyperthreading capabilities and
       the CPU template.
     required:
-      - ht_enabled
       - mem_size_mib
       - vcpu_count
     properties:

src/vmm/src/resources.rs

@@ -609,8 +609,7 @@ mod tests {
                     ],
                     "machine-config": {{
                         "vcpu_count": 0,
-                        "mem_size_mib": 1024,
-                        "ht_enabled": false
+                        "mem_size_mib": 1024
                     }}
             }}"#,
             kernel_file.as_path().to_str().unwrap(),
@@ -639,8 +638,7 @@ mod tests {
                     ],
                     "machine-config": {{
                         "vcpu_count": 2,
-                        "mem_size_mib": 0,
-                        "ht_enabled": false
+                        "mem_size_mib": 0
                     }}
             }}"#,
             kernel_file.as_path().to_str().unwrap(),

tests/framework/builder.py

@@ -152,7 +152,7 @@ def build(self,
         response = vm.machine_cfg.put(
             vcpu_count=int(microvm_config['vcpu_count']),
             mem_size_mib=int(microvm_config['mem_size_mib']),
-            ht_enabled=bool(microvm_config['ht_enabled']),
+            ht_enabled=microvm_config['ht_enabled'],
             track_dirty_pages=diff_snapshots,
             cpu_template=cpu_template,
         )

tests/framework/microvm.py

@@ -634,7 +634,7 @@ def serial_input(self, input_string):
     def basic_config(
         self,
         vcpu_count: int = 2,
-        ht_enabled: bool = False,
+        ht_enabled: bool = None,
         mem_size_mib: int = 256,
         add_root_device: bool = True,
         boot_args: str = None,

tests/integration_tests/functional/test_api.py

@@ -426,6 +426,33 @@ def test_api_machine_config(test_microvm_with_api):
     )
     assert test_microvm.api_session.is_status_bad_request(response.status_code)
 
+    # Test missing vcpu_count.
+    response = test_microvm.machine_cfg.put(
+        mem_size_mib=128
+    )
+    assert test_microvm.api_session.is_status_bad_request(response.status_code)
+    assert "Missing mandatory field: `vcpu_count`." in response.text
+
+    # Test missing mem_size_mib.
+    response = test_microvm.machine_cfg.put(
+        vcpu_count=2
+    )
+    assert test_microvm.api_session.is_status_bad_request(response.status_code)
+    assert "Missing mandatory field: `mem_size_mib`." in response.text
+
+    # Test default ht_enabled value.
+    response = test_microvm.machine_cfg.put(
+        mem_size_mib=128,
+        vcpu_count=1
+    )
+    assert test_microvm.api_session.is_status_no_content(
+        response.status_code
+    )
+
+    response = test_microvm.machine_cfg.get()
+    assert test_microvm.api_session.is_status_ok(response.status_code)
+    assert response.json()["ht_enabled"] is False
+
     # Test that ht_enabled=True errors on ARM.
     response = test_microvm.machine_cfg.patch(
         ht_enabled=True
@@ -520,8 +547,11 @@ def test_api_machine_config(test_microvm_with_api):
     # Validate full vm configuration after patching machine config.
     response = test_microvm.full_cfg.get()
     assert test_microvm.api_session.is_status_ok(response.status_code)
-    assert response.json()['machine-config']['vcpu_count'] == 2
-    assert response.json()['machine-config']['mem_size_mib'] == 256
+    json = response.json()
+    assert json['machine-config']['vcpu_count'] == 2
+    assert json['machine-config']['mem_size_mib'] == 256
+    assert json['machine-config']['ht_enabled'] == (
+        platform.machine() == "x86_64")
 
 
 def test_api_put_update_post_boot(test_microvm_with_api):
@@ -570,7 +600,6 @@ def test_api_put_update_post_boot(test_microvm_with_api):
 
     response = test_microvm.machine_cfg.put(
         vcpu_count=4,
-        ht_enabled=False,
         mem_size_mib=128
     )
     assert test_microvm.api_session.is_status_bad_request(response.status_code)

tests/integration_tests/functional/test_cpu_features.py

@@ -165,7 +165,6 @@ def test_cpu_template(test_microvm_with_api, network_config, cpu_template):
     response = test_microvm.machine_cfg.put(
         vcpu_count=1,
         mem_size_mib=256,
-        ht_enabled=False,
         cpu_template=cpu_template,
     )
     assert test_microvm.api_session.is_status_no_content(response.status_code)