From 6d7ebfcf8d401a9ba8927980a02e6c11a5fc3ff7 Mon Sep 17 00:00:00 2001 From: Marcelo Henrique Neppel Date: Thu, 25 Nov 2021 11:25:15 -0300 Subject: [PATCH] Template structure (#2) * Add initial charm structure * Add type hint for Pebble layer and use services attribute * Change name of the operator Co-authored-by: Jon Seager * Move testing and usage instructions to CONTRIBUTING.md * Add storage * Generate postgres user password instead of user provided password * Add missing imports * Subscription to on pebble ready event * Add tests structure from template * Remove default environment variables Co-authored-by: Jon Seager * Add type hint Co-authored-by: Daniela Plascencia * Change to get container from event workload * Improve readability of layers and services Co-authored-by: Mia Altieri * Implement peer relation Co-authored-by: Jon Seager Co-authored-by: Daniela Plascencia Co-authored-by: Mia Altieri --- .github/workflows/ci.yaml | 36 ++++++ .gitignore | 7 ++ .jujuignore | 3 + CONTRIBUTING.md | 59 ++++++++++ LICENSE | 202 ++++++++++++++++++++++++++++++++ README.md | 20 +++- actions.yaml | 5 + charmcraft.yaml | 12 ++ metadata.yaml | 31 +++++ pyproject.toml | 39 ++++++ requirements.txt | 1 + src/charm.py | 131 +++++++++++++++++++++ tests/integration/test_charm.py | 58 +++++++++ tests/unit/test_charm.py | 121 +++++++++++++++++++ tox.ini | 75 ++++++++++++ 15 files changed, 799 insertions(+), 1 deletion(-) create mode 100644 .github/workflows/ci.yaml create mode 100644 .gitignore create mode 100644 .jujuignore create mode 100644 CONTRIBUTING.md create mode 100644 LICENSE create mode 100644 actions.yaml create mode 100644 charmcraft.yaml create mode 100644 metadata.yaml create mode 100644 pyproject.toml create mode 100644 requirements.txt create mode 100755 src/charm.py create mode 100644 tests/integration/test_charm.py create mode 100644 tests/unit/test_charm.py create mode 100644 tox.ini diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml new file mode 100644 index 0000000000..32f7de9015 --- /dev/null +++ b/.github/workflows/ci.yaml @@ -0,0 +1,36 @@ +name: Tests +on: [pull_request, push] + +jobs: + lint: + name: Lint + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v2 + - name: Install dependencies + run: python3 -m pip install tox + - name: Run linters + run: tox -e lint + unit-test: + name: Unit tests + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v2 + - name: Install dependencies + run: python -m pip install tox + - name: Run tests + run: tox -e unit + integration-test-microk8s: + name: Integration tests (microk8s) + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v2 + - name: Setup operator environment + uses: charmed-kubernetes/actions-operator@main + with: + provider: microk8s + - name: Run integration tests + run: tox -e integration \ No newline at end of file diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000000..2c3f0e5ed7 --- /dev/null +++ b/.gitignore @@ -0,0 +1,7 @@ +venv/ +build/ +*.charm + +.coverage +__pycache__/ +*.py[cod] diff --git a/.jujuignore b/.jujuignore new file mode 100644 index 0000000000..6ccd559eab --- /dev/null +++ b/.jujuignore @@ -0,0 +1,3 @@ +/venv +*.py[cod] +*.charm diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000..4c2c281eb4 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,59 @@ +# Contributing + +## Overview + +This documents explains the processes and practices recommended for contributing enhancements to +this operator. + +- Generally, before developing enhancements to this charm, you should consider [opening an issue + ](https://github.com/canonical/postgresql-k8s-operator/issues) explaining your use case. +- If you would like to chat with us about your use-cases or proposed implementation, you can reach + us at [Canonical Mattermost public channel](https://chat.charmhub.io/charmhub/channels/charm-dev) + or [Discourse](https://discourse.charmhub.io/). +- Familiarising yourself with the [Charmed Operator Framework](https://juju.is/docs/sdk) library + will help you a lot when working on new features or bug fixes. +- All enhancements require review before being merged. Code review typically examines + - code quality + - test coverage + - user experience for Juju administrators this charm. +- Please help us out in ensuring easy to review branches by rebasing your pull request branch onto + the `main` branch. This also avoids merge commits and creates a linear Git commit history. + +## Developing + +You can use the environments created by `tox` for development: + +```shell +tox --notest -e unit +source .tox/unit/bin/activate +``` + +### Testing + +```shell +tox -e fmt # update your code according to linting rules +tox -e lint # code style +tox -e unit # unit tests +tox -e integration # integration tests +tox # runs 'lint' and 'unit' environments +``` + +## Build charm + +Build the charm in this git repository using: + +```shell +charmcraft pack +``` + +### Deploy + +```bash +# Create a model +juju add-model dev +# Enable DEBUG logging +juju model-config logging-config="=INFO;unit=DEBUG" +# Deploy the charm +juju deploy ./postgresql-k8s_ubuntu-20.04-amd64.charm \ + --resource postgresql-image=ubuntu/postgres +``` \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000000..d645695673 --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md index 3c0b0b060f..b453af70ca 100644 --- a/README.md +++ b/README.md @@ -1 +1,19 @@ -Coming soon +# PostgreSQL Kubernetes Operator + +## Description + +The PostgreSQL Kubernetes Operator deploys and operates the [PostgreSQL](https://www.postgresql.org/about/) database on Kubernetes clusters. + +This operator provides a Postgres database with replication enabled (one master instance and one or more hot standby replicas). The Operator in this repository is a Python script which wraps the LTS Postgres versions distributed by [Ubuntu](https://hub.docker.com/r/ubuntu/postgres), providing lifecycle management and handling events (install, configure, integrate, remove). + +## Usage + +As this charm is not yet published, you need to follow the build and deploy instructions from [CONTRIBUTING.md](CONTRIBUTING.md). + +## Accessing the database + +You can access the database using any PostgreSQL client by connecting on the unit address and port `5432` as user `postgres` with the password shown by the command below. + +```bash +juju run-action postgresql-k8s/0 get-postgres-password --wait +``` \ No newline at end of file diff --git a/actions.yaml b/actions.yaml new file mode 100644 index 0000000000..cf8b610d77 --- /dev/null +++ b/actions.yaml @@ -0,0 +1,5 @@ +# Copyright 2021 Canonical Ltd. +# See LICENSE file for licensing details. + +get-postgres-password: + description: Get the initial postgres user password for the database. \ No newline at end of file diff --git a/charmcraft.yaml b/charmcraft.yaml new file mode 100644 index 0000000000..2903d1a256 --- /dev/null +++ b/charmcraft.yaml @@ -0,0 +1,12 @@ +type: "charm" +bases: + - build-on: + - name: "ubuntu" + channel: "20.04" + run-on: + - name: "ubuntu" + channel: "20.04" +parts: + charm: + build-packages: + - git \ No newline at end of file diff --git a/metadata.yaml b/metadata.yaml new file mode 100644 index 0000000000..5b2369a7d0 --- /dev/null +++ b/metadata.yaml @@ -0,0 +1,31 @@ +# Copyright 2021 Canonical Ltd. +# See LICENSE file for licensing details. + +name: postgresql-k8s +display-name: PostgreSQL K8s +description: | + Charm to operate the PostgreSQL database on Kubernetes clusters +summary: | + Charm to operate the PostgreSQL database on Kubernetes clusters + +containers: + postgresql: + resource: postgresql-image + mounts: + - storage: pgdata + location: /var/lib/postgresql/data/pgdata + +resources: + postgresql-image: + type: oci-image + description: OCI image for PostgreSQL (ubuntu/postgres) + upstream-source: ubuntu/postgres:12-20.04_beta + +peers: + postgresql-replicas: + interface: postgresql-replicas + +storage: + pgdata: + type: filesystem + location: /var/lib/postgresql/data/pgdata \ No newline at end of file diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000000..9a931cf8aa --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,39 @@ +# Copyright 2021 Canonical Ltd. +# See LICENSE file for licensing details. + +# Testing tools configuration +[tool.coverage.run] +branch = true + +[tool.coverage.report] +show_missing = true + +[tool.pytest.ini_options] +minversion = "6.0" +log_cli_level = "INFO" + +# Formatting tools configuration +[tool.black] +line-length = 99 +target-version = ["py38"] + +[tool.isort] +profile = "black" + +# Linting tools configuration +[tool.flake8] +max-line-length = 99 +max-doc-length = 99 +max-complexity = 10 +exclude = [".git", "__pycache__", ".tox", "build", "dist", "*.egg_info", "venv"] +select = ["E", "W", "F", "C", "N", "R", "D", "H"] +# Ignore W503, E501 because using black creates errors with this +# Ignore D107 Missing docstring in __init__ +ignore = ["W503", "E501", "D107"] +# D100, D101, D102, D103: Ignore missing docstrings in tests +per-file-ignores = ["tests/*:D100,D101,D102,D103,D104"] +docstring-convention = "google" +# Check for properly formatted copyright header in each file +copyright-check = "True" +copyright-author = "Canonical Ltd." +copyright-regexp = "Copyright\\s\\d{4}([-,]\\d{4})*\\s+%(author)s" diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000000..ed6be36b5d --- /dev/null +++ b/requirements.txt @@ -0,0 +1 @@ +git+https://github.com/canonical/operator/#egg=ops diff --git a/src/charm.py b/src/charm.py new file mode 100755 index 0000000000..256a3e7a79 --- /dev/null +++ b/src/charm.py @@ -0,0 +1,131 @@ +#!/usr/bin/env python3 +# Copyright 2021 Canonical Ltd. +# See LICENSE file for licensing details. + +"""Charmed Kubernetes Operator for the PostgreSQL database.""" + +import logging +import secrets +import string + +from ops.charm import ActionEvent, CharmBase, WorkloadEvent +from ops.main import main +from ops.model import ActiveStatus, Relation, WaitingStatus +from ops.pebble import Layer + +logger = logging.getLogger(__name__) + + +class PostgresqlOperatorCharm(CharmBase): + """Charmed Operator for the PostgreSQL database.""" + + def __init__(self, *args): + super().__init__(*args) + + self._postgresql_service = "postgresql" + + self.framework.observe(self.on.install, self._on_install) + self.framework.observe(self.on.config_changed, self._on_config_changed) + self.framework.observe(self.on.leader_elected, self._on_leader_elected) + self.framework.observe(self.on.postgresql_pebble_ready, self._on_postgresql_pebble_ready) + self.framework.observe( + self.on.get_postgres_password_action, self._on_get_postgres_password + ) + + def _on_install(self, _): + """Event handler for InstallEvent.""" + # TODO: placeholder method to implement logic specific to install event. + pass + + def _on_config_changed(self, _): + """Handle the config-changed event.""" + # TODO: placeholder method to implement logic specific to configuration change. + pass + + def _on_leader_elected(self, _) -> None: + """Handle the leader-elected event.""" + data = self._peers.data[self.app] + postgres_password = data.get("postgres-password", None) + + if postgres_password is None: + self._peers.data[self.app]["postgres-password"] = self._new_password() + + def _on_postgresql_pebble_ready(self, event: WorkloadEvent) -> None: + """Event handler for on PebbleReadyEvent.""" + # TODO: move this code to an "_update_layer" method in order to also utilize it in + # config-changed hook. + # Get the postgresql container so we can configure/manipulate it. + container = event.workload + # Create a new config layer. + new_layer = self._postgresql_layer() + + if container.can_connect(): + # Get the current layer. + current_layer = container.get_plan() + # Check if there are any changes to layer services. + if current_layer.services != new_layer.services: + # Changes were made, add the new layer. + container.add_layer(self._postgresql_service, new_layer, combine=True) + logging.info("Added updated layer 'postgresql' to Pebble plan") + # Restart it and report a new status to Juju. + container.restart(self._postgresql_service) + logging.info("Restarted postgresql service") + # All is well, set an ActiveStatus. + self.unit.status = ActiveStatus() + else: + self.unit.status = WaitingStatus("waiting for Pebble in workload container") + + def _on_get_postgres_password(self, event: ActionEvent) -> None: + """Returns the password for the postgres user as an action response.""" + event.set_results({"postgres-password": self._get_postgres_password()}) + + def _postgresql_layer(self) -> Layer: + """Returns a Pebble configuration layer for PostgreSQL.""" + layer_config = { + "summary": "postgresql layer", + "description": "pebble config layer for postgresql", + "services": { + self._postgresql_service: { + "override": "replace", + "summary": "entrypoint of the postgresql image", + "command": "/usr/local/bin/docker-entrypoint.sh postgres", + "startup": "enabled", + "environment": { + "PGDATA": "/var/lib/postgresql/data/pgdata", + # We need to set either POSTGRES_HOST_AUTH_METHOD or POSTGRES_PASSWORD + # in order to initialize the database. + "POSTGRES_PASSWORD": self._get_postgres_password(), + }, + } + }, + } + return Layer(layer_config) + + def _new_password(self) -> str: + """Generate a random password string. + + Returns: + A random password string. + """ + choices = string.ascii_letters + string.digits + password = "".join([secrets.choice(choices) for i in range(16)]) + return password + + @property + def _peers(self) -> Relation: + """Fetch the peer relation. + + Returns: + A :class:`ops.model.Relation` object representing + the peer relation. + """ + return self.model.get_relation("postgresql-replicas") + + def _get_postgres_password(self) -> str: + """Get postgres user password.""" + data = self._peers.data[self.app] + return data.get("postgres-password", None) + + +if __name__ == "__main__": + main(PostgresqlOperatorCharm, use_juju_for_storage=True) diff --git a/tests/integration/test_charm.py b/tests/integration/test_charm.py new file mode 100644 index 0000000000..eed969c339 --- /dev/null +++ b/tests/integration/test_charm.py @@ -0,0 +1,58 @@ +#!/usr/bin/env python3 +# Copyright 2021 Canonical Ltd. +# See LICENSE file for licensing details. + + +import logging +from pathlib import Path + +import psycopg2 +import pytest +import yaml +from pytest_operator.plugin import OpsTest + +logger = logging.getLogger(__name__) + +METADATA = yaml.safe_load(Path("./metadata.yaml").read_text()) +APP_NAME = METADATA["name"] + + +@pytest.mark.abort_on_fail +async def test_build_and_deploy(ops_test: OpsTest): + """Build the charm-under-test and deploy it. + + Assert on the unit status before any relations/configurations take place. + """ + # Build and deploy charm from local source folder. + charm = await ops_test.build_charm(".") + resources = {"postgresql-image": METADATA["resources"]["postgresql-image"]["upstream-source"]} + # Deploy two units in order to test later the sharing of password through peer relation data. + await ops_test.model.deploy(charm, resources=resources, application_name=APP_NAME, num_units=2) + + # Issuing dummy update_status just to trigger an event. + await ops_test.model.set_config({"update-status-hook-interval": "10s"}) + + await ops_test.model.wait_for_idle(apps=[APP_NAME], status="active", timeout=1000) + assert ops_test.model.applications[APP_NAME].units[0].workload_status == "active" + + # Effectively disable the update status from firing. + await ops_test.model.set_config({"update-status-hook-interval": "60m"}) + + +@pytest.mark.abort_on_fail +async def test_database_is_up(ops_test: OpsTest): + # Retrieving the postgres user password using the action. + action = await ops_test.model.units.get(f"{APP_NAME}/0").run_action("get-postgres-password") + action = await action.wait() + password = action.results["postgres-password"] + + # Testing the connection to each PostgreSQL instance. + status = await ops_test.model.get_status() # noqa: F821 + for _, unit in status["applications"][APP_NAME]["units"].items(): + host = unit["address"] + logger.info("connecting to the database host: %s", host) + connection = psycopg2.connect( + f"dbname='postgres' user='postgres' host='{host}' password='{password}' connect_timeout=1" + ) + assert connection.status == psycopg2.extensions.STATUS_READY + connection.close() diff --git a/tests/unit/test_charm.py b/tests/unit/test_charm.py new file mode 100644 index 0000000000..dfded3451a --- /dev/null +++ b/tests/unit/test_charm.py @@ -0,0 +1,121 @@ +# Copyright 2021 Canonical Ltd. +# See LICENSE file for licensing details. + +import re +import unittest +from unittest.mock import Mock, patch + +from ops.model import ActiveStatus, WaitingStatus +from ops.testing import Harness + +from charm import PostgresqlOperatorCharm + + +class TestCharm(unittest.TestCase): + def setUp(self): + self._peer_relation = "postgresql-replicas" + self._postgresql_container = "postgresql" + self._postgresql_service = "postgresql" + + self.harness = Harness(PostgresqlOperatorCharm) + self.addCleanup(self.harness.cleanup) + self.harness.begin() + self.charm = self.harness.charm + + def test_on_leader_elected(self): + # Assert that there is no password in the peer relation. + self.harness.add_relation(self._peer_relation, self.charm.app.name) + self.assertIsNone(self.charm._peers.data[self.charm.app].get("postgres-password", None)) + + # Check that a new password was generated on leader election. + self.harness.set_leader() + password = self.charm._peers.data[self.charm.app].get("postgres-password", None) + self.assertIsNotNone(password) + + # Trigger a new leader election and check that the password is still the same. + self.harness.set_leader(False) + self.harness.set_leader() + self.assertEqual( + self.charm._peers.data[self.charm.app].get("postgres-password", None), password + ) + + def test_on_postgresql_pebble_ready(self): + # Check that the initial plan is empty. + plan = self.harness.get_container_pebble_plan(self._postgresql_container) + self.assertEqual(plan.to_dict(), {}) + + # Trigger a pebble-ready hook and test the status before we can connect to the container. + self.harness.add_relation(self._peer_relation, self.charm.app.name) + with patch("ops.model.Container.can_connect") as _can_connect: + _can_connect.return_value = False + self.harness.container_pebble_ready(self._postgresql_container) + self.assertEqual( + self.harness.model.unit.status, + WaitingStatus("waiting for Pebble in workload container"), + ) + + # Get the current and the expected layer from the pebble plan and the _postgresql_layer + # method, respectively. + self.harness.container_pebble_ready(self._postgresql_container) + plan = self.harness.get_container_pebble_plan(self._postgresql_container) + expected = self.charm._postgresql_layer().to_dict() + expected.pop("summary", "") + expected.pop("description", "") + # Check the plan is as expected. + self.assertEqual(plan.to_dict(), expected) + self.assertEqual(self.harness.model.unit.status, ActiveStatus()) + container = self.harness.model.unit.get_container(self._postgresql_container) + self.assertEqual(container.get_service(self._postgresql_service).is_running(), True) + + @patch("charm.PostgresqlOperatorCharm._get_postgres_password") + def test_on_get_postgres_password(self, _get_postgres_password): + mock_event = Mock() + _get_postgres_password.return_value = "test-password" + self.charm._on_get_postgres_password(mock_event) + _get_postgres_password.assert_called_once() + mock_event.set_results.assert_called_once_with({"postgres-password": "test-password"}) + + def test_postgresql_layer(self): + # Test with the already generated password. + self.harness.add_relation(self._peer_relation, self.charm.app.name) + self.harness.set_leader() + plan = self.charm._postgresql_layer().to_dict() + expected = { + "summary": "postgresql layer", + "description": "pebble config layer for postgresql", + "services": { + self._postgresql_service: { + "override": "replace", + "summary": "entrypoint of the postgresql image", + "command": "/usr/local/bin/docker-entrypoint.sh postgres", + "startup": "enabled", + "environment": { + "PGDATA": "/var/lib/postgresql/data/pgdata", + "POSTGRES_PASSWORD": self.charm._get_postgres_password(), + }, + } + }, + } + self.assertEqual(plan, expected) + + def test_new_password(self): + # Test the password generation twice in order to check if we get different passwords and + # that they meet the required criteria. + first_password = self.charm._new_password() + self.assertEqual(len(first_password), 16) + self.assertIsNotNone(re.fullmatch("[a-zA-Z0-9\b]{16}$", first_password)) + + second_password = self.charm._new_password() + self.assertIsNotNone(re.fullmatch("[a-zA-Z0-9\b]{16}$", second_password)) + self.assertNotEqual(second_password, first_password) + + def test_get_postgres_password(self): + # Test for a None password. + self.harness.add_relation(self._peer_relation, self.charm.app.name) + self.assertIsNone(self.charm._get_postgres_password()) + + # Then test for a non empty password after leader election and peer data set. + self.harness.set_leader() + password = self.charm._get_postgres_password() + self.assertIsNotNone(password) + self.assertNotEqual(password, "") diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000000..ffd57cbfba --- /dev/null +++ b/tox.ini @@ -0,0 +1,75 @@ +# Copyright 2021 Canonical Ltd. +# See LICENSE file for licensing details. + +[tox] +skipsdist=True +skip_missing_interpreters = True +envlist = lint, unit + +[vars] +src_path = {toxinidir}/src/ +tst_path = {toxinidir}/tests/ +;lib_path = {toxinidir}/lib/charms/operator_name_with_underscores +all_path = {[vars]src_path} {[vars]tst_path} + +[testenv] +setenv = + PYTHONPATH = {toxinidir}:{toxinidir}/lib:{[vars]src_path} + PYTHONBREAKPOINT=ipdb.set_trace + PY_COLORS=1 +passenv = + PYTHONPATH + HOME + CHARM_BUILD_DIR + MODEL_SETTINGS + +[testenv:fmt] +description = Apply coding style standards to code +deps = + black + isort +commands = + isort {[vars]all_path} + black {[vars]all_path} + +[testenv:lint] +description = Check code against coding style standards +deps = + black + flake8 + flake8-docstrings + flake8-copyright + flake8-builtins + pyproject-flake8 + pep8-naming + isort + codespell +commands = + codespell {toxinidir}/*.yaml {toxinidir}/*.ini {toxinidir}/*.md \ + {toxinidir}/*.toml {toxinidir}/*.txt {toxinidir}/.github + # pflake8 wrapper supports config from pyproject.toml + pflake8 {[vars]all_path} + isort --check-only --diff {[vars]all_path} + black --check --diff {[vars]all_path} + +[testenv:unit] +description = Run unit tests +deps = + pytest + coverage[toml] + -r{toxinidir}/requirements.txt +commands = + coverage run --source={[vars]src_path} \ + -m pytest --ignore={[vars]tst_path}integration -v --tb native -s {posargs} + coverage report + +[testenv:integration] +description = Run integration tests +deps = + git+https://github.com/juju/python-libjuju.git + pytest + git+https://github.com/charmed-kubernetes/pytest-operator.git + psycopg2-binary + -r{toxinidir}/requirements.txt +commands = + pytest -v --tb native --ignore={[vars]tst_path}unit --log-cli-level=INFO -s {posargs}