Skip to content

Commit

Permalink
linting and unit tests WIP
Browse files Browse the repository at this point in the history
  • Loading branch information
@gtrkiller
gtrkiller committed Apr 9, 2024
1 parent dabb9e6 commit 9d7b005
Show file tree
Hide file tree
Showing 3 changed files with 205 additions and 197 deletions.
140 changes: 108 additions & 32 deletions src/charm.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,7 @@
import os
import re
import secrets
import shutil
import string
import tempfile
import textwrap
import time
import traceback
Expand All @@ -26,14 +24,20 @@
from charms.data_platform_libs.v0.data_interfaces import DatabaseRequires
from charms.grafana_k8s.v0.grafana_dashboard import GrafanaDashboardProvider
from charms.nginx_ingress_integrator.v0.nginx_route import require_nginx_route
from charms.prometheus_k8s.v0.prometheus_scrape import MetricsEndpointProvider
from charms.plugin_integrator.v0.plugin import PluginRequires
from ops.charm import ActionEvent, CharmBase, HookEvent, PebbleReadyEvent, UpgradeCharmEvent
from charms.prometheus_k8s.v0.prometheus_scrape import MetricsEndpointProvider
from ops.charm import (
ActionEvent,
CharmBase,
HookEvent,
PebbleReadyEvent,
RelationEvent,
UpgradeCharmEvent,
)
from ops.framework import EventBase
from ops.main import main
from ops.model import ActiveStatus, RelationDataContent, WaitingStatus
from ops.pebble import ExecProcess
from yaml import safe_load

import exceptions
import types_
Expand Down Expand Up @@ -157,7 +161,9 @@ def __init__(self, *args, **kwargs):
self.framework.observe(self.on.wordpress_pebble_ready, self._set_version)
self.framework.observe(self.on.wordpress_pebble_ready, self._reconciliation)
self.framework.observe(self.on["wordpress-replica"].relation_changed, self._reconciliation)
self.framework.observe(self.plugins.on.reconcile_plugins, self._complex_plugin_reconciliation)
self.framework.observe(
self.plugins.on.reconcile_plugins, self._complex_plugin_reconciliation
)

def _set_version(self, _: PebbleReadyEvent) -> None:
"""Set WordPress application version to Juju charm's app version status."""
Expand Down Expand Up @@ -866,12 +872,16 @@ def _wp_addon_list(self, addon_type: str):
message=f"wp {addon_type} list command failed, stdout is not json",
)

def _wp_addon_install(self, addon_type: str, addon_name: str = "", addon_version: str = "", addon_zip: str = "") -> types_.ExecResult:
def _wp_addon_install(
self, addon_type: str, addon_name: str = "", addon_version: str = "", addon_zip: str = ""
) -> types_.ExecResult:
"""Install WordPress addon (plugin/theme).
Args:
addon_type (str): ``"theme"`` or ``"plugin"``.
addon_name (str): name of the addon that needs to be installed.
addon_type: ``"theme"`` or ``"plugin"``.
addon_name: name of the addon that needs to be installed.
addon_version: version of the addon that needs to be installed.
addon_zip: zip file containing the addon.
Returns:
Result of installation command.
Expand All @@ -888,14 +898,13 @@ def _wp_addon_install(self, addon_type: str, addon_name: str = "", addon_version
addon_version = "latest"
cmd = ["wp", "plugin", "install", addon_name, f"--version={addon_version}"]
return self._wrapped_run_wp_cli(cmd, timeout=600)


def _wp_plugin_update(self, plugin_name: str, plugin_version: str = "") -> types_.ExecResult:
"""Install WordPress addon (plugin/theme).
Args:
addon_type (str): ``"theme"`` or ``"plugin"``.
addon_name (str): name of the addon that needs to be installed.
plugin_name: name of the plugin that needs to be installed.
plugin_version: version of the plugin that needs to be installed.
Returns:
Result of installation command.
Expand All @@ -905,7 +914,6 @@ def _wp_plugin_update(self, plugin_name: str, plugin_version: str = "") -> types
cmd = ["wp", "plugin", "update", plugin_name, f"--version={plugin_version}"]
return self._wrapped_run_wp_cli(cmd, timeout=600)


