Merge ~peppepetra/charm-sudo-pair:lint-20.08 into charm-sudo-pair:master

[Giuseppe Petralia]

[Paul Goins (vultaire)]

Generally in favor, but the noqa clauses need to be fixed since without the colon they disable all checks.

review: Needs Fixing

[Paul Goins (vultaire)]

LGTM.

review: Approve

[Drew Freiberger (afreiberger)]

LGTM. +1

review: Approve

diff --git a/src/actions/actions.py b/src/actions/actions.py
index 2416eb3..9ff1ec5 100755
--- a/src/actions/actions.py
+++ b/src/actions/actions.py
@@ -1,4 +1,5 @@
 #!/usr/local/sbin/charm-env python3
+"""Sudo Pair actions."""
 #
 # Copyright 2016,2019,2020 Canonical Ltd
 #
@@ -39,6 +40,7 @@ ACTIONS = {"remove-sudopair": remove}
 
 
 def main(args):
+    """Dispatch actions based on command arguments."""
     action_name = os.path.basename(args[0])
     try:
         ACTIONS[action_name]()
diff --git a/src/lib/libsudopair.py b/src/lib/libsudopair.py
index cbaf467..2f7c45b 100644
--- a/src/lib/libsudopair.py
+++ b/src/lib/libsudopair.py
@@ -1,3 +1,4 @@
+"""Sudo pair utilities."""
 import grp
 import os
 
diff --git a/src/reactive/sudo_pair.py b/src/reactive/sudo_pair.py
index ed1d7ba..caab64f 100644
--- a/src/reactive/sudo_pair.py
+++ b/src/reactive/sudo_pair.py
@@ -1,3 +1,5 @@
+"""Charm reactive hooks."""
+
 from charmhelpers.core import hookenv
 
 from charms.reactive import hook, remove_state, set_state, when, when_not
@@ -46,11 +48,13 @@ def install_sudo_pair():
 
 @hook("config-changed")
 def reconfigure_sudo_pair_charm():
+    """Run config-changed hook."""
     sph.set_charm_config(hookenv.config())
     remove_state("sudo-pair.configured")
 
 
 @hook("stop")
 def stop():
+    """Run stop hook and remove charm configuration."""
     sph.deconfigure()
     remove_state("sudo-pair.installed")
diff --git a/src/tests/functional/conftest.py b/src/tests/functional/conftest.py
index 7a8523e..fdd4356 100644
--- a/src/tests/functional/conftest.py
+++ b/src/tests/functional/conftest.py
@@ -1,4 +1,5 @@
 #!/usr/bin/python3
+"""Functional tests utilities."""
 
 import asyncio
 import json
@@ -60,7 +61,7 @@ async def current_model():
 
 
 @pytest.fixture
-async def get_app(model):
+async def get_app(model):  # noqa: D202
     """Return the application requested."""
 
     async def _get_app(name):
@@ -73,7 +74,7 @@ async def get_app(model):
 
 
 @pytest.fixture
-async def get_unit(model):
+async def get_unit(model):  # noqa: D202
     """Return the requested <app_name>/<unit_number> unit."""
 
     async def _get_unit(name):
@@ -87,7 +88,7 @@ async def get_unit(model):
 
 
 @pytest.fixture
-async def get_entity(model, get_unit, get_app):
+async def get_entity(model, get_unit, get_app):  # noqa: D202
     """Return a unit or an application."""
 
     async def _get_entity(name):
@@ -103,15 +104,15 @@ async def get_entity(model, get_unit, get_app):
 
 
 @pytest.fixture
-async def run_command(get_unit):
-    """
-    Run a command on a unit.
-
-    :param cmd: Command to be run
-    :param target: Unit object or unit name string
-    """
+async def run_command(get_unit):  # noqa: D202
+    """Run a command on an unit."""
 
     async def _run_command(cmd, target):
+        """Run a command on a unit.
+
+        :param cmd: Command to be run
+        :param target: Unit object or unit name string
+        """
         unit = target if type(target) is juju.unit.Unit else await get_unit(target)
         action = await unit.run(cmd)
         return action.results
@@ -120,15 +121,15 @@ async def run_command(get_unit):
 
 
 @pytest.fixture
-async def file_stat(run_command):
-    """
-    Run stat on a file.
-
-    :param path: File path
-    :param target: Unit object or unit name string
-    """
+async def file_stat(run_command):  # noqa: D202
+    """Get file stat from an unit."""
 
     async def _file_stat(path, target):
+        """Run stat on a file.
+
+        :param path: File path
+        :param target: Unit object or unit name string
+        """
         cmd = STAT_FILE % path
         results = await run_command(cmd, target)
         return json.loads(results["Stdout"])
