Fix unittests

.github/workflows/main.yml

@@ -10,5 +10,5 @@ jobs:
       with:
         python-version: '3.8'
         cache: 'pip'
-    - run: pip install .[deepl]
-    - run: python -m unittest discover -v
+    - run: pip install .[all]
+    - run: make test

Makefile

@@ -1,2 +1,2 @@
 test:
-	python -m unittest discover -v -s reptor/tests
+	python -m unittest discover -v

pyproject.toml

@@ -44,8 +44,9 @@ classifiers = [
 ]
 
 [project.optional-dependencies]
-deepl = ['deepl >= 1.15.0']
-gql = ['gql >= 3.4.1']
+translate = ['deepl >= 1.15.0']
+ghostwriter = ['gql >= 3.4.1']
+all = ['reptor[translate,ghostwriter]']
 
 [project.scripts]
 reptor = 'reptor.__main__:run'

reptor/api/APIClient.py

@@ -46,6 +46,7 @@ def get(self, url: str) -> requests.models.Response:
         Returns:
             requests.models.Response: Returns requests Response Object
         """
+        self.reptor.logger.debug(f"GET URL:{url}")
         response = requests.get(
             url,
             headers=self._get_headers(),
@@ -69,6 +70,7 @@ def post(
         Returns:
             requests.models.Response: Requests Responde Object
         """
+        self.reptor.logger.debug(f"POST URL:{url}")
         response = requests.post(
             url,
             headers=self._get_headers(json_content=json_content),
@@ -90,6 +92,7 @@ def put(self, url: str, data: object) -> requests.models.Response:
         Returns:
             requests.models.Response: requests Respone Object
         """
+        self.reptor.logger.debug(f"PUT URL:{url}")
         response = requests.put(
             url,
             headers=self._get_headers(),
@@ -110,6 +113,7 @@ def patch(self, url: str, data: object) -> requests.models.Response:
         Returns:
             requests.models.Response: requests Respone Object
         """
+        self.reptor.logger.debug(f"PATCH URL:{url}")
         response = requests.patch(
             url,
             headers=self._get_headers(),

reptor/api/ProjectsAPI.py

@@ -12,10 +12,11 @@ def __init__(self, **kwargs) -> None:
         super().__init__(**kwargs)
 
         self.base_endpoint = (
-            f"{self.reptor.get_config().get_server()}/api/v1/pentestprojects/"
+            f"{self.reptor.get_config().get_server()}/api/v1/pentestprojects"
         )
 
         self.object_endpoint = f"{self.base_endpoint}/{self.project_id}"
+        self.reptor.get_logger().debug(self.base_endpoint)
 
     def get_projects(self, readonly: bool = False) -> typing.List[Project]:
         """Gets list of projects
@@ -53,7 +54,9 @@ def search(self, search_term: Optional[str] = "") -> typing.List[Project]:
         return return_data
 
     def get_project(self) -> Project:
-        url = urljoin(self.base_endpoint, f"{self.project_id}/")
+        if not self.project_id:
+            raise ValueError("Make sure you have a project specified.")
+        url = self.object_endpoint
         response = self.get(url)
         return Project(response.json())
 

reptor/api/models.py

@@ -294,15 +294,15 @@ class ProjectDesignField(BaseModel):
     """
 
     name: str = ""
-    type: ProjectFieldTypes = None
+    type: ProjectFieldTypes
     label: str = ""
     origin: str = ""
     default: str = ""
     required: bool = False
-    spellcheck: bool = None
-    # Use TypeAlias instead of "typing.List['ProjectDesignField'] = []" due to Python bug
+    spellcheck: bool = False
+    # Use Any instead of "typing.List['ProjectDesignField'] = []" due to Python bug
     # See: https://bugs.python.org/issue44926
-    properties: typing.TypeAlias = "ProjectDesignField"
+    properties: Any = None
     choices: typing.List[dict] = []
     items: dict = {}
     suggestions: typing.List[str] = []
@@ -356,13 +356,20 @@ class FindingDataExtendedField(ProjectDesignField):
         typing.List,  # list
         bool,  # boolean
         float,  # number
-        typing.TypeAlias,  # "FindingDataExtendedField" for object
+        Any,  # "FindingDataExtendedField" for object
     ]
 
-    def __init__(self,
-                 design_field: ProjectDesignField,
-                 value: typing.Union[
-                     str, typing.List, bool, float, typing.TypeAlias,]):
+    def __init__(
+        self,
+        design_field: ProjectDesignField,
+        value: typing.Union[
+            str,
+            typing.List,
+            bool,
+            float,
+            Any,
+        ],
+    ):
         project_design_type_hints = typing.get_type_hints(ProjectDesignField)
         for attr in project_design_type_hints.items():
             self.__setattr__(attr[0], design_field.__getattribute__(attr[0]))
@@ -372,12 +379,15 @@ def __init__(self,
             for property in self.properties:
                 # property is of type ProjectDesignField
                 try:
-                    self.value.append(FindingDataExtendedField(
-                        property, value[property.name]))
+                    self.value.append(
+                        FindingDataExtendedField(
+                            property, value[property.name])
+                    )
                 except KeyError:
                     self.reptor.logger.fail_with_exit(
                         f"Object name '{property.name}' not found. Did you mix"
-                        f"mismatched project design with project data?")
+                        f"mismatched project design with project data?"
+                    )
         elif self.type == ProjectFieldTypes.list.value:
             self.value = list()
             for v in value:
@@ -386,51 +396,65 @@ def __init__(self,
             self.value = value
 
     def __setattr__(self, __name: str, __value: Any) -> None:
-        if __name == 'value' and __value is not None:
+        if __name == "value" and __value is not None:
             if self.type in [
-                    ProjectFieldTypes.combobox.value,
-                    ProjectFieldTypes.cvss.value,
-                    ProjectFieldTypes.string.value,
-                    ProjectFieldTypes.markdown.value]:
+                ProjectFieldTypes.combobox.value,
+                ProjectFieldTypes.cvss.value,
+                ProjectFieldTypes.string.value,
+                ProjectFieldTypes.markdown.value,
+            ]:
                 if not isinstance(__value, str):
                     raise ValueError(
-                        f"'{self.name}' expects a string value (got '{__value}').")
+                        f"'{self.name}' expects a string value (got '{__value}')."
+                    )
             elif self.type == ProjectFieldTypes.date.value:
                 try:
-                    datetime.datetime.strptime(__value, '%Y-%m-%d')
+                    datetime.datetime.strptime(__value, "%Y-%m-%d")
                 except ValueError:
                     raise ValueError(
-                        f"'{self.name}' expects date in format 2000-01-01 (got '{__value}').")
+                        f"'{self.name}' expects date in format 2000-01-01 (got '{__value}')."
+                    )
             elif self.type == ProjectFieldTypes.enum.value:
-                valid_enums = [choice['value'] for choice in self.choices]
+                valid_enums = [choice["value"] for choice in self.choices]
                 if __value not in valid_enums:
                     raise ValueError(
-                        f"'{__value}' is not an valid enum choice for '{self.name}'.")
-            elif self.type in [ProjectFieldTypes.list.value, ProjectFieldTypes.object.value]:
+                        f"'{__value}' is not an valid enum choice for '{self.name}'."
+                    )
+            elif self.type in [
+                ProjectFieldTypes.list.value,
+                ProjectFieldTypes.object.value,
+            ]:
                 if not isinstance(__value, list):
                     raise ValueError(
-                        f"Value of '{self.name}' must be list  (got '{type(__value)}').")
+                        f"Value of '{self.name}' must be list  (got '{type(__value)}')."
+                    )
                 if not all([isinstance(v, FindingDataExtendedField) for v in __value]):
                     raise ValueError(
-                        f"Value of '{self.name}' must contain list of FindingDataExtendedFields.")
+                        f"Value of '{self.name}' must contain list of FindingDataExtendedFields."
+                    )
                 types = set([v.type for v in __value])
                 if len(types) > 1:
                     raise ValueError(
                         f"Values of '{self.name}' must not contain FindingDataExtendedFields"
-                        f"of multiple types  (got {','.join(types)}).")
+                        f"of multiple types  (got {','.join(types)})."
+                    )
             elif self.type == ProjectFieldTypes.boolean.value:
                 if not isinstance(__value, bool):
                     raise ValueError(
-                        f"'{self.name}' expects a boolean value (got '{__value}').")
+                        f"'{self.name}' expects a boolean value (got '{__value}')."
+                    )
             elif self.type == ProjectFieldTypes.number.value:
                 if not isinstance(__value, int) and not isinstance(__value, float):
