Merge ~gabrielcocenza/charm-openstack-service-checks:bug/1998333 into charm-openstack-service-checks:master

[Gabriel Cocenza]

render template using volume_api_version when related with keystone

- fix fcbtest snap channel for bionic. See lp #1999667

Closes-Bug: #1998333

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

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

[🤖 prod-jenkaas-bootstack (prod-jenkaas-bootstack)]

FAILED: Continuous integration, rev:d883a6f356b62be2a0e6599dd4eeefe3bc36b288
https://jenkins.canonical.com/bootstack/job/lp-charm-openstack-service-checks-ci/111/
Executed test runs:
    FAILURE: https://jenkins.canonical.com/bootstack/job/lp-charm-test-functest/1720/
    None: https://jenkins.canonical.com/bootstack/job/lp-update-mp/1809/

Click here to trigger a rebuild:
https://jenkins.canonical.com/bootstack/job/lp-charm-openstack-service-checks-ci/111//rebuild

review: Needs Fixing (continuous-integration)

[🤖 prod-jenkaas-bootstack (prod-jenkaas-bootstack)]

FAILED: Continuous integration, rev:509cc5f3e98c9b22b8a36cdb61dc1bd40ec84eda
https://jenkins.canonical.com/bootstack/job/lp-charm-openstack-service-checks-ci/112/
Executed test runs:
    FAILURE: https://jenkins.canonical.com/bootstack/job/lp-charm-test-functest/1721/
    None: https://jenkins.canonical.com/bootstack/job/lp-update-mp/1810/

Click here to trigger a rebuild:
https://jenkins.canonical.com/bootstack/job/lp-charm-openstack-service-checks-ci/112//rebuild

review: Needs Fixing (continuous-integration)

[🤖 prod-jenkaas-bootstack (prod-jenkaas-bootstack)]

FAILED: Continuous integration, rev:2d009d09c3ce6de8cc2edd010ed722239ccfd7a4
https://jenkins.canonical.com/bootstack/job/lp-charm-openstack-service-checks-ci/113/
Executed test runs:
    FAILURE: https://jenkins.canonical.com/bootstack/job/lp-charm-test-functest/1724/
    None: https://jenkins.canonical.com/bootstack/job/lp-update-mp/1813/

Click here to trigger a rebuild:
https://jenkins.canonical.com/bootstack/job/lp-charm-openstack-service-checks-ci/113//rebuild

review: Needs Fixing (continuous-integration)

[🤖 prod-jenkaas-bootstack (prod-jenkaas-bootstack)]

FAILED: Continuous integration, rev:3d6cc647658b37df616bb2fd8fcdcf8439d03e5a
https://jenkins.canonical.com/bootstack/job/lp-charm-openstack-service-checks-ci/114/
Executed test runs:
    FAILURE: https://jenkins.canonical.com/bootstack/job/lp-charm-test-functest/1725/
    None: https://jenkins.canonical.com/bootstack/job/lp-update-mp/1814/

Click here to trigger a rebuild:
https://jenkins.canonical.com/bootstack/job/lp-charm-openstack-service-checks-ci/114//rebuild

review: Needs Fixing (continuous-integration)

[🤖 prod-jenkaas-bootstack (prod-jenkaas-bootstack)]

FAILED: Continuous integration, rev:9764ff0fc06a649a03c8e514ebb98a7f2c437125
https://jenkins.canonical.com/bootstack/job/lp-charm-openstack-service-checks-ci/115/
Executed test runs:
    FAILURE: https://jenkins.canonical.com/bootstack/job/lp-charm-test-functest/1726/
    None: https://jenkins.canonical.com/bootstack/job/lp-update-mp/1815/

Click here to trigger a rebuild:
https://jenkins.canonical.com/bootstack/job/lp-charm-openstack-service-checks-ci/115//rebuild

review: Needs Fixing (continuous-integration)

[🤖 prod-jenkaas-bootstack (prod-jenkaas-bootstack)]

FAILED: Continuous integration, rev:539ed36908b4136285836cb5dd9243b8605a5105
https://jenkins.canonical.com/bootstack/job/lp-charm-openstack-service-checks-ci/116/
Executed test runs:
    FAILURE: https://jenkins.canonical.com/bootstack/job/lp-charm-test-functest/1727/
    None: https://jenkins.canonical.com/bootstack/job/lp-update-mp/1816/

