Skip to content

tests: remove unnecessary patching of private ops class #330

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

Open
wants to merge 2 commits into
base: 6/edge
Choose a base branch
from
Open

tests: remove unnecessary patching of private ops class #330

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fc62fc7
Stop using private ops classes.
tonyandrewmeyer Sep 12, 2024
ac17e62
Merge branch '6/edge' into no-private-ops
tonyandrewmeyer Sep 15, 2024
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
20 changes: 0 additions & 20 deletions tests/unit/helpers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,27 +3,7 @@
# See LICENSE file for licensing details.

from pathlib import Path
from typing import Callable
from unittest.mock import patch

import yaml

METADATA = yaml.safe_load(Path("./metadata.yaml").read_text())


def patch_network_get(private_address="10.1.157.116") -> Callable:
def network_get(*args, **kwargs) -> dict:
"""Patch for the not-yet-implemented testing backend needed for `bind_address`.

This patch decorator can be used for cases such as:
self.model.get_binding(event.relation).network.bind_address
"""
return {
"bind-addresses": [
{
"addresses": [{"value": private_address}],
}
]
}

return patch("ops.testing._TestingModelBackend.network_get", network_get)
4 changes: 0 additions & 4 deletions tests/unit/test_charm.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,6 @@

from charm import MongoDBCharm, NotReadyError

from .helpers import patch_network_get

