diff --git a/tests/integration/cli/test_args.py b/tests/integration/cli/test_args.py index 6d4ecc969..2e416be38 100644 --- a/tests/integration/cli/test_args.py +++ b/tests/integration/cli/test_args.py @@ -2,6 +2,7 @@ from linodecli.exit_codes import ExitCodes from tests.integration.helpers import ( + Capability, exec_failing_test_command, exec_test_command, get_random_region_with_caps, @@ -11,7 +12,7 @@ def test_arg_raw_body(): label = get_random_text(12) - region = get_random_region_with_caps(["VPCs"]) + region = get_random_region_with_caps([Capability.VPCs]) res = json.loads( exec_test_command( @@ -40,7 +41,7 @@ def test_arg_raw_body(): def test_arg_raw_body_conflict(): label = get_random_text(12) - region = get_random_region_with_caps(["VPCs"]) + region = get_random_region_with_caps([Capability.VPCs]) res = exec_failing_test_command( [ diff --git a/tests/integration/conftest.py b/tests/integration/conftest.py index dde6f9e6d..1fb201bb3 100644 --- a/tests/integration/conftest.py +++ b/tests/integration/conftest.py @@ -19,6 +19,7 @@ from linodecli import ENV_TOKEN_NAME from tests.integration.helpers import ( DEFAULT_REGION, + Capability, check_attribute_value, delete_target_id, exec_test_command, @@ -215,7 +216,9 @@ def create_vpc_w_subnet(): See: https://github.com/pytest-dev/pytest/issues/1216 """ - region = get_random_region_with_caps(required_capabilities=["VPCs"]) + region = get_random_region_with_caps( + required_capabilities=[Capability.VPCs] + ) vpc_label = get_random_text(5) + "label" subnet_label = get_random_text(5) + "label" diff --git a/tests/integration/helpers.py b/tests/integration/helpers.py index 84dbc1720..94e121d7f 100644 --- a/tests/integration/helpers.py +++ b/tests/integration/helpers.py @@ -4,6 +4,7 @@ import re import subprocess import time +from enum import Enum from string import ascii_lowercase from typing import Callable, Container, Iterable, List, TypeVar @@ -64,6 +65,93 @@ BASE_CMDS = {module: ["linode-cli", module] for module in MODULES} +class StrEnum(str, Enum): + """ + Used for enums that are of type string. + + This class is a compatibility workaround for older Python versions + where built-in enum.StrEnum is not available yet + + NOTE: Replace this with StrEnum once Python 3.10 has been EOL'd. + See: https://docs.python.org/3/library/enum.html#enum.StrEnum + """ + + def __new__(cls, *values): + value = str(*values) + member = str.__new__(cls, value) + member._value_ = value + return member + + def __str__(self): + return self._value_ + + +class Capability(StrEnum): + """ + An enum class that represents the capabilities that Linode offers + across different regions and services. + + These capabilities indicate what services are available in each data center. + """ + + Linodes = "Linodes" + NodeBalancers = "NodeBalancers" + BlockStorage = "Block Storage" + ObjectStorage = "Object Storage" + ObjectStorageRegions = "Object Storage Access Key Regions" + ObjectStorageEndpointTypes = "Object Storage Endpoint Types" + Kubernetes = "Kubernetes" + LKEHAControlPlanes = "LKE HA Control Planes" + KubernetesEnterprise = "Kubernetes Enterprise" + CloudFirewall = "Cloud Firewall" + GPULinodes = "GPU Linodes" + VLANs = "Vlans" + VPCs = "VPCs" + VPCsExtra = "VPCs Extra" + MachineImages = "Machine Images" + ManagedDatabases = "Managed Databases" + ManagedDatabasesBeta = "Managed Databases Beta" + BlockStorageMigrations = "Block Storage Migrations" + Metadata = "Metadata" + PremiumPlans = "Premium Plans" + EdgePlans = "Edge Plans" + DistributedPlans = "Distributed Plans" + LKEControlPlaneACL = "LKE Network Access Control List (IP ACL)" + AkamaiCloudLoadBalancer = "Akamai Cloud Load Balancer" + SupportTicketSeverity = "Support Ticket Severity" + SupportLiveChat = "Support Live Chat" + Backups = "Backups" + PlacementGroup = "Placement Group" + DiskEncryption = "Disk Encryption" + LADiskEncryption = "LA Disk Encryption" + AkamaiRAMProtection = "Akamai RAM Protection" + BlockStorageEncryption = "Block Storage Encryption" + BlockStoragePerformanceB1 = "Block Storage Performance B1" + BlockStoragePerformanceB1Default = "Block Storage Performance B1 Default" + AkamaiCloudPulse = "Akamai Cloud Pulse" + AkamaiCloudPulseLogs = "Akamai Cloud Pulse Logs" + AkamaiCloudPulseLogsLKEEAudit = "Akamai Cloud Pulse Logs LKE-E Audit" + ACLPLogsDatacenterLKEE = "ACLP Logs Datacenter LKE-E" + SMTPEnabled = "SMTP Enabled" + StackScripts = "StackScripts" + NETINTQuadraT1U = "NETINT Quadra T1U" + LinodeInterfaces = "Linode Interfaces" + MaintenancePolicy = "Maintenance Policy" + VPCDualStack = "VPC Dual Stack" + VPCIPv6Stack = "VPC IPv6 Stack" + CustomVPCIPv4Ranges = "Custom VPC IPv4 Ranges" + NetworkLoadBalancer = "Network LoadBalancer" + NATGateway = "NAT Gateway" + KubernetesEnterpriseBYOVPC = "Kubernetes Enterprise BYO VPC" + KubernetesEnterpriseDualStack = "Kubernetes Enterprise Dual Stack" + CloudFirewallRuleSet = "Cloud Firewall Rule Set" + CloudFirewallPrefixLists = "Cloud Firewall Prefix Lists" + CloudFirewallPrefixListCurrentReferences = ( + "Cloud Firewall Prefix List Current References" + ) + GPUDirectRDMA = "GPUDirect RDMA" + + def get_random_text(length: int = 10): return "".join(random.choice(ascii_lowercase) for _ in range(length)) @@ -196,7 +284,7 @@ def retry_exec_test_command_with_delay( def get_random_region_with_caps( - required_capabilities: List[str], site_type="core" + required_capabilities: List[Capability], site_type: str = "core" ): json_regions_data = exec_test_command( ["linode-cli", "regions", "ls", "--json"] diff --git a/tests/integration/linodes/fixtures.py b/tests/integration/linodes/fixtures.py index 7542ae47d..d058d0a0c 100644 --- a/tests/integration/linodes/fixtures.py +++ b/tests/integration/linodes/fixtures.py @@ -6,6 +6,7 @@ from tests.integration.helpers import ( BASE_CMDS, DEFAULT_REGION, + Capability, delete_target_id, exec_test_command, get_random_region_with_caps, @@ -113,7 +114,7 @@ def snapshot_of_linode(linode_cloud_firewall): # Configs TEST_REGION = get_random_region_with_caps( - required_capabilities=["Linodes", "VPCs"] + required_capabilities=[Capability.Linodes, Capability.VPCs] ) @@ -250,7 +251,9 @@ def create_vpc_w_subnet(): # Disks @pytest.fixture(scope="module") def linode_instance_disk_tests(linode_cloud_firewall): - test_region = get_random_region_with_caps(required_capabilities=["Linodes"]) + test_region = get_random_region_with_caps( + required_capabilities=[Capability.Linodes] + ) linode_id = create_linode_and_wait( firewall_id=linode_cloud_firewall, disk_encryption=False, @@ -530,7 +533,10 @@ def linode_in_running_state_for_reboot(linode_cloud_firewall): @pytest.fixture(scope="module") def linode_for_rebuild_tests(linode_cloud_firewall): test_region = get_random_region_with_caps( - required_capabilities=["Linodes", "Disk Encryption"] + required_capabilities=[ + Capability.Linodes, + Capability.DiskEncryption, + ] ) linode_id = create_linode_and_wait( firewall_id=linode_cloud_firewall, @@ -666,7 +672,10 @@ def linode_with_label(linode_cloud_firewall): def linode_with_authorization_key(linode_cloud_firewall): label = "cli" + get_random_text(5) test_region = get_random_region_with_caps( - required_capabilities=["Linodes", "Disk Encryption"] + required_capabilities=[ + Capability.Linodes, + Capability.DiskEncryption, + ] ) result = exec_test_command( BASE_CMDS["linodes"] diff --git a/tests/integration/linodes/test_linodes.py b/tests/integration/linodes/test_linodes.py index 4bbb70bef..104038689 100644 --- a/tests/integration/linodes/test_linodes.py +++ b/tests/integration/linodes/test_linodes.py @@ -6,6 +6,7 @@ from linodecli.exit_codes import ExitCodes from tests.integration.helpers import ( BASE_CMDS, + Capability, assert_headers_in_lines, delete_target_id, exec_failing_test_command, @@ -49,7 +50,10 @@ def test_create_linodes_with_a_label(linode_with_label): def test_expected_error_if_fields_authorized_users_authorized_keys_root_pass_are_not_set(): test_region = get_random_region_with_caps( - required_capabilities=["Linodes", "Disk Encryption"] + required_capabilities=[ + Capability.Linodes, + Capability.DiskEncryption, + ] ) result = exec_failing_test_command( BASE_CMDS["linodes"] @@ -265,7 +269,10 @@ def test_disk_view(test_linode_instance): def test_create_linode_disk_encryption_enabled(linode_cloud_firewall): test_region = get_random_region_with_caps( - required_capabilities=["Linodes", "Disk Encryption"] + required_capabilities=[ + Capability.Linodes, + Capability.DiskEncryption, + ] ) linode_id = create_linode( firewall_id=linode_cloud_firewall, @@ -294,7 +301,10 @@ def test_create_linode_disk_encryption_enabled(linode_cloud_firewall): def test_create_linode_disk_encryption_disabled(linode_cloud_firewall): test_region = get_random_region_with_caps( - required_capabilities=["Linodes", "Disk Encryption"] + required_capabilities=[ + Capability.Linodes, + Capability.DiskEncryption, + ] ) linode_id = create_linode( diff --git a/tests/integration/lke/fixtures.py b/tests/integration/lke/fixtures.py index 6b2c285ad..983ae06ae 100644 --- a/tests/integration/lke/fixtures.py +++ b/tests/integration/lke/fixtures.py @@ -2,6 +2,7 @@ from tests.integration.helpers import ( BASE_CMDS, + Capability, delete_target_id, exec_test_command, get_random_region_with_caps, @@ -15,7 +16,7 @@ def lke_cluster(): label = get_random_text(8) + "_cluster" test_region = get_random_region_with_caps( - required_capabilities=["Linodes", "Kubernetes"] + required_capabilities=[Capability.Linodes, Capability.Kubernetes] ) lke_version = exec_test_command( BASE_CMDS["lke"] @@ -90,7 +91,7 @@ def lke_cluster_acl(): label = get_random_text(8) + "_cluster" test_region = get_random_region_with_caps( - required_capabilities=["Linodes", "Kubernetes"] + required_capabilities=[Capability.Linodes, Capability.Kubernetes] ) lke_version = exec_test_command( BASE_CMDS["lke"] diff --git a/tests/integration/lke/test_clusters.py b/tests/integration/lke/test_clusters.py index f19de192d..64c83b17e 100644 --- a/tests/integration/lke/test_clusters.py +++ b/tests/integration/lke/test_clusters.py @@ -4,6 +4,7 @@ from tests.integration.helpers import ( BASE_CMDS, + Capability, assert_headers_in_lines, delete_target_id, exec_test_command, @@ -25,7 +26,7 @@ def test_deploy_an_lke_cluster(): label = get_random_text(8) + "_cluster" test_region = get_random_region_with_caps( - required_capabilities=["Linodes", "Kubernetes"] + required_capabilities=[Capability.Linodes, Capability.Kubernetes] ) lke_version = exec_test_command( BASE_CMDS["lke"] @@ -393,7 +394,7 @@ def test_create_cluster_with_apl_enabled(monkeypatch): label = get_random_text(8) + "_apl_enabled_cluster" test_region = get_random_region_with_caps( - required_capabilities=["Linodes", "Kubernetes"] + required_capabilities=[Capability.Linodes, Capability.Kubernetes] ) lke_version = exec_test_command( BASE_CMDS["lke"] @@ -458,7 +459,7 @@ def test_create_cluster_with_apl_disabled(monkeypatch): label = get_random_text(8) + "_apl_disabled_cluster" test_region = get_random_region_with_caps( - required_capabilities=["Linodes", "Kubernetes"] + required_capabilities=[Capability.Linodes, Capability.Kubernetes] ) lke_version = exec_test_command( BASE_CMDS["lke"] @@ -523,7 +524,7 @@ def test_create_cluster_apl_default(monkeypatch): label = get_random_text(8) + "_apl_default_cluster" test_region = get_random_region_with_caps( - required_capabilities=["Linodes", "Kubernetes"] + required_capabilities=[Capability.Linodes, Capability.Kubernetes] ) lke_version = exec_test_command( BASE_CMDS["lke"] @@ -588,7 +589,7 @@ def test_list_clusters_includes_apl_enabled(monkeypatch): label_apl_off = get_random_text(8) + "_apl_off" test_region = get_random_region_with_caps( - required_capabilities=["Linodes", "Kubernetes"] + required_capabilities=[Capability.Linodes, Capability.Kubernetes] ) lke_version = exec_test_command( BASE_CMDS["lke"] diff --git a/tests/integration/lke/test_lke_enterprise.py b/tests/integration/lke/test_lke_enterprise.py index bcb09a3cb..faf0a2bd2 100644 --- a/tests/integration/lke/test_lke_enterprise.py +++ b/tests/integration/lke/test_lke_enterprise.py @@ -5,6 +5,7 @@ from tests.integration.helpers import ( BASE_CMDS, + Capability, assert_headers_in_lines, delete_target_id, exec_test_command, @@ -37,7 +38,10 @@ def test_create_lke_enterprise(monkeypatch: MonkeyPatch): monkeypatch.setenv("LINODE_CLI_API_VERSION", "v4beta") label = get_random_text(8) test_region = get_random_region_with_caps( - required_capabilities=["Linodes", "Kubernetes Enterprise"] + required_capabilities=[ + Capability.Linodes, + Capability.KubernetesEnterprise, + ] ) k8s_version = get_lke_enterprise_id() diff --git a/tests/integration/ssh/test_plugin_ssh.py b/tests/integration/ssh/test_plugin_ssh.py index a1953fd6b..fbfdaca4b 100644 --- a/tests/integration/ssh/test_plugin_ssh.py +++ b/tests/integration/ssh/test_plugin_ssh.py @@ -7,6 +7,7 @@ from tests.integration.helpers import ( BASE_CMDS, COMMAND_JSON_OUTPUT, + Capability, delete_target_id, exec_failing_test_command, exec_test_command, @@ -15,7 +16,9 @@ wait_for_condition, ) -TEST_REGION = get_random_region_with_caps(required_capabilities=["Linodes"]) +TEST_REGION = get_random_region_with_caps( + required_capabilities=[Capability.Linodes] +) TEST_IMAGE = "linode/arch" TEST_TYPE = "g6-nanode-1" TEST_ROOT_PASS = "r00tp@ss!long-long-and-longer" diff --git a/tests/integration/vpc/conftest.py b/tests/integration/vpc/conftest.py index 1bdef8ad7..bc7c59e4e 100644 --- a/tests/integration/vpc/conftest.py +++ b/tests/integration/vpc/conftest.py @@ -5,6 +5,7 @@ from tests.integration.conftest import create_vpc_w_subnet from tests.integration.helpers import ( BASE_CMDS, + Capability, delete_target_id, exec_test_command, get_random_region_with_caps, @@ -24,7 +25,9 @@ def get_test_vpc_w_subnet(): @pytest.fixture def get_test_vpc_wo_subnet(): - region = get_random_region_with_caps(required_capabilities=["VPCs"]) + region = get_random_region_with_caps( + required_capabilities=[Capability.VPCs] + ) label = get_random_text(5) + "-label" vpc_id = exec_test_command( @@ -51,8 +54,12 @@ def get_test_vpc_wo_subnet(): @pytest.fixture def get_test_vpc_w_rdma_type(): # GPUDirect RDMA capability not available for now - # region = get_random_region_with_caps(required_capabilities=["VPCs", "GPUDirect RDMA"]) - region = get_random_region_with_caps(required_capabilities=["VPCs"]) + # region = get_random_region_with_caps( + # required_capabilities=[Capabilities.VPCs, Capabilities.GPUDirectRDMA] + # ) + region = get_random_region_with_caps( + required_capabilities=[Capability.VPCs] + ) label = get_random_text(5) + "-test-rdma-vpc" vpc_id = exec_test_command( @@ -125,7 +132,10 @@ def create_vpc_with_ipv4(request): params = getattr(request, "param", None) params = params.split() if params else [] region = get_random_region_with_caps( - required_capabilities=["VPCs", "Custom VPC IPv4 Ranges"] + required_capabilities=[ + Capability.VPCs, + Capability.CustomVPCIPv4Ranges, + ] ) label = get_random_text(5) + "-label" @@ -146,7 +156,9 @@ def create_vpc_with_ipv6(request): ipv6_range = getattr(request, "param", None) ipv6_range = ipv6_range if ipv6_range else "auto" label = get_random_text(5) + "-vpc-label" - region = get_random_region_with_caps(required_capabilities=["VPCs"]) + region = get_random_region_with_caps( + required_capabilities=[Capability.VPCs] + ) vpc_data = json.loads( exec_test_command( diff --git a/tests/integration/vpc/test_vpc.py b/tests/integration/vpc/test_vpc.py index 4db622c92..2a1b3bfc5 100644 --- a/tests/integration/vpc/test_vpc.py +++ b/tests/integration/vpc/test_vpc.py @@ -7,6 +7,7 @@ from linodecli.exit_codes import ExitCodes from tests.integration.helpers import ( BASE_CMDS, + Capability, exec_failing_test_command, exec_test_command, get_random_region_with_caps, @@ -173,7 +174,9 @@ def test_subnet_with_rdma_type_vpc(get_test_subnet_w_rdma_type): def test_fails_to_create_vpc_invalid_label(): invalid_label = "invalid_label!?#" - region = get_random_region_with_caps(required_capabilities=["VPCs"]) + region = get_random_region_with_caps( + required_capabilities=[Capability.VPCs] + ) res = exec_failing_test_command( BASE_CMDS["vpcs"] @@ -194,7 +197,9 @@ def test_fails_to_create_vpc_duplicate_label(get_test_vpc_wo_subnet): BASE_CMDS["vpcs"] + ["view", vpc_id, "--text", "--no-headers", "--format=label"] ) - region = get_random_region_with_caps(required_capabilities=["VPCs"]) + region = get_random_region_with_caps( + required_capabilities=[Capability.VPCs] + ) res = exec_failing_test_command( BASE_CMDS["vpcs"] + ["create", "--label", label, "--region", region], @@ -337,7 +342,9 @@ def test_create_subnet_with_ipv6_auto(get_test_vpc_wo_subnet): def test_fails_to_create_vpc_with_invalid_ipv6_range(): - region = get_random_region_with_caps(required_capabilities=["VPCs"]) + region = get_random_region_with_caps( + required_capabilities=[Capability.VPCs] + ) label = get_random_text(5) + "-invalidvpc" res = exec_failing_test_command( @@ -473,7 +480,10 @@ def test_vpc_with_forbidden_ipv4_fail(): ).split()[0] region = get_random_region_with_caps( - required_capabilities=["VPCs", "Custom VPC IPv4 Ranges"] + required_capabilities=[ + Capability.VPCs, + Capability.CustomVPCIPv4Ranges, + ] ) label = get_random_text(5) + "-label"