test: remove @type tags

As far as I can tell they don't serve any purpose, and the information
can be derived from the test filename.

Signed-off-by: Pablo Barbáchano <[email protected]>

Author: pb8o

tests/integration_tests/build/test_binary_size.py

@@ -37,8 +37,6 @@
 def test_firecracker_binary_size(record_property, metrics):
     """
     Test if the size of the firecracker binary is within expected ranges.
-
-    @type: build
     """
     fc_binary, _ = host.get_firecracker_binaries()
 
@@ -61,8 +59,6 @@ def test_firecracker_binary_size(record_property, metrics):
 def test_jailer_binary_size(record_property, metrics):
     """
     Test if the size of the jailer binary is within expected ranges.
-
-    @type: build
     """
     _, jailer_binary = host.get_firecracker_binaries()
 

tests/integration_tests/build/test_clippy.py

@@ -21,7 +21,5 @@
 def test_rust_clippy(target):
     """
     Test that clippy does not generate any errors/warnings.
-
-    @type: build
     """
     cargo("clippy", f"--target {target} --all --profile test", "-D warnings")

tests/integration_tests/build/test_coverage.py

@@ -58,8 +58,6 @@ def is_on_skylake():
 @pytest.mark.timeout(600)
 def test_coverage(monkeypatch, record_property, metrics):
     """Test code coverage
-
-    @type: build
     """
     # Get coverage target.
     processor_model = [item for item in COVERAGE_DICT if item in PROC_MODEL]

tests/integration_tests/build/test_dependencies.py

@@ -19,8 +19,6 @@ def test_licenses():
 
     For a list of currently allowed licenses checkout deny.toml in
     the root directory.
-
-    @type: build
     """
     toml_file = os.path.normpath(
         os.path.join(os.path.dirname(os.path.realpath(__file__)), "../../../Cargo.toml")

tests/integration_tests/build/test_unittests.py

@@ -16,8 +16,6 @@
 def test_unittests(test_fc_session_root_path):
     """
     Run unit and doc tests for all supported targets.
-
-    @type: build
     """
     extra_args = "--release --target {} ".format(TARGET)
 

tests/integration_tests/functional/test_api.py

@@ -25,8 +25,6 @@
 def test_api_happy_start(test_microvm_with_api):
     """
     Test that a regular microvm API config and boot sequence works.
-
-    @type: functional
     """
     test_microvm = test_microvm_with_api
     test_microvm.spawn()
@@ -44,8 +42,6 @@ def test_drive_io_engine(test_microvm_with_api, network_config):
 
     Test that the io_engine can be configured via the API on kernels that
     support the given type and that FC returns an error otherwise.
-
-    @type: functional
     """
     test_microvm = test_microvm_with_api
     test_microvm.spawn()
@@ -97,8 +93,6 @@ def test_api_put_update_pre_boot(test_microvm_with_api):
     Test that PUT updates are allowed before the microvm boots.
 
     Tests updates on drives, boot source and machine config.
-
-    @type: functional
     """
     test_microvm = test_microvm_with_api
     test_microvm.spawn()
@@ -214,8 +208,6 @@ def test_api_put_update_pre_boot(test_microvm_with_api):
 def test_net_api_put_update_pre_boot(test_microvm_with_api):
     """
     Test PUT updates on network configurations before the microvm boots.
-
-    @type: functional
     """
     test_microvm = test_microvm_with_api
     test_microvm.spawn()
@@ -272,8 +264,6 @@ def test_api_mmds_config(test_microvm_with_api):
     Test /mmds/config PUT scenarios that unit tests can't cover.
 
     Tests updates on MMDS config before and after attaching a network device.
-
-    @type: negative
     """
     test_microvm = test_microvm_with_api
     test_microvm.spawn()
@@ -360,8 +350,6 @@ def test_api_mmds_config(test_microvm_with_api):
 def test_api_machine_config(test_microvm_with_api):
     """
     Test /machine_config PUT/PATCH scenarios that unit tests can't cover.
-
-    @type: functional
     """
     test_microvm = test_microvm_with_api
     test_microvm.spawn()
@@ -489,8 +477,6 @@ def test_api_machine_config(test_microvm_with_api):
 def test_api_cpu_config(test_microvm_with_api, custom_cpu_template):
     """
     Test /cpu-config PUT scenarios.
-
-    @type: functional
     """
     test_microvm = test_microvm_with_api
     test_microvm.spawn()
@@ -505,8 +491,6 @@ def test_api_cpu_config(test_microvm_with_api, custom_cpu_template):
 def test_api_put_update_post_boot(test_microvm_with_api):
     """
     Test that PUT updates are rejected after the microvm boots.
-
-    @type: negative
     """
     test_microvm = test_microvm_with_api
     test_microvm.spawn()
