Replace flake8 with ruff

Author: ssbarnea

.pre-commit-config.yaml

@@ -30,12 +30,11 @@ repos:
       - id: check-executables-have-shebangs
       - id: check-merge-conflict
       - id: debug-statements
-  - repo: https://github.com/PyCQA/flake8
-    rev: 6.0.0
+  - repo: https://github.com/charliermarsh/ruff-pre-commit
+    rev: "v0.0.262"
     hooks:
-      - id: flake8
-        additional_dependencies:
-          - flake8-black
+      - id: ruff
+        args: [--fix, --exit-non-zero-on-fix]
   - repo: https://github.com/ansible/ansible-lint.git
     rev: v6.14.6
     hooks:

conftest.py

@@ -4,6 +4,7 @@
 import string
 
 import pytest
+
 from molecule import config, logger, util
 from molecule.scenario import ephemeral_directory
 
@@ -23,9 +24,9 @@ def _rebake_command(cmd, env, out=LOG.info, err=LOG.error):
     return cmd.bake(_env=env, _out=out, _err=err)
 
 
-@pytest.fixture
+@pytest.fixture()
 def random_string(length=5):
-    return "".join((random.choice(string.ascii_uppercase) for _ in range(length)))
+    return "".join(random.choice(string.ascii_uppercase) for _ in range(length))
 
 
 @contextlib.contextmanager
@@ -36,15 +37,15 @@ def change_dir_to(dir_name):
     os.chdir(cwd)
 
 
-@pytest.fixture
+@pytest.fixture()
 def temp_dir(tmpdir, random_string, request):
     directory = tmpdir.mkdir(random_string)
 
     with change_dir_to(directory.strpath):
         yield directory
 
 
-@pytest.fixture
+@pytest.fixture()
 def resources_folder_path():
     resources_folder_path = os.path.join(os.path.dirname(__file__), "resources")
     return resources_folder_path
@@ -77,9 +78,9 @@ def get_molecule_file(path):
 
 @pytest.helpers.register
 def molecule_ephemeral_directory(_fixture_uuid):
-    project_directory = "test-project-{}".format(_fixture_uuid)
+    project_directory = f"test-project-{_fixture_uuid}"
     scenario_name = "test-instance"
 
     return ephemeral_directory(
-        os.path.join("molecule_test", project_directory, scenario_name)
+        os.path.join("molecule_test", project_directory, scenario_name),
     )

pyproject.toml

@@ -79,6 +79,44 @@ selinux = [
     'selinux; sys_platform=="linux"',
 ]
 
+[tool.ruff]
+ignore = [
+  "E501", # we use black
+  # we deliberately ignore these:
+  "EM102",
+  # temporary disabled until we either fix them or decide to ignore them:
+  "A001",
+  "ANN",
+  "ARG",
+  "B006",
+  "B028",
+  "BLE",
+  "C901",
+  "D",
+  "DTZ",
+  "EXE",
+  "FBT",
+  "INP",
+  "ISC",
+  "N",
+  "PGH",
+  "PLR",
+  "PT",
+  "PTH",
+  "RET",
+  "S",
+  "TRY",
+]
+select = ["ALL"]
+target-version = "py39"
+# Same as Black.
+line-length = 88
+
+[tool.ruff.flake8-pytest-style]
+parametrize-values-type = "tuple"
+
+[tool.ruff.isort]
+known-first-party = ["molecule_plugins"]
 
 [project.entry-points."molecule.driver"]
 azure = "molecule_plugins.azure.driver:Azure"

requirements.yml

@@ -6,3 +6,5 @@ collections:
   - name: community.docker
     version: ">=3.0.2"
   - name: containers.podman
+  - name: community.crypto
+  - name: community.vagrant

src/molecule_plugins/azure/driver.py

@@ -18,10 +18,9 @@
 #  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 #  DEALINGS IN THE SOFTWARE.
 import os
-from molecule import logger
-from molecule.api import Driver
 
-from molecule import util
+from molecule import logger, util
+from molecule.api import Driver
 
 LOG = logger.get_logger(__name__)
 
@@ -72,10 +71,10 @@ class Azure(Driver):
             - foo
 
     .. _`Azure`: https://azure.microsoft.com
-    """  # noqa
+    """
 
-    def __init__(self, config=None):
-        super(Azure, self).__init__(config)
+    def __init__(self, config=None) -> None:
+        super().__init__(config)
         self._name = "azure"
 
     @property
@@ -125,7 +124,7 @@ def ansible_connection_options(self, instance_name):
             }
         except StopIteration:
             return {}
-        except IOError:
+        except OSError:
             # Instance has yet to be provisioned , therefore the
             # instance_config is not on disk.
             return {}

src/molecule_plugins/containers/driver.py

@@ -1,10 +1,8 @@
 """Containers Driver Module."""
-from __future__ import absolute_import
 
 import inspect
 import os
 import shutil
-from typing import Dict
 
 from molecule import logger
 
@@ -34,9 +32,9 @@ class Container(DriverBackend):
 
     This class aims to provide an agnostic container enginer implementation,
     which should allow users to consume whichever enginer they have available.
-    """  # noqa
+    """
 
-    def __init__(self, config=None):
+    def __init__(self, config=None) -> None:
         """Construct Container."""
         super().__init__(config)
         self._name = "containers"
@@ -45,7 +43,7 @@ def __init__(self, config=None):
         self._path = os.path.abspath(os.path.dirname(inspect.getfile(DriverBackend)))
 
     @property
