Rename osim (#390)

This PR renames OSIM module to Workflows.

In order to achieve that this PR is separated in 4 commits that
respectively has the purpose of:
- Change the folder name modifying imports, settings and
comments/documentations;
- Change classes, exceptions and models names and attributes to comply
with new naming;
- Change constants names related to the module;
- Change the API path from `/osim/*` to `/workflows/*`.

Closes OSIDB-1395

.bandit

@@ -1,3 +1,3 @@
 [bandit]
-exclude: osidb/tests, collectors/bzimport/tests, collectors/jiraffe/tests, apps/osim/tests, src, .git, .tox,
+exclude: osidb/tests, collectors/bzimport/tests, collectors/jiraffe/tests, apps/workflows/tests, src, .git, .tox,
 skips: B101,B102,B301

README.md

@@ -56,7 +56,7 @@ Additional functionality is implemented by specialized [apps](apps/).
 
 * [bbsync](apps/bbsync/) Bugzilla Backwards Synchronization
 * [exploits](apps/exploits/)
-* [osim](apps/osim/) - Open Security Issue Manager
+* [workflows](apps/workflows/) - Open Security Issue Manager
 
 Various data sources are being collected by [collectors](collectors/).
 They are build on [collector framework](collectors/framework/).

apps/osim/api.py → apps/workflows/api.py

@@ -1,5 +1,5 @@
 """
-OSIM API endpoints
+Workflows API endpoints
 """
 
 import logging
@@ -12,7 +12,7 @@
 
 from apps.taskman.service import JiraTaskmanQuerier
 
-from .exceptions import OSIMException
+from .exceptions import WorkflowsException
 from .helpers import get_flaw_or_404, str2bool
 from .serializers import (
     ClassificationWorkflowSerializer,
@@ -39,7 +39,7 @@ def get(self, request, *args, **kwargs):
         )
 
 
-# TODO do we need this when OSIM is baked into OSIDB service ?
+# TODO do we need this when Workflows is baked into OSIDB service ?
 class healthy(APIView):
     """unauthenticated health check API endpoint"""
 
@@ -113,7 +113,7 @@ def post(self, request, flaw_id):
                     "classification": flaw.classification,
                 }
             )
-        except OSIMException as e:
+        except WorkflowsException as e:
             return Response({"errors": str(e)}, status=status.HTTP_409_CONFLICT)
 
 
@@ -160,7 +160,7 @@ def post(self, request, flaw_id):
                     "classification": flaw.classification,
                 }
             )
-        except OSIMException as e:
+        except WorkflowsException as e:
             return Response({"errors": str(e)}, status=status.HTTP_409_CONFLICT)
 
 

apps/workflows/api_deprecated.py

@@ -0,0 +1,46 @@
+"""
+Former OSIM API endpoints marked as deprecated
+"""
+
+import logging
+
+from drf_spectacular.utils import extend_schema
+
+from apps.workflows import api
+
+logger = logging.getLogger(__name__)
+
+
+@extend_schema(deprecated=True)
+class index(api.index):
+    """deprecated osim index API endpoint"""
+
+
+@extend_schema(deprecated=True)
+class healthy(api.healthy):
+    """deprecated osim unauthenticated health check API endpoint"""
+
+
+@extend_schema(deprecated=True)
+class adjust(api.adjust):
+    """deprecated osim adjustion API endpoint"""
+
+
+@extend_schema(deprecated=True)
+class promote(api.promote):
+    """deprecated osim promote API endpoint"""
+
+
+@extend_schema(deprecated=True)
+class reject(api.reject):
+    """deprecated osim reject API endpoint"""
+
+
+@extend_schema(deprecated=True)
+class classification(api.classification):
+    """deprecated osim classification API endpoint"""
+
+
+@extend_schema(deprecated=True)
+class workflows(api.workflows):
+    """deprecated osim info API endpoint"""

apps/workflows/apps.py

@@ -0,0 +1,13 @@
+"""
+
+    Workflows Manager
+
+"""
+
+from django.apps import AppConfig
+
+
+class Workflows(AppConfig):
+    """django name"""
+
+    name = "apps.workflows"

apps/osim/checks.py → apps/workflows/checks.py

@@ -1,5 +1,5 @@
 """
-OSIM entity requirement check definition
+Workflows entity requirement check definition
 """
 import inspect
 
@@ -38,7 +38,7 @@ class CheckParser(metaclass=MetaCheckParser):
         "cve": "cve_id",
         "cwe": "cwe_id",
         "group": "group_key",
-        "state": "osim_state",
+        "state": "workflow_state",
         "team": "team_id",
         "trackers": "trackers_filed",
     }

apps/workflows/constants.py

@@ -0,0 +1,6 @@
+"""
+Workflows constants
+"""
+
+WORKFLOWS_API_VERSION: str = "v1"
+WORKFLOW_DIR = "apps/workflows/workflows"

apps/workflows/exceptions.py

@@ -0,0 +1,31 @@
+"""
+Workflows exceptions
+"""
+
+
+class WorkflowsException(Exception):
+    """base exception class for Workflows specific exceptions"""
+
+
+class APIError(WorkflowsException):
+    """exception class for API errors"""
+
+
+class LastStateException(WorkflowsException):
+    """exception for trying to promote further when in the last possible state"""
+
+
+class MissingRequirementsException(WorkflowsException):
+    """exception for trying to change state without requirements"""
+
+
+class MissingStateException(WorkflowsException):
+    """exception for handling a non-registered state"""
+
+
+class MissingWorkflowException(WorkflowsException):
+    """exception for handling a non-registered workflow"""
+
+
+class WorkflowDefinitionError(WorkflowsException):
+    """exception class for workflow definitions errors"""

apps/osim/models.py → apps/workflows/models.py

@@ -1,5 +1,5 @@
 """
-OSIM workflow model definitions
+Workflows model definitions
 """
 
 from .checks import CheckParser

apps/osim/serializers.py → apps/workflows/serializers.py

@@ -1,5 +1,5 @@
 """
-OSIM models serializers
+Workflows models serializers
 """
 
 from drf_spectacular.utils import extend_schema_field
@@ -88,7 +88,7 @@ class Meta:
                 "workflow": {"type": "string"},
                 "state": {
                     "type": "string",
-                    "enum": WorkflowModel.OSIMState.values,
+                    "enum": WorkflowModel.WorkflowState.values,
                 },
             },
         }

apps/osim/templates/graph.html → apps/workflows/templates/graph.html

@@ -3,7 +3,7 @@
 <html lang="en">
   <head>
     <meta charset="utf-8">
-    <title>OSIM | graph/workflows</title>
+    <title>Workflows | graph/workflows</title>
   </head>
   <body>
     {% for workflow in workflows %}

apps/osim/tests/conftest.py → apps/workflows/tests/conftest.py

@@ -1,7 +1,7 @@
 import pytest
 
-from apps.osim.constants import OSIM_API_VERSION
-from apps.osim.workflow import WorkflowFramework
+from apps.workflows.constants import WORKFLOWS_API_VERSION
+from apps.workflows.workflow import WorkflowFramework
 from osidb.helpers import get_env
 
 
@@ -35,7 +35,7 @@ def ldap_test_password():
 
 @pytest.fixture
 def test_scheme_host():
-    return "http://osidb-service:8000/osim"
+    return "http://osidb-service:8000/workflows"
 
 
 @pytest.fixture
@@ -45,7 +45,7 @@ def test_scheme_host_osidb():
 
 @pytest.fixture
 def api_version():
-    return OSIM_API_VERSION
+    return WORKFLOWS_API_VERSION
 
 
 @pytest.fixture