@@ -576,8 +560,6 @@ def test_api_put_update_post_boot(test_microvm_with_api):
 def test_rate_limiters_api_config(test_microvm_with_api):
     """
     Test the IO rate limiter API config.
-
-    @type: functional
     """
     test_microvm = test_microvm_with_api
     test_microvm.spawn()
@@ -690,8 +672,6 @@ def test_rate_limiters_api_config(test_microvm_with_api):
 def test_api_patch_pre_boot(test_microvm_with_api):
     """
     Test that PATCH updates are not allowed before the microvm boots.
-
-    @type: negative
     """
     test_microvm = test_microvm_with_api
     test_microvm.spawn()
@@ -754,8 +734,6 @@ def test_api_patch_pre_boot(test_microvm_with_api):
 def test_negative_api_patch_post_boot(test_microvm_with_api):
     """
     Test PATCH updates that are not allowed after the microvm boots.
-
-    @type: negative
     """
     test_microvm = test_microvm_with_api
     test_microvm.spawn()
@@ -805,8 +783,6 @@ def test_negative_api_patch_post_boot(test_microvm_with_api):
 def test_drive_patch(test_microvm_with_api):
     """
     Extensively test drive PATCH scenarios before and after boot.
-
-    @type: functional
     """
     test_microvm = test_microvm_with_api
     test_microvm.spawn()
@@ -845,8 +821,6 @@ def test_drive_patch(test_microvm_with_api):
 def test_send_ctrl_alt_del(test_microvm_with_api):
     """
     Test shutting down the microVM gracefully on x86, by sending CTRL+ALT+DEL.
-
-    @type: functional
     """
     # This relies on the i8042 device and AT Keyboard support being present in
     # the guest kernel.
@@ -993,8 +967,6 @@ def _drive_patch(test_microvm):
 def test_api_version(test_microvm_with_api):
     """
     Test the permanent VM version endpoint.
-
-    @type: functional
     """
     test_microvm = test_microvm_with_api
     test_microvm.spawn()
@@ -1029,8 +1001,6 @@ def test_api_version(test_microvm_with_api):
 def test_api_vsock(bin_cloner_path):
     """
     Test vsock related API commands.
-
-    @type: functional
     """
     builder = MicrovmBuilder(bin_cloner_path)
     # Test with the current build.
@@ -1094,8 +1064,6 @@ def test_api_entropy(test_microvm_with_api):
 def test_api_balloon(test_microvm_with_api):
     """
     Test balloon related API commands.
-
-    @type: functional
     """
     test_microvm = test_microvm_with_api
     test_microvm.spawn()
@@ -1180,8 +1148,6 @@ def test_api_balloon(test_microvm_with_api):
 def test_get_full_config_after_restoring_snapshot(bin_cloner_path):
     """
     Test the configuration of a microVM after restoring from a snapshot.
-
-    @type: functional
     """
     microvm_builder = MicrovmBuilder(bin_cloner_path)
     net_iface = NetIfaceConfig()
@@ -1313,8 +1279,6 @@ def test_get_full_config_after_restoring_snapshot(bin_cloner_path):
 def test_get_full_config(test_microvm_with_api):
     """
     Test the reported configuration of a microVM configured with all resources.
-
-    @type: functional
     """
     test_microvm = test_microvm_with_api
 
@@ -1428,8 +1392,6 @@ def test_map_private_seccomp_regression(test_microvm_with_api):
     When sending large buffer to an api endpoint there will be an attempt to
     call mmap with MAP_PRIVATE|MAP_ANONYMOUS. This would result in vmm being
     killed by the seccomp filter before this PR.
-
-    @type: regression
     """
     test_microvm = test_microvm_with_api
     test_microvm.jailer.extra_args.update(
@@ -1452,8 +1414,6 @@ def test_map_private_seccomp_regression(test_microvm_with_api):
 def test_negative_snapshot_load_api(microvm_factory):
     """
     Test snapshot load API.
-
-    @type: negative
     """
     vm = microvm_factory.build()
     vm.spawn()

tests/integration_tests/functional/test_api_server.py

@@ -15,8 +15,6 @@ def test_api_socket_in_use(test_microvm_with_api):
     start due to the socket being left open from previous runs.
     Check that the error message is a fixed one and that it also
     contains the name of the path.
-
-    @type: functional
     """
     microvm = test_microvm_with_api
 

tests/integration_tests/functional/test_balloon.py

@@ -100,8 +100,6 @@ def _test_rss_memory_lower(test_microvm):
 def test_rss_memory_lower(test_microvm_with_api, network_config):
     """
     Test that inflating the balloon makes guest use less rss memory.
-
-    @type: functional
     """
     test_microvm = test_microvm_with_api
     test_microvm.spawn()
@@ -124,8 +122,6 @@ def test_rss_memory_lower(test_microvm_with_api, network_config):
 def test_inflate_reduces_free(test_microvm_with_api, network_config):
     """
     Check that the output of free in guest changes with inflate.
-
-    @type: functional
     """
     test_microvm = test_microvm_with_api
     test_microvm.spawn()