PYMONGO_EXCEPTIONS = [
(ConnectionFailure("error message"), ConnectionFailure),
(ConfigurationError("error message"), ConfigurationError),
Expand All @@ -37,7 +35,6 @@

class TestCharm(unittest.TestCase):
@patch("charm.get_charm_revision")
@patch_network_get(private_address="1.1.1.1")
def setUp(self, *unused):
self.maxDiff = None
self.harness = Harness(MongoDBCharm)
Expand Down Expand Up @@ -1047,7 +1044,6 @@ def test_set_password_provided(self, connection):
# verify app data is updated and results are reported to user
self.assertEqual("canonical123", new_password)

@patch_network_get(private_address="1.1.1.1")
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some of our charms are using this specific value 1.1.1.1 to do further checks, e.g. here.

How can we now mock the network_get and return a specific private_address?

@patch("charm.MongoDBCharm.has_backup_service")
@patch("charm.MongoDBBackups.get_pbm_status")
def test_set_backup_password_pbm_busy(self, pbm_status, has_backup_service):
Expand Down
8 changes: 0 additions & 8 deletions tests/unit/test_mongodb_backups.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,14 +25,11 @@

from charm import MongoDBCharm

from .helpers import patch_network_get

RELATION_NAME = "s3-credentials"


class TestMongoBackups(unittest.TestCase):
@patch("charm.get_charm_revision")
@patch_network_get(private_address="1.1.1.1")
def setUp(self, *unused):
self.harness = Harness(MongoDBCharm)
self.harness.begin()
Expand Down Expand Up @@ -269,7 +266,6 @@ def test_s3_credentials_no_db(self, defer):

defer.assert_called()

@patch_network_get(private_address="1.1.1.1")
@patch("charm.MongoDBCharm.has_backup_service")
@patch("charm.MongoDBBackups._set_config_options")
def test_s3_credentials_set_pbm_failure(self, _set_config_options, service):
Expand All @@ -295,7 +291,6 @@ def test_s3_credentials_set_pbm_failure(self, _set_config_options, service):

self.assertTrue(isinstance(self.harness.charm.unit.status, BlockedStatus))

@patch_network_get(private_address="1.1.1.1")
@patch("charm.MongoDBBackups._set_config_options")
@patch("charm.MongoDBBackups._resync_config_options")
@patch("ops.framework.EventBase.defer")
Expand Down Expand Up @@ -325,7 +320,6 @@ def test_s3_credentials_config_error(
)
self.assertTrue(isinstance(self.harness.charm.unit.status, BlockedStatus))

@patch_network_get(private_address="1.1.1.1")
@patch("charm.MongoDBBackups._set_config_options")
@patch("charm.MongoDBBackups._resync_config_options")
@patch("ops.framework.EventBase.defer")
Expand Down Expand Up @@ -354,7 +348,6 @@ def test_s3_credentials_syncing(self, pbm_status, service, defer, resync, _set_c
defer.assert_called()
self.assertTrue(isinstance(self.harness.charm.unit.status, WaitingStatus))

@patch_network_get(private_address="1.1.1.1")
@patch("charm.MongoDBBackups._set_config_options")
@patch("charm.MongoDBBackups._resync_config_options")
@patch("ops.framework.EventBase.defer")
Expand Down Expand Up @@ -386,7 +379,6 @@ def test_s3_credentials_pbm_busy(
defer.assert_called()
self.assertTrue(isinstance(self.harness.charm.unit.status, WaitingStatus))

@patch_network_get(private_address="1.1.1.1")
@patch("charm.MongoDBBackups._set_config_options")
@patch("charm.MongoDBBackups._resync_config_options")
@patch("ops.framework.EventBase.defer")
Expand Down
15 changes: 0 additions & 15 deletions tests/unit/test_mongodb_provider.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@

from charm import MongoDBCharm

from .helpers import patch_network_get

PYMONGO_EXCEPTIONS = [
(ConnectionFailure("error message"), ConnectionFailure),
(ConfigurationError("error message"), ConfigurationError),
Expand All @@ -26,7 +24,6 @@

class TestMongoProvider(unittest.TestCase):
@patch("charm.get_charm_revision")
@patch_network_get(private_address="1.1.1.1")
def setUp(self, *unused):
self.harness = Harness(MongoDBCharm)
mongo_resource = {
Expand Down Expand Up @@ -88,7 +85,6 @@ def test_relation_event_oversee_users_mongo_failure(self, oversee_users, defer,
defer.assert_called()

# oversee_users raises AssertionError when unable to attain users from relation
@patch_network_get(private_address="1.1.1.1")
@patch("charm.CrossAppVersionChecker.is_local_charm")
@patch("charms.mongodb.v0.set_status.get_charm_revision")
@patch("ops.framework.EventBase.defer")
Expand All @@ -112,7 +108,6 @@ def test_relation_event_oversee_users_fails_to_get_relation(self, oversee_users,
else:
self.harness.remove_relation_unit(relation_id, "consumer/0")

@patch_network_get(private_address="1.1.1.1")
@patch("charms.mongodb.v1.mongodb_provider.MongoConnection")
def test_oversee_users_get_users_failure(self, connection):
"""Verifies that when unable to retrieve users from mongod an exception is raised."""
Expand All @@ -124,7 +119,6 @@ def test_oversee_users_get_users_failure(self, connection):
dep_id, RelationEvent(mock.Mock(), mock.Mock())
)

@patch_network_get(private_address="1.1.1.1")
@patch("charm.MongoDBProvider._get_users_from_relations")
@patch("charms.mongodb.v1.mongodb_provider.MongoConnection")
def test_oversee_users_drop_user_failure(self, connection, relation_users):
Expand All @@ -146,7 +140,6 @@ def test_oversee_users_drop_user_failure(self, connection, relation_users):
dep_id, RelationEvent(mock.Mock(), mock.Mock())
)

@patch_network_get(private_address="1.1.1.1")
@patch("charm.MongoDBProvider._get_users_from_relations")
@patch("charms.mongodb.v1.mongodb_provider.MongoConnection")
def test_oversee_users_get_config_failure(self, connection, relation_users):
Expand All @@ -163,7 +156,6 @@ def test_oversee_users_get_config_failure(self, connection, relation_users):
dep_id, RelationEvent(mock.Mock(), mock.Mock())
)

@patch_network_get(private_address="1.1.1.1")
@patch("charm.MongoDBProvider._set_relation")
@patch("charm.MongoDBProvider._get_config")
@patch("charm.MongoDBProvider._get_users_from_relations")
Expand All @@ -186,7 +178,6 @@ def test_oversee_users_no_config_database(
connection.return_value.__enter__.return_value.create_user.assert_not_called()
set_relation.assert_not_called()

@patch_network_get(private_address="1.1.1.1")
@patch("charm.MongoDBProvider._set_relation")
@patch("charm.MongoDBProvider._get_config")
@patch("charm.MongoDBProvider._get_users_from_relations")
Expand All @@ -208,7 +199,6 @@ def test_oversee_users_create_user_failure(
)
set_relation.assert_not_called()

@patch_network_get(private_address="1.1.1.1")
@patch("charm.MongoDBProvider._get_config")
@patch("charm.MongoDBProvider._get_users_from_relations")
@patch("charms.mongodb.v1.mongodb_provider.MongoConnection")
Expand All @@ -228,7 +218,6 @@ def test_oversee_users_set_relation_failure(self, connection, relation_users, ge
dep_id, RelationEvent(mock.Mock(), mock.Mock())
)

@patch_network_get(private_address="1.1.1.1")
@patch("charm.MongoDBProvider._get_users_from_relations")
@patch("charms.mongodb.v1.mongodb_provider.MongoConnection")
def test_oversee_users_update_get_config_failure(self, connection, relation_users):
Expand All @@ -245,7 +234,6 @@ def test_oversee_users_update_get_config_failure(self, connection, relation_user
dep_id, RelationEvent(mock.Mock(), mock.Mock())
)

@patch_network_get(private_address="1.1.1.1")
@patch("charm.MongoDBProvider._get_config")
@patch("charm.MongoDBProvider._get_users_from_relations")
@patch("charms.mongodb.v1.mongodb_provider.MongoConnection")
Expand All @@ -265,7 +253,6 @@ def test_oversee_users_update_user_failure(self, connection, relation_users, get
dep_id, RelationEvent(mock.Mock(), mock.Mock())
)

@patch_network_get(private_address="1.1.1.1")
@patch("charm.MongoDBProvider._get_databases_from_relations")
@patch("charm.MongoDBProvider._get_users_from_relations")
@patch("charms.mongodb.v1.mongodb_provider.MongoConnection")
Expand All @@ -283,7 +270,6 @@ def test_oversee_users_no_auto_delete(
)
connection.return_value.__enter__.return_value.drop_database.assert_not_called()

@patch_network_get(private_address="1.1.1.1")
@patch("charm.MongoDBProvider._get_users_from_relations")
@patch("charms.mongodb.v1.mongodb_provider.MongoConnection")
def test_oversee_users_mongo_databases_failure(self, connection, relation_users):
Expand All @@ -300,7 +286,6 @@ def test_oversee_users_mongo_databases_failure(self, connection, relation_users)
dep_id, RelationEvent(mock.Mock(), mock.Mock())
)

@patch_network_get(private_address="1.1.1.1")
@patch("charm.MongoDBProvider._get_databases_from_relations")
@patch("charm.MongoDBProvider._get_users_from_relations")
@patch("charms.mongodb.v1.mongodb_provider.MongoConnection")
Expand Down
Loading