-                    raise ValueError(f"'{self.name}' expects int or float (got '{__value}').")
+                    raise ValueError(
+                        f"'{self.name}' expects int or float (got '{__value}')."
+                    )
             elif self.type == ProjectFieldTypes.user.value:
                 try:
                     UUID(__value, version=4)
                 except ValueError:
                     raise ValueError(
-                        f"'{self.name}' expects v4 uuid (got '{__value}').")
+                        f"'{self.name}' expects v4 uuid (got '{__value}')."
+                    )
 
         return super().__setattr__(__name, __value)
 
@@ -452,14 +476,18 @@ class FindingDataExtended(BaseModel):
     retest_status: FindingDataExtendedField
     evidence: FindingDataExtendedField
 
-    def __init__(self,
-                 design_fields: typing.List[ProjectDesignField] = None,
-                 field_data: FindingData = None,):
+    def __init__(
+        self,
+        design_fields: typing.List[ProjectDesignField] = None,
+        field_data: FindingData = None,
+    ):
         for design_field in design_fields:
             self.__setattr__(
                 design_field.name,
                 FindingDataExtendedField(
-                    design_field, field_data.__getattribute__(design_field.name))
+                    design_field, field_data.__getattribute__(
+                        design_field.name)
+                ),
             )
 
 

reptor/plugins/core/Nmap/tests/test_nmap.py

@@ -19,7 +19,6 @@
 class NmapTests(unittest.TestCase):
     def setUp(self) -> None:
         reptor = Reptor()
-        reptor._load_config()
         Nmap.set_template_vars(os.path.dirname(templates_path))
         self.nmap = Nmap(reptor=reptor)
 

reptor/plugins/core/Translate.py

@@ -10,7 +10,7 @@
 try:
     import deepl
 except ImportError:
-    deepl = None
+    raise Exception("Make sure you have deepl installed.")
 
 
 class Translate(Base):
@@ -152,7 +152,7 @@ def add_arguments(cls, parser, plugin_filepath=None):
     def _set_deepl_translator(self) -> None:
         if not deepl:
             raise ModuleNotFoundError(
-                'deepl library not found. Install with "pip3 install reptor[deepl]'
+                'deepl library not found. Install plugin requirements with "pip3 install reptor[translate]'
             )
 
         try:
@@ -210,14 +210,13 @@ def _translate_project(self) -> None:
         if self.dry_run:
             self._translate = self._dry_run_translate
         self.display(f"Translating project name{' (dry run)' if self.dry_run else ''}.")
-        from_projects_api: ProjectsAPI = ProjectsAPI(reptor=self.reptor)
-        from_project = from_projects_api.get_project()
+        from_project = self.reptor.api.projects.get_project()
         from_project_name = from_project.name
         to_project_title = self._translate(from_project_name)
 
         self.display(f"Duplicating project{' (dry run)' if self.dry_run else ''}.")
         if not self.dry_run:
-            to_project_id = from_projects_api.duplicate().id
+            to_project_id = self.reptor.api.projects.duplicate().id
             self.display(
                 f"Updating project metadata{' (dry run)' if self.dry_run else ''}."
             )