@@ -165,8 +161,6 @@ def test_inflate_reduces_free(test_microvm_with_api, network_config):
 def test_deflate_on_oom_true(test_microvm_with_api, network_config):
     """
     Verify that setting the `deflate_on_oom` to True works correctly.
-
-    @type: functional
     """
     test_microvm = test_microvm_with_api
     test_microvm.spawn()
@@ -210,8 +204,6 @@ def test_deflate_on_oom_true(test_microvm_with_api, network_config):
 def test_deflate_on_oom_false(test_microvm_with_api, network_config):
     """
     Verify that setting the `deflate_on_oom` to False works correctly.
-
-    @type: functional
     """
     test_microvm = test_microvm_with_api
     test_microvm.spawn()
@@ -252,8 +244,6 @@ def test_deflate_on_oom_false(test_microvm_with_api, network_config):
 def test_reinflate_balloon(test_microvm_with_api, network_config):
     """
     Verify that repeatedly inflating and deflating the balloon works.
-
-    @type: functional
     """
     test_microvm = test_microvm_with_api
     test_microvm.spawn()
@@ -322,8 +312,6 @@ def test_reinflate_balloon(test_microvm_with_api, network_config):
 def test_size_reduction(test_microvm_with_api, network_config):
     """
     Verify that ballooning reduces RSS usage on a newly booted guest.
-
-    @type: functional
     """
     test_microvm = test_microvm_with_api
     test_microvm.spawn()
@@ -371,8 +359,6 @@ def test_size_reduction(test_microvm_with_api, network_config):
 def test_stats(test_microvm_with_api, network_config):
     """
     Verify that balloon stats work as expected.
-
-    @type: functional
     """
     test_microvm = test_microvm_with_api
     test_microvm.spawn()
@@ -437,8 +423,6 @@ def test_stats(test_microvm_with_api, network_config):
 def test_stats_update(test_microvm_with_api, network_config):
     """
     Verify that balloon stats update correctly.
-
-    @type: functional
     """
     test_microvm = test_microvm_with_api
     test_microvm.spawn()
@@ -494,8 +478,6 @@ def test_stats_update(test_microvm_with_api, network_config):
 def test_balloon_snapshot(bin_cloner_path, microvm_factory, guest_kernel, rootfs):
     """
     Test that the balloon works after pause/resume.
-
-    @type: functional
     """
     logger = logging.getLogger("snapshot_sequence")
     snapshot_type = SnapshotType.FULL
@@ -600,8 +582,6 @@ def test_balloon_snapshot(bin_cloner_path, microvm_factory, guest_kernel, rootfs
 def test_snapshot_compatibility(microvm_factory, guest_kernel, rootfs):
     """
     Test that the balloon serializes correctly.
-
-    @type: functional
     """
     logger = logging.getLogger("snapshot_compatibility")
     snapshot_type = SnapshotType.FULL
@@ -653,8 +633,6 @@ def test_snapshot_compatibility(microvm_factory, guest_kernel, rootfs):
 def test_memory_scrub(microvm_factory, guest_kernel, rootfs, network_config):
     """
     Test that the memory is zeroed after deflate.
-
-    @type: functional
     """
     microvm = microvm_factory.build(guest_kernel, rootfs)
     microvm.spawn()

tests/integration_tests/functional/test_cmd_line_parameters.py

@@ -18,8 +18,6 @@ def test_describe_snapshot_all_versions(bin_cloner_path, firecracker_release):
 
     For each release create a snapshot and verify the data version of the
     snapshot state file.
-
-    @type: functional
     """
     logger = logging.getLogger("describe_snapshot")
     builder = MicrovmBuilder(bin_cloner_path)
@@ -70,8 +68,6 @@ def test_describe_snapshot_all_versions(bin_cloner_path, firecracker_release):
 def test_cli_metrics_path(test_microvm_with_api):
     """
     Test --metrics-path parameter
-
-    @type: functional
     """
     microvm = test_microvm_with_api
     metrics_fifo_path = Path(microvm.path) / "metrics_ndjson.fifo"
@@ -116,8 +112,6 @@ def test_cli_metrics_path_if_metrics_initialized_twice_fail(test_microvm_with_ap
     Given: a running firecracker with metrics configured with the CLI option
     When: Configure metrics via API
     Then: API returns an error
-
-    @type: functional
     """
     microvm = test_microvm_with_api
 
@@ -143,8 +137,6 @@ def test_cli_metrics_path_if_metrics_initialized_twice_fail(test_microvm_with_ap
 def test_cli_metrics_if_resume_no_metrics(test_microvm_with_api, microvm_factory):
     """
     Check that metrics configuration is not part of the snapshot
-
-    @type: functional
     """
     # Given: a snapshot of a FC with metrics configured with the CLI option
     uvm1 = test_microvm_with_api