qontract-reconcile 0.10.0__py3-none-any.whl → 0.10.1.dev1203__py3-none-any.whl

reconcile/test/test_utils_terraform_config_client.py

@@ -1,219 +0,0 @@
-import subprocess
-from pathlib import Path
-from unittest.mock import (
-    MagicMock,
-    call,
-    create_autospec,
-    mock_open,
-)
-
-import pytest
-
-from reconcile.utils.exceptions import PrintToFileInGitRepositoryError
-from reconcile.utils.external_resource_spec import ExternalResourceSpec
-from reconcile.utils.terraform.config_client import (
-    ClientAlreadyRegisteredError,
-    ClientNotRegisteredError,
-    TerraformConfigClient,
-    TerraformConfigClientCollection,
-)
-
-
-@pytest.fixture
-def empty_git_repo(tmp_path_factory) -> Path:
-    temp_dir = tmp_path_factory.mktemp("empty-git-repo")
-    subprocess.check_call(["git", "init", temp_dir])
-    return temp_dir
-
-
-def create_external_resource_spec(provisioner_name, identifier):
-    return ExternalResourceSpec(
-        "cloudflare_zone",
-        {"name": provisioner_name, "automationToken": {}},
-        {
-            "provider": "cloudflare_zone",
-            "identifier": f"{identifier}-com",
-            "zone": f"{identifier}.com",
-            "plan": "enterprise",
-            "type": "partial",
-        },
-        {},
-    )
-
-
-def test_terraform_config_client_collection_populate_resources():
-    """populate_resources() is called on all registered clients."""
-    client_1: MagicMock = create_autospec(TerraformConfigClient)
-    client_2: MagicMock = create_autospec(TerraformConfigClient)
-    client_3: MagicMock = create_autospec(TerraformConfigClient)
-
-    terraform_configs = TerraformConfigClientCollection()
-    terraform_configs.register_client("acct_1", client_1)
-    terraform_configs.register_client("acct_2", client_2)
-    terraform_configs.register_client("acct_3", client_3)
-
-    terraform_configs.populate_resources()
-
-    client_1.populate_resources.assert_called_once()
-    client_2.populate_resources.assert_called_once()
-    client_3.populate_resources.assert_called_once()
-
-
-def test_terraform_config_client_collection_add_specs():
-    """
-    add_specs() is called on the correct client and resource_spec_inventory is updated.
-    """
-    client_1: MagicMock = create_autospec(TerraformConfigClient)
-    client_2: MagicMock = create_autospec(TerraformConfigClient)
-    client_3: MagicMock = create_autospec(TerraformConfigClient)
-
-    terraform_configs = TerraformConfigClientCollection()
-    terraform_configs.register_client("acct_1", client_1)
-    terraform_configs.register_client("acct_2", client_2)
-    terraform_configs.register_client("acct_3", client_3)
-
-    spec_1 = create_external_resource_spec("acct_1", "dev-1")
-    spec_2 = create_external_resource_spec("acct_2", "dev-2")
-    spec_3 = create_external_resource_spec("acct_2", "dev-3")
-    spec_4 = create_external_resource_spec("acct_3", "dev-4")
-    spec_5 = create_external_resource_spec("acct_3", "dev-5")
-
-    terraform_configs.add_specs([spec_1, spec_2, spec_3, spec_4, spec_5])
-
-    client_1.add_spec.assert_called_once_with(spec_1)
-    client_2.add_spec.assert_has_calls([call(spec_2), call(spec_3)])
-    client_3.add_spec.assert_has_calls([call(spec_4), call(spec_5)])
-
-    assert list(terraform_configs.resource_spec_inventory.values()) == [
-        spec_1,
-        spec_2,
-        spec_3,
-        spec_4,
-        spec_5,
-    ]
-
-
-def test_terraform_config_client_collection_add_specs_with_filter():
-    """add_specs() is called on the correct client when a filter is set."""
-    client_1: MagicMock = create_autospec(TerraformConfigClient)
-    client_2: MagicMock = create_autospec(TerraformConfigClient)
-    client_3: MagicMock = create_autospec(TerraformConfigClient)
-
-    terraform_configs = TerraformConfigClientCollection()
-    terraform_configs.register_client("acct_1", client_1)
-    terraform_configs.register_client("acct_2", client_2)
-    terraform_configs.register_client("acct_3", client_3)
-
-    spec_1 = create_external_resource_spec("acct_1", "dev-1")
-    spec_2 = create_external_resource_spec("acct_2", "dev-2")
-    spec_3 = create_external_resource_spec("acct_2", "dev-3")
-    spec_4 = create_external_resource_spec("acct_3", "dev-4")
-    spec_5 = create_external_resource_spec("acct_3", "dev-5")
-
-    specs = [spec_1, spec_2, spec_3, spec_4, spec_5]
-    # With the filter set, only a single client should have specs added.
-    terraform_configs.add_specs(specs, account_filter="acct_3")
-
-    client_1.add_spec.assert_not_called()
-    client_2.add_spec.assert_not_called()
-    client_3.add_spec.assert_has_calls([call(spec_4), call(spec_5)])
-
-
-def test_terraform_config_client_collection_dump():
-    """The working directories return by clients are aggregated properly in dump()."""
-    client_1: MagicMock = create_autospec(TerraformConfigClient)
-    client_1.dump.return_value = {"acct_1": "/tmp/acct_1"}
-    client_2: MagicMock = create_autospec(TerraformConfigClient)
-    client_2.dump.return_value = {"acct_2": "/tmp/acct_2"}
-    client_3: MagicMock = create_autospec(TerraformConfigClient)
-    client_3.dump.return_value = {"acct_3": "/tmp/acct_3"}
-
-    terraform_configs = TerraformConfigClientCollection()
-    terraform_configs.register_client("acct_1", client_1)
-    terraform_configs.register_client("acct_2", client_2)
-    terraform_configs.register_client("acct_3", client_3)
-
-    working_dirs = terraform_configs.dump()
-
-    assert working_dirs == {
-        "acct_1": {"acct_1": "/tmp/acct_1"},
-        "acct_2": {"acct_2": "/tmp/acct_2"},
-        "acct_3": {"acct_3": "/tmp/acct_3"},
-    }
-
-
-def test_terraform_config_client_collection_print_to_file(mocker):
-    """
-    The print_to_file kwarg results in a properly formatted file at the desired file
-    path.
-    """
-    mock_builtins_open = mock_open()
-    mocker.patch("builtins.open", mock_builtins_open)
-
-    client_1: MagicMock = create_autospec(TerraformConfigClient)
-    client_1.dumps.return_value = {"acct_1": "data"}
-    client_2: MagicMock = create_autospec(TerraformConfigClient)
-    client_2.dumps.return_value = {"acct_2": "data"}
-    client_3: MagicMock = create_autospec(TerraformConfigClient)
-    client_3.dumps.return_value = {"acct_3": "data"}
-
-    terraform_configs = TerraformConfigClientCollection()
-    terraform_configs.register_client("acct_1", client_1)
-    terraform_configs.register_client("acct_2", client_2)
-    terraform_configs.register_client("acct_3", client_3)
-
-    # This file is never actually written to because of the patched builtins.open()
-    terraform_configs.dump(print_to_file="/tmp/test-utils-terraform-config-client")
-
-    comment_calls = [
-        call("##### acct_1 #####\n"),
-        call("##### acct_2 #####\n"),
-        call("##### acct_3 #####\n"),
-    ]
-
-    data_calls = [
-        call({"acct_1": "data"}),
-        call({"acct_2": "data"}),
-        call({"acct_3": "data"}),
-    ]
-
-    for comment in comment_calls:
-        assert comment in mock_builtins_open.return_value.write.call_args_list
-
-    for data in data_calls:
-        assert data in mock_builtins_open.return_value.write.call_args_list
-
-
-def test_terraform_config_client_collection_dump_print_file_git(empty_git_repo):
-    """Using print_to_file in a git repo should result in an exception."""
-    client_1: MagicMock = create_autospec(TerraformConfigClient)
-    client_1.dump.return_value = {"acct_1": "/tmp/acct_1"}
-
-    terraform_configs = TerraformConfigClientCollection()
-    terraform_configs.register_client("acct_1", client_1)
-
-    with pytest.raises(PrintToFileInGitRepositoryError):
-        terraform_configs.dump(
-            print_to_file=f"{empty_git_repo}/terraform-config-print-to-file"
-        )
-
-
-def test_terraform_config_client_collection_raise_on_duplicate():
-    """Client names must be unique."""
-    client_1: MagicMock = create_autospec(TerraformConfigClient)
-    client_2: MagicMock = create_autospec(TerraformConfigClient)
-
-    terraform_configs = TerraformConfigClientCollection()
-    terraform_configs.register_client("duplicate", client_1)
-
-    with pytest.raises(ClientAlreadyRegisteredError):
-        terraform_configs.register_client("duplicate", client_2)
-
-
-def test_terraform_config_client_collection_raise_on_missing():
-    """Specs cannot be added to clients that don't exist."""
-    terraform_configs = TerraformConfigClientCollection()
-    spec_1 = create_external_resource_spec("acct_1", "dev-1")
-
-    with pytest.raises(ClientNotRegisteredError):
-        terraform_configs.add_specs([spec_1])

