Merge ~mertkirpici/charm-cloudsupport:lp/1998094 into charm-cloudsupport:main

[Mert Kirpici]

Close LP #1998094

flake8 6.0.0 does not like it when the inline comments are on the same
line as the ignored rule.

[🤖 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:53822b0c4b00f42edb41b57967b1bcdc6957826b
https://jenkins.canonical.com/bootstack/job/lp-charm-cloudsupport-ci/68/
Executed test runs:
    FAILURE: https://jenkins.canonical.com/bootstack/job/lp-charm-test-functest/1457/
    None: https://jenkins.canonical.com/bootstack/job/lp-update-mp/1713/

Click here to trigger a rebuild:
https://jenkins.canonical.com/bootstack/job/lp-charm-cloudsupport-ci/68//rebuild

review: Needs Fixing (continuous-integration)

[Mert Kirpici (mertkirpici)]

The failed CI run is not relevant to this PR. This PR is about fixing the lint target. See:
https://jenkins.canonical.com/bootstack/job/lp-charm-test-functest/1414/console

The current failure is due to functests, for which the work is still in progress.

[Ramesh Sattaru (rameshcan)]

review: Approve

[Eric Chen (eric-chen)]

review: Approve

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

FAILED: Continuous integration, rev:c74eba447e5a32f4297ce957f83ffd493df45431
https://jenkins.canonical.com/bootstack/job/lp-charm-cloudsupport-ci/69/
Executed test runs:
    FAILURE: https://jenkins.canonical.com/bootstack/job/lp-charm-test-functest/1471/
    None: https://jenkins.canonical.com/bootstack/job/lp-update-mp/1722/

Click here to trigger a rebuild:
https://jenkins.canonical.com/bootstack/job/lp-charm-cloudsupport-ci/69//rebuild

review: Needs Fixing (continuous-integration)

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

FAILED: Continuous integration, rev:c74eba447e5a32f4297ce957f83ffd493df45431
https://jenkins.canonical.com/bootstack/job/lp-charm-cloudsupport-ci/70/
Executed test runs:
    FAILURE: https://jenkins.canonical.com/bootstack/job/lp-charm-test-functest/1481/
    None: https://jenkins.canonical.com/bootstack/job/lp-update-mp/1731/

Click here to trigger a rebuild:
https://jenkins.canonical.com/bootstack/job/lp-charm-cloudsupport-ci/70//rebuild

review: Needs Fixing (continuous-integration)

[Erhan Sunar (esunar)]

LGTM

review: Approve

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

Change successfully merged at revision 4267ca5f99fca5ccea77db7211de7a3711c7c3ac

diff --git a/files/plugins/stale_server_check.py b/files/plugins/stale_server_check.py
index ff383d4..8de4070 100755
--- a/files/plugins/stale_server_check.py
+++ b/files/plugins/stale_server_check.py
@@ -23,6 +23,7 @@ class NrpeStatus(IntEnum):
 
 
 def nrpe_check():
+    """Perform the nrpe check."""
     args = parse_args()
     crit_servers, warn_servers = get_stale_servers(
         args.name_prefix, args.crit_days, args.warn_days, args.ignored_servers_uuids
@@ -54,6 +55,7 @@ def nrpe_check():
 
 
 def parse_args():
+    """Parse the command line arguments."""
     ap = argparse.ArgumentParser()
     ap.add_argument("--cloud-name", dest="cloud_name", type=str, required=True)
     ap.add_argument("--name-prefix", dest="name_prefix", type=str, required=True)
@@ -71,6 +73,7 @@ def parse_args():
 
 
 def get_stale_servers(name_prefix, crit_days, warn_days, ignored_servers=None):
+    """Get the stale servers."""
     crit_servers = []
     warn_servers = []
     server_search_pattern = "^{}".format(re.escape(name_prefix))
diff --git a/lib/lib_cloudsupport.py b/lib/lib_cloudsupport.py
index 8ec1d75..1fd5ffb 100644
--- a/lib/lib_cloudsupport.py
+++ b/lib/lib_cloudsupport.py
@@ -47,13 +47,16 @@ class CloudSupportHelper:
 
     @property
     def check_stale_server(self):
+        """Get the stale-server-check config option value."""
         return self.charm_config.get("stale-server-check")
 
     @property
     def cloud_name(self):
+        """Get the cloud-name config option value."""
         return self.charm_config.get("cloud-name")
 
     def install_dependencies(self):
+        """Install charm dependencies."""
         fetch.apt_install(["python3-openstackclient"], fatal=True)
 
     def verify_config(self):
diff --git a/lib/os_testing.py b/lib/os_testing.py
index a5988ef..4cb4f68 100644
--- a/lib/os_testing.py
+++ b/lib/os_testing.py
@@ -323,6 +323,12 @@ def delete_instance(nodes, pattern, cloud_name="cloud1"):
 
 
 def get_instances(instance=None, cloud_name="cloud1"):
+    """Get the list of instance ids from the cloud.
+
+    :param instance: get particular instance if specified
+    :param cloud_name: the cloud name to get the instances from
+    :return: list of instances
+    """
     if not instance:
         instances = [
             i.id
@@ -338,6 +344,12 @@ def get_instances(instance=None, cloud_name="cloud1"):
 
 
 def is_ovn_used(hypervisor_hostname, cloud_name="cloud1"):
+    """Check is OVN used in a particular cloud.
+
+    :param hypervisor_hostname: the hostname of the hypervisor machine
+    :param cloud_name: the cloud name the check is performed on
+    :return: boolean value for the condition
+    """
     if (
         len(
             list(
diff --git a/lib/qssh.py b/lib/qssh.py
index a14e8dd..a733462 100644
--- a/lib/qssh.py
+++ b/lib/qssh.py
@@ -44,6 +44,7 @@ def get_port(srv, network=None):
 
 
 def build_ssh_command_line(ip, net):
+    """Build the ssh command."""
     dhcp_agent = next(con().network.network_hosting_dhcp_agents(net))
     cmdline = (
         """ssh -o 'ProxyCommand=ssh -l ubuntu {} "sudo ip netns exec qdhcp-{} """
@@ -53,6 +54,7 @@ def build_ssh_command_line(ip, net):
 
 
 def get_ssh_command_line(instance, network=None):
+    """Print the ssh command."""
     srv = con().compute.find_server(instance)
     if not srv:
         raise QsshError("Can't find {}".format(instance))
diff --git a/tests/functional/tests/modules/setup.py b/tests/functional/tests/modules/setup.py
index 2ab534d..a6dd88f 100644
--- a/tests/functional/tests/modules/setup.py
+++ b/tests/functional/tests/modules/setup.py
@@ -24,6 +24,7 @@ cloudinit-userdata: |
 
 
 def model_config():
+    """Set the model configuration."""
     tmp = Path(deployment_env.get_tmpdir())
     priv_file, pub_file = gen_test_ssh_keys(tmp)
     with pub_file.open() as f:
diff --git a/tests/functional/tests/modules/test_cloudsupport.py b/tests/functional/tests/modules/test_cloudsupport.py
index 4af0d5a..25508da 100644
--- a/tests/functional/tests/modules/test_cloudsupport.py
+++ b/tests/functional/tests/modules/test_cloudsupport.py
@@ -19,6 +19,7 @@ logger = logging.getLogger(__name__)
 
 
 def gen_clouds_yaml(creds_dict):
+    """Generate and return the clouds.yaml content."""
     template = textwrap.dedent(
         """
     clouds:
diff --git a/tests/functional/tests/modules/test_utils.py b/tests/functional/tests/modules/test_utils.py
index b9bbede..86dfd3b 100644
--- a/tests/functional/tests/modules/test_utils.py
+++ b/tests/functional/tests/modules/test_utils.py
@@ -29,5 +29,6 @@ def gen_test_ssh_keys(tmpdir):
 
 
 def get_priv_key(tmpdir):
+    """Return the private key contents."""
     priv_file = tmpdir / "test_id_rsa"
     return priv_file.open().read()
diff --git a/tox.ini b/tox.ini
index 81c6399..201691a 100644
--- a/tox.ini
+++ b/tox.ini
@@ -42,10 +42,10 @@ deps =
 
 [flake8]
 ignore =
-    D102 #TODO Missing docstring in public method
-    D103 #TODO Missing docstring in public function
-    N818 #exception should be named with an Error suffix
-    W503 #line break before binary operator (conflict with black)
+    #exception should be named with an Error suffix
+    N818
+    #line break before binary operator (conflict with black)
+    W503
 exclude =
     .git,
     .venv,