Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Keychain cleanups #3573

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Keychain cleanups #3573

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d8857ea
Keychain cleanups
Apr 6, 2023
b9d4f61
Merge branch 'main' into change_config_tests
May 8, 2023
a4b60c0
Merge branch 'main' into change_config_tests
May 9, 2023
12bd83f
Merge branch 'main' into change_config_tests
davidmreed Sep 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 11 additions & 3 deletions cumulusci/core/keychain/tests/conftest.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
from unittest import mock

import pytest

from cumulusci.core.config import (
Expand All @@ -15,9 +17,9 @@ def project_config():
project_config = BaseProjectConfig(universal_config, config={"no_yaml": True})
project_config.config["services"] = {
"connected_app": {"attributes": {"test": {"required": True}}},
"github": {"attributes": {"name": {"required": True}, "password": {}}},
"github": {"attributes": {"name4tests": {"required": True}, "pw4tests": {}}},
"github_enterprise": {
"attributes": {"name": {"required": True}, "password": {}}
"attributes": {"name4tests": {"required": True}, "pw4tests": {}}
},
"not_configured": {"attributes": {"foo": {"required": True}}},
"devhub": {"attributes": {"foo": {"required": True}}},
Expand All @@ -30,6 +32,12 @@ def project_config():
return project_config


@pytest.fixture(autouse=True)
def clear_environment():
with mock.patch("os.environ", {}):
yield


@pytest.fixture
def org_config():
return OrgConfig({"foo": "bar"}, "test")
Expand All @@ -47,4 +55,4 @@ def key():

@pytest.fixture
def service_config():
return ServiceConfig({"name": "[email protected]", "password": "test123"})
return ServiceConfig({"name4tests": "[email protected]", "password": "test123"})
4 changes: 2 additions & 2 deletions cumulusci/core/keychain/tests/test_base_project_keychain.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -220,10 +220,10 @@ def test_get_default_org__no_default(self, keychain):
assert keychain.get_default_org() == (None, None)

def test_validate_service_attributes(self, keychain):
# config is missing the "name" attribute
# config is missing the "name4tests" attribute
service_config = ServiceConfig({"password": "test123"})
error_message = re.escape(
"Missing required attribute(s) for github service: ['name']"
"Missing required attribute(s) for github service: ['name4tests']"
)
with pytest.raises(
ServiceNotValid,
Expand Down
58 changes: 39 additions & 19 deletions cumulusci/core/keychain/tests/test_encrypted_file_project_keychain.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -304,7 +304,9 @@ def test_load_service_files(self, keychain):
github_service_path = Path(f"{keychain.global_config_dir}/services/github")
self._write_file(
Path(github_service_path / "alias.service"),
keychain._get_config_bytes(BaseConfig({"name": "foo"})).decode("utf-8"),
keychain._get_config_bytes(BaseConfig({"name4tests": "foo"})).decode(
"utf-8"
),
)

# keychain.config["services"] = {}
Expand All @@ -316,14 +318,14 @@ def test_load_service_files(self, keychain):
):
keychain._load_service_files()
github_service = keychain.get_service("github", "alias")
assert "foo" in github_service.config["name"]
assert "foo" in github_service.config["name4tests"]

def test_load_services__from_env(self, keychain):
service_config_one = ServiceConfig(
{"name": "foo1", "password": "1234", "token": "1234"}
{"name4tests": "foo1", "pw4tests": "1234", "token": "1234"}
)
service_config_two = ServiceConfig(
{"name": "foo2", "password": "5678", "token": "5678"}
{"name4tests": "foo2", "pw4tests": "5678", "token": "5678"}
)
with EnvironmentVarGuard() as env:
env.set(
Expand All @@ -349,7 +351,7 @@ def test_load_services_from_env__same_name_throws_error(self, keychain):
keychain.logger = mock.Mock()
service_prefix = EncryptedFileProjectKeychain.env_service_var_prefix
service_config = ServiceConfig(
{"name": "foo", "password": "1234", "token": "1234"}
{"name4tests": "foo", "pw4tests": "1234", "token": "1234"}
)
with EnvironmentVarGuard() as env:
env.set(f"{service_prefix}github", json.dumps(service_config.config))
Expand Down Expand Up @@ -440,38 +442,48 @@ def test_set_service__cannot_overwrite_default_connected_app(self, keychain):
)

def test_set_service__first_should_be_default(self, keychain):
keychain.set_service("github", "foo_github", ServiceConfig({"name": "foo"}))
keychain.set_service("github", "bar_github", ServiceConfig({"name": "bar"}))
keychain.set_service(
"github", "foo_github", ServiceConfig({"name4tests": "foo"})
)
keychain.set_service(
"github", "bar_github", ServiceConfig({"name4tests": "bar"})
)

github_service = keychain.get_service("github")
assert _simplify_config(github_service.config) == {"name": "foo"}
assert _simplify_config(github_service.config) == {"name4tests": "foo"}

def test_set_default_service(self, keychain, withdifferentformats):
keychain.set_service("github", "foo_github", ServiceConfig({"name": "foo"}))
keychain.set_service("github", "bar_github", ServiceConfig({"name": "bar"}))
keychain.set_service(
"github", "foo_github", ServiceConfig({"name4tests": "foo"})
)
keychain.set_service(
"github", "bar_github", ServiceConfig({"name4tests": "bar"})
)

github_service = keychain.get_service("github")
assert _simplify_config(github_service.config) == {"name": "foo"}
assert _simplify_config(github_service.config) == {"name4tests": "foo"}
# now set default to bar
keychain.set_default_service("github", "bar_github")
github_service = keychain.get_service("github")
assert _simplify_config(github_service.config) == {"name": "bar"}
assert _simplify_config(github_service.config) == {"name4tests": "bar"}

def test_set_default_service__service_alredy_default(
self, keychain, withdifferentformats
):
keychain.set_service("github", "foo_github", ServiceConfig({"name": "foo"}))
keychain.set_service(
"github", "foo_github", ServiceConfig({"name4tests": "foo"})
)
github_service = keychain.get_service("github")
assert github_service.config == {
"name": "foo",
"name4tests": "foo",
"serialization_format": withdifferentformats,
}

keychain.set_default_service("github", "foo_github")

github_service = keychain.get_service("github")
assert github_service.config == {
"name": "foo",
"name4tests": "foo",
"serialization_format": withdifferentformats,
}

Expand All @@ -480,7 +492,9 @@ def test_set_default_service__no_such_service(self, keychain):
keychain.set_default_service("fooey", "alias")

def test_set_default_service__no_such_alias(self, keychain):
keychain.set_service("github", "foo_github", ServiceConfig({"name": "foo"}))
keychain.set_service(
"github", "foo_github", ServiceConfig({"name4tests": "foo"})
)
with pytest.raises(ServiceNotConfigured):
keychain.set_default_service("github", "wrong_alias")

Expand Down Expand Up @@ -1133,7 +1147,7 @@ def test_set_and_get_service_with_dates__global(
self, keychain, key, withdifferentformats
):
service_config = ServiceConfig(
{"name": "foo1", "password": "1234", "token": "1234"}
{"name4tests": "foo1", "pw4tests": "1234", "token": "1234"}
)

keychain.key = key
Expand Down Expand Up @@ -1167,7 +1181,10 @@ def test_migration_pickle_to_json(
del keychain.config["orgs"]
keychain._load_orgs()
assert keychain.get_org("test_migration").password == "Kltpzyxm"
assert keychain.get_org("test_migration").serialization_format == "pickle"
assert (
keychain.get_org("test_migration").lookup("serialization_format")
== "pickle"
)

with mock.patch(
"cumulusci.core.keychain.serialization.SHOULD_SAVE_AS_JSON", True
Expand All @@ -1177,4 +1194,7 @@ def test_migration_pickle_to_json(
del keychain.config["orgs"]
keychain._load_orgs()
assert keychain.get_org("test_migration").password == "Kltpzyxm"
assert keychain.get_org("test_migration").serialization_format == "json"
assert (
keychain.get_org("test_migration").lookup("serialization_format")
== "json"
)
Loading