Merge branch 'pylint-fixes' into 'ddd-intro'

Pylint fixes

See merge request domaindrivenarchitecture/dda-devops-build!11

.gitlab-ci.yml

@@ -27,7 +27,7 @@ pylint:
   stage: lint&test
   script:
   - pip install -r dev_requirements.txt
-  - pylint -d C0301,W0614,C0114,C0115,C0116,similarities,W0702,W0702,R0913,R0902,R0914,R1732 src/main/python/ddadevops/
+  - pylint -d W0511,R0903,C0301,W0614,C0114,C0115,C0116,similarities,W1203,W0719,W0702,W0702,R0913,R0902,R0914,R1732 src/main/python/ddadevops/
 
 pytest:
   stage: lint&test

src/main/python/ddadevops/devops_build.py

@@ -1,5 +1,4 @@
 from typing import Optional
-from subprocess import run, CalledProcessError
 import deprecation
 from .domain import Devops
 from .infrastructure import ProjectRepository, FileApi

src/main/python/ddadevops/domain/common.py

@@ -1,6 +1,6 @@
-import deprecation
-import logging
 from typing import List
+import logging
+import deprecation
 
 def filter_none(list_to_filter):
     return [x for x in list_to_filter if x is not None]
@@ -10,21 +10,20 @@ class Validateable:
         value = self.__dict__[field_name]
         if value is None or value == "":
             return [f"Field '{field_name}' must not be empty."]
-        else:
-            return []
+
+        return []
 
     def validate(self) -> List[str]:
         return []
 
     def is_valid(self) -> bool:
         return len(self.validate()) < 1
-    
+
     def throw_if_invalid(self):
         if not self.is_valid():
             issues = '\n'.join(self.validate())
             raise ValueError(f"Invalid Validateable: {issues}")
 
-
 class DnsRecord(Validateable):
     def __init__(self, fqdn, ipv4=None, ipv6=None):
         self.fqdn = fqdn
@@ -46,7 +45,7 @@ class Devops(Validateable):
         self.stage = stage
         self.name = name
         self.project_root_path = project_root_path
-        logging.warn(f"Set project root in DevOps {self.project_root_path}")
+        logging.warning(f"Set project root in DevOps {self.project_root_path}")
         self.module = module
         if not name:
             self.name = module
@@ -56,22 +55,23 @@ class Devops(Validateable):
 
     @deprecation.deprecated(deprecated_in="3.2")
     # use .name instead
+    #pylint: disable=method-hidden
     def name(self):
         return self.name
 
     def build_path(self):
         path = [self.project_root_path, self.build_dir_name, self.name, self.module]
-        logging.warn(f"Set project build_path in Devops {path}")
+        logging.warning(f"Set project build_path in Devops {path}")
         return "/".join(filter_none(path))
 
     def __put__(self, key, value):
         self.stack[key] = value
 
-    def __get__(self, key):
+    def __get(self, key):
         return self.stack[key]
 
     def __get_keys__(self, keys):
         result = {}
         for key in keys:
-            result[key] = self.__get__(key)
+            result[key] = self.__get(key)
         return result

src/main/python/ddadevops/domain/image.py