@@ -137,15 +138,15 @@ async def file_stat(run_command):
 
 
 @pytest.fixture
-async def file_contents(run_command):
-    """
-    Return the contents of a file.
-
-    :param path: File path
-    :param target: Unit object or unit name string
-    """
+async def file_contents(run_command):  # noqa: D202
+    """Return the contents of a file."""
 
     async def _file_contents(path, target):
+        """Return the contents of a file.
+
+        :param path: File path
+        :param target: Unit object or unit name string
+        """
         cmd = "cat {}".format(path)
         results = await run_command(cmd, target)
         return results["Stdout"]
@@ -154,7 +155,7 @@ async def file_contents(run_command):
 
 
 @pytest.fixture
-async def reconfigure_app(get_app, model):
+async def reconfigure_app(get_app, model):  # noqa: D202
     """Apply a different config to the requested app."""
 
     async def _reconfigure_app(cfg, target):
@@ -171,7 +172,7 @@ async def reconfigure_app(get_app, model):
 
 
 @pytest.fixture
-async def create_group(run_command):
+async def create_group(run_command):  # noqa: D202
     """Create the UNIX group specified."""
 
     async def _create_group(group_name, target):
diff --git a/src/tests/functional/test_deploy.py b/src/tests/functional/test_deploy.py
index 7f24224..11e8297 100644
--- a/src/tests/functional/test_deploy.py
+++ b/src/tests/functional/test_deploy.py
@@ -1,4 +1,5 @@
 #!/usr/bin/python3.6
+"""Charm functional tests."""
 
 import os
 
diff --git a/src/tests/unit/conftest.py b/src/tests/unit/conftest.py
index 9ca50ec..c1df1d0 100644
--- a/src/tests/unit/conftest.py
+++ b/src/tests/unit/conftest.py
@@ -1,4 +1,5 @@
 #!/usr/bin/python3
+"""Unit tests utilities."""
 
 import grp
 import os
@@ -10,6 +11,7 @@ import pytest
 
 @pytest.fixture
 def mock_hookenv_config(monkeypatch):
+    """Mock hookenv config."""
     import yaml
 
     def mock_config():
@@ -27,11 +29,13 @@ def mock_hookenv_config(monkeypatch):
 
 @pytest.fixture
 def mock_charm_dir(monkeypatch):
+    """Mock charm dir."""
     monkeypatch.setattr("charmhelpers.core.hookenv.charm_dir", lambda: ".")
 
 
 @pytest.fixture
 def sph(mock_hookenv_config, mock_charm_dir, tmpdir):
+    """Return SudoPairHelpers with mocks."""
     from libsudopair import SudoPairHelper
 
     sph = SudoPairHelper()
diff --git a/src/tests/unit/test_actions.py b/src/tests/unit/test_actions.py
index d6d86d7..ddf6003 100644
--- a/src/tests/unit/test_actions.py
+++ b/src/tests/unit/test_actions.py
@@ -1,3 +1,5 @@
+"""Unit tests for charm actions."""
+
 import os
 import sys
 import unittest.mock as mock
@@ -11,6 +13,7 @@ import actions  # NOQA
 @mock.patch("actions.action_set")
 @mock.patch("actions.status_set")
 def test_remove_action(status_set, action_set, sudo_pair_helper):
+    """Verify remove action."""
     actions.remove()
     msg = "Successfully removed sudo-pair config and binaries"
     action_set.assert_called_with({"message": msg})
diff --git a/src/tests/unit/test_libsudopair.py b/src/tests/unit/test_libsudopair.py
index 874f0a3..860d8db 100644
--- a/src/tests/unit/test_libsudopair.py
+++ b/src/tests/unit/test_libsudopair.py
@@ -1,3 +1,5 @@
+"""Sudopair lib unit tests."""
+
 import filecmp
 import grp
 import os
@@ -6,11 +8,13 @@ from libsudopair import check_valid_group, group_id
 
 
 def test_check_valid_group():
+    """Check an unix group is valid."""
     assert not check_valid_group("fake_group")
     assert check_valid_group(grp.getgrgid(os.getgid()).gr_name)
 
 
 def test_group_id():
+    """Verify group_id() is correct."""
     assert group_id(grp.getgrgid(os.getgid()).gr_name) == os.getgid()
 
 
diff --git a/src/tox.ini b/src/tox.ini
index 2085ea9..2900ead 100644
--- a/src/tox.ini
+++ b/src/tox.ini
@@ -29,9 +29,9 @@ commands =
 deps =
     black
     flake8
-#TODO    flake8-docstrings
-#TODO    flake8-import-order
-#TODO    pep8-naming
+    flake8-docstrings
+    flake8-import-order
+    pep8-naming
     flake8-colors
 
 [flake8]