Merge ~axino/charm-canonical-is-reviewbot/+git/charm-canonical-is-reviewbot:axino into charm-canonical-is-reviewbot:main

[Junien F]

initial commit

[Barry Price (barryprice)]

Tiny nitpick inline, LGTM otherwise

review: Approve

[Junien F (axino)]

Fixed, thanks !

[🤖 Canonical IS Merge Bot (canonical-is-mergebot)]

This merge proposal is being monitored by mergebot. Change the status to Approved to merge.

[🤖 Canonical IS Merge Bot (canonical-is-mergebot)]

Change has no commit message, setting status to needs review.

[🤖 Canonical IS Merge Bot (canonical-is-mergebot)]

Change successfully merged at revision 9763831c66fb1ba544d4b657de58f8bac49ee979

diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..a26d707
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,9 @@
+venv/
+build/
+*.charm
+.tox/
+.coverage
+__pycache__/
+*.py[cod]
+.idea
+.vscode/
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..2969183
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,33 @@
+# Contributing
+
+To make contributions to this charm, you'll need a working [development setup](https://juju.is/docs/sdk/dev-setup).
+
+You can use the environments created by `tox` for development:
+
+```shell
+tox --notest -e unit
+source .tox/unit/bin/activate
+```
+
+## Testing
+
+This project uses `tox` for managing test environments. There are some pre-configured environments
+that can be used for linting and formatting code when you're preparing contributions to the charm:
+
+```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 the charm
+
+Build the charm in this git repository using:
+
+```shell
+charmcraft pack
+```
+
+<!-- You may want to include any contribution/style guidelines in this document>
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..ecbda55
--- /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 2022 Ubuntu
+
+   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
new file mode 100644
index 0000000..6cca19d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,7 @@
+# charm-canonical-is-reviewbot
+
+Charmhub package name: mm-reviewbot-charmers-canonical-is-reviewbot
+More information: https://charmhub.io/mm-reviewbot-charmers-canonical-is-reviewbot
+
+This charm deploys the Canonical IS reviewbot, which helps doing reviews of
+Launchpad merge proposals for the IS team.
diff --git a/charmcraft.yaml b/charmcraft.yaml
new file mode 100644
index 0000000..900d34a
--- /dev/null
+++ b/charmcraft.yaml
@@ -0,0 +1,11 @@
+# This file configures Charmcraft.
+# See https://juju.is/docs/sdk/charmcraft-config for guidance.
+
+type: charm
+bases:
+  - build-on:
+    - name: ubuntu
+      channel: "22.04"
+    run-on:
+    - name: ubuntu
+      channel: "22.04"
diff --git a/config.yaml b/config.yaml
new file mode 100644
index 0000000..79e1a0d
--- /dev/null
+++ b/config.yaml
@@ -0,0 +1,30 @@
+# This file defines charm config options, and populates the Configure tab on Charmhub.
+# If your charm does not require configuration options, delete this file entirely.
+#
+# See https://juju.is/docs/config for guidance.
+
+options:
+  launchpad_secret:
+    description: "Launchpad credential secret"
+    default: ""
+    type: string
+  launchpad_token:
+    description: "Launchpad credential token"
+    default: ""
+    type: string
+  mattermost_token:
+    description: "Mattermost API token"
+    default: ""
+    type: string
+  mattermost_channel:
+    description: "Mattermost channel in which to expect review requests"
+    default: ""
+    type: string
+  mattermost_url:
+    description: "Mattermost URL"
+    default: ""
+    type: string
+  mattermost_team:
+    description: "Mattermost team"
+    default: ""
+    type: string
diff --git a/metadata.yaml b/metadata.yaml
new file mode 100644
index 0000000..83d6842
--- /dev/null
+++ b/metadata.yaml
@@ -0,0 +1,18 @@
+name: canonical-is-reviewbot
+display-name: Mattermost Review Bot
+summary: MatterMost Review Bot charm
+maintainers:
+  - https://launchpad.net/~mm-reviewbot-charmers
+description: |
+  A charm which deploys Mattermost Review Bot on kubernetes.
+  Mattermost is a flexible, open source messaging platform that enables
+  secure team collaboration.
+  This bot allows reviewing Launchpad merge proposals on Mattermost
+containers:
+  reviewbot:
+    resource: reviewbot-image
+resources:
+  reviewbot-image:
+    type: oci-image
+    description: Reviewbot docker image
+    auto-fetch: true
diff --git a/pyproject.toml b/pyproject.toml
new file mode 100644
index 0000000..3f51442
--- /dev/null
+++ b/pyproject.toml
@@ -0,0 +1,39 @@
+# 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"]
+
+# Linting tools configuration
+[tool.ruff]
+line-length = 99
+select = ["E", "W", "F", "C", "N", "D", "I001"]
+extend-ignore = [
+    "D203",
+    "D204",
+    "D213",
+    "D215",
+    "D400",
+    "D404",
+    "D406",
+    "D407",
+    "D408",
+    "D409",
+    "D413",
+]
+ignore = ["E501", "D107"]
+extend-exclude = ["__pycache__", "*.egg_info"]
+per-file-ignores = {"tests/*" = ["D100","D101","D102","D103","D104"]}
+
+[tool.ruff.mccabe]
+max-complexity = 10
diff --git a/requirements.txt b/requirements.txt
new file mode 100644
index 0000000..56f5f64
--- /dev/null
+++ b/requirements.txt
@@ -0,0 +1 @@
+ops >= 1.5.0
diff --git a/src/charm.py b/src/charm.py
new file mode 100755
index 0000000..e2bf66d
--- /dev/null
+++ b/src/charm.py
@@ -0,0 +1,121 @@
+#!/usr/bin/env python3
+# Copyright 2022 Ubuntu
+# See LICENSE file for licensing details.
+#
+# Learn more at: https://juju.is/docs/sdk
+
+"""Charm the service.
+
+Refer to the following post for a quick-start guide that will help you
+develop a new k8s charm using the Operator Framework:
+
+https://discourse.charmhub.io/t/4208
+"""
+
+import logging
+
+from ops.charm import CharmBase
+from ops.main import main
+from ops.model import ActiveStatus, BlockedStatus, WaitingStatus
+
+# Log messages can be retrieved using juju debug-log
+logger = logging.getLogger(__name__)
+
+VALID_LOG_LEVELS = ["info", "debug", "warning", "error", "critical"]
+
+
+class CharmReviewbotCharm(CharmBase):
+    """Charm the service."""
+
+    def __init__(self, *args):
+        super().__init__(*args)
+        self.framework.observe(self.on.reviewbot_pebble_ready, self._on_reviewbot_pebble_ready)
+        self.framework.observe(self.on.config_changed, self._on_config_changed)
+
+    def _missing_config(self):
+        # All config options must be set
+        missing_config = []
+        for k, v in self.model.config.items():
+            if not v:
+                missing_config.append(k)
+        return missing_config
+
+    def _on_reviewbot_pebble_ready(self, event):
+        """Define and start a workload using the Pebble API.
+
+        Change this example to suit your needs. You'll need to specify the right entrypoint and
+        environment configuration for your specific workload.
+
+        Learn more about interacting with Pebble at at https://juju.is/docs/sdk/pebble.
+        """
+        missing_config = self._missing_config()
+        if missing_config:
+            self.unit.status = BlockedStatus(f"required config not set: '{missing_config}'")
+            return
+        # Get a reference the container attribute on the PebbleReadyEvent
+        container = event.workload
+        # Add initial Pebble config layer using the Pebble API
+        container.add_layer("reviewbot", self._pebble_layer, combine=True)
+        # Make Pebble reevaluate its plan, ensuring any services are started if enabled.
+        container.replan()
+        # Learn more about statuses in the SDK docs:
+        # https://juju.is/docs/sdk/constructs#heading--statuses
+        self.unit.status = ActiveStatus()
+
+    def _get_reviewbot_env_config(self) -> dict:
+        """Return an envConfig with configuration."""
+        env_config = {
+            "REVIEWBOT_LP_SECRET": self.config["launchpad_secret"],
+            "REVIEWBOT_LP_TOKEN": self.config["launchpad_token"],
+            "REVIEWBOT_MM_CHANNEL": self.config["mattermost_channel"],
+            "REVIEWBOT_MM_TEAM": self.config["mattermost_team"],
+            "REVIEWBOT_MM_TOKEN": self.config["mattermost_token"],
+            "REVIEWBOT_MM_URL": self.config["mattermost_url"],
+            "HOME": "/home/reviewbot",  # work around https://github.com/canonical/pebble/issues/183
+        }
+
+        return env_config
+
+    def _on_config_changed(self, event):
+        """Handle changed configuration."""
+        missing_config = self._missing_config()
+        if missing_config:
+            self.unit.status = BlockedStatus(f"required config not set: '{missing_config}'")
+            return
+
+        # The config is good, so update the configuration of the workload
+        container = self.unit.get_container("reviewbot")
+        # Verify that we can connect to the Pebble API in the workload container
+        if container.can_connect():
+            # Push an updated layer with the new config
+            container.add_layer("reviewbot", self._pebble_layer, combine=True)
+            container.replan()
+
+            self.unit.status = ActiveStatus()
+        else:
+            # We were unable to connect to the Pebble API, so we defer this event
+            event.defer()
+            self.unit.status = WaitingStatus("waiting for Pebble API")
+
+    @property
+    def _pebble_layer(self):
+        """Return a dictionary representing a Pebble layer."""
+        return {
+            "summary": "reviewbot layer",
+            "description": "pebble config layer for reviewbot",
+            "services": {
+                "reviewbot": {
+                    "override": "replace",
+                    "summary": "reviewbot",
+                    "user": "reviewbot",
+                    "group": "reviewbot",
+                    "command": "/app/bot.py",
+                    "startup": "enabled",
+                    "environment": self._get_reviewbot_env_config(),
+                },
+            },
+        }
+
+
+if __name__ == "__main__":  # pragma: nocover
+    main(CharmReviewbotCharm)
diff --git a/tests/unit/test_charm.py b/tests/unit/test_charm.py
new file mode 100644
index 0000000..3399c04
--- /dev/null
+++ b/tests/unit/test_charm.py
@@ -0,0 +1,108 @@
+# Copyright 2022 Ubuntu
+# See LICENSE file for licensing details.
+#
+# Learn more about testing at: https://juju.is/docs/sdk/testing
+
+import unittest
+
+import ops.testing
+from charm import CharmReviewbotCharm
+from ops.model import ActiveStatus, BlockedStatus, WaitingStatus
+from ops.testing import Harness
+
+
+class TestCharm(unittest.TestCase):
+    base_config = {
+        "launchpad_secret": "lps",
+        "launchpad_token": "lpt",
+        "mattermost_token": "mmtok",
+        "mattermost_channel": "mmc",
+        "mattermost_url": "mmu",
+        "mattermost_team": "mmt",
+    }
+
+    def setUp(self):
+        # Enable more accurate simulation of container networking.
+        # For more information, see https://juju.is/docs/sdk/testing#heading--simulate-can-connect
+        ops.testing.SIMULATE_CAN_CONNECT = True
+        self.addCleanup(setattr, ops.testing, "SIMULATE_CAN_CONNECT", False)
+
+        self.harness = Harness(CharmReviewbotCharm)
+        self.addCleanup(self.harness.cleanup)
+        self.harness.begin()
+
+    def test_reviewbot_pebble_ready(self):
+        # Expected plan after Pebble ready with default config
+        expected_plan = {
+            "services": {
+                "reviewbot": {
+                    "override": "replace",
+                    "summary": "reviewbot",
+                    "command": "/app/bot.py",
+                    "startup": "enabled",
+                    "environment": {
+                        "REVIEWBOT_LP_SECRET": "lps",
+                        "REVIEWBOT_LP_TOKEN": "lpt",
+                        "REVIEWBOT_MM_CHANNEL": "mmc",
+                        "REVIEWBOT_MM_TEAM": "mmt",
+                        "REVIEWBOT_MM_TOKEN": "mmtok",
+                        "REVIEWBOT_MM_URL": "mmu",
+                        "HOME": "/home/reviewbot",
+                    },
+                    "user": "reviewbot",
+                    "group": "reviewbot",
+                }
+            },
+        }
+        # Simulate the container coming up and emission of pebble-ready event
+        self.harness.update_config(self.base_config)
+        self.harness.container_pebble_ready("reviewbot")
+        # Get the plan now we've run PebbleReady
+        updated_plan = self.harness.get_container_pebble_plan("reviewbot").to_dict()
+        # Check we've got the plan we expected
+        self.assertEqual(expected_plan, updated_plan)
+        # Check the service was started
+        service = self.harness.model.unit.get_container("reviewbot").get_service("reviewbot")
+        self.assertTrue(service.is_running())
+        # Ensure we set an ActiveStatus with no message
+        self.assertEqual(self.harness.model.unit.status, ActiveStatus())
+
+    def test_reviewbot_pebble_ready_no_config(self):
+        # Expect an empty plan when a config item is missing
+        expected_plan = {}
+        # Simulate the container coming up and emission of pebble-ready event
+        self.harness.container_pebble_ready("reviewbot")
+        # Get the plan now we've run PebbleReady
+        updated_plan = self.harness.get_container_pebble_plan("reviewbot").to_dict()
+        # Check we've got the plan we expected
+        self.assertEqual(expected_plan, updated_plan)
+        # Ensure we got a BlockedStatus
+        self.assertIsInstance(self.harness.model.unit.status, BlockedStatus)
+
+    def test_config_changed_valid_can_connect(self):
+        # Ensure the simulated Pebble API is reachable
+        self.harness.set_can_connect("reviewbot", True)
+        # Trigger a config-changed event with an updated value
+        changed_config = self.base_config.copy()
+        changed_config["launchpad_secret"] = "CHANGED"
+        self.harness.update_config(changed_config)
+        # Get the plan now we've run PebbleReady
+        updated_plan = self.harness.get_container_pebble_plan("reviewbot").to_dict()
+        updated_env = updated_plan["services"]["reviewbot"]["environment"]
+        # Check the config change was effective
+        self.assertEqual(updated_env["REVIEWBOT_LP_SECRET"], "CHANGED")
+        self.assertEqual(self.harness.model.unit.status, ActiveStatus())
+
+    def test_config_changed_valid_cannot_connect(self):
+        # Trigger a config-changed event with an updated value
+        self.harness.update_config(self.base_config)
+        # Check the charm is in WaitingStatus
+        self.assertIsInstance(self.harness.model.unit.status, WaitingStatus)
+
+    def test_config_changed_invalid(self):
+        # Ensure the simulated Pebble API is reachable
+        self.harness.set_can_connect("reviewbot", True)
+        # Trigger a config-changed event with an updated value
+        self.harness.update_config({})
+        # Check the charm is in BlockedStatus
+        self.assertIsInstance(self.harness.model.unit.status, BlockedStatus)
diff --git a/tox.ini b/tox.ini
new file mode 100644
index 0000000..d4284f8
--- /dev/null
+++ b/tox.ini
@@ -0,0 +1,84 @@
+# Copyright 2022 Ubuntu
+# See LICENSE file for licensing details.
+
+[tox]
+skipsdist=True
+skip_missing_interpreters = True
+envlist = fmt, 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=pdb.set_trace
+  PY_COLORS=1
+passenv =
+  PYTHONPATH
+  CHARM_BUILD_DIR
+  MODEL_SETTINGS
+
+[testenv:fmt]
+description = Apply coding style standards to code
+deps =
+    black
+    ruff
+commands =
+    black {[vars]all_path}
+    ruff --fix {[vars]all_path}
+
+[testenv:lint]
+description = Check code against coding style standards
+deps =
+    black
+    ruff
+    codespell
+commands =
+    # uncomment the following line if this charm owns a lib
+    # codespell {[vars]lib_path}
+    codespell {toxinidir} \
+              --skip {toxinidir}/.git \
+              --skip {toxinidir}/.tox \
+              --skip {toxinidir}/build \
+              --skip {toxinidir}/lib \
+              --skip {toxinidir}/venv \
+              --skip {toxinidir}/.mypy_cache \
+              --skip {toxinidir}/icon.svg
+    
+    ruff {[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 \
+                 --tb native \
+                 -v \
+                 -s \
+                 {posargs}
+    coverage report
+
+[testenv:integration]
+description = Run integration tests
+deps =
+    pytest
+    juju
+    pytest-operator
+    -r{toxinidir}/requirements.txt
+commands =
+    pytest -v \
+           -s \
+           --tb native \
+           --ignore={[vars]tst_path}unit \
+           --log-cli-level=INFO \
+           {posargs}