fix: lint issues for Access/helpers.py

Author: sharad-sharma

Diff for: .github/workflows/unit-tests.yml

@@ -25,6 +25,6 @@ jobs:
       run: |
         pip install -r Access/access_modules/requirements.txt --no-cache-dir --ignore-installed
     - name: Lint code base
-      run: python -m pylama Access/accessrequest_helper.py Access/models.py Access/views.py Access/views_helper.py Access/validators.py Access/notifications.py scripts bootprocess enigma_automation
+      run: python -m pylama Access/accessrequest_helper.py Access/models.py Access/views.py Access/views_helper.py Access/validators.py Access/notifications.py Access/helpers.py scripts bootprocess enigma_automation
     - name: Test with pytest
       run: python -m pytest -v --cov --disable-warnings

Diff for: Access/context_processors.py

@@ -1,5 +1,5 @@
 from Access.models import User
-from Access.helpers import get_available_access_modules, getPossibleApproverPermissions
+from Access.helpers import get_available_access_modules, get_possible_approver_permissions
 
 
 def add_variables_to_context(request):

Diff for: Access/decorators.py

@@ -1,5 +1,5 @@
 from django.core.exceptions import PermissionDenied
-from Access.helpers import getPossibleApproverPermissions
+from Access.helpers import get_possible_approver_permissions
 from django.core.paginator import Paginator
 
 
@@ -41,7 +41,7 @@ def wrap(request, *args, **kwargs):
 
 def user_any_approver(function):
     def wrap(request, *args, **kwargs):
-        all_approve_permissions = getPossibleApproverPermissions()
+        all_approve_permissions = get_possible_approver_permissions()
         is_any_approver = request.user.user.is_an_approver(all_approve_permissions)
         if is_any_approver:
             return function(request, *args, **kwargs)

Diff for: Access/helpers.py

@@ -1,22 +1,23 @@
-from django.template import loader
+""" module contains helper methods """
 from os.path import dirname, basename, isfile, join
 import glob
 import logging
 import re
 import datetime
 import random
-
+from typing import Dict
+from django.template import loader
 from Access.access_modules import *  # NOQA
-from enigma_automation.settings import PERMISSION_CONSTANTS
 from Access.models import User
+from enigma_automation.settings import PERMISSION_CONSTANTS
 
 logger = logging.getLogger(__name__)
 
-available_accesses = []
-cached_accesses = []
+MAP_ACCESSES: Dict[str, list[object]] = {}
 
 
 def get_available_access_module_from_tag(tag):
+    """ method to get available access module from tag """
     all_modules = get_available_access_modules()
     if tag in all_modules:
         return get_available_access_modules()[tag]
@@ -31,27 +32,29 @@ def get_available_access_module_desc():
 
 
 def get_available_access_type():
+    """ method to get available access type """
     available_accesses_type = [access.access_desc() for access in _get_modules_on_disk()]
     return available_accesses_type
 
 
 def get_available_access_modules():
-    global available_accesses
-    if len(available_accesses) > 0:
-        return available_accesses.copy()
+    """ method to get available access modules """
+    if MAP_ACCESSES.get("AVAILABLE_ACCESSES"):
+        return MAP_ACCESSES.get("AVAILABLE_ACCESSES").copy()
 
     available_accesses = {
         access.tag(): access for access in _get_modules_on_disk() if access.available
     }
+    MAP_ACCESSES["AVAILABLE_ACCESSES"] = available_accesses
     return available_accesses.copy()
 
 
 def _get_modules_on_disk():
-    global cached_accesses
-    if len(cached_accesses) > 0:
-        return cached_accesses
+    if MAP_ACCESSES.get("CACHED_ACCESSES"):
+        return MAP_ACCESSES.get("CACHED_ACCESSES")
+
     access_modules_dirs = glob.glob(join(dirname(__file__), "access_modules", "*"))