@@ -1,4 +1,3 @@
-from typing import Optional
 from .common import (
     filter_none,
     Validateable,
@@ -11,7 +10,6 @@ class Image(Validateable):
         dockerhub_user,
         dockerhub_password,
         devops: Devops,
-        build_dir_name="target",
         use_package_common_files=True,
         build_commons_path=None,
         docker_build_commons_dir_name="docker",
@@ -26,5 +24,5 @@ class Image(Validateable):
         self.devops = devops
 
     def docker_build_commons_path(self):
-        list = [self.build_commons_path, self.docker_build_commons_dir_name]
-        return "/".join(filter_none(list)) + "/"
+        commons_path = [self.build_commons_path, self.docker_build_commons_dir_name]
+        return "/".join(filter_none(commons_path)) + "/"

src/main/python/ddadevops/domain/release.py

@@ -2,7 +2,6 @@ from enum import Enum
 from typing import Optional
 from pathlib import Path
 from .common import (
-    filter_none,
     Validateable,
     Devops,
 )
@@ -19,8 +18,8 @@ class EnvironmentKeys(Enum):
 
 class Version():
 
-    def __init__(self, id: Path, version_list: list):
-        self.id = id
+    def __init__(self, path: Path, version_list: list):
+        self.path = path
         self.version_list = version_list
         self.version_string: Optional[str | None] = None
         self.is_snapshot: Optional[bool | None] = None
@@ -43,7 +42,7 @@ class Version():
                 self.version_list[ReleaseType.MINOR.value] = 0
                 self.version_list[ReleaseType.MAJOR.value] += 1
             case None:
-                raise Exception("Release Type was not set!")
+                raise RuntimeError("Release Type was not set!")
 
     def get_version_string(self) -> str:
         self.version_string = ".".join([str(x) for x in self.version_list])
@@ -52,13 +51,13 @@ class Version():
         return self.version_string
 
     def create_release_version(self, release_type: ReleaseType | None):
-        release_version = Version(self.id, self.version_list.copy())
+        release_version = Version(self.path, self.version_list.copy())
         release_version.is_snapshot = self.is_snapshot
         release_version.increment(release_type)
         return release_version
 
     def create_bump_version(self):
-        bump_version = Version(self.id, self.version_list.copy())
+        bump_version = Version(self.path, self.version_list.copy())
         bump_version.is_snapshot = self.is_snapshot
         bump_version.increment(ReleaseType.BUMP)
         return bump_version
@@ -100,9 +99,9 @@ class Release(Validateable):
         self.config_file = config_file
         self.release_context: ReleaseContext | None = None
 
-    def set_release_context(self, set_release_context: ReleaseContext): 
+    def set_release_context(self, set_release_context: ReleaseContext):
         self.release_context = set_release_context
-    
+
     def release_version(self):
         return self.release_context.release_version()
 

src/main/python/ddadevops/infrastructure/release_mixin/infrastructure_api.py

@@ -1,6 +1,5 @@
 import json
 import re
-import subprocess as sub
 from abc import ABC, abstractmethod
 from typing import Optional
 from pathlib import Path
@@ -26,7 +25,7 @@ class FileHandler(ABC):
             case '.py':
                 file_handler = PythonFileHandler()
             case _:
-                raise Exception(
+                raise RuntimeError(
                     f'The file type "{config_file_type}" is not implemented')
         # TODO: Attribute is only set in classmethod. Should this be initialized outside of this class?
         file_handler.config_file_path = file_path
@@ -47,7 +46,7 @@ class JsonFileHandler(FileHandler):
     def parse(self) -> tuple[list[int], bool]:
         if self.config_file_path is None:
             raise ValueError("No file name given.")
-        with open(self.config_file_path, 'r') as json_file:
+        with open(self.config_file_path, 'r', encoding='utf-8') as json_file:
             json_version = json.load(json_file)['version']
             is_snapshot = False
             if '-SNAPSHOT' in json_version:
@@ -57,7 +56,7 @@ class JsonFileHandler(FileHandler):
             return version, is_snapshot
 
     def write(self, version_string):
-        with open(self.config_file_path, 'r+') as json_file:
+        with open(self.config_file_path, 'r+', encoding='utf-8') as json_file:
             json_data = json.load(json_file)
             json_data['version'] = version_string
             json_file.seek(0)
@@ -70,7 +69,7 @@ class GradleFileHandler(FileHandler):
     def parse(self) -> tuple[list[int], bool]:
         if self.config_file_path is None:
             raise ValueError("No file name given.")
-        with open(self.config_file_path, 'r') as gradle_file:
+        with open(self.config_file_path, 'r', encoding='utf-8') as gradle_file:
             contents = gradle_file.read()
             version_line = re.search("\nversion = .*", contents)
             exception = Exception("Version not found in gradle file")
@@ -94,7 +93,7 @@ class GradleFileHandler(FileHandler):
             return version, is_snapshot
 
     def write(self, version_string):
-        with open(self.config_file_path, 'r+') as gradle_file:
+        with open(self.config_file_path, 'r+', encoding='utf-8') as gradle_file:
             contents = gradle_file.read()
             version_substitute = re.sub(
                 '\nversion = "[0-9]*\\.[0-9]*\\.[0-9]*(-SNAPSHOT)?"', f'\nversion = "{version_string}"', contents)
@@ -108,7 +107,7 @@ class PythonFileHandler(FileHandler):
     def parse(self) -> tuple[list[int], bool]:
         if self.config_file_path is None:
             raise ValueError("No file name given.")
-        with open(self.config_file_path, 'r') as python_file:
+        with open(self.config_file_path, 'r', encoding='utf-8') as python_file:
             contents = python_file.read()
             version_line = re.search("\nversion = .*\n", contents)
             exception = Exception("Version not found in gradle file")
@@ -132,7 +131,7 @@ class PythonFileHandler(FileHandler):
             return version, is_snapshot
 
     def write(self, version_string):
-        with open(self.config_file_path, 'r+') as python_file:
+        with open(self.config_file_path, 'r+', encoding='utf-8') as python_file:
             contents = python_file.read()
             version_substitute = re.sub(
                 '\nversion = "[0-9]*\\.[0-9]*\\.[0-9]*(-SNAPSHOT)?"', f'\nversion = "{version_string}"', contents)
@@ -146,7 +145,7 @@ class ClojureFileHandler(FileHandler):
     def parse(self) -> tuple[list[int], bool]:
         if self.config_file_path is None:
             raise ValueError("No file name given.")
-        with open(self.config_file_path, 'r') as clj_file:
+        with open(self.config_file_path, 'r', encoding='utf-8') as clj_file:
             contents = clj_file.read()
             version_line = re.search("^\\(defproject .*\n", contents)
             exception = Exception("Version not found in clj file")
@@ -170,7 +169,7 @@ class ClojureFileHandler(FileHandler):
             return version, is_snapshot
 
     def write(self, version_string):
-        with open(self.config_file_path, 'r+') as clj_file:
+        with open(self.config_file_path, 'r+', encoding='utf-8') as clj_file:
             clj_first = clj_file.readline()
             clj_rest = clj_file.read()
             version_substitute = re.sub(
@@ -186,6 +185,7 @@ class GitApi():
     def __init__(self):
         self.execution_api = ExecutionApi()
 
+    # pylint: disable=invalid-name
     def get_latest_n_commits(self, n: int):
         return self.execution_api.execute(
             f'git log --oneline --format="%s %b" -n {n}')
@@ -204,11 +204,10 @@ class GitApi():
         return self.execution_api.execute('git describe --tags --abbrev=0')
 
     def get_current_branch(self):
-        self.execution_api.execute('git branch --show-current')
-        return ''.join(self.execution_api.stdout).rstrip()
+        return ''.join(self.execution_api.execute('git branch --show-current')).rstrip()
 
     def init(self, default_branch: str = "main"):
-        self.execution_api.execute(f'git init')
+        self.execution_api.execute('git init')
         self.execution_api.execute(f'git checkout -b {default_branch}')
 
     def set_user_config(self, email: str, name: str):

src/main/python/ddadevops/infrastructure/release_mixin/repo.py

@@ -1,11 +1,11 @@
-from typing import Optional
+
 from src.main.python.ddadevops.domain import (
     ReleaseContext,
     Version,
     ReleaseType,
     EnvironmentKeys,
 )
-from src.main.python.ddadevops.infrastructure.release_mixin import (
+from src.main.python.ddadevops.infrastructure.release_mixin.infrastructure_api import (
     FileHandler,
     GitApi,
     EnvironmentApi,
@@ -23,9 +23,8 @@ class VersionRepository:
 
     def write_file(self, version_string):
         if self.file_handler is None:
-            raise Exception("Version was not created by load_file method.")
-        else:
-            self.file_handler.write(version_string)
+            raise RuntimeError("Version was not created by load_file method.")
+        self.file_handler.write(version_string)
 
     def parse_file(self):
         version_list, is_snapshot = self.file_handler.parse()
@@ -53,29 +52,30 @@ class ReleaseTypeRepository:
 
     @classmethod
     def from_git(cls, git_api: GitApi):
-        releaseTypeRepo = cls(git_api=git_api)
-        releaseTypeRepo.get_from_git = True
-        return releaseTypeRepo
+        release_type_repo = cls(git_api=git_api)
+        release_type_repo.get_from_git = True
+        return release_type_repo
 
     @classmethod
     def from_environment(cls, environment_api: EnvironmentApi):
-        releaseTypeRepo = cls(environment_api=environment_api)
-        releaseTypeRepo.get_from_env = True
-        return releaseTypeRepo
+        release_type_repo = cls(environment_api=environment_api)
+        release_type_repo.get_from_env = True
+        return release_type_repo
 
     def __get_release_type_git(self) -> ReleaseType | None:
         latest_commit = self.git_api.get_latest_commit()
 
-        if ReleaseType.MAJOR.name in latest_commit.upper():
-            return ReleaseType.MAJOR
-        elif ReleaseType.MINOR.name in latest_commit.upper():
-            return ReleaseType.MINOR
-        elif ReleaseType.PATCH.name in latest_commit.upper():
-            return ReleaseType.PATCH
-        elif ReleaseType.SNAPSHOT.name in latest_commit.upper():
-            return ReleaseType.SNAPSHOT
-        else:
-            return None
+        match latest_commit.upper():
+            case ReleaseType.MAJOR.name:
+                return ReleaseType.MAJOR
+            case ReleaseType.MINOR.name:
+                return ReleaseType.MINOR
+            case ReleaseType.PATCH.name:
+                return ReleaseType.PATCH
+            case ReleaseType.SNAPSHOT.name:
+                return ReleaseType.SNAPSHOT
+            case _:
+                return None
 
     def __get_release_type_environment(self) -> ReleaseType | None:
         release_name = self.environment_api.get(
@@ -86,24 +86,25 @@ class ReleaseTypeRepository:
             raise ValueError(
                 "Release Name not found. Is the Environment correctly configured?"
             )
-        elif ReleaseType.MAJOR.name in release_name.upper():
-            return ReleaseType.MAJOR
-        elif ReleaseType.MINOR.name in release_name.upper():
-            return ReleaseType.MINOR
-        elif ReleaseType.PATCH.name in release_name.upper():
-            return ReleaseType.PATCH
-        elif ReleaseType.SNAPSHOT.name in release_name.upper():
-            return ReleaseType.SNAPSHOT
-        else:
-            return None
+
+        match release_name.upper():
+            case ReleaseType.MAJOR.name:
+                return ReleaseType.MAJOR
+            case ReleaseType.MINOR.name:
+                return ReleaseType.MINOR
+            case ReleaseType.PATCH.name:
+                return ReleaseType.PATCH
+            case ReleaseType.SNAPSHOT.name:
+                return ReleaseType.SNAPSHOT
+            case _:
+                return None
 
     def get_release_type(self) -> ReleaseType | None:
         if self.get_from_git:
             return self.__get_release_type_git()
-        elif self.get_from_env:
+        if self.get_from_env:
             return self.__get_release_type_environment()
-        else:
-            raise ValueError("No valid api passed to ReleaseTypeRepository")
+        raise ValueError("No valid api passed to ReleaseTypeRepository")
 
 
 class ReleaseContextRepository:

src/main/python/ddadevops/release_mixin.py

@@ -1,4 +1,3 @@
-from typing import Optional
 from pybuilder.core import Project
 from src.main.python.ddadevops.devops_build import DevopsBuild
 from src.main.python.ddadevops.infrastructure.release_mixin import ReleaseContextRepository, ReleaseTypeRepository, VersionRepository, GitApi, EnvironmentApi