fix Optional typing, use Permission enum (#167), codacy issues (#168)

Dockerfile

@@ -7,7 +7,7 @@ ENV MAGPIE_ENV_DIR=$MAGPIE_DIR/env
 WORKDIR $MAGPIE_DIR
 
 # magpie cron service
-ADD magpie-cron /etc/cron.d/magpie-cron
+COPY magpie-cron /etc/cron.d/magpie-cron
 RUN chmod 0644 /etc/cron.d/magpie-cron
 RUN touch ~/magpie_cron_status.log
 # set /etc/environment so that cron runs using the environment variables set by docker

magpie/__init__.py

@@ -4,10 +4,10 @@
 
 def includeme(config):
     # import needs to be here, otherwise ImportError happens during setup.py install (modules not yet installed)
-    from magpie.definitions.pyramid_definitions import NewRequest, EXCVIEW
     from magpie.api.api_generic import internal_server_error, unauthorized_or_forbidden, not_found_or_method_not_allowed
     from magpie.constants import get_constant
-    from magpie.common import get_logger
+    from magpie.definitions.pyramid_definitions import NewRequest, EXCVIEW
+    from magpie.utils import get_logger
 
     mod_dir = get_constant('MAGPIE_MODULE_DIR')
     logger = get_logger(__name__)

magpie/adapter/__init__.py

@@ -4,7 +4,7 @@
 from magpie.models import get_user
 from magpie.security import auth_config_from_settings
 from magpie.db import get_session_factory, get_tm_session, get_engine
-from magpie.common import get_logger
+from magpie.utils import get_logger
 from magpie import __meta__
 LOGGER = get_logger("TWITCHER")
 

magpie/adapter/magpieowssecurity.py

@@ -1,6 +1,5 @@
 from magpie.api.api_except import evaluate_call, verify_param
 from magpie.constants import get_constant
-from magpie.common import get_logger, JSON_TYPE
 from magpie.definitions.pyramid_definitions import (
     HTTPOk,
     HTTPNotFound,
@@ -19,7 +18,7 @@
 )
 from magpie.models import Service
 from magpie.services import service_factory
-from magpie.utils import get_magpie_url
+from magpie.utils import get_magpie_url, get_logger, CONTENT_TYPE_JSON
 from requests.cookies import RequestsCookieJar
 from six.moves.urllib.parse import urlparse
 import requests
@@ -70,7 +69,7 @@ def update_request_cookies(self, request):
             magpie_prov = request.params.get('provider', 'WSO2')
             magpie_auth = '{host}/providers/{provider}/signin'.format(host=self.magpie_url, provider=magpie_prov)
             headers = dict(request.headers)
-            headers.update({'Homepage-Route': '/session', 'Accept': JSON_TYPE})
+            headers.update({'Homepage-Route': '/session', 'Accept': CONTENT_TYPE_JSON})
             session_resp = requests.get(magpie_auth, headers=headers, verify=self.twitcher_ssl_verify)
             if session_resp.status_code != HTTPOk.code:
                 raise OWSAccessForbidden("Not authorized to access this resource. " +

magpie/adapter/magpieprocess.py

@@ -1,10 +1,8 @@
 """
 Store adapters to read data from magpie.
 """
-from magpie.utils import get_magpie_url, get_admin_cookies
 from magpie.api.api_except import raise_http
 from magpie.constants import get_constant
-from magpie.common import get_logger, JSON_TYPE
 from magpie.definitions.pyramid_definitions import (
     HTTPOk,
     HTTPCreated,
@@ -13,6 +11,7 @@
     HTTPNotImplemented,
     asbool,
 )
+from magpie.utils import get_magpie_url, get_admin_cookies, get_logger, CONTENT_TYPE_JSON
 
 # import 'process' elements separately than 'twitcher_definitions' because not defined in master
 # noinspection PyUnresolvedReferences
@@ -59,7 +58,7 @@ def __init__(self, registry):
         self.default_process_store = DefaultAdapter().processstore_factory(registry)
         self.twitcher_config = get_twitcher_configuration(registry.settings)
         self.twitcher_url = get_twitcher_url(registry.settings)
-        self.json_headers = {'Accept': JSON_TYPE, 'Content-Type': JSON_TYPE}
+        self.json_headers = {'Accept': CONTENT_TYPE_JSON, 'Content-Type': CONTENT_TYPE_JSON}
 
         # setup basic configuration ('/ems' service of type 'api', '/ems/processes' resource, admin full permissions)
         ems_res_id = self._create_resource(self.magpie_service, resource_parent_id=None, resource_type='service',
@@ -111,7 +110,7 @@ def _find_resource_id(self, parent_resource_id, resource_name):
             raise_http(httpError=HTTPNotFound, detail=detail)
 
     def _get_service_processes_resource(self):
-        # type: (...) -> Union[int, None]
+        # type: () -> Optional[int]
         """
         Finds the magpie resource 'processes' corresponding to '/ems/processes'.
 
@@ -378,7 +377,7 @@ def list_processes(self, visibility=None, request=None):
         return processes
 
     def fetch_by_id(self, process_id, visibility=None, request=None):
-        # type: (AnyStr, Optional[AnyStr], Optional[requests.Request]) -> Union[Process, None]
+        # type: (AnyStr, Optional[AnyStr], Optional[requests.Request]) -> Optional[Process]
         """
         Get a process if visible for user.
 

magpie/adapter/magpieservice.py

@@ -5,8 +5,7 @@
 # noinspection PyUnresolvedReferences
 from magpie.definitions.twitcher_definitions import ServiceStore, Service, ServiceNotFound
 from magpie.definitions.pyramid_definitions import HTTPOk, asbool
-from magpie.common import get_logger, JSON_TYPE
-from magpie.utils import get_admin_cookies, get_magpie_url
+from magpie.utils import get_admin_cookies, get_magpie_url, get_logger, CONTENT_TYPE_JSON
 import requests
 LOGGER = get_logger("TWITCHER")
 
@@ -40,7 +39,7 @@ def list_services(self, request=None):
         # obtain admin access since 'service_url' is only provided on admin routes
         services = []
         path = '{}/services'.format(self.magpie_url)
-        resp = requests.get(path, cookies=self.magpie_admin_token, headers={'Accept': JSON_TYPE},
+        resp = requests.get(path, cookies=self.magpie_admin_token, headers={'Accept': CONTENT_TYPE_JSON},
                             verify=self.twitcher_ssl_verify)
         if resp.status_code != HTTPOk.code:
             raise resp.raise_for_status()

magpie/alembic/env.py

@@ -8,7 +8,7 @@
 from sqlalchemy_utils import database_exists, create_database
 from magpie.db import get_db_url
 from magpie.constants import get_constant
-from magpie.common import get_logger
+from magpie.utils import get_logger
 LOGGER = get_logger(__name__)
 
 

magpie/api/__init__.py

@@ -1,4 +1,4 @@
-from magpie.common import get_logger
+from magpie.utils import get_logger
 logger = get_logger(__name__)