Click here to trigger a rebuild:
https://jenkins.canonical.com/bootstack/job/lp-charm-openstack-service-checks-ci/116//rebuild

review: Needs Fixing (continuous-integration)

[Martin Kalcok (martin-kalcok)]

Two inline comments that I think are worth considering, otherwise LGTM.

[🤖 prod-jenkaas-bootstack (prod-jenkaas-bootstack)]

FAILED: Continuous integration, rev:f2ba3d43e46553f37c210dedd7b5f1f103eb5cc6
https://jenkins.canonical.com/bootstack/job/lp-charm-openstack-service-checks-ci/117/
Executed test runs:
    FAILURE: https://jenkins.canonical.com/bootstack/job/lp-charm-test-functest/1728/
    None: https://jenkins.canonical.com/bootstack/job/lp-update-mp/1817/

Click here to trigger a rebuild:
https://jenkins.canonical.com/bootstack/job/lp-charm-openstack-service-checks-ci/117//rebuild

review: Needs Fixing (continuous-integration)

[JamesLin (jneo8)]

LGTM

review: Approve

[🤖 prod-jenkaas-bootstack (prod-jenkaas-bootstack)]

FAILED: Continuous integration, rev:97dcb4cb3c2e676c01ecd8dc10aeda876e56faf9
https://jenkins.canonical.com/bootstack/job/lp-charm-openstack-service-checks-ci/118/
Executed test runs:
    FAILURE: https://jenkins.canonical.com/bootstack/job/lp-charm-test-functest/1731/
    None: https://jenkins.canonical.com/bootstack/job/lp-update-mp/1820/

Click here to trigger a rebuild:
https://jenkins.canonical.com/bootstack/job/lp-charm-openstack-service-checks-ci/118//rebuild

review: Needs Fixing (continuous-integration)

[🤖 prod-jenkaas-bootstack (prod-jenkaas-bootstack)]

FAILED: Continuous integration, rev:97dcb4cb3c2e676c01ecd8dc10aeda876e56faf9
https://jenkins.canonical.com/bootstack/job/lp-charm-openstack-service-checks-ci/119/
Executed test runs:
    FAILURE: https://jenkins.canonical.com/bootstack/job/lp-charm-test-functest/1732/
    None: https://jenkins.canonical.com/bootstack/job/lp-update-mp/1821/

Click here to trigger a rebuild:
https://jenkins.canonical.com/bootstack/job/lp-charm-openstack-service-checks-ci/119//rebuild

review: Needs Fixing (continuous-integration)

[🤖 prod-jenkaas-bootstack (prod-jenkaas-bootstack)]

FAILED: Continuous integration, rev:97dcb4cb3c2e676c01ecd8dc10aeda876e56faf9
https://jenkins.canonical.com/bootstack/job/lp-charm-openstack-service-checks-ci/120/
Executed test runs:
    FAILURE: https://jenkins.canonical.com/bootstack/job/lp-charm-test-functest/1733/
    None: https://jenkins.canonical.com/bootstack/job/lp-update-mp/1822/

Click here to trigger a rebuild:
https://jenkins.canonical.com/bootstack/job/lp-charm-openstack-service-checks-ci/120//rebuild

review: Needs Fixing (continuous-integration)

[🤖 prod-jenkaas-bootstack (prod-jenkaas-bootstack)]

PASSED: Continuous integration, rev:97dcb4cb3c2e676c01ecd8dc10aeda876e56faf9
https://jenkins.canonical.com/bootstack/job/lp-charm-openstack-service-checks-ci/121/
Executed test runs:
    SUCCESS: https://jenkins.canonical.com/bootstack/job/lp-charm-test-functest/1734/
    None: https://jenkins.canonical.com/bootstack/job/lp-update-mp/1823/

Click here to trigger a rebuild:
https://jenkins.canonical.com/bootstack/job/lp-charm-openstack-service-checks-ci/121//rebuild

review: Approve (continuous-integration)

[Eric Chen (eric-chen)]

review: Approve

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

Change successfully merged at revision b90b7cab7784da57b943a7d67a80cd00158d0577

diff --git a/src/lib/lib_openstack_service_checks.py b/src/lib/lib_openstack_service_checks.py
index d9782e7..c0dc696 100644
--- a/src/lib/lib_openstack_service_checks.py
+++ b/src/lib/lib_openstack_service_checks.py
@@ -1025,6 +1025,12 @@ class OSCHelper:
             force=False,
         )
 
