Merge pull request #394 from linode/migrate-bats-to-pytest

migrate: bats test to pytest

Author: ykim-akamai

tests/__init__.py

@@ -0,0 +1,27 @@
+from tests.integration.helpers import exec_test_command
+
+
+def test_help_page_for_non_aliased_actions():
+    process = exec_test_command(["linode-cli", "linodes", "list", "--help"])
+    output = process.stdout.decode()
+
+    assert "Linodes List" in output
+    assert (
+        "API Documentation: https://www.linode.com/docs/api/linode-instances/#linodes-list"
+        in output
+    )
+    assert "You may filter results with:" in output
+    assert "--tags" in output
+
+
+def test_help_page_for_aliased_actions():
+    process = exec_test_command(["linode-cli", "linodes", "ls", "--help"])
+    output = process.stdout.decode()
+
+    assert "Linodes List" in output
+    assert (
+        "API Documentation: https://www.linode.com/docs/api/linode-instances/#linodes-list"
+        in output
+    )
+    assert "You may filter results with:" in output
+    assert "--tags" in output

tests/integration/__init__.py

@@ -0,0 +1,28 @@
+import os
+
+from tests.integration.helpers import INVALID_HOST, exec_failing_test_command
+
+
+def test_cli_command_fails_to_access_invalid_host(monkeypatch):
+    monkeypatch.setenv("LINODE_CLI_API_HOST", INVALID_HOST)
+
+    process = exec_failing_test_command(["linode-cli", "linodes", "ls"])
+    output = process.stderr.decode()
+
+    assert "Max retries exceeded with url: //wrongapi.linode.com" in output
+
+
+def test_cli_uses_v4beta_when_override_is_set(monkeypatch):
+    monkeypatch.setenv("LINODE_CLI_API_VERSION", "v4beta")
+    os.system("linode-cli linodes ls --debug 2>&1 | tee /tmp/output_file.txt")
+
+    result = os.popen("cat /tmp/output_file.txt").read()
+    assert "v4beta" in result
+
+
+def test_cli_command_fails_to_access_invalid_api_scheme(monkeypatch):
+    monkeypatch.setenv("LINODE_CLI_API_SCHEME", "ssh")
+    process = exec_failing_test_command(["linode-cli", "linodes", "ls"])
+    output = process.stderr.decode()
+
+    assert "ssh://" in output

tests/integration/cli/test_help.py

@@ -11,9 +11,9 @@
 from typing import Callable, Optional
 
 import pytest
-from helpers import get_random_text
 
 from linodecli import ENV_TOKEN_NAME
+from tests.integration.helpers import get_random_text
 
 
 @pytest.fixture(scope="session")

tests/integration/cli/test_host_overrides.py

@@ -0,0 +1,222 @@
+import logging
+import re
+import time
+
+import pytest
+
+from tests.integration.helpers import (
+    SUCCESS_STATUS_CODE,
+    delete_all_domains,
+    exec_test_command,
+)
+
+BASE_CMD = ["linode-cli", "domains"]
+
+
+@pytest.fixture(scope="session", autouse=True)
+def domain_records_setup():
+    # Create one domain for some tests in this suite
+    try:
+        timestamp = str(int(time.time()))
+        # Create domain
+        domain_id = (
+            exec_test_command(
+                BASE_CMD
+                + [
+                    "create",
+                    "--type",
+                    "master",
+                    "--domain",
+                    timestamp + "example.com",
+                    "[email protected]",
+                    "--text",
+                    "--no-header",
+                    "--format=id",
+                ]
+            )
+            .stdout.decode()
+            .rstrip()
+        )
+
+        # Create record
+        record_id = (
+            exec_test_command(
+                BASE_CMD
+                + [
+                    "records-create",
+                    "--protocol=tcp",
+                    "--type=SRV",
+                    "--port=23",
+                    "--priority=4",
+                    "--service=telnet",
+                    "--target=8.8.8.8",
+                    "--weight=4",
+                    "--text",
+                    "--no-header",
+                    "--delimiter=,",
+                    "--format=id",
+                    domain_id,
+                ]
+            )
+            .stdout.decode()
+            .rstrip()
+        )
+
+    except:
+        logging.exception("Failed creating domain in setup")
+
+    yield domain_id, record_id
+
+    try:
+        delete_all_domains()
+    except:
+        logging.exception("Failed to delete all domains")
+
+
+def test_create_a_domain():
+    timestamp = str(int(time.time()))
+
+    # Current domain list
+    process = exec_test_command(
+        BASE_CMD + ["list", '--format="id"', "--text", "--no-header"]
+    )
+    output_current = process.stdout.decode()
+
+    # Create domain
+    exec_test_command(
+        BASE_CMD
+        + [
+            "create",
+            "--type",
+            "master",
+            "--domain",
+            timestamp + "example.com",
+            "[email protected]",
+            "--text",
+            "--no-header",
+        ]
+    )
+
+    process = exec_test_command(
+        BASE_CMD + ["list", "--format=id", "--text", "--no-header"]
+    )
+    output_after = process.stdout.decode()
+
+    # Check if list is bigger than previous list
+    assert (
+        len(output_after.splitlines()) > len(output_current.splitlines()),
+        "the list is not updated with new domain..",
+    )
+
+
+def test_create_domain_srv_record(domain_records_setup):
+    domain_id = domain_records_setup[0]
+
+    process = exec_test_command(
+        BASE_CMD
+        + [
+            "records-create",
+            "--protocol=tcp",
+            "--type=SRV",
+            "--port=23",
+            "--priority=4",
+            "--service=telnet",
+            "--target=8.8.8.8",
+            "--weight=4",
+            "--text",
+            "--no-header",
+            "--delimiter=,",
+            domain_id,
+        ]
+    )
+
+    output = process.stdout.decode()
+
+    assert (
+        re.search("[0-9]+,SRV,_telnet._tcp,8.8.8.8,0,4,4", output),
+        "Output does not match the format",
+    )
+
+
+def test_list_srv_record(domain_records_setup):
+    domain_id = domain_records_setup[0]
+    process = exec_test_command(
+        BASE_CMD
+        + [
+            "records-list",
+            domain_id,
+            "--text",
+            "--no-header",
+            "--delimiter=,",
+        ]
+    )
+    output = process.stdout.decode()
+
+    assert (
+        re.search("[0-9]+,SRV,_telnet._tcp,8.8.8.8,0,4,4", output),
+        "Output does not match the format",
+    )
+
+
+def test_view_domain_record(domain_records_setup):
+    domain_id = domain_records_setup[0]
+    record_id = domain_records_setup[1]
+
+    process = exec_test_command(
+        BASE_CMD
+        + [
+            "records-view",
+            domain_id,
+            record_id,
+            "--target= 8.8.4.4",
+            "--text",
+            "--no-header",
+            "--delimiter=,",
+        ]
+    )
+    output = process.stdout.decode()
+
+    assert (
+        re.search("[0-9]+,SRV,_telnet._tcp,8.8.8.8,0,4,4", output),
+        "Output does not match the format",
+    )
+
+
+def test_update_domain_record(domain_records_setup):
+    domain_id = domain_records_setup[0]
+    record_id = domain_records_setup[1]
+
+    process = exec_test_command(
+        BASE_CMD
+        + [
+            "records-update",
+            domain_id,
+            record_id,
+            "--target= 8.8.4.4",
+            "--text",
+            "--no-header",
+            "--delimiter=,",
+        ]
+    )
+    output = process.stdout.decode()
+
+    assert (
+        re.search("[0-9]+,SRV,_telnet._tcp,8.8.8.8,0,4,4", output),
+        "Output does not match the format",
+    )
+
+
+def test_delete_a_domain_record(domain_records_setup):
+    domain_id = domain_records_setup[0]
+    record_id = domain_records_setup[1]
+
+    process = exec_test_command(
+        BASE_CMD + ["records-delete", domain_id, record_id]
+    )
+
+    # Assert on status code returned from deleting domain
+    assert process.returncode == SUCCESS_STATUS_CODE
+
+
+def test_delete_all_domains():
+    delete_all_domains()

