chore(server): remove useless comments under server/tests (opensandbox-group#693)

Author: Pangjiping

server/tests/conftest.py

@@ -12,12 +12,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-"""
-Pytest configuration and fixtures for sandbox server tests.
-
-This module provides shared fixtures and configuration for all test modules.
-"""
-
 import os
 from pathlib import Path
 
@@ -40,33 +34,21 @@
 
 @pytest.fixture(scope="session")
 def test_api_key() -> str:
-    """
-    Fixture providing a test API key (matches test configuration file).
-    """
     return "test-api-key-12345"
 
 
 @pytest.fixture(scope="function")
 def client() -> TestClient:
-    """
-    Fixture providing a FastAPI test client.
-    """
     return TestClient(app)
 
 
 @pytest.fixture(scope="function")
 def auth_headers(test_api_key: str) -> dict:
-    """
-    Fixture providing authentication headers.
-    """
     return {"OPEN-SANDBOX-API-KEY": test_api_key}
 
 
 @pytest.fixture(scope="session")
 def sample_sandbox_request() -> dict:
-    """
-    Fixture providing a sample sandbox creation request.
-    """
     return {
         "image": {"uri": "python:3.11"},
         "timeout": 3600,

server/tests/k8s/__init__.py

@@ -12,6 +12,3 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-"""
-Kubernetes runtime unit tests.
-"""

server/tests/k8s/test_agent_sandbox_provider.py

@@ -12,10 +12,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-"""
-Unit tests for AgentSandboxProvider.
-"""
-
 from datetime import datetime, timezone
 from types import SimpleNamespace
 from unittest.mock import MagicMock
@@ -38,7 +34,6 @@
 from opensandbox_server.services.k8s.agent_sandbox_provider import AgentSandboxProvider
 from opensandbox_server.services.constants import OPENSANDBOX_EGRESS_TOKEN
 
-
 def _app_config(
     shutdown_policy: str = "Delete",
     service_account: str | None = None,
@@ -58,24 +53,16 @@ def _app_config(
         egress=egress,
     )
 
-
 class TestAgentSandboxProvider:
-    """AgentSandboxProvider unit tests"""
 
     def test_init_sets_crd_constants_correctly(self, mock_k8s_client):
-        """
-        Test case: Verify CRD constants set correctly
-        """
         provider = AgentSandboxProvider(mock_k8s_client)
 
         assert provider.group == "agents.x-k8s.io"
         assert provider.version == "v1alpha1"
         assert provider.plural == "sandboxes"
 
     def test_create_workload_builds_correct_manifest_init_mode(self, mock_k8s_client):
-        """
-        Test case: Verify created manifest structure with init mode
-        """
         provider = AgentSandboxProvider(
             mock_k8s_client,
             _app_config(shutdown_policy="Delete", service_account="agent-sa"),
@@ -205,9 +192,6 @@ def test_create_workload_rejects_platform_conflict_with_template_node_affinity(
             )
 
     def test_create_workload_sanitizes_resource_name(self, mock_k8s_client):
-        """
-        Test case: Ensure sandbox names are DNS-1035 compliant when IDs start with digits
-        """
         provider = AgentSandboxProvider(mock_k8s_client)
         mock_k8s_client.create_custom_object.return_value = {
             "metadata": {"name": "sandbox-1234", "uid": "test-uid"}
@@ -232,9 +216,6 @@ def test_create_workload_sanitizes_resource_name(self, mock_k8s_client):
         assert body["metadata"]["name"] == "sandbox-1234"
 
     def test_resource_name_uses_hash_when_id_has_no_alnum(self, mock_k8s_client):
-        """
-        Test case: Ensure symbol-only sandbox ids do not collapse to the same name
-        """
         provider = AgentSandboxProvider(mock_k8s_client)
 
         first = provider._resource_name("!!!")
@@ -245,9 +226,6 @@ def test_resource_name_uses_hash_when_id_has_no_alnum(self, mock_k8s_client):
         assert first != second
 
     def test_get_workload_returns_none_on_404(self, mock_k8s_client):
-        """
-        Test case: Verify None returned when not found
-        """
         provider = AgentSandboxProvider(mock_k8s_client)
         mock_k8s_client.get_custom_object.return_value = None
 
@@ -256,9 +234,6 @@ def test_get_workload_returns_none_on_404(self, mock_k8s_client):
         assert result is None
 
     def test_get_workload_prefers_sanitized_name(self, mock_k8s_client):
-        """
-        Test case: Ensure DNS-1035 resource name is tried before raw id
-        """
         provider = AgentSandboxProvider(mock_k8s_client)
         mock_k8s_client.get_custom_object.side_effect = [
             None,
@@ -272,9 +247,6 @@ def test_get_workload_prefers_sanitized_name(self, mock_k8s_client):
         assert mock_k8s_client.get_custom_object.call_args_list[1].kwargs["name"] == "1234"
 
     def test_get_workload_falls_back_to_legacy_name(self, mock_k8s_client):
-        """
-        Test case: Verify legacy sandbox-<id> name is used when primary lookup returns None
-        """
         provider = AgentSandboxProvider(mock_k8s_client)
         mock_k8s_client.get_custom_object.side_effect = [
             None,
@@ -288,9 +260,6 @@ def test_get_workload_falls_back_to_legacy_name(self, mock_k8s_client):
         assert mock_k8s_client.get_custom_object.call_args_list[1].kwargs["name"] == "sandbox-test-id"
 
     def test_get_workload_reraises_non_404_exceptions(self, mock_k8s_client):
-        """
-        Test case: Verify non-404 exceptions are re-raised
-        """
         provider = AgentSandboxProvider(mock_k8s_client)
         mock_k8s_client.get_custom_object.side_effect = ApiException(status=500)
 
@@ -300,9 +269,6 @@ def test_get_workload_reraises_non_404_exceptions(self, mock_k8s_client):
         assert exc_info.value.status == 500
 
     def test_get_workload_prefers_informer_cache(self, mock_k8s_client):
-        """
-        Test case: get_workload calls k8s_client.get_custom_object and returns result
-        """
         cached = {"metadata": {"name": "test-id"}}
         mock_k8s_client.get_custom_object.return_value = cached
 
@@ -314,9 +280,6 @@ def test_get_workload_prefers_informer_cache(self, mock_k8s_client):
         mock_k8s_client.get_custom_object.assert_called()
 
     def test_create_workload_updates_informer_cache(self, mock_k8s_client):
-        """
-        Test case: create_workload returns name and uid from created resource
-        """
         created_body = {"metadata": {"name": "test-id", "uid": "test-uid"}}
         mock_k8s_client.create_custom_object.return_value = created_body
 
@@ -339,9 +302,6 @@ def test_create_workload_updates_informer_cache(self, mock_k8s_client):
         assert result == {"name": "test-id", "uid": "test-uid"}
 
     def test_update_expiration_patches_spec(self, mock_k8s_client):
-        """
-        Test case: Verify expiration time update
-        """
         provider = AgentSandboxProvider(mock_k8s_client)
         mock_k8s_client.get_custom_object.return_value = {"metadata": {"name": "sandbox-test-id"}}
 
@@ -354,9 +314,6 @@ def test_update_expiration_patches_spec(self, mock_k8s_client):
         }
 
     def test_get_expiration_parses_z_suffix(self):
-        """
-        Test case: Verify handling time with Z suffix
-        """
         provider = AgentSandboxProvider(MagicMock())
         workload = {"spec": {"shutdownTime": "2025-12-31T10:00:00Z"}}
 
@@ -365,9 +322,6 @@ def test_get_expiration_parses_z_suffix(self):
         assert result == datetime(2025, 12, 31, 10, 0, 0, tzinfo=timezone.utc)
 
     def test_get_status_ready_condition_true(self):
-        """
-        Test case: Verify Ready True is Running
-        """
         provider = AgentSandboxProvider(MagicMock())
         workload = {
             "status": {
@@ -391,9 +345,6 @@ def test_get_status_ready_condition_true(self):
         assert result["message"] == "Ready"
 
     def test_get_status_expired_condition(self):
-        """
-        Test case: Verify SandboxExpired reason maps to Terminated
-        """
         provider = AgentSandboxProvider(MagicMock())
         workload = {
             "status": {
@@ -416,9 +367,6 @@ def test_get_status_expired_condition(self):
         assert result["reason"] == "SandboxExpired"
 
     def test_get_status_falls_back_to_pod_state(self, mock_k8s_client):
-        """
-        Test case: Verify status fallback uses pod selector state (Running + IP = Running)
-        """
         provider = AgentSandboxProvider(mock_k8s_client)
         mock_k8s_client.list_pods.return_value = [
             SimpleNamespace(
@@ -436,9 +384,6 @@ def test_get_status_falls_back_to_pod_state(self, mock_k8s_client):
         assert result["reason"] == "POD_READY"
 
     def test_get_status_falls_back_to_allocated_when_ip_assigned_not_running(self, mock_k8s_client):
-        """
-        Test case: Verify Allocated state when Pod has IP but is not Running yet
-        """
         provider = AgentSandboxProvider(mock_k8s_client)
         mock_k8s_client.list_pods.return_value = [
             SimpleNamespace(
@@ -597,9 +542,6 @@ def test_get_status_keeps_pending_for_mixed_capacity_and_affinity_message(self,
         assert result["reason"] in {"POD_SCHEDULED", "POD_PENDING"}
 
     def test_get_endpoint_info_prefers_running_pod(self, mock_k8s_client):
-        """
-        Test case: Verify endpoint uses running pod IP
-        """
         provider = AgentSandboxProvider(mock_k8s_client)
         mock_k8s_client.list_pods.return_value = [
             SimpleNamespace(
@@ -617,9 +559,6 @@ def test_get_endpoint_info_prefers_running_pod(self, mock_k8s_client):
         assert endpoint.headers is None
 
     def test_get_endpoint_info_falls_back_to_service_fqdn(self, mock_k8s_client):
-        """
-        Test case: Verify endpoint falls back to serviceFQDN on pod lookup failure
-        """
         provider = AgentSandboxProvider(mock_k8s_client)
         mock_k8s_client.list_pods.side_effect = Exception("boom")
         workload = {
@@ -632,14 +571,10 @@ def test_get_endpoint_info_falls_back_to_service_fqdn(self, mock_k8s_client):
         assert endpoint.endpoint == "svc.example.com:9000"
         assert endpoint.headers is None
 
-
 class TestAgentSandboxProviderExecdInit:
     """AgentSandboxProvider execd init container resource tests"""
 
     def test_init_container_has_no_resources_when_not_configured(self, mock_k8s_client):
-        """
-        Test case: Verify init container has no resources when execd_init_resources is not set
-        """
         provider = AgentSandboxProvider(mock_k8s_client)
         mock_k8s_client.create_custom_object.return_value = {
             "metadata": {"name": "test-id", "uid": "test-uid"}
@@ -663,9 +598,6 @@ def test_init_container_has_no_resources_when_not_configured(self, mock_k8s_clie
         assert "resources" not in init_containers[0]
 
     def test_init_container_has_resources_when_configured(self, mock_k8s_client):
-        """
-        Test case: Verify init container applies resources when execd_init_resources is set
-        """
         provider = AgentSandboxProvider(
             mock_k8s_client,
             _app_config(execd_init_resources=ExecdInitResources(
@@ -694,14 +626,10 @@ def test_init_container_has_resources_when_configured(self, mock_k8s_client):
         assert init_containers[0]["resources"]["limits"] == {"cpu": "100m", "memory": "128Mi"}
         assert init_containers[0]["resources"]["requests"] == {"cpu": "50m", "memory": "64Mi"}
 
-
 class TestAgentSandboxProviderEgress:
     """AgentSandboxProvider egress sidecar tests"""
 
     def test_create_workload_without_network_policy_no_sidecar(self, mock_k8s_client):
-        """
-        Test case: Verify no sidecar is added when network_policy is None
-        """
         provider = AgentSandboxProvider(mock_k8s_client)
         mock_k8s_client.create_custom_object.return_value = {
             "metadata": {"name": "test-id", "uid": "test-uid"}
@@ -734,9 +662,6 @@ def test_create_workload_without_network_policy_no_sidecar(self, mock_k8s_client
         assert "securityContext" not in pod_spec or "sysctls" not in pod_spec.get("securityContext", {})
 
     def test_create_workload_with_network_policy_adds_sidecar(self, mock_k8s_client):
-        """
-        Test case: Verify egress sidecar is added when network_policy is provided
-        """
         provider = AgentSandboxProvider(
             mock_k8s_client,
             _app_config(egress=EgressConfig()),
@@ -932,9 +857,6 @@ def test_create_workload_with_egress_skips_ipv6_disable_when_not_configured(self
         assert "/proc/sys/net/ipv6/conf/all/disable_ipv6" not in execd_init["args"][0]
 
     def test_create_workload_with_network_policy_drops_net_admin_from_main_container(self, mock_k8s_client):
-        """
-        Test case: Verify main container drops NET_ADMIN when network_policy is enabled
-        """
         provider = AgentSandboxProvider(mock_k8s_client)
         mock_k8s_client.create_custom_object.return_value = {
             "metadata": {"name": "test-id", "uid": "test-uid"}
@@ -975,9 +897,6 @@ def test_create_workload_with_network_policy_drops_net_admin_from_main_container
         assert "NET_ADMIN" in main_container["securityContext"]["capabilities"]["drop"]
 
     def test_create_workload_without_egress_image_no_sidecar(self, mock_k8s_client):
-        """
-        Test case: Verify no sidecar is added when egress_image is None even if network_policy exists
-        """
         provider = AgentSandboxProvider(mock_k8s_client)
         mock_k8s_client.create_custom_object.return_value = {
             "metadata": {"name": "test-id", "uid": "test-uid"}
@@ -1012,9 +931,6 @@ def test_create_workload_without_egress_image_no_sidecar(self, mock_k8s_client):
         assert containers[0]["name"] == "sandbox"
 
     def test_egress_sidecar_contains_network_policy_in_env(self, mock_k8s_client):
-        """
-        Test case: Verify sidecar environment variable contains serialized network policy
-        """
         provider = AgentSandboxProvider(mock_k8s_client)
         mock_k8s_client.create_custom_object.return_value = {
             "metadata": {"name": "test-id", "uid": "test-uid"}
@@ -1062,9 +978,6 @@ def test_egress_sidecar_contains_network_policy_in_env(self, mock_k8s_client):
         assert policy_json["egress"][0]["target"] == "pypi.org"
 
     def test_main_container_no_security_context_without_network_policy(self, mock_k8s_client):
-        """
-        Test case: Verify main container has no securityContext when network_policy is None
-        """
         provider = AgentSandboxProvider(mock_k8s_client)
         mock_k8s_client.create_custom_object.return_value = {
             "metadata": {"name": "test-id", "uid": "test-uid"}