+        # NOTE(gabrielcocenza) See bug# 1999667 for more context.
+        release = host.lsb_release()["DISTRIB_CODENAME"].lower()
+        if host.CompareHostReleases(release) <= "bionic":
+            hookenv.log("Refreshing fcbtest to channel V1/stable", hookenv.WARNING)
+            fetch.snap.snap_refresh("fcbtest", "--channel=V1/stable")
+
         for tool in ["rally", "tempest"]:
             toolname = "fcbtest.{}init".format(tool)
             installed = self._run_as(user, [toolname])
@@ -1180,3 +1186,43 @@ class OSCHelper:
             self.remove_rally_check()
             unitdata.kv().set("rallyconfigured", False)
         return True
+
+    def get_cinder_api_version(self):
+        """Get the cinder version to set on OS_VOLUME_API_VERSION."""
+        creds = self.get_keystone_credentials()
+        if creds:
+            try:
+                self.get_keystone_client(creds)
+                cinder_name = [
+                    service
+                    for service in self.endpoint_service_names.values()
+                    if service.startswith("cinder")
+                ][0]
+            except IndexError as err:
+                hookenv.log(
+                    f"Missing Cinder Service: {err}",
+                    hookenv.WARNING,
+                )
+                hookenv.log(
+                    "Disconsider if your deployment doesn't have Cinder",
+                    hookenv.WARNING,
+                )
+                return
+            except OSCKeystoneError as keystone_error:
+                error_status_message = (
+                    "Failed to create endpoint checks due issue "
+                    "communicating with Keystone"
+                )
+                hookenv.log(
+                    "{}. Error:\n{}".format(error_status_message, keystone_error),
+                    level=hookenv.ERROR,
+                )
+                hookenv.status_set("blocked", keystone_error.workload_status)
+                return
+
+            try:
+                return cinder_name.rsplit("v", maxsplit=1)[1]
+            except IndexError as err:
+                raise ValueError(
+                    f"Cinder API version {cinder_name} has unknown format"
+                ) from err
diff --git a/src/reactive/openstack_service_checks.py b/src/reactive/openstack_service_checks.py
index 24f4122..e572128 100644
--- a/src/reactive/openstack_service_checks.py
+++ b/src/reactive/openstack_service_checks.py
@@ -174,6 +174,10 @@ def get_credentials():
                 "blocked", "Missing os-credentials vars: {}".format(error)
             )
             return
+
+        volume_api_version = helper.get_cinder_api_version()
+        if volume_api_version:
+            creds["volume_api_version"] = volume_api_version
     return creds
 
 
@@ -267,6 +271,7 @@ def configure_nrpe_endpoints():
 def endpoints_changed():
     """Clear configured flag if endpoints are updated."""
     clear_flag("openstack-service-checks.endpoints.configured")
+    clear_flag("openstack-service-checks.configured")
 
 
 @when("openstack-service-checks.configured")
diff --git a/src/templates/nagios.novarc b/src/templates/nagios.novarc
index a6e6be8..7a72705 100644
--- a/src/templates/nagios.novarc
+++ b/src/templates/nagios.novarc
@@ -1,10 +1,14 @@
 export OS_USERNAME={{ username }}
+{%- if tenant_name %}
 export OS_TENANT_NAME={{ tenant_name }}
+{%- endif %}
 export OS_PROJECT_NAME={{ project_name }}
 export OS_PASSWORD={{ password }}
 export OS_REGION_NAME={{ region }}
 export OS_AUTH_URL={{ auth_url }}
+{%- if volume_api_version %}
 export OS_VOLUME_API_VERSION={{ volume_api_version }}
+{%- endif %}
 {%- if cacert %}
 export OS_CACERT={{ cacert }}
 export REQUESTS_CA_BUNDLE=$OS_CACERT
diff --git a/src/tests/unit/requirements.txt b/src/tests/unit/requirements.txt
index 6abbf5d..cdcd551 100644
--- a/src/tests/unit/requirements.txt
+++ b/src/tests/unit/requirements.txt
@@ -3,6 +3,7 @@ charms.reactive
 mock
 pytest
 pytest-cov
+pytest-mock
 os-client-config
 os-testr>=0.4.1
 requests>=2.18.4