tests/integration/conftest.py

@@ -0,0 +1,106 @@
+import logging
+import re
+import time
+
+import pytest
+
+from tests.integration.helpers import (
+    delete_all_domains,
+    delete_tag,
+    exec_failing_test_command,
+    exec_test_command,
+)
+
+BASE_CMD = ["linode-cli", "domains"]
+
+
+@pytest.fixture(scope="session", autouse=True)
+def domain_tags_setup():
+    yield "setup"
+    try:
+        delete_all_domains()
+    except:
+        logging.exception("Failed to delete all domains")
+
+
+# @pytest.mark.skip(reason="BUG 943")
+def test_fail_to_create_master_domain_with_invalid_tags():
+    timestamp = str(int(time.time()))
+    bad_tag = "*"
+
+    exec_failing_test_command(
+        BASE_CMD
+        + [
+            "create",
+            "--type",
+            "master",
+            "--domain",
+            timestamp + "example.com",
+            "--soa_email=" + timestamp + "[email protected]",
+            "--text",
+            "--no-header",
+            "--format=id",
+            "--tag",
+            bad_tag,
+        ]
+    )
+
+
+# @pytest.mark.skip(reason="BUG 943")
+def test_fail_to_create_slave_domain_with_invalid_tags():
+    timestamp = str(int(time.time()))
+    bad_tag = "*"
+
+    exec_failing_test_command(
+        BASE_CMD
+        + [
+            "create",
+            "--type",
+            "slave",
+            "--domain",
+            timestamp + "example.com",
+            "--soa_email=" + timestamp + "[email protected]",
+            "--text",
+            "--no-header",
+            "--format=id",
+            "--tag",
+            bad_tag,
+        ]
+    )
+
+
+# @pytest.mark.skip(reason="BUG 943")
+def test_create_master_domain_with_tags():
+    timestamp = str(int(time.time()))
+    tag = "foo"
+
+    process = exec_test_command(
+        BASE_CMD
+        + [
+            "create",
+            "--type",
+            "master",
+            "--domain",
+            timestamp + "-example.com",
+            "--soa_email=" + timestamp + "[email protected]",
+            "--text",
+            "--no-header",
+            "--delimiter=,",
+            "--format=id,domain,type,status,tags",
+            "--tag",
+            tag,
+        ]
+    )
+    output = process.stdout.decode()
+    assert re.search("[0-9]+,[0-9]+-example.com,master,active," + tag, output)
+
+
+# @pytest.mark.skip(reason="BUG 943")
+def test_delete_domain_and_tag():
+    # need to check if tag foo is still present while running this test
+    result = exec_test_command(["linode-cli", "tags", "list"]).stdout.decode()
+    if "foo" in result:
+        delete_tag("foo")
+        delete_all_domains()
+    else:
+        delete_all_domains()