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

test(charm): simplify relation tests with new add_relation #17

Closed
wants to merge 2 commits into from
Closed

test(charm): simplify relation tests with new add_relation #17

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
131f133
chore(charm): update ops library to 2.6.0
jnsgruk Aug 31, 2023
f86043f
test(charm): simplify relation unit tests with new add_relation
jnsgruk Aug 31, 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
2 changes: 1 addition & 1 deletion operator/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
ops == 2.2.0
ops == 2.6.0
psycopg[binary] == 3.1.10
34 changes: 11 additions & 23 deletions operator/tests/unit/test_charm.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,19 +28,11 @@ def __init__(self, id, name="database"):
self.id = id


def init_db_relation(harness) -> id:
"""Reduce repetition in setting up relation with Postgres."""
harness.set_leader(True)
rel_id = harness.add_relation("database", "postgresql")
harness.add_relation_unit(rel_id, "postgresql/0")
harness.update_relation_data(rel_id, "postgresql/0", DB_RELATION_DATA)
return rel_id


class TestCharm(unittest.TestCase):
def setUp(self):
self.harness = ops.testing.Harness(RatingsCharm)
self.addCleanup(self.harness.cleanup)
self.harness.set_leader(True)
self.harness.begin()

def test_ratings_pebble_ready_no_relation(self):
Expand All @@ -53,13 +45,13 @@ def test_ratings_pebble_ready_no_relation(self):
)

def test_ratings_sets_database_name_on_database_relation(self):
rel_id = init_db_relation(self.harness)
rel_id = self.harness.add_relation("database", "postgresql", unit_data=DB_RELATION_DATA)
self.harness.container_pebble_ready("ratings")
app_data = self.harness.get_relation_data(rel_id, self.harness.charm.app.name)
self.assertEqual(app_data, {"database": "ratings"})

def test_ratings_pebble_ready_waits_for_db_initialisation(self):
init_db_relation(self.harness)
self.harness.add_relation("database", "postgresql", unit_data=DB_RELATION_DATA)
self.harness.container_pebble_ready("ratings")
self.assertEqual(
self.harness.model.unit.status, ops.WaitingStatus("Ratings not yet initialised")
Expand All @@ -68,7 +60,7 @@ def test_ratings_pebble_ready_waits_for_db_initialisation(self):
@patch("charm.RatingsCharm._ratings", MOCK_RATINGS)
@patch("ratings.Ratings.ready", lambda x: True)
def test_ratings_pebble_ready_sets_correct_plan(self):
init_db_relation(self.harness)
self.harness.add_relation("database", "postgresql", unit_data=DB_RELATION_DATA)
self.harness.container_pebble_ready("ratings")
self.assertEqual(self.harness.model.unit.status, ops.ActiveStatus())
expected = {
Expand All @@ -92,15 +84,15 @@ def test_ratings_pebble_ready_sets_correct_plan(self):
@patch("charm.RatingsCharm._ratings", MOCK_RATINGS)
@patch("ratings.Ratings.ready", lambda x: True)
def test_ratings_pebble_ready_waits_for_container(self):
init_db_relation(self.harness)
self.harness.add_relation("database", "postgresql", unit_data=DB_RELATION_DATA)
self.harness.set_can_connect("ratings", False)
self.harness.charm.on.ratings_pebble_ready.emit(SimpleNamespace(workload="foo"))
self.assertEqual(
self.harness.model.unit.status, ops.WaitingStatus("Waiting for ratings container")
)

def test_ratings_database_created_ratings_not_initialised(self):
rel_id = init_db_relation(self.harness)
rel_id = self.harness.add_relation("database", "postgresql", unit_data=DB_RELATION_DATA)
self.harness.charm._database.on.database_created.emit(MockDatabaseEvent(id=rel_id))
self.harness.set_can_connect("ratings", True)
plan = self.harness.get_container_pebble_plan("ratings").to_dict()
Expand All @@ -109,7 +101,7 @@ def test_ratings_database_created_ratings_not_initialised(self):
@patch("charm.DatabaseRequires.is_resource_created", lambda x: True)
@patch("ratings.Ratings.ready")
def test_ratings_database_created_database_not_initialised_fail_create_tables(self, db_init):
rel_id = init_db_relation(self.harness)
rel_id = self.harness.add_relation("database", "postgresql", unit_data=DB_RELATION_DATA)
db_init.side_effect = DatabaseInitialisationError
self.harness.charm._database.on.database_created.emit(MockDatabaseEvent(id=rel_id))
self.assertEqual(
Expand All @@ -119,7 +111,7 @@ def test_ratings_database_created_database_not_initialised_fail_create_tables(se
@patch("charm.DatabaseRequires.is_resource_created", lambda x: True)
@patch("ratings.Ratings.ready", lambda x: True)
def test_ratings_database_created_database_success(self):
rel_id = init_db_relation(self.harness)
rel_id = self.harness.add_relation("database", "postgresql", unit_data=DB_RELATION_DATA)
self.harness.set_can_connect("ratings", True)
self.harness.charm._database.on.database_created.emit(MockDatabaseEvent(id=rel_id))
self.assertEqual(self.harness.model.unit.status, ops.ActiveStatus())
Expand All @@ -129,28 +121,24 @@ def test_ratings_db_connection_string_no_relation(self):

@patch("charm.DatabaseRequires.fetch_relation_data", lambda x: {0: DB_RELATION_DATA})
def test_ratings_db_connection_string(self):
init_db_relation(self.harness)
self.harness.add_relation("database", "postgresql", unit_data=DB_RELATION_DATA)
expected = "postgres://username:password@postgres:5432/ratings"
self.assertEqual(self.harness.charm._db_connection_string(), expected)

def test_ratings_jwt_secret_no_relation(self):
self.harness.set_leader(True)
new_secret = self.harness.charm._jwt_secret()
self.assertEqual(new_secret, "")

def test_ratings_jwt_secret_create(self):
self.harness.set_leader(True)
self.harness.add_relation("ratings-peers", "ubuntu-software-ratings")
new_secret = self.harness.charm._jwt_secret()
self.assertEqual(len(new_secret), 48)

def test_ratings_jwt_secret_from_peer_data(self):
self.harness.set_leader(True)
content = {"jwt-secret": "deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef"}
secret_id = self.harness.add_model_secret(owner=self.harness.charm.app, content=content)
rel_id = self.harness.add_relation("ratings-peers", "ubuntu-software-ratings")
self.harness.update_relation_data(
rel_id, self.harness.charm.app.name, {"jwt-secret-id": secret_id}
self.harness.add_relation(
"ratings-peers", "ubuntu-software-ratings", app_data={"jwt-secret-id": secret_id}
)
secret = self.harness.charm._jwt_secret()
self.assertEqual(secret, content["jwt-secret"])
Expand Down
Loading