-    # create a deepcopy copy of the list so we can remove items from the original list
+    # create a deepcopy copy of the list, so we can remove items from the original list
     access_modules_dirs_copy = access_modules_dirs[:]
     for each_dir in access_modules_dirs_copy:
         if re.search(r"/(base_|__pycache__|secrets)", each_dir):
@@ -62,13 +65,15 @@ def _get_modules_on_disk():
         for f in access_modules_dirs
         if not isfile(f)
     ]
+    MAP_ACCESSES["CACHED_ACCESSES"] = cached_accesses
     return cached_accesses
 
 
 def check_user_permissions(user, permissions):
+    """ method to check user permission """
     if hasattr(user, "user"):
         permission_labels = [permission.label for permission in user.user.permissions]
-        if type(permissions) == list:
+        if isinstance(permissions, list):
             if len(set(permissions).intersection(permission_labels)) > 0:
                 return True
         else:
@@ -78,6 +83,7 @@ def check_user_permissions(user, permissions):
 
 
 def sla_breached(requested_on):
+    """ method to handle sla breach """
     diff = datetime.datetime.now().replace(tzinfo=None) - requested_on.replace(
         tzinfo=None
     )
@@ -86,23 +92,26 @@ def sla_breached(requested_on):
     return hours >= 24
 
 
-def generateStringFromTemplate(filename, **kwargs):
+def generate_string_from_template(filename, **kwargs):
+    """ method to generate string from template """
     template = loader.get_template(filename)
     vals = {}
     for key, value in kwargs.items():
         vals[key] = value
     return template.render(vals)
 
 
-def getPossibleApproverPermissions():
+def get_possible_approver_permissions():
+    """ method to get possible approver permissions """
     all_approver_permissions = [PERMISSION_CONSTANTS["DEFAULT_APPROVER_PERMISSION"]]
-    for each_tag, each_module in get_available_access_modules().items():
+    for _each_tag, each_module in get_available_access_modules().items():
         approver_permissions = each_module.fetch_approver_permissions()
         all_approver_permissions.extend(approver_permissions.values())
     return list(set(all_approver_permissions))
 
 
 def get_approvers():