reconcile/test/test_utils_terrascript_aws_client.py

@@ -1,277 +0,0 @@
-import pytest
-
-import reconcile.utils.terrascript_aws_client as tsclient
-from reconcile.utils.aws_api import AmiTag
-from reconcile.utils.external_resource_spec import (
-    ExternalResourceSpec,
-    ExternalResourceUniqueKey,
-)
-
-
-@pytest.fixture
-def ts():
-    return tsclient.TerrascriptClient("", "", 1, [])
-
-
-def test_aws_username_org(ts):
-    result = "org"
-    user = {"org_username": result}
-    assert ts._get_aws_username(user) == result
-
-
-def test_aws_username_aws(ts):
-    result = "aws"
-    user = {"org_username": "org", "aws_username": result}
-    assert ts._get_aws_username(user) == result
-
-
-def test_validate_mandatory_policies(ts):
-    mandatory_policy = {
-        "name": "mandatory",
-        "mandatory": True,
-    }
-    not_mandatory_policy = {
-        "name": "not-mandatory",
-    }
-    account = {"name": "acc", "policies": [mandatory_policy, not_mandatory_policy]}
-    assert ts._validate_mandatory_policies(account, [mandatory_policy], "role") is True
-    assert (
-        ts._validate_mandatory_policies(account, [not_mandatory_policy], "role")
-        is False
-    )
-
-
-class MockJenkinsApi:
-    def __init__(self, response):
-        self.response = response
-
-    def is_job_running(self, name):
-        return self.response
-
-
-def test_use_previous_image_id_no_upstream(ts):
-    assert ts._use_previous_image_id([]) is False
-
-
-@pytest.mark.parametrize("result", [True, False])
-def test_use_previous_image_id(mocker, ts, result):
-    mocker.patch(
-        "reconcile.utils.terrascript_aws_client.TerrascriptClient.init_jenkins",
-        return_value=MockJenkinsApi(result),
-    )
-    image = [{"upstream": {"instance": {"name": "ci"}, "name": "job"}}]
-    assert ts._use_previous_image_id(image) == result
-
-
-def test_get_asg_image_id(mocker, ts: tsclient.TerrascriptClient):
-    awsapi = mocker.patch("reconcile.utils.terrascript_aws_client.AWSApi")
-    with awsapi() as aws:
-        get_image_id_mock = aws.get_image_id
-    get_image_id_mock.return_value = "ami-123456"
-
-    ref = "sha-12345"
-    mocker.patch(
-        "reconcile.utils.terrascript_aws_client.TerrascriptClient.get_commit_sha",
-        return_value=ref,
-    )
-    ts.accounts["some-account"] = "mock"  # type: ignore
-    image_id = ts.get_asg_image_id(
-        filters=[
-            {"provider": "git", "tag_name": "commit", "ref": ref},
-            {
-                "provider": "static",
-                "tag_name": "tag1",
-                "value": "value1",
-            },
-            {
-                "provider": "static",
-                "tag_name": "tag2",
-                "value": "value2",
-            },
-        ],
-        account="some-account",
-        region="us-east-1",
-    )
-    assert image_id == "ami-123456"
-    get_image_id_mock.assert_called_with(
-        "some-account",
-        "us-east-1",
-        [
-            AmiTag(name="commit", value=ref),
-            AmiTag(name="tag1", value="value1"),
-            AmiTag(name="tag2", value="value2"),
-        ],
-    )
-
-
-class MockProjectCommit:
-    def __init__(self, id):
-        setattr(self, "id", id)
-
-
-@pytest.mark.parametrize(
-    "repo_info, expected",
-    [
-        ({"url": "http://fake", "ref": 40 * "1"}, 40 * "1"),
-        ({"url": "http://github.com/foo/bar", "ref": "main"}, "sha-12345"),
-        (
-            {"url": "http://gitlab.com/foo/bar", "ref": "master"},
-            "sha-67890",
-        ),
-    ],
-)
-def test_get_commit_sha(mocker, ts: tsclient.TerrascriptClient, repo_info, expected):
-    init_github = mocker.patch(
-        "reconcile.utils.terrascript_aws_client.TerrascriptClient.init_github"
-    )
-    init_github.return_value.get_repo.return_value.get_commit.return_value.sha = (
-        expected
-    )
-    init_gitlab = mocker.patch(
-        "reconcile.utils.terrascript_aws_client.TerrascriptClient.init_gitlab"
-    )
-    init_gitlab.return_value.get_project.return_value.commits.list.return_value = [
-        MockProjectCommit(expected)
-    ]
-    assert ts.get_commit_sha(repo_info) == expected
-
-
-def test_tf_disabled_namespace_with_resources(ts):
-    """
-    even if a namespace has tf resources, they are not considered when the
-    namespace is not enabled for tf resource management
-    """
-    ra = {"identifier": "a", "provider": "p"}
-    ns1 = {
-        "name": "ns1",
-        "managedExternalResources": False,
-        "externalResources": [
-            {"provider": "aws", "provisioner": {"name": "a"}, "resources": [ra]}
-        ],
-        "cluster": {"name": "c"},
-    }
-    namespaces = [ns1]
-    ts.init_populate_specs(namespaces, None)
-    specs = ts.resource_spec_inventory
-    assert not specs
-
-
-def test_resource_specs_without_account_filter(ts):
-    """
-    if no account filter is given, all resources of namespaces with
-    enabled tf resource management are expected to be returned
-    """
-    p = "aws"
-    pa = {"name": "a"}
-    ra = {"identifier": "a", "provider": "p"}
-    ns1 = {
-        "name": "ns1",
-        "managedExternalResources": True,
-        "externalResources": [{"provider": p, "provisioner": pa, "resources": [ra]}],
-        "cluster": {"name": "c"},
-    }
-    namespaces = [ns1]
-    ts.init_populate_specs(namespaces, None)
-    specs = ts.resource_spec_inventory
-    spec = ExternalResourceSpec(p, pa, ra, ns1)
-    assert specs == {ExternalResourceUniqueKey.from_spec(spec): spec}
-
-
-def test_resource_specs_with_account_filter(ts):
-    """
-    if an account filter is given only the resources defined for
-    that account are expected
-    """
-    p = "aws"
-    pa = {"name": "a"}
-    ra = {"identifier": "a", "provider": "p"}
-    pb = {"name": "b"}
-    rb = {"identifier": "b", "provider": "p"}
-    ns1 = {
-        "name": "ns1",
-        "managedExternalResources": True,
-        "externalResources": [
-            {"provider": p, "provisioner": pa, "resources": [ra]},
-            {"provider": p, "provisioner": pb, "resources": [rb]},
-        ],
-        "cluster": {"name": "c"},
-    }
-    namespaces = [ns1]
-    ts.init_populate_specs(namespaces, "a")
-    specs = ts.resource_spec_inventory
-    spec = ExternalResourceSpec(p, pa, ra, ns1)
-    assert specs == {ExternalResourceUniqueKey.from_spec(spec): spec}
-
-
-expected_result = {
-    "s3": {
-        "access_key": "SOMEKEY123",
-        "secret_key": "somesecretkey",
-        "bucket": "some-bucket",
-        "key": "qontract-reconcile.tfstate",
-        "region": "us-east-1",
-    }
-}
-
-
-def test_terraform_state_when_present(ts):
-    account_name = "some-account"
-    integration_name = "terraform-resources-wrapper"
-    terraform_state_config_test = {
-        "aws_access_key_id": "SOMEKEY123",
-        "aws_secret_access_key": "somesecretkey",
-        "bucket": "some-bucket",
-        "key": "qontract-reconcile.tfstate",
-        "region": "us-east-1",
-        "terraform-resources-wrapper_key": "qontract-reconcile.tfstate",
-        "terraformState": {
-            "provider": "s3",
-            "bucket": "some-bucket",
-            "region": "some-region",
-            "integrations": [
-                {
-                    "key": "terraform-resources-wrapper",
-                    "integration": "qontract-reconcile.tfstate",
-                },
-            ],
-        },
-    }
-    assert (
-        ts.state_bucket_for_account(
-            integration_name, account_name, terraform_state_config_test
-        )
-        == expected_result
-    )
-
-
-terraform_state_config_test_missing = {
-    "aws_access_key_id": "SOMEKEY123",
-    "aws_secret_access_key": "somesecretkey",
-    "bucket": "some-bucket",
-    "key": "qontract-reconcile.tfstate",
-    "region": "us-east-1",
-    "terraform-resources-wrapper_key": "qontract-reconcile.tfstate",
-    "terraformState": None,
-}
-
-
-def test_terraform_state_when_not_present(ts):
-    account_name = "some-account"
-    integration_name = "terraform-resources-wrapper"
-    assert (
-        ts.state_bucket_for_account(
-            integration_name, account_name, terraform_state_config_test_missing
-        )
-        == expected_result
-    )
-
-
-def test_terraform_state_when_not_present_error(ts):
-    account_name = "some-account"
-    integration_name = "not-found-integration"
-    try:
-        ts.state_bucket_for_account(
-            integration_name, account_name, terraform_state_config_test_missing
-        )
-    except ValueError:
-        pass