From 38079087245a695f0eee2b56ebe5fa9da35f0640 Mon Sep 17 00:00:00 2001 From: Chris MacNaughton Date: Fri, 26 Nov 2021 13:28:05 +0100 Subject: [PATCH] Initial commit --- .flake8 | 9 ++ .gitignore | 8 + .jujuignore | 3 + .stestr.conf | 3 + CONTRIBUTING.md | 34 +++++ LICENSE | 202 +++++++++++++++++++++++++ README.md | 24 +++ actions.yaml | 16 ++ build-requirements.txt | 1 + charmcraft.yaml | 10 ++ config.yaml | 14 ++ metadata.yaml | 23 +++ osci.yaml | 29 ++++ requirements-dev.txt | 3 + requirements.txt | 5 + src/charm.py | 140 +++++++++++++++++ templates/ceph.client.ceph-nfs.keyring | 3 + templates/ceph.conf | 15 ++ test-requirements.txt | 16 ++ tests/bundles/focal-octopus.yaml | 27 ++++ tests/tests.yaml | 12 ++ tox.ini | 133 ++++++++++++++++ unit_tests/__init__.py | 0 unit_tests/test_charm.py | 72 +++++++++ 24 files changed, 802 insertions(+) create mode 100644 .flake8 create mode 100644 .gitignore create mode 100644 .jujuignore create mode 100644 .stestr.conf create mode 100644 CONTRIBUTING.md create mode 100644 LICENSE create mode 100644 README.md create mode 100644 actions.yaml create mode 100644 build-requirements.txt create mode 100644 charmcraft.yaml create mode 100644 config.yaml create mode 100644 metadata.yaml create mode 100644 osci.yaml create mode 100644 requirements-dev.txt create mode 100644 requirements.txt create mode 100755 src/charm.py create mode 100644 templates/ceph.client.ceph-nfs.keyring create mode 100644 templates/ceph.conf create mode 100644 test-requirements.txt create mode 100644 tests/bundles/focal-octopus.yaml create mode 100644 tests/tests.yaml create mode 100644 tox.ini create mode 100644 unit_tests/__init__.py create mode 100644 unit_tests/test_charm.py diff --git a/.flake8 b/.flake8 new file mode 100644 index 0000000..8ef84fc --- /dev/null +++ b/.flake8 @@ -0,0 +1,9 @@ +[flake8] +max-line-length = 99 +select: E,W,F,C,N +exclude: + venv + .git + build + dist + *.egg_info diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..f3c3e4d --- /dev/null +++ b/.gitignore @@ -0,0 +1,8 @@ +.tox +**/*.swp +__pycache__ +.stestr/ +lib/* +!lib/README.txt +build +ceph-iscsi.charm diff --git a/.jujuignore b/.jujuignore new file mode 100644 index 0000000..6ccd559 --- /dev/null +++ b/.jujuignore @@ -0,0 +1,3 @@ +/venv +*.py[cod] +*.charm diff --git a/.stestr.conf b/.stestr.conf new file mode 100644 index 0000000..5fcccac --- /dev/null +++ b/.stestr.conf @@ -0,0 +1,3 @@ +[DEFAULT] +test_path=./unit_tests +top_dir=./ diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..61ef5c8 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,34 @@ +# ceph-nfs + +## Developing + +Create and activate a virtualenv with the development requirements: + + virtualenv -p python3 venv + source venv/bin/activate + pip install -r requirements-dev.txt + +## Code overview + +TEMPLATE-TODO: +One of the most important things a consumer of your charm (or library) +needs to know is what set of functionality it provides. Which categories +does it fit into? Which events do you listen to? Which libraries do you +consume? Which ones do you export and how are they used? + +## Intended use case + +TEMPLATE-TODO: +Why were these decisions made? What's the scope of your charm? + +## Roadmap + +If this Charm doesn't fulfill all of the initial functionality you were +hoping for or planning on, please add a Roadmap or TODO here + +## Testing + +The Python operator framework includes a very nice harness for testing +operator behaviour without full deployment. Just `run_tests`: + + ./run_tests diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d645695 --- /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 new file mode 100644 index 0000000..0276d99 --- /dev/null +++ b/README.md @@ -0,0 +1,24 @@ +# ceph-nfs + +## Description + +TODO: Describe your charm in a few paragraphs of Markdown + +## Usage + +TODO: Provide high-level usage, such as required config or relations + + +## Relations + +TODO: Provide any relations which are provided or required by your charm + +## OCI Images + +TODO: Include a link to the default image your charm uses + +## Contributing + +Please see the [Juju SDK docs](https://juju.is/docs/sdk) for guidelines +on enhancements to this charm following best practice guidelines, and +`CONTRIBUTING.md` for developer guidance. diff --git a/actions.yaml b/actions.yaml new file mode 100644 index 0000000..b38973f --- /dev/null +++ b/actions.yaml @@ -0,0 +1,16 @@ +# Copyright 2021 OpenStack Charmers +# See LICENSE file for licensing details. +# +# TEMPLATE-TODO: change this example to suit your needs. +# If you don't need actions, you can remove the file entirely. +# It ties in to the example _on_fortune_action handler in src/charm.py +# +# Learn more about actions at: https://juju.is/docs/sdk/actions + +fortune: + description: Returns a pithy phrase. + params: + fail: + description: "Fail with this message" + type: string + default: "" diff --git a/build-requirements.txt b/build-requirements.txt new file mode 100644 index 0000000..271d895 --- /dev/null +++ b/build-requirements.txt @@ -0,0 +1 @@ +git+https://github.com/canonical/charmcraft.git@0.10.2#egg=charmcraft diff --git a/charmcraft.yaml b/charmcraft.yaml new file mode 100644 index 0000000..048d454 --- /dev/null +++ b/charmcraft.yaml @@ -0,0 +1,10 @@ +# Learn more about charmcraft.yaml configuration at: +# https://juju.is/docs/sdk/charmcraft-config +type: "charm" +bases: + - build-on: + - name: "ubuntu" + channel: "20.04" + run-on: + - name: "ubuntu" + channel: "20.04" diff --git a/config.yaml b/config.yaml new file mode 100644 index 0000000..edb967c --- /dev/null +++ b/config.yaml @@ -0,0 +1,14 @@ +# Copyright 2021 OpenStack Charmers +# See LICENSE file for licensing details. +# +# TEMPLATE-TODO: change this example to suit your needs. +# If you don't need a config, you can remove the file entirely. +# It ties in to the example _on_config_changed handler in src/charm.py +# +# Learn more about config at: https://juju.is/docs/sdk/config + +options: + thing: + default: 🎁 + description: A thing used by the charm. + type: string diff --git a/metadata.yaml b/metadata.yaml new file mode 100644 index 0000000..16d8532 --- /dev/null +++ b/metadata.yaml @@ -0,0 +1,23 @@ +# Copyright 2021 OpenStack Charmers +# See LICENSE file for licensing details. + +# For a complete list of supported options, see: +# https://discourse.charmhub.io/t/charm-metadata-v2/3674/15 +name: ceph-nfs +display-name: | + TEMPLATE-TODO: fill out a display name for the Charmcraft store +description: | + TEMPLATE-TODO: fill out the charm's description +summary: | + TEMPLATE-TODO: fill out the charm's summary + +# TEMPLATE-TODO: replace with containers for your workload (delete for non-k8s) +containers: + httpbin: + resource: httpbin-image + +# TEMPLATE-TODO: each container defined above must specify an oci-image resource +resources: + httpbin-image: + type: oci-image + description: OCI image for httpbin (kennethreitz/httpbin) diff --git a/osci.yaml b/osci.yaml new file mode 100644 index 0000000..d55941b --- /dev/null +++ b/osci.yaml @@ -0,0 +1,29 @@ +- project: + templates: + - charm-unit-jobs + check: + jobs: + - octopus + - pacific + vars: + needs_charm_build: true + charm_build_name: ceph-iscsi + build_type: charmcraft +- job: + name: focal-octopus + parent: func-target + dependencies: + - osci-lint + - tox-py35 + - tox-py36 + - tox-py37 + - tox-py38 + vars: + tox_extra_args: focal-octopus +- job: + name: focal-pacific + parent: func-target + dependencies: &smoke-jobs + - focal-octopus + vars: + tox_extra_args: focal-pacific diff --git a/requirements-dev.txt b/requirements-dev.txt new file mode 100644 index 0000000..4f2a3f5 --- /dev/null +++ b/requirements-dev.txt @@ -0,0 +1,3 @@ +-r requirements.txt +coverage +flake8 diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..37368f6 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,5 @@ +# requirements +git+https://github.com/juju/charm-helpers.git#egg=charmhelpers +git+https://github.com/canonical/operator.git#egg=ops +git+https://opendev.org/openstack/charm-ops-interface-ceph-client#egg=interface_ceph_client +git+https://opendev.org/openstack/charm-ops-openstack#egg=ops_openstack diff --git a/src/charm.py b/src/charm.py new file mode 100755 index 0000000..4e5866a --- /dev/null +++ b/src/charm.py @@ -0,0 +1,140 @@ +#!/usr/bin/env python3 +# Copyright 2021 OpenStack Charmers +# 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.framework import StoredState +from ops.main import main +from ops.model import ActiveStatus + +import ops_openstack.adapters +import ops_openstack.core +import ops_openstack.plugins.classes + +logger = logging.getLogger(__name__) + + +class CephClientAdapter(ops_openstack.adapters.OpenStackOperRelationAdapter): + """Adapter for ceph client interface.""" + + @property + def mon_hosts(self): + """Sorted list of ceph mon addresses. + + :returns: Ceph MON addresses. + :rtype: str + """ + hosts = self.relation.get_relation_data()['mon_hosts'] + return ' '.join(sorted(hosts)) + + @property + def auth_supported(self): + """Authentication type. + + :returns: Authentication type + :rtype: str + """ + return self.relation.get_relation_data()['auth'] + + @property + def key(self): + """Key client should use when communicating with Ceph cluster. + + :returns: Key + :rtype: str + """ + return self.relation.get_relation_data()['key'] + + +class CephNfsCharm(CharmBase): + """Charm the service.""" + + _stored = StoredState() + + def __init__(self, *args): + super().__init__(*args) + self.framework.observe(self.on.httpbin_pebble_ready, self._on_httpbin_pebble_ready) + self.framework.observe(self.on.config_changed, self._on_config_changed) + self.framework.observe(self.on.fortune_action, self._on_fortune_action) + self._stored.set_default(things=[]) + + def _on_httpbin_pebble_ready(self, event): + """Define and start a workload using the Pebble API. + + TEMPLATE-TODO: change this example to suit your needs. + You'll need to specify the right entrypoint and environment + configuration for your specific workload. Tip: you can see the + standard entrypoint of an existing container using docker inspect + + Learn more about Pebble layers at https://github.com/canonical/pebble + """ + # Get a reference the container attribute on the PebbleReadyEvent + container = event.workload + # Define an initial Pebble layer configuration + pebble_layer = { + "summary": "httpbin layer", + "description": "pebble config layer for httpbin", + "services": { + "httpbin": { + "override": "replace", + "summary": "httpbin", + "command": "gunicorn -b 0.0.0.0:80 httpbin:app -k gevent", + "startup": "enabled", + "environment": {"thing": self.model.config["thing"]}, + } + }, + } + # Add intial Pebble config layer using the Pebble API + container.add_layer("httpbin", pebble_layer, combine=True) + # Autostart any services that were defined with startup: enabled + container.autostart() + # Learn more about statuses in the SDK docs: + # https://juju.is/docs/sdk/constructs#heading--statuses + self.unit.status = ActiveStatus() + + def _on_config_changed(self, _): + """Just an example to show how to deal with changed configuration. + + TEMPLATE-TODO: change this example to suit your needs. + If you don't need to handle config, you can remove this method, + the hook created in __init__.py for it, the corresponding test, + and the config.py file. + + Learn more about config at https://juju.is/docs/sdk/config + """ + current = self.config["thing"] + if current not in self._stored.things: + logger.debug("found a new thing: %r", current) + self._stored.things.append(current) + + def _on_fortune_action(self, event): + """Just an example to show how to receive actions. + + TEMPLATE-TODO: change this example to suit your needs. + If you don't need to handle actions, you can remove this method, + the hook created in __init__.py for it, the corresponding test, + and the actions.py file. + + Learn more about actions at https://juju.is/docs/sdk/actions + """ + fail = event.params["fail"] + if fail: + event.fail(fail) + else: + event.set_results({"fortune": "A bug in the code is worth two in the documentation."}) + + +if __name__ == "__main__": + main(CephNfsCharm) diff --git a/templates/ceph.client.ceph-nfs.keyring b/templates/ceph.client.ceph-nfs.keyring new file mode 100644 index 0000000..8ad51ff --- /dev/null +++ b/templates/ceph.client.ceph-nfs.keyring @@ -0,0 +1,3 @@ +[client.ceph-nfs] + key = {{ ceph_client.key }} + diff --git a/templates/ceph.conf b/templates/ceph.conf new file mode 100644 index 0000000..dfd7431 --- /dev/null +++ b/templates/ceph.conf @@ -0,0 +1,15 @@ +############################################################################### +# [ WARNING ] +# configuration file maintained by Juju +# local changes will be overwritten. +############################################################################### +[global] +auth supported = {{ ceph_client.auth_supported }} +mon host = {{ ceph_client.mon_hosts }} +keyring = /etc/ceph/nfs/$cluster.$name.keyring + +[client.ceph-nfs] +client mount uid = 0 +client mount gid = 0 +log file = /var/log/ceph/ceph-client.nfs.log + diff --git a/test-requirements.txt b/test-requirements.txt new file mode 100644 index 0000000..73db69b --- /dev/null +++ b/test-requirements.txt @@ -0,0 +1,16 @@ +# This file is managed centrally. If you find the need to modify this as a +# one-off, please don't. Intead, consult #openstack-charms and ask about +# requirements management in charms via bot-control. Thank you. +charm-tools>=2.4.4 +coverage>=3.6 +mock>=1.2 +flake8>=2.2.4 +stestr>=2.2.0 +requests>=2.18.4 +psutil +# oslo.i18n dropped py35 support +oslo.i18n<4.0.0 +git+https://github.com/openstack-charmers/zaza.git#egg=zaza +git+https://github.com/openstack-charmers/zaza-openstack-tests.git#egg=zaza.openstack +pytz # workaround for 14.04 pip/tox +pyudev # for ceph-* charm unit tests (not mocked?) diff --git a/tests/bundles/focal-octopus.yaml b/tests/bundles/focal-octopus.yaml new file mode 100644 index 0000000..bf8426a --- /dev/null +++ b/tests/bundles/focal-octopus.yaml @@ -0,0 +1,27 @@ +local_overlay_enabled: False +series: focal +applications: + ubuntu: + charm: cs:ubuntu + num_units: 2 + ceph-nfs: + charm: ../../ceph-nfs.charm + num_units: 2 + ceph-osd: + charm: cs:~openstack-charmers-next/ceph-osd + num_units: 3 + storage: + osd-devices: '2,10G' + options: + osd-devices: '/dev/test-non-existent' + ceph-mon: + charm: cs:~openstack-charmers-next/ceph-mon + num_units: 3 + options: + monitor-count: '3' + excpected-osd-count: 6 +relations: + - - 'ceph-mon:client' + - 'ceph-nfs:ceph-client' + - - 'ceph-osd:mon' + - 'ceph-mon:osd' \ No newline at end of file diff --git a/tests/tests.yaml b/tests/tests.yaml new file mode 100644 index 0000000..3b0373c --- /dev/null +++ b/tests/tests.yaml @@ -0,0 +1,12 @@ +charm_name: ceph-nfs +gate_bundles: + - focal-octopuc + - focal-pacific +smoke_bundles: + - focal-octopus +configure: [] +tests: [] +target_deploy_status: + ubuntu: + workload-status: active + workload-status-message: '' diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000..775ea57 --- /dev/null +++ b/tox.ini @@ -0,0 +1,133 @@ +# Operator charm (with zaza): tox.ini + +[tox] +envlist = pep8,py3 +skipsdist = True +# NOTE: Avoid build/test env pollution by not enabling sitepackages. +sitepackages = False +# NOTE: Avoid false positives by not skipping missing interpreters. +skip_missing_interpreters = False +# NOTES: +# * We avoid the new dependency resolver by pinning pip < 20.3, see +# https://github.com/pypa/pip/issues/9187 +# * Pinning dependencies requires tox >= 3.2.0, see +# https://tox.readthedocs.io/en/latest/config.html#conf-requires +# * It is also necessary to pin virtualenv as a newer virtualenv would still +# lead to fetching the latest pip in the func* tox targets, see +# https://stackoverflow.com/a/38133283 +requires = pip < 20.3 + virtualenv < 20.0 +# NOTE: https://wiki.canonical.com/engineering/OpenStack/InstallLatestToxOnOsci +minversion = 3.2.0 + +[testenv] +setenv = VIRTUAL_ENV={envdir} + PYTHONHASHSEED=0 + CHARM_DIR={envdir} +install_command = + pip install {opts} {packages} +commands = stestr run --slowest {posargs} +whitelist_externals = + git + add-to-archive.py + bash +passenv = HOME TERM CS_* OS_* TEST_* +deps = -r{toxinidir}/test-requirements.txt + +[testenv:py35] +basepython = python3.5 +# python3.5 is irrelevant on a focal+ charm. +commands = /bin/true + +[testenv:py36] +basepython = python3.6 +deps = -r{toxinidir}/requirements.txt + -r{toxinidir}/test-requirements.txt + +[testenv:py37] +basepython = python3.7 +deps = -r{toxinidir}/requirements.txt + -r{toxinidir}/test-requirements.txt + +[testenv:py38] +basepython = python3.8 +deps = -r{toxinidir}/requirements.txt + -r{toxinidir}/test-requirements.txt + +[testenv:py3] +basepython = python3 +deps = -r{toxinidir}/requirements.txt + -r{toxinidir}/test-requirements.txt + +[testenv:pep8] +basepython = python3 +deps = -r{toxinidir}/requirements.txt + -r{toxinidir}/test-requirements.txt +commands = flake8 {posargs} src unit_tests tests + +[testenv:cover] +# Technique based heavily upon +# https://github.com/openstack/nova/blob/master/tox.ini +basepython = python3 +deps = -r{toxinidir}/requirements.txt + -r{toxinidir}/test-requirements.txt +setenv = + {[testenv]setenv} + PYTHON=coverage run +commands = + coverage erase + stestr run --slowest {posargs} + coverage combine + coverage html -d cover + coverage xml -o cover/coverage.xml + coverage report + +[coverage:run] +branch = True +concurrency = multiprocessing +parallel = True +source = + . +omit = + .tox/* + */charmhelpers/* + unit_tests/* + +[testenv:venv] +basepython = python3 +commands = {posargs} + +[testenv:build] +basepython = python3 +deps = -r{toxinidir}/build-requirements.txt +commands = + charmcraft build + +[testenv:func-noop] +basepython = python3 +commands = + functest-run-suite --help + +[testenv:func] +basepython = python3 +commands = + functest-run-suite --keep-model + +[testenv:func-smoke] +basepython = python3 +commands = + functest-run-suite --keep-model --smoke + +[testenv:func-dev] +basepython = python3 +commands = + functest-run-suite --keep-model --dev + +[testenv:func-target] +basepython = python3 +commands = + functest-run-suite --keep-model --bundle {posargs} + +[flake8] +# Ignore E902 because the unit_tests directory is missing in the built charm. +ignore = E402,E226,E902 diff --git a/unit_tests/__init__.py b/unit_tests/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/unit_tests/test_charm.py b/unit_tests/test_charm.py new file mode 100644 index 0000000..2df5aa8 --- /dev/null +++ b/unit_tests/test_charm.py @@ -0,0 +1,72 @@ +# Copyright 2021 OpenStack Charmers +# See LICENSE file for licensing details. +# +# Learn more about testing at: https://juju.is/docs/sdk/testing + + +import unittest +import sys + +sys.path.append('lib') # noqa +sys.path.append('src') # noqa + +from unittest.mock import Mock + +from charm import CephNfsCharm +from ops.model import ActiveStatus +from ops.testing import Harness + + +class TestCharm(unittest.TestCase): + def setUp(self): + self.harness = Harness(CephNfsCharm) + self.addCleanup(self.harness.cleanup) + self.harness.begin() + + def test_config_changed(self): + self.assertEqual(list(self.harness.charm._stored.things), []) + self.harness.update_config({"thing": "foo"}) + self.assertEqual(list(self.harness.charm._stored.things), ["foo"]) + + def test_action(self): + # the harness doesn't (yet!) help much with actions themselves + action_event = Mock(params={"fail": ""}) + self.harness.charm._on_fortune_action(action_event) + + self.assertTrue(action_event.set_results.called) + + def test_action_fail(self): + action_event = Mock(params={"fail": "fail this"}) + self.harness.charm._on_fortune_action(action_event) + + self.assertEqual(action_event.fail.call_args, [("fail this",)]) + + def test_httpbin_pebble_ready(self): + # Check the initial Pebble plan is empty + initial_plan = self.harness.get_container_pebble_plan("httpbin") + self.assertEqual(initial_plan.to_yaml(), "{}\n") + # Expected plan after Pebble ready with default config + expected_plan = { + "services": { + "httpbin": { + "override": "replace", + "summary": "httpbin", + "command": "gunicorn -b 0.0.0.0:80 httpbin:app -k gevent", + "startup": "enabled", + "environment": {"thing": "🎁"}, + } + }, + } + # Get the httpbin container from the model + container = self.harness.model.unit.get_container("httpbin") + # Emit the PebbleReadyEvent carrying the httpbin container + self.harness.charm.on.httpbin_pebble_ready.emit(container) + # Get the plan now we've run PebbleReady + updated_plan = self.harness.get_container_pebble_plan("httpbin").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("httpbin").get_service("httpbin") + self.assertTrue(service.is_running()) + # Ensure we set an ActiveStatus with no message + self.assertEqual(self.harness.model.unit.status, ActiveStatus())