add version upgrade test

tests/integration/constants.py

@@ -6,3 +6,21 @@
 ALLOWED_PLUGINS = ("git", "blueocean", "openid")
 INSTALLED_PLUGINS = ("git", "timestamper", "blueocean", "openid")
 REMOVED_PLUGINS = set(INSTALLED_PLUGINS) - set(ALLOWED_PLUGINS)
+ALL_PLUGINS = [
+    "bazaar",
+    "blueocean",
+    "dependency-check-jenkins-plugin",
+    "docker-build-publish",
+    "git",
+    "kubernetes",
+    "ldap",
+    "matrix-combinations-parameter",
+    "momentjs",
+    "oic-auth",
+    "openid",
+    "pipeline-groovy-lib",
+    "postbuildscript",
+    "rebuild",
+    "ssh-agent",
+    "thinBackup",
+]

tests/integration/helpers.py

@@ -49,7 +49,7 @@ async def install_plugins(
             client.requester.post_url(f"{web}/manage/pluginManager/updates/body").content,
             encoding="utf-8",
         ),
-        timeout=60 * 5,
+        timeout=60 * 10,
         wait_period=10,
     )
 
@@ -58,7 +58,7 @@ async def install_plugins(
     client.safe_restart()
     await unit.model.block_until(
         lambda: requests.get(web, timeout=10).status_code == 403,
-        timeout=300,
+        timeout=600,
         wait_period=10,
     )
 

tests/integration/test_upgrade.py

@@ -0,0 +1,105 @@
+# Copyright 2024 Canonical Ltd.
+# See LICENSE file for licensing details.
+
+# pylint: disable=redefined-outer-name,unused-argument,duplicate-code
+
+"""Integration test relation file."""
+
+import logging
+
+import jenkinsapi.jenkins
+import requests
+from juju.application import Application
+from juju.model import Model
+from juju.unit import Unit
+from pytest_operator.plugin import OpsTest
+
+import jenkins
+
+from .constants import ALL_PLUGINS
+from .helpers import install_plugins
+from .types_ import UnitWebClient
+
+LOGGER = logging.getLogger(__name__)
+
+
+async def test_jenkins_deploy_with_plugins(ops_test: OpsTest, jenkins_image: str):
+    """
+    arrange: given a juju model.
+    act: deploy Jenkins, instantiate the Jenkins client and install the plugins.
+    assert: the deployment has no errors.
+    """
+    # Ignoring assignment lint error due to knowing there will always be a model.
+    model: Model = ops_test.model  # type: ignore[assignment]
+    application: Application = await model.deploy(
+        "jenkins-k8s",
+        application_name="jenkins-k8s",
+        channel="edge",
+    )
+    await application.set_config({"allowed-plugins": ",".join(ALL_PLUGINS)})
+    await model.wait_for_idle(status="active", timeout=30 * 60)
+    status = await model.get_status()
+    unit = list(status.applications["jenkins-k8s"].units)[0]
+    address = status["applications"]["jenkins-k8s"]["units"][unit]["address"]
+    jenkins_unit = application.units[0]
+    ret, api_token, stderr = await ops_test.juju(
+        "ssh",
+        "--container",
+        "jenkins",
+        jenkins_unit.name,
+        "cat",
+        str(jenkins.API_TOKEN_PATH),
+    )
+    assert ret == 0, f"Failed to get Jenkins API token, {stderr}"
+    jenkins_client = jenkinsapi.jenkins.Jenkins(
+        f"http://{address}:8080", "admin", api_token, timeout=600
+    )
+    unit_web_client = UnitWebClient(
+        unit=jenkins_unit, web=f"http://{address}:8080", client=jenkins_client
+    )
+    await install_plugins(unit_web_client, ALL_PLUGINS)
+
+
+async def test_jenkins_upgrade_check_plugins(ops_test: OpsTest, jenkins_image: str):  #type: ignore[too-many-locals]
+    """
+    arrange: given charm has been built, deployed and plugins have been installed.
+    act: get Jenkins' version, upgrade the charm and if the versions differ, check plugins.
+    assert: all the installed plugins are up and running.
+    """
+    # Ignoring assignment lint error due to knowing there will always be a model.
+    model: Model = ops_test.model  # type: ignore[assignment]
+    application = model.applications["jenkins-k8s"]
+    status = await model.get_status()
+    unit = list(status.applications["jenkins-k8s"].units)[0]
+    address = status["applications"]["jenkins-k8s"]["units"][unit]["address"]
+    response = requests.get(f"http://{address}:8080", timeout=60)
+    version = response.headers["X-Jenkins"]
+    charm = await ops_test.build_charm(".")
+    await application.refresh(path=charm, resources={"jenkins-image": jenkins_image})
+    await model.wait_for_idle(status="active", timeout=30 * 60)
+    status = await model.get_status()
+    unit = list(status.applications["jenkins-k8s"].units)[0]
+    address = status["applications"]["jenkins-k8s"]["units"][unit]["address"]
+    response = requests.get(f"http://{address}:8080", timeout=60)
+    version_new = response.headers["X-Jenkins"]
+    if version != version_new:
+        jenkins_unit: Unit = application.units[0]
+        ret, api_token, stderr = await ops_test.juju(
+            "ssh",
+            "--container",
+            "jenkins",
+            jenkins_unit.name,
+            "cat",
+            str(jenkins.API_TOKEN_PATH),
+        )
+        assert ret == 0, f"Failed to get Jenkins API token, {stderr}"
+        jenkins_client_new = jenkinsapi.jenkins.Jenkins(
+            f"http://{address}:8080", "admin", api_token, timeout=600
+        )
+        unit_web_client_new = UnitWebClient(
+            unit=jenkins_unit, web=f"http://{address}:8080", client=jenkins_client_new
+        )
+        troubled_plugins = [
+            plugin for plugin in ALL_PLUGINS if not unit_web_client_new.client.has_plugin(plugin)
+        ]
+        assert troubled_plugins == [], f"The following plugins have trouble: {troubled_plugins}"