diff --git a/src/tests/unit/test_lib.py b/src/tests/unit/test_lib.py
index 12a2186..718a3ac 100644
--- a/src/tests/unit/test_lib.py
+++ b/src/tests/unit/test_lib.py
@@ -554,3 +554,112 @@ def test_create_endpoint_checks__v3_services(
     OSCHelper().create_endpoint_checks()
     assert mock_render_http.call_count == result[0]
     assert mock_render_https.call_count == result[1]
+
+
[e-mail](
+    "endpoint_service_names, result",
+    [
+        (
+            {
+                "1606b9c42008495e96d323bbb9a45aa7": "cinderv3",
+                "2438857485f34ffc9b9d550f7f5e73af": "nova",
+            },
+            "3",
+        ),
+        (
+            {
+                "1606b9c42008495e96d323bbb9a45aa7": "cinderv2",
+                "2438857485f34ffc9b9d550f7f5e73af": "nova",
+            },
+            "2",
+        ),
+        (
+            {
+                "1606b9c42008495e96d323bbb9a45aa7": "cinderv1",
+                "2438857485f34ffc9b9d550f7f5e73af": "nova",
+            },
+            "1",
+        ),
+    ],
+)
+def test_get_cinder_api_version(mocker, endpoint_service_names, result):
+    """Test get_cinder_api_version working as expected."""
+    mocker.patch("charmhelpers.core.hookenv.config", return_value={})
+    mocker.patch("lib_openstack_service_checks.OSCHelper.get_keystone_client")
+    mocker.patch(
+        "lib_openstack_service_checks.OSCHelper.get_keystone_credentials",
+        return_value={
+            "auth_url": "auth_url",
+            "project_name": "project_name",
+            "username": "username",
+            "password": "password",
+            "region": "region_name",
+            "user_domain_name": "user_domain_name",
+            "project_domain_name": "project_domain_name",
+            "app_version": "app_version",
+            "auth_version": "auth_version",
+        },
+    )
+    with mock.patch(
+        "lib_openstack_service_checks.OSCHelper.endpoint_service_names",
+        new_callable=mocker.PropertyMock,
+    ) as mock_endpoint_name:
+        mock_endpoint_name.return_value = endpoint_service_names
+        assert OSCHelper().get_cinder_api_version() == result
+
+
[e-mail](
+    "endpoint_service_names, expected_exception, err_msg",
+    [
+        (
+            {
+                "1606b9c42008495e96d323bbb9a45aa7": "keystone",
+                "2438857485f34ffc9b9d550f7f5e73af": "nova",
+            },
+            None,
+            "Missing Cinder Service: list index out of range",
+        ),
+        (
+            {
+                "1606b9c42008495e96d323bbb9a45aa7": "cinder",
+                "2438857485f34ffc9b9d550f7f5e73af": "nova",
+            },
+            ValueError,
+            "Cinder API version cinder has unknown format",
+        ),
+    ],
+)
+def test_get_cinder_api_version_exceptions(
+    mocker, endpoint_service_names, expected_exception, err_msg
+):
+    """Test get_cinder_api_version exceptions."""
+    mocker.patch("charmhelpers.core.hookenv.config", return_value={})
+    mock_log = mocker.patch("charmhelpers.core.hookenv.log")
+    mocker.patch("lib_openstack_service_checks.OSCHelper.get_keystone_client")
+    mocker.patch(
+        "lib_openstack_service_checks.OSCHelper.get_keystone_credentials",
+        return_value={
+            "auth_url": "auth_url",
+            "project_name": "project_name",
+            "username": "username",
+            "password": "password",
+            "region": "region_name",
+            "user_domain_name": "user_domain_name",
+            "project_domain_name": "project_domain_name",
+            "app_version": "app_version",
+            "auth_version": "auth_version",
+        },
+    )
+    with mock.patch(
+        "lib_openstack_service_checks.OSCHelper.endpoint_service_names",
+        new_callable=mocker.PropertyMock,
+    ) as mock_endpoint_name:
+        mock_endpoint_name.return_value = endpoint_service_names
+        if expected_exception:
+            with pytest.raises(expected_exception) as err:
+                OSCHelper().get_cinder_api_version()
+            assert str(err.value) == err_msg
+            mock_log.assert_not_called()
+        else:
+            OSCHelper().get_cinder_api_version()
+            mock_log.assert_any_call(err_msg, hookenv.WARNING)