-    def required_collections(self) -> Dict[str, str]:
+    def required_collections(self) -> dict[str, str]:
         """Return collections dict containing names and versions required."""
         return {
             "ansible.posix": "1.3.0",

src/molecule_plugins/docker/driver.py

@@ -19,10 +19,8 @@
 #  DEALINGS IN THE SOFTWARE.
 """Docker Driver Module."""
 
-from __future__ import absolute_import
 
 import os
-from typing import Dict
 
 from molecule import logger
 from molecule.api import Driver
@@ -187,13 +185,13 @@ class Docker(Driver):
     .. _`Docker`: https://www.docker.com
     .. _`systemd`: https://www.freedesktop.org/wiki/Software/systemd/
     .. _`CMD`: https://docs.docker.com/engine/reference/builder/#cmd
-    """  # noqa
+    """
 
     _passed_sanity = False
 
-    def __init__(self, config=None):
+    def __init__(self, config=None) -> None:
         """Construct Docker."""
-        super(Docker, self).__init__(config)
+        super().__init__(config)
         self._name = "docker"
 
     @property
@@ -269,7 +267,7 @@ def reset(self):
             n.remove()
 
     @property
-    def required_collections(self) -> Dict[str, str]:
+    def required_collections(self) -> dict[str, str]:
         """Return collections dict containing names and versions required."""
         # https://galaxy.ansible.com/community/docker
         return {"community.docker": "3.0.2", "ansible.posix": "1.4.0"}

src/molecule_plugins/docker/playbooks/filter_plugins/get_docker_networks.py

@@ -28,7 +28,7 @@ def get_docker_networks(data, labels={}):
     return network_list
 
 
-class FilterModule(object):
+class FilterModule:
     """Core Molecule filter plugins."""
 
     def filters(self):

src/molecule_plugins/ec2/driver.py

@@ -18,9 +18,9 @@
 #  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 #  DEALINGS IN THE SOFTWARE.
 
-from base64 import b64decode
 import os
 import sys
+from base64 import b64decode
 
 try:
     from cryptography.hazmat.backends import default_backend
@@ -38,11 +38,9 @@
 except ImportError:
     HAS_BOTO3 = False
 
-from molecule import logger
+from molecule import logger, util
 from molecule.api import Driver
 
-from molecule import util
-
 LOG = logger.get_logger(__name__)
 
 
@@ -153,10 +151,10 @@ class EC2(Driver):
             - foo
 
     .. _`EC2`: https://aws.amazon.com/ec2/
-    """  # noqa
+    """
 
-    def __init__(self, config=None):
-        super(EC2, self).__init__(config)
+    def __init__(self, config=None) -> None:
+        super().__init__(config)
         self._name = "ec2"
 
     @property
@@ -181,13 +179,12 @@ def login_cmd_template(self):
         if ansible_connection_options.get("ansible_connection") == "winrm":
             return (
                 "xfreerdp "
-                '"/u:%s" '
-                '"/p:%s" '
-                "/v:%s "
+                '"/u:{}" '
+                '"/p:{}" '
+                "/v:{} "
                 "/cert-tofu "
                 "+clipboard "
-                "/grab-keyboard"
-                % (
+                "/grab-keyboard".format(
                     ansible_connection_options["ansible_user"],
                     ansible_connection_options["ansible_password"],
                     ansible_connection_options["ansible_host"],
@@ -244,12 +241,13 @@ def ansible_connection_options(self, instance_name):
                 not conn_opts.get("ansible_password")
             ):
                 conn_opts["ansible_password"] = self._get_windows_instance_pass(
-                    d["instance_ids"][0], d["identity_file"]
+                    d["instance_ids"][0],
+                    d["identity_file"],
                 )
             return conn_opts
         except StopIteration:
             return {}
-        except IOError:
+        except OSError:
             # Instance has yet to be provisioned , therefore the
             # instance_config is not on disk.
             return {}

src/molecule_plugins/gce/driver.py

@@ -17,12 +17,10 @@
 #  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 #  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 #  DEALINGS IN THE SOFTWARE.
-from typing import Dict
 import os
-from molecule import logger
-from molecule.api import Driver
 
-from molecule import util
+from molecule import logger, util
+from molecule.api import Driver
 
 LOG = logger.get_logger(__name__)
 
@@ -77,10 +75,10 @@ class GCE(Driver):
             - foo
 
     .. _`GCE`: https://cloud.google.com/compute/docs/
-    """  # noqa
+    """
 
-    def __init__(self, config=None):
-        super(GCE, self).__init__(config)
+    def __init__(self, config=None) -> None:
+        super().__init__(config)
         self._name = "gce"
 
     @property
@@ -129,7 +127,7 @@ def ansible_connection_options(self, instance_name):
                         "ansible_private_key_file": d["identity_file"],
                         "ansible_connection": "ssh",
                         "ansible_ssh_common_args": " ".join(
-                            self.ssh_connection_options
+                            self.ssh_connection_options,
                         ),
                     }
 
@@ -148,7 +146,7 @@ def ansible_connection_options(self, instance_name):
                     }
         except StopIteration:
             return {}
-        except IOError:
+        except OSError:
             # Instance has yet to be provisioned , therefore the
             # instance_config is not on disk.
             return {}
@@ -171,6 +169,6 @@ def template_dir(self):
         return os.path.join(os.path.dirname(__file__), "cookiecutter")
 
     @property
-    def required_collections(self) -> Dict[str, str]:
+    def required_collections(self) -> dict[str, str]:
         # https://galaxy.ansible.com/google/cloud
         return {"google.cloud": "1.0.2", "community.crypto": "1.8.0"}