+    """ method to get approvers """
     emails = [
         user.email
         for user in User.get_active_users_with_permission(

Diff for: Access/notifications.py

@@ -30,7 +30,7 @@
 def send_new_group_create_notification(auth_user, date_time, new_group, member_list):
     """ method to send group create notification """
     subject = NEW_GROUP_EMAIL_SUBJECT + auth_user.email + " -- " + date_time
-    body = helpers.generateStringFromTemplate(
+    body = helpers.generate_string_from_template(
         filename="groupCreationEmailBody.html",
         user=str(auth_user.user),
         first_name=auth_user.first_name,
@@ -52,7 +52,7 @@ def send_new_group_approved_notification(group, group_id, initial_member_names):
     if initial_member_names:
         body += NEW_MEMBERS_ADDED_MESSAGE
         body += generate_group_member_table(initial_member_names)
-    body = helpers.generateStringFromTemplate(filename="email.html", emailBody=body)
+    body = helpers.generate_string_from_template(filename="email.html", emailBody=body)
     destination = []
     destination += MAIL_APPROVER_GROUPS[:]
     destination.append(group.requester.email)
@@ -64,7 +64,7 @@ def send_new_group_approved_notification(group, group_id, initial_member_names):
 def send_membership_accepted_notification(user, group, membership):
     """ method to send membership accepted notification """
     subject = MEMBERSHIP_ACCEPTED_SUBJECT.format(user.name, group.name)
-    body = helpers.generateStringFromTemplate(
+    body = helpers.generate_string_from_template(
         filename="membershipAcceptedEmailBody.html",
         user_name=user.name,
         group_name=group.name,
@@ -80,7 +80,7 @@ def send_mulitple_membership_accepted_notification(all_user_emails, group_name,
     """ method to send multiple membership accepted notification """
     for each_user_email in all_user_emails.keys():
         subject = MEMBERSHIP_ACCEPTED_SUBJECT.format(each_user_email, group_name)
-        body = helpers.generateStringFromTemplate(
+        body = helpers.generate_string_from_template(
             filename="membershipAcceptedEmailBody.html",
             user_name=",".join(each_user_email),
             group_name=group_name,
@@ -96,7 +96,7 @@ def generate_group_member_table(member_list):
     """ method to generate group number table """
     if len(member_list) <= 0:
         return "No members are being added initially"
-    return helpers.generateStringFromTemplate("listToTable.html", memberList=member_list)
+    return helpers.generate_string_from_template("listToTable.html", memberList=member_list)
 
 
 def send_group_owners_update_mail(destination, group_name, updated_by):
@@ -116,9 +116,9 @@ def send_group_access_add_email(
     destination, group_name, requester, request_id, member_list
 ):
     """ method to send email for group access add """
-    body = helpers.generateStringFromTemplate(
+    body = helpers.generate_string_from_template(
         filename="email.html",
-        emailBody=helpers.generateStringFromTemplate(
+        emailBody=helpers.generate_string_from_template(
             "add_access_to_group.html",
             request_id=request_id,
             group_name=group_name,
@@ -137,7 +137,7 @@ def send_revoke_failure_mail(
     """ method to send email for revoke failure """
     try:
         subject = f"Celery Revoke Failed for the request: {request_id}"
-        body = helpers.generateStringFromTemplate(
+        body = helpers.generate_string_from_template(
             "celery_revoke_failure_email.html",
             request_id=request_id,
             revoker_email=revoker_email,
@@ -161,7 +161,7 @@ def send_mail_for_request_decline(
     subject = USER_ACCESS_REQUEST_DENIED_SUBJECT.format(
         auth_user.email, access_type, description
     )
-    body = helpers.generateStringFromTemplate(
+    body = helpers.generate_string_from_template(
         filename="requestDeclineEmail.html",
         user=auth_user.email,
         request_id=request_id,
@@ -196,7 +196,7 @@ def send_mail_for_member_approval(user_email, requester, group_name, reason):
         + "]"
     )
     destination = MAIL_APPROVER_GROUPS[:]
-    body = helpers.generateStringFromTemplate(
+    body = helpers.generate_string_from_template(
         filename="email.html",
         emailBody=generate_user_add_to_group_email_body(
             user_email,
@@ -214,7 +214,7 @@ def generate_user_add_to_group_email_body(
     user_email, primary_approver, other_approver, requester, group_name, reason
 ):
     """ method to generate user add to group email body """
-    return helpers.generateStringFromTemplate(
+    return helpers.generate_string_from_template(
         filename="add_user_to_group_mail.html",
         user_email=user_email,
         primary_approver=primary_approver,
@@ -240,7 +240,7 @@ def send_group_access_declined(
     destination, group_name, requester, decliner, request_id, declined_access, reason
 ):
     """ method to send email for group access declined """
-    body = helpers.generateStringFromTemplate(
+    body = helpers.generate_string_from_template(
         "groupAccessDeclined.html",
         request_id=request_id,
         requester=requester,
@@ -257,7 +257,7 @@ def send_group_access_declined(
 def send_accept_group_access_failed(destination, request_id, error):
     """ method to send email for accept group access failed """
     try:
-        body = helpers.generateStringFromTemplate(
+        body = helpers.generate_string_from_template(
             "acceptGroupAccessFailed.html", request_id=request_id, error=error
         )
 
@@ -271,7 +271,7 @@ def send_accept_group_access_failed(destination, request_id, error):
 def send_decline_group_access_failed(destination, request_id, error):
     """ method to send decline group access failed """
     try:
-        body = helpers.generateStringFromTemplate(
+        body = helpers.generate_string_from_template(
             "declineGroupAccessFailed.html", request_id=request_id, error=error
         )
 
@@ -286,7 +286,7 @@ def send_mail_for_request_resolve(auth_user, access_type, request_id):
     """ method to send mail for request resolve """
     destination = [auth_user.email]
     subject = USER_REQUEST_RESOLVE_SUBJECT.format(request_id)
-    body = helpers.generateStringFromTemplate(
+    body = helpers.generate_string_from_template(
         filename="requestResolvedEmail.html",
         user=auth_user.email,
         request_id=request_id,

Diff for: Access/tests/test_access_helpers.py

@@ -3,7 +3,7 @@
 from Access.helpers import (
     get_available_access_modules,
     _get_modules_on_disk,
-    getPossibleApproverPermissions,
+    get_possible_approver_permissions,
 )
 from Access.tests.helper_mocks import MockAccessModule
 
@@ -31,7 +31,7 @@ def test_get_available_access_modules(
 ):
     mocker.patch("Access.helpers._get_modules_on_disk", return_value=expectedModuleList)
 
-    helpers.available_accesses = available_accesses
+    helpers.MAP_ACCESSES["AVAILABLE_ACCESSES"] = available_accesses
     modules = list(get_available_access_modules().values())
     assert len(modules) == len(expectedModuleList)
     for i in range(len(modules)):
@@ -53,7 +53,7 @@ def test_get_modules_on_disk(mocker, testName, cached_accesses, expectedModuleLi
         "glob.glob", return_value=["dir1", "dir2"] + ["base_somedir", "__pycache__"]
     )
     mocker.patch("os.path.isfile", return_value=False)
-    helpers.cached_accesses = cached_accesses
+    helpers.MAP_ACCESSES["CACHED_ACCESSES"] = cached_accesses
     modules = _get_modules_on_disk()
     assert len(modules) == len(expectedModuleList)
     for i in range(len(modules)):
@@ -115,4 +115,4 @@ def test_getPossibleApproverPermissions(
     mocker.patch(
         "Access.helpers.get_available_access_modules", return_value=modulesPresent
     )
-    assert getPossibleApproverPermissions().sort() == expectedApprovers.sort()
+    assert get_possible_approver_permissions().sort() == expectedApprovers.sort()

Diff for: Access/tests/test_group_helper.py

@@ -105,7 +105,7 @@ def test_approve_new_group_request(
             return_value=mock_membership_update,
         )
         mocker.patch(
-            "Access.helpers.generateStringFromTemplate", return_value="email body"
+            "Access.helpers.generate_string_from_template", return_value="email body"
         )
         mocker.patch("bootprocess.general.email_via_smtp", return_value=True)
 
@@ -128,7 +128,7 @@ def test_approve_new_group_request(
             return_value=mock_membership_update,
         )
         mocker.patch(
-            "Access.helpers.generateStringFromTemplate", return_value="email body"
+            "Access.helpers.generate_string_from_template", return_value="email body"
         )
         mocker.patch(
             "bootprocess.general.email_via_smtp",
@@ -145,7 +145,7 @@ def test_approve_new_group_request(
     if testname != test_approve_new_group_request_ProcessReq and requestApproved:
         assert general.email_via_smtp.call_count == 1
         assert models.MembershipV2.objects.filter.call_count == 2
-        assert helpers.generateStringFromTemplate.call_count == 2
+        assert helpers.generate_string_from_template.call_count == 2
 
 
 test_get_user_group_group_not_found = "GroupNotFound"

Diff for: Makefile

@@ -72,7 +72,7 @@ test: setup_mounts ensure_web_container_for_test
 lint: export APPUID = $(APP_UID)
 lint: setup_mounts ensure_web_container_for_test
 	@docker exec dev python -m pylama --version
-	@docker exec dev python -m pylama Access/accessrequest_helper.py Access/models.py Access/views.py Access/views_helper.py Access/validators.py Access/notifications.py scripts bootprocess enigma_automation
+	@docker exec dev python -m pylama Access/accessrequest_helper.py Access/models.py Access/views.py Access/views_helper.py Access/validators.py Access/notifications.py Access/helpers.py scripts bootprocess enigma_automation
 	@if [ "$$?" -ne 0 ]; then \
 		echo "Linter checks failed"; \
 		exit 1; \