def _wp_addon_uninstall(self, addon_type: str, addon_name: str) -> types_.ExecResult:
"""Uninstall WordPress addon (theme/plugin).
Expand Down Expand Up @@ -940,25 +948,66 @@ def _simple_plugin_reconciliation(self) -> None:
return
current_installed_plugins = set((t["name"], t["version"]) for t in exec_result.result)
plugins_in_config_no_filter = [
(t.strip().split(":")[0], t.strip().split(":")[1]) for t in self.model.config[f"plugins"].split(",") if t.strip()
(t.strip().split(":")[0], t.strip().split(":")[1])
for t in self.model.config["plugins"].split(",")
if t.strip()
]
complex_plugins = ["akismet", "openid", "openstack-objectstorage-k8s"]
filtered_plugins = filter(lambda a: a[0] not in complex_plugins, plugins_in_config_no_filter)
filtered_plugins = filter(
lambda a: a[0] not in complex_plugins, plugins_in_config_no_filter
)
plugins_in_config = list(filtered_plugins)
plugins_update = [tup for tup in plugins_in_config if any(i[1] not in tup and i[0] in tup for i in current_installed_plugins)]
plugins_install_no_filter = [tup for tup in plugins_in_config if all(i[0] not in tup for i in current_installed_plugins)]
plugins_uninstall = [tup for tup in current_installed_plugins if all(i[0] not in tup for i in plugins_in_config)]
plugins_update = [
tup
for tup in plugins_in_config
if any(i[1] not in tup and i[0] in tup for i in current_installed_plugins)
]
plugins_install_no_filter = [
tup
for tup in plugins_in_config
if all(i[0] not in tup for i in current_installed_plugins)
]
plugins_uninstall = [
tup
for tup in current_installed_plugins
if all(i[0] not in tup for i in plugins_in_config)
]
filtered_install = filter(lambda a: a[0] not in complex_plugins, plugins_install_no_filter)
plugins_install= list(filtered_install)
plugins_install = list(filtered_install)
self._simple_plugin_install(plugins_install)
self._simple_plugin_update(plugins_update)
self._simple_plugin_uninstall(plugins_uninstall)

def _simple_plugin_install(self, plugins_install: list[str]) -> None:
"""Installation of simple plugins.
Args:
plugins_install: Plugins that need to be installed
Raises:
WordPressBlockedStatusException: When the installation fails for a plugin
"""
for plugin in plugins_install:
if len(plugin) == 1:
plugin.append("")
logger.info("Install plugin: %s", repr(plugin))
exec_result = self._wp_addon_install(addon_type="plugin", addon_name=plugin[0], addon_version=plugin[1])
exec_result = self._wp_addon_install(
addon_type="plugin", addon_name=plugin[0], addon_version=plugin[1]
)
if not exec_result.success:
raise exceptions.WordPressBlockedStatusException(
f"failed to install plugin {repr(plugin)}"
)

def _simple_plugin_update(self, plugins_update: list[str]) -> None:
"""Update of simple plugins.
Args:
plugins_update: Plugins that need to be updated
Raises:
WordPressBlockedStatusException: When the update fails for a plugin
"""
for plugin in plugins_update:
logger.info("Update plugin: %s", repr(plugin))
if len(plugin) == 1 and ".zip" not in plugin[0]:
Expand All @@ -968,6 +1017,16 @@ def _simple_plugin_reconciliation(self) -> None:
raise exceptions.WordPressBlockedStatusException(
f"failed to update plugin {repr(plugin)}"
)

def _simple_plugin_uninstall(self, plugins_uninstall: list[str]) -> None:
"""Uninstallation of simple plugins.
Args:
plugins_uninstall: Plugins that need to be uninstalled
Raises:
WordPressBlockedStatusException: When the uninstallation fails for a plugin
"""
for plugin in plugins_uninstall:
logger.info("Uninstall plugin: %s", repr(plugin))
exec_result = self._wp_addon_uninstall(addon_type="plugin", addon_name=plugin[0])
Expand All @@ -980,6 +1039,10 @@ def _theme_reconciliation(self) -> None:
"""Reconciliation process for WordPress themes.
Install and uninstall themes to match the themes setting in config.
Raises:
WordPressBlockedStatusException: If the themes can't be managed
"""
logger.info("Start theme reconciliation process")
exec_result = self._wp_addon_list("theme")
Expand All @@ -990,12 +1053,8 @@ def _theme_reconciliation(self) -> None:
return
current_installed_themes = set(t["name"] for t in exec_result.result)
logger.debug("Currently installed themes: %s", current_installed_themes)
themes_in_config = [
t.strip() for t in self.model.config["themes"].split(",") if t.strip()
]
default_themes = (
self._WORDPRESS_DEFAULT_THEMES
)
themes_in_config = [t.strip() for t in self.model.config["themes"].split(",") if t.strip()]
default_themes = self._WORDPRESS_DEFAULT_THEMES
desired_themes = set(itertools.chain(themes_in_config, default_themes))
install_themes = desired_themes - current_installed_themes
uninstall_themes = current_installed_themes - desired_themes
Expand Down Expand Up @@ -1412,18 +1471,27 @@ def _config_swift_plugin(self, swift_config: Dict[str, Any]) -> None:
)

def _plugin_swift_reconciliation(self, event) -> None:
"""Reconciliation process for swift object storage (openstack-objectstorage-k8s) plugin."""
"""Reconciliation process for swift object storage (openstack-objectstorage-k8s) plugin.
Args:
event: RelationEvent fired by the plugin integrator.
Raises:
WordPressBlockedStatusException: If the plugins can't be listed
"""
exec_result = self._wp_addon_list("plugin")
if not exec_result.success:
logger.error("Failed to list plugins, %s", exec_result.message)
raise exceptions.WordPressBlockedStatusException("Failed to list plugins.")
if not exec_result.result:
return
current_installed_plugins = set(t["name"] for t in exec_result.result)
swift_installed = any(name=="openstack-objectstorage-k8s" for name in current_installed_plugins)
swift_installed = any(
name == "openstack-objectstorage-k8s" for name in current_installed_plugins
)
if not swift_installed:
self._zip_swift_plugin()

swift_config = self._swift_config()
if self.unit.is_leader():
self._config_swift_plugin(swift_config)
Expand All @@ -1449,12 +1517,17 @@ def _plugin_swift_reconciliation(self, event) -> None:
self._apache_enable_config(apache_swift_conf, conf)
elif not swift_config and swift_apache_config_enabled:
self._apache_disable_config(apache_swift_conf)

def _zip_swift_plugin(self) -> str:
"""Get the openstack-objectstorage-k8s repo and zip it."""
container = self._container()
process_git = container.exec(
["git", "clone", "https://git.launchpad.net/~canonical-sysadmins/wordpress/+git/openstack-objectstorage-k8s", "/var/www/html/wp-content/plugins/openstack-objectstorage-k8s/"]
[
"git",
"clone",
"https://git.launchpad.net/~canonical-sysadmins/wordpress/+git/openstack-objectstorage-k8s",
"/var/www/html/wp-content/plugins/openstack-objectstorage-k8s/",
]
)
process_git.wait()

Expand All @@ -1469,12 +1542,15 @@ def _are_pebble_instances_ready(self) -> bool:
for container_name in self.model.unit.containers
)

def _complex_plugin_reconciliation(self, event) -> None:
def _complex_plugin_reconciliation(self, event: RelationEvent) -> None:
"""Reconciliation process for WordPress plugins.
Install and uninstall plugins to match the plugins setting in config.
Activate and deactivate three charm managed plugins (akismet, openid, openstack-swift)
and adjust plugin options for these three plugins according to charm config.
Args:
event: The relation event fired by the plugin integrator.
"""
if self._current_wp_config() is None:
logger.info("WP config file is not yet created, deferring plugin event")
Expand Down
69 changes: 0 additions & 69 deletions tests/unit/conftest.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -237,75 +237,6 @@ def action_event_mock():
return event_mock


@pytest.fixture(scope="function")
def run_standard_plugin_test(
patch: WordpressPatch,
harness: ops.testing.Harness,
setup_replica_consensus: typing.Callable[[], dict],
setup_database_relation_no_port: typing.Callable[[], typing.Tuple[int, dict]],
):
"""Returns a function that can be used to perform some general test for different plugins."""

def _run_standard_plugin_test(
plugin: str,
plugin_config: typing.Dict[str, str],
excepted_options: typing.Dict[str, typing.Any],
excepted_options_after_removed: typing.Optional[typing.Dict[str, str]] = None,
additional_check_after_install: typing.Optional[typing.Callable] = None,
):
"""Function to perform standard plugins test.
Args:
plugin: Name of WordPress standard plugin to test.
plugin_config: Configurable parameters for WordPress plugins. See config.yaml for
configuration details.
excepted_options: Expected configurations of a given plugin.
excepted_options_after_removed: Remaining options after plugin deactivation.
additional_check_after_install: Callback to additional checks to perform after
installation.
"""
plugin_config_keys = list(plugin_config.keys())
harness.set_can_connect(harness.model.unit.containers["wordpress"], True)
setup_replica_consensus()
_, db_info = setup_database_relation_no_port()
patch.database.prepare_database(
host=db_info["endpoints"],
database=db_info["database"],
user=db_info["username"],
password=db_info["password"],
)

harness.update_config(plugin_config)

database_instance = patch.database.get_wordpress_database(
host="test_database_host", database="test_database_name"
)
assert database_instance
assert (
database_instance.activated_plugins == {plugin}
if isinstance(plugin, str)
else set(plugin)
), f"{plugin} should be activated after {plugin_config_keys} being set"
assert (
database_instance.options == excepted_options
), f"options of plugin {plugin} should be set correctly"

if additional_check_after_install is not None:
additional_check_after_install()

harness.update_config({k: "" for k in plugin_config})
assert (
database_instance.activated_plugins == set()
), f"{plugin} should be deactivated after {plugin_config_keys} being reset"
assert (
database_instance.options == {}
if excepted_options_after_removed is None
else excepted_options_after_removed
), f"{plugin} options should be removed after {plugin_config_keys} being reset"

return _run_standard_plugin_test


@pytest.fixture(scope="function")
def attach_storage(
patch: WordpressPatch,
Expand Down
Loading

0 comments on commit 9d7b005

Please sign in to comment.