Version Bump 2.7.2

Improve page load performance by replacing groups context manager

See merge request allianceauth/allianceauth!1219

.gitignore

@@ -75,3 +75,5 @@ celerybeat-schedule
 
 #other
 .flake8
+.pylintrc
+Makefile

.gitlab-ci.yml

@@ -1,8 +1,11 @@
 stages:
-- "test"
+- test
 - deploy
 
 before_script:
+- apt-get update && apt-get install redis-server -y
+- redis-server --daemonize yes
+- redis-cli ping
 - python -V
 - pip install wheel tox
 
@@ -47,5 +50,5 @@ deploy_production:
     - python setup.py sdist
     - twine upload dist/*
 
-  only:
+  rules:
-    - tags
+    - if: $CI_COMMIT_TAG

allianceauth/__init__.py

@@ -1,6 +1,8 @@
 # This will make sure the app is always imported when
 # Django starts so that shared_task will use this app.
 
-__version__ = '2.6.4'
+__version__ = '2.7.2'
-NAME = 'Alliance Auth v%s' % __version__
+__title__ = 'Alliance Auth'
+__url__ = 'https://gitlab.com/allianceauth/allianceauth'
+NAME = '%s v%s' % (__title__, __version__)
 default_app_config = 'allianceauth.apps.AllianceAuthConfig'

allianceauth/authentication/admin.py

@@ -37,8 +37,11 @@ def make_service_hooks_update_groups_action(service):
     :return: fn to update services groups for the selected users
     """
     def update_service_groups(modeladmin, request, queryset):
-        for user in queryset:  # queryset filtering doesn't work here?
+        if hasattr(service, 'update_groups_bulk'):
-            service.update_groups(user)
+            service.update_groups_bulk(queryset)
+        else:
+            for user in queryset:  # queryset filtering doesn't work here?
+                service.update_groups(user)
 
     update_service_groups.__name__ = str('update_{}_groups'.format(slugify(service.name)))
     update_service_groups.short_description = "Sync groups for selected {} accounts".format(service.title)
@@ -52,8 +55,11 @@ def make_service_hooks_sync_nickname_action(service):
     :return: fn to sync nickname for the selected users
     """
     def sync_nickname(modeladmin, request, queryset):
-        for user in queryset:  # queryset filtering doesn't work here?
+        if hasattr(service, 'sync_nicknames_bulk'):
-            service.sync_nickname(user)
+            service.sync_nicknames_bulk(queryset)
+        else:
+            for user in queryset:  # queryset filtering doesn't work here?
+                service.sync_nickname(user)
 
     sync_nickname.__name__ = str('sync_{}_nickname'.format(slugify(service.name)))
     sync_nickname.short_description = "Sync nicknames for selected {} accounts".format(service.title)

allianceauth/authentication/templates/authentication/dashboard.html

@@ -141,19 +141,17 @@
                 </table>
                 <table class="table table-aa visible-xs-block" style="width: 100%">
                     <tbody>
-                        {% for ownership in request.user.character_ownerships.all %}
+                        {% for char in characters %}                            
-                            {% with ownership.character as char %}
+                            <tr>
-                                <tr>
+                                <td class="text-center" style="vertical-align: middle">
-                                    <td class="text-center" style="vertical-align: middle">
+                                    <img class="ra-avatar img-circle" src="{{ char.portrait_url_32 }}">
-                                        <img class="ra-avatar img-circle" src="{{ char.portrait_url_32 }}">
+                                </td>
-                                    </td>
+                                <td class="text-center" style="vertical-align: middle; width: 100%">
-                                    <td class="text-center" style="vertical-align: middle; width: 100%">
+                                    <strong>{{ char.character_name }}</strong><br>
-                                        <strong>{{ char.character_name }}</strong><br>
+                                    {{ char.corporation_name }}<br>
-                                        {{ char.corporation_name }}<br>
+                                    {{ char.alliance_name|default:"" }}
-                                        {{ char.alliance_name|default:"" }}
+                                </td> 
-                                    </td> 
+                            </tr>
-                                </tr>
-                            {% endwith %}
                         {% endfor %}
                     </tbody>
                 </table>

allianceauth/authentication/templates/public/base.html

@@ -6,6 +6,10 @@
         <meta name="viewport" content="width=device-width, initial-scale=1">
         <meta name="description" content="">
         <meta name="author" content="">
+        <meta property="og:title" content="{{ SITE_NAME }}">
+        <meta property="og:image" content="{{ request.scheme }}://{{ request.get_host }}{% static 'icons/apple-touch-icon.png' %}">
+        <meta property="og:description" content="Alliance Auth - An auth system for EVE Online to help in-game organizations manage online service access.">
+
         {% include 'allianceauth/icons.html' %}
 
         <title>{% block title %}{{ SITE_NAME }}{% endblock %}</title>

allianceauth/authentication/tests/test_admin.py

@@ -1,5 +1,5 @@
 from urllib.parse import quote
-from unittest.mock import patch
+from unittest.mock import patch, MagicMock
 
 from django.conf import settings
 from django.contrib import admin
@@ -13,6 +13,7 @@ from allianceauth.authentication.models import (
 from allianceauth.eveonline.models import (
     EveCharacter, EveCorporationInfo, EveAllianceInfo
 )
+from allianceauth.services.hooks import ServicesHook
 from allianceauth.tests.auth_utils import AuthUtils
 
 from ..admin import (
@@ -28,7 +29,9 @@ from ..admin import (
     user_main_organization,
     user_profile_pic, 
     user_username,
-    update_main_character_model
+    update_main_character_model,
+    make_service_hooks_update_groups_action,
+    make_service_hooks_sync_nickname_action
 )
 from . import get_admin_change_view_url, get_admin_search_url
 
@@ -45,136 +48,144 @@ class MockRequest(object):
     def __init__(self, user=None):
         self.user = user
 
+class TestCaseWithTestData(TestCase):
 
-def create_test_data():        
+    @classmethod
-    # groups
+    def setUpClass(cls):
-    group_1 = Group.objects.create(
+        super().setUpClass()
-        name='Group 1'
-    )
-    group_2 = Group.objects.create(
-        name='Group 2'
-    )
 
-    # user 1 - corp and alliance, normal user
+        for MyModel in [
-    character_1 = EveCharacter.objects.create(
+            EveAllianceInfo, EveCorporationInfo, EveCharacter, Group, User
-        character_id='1001',
+        ]:
-        character_name='Bruce Wayne',
+            MyModel.objects.all().delete()
-        corporation_id='2001',
-        corporation_name='Wayne Technologies',
-        corporation_ticker='WT',
-        alliance_id='3001',
-        alliance_name='Wayne Enterprises',
-        alliance_ticker='WE',
-    )
-    character_1a = EveCharacter.objects.create(
-        character_id='1002',
-        character_name='Batman',
-        corporation_id='2001',
-        corporation_name='Wayne Technologies',
-        corporation_ticker='WT',
-        alliance_id='3001',
-        alliance_name='Wayne Enterprises',
-        alliance_ticker='WE',
-    )
-    alliance = EveAllianceInfo.objects.create(
-        alliance_id='3001',
-        alliance_name='Wayne Enterprises',
-        alliance_ticker='WE',            
-        executor_corp_id='2001'
-    )
-    EveCorporationInfo.objects.create(
-        corporation_id='2001',
-        corporation_name='Wayne Technologies',
-        corporation_ticker='WT',            
-        member_count=42,
-        alliance=alliance
-    )        
-    user_1 = User.objects.create_user(
-        character_1.character_name.replace(' ', '_'),
-        'abc@example.com',
-        'password'
-    )
-    CharacterOwnership.objects.create(
-        character=character_1,
-        owner_hash='x1' + character_1.character_name,
-        user=user_1
-    )
-    CharacterOwnership.objects.create(
-        character=character_1a,
-        owner_hash='x1' + character_1a.character_name,
-        user=user_1
-    )
-    user_1.profile.main_character = character_1
-    user_1.profile.save()
-    user_1.groups.add(group_1)        
         
-    # user 2 - corp only, staff
+        # groups
-    character_2 = EveCharacter.objects.create(
+        cls.group_1 = Group.objects.create(
-        character_id=1003,
+            name='Group 1'
-        character_name='Clark Kent',
+        )
-        corporation_id=2002,
+        cls.group_2 = Group.objects.create(
-        corporation_name='Daily Planet',
+            name='Group 2'
-        corporation_ticker='DP',
+        )
-        alliance_id=None
-    )
-    EveCorporationInfo.objects.create(
-        corporation_id=2002,
-        corporation_name='Daily Plane',
-        corporation_ticker='DP',            
-        member_count=99,
-        alliance=None
-    )
-    user_2 = User.objects.create_user(
-        character_2.character_name.replace(' ', '_'),
-        'abc@example.com',
-        'password'
-    )
-    CharacterOwnership.objects.create(
-        character=character_2,
-        owner_hash='x1' + character_2.character_name,
-        user=user_2
-    )
-    user_2.profile.main_character = character_2
-    user_2.profile.save()
-    user_2.groups.add(group_2)
-    user_2.is_staff = True
-    user_2.save()
 
-    # user 3 - no main, no group, superuser
+        # user 1 - corp and alliance, normal user
-    character_3 = EveCharacter.objects.create(
+        character_1 = EveCharacter.objects.create(
-        character_id=1101,
+            character_id=1001,
-        character_name='Lex Luthor',
+            character_name='Bruce Wayne',
-        corporation_id=2101,
+            corporation_id=2001,
-        corporation_name='Lex Corp',
+            corporation_name='Wayne Technologies',
-        corporation_ticker='LC',
+            corporation_ticker='WT',
-        alliance_id=None
+            alliance_id=3001,
-    )
+            alliance_name='Wayne Enterprises',
-    EveCorporationInfo.objects.create(
+            alliance_ticker='WE',
-        corporation_id=2101,
+        )
-        corporation_name='Lex Corp',
+        character_1a = EveCharacter.objects.create(
-        corporation_ticker='LC',            
+            character_id=1002,
-        member_count=666,
+            character_name='Batman',
-        alliance=None
+            corporation_id=2001,
-    )
+            corporation_name='Wayne Technologies',
-    EveAllianceInfo.objects.create(
+            corporation_ticker='WT',
-        alliance_id='3101',
+            alliance_id=3001,
-        alliance_name='Lex World Domination',
+            alliance_name='Wayne Enterprises',
-        alliance_ticker='LWD',
+            alliance_ticker='WE',
-        executor_corp_id=''
+        )
-    )
+        alliance = EveAllianceInfo.objects.create(
-    user_3 = User.objects.create_user(
+            alliance_id=3001,
-        character_3.character_name.replace(' ', '_'),
+            alliance_name='Wayne Enterprises',
-        'abc@example.com',
+            alliance_ticker='WE',            
-        'password'
+            executor_corp_id=2001
-    )
+        )
-    CharacterOwnership.objects.create(
+        EveCorporationInfo.objects.create(
-        character=character_3,
+            corporation_id=2001,
-        owner_hash='x1' + character_3.character_name,
+            corporation_name='Wayne Technologies',
-        user=user_3
+            corporation_ticker='WT',            
-    )
+            member_count=42,
-    user_3.is_superuser = True
+            alliance=alliance
-    user_3.save()
+        )        
-    return user_1, user_2, user_3, group_1, group_2
+        cls.user_1 = User.objects.create_user(
+            character_1.character_name.replace(' ', '_'),
+            'abc@example.com',
+            'password'
+        )
+        CharacterOwnership.objects.create(
+            character=character_1,
+            owner_hash='x1' + character_1.character_name,
+            user=cls.user_1
+        )
+        CharacterOwnership.objects.create(
+            character=character_1a,
+            owner_hash='x1' + character_1a.character_name,
+            user=cls.user_1
+        )
+        cls.user_1.profile.main_character = character_1
+        cls.user_1.profile.save()
+        cls.user_1.groups.add(cls.group_1)        
+
+        # user 2 - corp only, staff
+        character_2 = EveCharacter.objects.create(
+            character_id=1003,
+            character_name='Clark Kent',
+            corporation_id=2002,
+            corporation_name='Daily Planet',
+            corporation_ticker='DP',
+            alliance_id=None
+        )
+        EveCorporationInfo.objects.create(
+            corporation_id=2002,
+            corporation_name='Daily Plane',
+            corporation_ticker='DP',            
+            member_count=99,
+            alliance=None
+        )
+        cls.user_2 = User.objects.create_user(
+            character_2.character_name.replace(' ', '_'),
+            'abc@example.com',
+            'password'
+        )
+        CharacterOwnership.objects.create(
+            character=character_2,
+            owner_hash='x1' + character_2.character_name,
+            user=cls.user_2
+        )
+        cls.user_2.profile.main_character = character_2
+        cls.user_2.profile.save()
+        cls.user_2.groups.add(cls.group_2)
+        cls.user_2.is_staff = True
+        cls.user_2.save()
+        
+        # user 3 - no main, no group, superuser
+        character_3 = EveCharacter.objects.create(
+            character_id=1101,
+            character_name='Lex Luthor',
+            corporation_id=2101,
+            corporation_name='Lex Corp',
+            corporation_ticker='LC',
+            alliance_id=None
+        )
+        EveCorporationInfo.objects.create(
+            corporation_id=2101,
+            corporation_name='Lex Corp',
+            corporation_ticker='LC',            
+            member_count=666,
+            alliance=None
+        )
+        EveAllianceInfo.objects.create(
+            alliance_id=3101,
+            alliance_name='Lex World Domination',
+            alliance_ticker='LWD',
+            executor_corp_id=2101
+        )
+        cls.user_3 = User.objects.create_user(
+            character_3.character_name.replace(' ', '_'),
+            'abc@example.com',
+            'password'
+        )
+        CharacterOwnership.objects.create(
+            character=character_3,
+            owner_hash='x1' + character_3.character_name,
+            user=cls.user_3
+        )
+        cls.user_3.is_superuser = True
+        cls.user_3.save()
 
 
 def make_generic_search_request(ModelClass: type, search_term: str):
@@ -188,12 +199,7 @@ def make_generic_search_request(ModelClass: type, search_term: str):
     )    
 
 
-class TestCharacterOwnershipAdmin(TestCase):
+class TestCharacterOwnershipAdmin(TestCaseWithTestData):
-    
-    @classmethod
-    def setUpClass(cls):
-        super().setUpClass()        
-        cls.user_1, _, _, _, _ = create_test_data()
     
     def setUp(self):
         self.modeladmin = CharacterOwnershipAdmin(
@@ -219,12 +225,7 @@ class TestCharacterOwnershipAdmin(TestCase):
         self.assertEqual(response.status_code, expected)
 
 
-class TestOwnershipRecordAdmin(TestCase):
+class TestOwnershipRecordAdmin(TestCaseWithTestData):
-    
-    @classmethod
-    def setUpClass(cls):
-        super().setUpClass()        
-        cls.user_1, _, _, _, _ = create_test_data()
     
     def setUp(self):
         self.modeladmin = OwnershipRecordAdmin(
@@ -250,12 +251,7 @@ class TestOwnershipRecordAdmin(TestCase):
         self.assertEqual(response.status_code, expected)
 
 
-class TestStateAdmin(TestCase):
+class TestStateAdmin(TestCaseWithTestData):
-    
-    @classmethod
-    def setUpClass(cls):
-        super().setUpClass()        
-        create_test_data()
         
     def setUp(self):
         self.modeladmin = StateAdmin(
@@ -283,13 +279,7 @@ class TestStateAdmin(TestCase):
         expected = 200
         self.assertEqual(response.status_code, expected)
 
-class TestUserAdmin(TestCase):
+class TestUserAdmin(TestCaseWithTestData):
-
-    @classmethod
-    def setUpClass(cls):
-        super().setUpClass()        
-        cls.user_1, cls.user_2, cls.user_3, cls.group_1, cls.group_2  = \
-            create_test_data()
 
     def setUp(self):
         self.factory = RequestFactory()
@@ -520,8 +510,8 @@ class TestUserAdmin(TestCase):
         filters = changelist.get_filters(request)
         filterspec = filters[0][0]
         expected = [            
-            ('2002', 'Daily Planet'),
+            (2002, 'Daily Planet'),
-            ('2001', 'Wayne Technologies'),
+            (2001, 'Wayne Technologies'),
         ]
         self.assertEqual(filterspec.lookup_choices, expected)
 
@@ -550,7 +540,7 @@ class TestUserAdmin(TestCase):
         filters = changelist.get_filters(request)
         filterspec = filters[0][0]
         expected = [            
-            ('3001', 'Wayne Enterprises'),            
+            (3001, 'Wayne Enterprises'),            
         ]
         self.assertEqual(filterspec.lookup_choices, expected)
 
@@ -579,3 +569,67 @@ class TestUserAdmin(TestCase):
         response = make_generic_search_request(type(obj), obj.username)
         expected = 200
         self.assertEqual(response.status_code, expected)
+
+
+class TestMakeServicesHooksActions(TestCaseWithTestData):
+
+    class MyServicesHookTypeA(ServicesHook):
+
+        def __init__(self):
+            super().__init__()
+            self.name = 'My Service A'            
+        
+        def update_groups(self, user):
+            pass
+
+        def sync_nicknames(self, user):
+            pass
+
+    class MyServicesHookTypeB(ServicesHook):
+
+        def __init__(self):
+            super().__init__()
+            self.name = 'My Service B'
+        
+        def update_groups(self, user):
+            pass
+
+        def update_groups_bulk(self, user):
+            pass
+
+        def sync_nicknames(self, user):
+            pass
+
+        def sync_nicknames_bulk(self, user):
+            pass
+         
+
+    def test_service_has_update_groups_only(self):        
+        service = self.MyServicesHookTypeA()
+        mock_service = MagicMock(spec=service)      
+        action = make_service_hooks_update_groups_action(mock_service)
+        action(MagicMock(), MagicMock(), [self.user_1])
+        self.assertTrue(mock_service.update_groups.called)
+
+    def test_service_has_update_groups_bulk(self):        
+        service = self.MyServicesHookTypeB()
+        mock_service = MagicMock(spec=service)      
+        action = make_service_hooks_update_groups_action(mock_service)
+        action(MagicMock(), MagicMock(), [self.user_1])
+        self.assertFalse(mock_service.update_groups.called)
+        self.assertTrue(mock_service.update_groups_bulk.called)
+
+    def test_service_has_sync_nickname_only(self):        
+        service = self.MyServicesHookTypeA()
+        mock_service = MagicMock(spec=service)      
+        action = make_service_hooks_sync_nickname_action(mock_service)
+        action(MagicMock(), MagicMock(), [self.user_1])
+        self.assertTrue(mock_service.sync_nickname.called)
+
+    def test_service_has_sync_nicknames_bulk(self):        
+        service = self.MyServicesHookTypeB()
+        mock_service = MagicMock(spec=service)      
+        action = make_service_hooks_sync_nickname_action(mock_service)
+        action(MagicMock(), MagicMock(), [self.user_1])
+        self.assertFalse(mock_service.sync_nickname.called)
+        self.assertTrue(mock_service.sync_nicknames_bulk.called)

allianceauth/authentication/tests/test_all.py

@@ -343,10 +343,10 @@ class CharacterOwnershipCheckTestCase(TestCase):
         cls.user = AuthUtils.create_user('test_user', disconnect_signals=True)
         AuthUtils.add_main_character(cls.user, 'Test Character', '1', corp_id='1', alliance_id='1',
                                      corp_name='Test Corp', alliance_name='Test Alliance')
-        cls.character = EveCharacter.objects.get(character_id='1')
+        cls.character = EveCharacter.objects.get(character_id=1)
         cls.token = Token.objects.create(
             user=cls.user,
-            character_id='1',
+            character_id=1,
             character_name='Test',
             character_owner_hash='1',
         )

allianceauth/authentication/tests/test_templatetags.py

@@ -0,0 +1,275 @@
+from math import ceil
+from unittest.mock import patch
+
+from requests import RequestException
+import requests_mock
+from packaging.version import Version as Pep440Version
+
+from django.test import TestCase
+
+from allianceauth.templatetags.admin_status import (
+    status_overview,
+    _fetch_list_from_gitlab,
+    _current_notifications, 
+    _current_version_summary, 
+    _fetch_notification_issues_from_gitlab,
+    _fetch_tags_from_gitlab,
+    _latests_versions
+)
+
+MODULE_PATH = 'allianceauth.templatetags'
+
+
+def create_tags_list(tag_names: list):
+    return [{'name': str(tag_name)} for tag_name in tag_names]
+
+
+GITHUB_TAGS = create_tags_list(['v2.4.6a1', 'v2.4.5', 'v2.4.0', 'v2.0.0', 'v1.1.1'])
+GITHUB_NOTIFICATION_ISSUES = [
+    {
+        'id': 1,
+        'title': 'first issue'
+    },
+    {
+        'id': 2,
+        'title': 'second issue'
+    },
+    {
+        'id': 3,
+        'title': 'third issue'
+    },
+    {
+        'id': 4,
+        'title': 'forth issue'
+    },
+    {
+        'id': 5,
+        'title': 'fifth issue'
+    },
+    {
+        'id': 6,
+        'title': 'sixth issue'
+    },
+]
+TEST_VERSION = '2.6.5'
+
+
+class TestStatusOverviewTag(TestCase):
+
+    @patch(MODULE_PATH + '.admin_status.__version__', TEST_VERSION)
+    @patch(MODULE_PATH + '.admin_status._fetch_celery_queue_length')
+    @patch(MODULE_PATH + '.admin_status._current_version_summary')
+    @patch(MODULE_PATH + '.admin_status._current_notifications')    
+    def test_status_overview(
+        self, 
+        mock_current_notifications, 
+        mock_current_version_info,
+        mock_fetch_celery_queue_length
+    ):
+        notifications = {
+            'notifications': GITHUB_NOTIFICATION_ISSUES[:5]
+        }
+        mock_current_notifications.return_value = notifications
+        version_info = {
+            'latest_major': True,
+            'latest_minor': True,
+            'latest_patch': True,
+            'latest_beta': False,
+            'current_version': TEST_VERSION,
+            'latest_major_version': '2.4.5',
+            'latest_minor_version': '2.4.0',
+            'latest_patch_version': '2.4.5',
+            'latest_beta_version': '2.4.4a1',
+        }
+        mock_current_version_info.return_value = version_info
+        mock_fetch_celery_queue_length.return_value = 3
+        
+        context = {}
+        result = status_overview(context)
+        expected = {
+            'notifications': GITHUB_NOTIFICATION_ISSUES[:5],
+            'latest_major': True,
+            'latest_minor': True,
+            'latest_patch': True,
+            'latest_beta': False,
+            'current_version': TEST_VERSION,
+            'latest_major_version': '2.4.5',
+            'latest_minor_version': '2.4.0',
+            'latest_patch_version': '2.4.5',
+            'latest_beta_version': '2.4.4a1',
+            'task_queue_length': 3,
+        }
+        self.assertEqual(result, expected)
+
+
+class TestNotifications(TestCase):
+
+    @requests_mock.mock()
+    def test_fetch_notification_issues_from_gitlab(self, requests_mocker):
+        url = (
+            'https://gitlab.com/api/v4/projects/allianceauth%2Fallianceauth/issues'
+            '?labels=announcement'
+        )        
+        requests_mocker.get(url, json=GITHUB_NOTIFICATION_ISSUES)
+        result = _fetch_notification_issues_from_gitlab()
+        self.assertEqual(result, GITHUB_NOTIFICATION_ISSUES)
+
+    @patch(MODULE_PATH + '.admin_status.cache')
+    def test_current_notifications_normal(self, mock_cache):
+        mock_cache.get_or_set.return_value = GITHUB_NOTIFICATION_ISSUES
+
+        result = _current_notifications()
+        self.assertEqual(result['notifications'], GITHUB_NOTIFICATION_ISSUES[:5])
+
+    @patch(MODULE_PATH + '.admin_status.cache')
+    def test_current_notifications_failed(self, mock_cache):
+        mock_cache.get_or_set.side_effect = RequestException
+
+        result = _current_notifications()
+        self.assertEqual(result['notifications'], list())
+
+
+class TestCeleryQueueLength(TestCase):
+
+    def test_get_celery_queue_length(self):
+        pass
+
+
+class TestVersionTags(TestCase):
+
+    @patch(MODULE_PATH + '.admin_status.__version__', TEST_VERSION)
+    @patch(MODULE_PATH + '.admin_status.cache')
+    def test_current_version_info_normal(self, mock_cache):
+        mock_cache.get_or_set.return_value = GITHUB_TAGS
+
+        result = _current_version_summary()
+        self.assertTrue(result['latest_major'])
+        self.assertTrue(result['latest_minor'])
+        self.assertTrue(result['latest_patch'])
+        self.assertEqual(result['latest_major_version'], '2.0.0')
+        self.assertEqual(result['latest_minor_version'], '2.4.0')
+        self.assertEqual(result['latest_patch_version'], '2.4.5')
+        self.assertEqual(result['latest_beta_version'], '2.4.6a1')
+
+    @patch(MODULE_PATH + '.admin_status.__version__', TEST_VERSION)
+    @patch(MODULE_PATH + '.admin_status.cache')
+    def test_current_version_info_failed(self, mock_cache):
+        mock_cache.get_or_set.side_effect = RequestException
+        
+        expected = {}
+        result = _current_version_summary()
+        self.assertEqual(result, expected)
+
+    @requests_mock.mock()
+    def test_fetch_tags_from_gitlab(self, requests_mocker):
+        url = (
+            'https://gitlab.com/api/v4/projects/allianceauth%2Fallianceauth'
+            '/repository/tags'
+        )        
+        requests_mocker.get(url, json=GITHUB_TAGS)
+        result = _fetch_tags_from_gitlab()
+        self.assertEqual(result, GITHUB_TAGS)
+
+
+class TestLatestsVersion(TestCase):
+
+    def test_all_version_types_defined(self):
+        
+        tags = create_tags_list(
+            ['2.1.1', '2.1.0', '2.0.0', '2.1.1a1', '1.1.1', '1.1.0', '1.0.0']
+        )
+        major, minor, patch, beta = _latests_versions(tags)
+        self.assertEqual(major, Pep440Version('2.0.0'))
+        self.assertEqual(minor, Pep440Version('2.1.0'))
+        self.assertEqual(patch, Pep440Version('2.1.1'))
+        self.assertEqual(beta, Pep440Version('2.1.1a1'))
+
+    def test_major_and_minor_not_defined_with_zero(self):
+        
+        tags = create_tags_list(
+            ['2.1.2', '2.1.1', '2.0.1', '2.1.1a1', '1.1.1', '1.1.0', '1.0.0']
+        )
+        major, minor, patch, beta = _latests_versions(tags)
+        self.assertEqual(major, Pep440Version('2.0.1'))
+        self.assertEqual(minor, Pep440Version('2.1.1'))
+        self.assertEqual(patch, Pep440Version('2.1.2'))
+        self.assertEqual(beta, Pep440Version('2.1.1a1'))
+        
+    def test_can_ignore_invalid_versions(self):
+        
+        tags = create_tags_list(
+            ['2.1.1', '2.1.0', '2.0.0', '2.1.1a1', 'invalid']
+        )
+        major, minor, patch, beta = _latests_versions(tags)
+        self.assertEqual(major, Pep440Version('2.0.0'))
+        self.assertEqual(minor, Pep440Version('2.1.0'))
+        self.assertEqual(patch, Pep440Version('2.1.1'))
+        self.assertEqual(beta, Pep440Version('2.1.1a1'))
+
+
+class TestFetchListFromGitlab(TestCase):
+   
+    page_size = 2
+    
+    def setUp(self):
+        self.url = (
+            'https://gitlab.com/api/v4/projects/allianceauth%2Fallianceauth'
+            '/repository/tags'
+        )
+
+    @classmethod
+    def my_callback(cls, request, context):
+        page = int(request.qs['page'][0])
+        start = (page - 1) * cls.page_size
+        end = start + cls.page_size
+        return GITHUB_TAGS[start:end]        
+    
+    @requests_mock.mock()
+    def test_can_fetch_one_page_with_header(self, requests_mocker):
+        headers = {
+            'x-total-pages': '1'
+        }
+        requests_mocker.get(self.url, json=GITHUB_TAGS, headers=headers)
+        result = _fetch_list_from_gitlab(self.url)
+        self.assertEqual(result, GITHUB_TAGS)
+        self.assertEqual(requests_mocker.call_count, 1)
+
+    @requests_mock.mock()
+    def test_can_fetch_one_page_wo_header(self, requests_mocker):        
+        requests_mocker.get(self.url, json=GITHUB_TAGS)
+        result = _fetch_list_from_gitlab(self.url)
+        self.assertEqual(result, GITHUB_TAGS)
+        self.assertEqual(requests_mocker.call_count, 1)
+
+    @requests_mock.mock()
+    def test_can_fetch_one_page_and_ignore_invalid_header(self, requests_mocker):
+        headers = {
+            'x-total-pages': 'invalid'
+        }
+        requests_mocker.get(self.url, json=GITHUB_TAGS, headers=headers)
+        result = _fetch_list_from_gitlab(self.url)
+        self.assertEqual(result, GITHUB_TAGS)
+        self.assertEqual(requests_mocker.call_count, 1)
+
+    @requests_mock.mock()
+    def test_can_fetch_multiple_pages(self, requests_mocker):     
+        total_pages = ceil(len(GITHUB_TAGS) / self.page_size)
+        headers = {
+            'x-total-pages': str(total_pages)
+        }
+        requests_mocker.get(self.url, json=self.my_callback, headers=headers)
+        result = _fetch_list_from_gitlab(self.url)
+        self.assertEqual(result, GITHUB_TAGS)
+        self.assertEqual(requests_mocker.call_count, total_pages)
+
+    @requests_mock.mock()
+    def test_can_fetch_given_number_of_pages_only(self, requests_mocker):     
+        total_pages = ceil(len(GITHUB_TAGS) / self.page_size)
+        headers = {
+            'x-total-pages': str(total_pages)
+        }
+        requests_mocker.get(self.url, json=self.my_callback, headers=headers)
+        max_pages = 2
+        result = _fetch_list_from_gitlab(self.url, max_pages=max_pages)
+        self.assertEqual(result, GITHUB_TAGS[:4])
+        self.assertEqual(requests_mocker.call_count, max_pages)

allianceauth/corputils/auth_hooks.py

@@ -8,7 +8,7 @@ class CorpStats(MenuItemHook):
     def __init__(self):
         MenuItemHook.__init__(self,
                               _('Corporation Stats'),
-                              'fa fa-share-alt fa-fw',
+                              'fas fa-share-alt fa-fw',
                               'corputils:view',
                               navactive=['corputils:'])
 

allianceauth/corputils/tests.py

@@ -17,9 +17,9 @@ class CorpStatsManagerTestCase(TestCase):
         cls.user = AuthUtils.create_user('test')
         AuthUtils.add_main_character(cls.user, 'test character', '1', corp_id='2', corp_name='test_corp', corp_ticker='TEST', alliance_id='3', alliance_name='TEST')
         cls.user.profile.refresh_from_db()
-        cls.alliance = EveAllianceInfo.objects.create(alliance_id='3', alliance_name='test alliance', alliance_ticker='TEST', executor_corp_id='2')
+        cls.alliance = EveAllianceInfo.objects.create(alliance_id=3, alliance_name='test alliance', alliance_ticker='TEST', executor_corp_id=2)
-        cls.corp = EveCorporationInfo.objects.create(corporation_id='2', corporation_name='test corp', corporation_ticker='TEST', alliance=cls.alliance, member_count=1)
+        cls.corp = EveCorporationInfo.objects.create(corporation_id=2, corporation_name='test corp', corporation_ticker='TEST', alliance=cls.alliance, member_count=1)
-        cls.token = Token.objects.create(user=cls.user, access_token='a', character_id='1', character_name='test character', character_owner_hash='z')
+        cls.token = Token.objects.create(user=cls.user, access_token='a', character_id=1, character_name='test character', character_owner_hash='z')
         cls.corpstats = CorpStats.objects.create(corp=cls.corp, token=cls.token)
         cls.view_corp_permission = Permission.objects.get_by_natural_key('view_corp_corpstats', 'corputils', 'corpstats')
         cls.view_alliance_permission = Permission.objects.get_by_natural_key('view_alliance_corpstats', 'corputils', 'corpstats')
@@ -66,9 +66,9 @@ class CorpStatsUpdateTestCase(TestCase):
     @classmethod
     def setUpTestData(cls):
         cls.user = AuthUtils.create_user('test')
-        AuthUtils.add_main_character(cls.user, 'test character', '1', corp_id='2', corp_name='test_corp', corp_ticker='TEST', alliance_id='3', alliance_name='TEST')
+        AuthUtils.add_main_character(cls.user, 'test character', '1', corp_id=2, corp_name='test_corp', corp_ticker='TEST', alliance_id=3, alliance_name='TEST')
-        cls.token = Token.objects.create(user=cls.user, access_token='a', character_id='1', character_name='test character', character_owner_hash='z')
+        cls.token = Token.objects.create(user=cls.user, access_token='a', character_id=1, character_name='test character', character_owner_hash='z')
-        cls.corp = EveCorporationInfo.objects.create(corporation_id='2', corporation_name='test corp', corporation_ticker='TEST', member_count=1)
+        cls.corp = EveCorporationInfo.objects.create(corporation_id=2, corporation_name='test corp', corporation_ticker='TEST', member_count=1)
 
     def setUp(self):
         self.corpstats = CorpStats.objects.get_or_create(token=self.token, corp=self.corp)[0]
@@ -88,11 +88,11 @@ class CorpStatsUpdateTestCase(TestCase):
         SwaggerClient.from_spec.return_value.Corporation.get_corporations_corporation_id_members.return_value.result.return_value = [1]
         SwaggerClient.from_spec.return_value.Universe.post_universe_names.return_value.result.return_value = [{'id': 1, 'name': 'test character'}]
         self.corpstats.update()
-        self.assertTrue(CorpMember.objects.filter(character_id='1', character_name='test character', corpstats=self.corpstats).exists())
+        self.assertTrue(CorpMember.objects.filter(character_id=1, character_name='test character', corpstats=self.corpstats).exists())
 
     @mock.patch('esi.clients.SwaggerClient')
     def test_update_remove_member(self, SwaggerClient):
-        CorpMember.objects.create(character_id='2', character_name='old test character', corpstats=self.corpstats)
+        CorpMember.objects.create(character_id=2, character_name='old test character', corpstats=self.corpstats)
         SwaggerClient.from_spec.return_value.Character.get_characters_character_id.return_value.result.return_value = {'corporation_id': 2}
         SwaggerClient.from_spec.return_value.Corporation.get_corporations_corporation_id_members.return_value.result.return_value = [1]
         SwaggerClient.from_spec.return_value.Universe.post_universe_names.return_value.result.return_value = [{'id': 1, 'name': 'test character'}]
@@ -130,15 +130,15 @@ class CorpStatsPropertiesTestCase(TestCase):
     @classmethod
     def setUpTestData(cls):
         cls.user = AuthUtils.create_user('test')
-        AuthUtils.add_main_character(cls.user, 'test character', '1', corp_id='2', corp_name='test_corp', corp_ticker='TEST', alliance_id='3', alliance_name='TEST')
+        AuthUtils.add_main_character(cls.user, 'test character', '1', corp_id=2, corp_name='test_corp', corp_ticker='TEST', alliance_id=3, alliance_name='TEST')
         cls.user.profile.refresh_from_db()
-        cls.token = Token.objects.create(user=cls.user, access_token='a', character_id='1', character_name='test character', character_owner_hash='z')
+        cls.token = Token.objects.create(user=cls.user, access_token='a', character_id=1, character_name='test character', character_owner_hash='z')
-        cls.corp = EveCorporationInfo.objects.create(corporation_id='2', corporation_name='test corp', corporation_ticker='TEST', member_count=1)
+        cls.corp = EveCorporationInfo.objects.create(corporation_id=2, corporation_name='test corp', corporation_ticker='TEST', member_count=1)
         cls.corpstats = CorpStats.objects.create(token=cls.token, corp=cls.corp)
-        cls.character = EveCharacter.objects.create(character_name='another test character', character_id='4', corporation_id='2', corporation_name='test corp', corporation_ticker='TEST')
+        cls.character = EveCharacter.objects.create(character_name='another test character', character_id=4, corporation_id=2, corporation_name='test corp', corporation_ticker='TEST')
 
     def test_member_count(self):
-        member = CorpMember.objects.create(corpstats=self.corpstats, character_id='1', character_name='test character')
+        member = CorpMember.objects.create(corpstats=self.corpstats, character_id=2, character_name='test character')
         self.assertEqual(self.corpstats.member_count, 1)
         member.delete()
         self.assertEqual(self.corpstats.member_count, 0)
@@ -147,7 +147,7 @@ class CorpStatsPropertiesTestCase(TestCase):
         AuthUtils.disconnect_signals()
         co = CharacterOwnership.objects.create(character=self.character, user=self.user, owner_hash='a')
         AuthUtils.connect_signals()
-        CorpMember.objects.create(corpstats=self.corpstats, character_id='4', character_name='test character')
+        CorpMember.objects.create(corpstats=self.corpstats, character_id=4, character_name='test character')
         self.assertEqual(self.corpstats.user_count, 1)
         co.delete()
         self.assertEqual(self.corpstats.user_count, 0)
@@ -156,7 +156,8 @@ class CorpStatsPropertiesTestCase(TestCase):
         AuthUtils.disconnect_signals()
         co = CharacterOwnership.objects.create(character=self.character, user=self.user, owner_hash='a')
         AuthUtils.connect_signals()
-        member = CorpMember.objects.create(corpstats=self.corpstats, character_id='4', character_name='test character')
+        member = CorpMember.objects.create(corpstats=self.corpstats, character_id=4, character_name='test character')
+        self.corpstats.refresh_from_db()
         self.assertIn(member, self.corpstats.registered_members)
         self.assertEqual(self.corpstats.registered_member_count, 1)
 
@@ -165,7 +166,7 @@ class CorpStatsPropertiesTestCase(TestCase):
         self.assertEqual(self.corpstats.registered_member_count, 0)
 
     def test_unregistered_members(self):
-        member = CorpMember.objects.create(corpstats=self.corpstats, character_id='4', character_name='test character')
+        member = CorpMember.objects.create(corpstats=self.corpstats, character_id=4, character_name='test character')
         self.corpstats.refresh_from_db()
         self.assertIn(member, self.corpstats.unregistered_members)
         self.assertEqual(self.corpstats.unregistered_member_count, 1)
@@ -178,13 +179,13 @@ class CorpStatsPropertiesTestCase(TestCase):
 
     def test_mains(self):
         # test when is a main
-        member = CorpMember.objects.create(corpstats=self.corpstats, character_id='1', character_name='test character')
+        member = CorpMember.objects.create(corpstats=self.corpstats, character_id=1, character_name='test character')
         self.assertIn(member, self.corpstats.mains)
         self.assertEqual(self.corpstats.main_count, 1)
 
         # test when is an alt
         old_main = self.user.profile.main_character
-        character = EveCharacter.objects.create(character_name='other character', character_id=10, corporation_name='test corp', corporation_id='2', corporation_ticker='TEST')
+        character = EveCharacter.objects.create(character_name='other character', character_id=10, corporation_name='test corp', corporation_id=2, corporation_ticker='TEST')
         AuthUtils.disconnect_signals()
         co = CharacterOwnership.objects.create(character=character, user=self.user, owner_hash='b')
         self.user.profile.main_character = character
@@ -208,7 +209,7 @@ class CorpStatsPropertiesTestCase(TestCase):
         self.assertEqual(self.corpstats.corp_logo(size=128), 'https://images.evetech.net/corporations/2/logo?size=128')
         self.assertEqual(self.corpstats.alliance_logo(size=128), 'https://images.evetech.net/alliances/1/logo?size=128')
 
-        alliance = EveAllianceInfo.objects.create(alliance_name='test alliance', alliance_id='3', alliance_ticker='TEST', executor_corp_id='2')
+        alliance = EveAllianceInfo.objects.create(alliance_name='test alliance', alliance_id=3, alliance_ticker='TEST', executor_corp_id=2)
         self.corp.alliance = alliance
         self.corp.save()
         self.assertEqual(self.corpstats.alliance_logo(size=128), 'https://images.evetech.net/alliances/3/logo?size=128')
@@ -221,14 +222,14 @@ class CorpMemberTestCase(TestCase):
         cls.user = AuthUtils.create_user('test')
         AuthUtils.add_main_character(cls.user, 'test character', '1', corp_id='2', corp_name='test_corp', corp_ticker='TEST', alliance_id='3', alliance_name='TEST')
         cls.user.profile.refresh_from_db()
-        cls.token = Token.objects.create(user=cls.user, access_token='a', character_id='1', character_name='test character', character_owner_hash='a')
+        cls.token = Token.objects.create(user=cls.user, access_token='a', character_id=1, character_name='test character', character_owner_hash='a')
-        cls.corp = EveCorporationInfo.objects.create(corporation_id='2', corporation_name='test corp', corporation_ticker='TEST', member_count=1)
+        cls.corp = EveCorporationInfo.objects.create(corporation_id=2, corporation_name='test corp', corporation_ticker='TEST', member_count=1)
         cls.corpstats = CorpStats.objects.create(token=cls.token, corp=cls.corp)
-        cls.member = CorpMember.objects.create(corpstats=cls.corpstats, character_id='2', character_name='other test character')
+        cls.member = CorpMember.objects.create(corpstats=cls.corpstats, character_id=2, character_name='other test character')
 
     def test_character(self):
         self.assertIsNone(self.member.character)
-        character = EveCharacter.objects.create(character_id='2', character_name='other test character', corporation_id='2', corporation_name='test corp', corporation_ticker='TEST')
+        character = EveCharacter.objects.create(character_id=2, character_name='other test character', corporation_id=2, corporation_name='test corp', corporation_ticker='TEST')
         self.assertEqual(self.member.character, character)
 
     def test_main_character(self):
@@ -238,7 +239,7 @@ class CorpMemberTestCase(TestCase):
         self.assertIsNone(self.member.main_character)
 
         # test when member.character is not None but also not a main
-        character = EveCharacter.objects.create(character_id='2', character_name='other test character', corporation_id='2', corporation_name='test corp', corporation_ticker='TEST')
+        character = EveCharacter.objects.create(character_id=2, character_name='other test character', corporation_id=2, corporation_name='test corp', corporation_ticker='TEST')
         CharacterOwnership.objects.create(character=character, user=self.user, owner_hash='b')
         self.member.refresh_from_db()
         self.assertNotEqual(self.member.main_character, self.member.character)
@@ -260,14 +261,14 @@ class CorpMemberTestCase(TestCase):
     def test_alts(self):
         self.assertListEqual(self.member.alts, [])
 
-        character = EveCharacter.objects.create(character_id='2', character_name='other test character', corporation_id='2', corporation_name='test corp', corporation_ticker='TEST')
+        character = EveCharacter.objects.create(character_id=2, character_name='other test character', corporation_id=2, corporation_name='test corp', corporation_ticker='TEST')
         CharacterOwnership.objects.create(character=character, user=self.user, owner_hash='b')
         self.assertIn(character, self.member.alts)
 
     def test_registered(self):
         self.assertFalse(self.member.registered)
         AuthUtils.disconnect_signals()
-        character = EveCharacter.objects.create(character_id='2', character_name='other test character', corporation_id='2', corporation_name='test corp', corporation_ticker='TEST')
+        character = EveCharacter.objects.create(character_id=2, character_name='other test character', corporation_id=2, corporation_name='test corp', corporation_ticker='TEST')
         CharacterOwnership.objects.create(character=character, user=self.user, owner_hash='b')
         self.assertTrue(self.member.registered)
         AuthUtils.connect_signals()

allianceauth/eveonline/evelinks/__init__.py

@@ -4,14 +4,14 @@
 # It contains of modules for views and templatetags for templates
 
 # list of all eve entity categories as defined in ESI
-ESI_CATEGORY_AGENT = "agent"
+_ESI_CATEGORY_AGENT = "agent"
-ESI_CATEGORY_ALLIANCE = "alliance"
+_ESI_CATEGORY_ALLIANCE = "alliance"
-ESI_CATEGORY_CHARACTER = "character"
+_ESI_CATEGORY_CHARACTER = "character"
-ESI_CATEGORY_CONSTELLATION = "constellation"
+_ESI_CATEGORY_CONSTELLATION = "constellation"
-ESI_CATEGORY_CORPORATION = "corporation"
+_ESI_CATEGORY_CORPORATION = "corporation"
-ESI_CATEGORY_FACTION = "faction"
+_ESI_CATEGORY_FACTION = "faction"
-ESI_CATEGORY_INVENTORYTYPE = "inventory_type"
+_ESI_CATEGORY_INVENTORYTYPE = "inventory_type"
-ESI_CATEGORY_REGION = "region"
+_ESI_CATEGORY_REGION = "region"
-ESI_CATEGORY_SOLARSYSTEM = "solar_system"
+_ESI_CATEGORY_SOLARSYSTEM = "solar_system"
-ESI_CATEGORY_STATION = "station"
+_ESI_CATEGORY_STATION = "station"
-ESI_CATEGORY_WORMHOLE = "wormhole"
+_ESI_CATEGORY_WORMHOLE = "wormhole"

allianceauth/eveonline/evelinks/dotlan.py

@@ -2,24 +2,30 @@
 
 from urllib.parse import urljoin, quote
 
-from . import *
+from . import (
+    _ESI_CATEGORY_ALLIANCE, 
+    _ESI_CATEGORY_CORPORATION, 
+    _ESI_CATEGORY_REGION, 
+    _ESI_CATEGORY_SOLARSYSTEM
+)
 
-BASE_URL = 'http://evemaps.dotlan.net'
+
+_BASE_URL = 'http://evemaps.dotlan.net'
 
 
 def _build_url(category: str, name: str) -> str:
     """return url to profile page for an eve entity"""
     
-    if category == ESI_CATEGORY_ALLIANCE:        
+    if category == _ESI_CATEGORY_ALLIANCE:        
         partial = 'alliance'
 
-    elif category == ESI_CATEGORY_CORPORATION:        
+    elif category == _ESI_CATEGORY_CORPORATION:        
         partial = 'corp'
 
-    elif category == ESI_CATEGORY_REGION:
+    elif category == _ESI_CATEGORY_REGION:
         partial = 'map'
     
-    elif category == ESI_CATEGORY_SOLARSYSTEM:
+    elif category == _ESI_CATEGORY_SOLARSYSTEM:
         partial = 'system'
     
     else:
@@ -28,7 +34,7 @@ def _build_url(category: str, name: str) -> str:
         )
         
     url = urljoin(
-        BASE_URL,
+        _BASE_URL,
         '{}/{}'.format(partial, quote(str(name).replace(" ", "_")))
         
     )
@@ -37,16 +43,19 @@ def _build_url(category: str, name: str) -> str:
 
 def alliance_url(name: str) -> str:
     """url for page about given alliance on dotlan"""
-    return _build_url(ESI_CATEGORY_ALLIANCE, name)
+    return _build_url(_ESI_CATEGORY_ALLIANCE, name)
+
 
 def corporation_url(name: str) -> str:
     """url for page about given corporation on dotlan"""
-    return _build_url(ESI_CATEGORY_CORPORATION, name)
+    return _build_url(_ESI_CATEGORY_CORPORATION, name)
+
 
 def region_url(name: str) -> str:
     """url for page about given region on dotlan"""
-    return _build_url(ESI_CATEGORY_REGION, name)
+    return _build_url(_ESI_CATEGORY_REGION, name)
+
 
 def solar_system_url(name: str) -> str:
     """url for page about given solar system on dotlan"""
-    return _build_url(ESI_CATEGORY_SOLARSYSTEM, name)
+    return _build_url(_ESI_CATEGORY_SOLARSYSTEM, name)

allianceauth/eveonline/evelinks/eveimageserver.py

@@ -0,0 +1,129 @@
+from . import (
+    _ESI_CATEGORY_ALLIANCE, 
+    _ESI_CATEGORY_CHARACTER, 
+    _ESI_CATEGORY_CORPORATION, 
+    _ESI_CATEGORY_INVENTORYTYPE
+)
+
+
+_EVE_IMAGE_SERVER_URL = 'https://images.evetech.net'
+_DEFAULT_IMAGE_SIZE = 32
+
+
+def _eve_entity_image_url(    
+    category: str,
+    entity_id: int,
+    size: int = 32,
+    variant: str = None,
+    tenant: str = None,
+) -> str:
+    """returns image URL for an Eve Online ID.
+    Supported categories: alliance, corporation, character, inventory_type
+    
+    Arguments:
+    - category: category of the ID, see ESI category constants
+    - entity_id: Eve ID of the entity
+    - size: (optional) render size of the image.must be between 32 (default) and 1024
+    - variant: (optional) image variant for category. currently not relevant.
+    - tenant: (optional) Eve Server, either `tranquility`(default) or `singularity`
+
+    Returns:
+    - URL string for the requested image on the Eve image server
+
+    Exceptions:
+    - Throws ValueError on invalid input
+    """
+    
+    # input validations
+    categories = {
+        _ESI_CATEGORY_ALLIANCE: {
+            'endpoint': 'alliances',
+            'variants': ['logo']
+        },
+        _ESI_CATEGORY_CORPORATION: {
+            'endpoint': 'corporations',
+            'variants': ['logo']
+        },
+        _ESI_CATEGORY_CHARACTER: {
+            'endpoint': 'characters',
+            'variants': ['portrait']
+        },
+        _ESI_CATEGORY_INVENTORYTYPE: {
+            'endpoint': 'types',
+            'variants': ['icon', 'render']
+        }
+    }
+    tenants = ['tranquility', 'singularity']
+   
+    if not entity_id:
+        raise ValueError('Invalid entity_id: {}'.format(entity_id))
+    else:
+        entity_id = int(entity_id)
+    
+    if not size or size < 32 or size > 1024 or (size & (size - 1) != 0):
+        raise ValueError('Invalid size: {}'.format(size))
+   
+    if category not in categories:
+        raise ValueError('Invalid category {}'.format(category))
+    else:
+        endpoint = categories[category]['endpoint']
+
+    if variant:
+        if variant not in categories[category]['variants']:
+            raise ValueError('Invalid variant {} for category {}'.format(
+                variant,
+                category
+            ))
+    else:
+        variant = categories[category]['variants'][0]
+
+    if tenant and tenant not in tenants:
+        raise ValueError('Invalid tenant {}'.format(tenant))
+        
+    # compose result URL
+    result = '{}/{}/{}/{}?size={}'.format(
+        _EVE_IMAGE_SERVER_URL,
+        endpoint,
+        entity_id,
+        variant,
+        size
+    )
+    if tenant:
+        result += '&tenant={}'.format(tenant)
+    
+    return result
+
+
+def alliance_logo_url(alliance_id: int, size: int = _DEFAULT_IMAGE_SIZE) -> str:
+    """image URL for the given alliance ID"""
+    return _eve_entity_image_url(_ESI_CATEGORY_ALLIANCE, alliance_id, size)
+
+
+def corporation_logo_url(
+    corporation_id: int, size: int = _DEFAULT_IMAGE_SIZE
+) -> str:
+    """image URL for the given corporation ID"""
+    return _eve_entity_image_url(
+        _ESI_CATEGORY_CORPORATION, corporation_id, size
+    )
+
+
+def character_portrait_url(
+    character_id: int, size: int = _DEFAULT_IMAGE_SIZE
+) -> str:
+    """image URL for the given character ID"""
+    return _eve_entity_image_url(_ESI_CATEGORY_CHARACTER, character_id, size)
+
+
+def type_icon_url(type_id: int, size: int = _DEFAULT_IMAGE_SIZE) -> str:
+    """icon image URL for the given type ID"""
+    return _eve_entity_image_url(
+        _ESI_CATEGORY_INVENTORYTYPE, type_id, size, variant='icon'
+    )
+
+
+def type_render_url(type_id: int, size: int = _DEFAULT_IMAGE_SIZE) -> str:
+    """render image URL for the given type ID"""
+    return _eve_entity_image_url(
+        _ESI_CATEGORY_INVENTORYTYPE, type_id, size, variant='render'
+    )

allianceauth/eveonline/evelinks/evewho.py

@@ -1,22 +1,27 @@
 # this module generates profile URLs for evewho
 
-from urllib.parse import urljoin, quote
+from urllib.parse import urljoin
 
-from . import *
+from . import (
+    _ESI_CATEGORY_ALLIANCE, 
+    _ESI_CATEGORY_CORPORATION, 
+    _ESI_CATEGORY_CHARACTER,  
+)
 
-BASE_URL = 'https://evewho.com'
+
+_BASE_URL = 'https://evewho.com'
 
 
 def _build_url(category: str, eve_id: int) -> str:
     """return url to profile page for an eve entity"""
     
-    if category == ESI_CATEGORY_ALLIANCE:        
+    if category == _ESI_CATEGORY_ALLIANCE:        
         partial = 'alliance'
 
-    elif category == ESI_CATEGORY_CORPORATION:        
+    elif category == _ESI_CATEGORY_CORPORATION:        
         partial = 'corporation'
 
-    elif category == ESI_CATEGORY_CHARACTER:
+    elif category == _ESI_CATEGORY_CHARACTER:
         partial = 'character'
     
     else:
@@ -25,7 +30,7 @@ def _build_url(category: str, eve_id: int) -> str:
         )
     
     url = urljoin(
-        BASE_URL,
+        _BASE_URL,
         '{}/{}'.format(partial, int(eve_id))
     )
     return url
@@ -33,12 +38,14 @@ def _build_url(category: str, eve_id: int) -> str:
 
 def alliance_url(eve_id: int) -> str:
     """url for page about given alliance on evewho"""
-    return _build_url(ESI_CATEGORY_ALLIANCE, eve_id)
+    return _build_url(_ESI_CATEGORY_ALLIANCE, eve_id)
+
 
 def character_url(eve_id: int) -> str:
     """url for page about given character on evewho"""
-    return _build_url(ESI_CATEGORY_CHARACTER, eve_id)
+    return _build_url(_ESI_CATEGORY_CHARACTER, eve_id)
+
 
 def corporation_url(eve_id: int) -> str:
     """url for page about given corporation on evewho"""
-    return _build_url(ESI_CATEGORY_CORPORATION, eve_id)
+    return _build_url(_ESI_CATEGORY_CORPORATION, eve_id)

allianceauth/eveonline/evelinks/tests/test_evelinks.py

@@ -1,7 +1,7 @@
 from django.test import TestCase
 
 from ...models import EveCharacter, EveCorporationInfo, EveAllianceInfo
-from .. import dotlan, zkillboard, evewho
+from .. import dotlan, zkillboard, evewho, eveimageserver
 from ...templatetags import evelinks
 
 
@@ -90,3 +90,115 @@ class TestZkillboard(TestCase):
             'https://zkillboard.com/system/12345678/'
         )
 
+
+class TestEveImageServer(TestCase):
+    """unit test for eveimageserver"""
+    
+    def test_sizes(self):        
+        self.assertEqual(
+            eveimageserver._eve_entity_image_url('character', 42),  
+            'https://images.evetech.net/characters/42/portrait?size=32'
+        )
+        self.assertEqual(
+            eveimageserver._eve_entity_image_url('character', 42, size=32),  
+            'https://images.evetech.net/characters/42/portrait?size=32'
+        )
+        self.assertEqual(
+            eveimageserver._eve_entity_image_url('character', 42, size=64),  
+            'https://images.evetech.net/characters/42/portrait?size=64'
+        )
+        self.assertEqual(
+            eveimageserver._eve_entity_image_url('character', 42, size=128),  
+            'https://images.evetech.net/characters/42/portrait?size=128'
+        )
+        self.assertEqual(
+            eveimageserver._eve_entity_image_url('character', 42, size=256),  
+            'https://images.evetech.net/characters/42/portrait?size=256'
+        )
+        self.assertEqual(
+            eveimageserver._eve_entity_image_url('character', 42, size=512),  
+            'https://images.evetech.net/characters/42/portrait?size=512'
+        )
+        self.assertEqual(
+            eveimageserver._eve_entity_image_url('character', 42, size=1024),  
+            'https://images.evetech.net/characters/42/portrait?size=1024'
+        )
+        with self.assertRaises(ValueError):
+            eveimageserver._eve_entity_image_url('corporation', 42, size=-5)
+
+        with self.assertRaises(ValueError):
+            eveimageserver._eve_entity_image_url('corporation', 42, size=0)
+        
+        with self.assertRaises(ValueError):
+            eveimageserver._eve_entity_image_url('corporation', 42, size=31)
+        
+        with self.assertRaises(ValueError):
+            eveimageserver._eve_entity_image_url('corporation', 42, size=1025)
+
+        with self.assertRaises(ValueError):
+            eveimageserver._eve_entity_image_url('corporation', 42, size=2048)
+
+
+    def test_variant(self):
+        self.assertEqual(
+            eveimageserver._eve_entity_image_url('character', 42, variant='portrait'),  
+            'https://images.evetech.net/characters/42/portrait?size=32'
+        )
+        self.assertEqual(
+            eveimageserver._eve_entity_image_url('alliance', 42, variant='logo'),  
+            'https://images.evetech.net/alliances/42/logo?size=32'
+        )
+        with self.assertRaises(ValueError):
+            eveimageserver._eve_entity_image_url('character', 42, variant='logo')
+    
+
+    def test_alliance(self):
+        self.assertEqual(
+            eveimageserver._eve_entity_image_url('alliance', 42),  
+            'https://images.evetech.net/alliances/42/logo?size=32'
+        )
+        self.assertEqual(
+            eveimageserver._eve_entity_image_url('corporation', 42),  
+            'https://images.evetech.net/corporations/42/logo?size=32'
+        )
+        self.assertEqual(
+            eveimageserver._eve_entity_image_url('character', 42),  
+            'https://images.evetech.net/characters/42/portrait?size=32'
+        )
+        with self.assertRaises(ValueError):
+            eveimageserver._eve_entity_image_url('station', 42)
+
+
+    def test_tenants(self):
+        self.assertEqual(
+            eveimageserver._eve_entity_image_url('character', 42, tenant='tranquility'),  
+            'https://images.evetech.net/characters/42/portrait?size=32&tenant=tranquility'
+        )
+        self.assertEqual(
+            eveimageserver._eve_entity_image_url('character', 42, tenant='singularity'),  
+            'https://images.evetech.net/characters/42/portrait?size=32&tenant=singularity'
+        )
+        with self.assertRaises(ValueError):
+            eveimageserver._eve_entity_image_url('character', 42, tenant='xxx')
+        
+    def test_alliance_logo_url(self):
+        expected = 'https://images.evetech.net/alliances/42/logo?size=128'
+        self.assertEqual(eveimageserver.alliance_logo_url(42, 128), expected)
+
+    def test_corporation_logo_url(self):
+        expected = 'https://images.evetech.net/corporations/42/logo?size=128'
+        self.assertEqual(eveimageserver.corporation_logo_url(42, 128), expected)
+
+    def test_character_portrait_url(self):
+        expected = 'https://images.evetech.net/characters/42/portrait?size=128'
+        self.assertEqual(
+            eveimageserver.character_portrait_url(42, 128), expected
+        )
+
+    def test_type_icon_url(self):
+        expected = 'https://images.evetech.net/types/42/icon?size=128'
+        self.assertEqual(eveimageserver.type_icon_url(42, 128), expected)
+
+    def test_type_render_url(self):
+        expected = 'https://images.evetech.net/types/42/render?size=128'
+        self.assertEqual(eveimageserver.type_render_url(42, 128), expected)

allianceauth/eveonline/evelinks/tests/test_templatetags.py

@@ -1,7 +1,7 @@
 from django.test import TestCase
 
 from ...models import EveCharacter, EveCorporationInfo, EveAllianceInfo
-from .. import dotlan, zkillboard, evewho
+from .. import eveimageserver, evewho, dotlan, zkillboard
 from ...templatetags import evelinks
 
 
@@ -332,3 +332,28 @@ class TestTemplateTags(TestCase):
             ''
         )
 
+    def test_type_icon_url(self):
+        expected = eveimageserver.type_icon_url(123)
+        self.assertEqual(evelinks.type_icon_url(123), expected)
+
+        expected = eveimageserver.type_icon_url(123, 128)
+        self.assertEqual(evelinks.type_icon_url(123, 128), expected)
+        
+        expected = ''
+        self.assertEqual(evelinks.type_icon_url(123, 99), expected)
+        
+        expected = ''
+        self.assertEqual(evelinks.type_icon_url(None), expected)
+
+    def test_type_render_url(self):
+        expected = eveimageserver.type_render_url(123)
+        self.assertEqual(evelinks.type_render_url(123), expected)
+
+        expected = eveimageserver.type_render_url(123, 128)
+        self.assertEqual(evelinks.type_render_url(123, 128), expected)
+        
+        expected = ''
+        self.assertEqual(evelinks.type_render_url(123, 99), expected)
+        
+        expected = ''
+        self.assertEqual(evelinks.type_render_url(None), expected)

allianceauth/eveonline/evelinks/zkillboard.py

@@ -1,28 +1,35 @@
 # this module generates profile URLs for zKillboard
 
-from urllib.parse import urljoin, quote
+from urllib.parse import urljoin
 
-from . import *
+from . import (
+    _ESI_CATEGORY_ALLIANCE, 
+    _ESI_CATEGORY_CORPORATION, 
+    _ESI_CATEGORY_CHARACTER,
+    _ESI_CATEGORY_REGION, 
+    _ESI_CATEGORY_SOLARSYSTEM
+)
 
-BASE_URL = 'https://zkillboard.com'
+
+_BASE_URL = 'https://zkillboard.com'
 
 
 def _build_url(category: str, eve_id: int) -> str:
     """return url to profile page for an eve entity"""
     
-    if category == ESI_CATEGORY_ALLIANCE:        
+    if category == _ESI_CATEGORY_ALLIANCE:        
         partial = 'alliance'
 
-    elif category == ESI_CATEGORY_CORPORATION:        
+    elif category == _ESI_CATEGORY_CORPORATION:        
         partial = 'corporation'
 
-    elif category == ESI_CATEGORY_CHARACTER:
+    elif category == _ESI_CATEGORY_CHARACTER:
         partial = 'character'
 
-    elif category == ESI_CATEGORY_REGION:
+    elif category == _ESI_CATEGORY_REGION:
         partial = 'region'
 
-    elif category == ESI_CATEGORY_SOLARSYSTEM:
+    elif category == _ESI_CATEGORY_SOLARSYSTEM:
         partial = 'system'
     
     else:
@@ -31,7 +38,7 @@ def _build_url(category: str, eve_id: int) -> str:
         )
     
     url = urljoin(
-        BASE_URL,
+        _BASE_URL,
         '{}/{}/'.format(partial, int(eve_id))
     )
     return url
@@ -39,19 +46,23 @@ def _build_url(category: str, eve_id: int) -> str:
 
 def alliance_url(eve_id: int) -> str:
     """url for page about given alliance on zKillboard"""
-    return _build_url(ESI_CATEGORY_ALLIANCE, eve_id)
+    return _build_url(_ESI_CATEGORY_ALLIANCE, eve_id)
+
 
 def character_url(eve_id: int) -> str:
     """url for page about given character on zKillboard"""
-    return _build_url(ESI_CATEGORY_CHARACTER, eve_id)
+    return _build_url(_ESI_CATEGORY_CHARACTER, eve_id)
+
 
 def corporation_url(eve_id: int) -> str:
     """url for page about given corporation on zKillboard"""
-    return _build_url(ESI_CATEGORY_CORPORATION, eve_id)
+    return _build_url(_ESI_CATEGORY_CORPORATION, eve_id)
+
 
 def region_url(eve_id: int) -> str:
     """url for page about given region on zKillboard"""
-    return _build_url(ESI_CATEGORY_REGION, eve_id)
+    return _build_url(_ESI_CATEGORY_REGION, eve_id)
+
 
 def solar_system_url(eve_id: int) -> str:
-    return _build_url(ESI_CATEGORY_SOLARSYSTEM, eve_id)
+    return _build_url(_ESI_CATEGORY_SOLARSYSTEM, eve_id)

allianceauth/eveonline/managers.py

@@ -89,4 +89,6 @@ class EveCorporationManager(models.Manager):
         )
 
     def update_corporation(self, corp_id):
-        return self.get(corporation_id=corp_id).update_corporation(self.provider.get_corporation(corp_id))
+        return self\
+            .get(corporation_id=corp_id)\
+            .update_corporation(self.provider.get_corporation(corp_id))

allianceauth/eveonline/migrations/0011_ids_to_integers.py

@@ -0,0 +1,43 @@
+# Generated by Django 2.2.12 on 2020-05-25 02:28
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('eveonline', '0010_alliance_ticker'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='eveallianceinfo',
+            name='alliance_id',
+            field=models.PositiveIntegerField(unique=True),
+        ),
+        migrations.AlterField(
+            model_name='eveallianceinfo',
+            name='executor_corp_id',
+            field=models.PositiveIntegerField(),
+        ),
+        migrations.AlterField(
+            model_name='evecharacter',
+            name='alliance_id',
+            field=models.PositiveIntegerField(blank=True, default=None, null=True),
+        ),
+        migrations.AlterField(
+            model_name='evecharacter',
+            name='character_id',
+            field=models.PositiveIntegerField(unique=True),
+        ),
+        migrations.AlterField(
+            model_name='evecharacter',
+            name='corporation_id',
+            field=models.PositiveIntegerField(),
+        ),
+        migrations.AlterField(
+            model_name='evecorporationinfo',
+            name='corporation_id',
+            field=models.PositiveIntegerField(unique=True),
+        ),
+    ]

allianceauth/eveonline/migrations/0012_index_additions.py

@@ -0,0 +1,33 @@
+# Generated by Django 2.2.12 on 2020-05-26 02:09
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('eveonline', '0011_ids_to_integers'),
+    ]
+
+    operations = [
+        migrations.AddIndex(
+            model_name='eveallianceinfo',
+            index=models.Index(fields=['executor_corp_id'], name='eveonline_e_executo_7f3280_idx'),
+        ),
+        migrations.AddIndex(
+            model_name='evecharacter',
+            index=models.Index(fields=['corporation_id'], name='eveonline_e_corpora_cb4cd9_idx'),
+        ),
+        migrations.AddIndex(
+            model_name='evecharacter',
+            index=models.Index(fields=['alliance_id'], name='eveonline_e_allianc_39ee2a_idx'),
+        ),
+        migrations.AddIndex(
+            model_name='evecharacter',
+            index=models.Index(fields=['corporation_name'], name='eveonline_e_corpora_893c60_idx'),
+        ),
+        migrations.AddIndex(
+            model_name='evecharacter',
+            index=models.Index(fields=['alliance_name'], name='eveonline_e_allianc_63fd98_idx'),
+        ),
+    ]

allianceauth/eveonline/models.py

@@ -5,109 +5,35 @@ from .managers import EveCharacterManager, EveCharacterProviderManager
 from .managers import EveCorporationManager, EveCorporationProviderManager
 from .managers import EveAllianceManager, EveAllianceProviderManager
 from . import providers
+from .evelinks import eveimageserver
 
-
+_DEFAULT_IMAGE_SIZE = 32
-EVE_IMAGE_SERVER_URL = 'https://images.evetech.net'
-
-
-def _eve_entity_image_url(    
-    category: str,     
-    id: int, 
-    size: int = 32, 
-    variant: str = None,
-    tenant: str = None,
-) -> str:
-    """returns image URL for an Eve Online ID.
-    Supported categories: `alliance`, `corporation`, `character`
-    
-    Arguments:
-    - category: category of the ID
-    - id: Eve ID of the entity
-    - size: (optional) render size of the image.must be between 32 (default) and 1024
-    - variant: (optional) image variant for category. currently not relevant.
-    - tentant: (optional) Eve Server, either `tranquility`(default) or `singularity`
-
-    Returns:
-    - URL string for the requested image on the Eve image server
-
-    Exceptions:
-    - Throws ValueError on invalid input
-    """
-    
-    # input validations
-    categories = {
-        'alliance': {
-            'endpoint': 'alliances',
-            'variants': [
-                'logo'
-            ]
-        },
-        'corporation': {
-            'endpoint': 'corporations',
-            'variants': [
-                'logo'
-            ]
-        },
-        'character': {
-            'endpoint': 'characters',
-            'variants': [
-                'portrait'
-            ]
-        }
-    }
-    tenants = ['tranquility', 'singularity']
-   
-    if size < 32 or size > 1024 or (size & (size - 1) != 0):
-        raise ValueError('Invalid size: {}'.format(size))
-   
-    if category not in categories:
-        raise ValueError('Invalid category {}'.format(category))
-    else:
-        endpoint = categories[category]['endpoint']
-
-    if variant:
-        if variant not in categories[category]['variants']:
-            raise ValueError('Invalid variant {} for category {}'.format(
-                variant,
-                category
-            ))
-    else:
-        variant = categories[category]['variants'][0]
-
-    if tenant and tenant not in tenants:
-            raise ValueError('Invalid tentant {}'.format(tenant))
-        
-    # compose result URL
-    result = '{}/{}/{}/{}?size={}'.format(
-        EVE_IMAGE_SERVER_URL,
-        endpoint,
-        id,
-        variant,
-        size
-    )
-    if tenant:
-        result += '&tenant={}'.format(tenant)
-    
-    return result
 
 
 class EveAllianceInfo(models.Model):
-    alliance_id = models.CharField(max_length=254, unique=True)
+    alliance_id = models.PositiveIntegerField(unique=True)
     alliance_name = models.CharField(max_length=254, unique=True)
     alliance_ticker = models.CharField(max_length=254)
-    executor_corp_id = models.CharField(max_length=254)
+    executor_corp_id = models.PositiveIntegerField()
 
     objects = EveAllianceManager()
     provider = EveAllianceProviderManager()
 
+    class Meta:
+        indexes = [models.Index(fields=['executor_corp_id',])]
+
     def populate_alliance(self):
         alliance = self.provider.get_alliance(self.alliance_id)
         for corp_id in alliance.corp_ids:
             if not EveCorporationInfo.objects.filter(corporation_id=corp_id).exists():
                 EveCorporationInfo.objects.create_corporation(corp_id)
-        EveCorporationInfo.objects.filter(corporation_id__in=alliance.corp_ids).update(alliance=self)
+        EveCorporationInfo.objects.filter(
-        EveCorporationInfo.objects.filter(alliance=self).exclude(corporation_id__in=alliance.corp_ids).update(
+            corporation_id__in=alliance.corp_ids).update(alliance=self
-            alliance=None)
+        )
+        EveCorporationInfo.objects\
+            .filter(alliance=self)\
+            .exclude(corporation_id__in=alliance.corp_ids)\
+            .update(alliance=None)
 
     def update_alliance(self, alliance: providers.Alliance = None):
         if alliance is None:
@@ -120,11 +46,13 @@ class EveAllianceInfo(models.Model):
         return self.alliance_name
 
     @staticmethod
-    def generic_logo_url(alliance_id: int, size: int = 32) -> str:
+    def generic_logo_url(
+        alliance_id: int, size: int = _DEFAULT_IMAGE_SIZE
+    ) -> str:
         """image URL for the given alliance ID"""
-        return _eve_entity_image_url('alliance', alliance_id, size)
+        return eveimageserver.alliance_logo_url(alliance_id, size)
     
-    def logo_url(self, size:int = 32) -> str:
+    def logo_url(self, size: int = _DEFAULT_IMAGE_SIZE) -> str:
         """image URL of this alliance"""
         return self.generic_logo_url(self.alliance_id, size)
 
@@ -150,11 +78,13 @@ class EveAllianceInfo(models.Model):
 
 
 class EveCorporationInfo(models.Model):
-    corporation_id = models.CharField(max_length=254, unique=True)
+    corporation_id = models.PositiveIntegerField(unique=True)
     corporation_name = models.CharField(max_length=254, unique=True)
     corporation_ticker = models.CharField(max_length=254)
     member_count = models.IntegerField()
-    alliance = models.ForeignKey(EveAllianceInfo, blank=True, null=True, on_delete=models.SET_NULL)
+    alliance = models.ForeignKey(
+        EveAllianceInfo, blank=True, null=True, on_delete=models.SET_NULL
+    )
 
     objects = EveCorporationManager()
     provider = EveCorporationProviderManager()
@@ -174,11 +104,13 @@ class EveCorporationInfo(models.Model):
         return self.corporation_name
 
     @staticmethod
-    def generic_logo_url(corporation_id: int, size: int = 32) -> str:
+    def generic_logo_url(
+        corporation_id: int, size: int = _DEFAULT_IMAGE_SIZE
+    ) -> str:
         """image URL for the given corporation ID"""
-        return _eve_entity_image_url('corporation', corporation_id, size)
+        return eveimageserver.corporation_logo_url(corporation_id, size)
 
-    def logo_url(self, size:int = 32) -> str:
+    def logo_url(self, size: int = _DEFAULT_IMAGE_SIZE) -> str:
         """image URL for this corporation"""
         return self.generic_logo_url(self.corporation_id, size)
 
@@ -204,18 +136,26 @@ class EveCorporationInfo(models.Model):
 
 
 class EveCharacter(models.Model):
-    character_id = models.CharField(max_length=254, unique=True)
+    character_id = models.PositiveIntegerField(unique=True)
     character_name = models.CharField(max_length=254, unique=True)
-    corporation_id = models.CharField(max_length=254)
+    corporation_id = models.PositiveIntegerField()
     corporation_name = models.CharField(max_length=254)
     corporation_ticker = models.CharField(max_length=5)
-    alliance_id = models.CharField(max_length=254, blank=True, null=True, default='')
+    alliance_id = models.PositiveIntegerField(blank=True, null=True, default=None)
     alliance_name = models.CharField(max_length=254, blank=True, null=True, default='')
     alliance_ticker = models.CharField(max_length=5, blank=True, null=True, default='')
 
     objects = EveCharacterManager()
     provider = EveCharacterProviderManager()
 
+    class Meta:
+        indexes = [
+                    models.Index(fields=['corporation_id',]),
+                    models.Index(fields=['alliance_id',]),
+                    models.Index(fields=['corporation_name',]),
+                    models.Index(fields=['alliance_name',]),
+                  ]
+
     @property
     def alliance(self) -> Union[EveAllianceInfo, None]:
         """
@@ -253,11 +193,13 @@ class EveCharacter(models.Model):
         return self.character_name
 
     @staticmethod
-    def generic_portrait_url(character_id: int, size: int = 32) -> str:
+    def generic_portrait_url(
+        character_id: int, size: int = _DEFAULT_IMAGE_SIZE
+    ) -> str:
         """image URL for the given character ID"""
-        return _eve_entity_image_url('character', character_id, size)
+        return eveimageserver.character_portrait_url(character_id, size)
 
-    def portrait_url(self, size = 32) -> str:
+    def portrait_url(self, size=_DEFAULT_IMAGE_SIZE) -> str:
         """image URL for this character"""
         return self.generic_portrait_url(self.character_id, size)
 
@@ -281,7 +223,7 @@ class EveCharacter(models.Model):
         """image URL for this character"""
         return self.portrait_url(256)
 
-    def corporation_logo_url(self, size = 32) -> str:
+    def corporation_logo_url(self, size=_DEFAULT_IMAGE_SIZE) -> str:
         """image URL for corporation of this character"""
         return EveCorporationInfo.generic_logo_url(self.corporation_id, size)
 
@@ -305,7 +247,7 @@ class EveCharacter(models.Model):
         """image URL for corporation of this character"""
         return self.corporation_logo_url(256)
 
-    def alliance_logo_url(self, size = 32) -> str:
+    def alliance_logo_url(self, size=_DEFAULT_IMAGE_SIZE) -> str:
         """image URL for alliance of this character or empty string"""
         if self.alliance_id:
             return EveAllianceInfo.generic_logo_url(self.alliance_id, size)

allianceauth/eveonline/templatetags/evelinks.py

@@ -15,7 +15,7 @@
 from django import template
 
 from ..models import EveCharacter, EveCorporationInfo, EveAllianceInfo
-from ..evelinks import evewho, dotlan, zkillboard
+from ..evelinks import eveimageserver, evewho, dotlan, zkillboard
 
 register = template.Library()
 
@@ -163,7 +163,7 @@ def dotlan_solar_system_url(eve_obj: object) -> str:
     return _generic_evelinks_url(dotlan, 'solar_system_url', eve_obj)
 
 
-#zkillboard
+# zkillboard
 
 @register.filter
 def zkillboard_character_url(eve_obj: EveCharacter) -> str:    
@@ -212,7 +212,6 @@ def zkillboard_solar_system_url(eve_obj: object) -> str:
 
 # image urls
 
-
 @register.filter
 def character_portrait_url(
     eve_obj: object, 
@@ -284,3 +283,30 @@ def alliance_logo_url(
         except ValueError:
             return ''
 
+
+@register.filter
+def type_icon_url(
+    type_id: int, 
+    size: int = _DEFAULT_IMAGE_SIZE
+) -> str:
+    """generates a icon image URL for the given type ID    
+    Returns URL or empty string
+    """
+    try:
+        return eveimageserver.type_icon_url(type_id, size)
+    except ValueError:
+        return ''
+
+
+@register.filter
+def type_render_url(
+    type_id: int, 
+    size: int = _DEFAULT_IMAGE_SIZE
+) -> str:
+    """generates a render image URL for the given type ID    
+    Returns URL or empty string
+    """
+    try:
+        return eveimageserver.type_render_url(type_id, size)
+    except ValueError:
+        return ''

allianceauth/eveonline/tests/test_managers.py

@@ -12,7 +12,7 @@ class EveCharacterProviderManagerTestCase(TestCase):
         expected = Character()
         provider.get_character.return_value = expected
 
-        result = EveCharacter.provider.get_character('1234')
+        result = EveCharacter.provider.get_character(1234)
 
         self.assertEqual(expected, result)
 
@@ -22,30 +22,30 @@ class EveCharacterManagerTestCase(TestCase):
     class TestCharacter(Character):
         @property
         def alliance(self):
-            return Alliance(id='3456', name='Test Alliance')
+            return Alliance(id=3456, name='Test Alliance')
 
         @property
         def corp(self):
             return Corporation(
-                id='2345', 
+                id=2345, 
                 name='Test Corp', 
-                alliance_id='3456', 
+                alliance_id=3456, 
-                ticker='0BUGS'
+                ticker='0BUGS' #lies, blatant lies!
             )
 
     @mock.patch('allianceauth.eveonline.managers.providers.provider')
     def test_create_character(self, provider):
         # Also covers create_character_obj
         expected = self.TestCharacter(
-            id='1234', 
+            id=1234, 
             name='Test Character', 
-            corp_id='2345', 
+            corp_id=2345, 
-            alliance_id='3456'
+            alliance_id=3456
         )
 
         provider.get_character.return_value = expected
 
-        result = EveCharacter.objects.create_character('1234')
+        result = EveCharacter.objects.create_character(1234)
 
         self.assertEqual(result.character_id, expected.id)
         self.assertEqual(result.character_name, expected.name)
@@ -59,25 +59,24 @@ class EveCharacterManagerTestCase(TestCase):
     def test_update_character(self, provider):
         # Also covers Model.update_character
         existing = EveCharacter.objects.create(
-            character_id='1234',
+            character_id=1234,
             character_name='character.name',
-            corporation_id='character.corp.id',
+            corporation_id=23457,
             corporation_name='character.corp.name',
-            corporation_ticker='character.corp.ticker',
+            corporation_ticker='cc1',
-            alliance_id='character.alliance.id',
+            alliance_id=34567,
             alliance_name='character.alliance.name',
         )
 
         expected = self.TestCharacter(
-            id='1234', 
+            id=1234, 
             name='Test Character', 
-            corp_id='2345', 
+            corp_id=2345, 
-            alliance_id='3456'
+            alliance_id=3456
         )
-
         provider.get_character.return_value = expected
 
-        result = EveCharacter.objects.update_character('1234')
+        result = EveCharacter.objects.update_character(1234)
 
         self.assertEqual(result.character_id, expected.id)
         self.assertEqual(result.character_name, expected.name)
@@ -90,23 +89,23 @@ class EveCharacterManagerTestCase(TestCase):
     def test_get_character_by_id(self):
         EveCharacter.objects.all().delete()
         EveCharacter.objects.create(
-            character_id='1234',
+            character_id=1234,
             character_name='character.name',
-            corporation_id='character.corp.id',
+            corporation_id=2345,
             corporation_name='character.corp.name',
-            corporation_ticker='character.corp.ticker',
+            corporation_ticker='cc1',
-            alliance_id='character.alliance.id',
+            alliance_id=3456,
             alliance_name='character.alliance.name',
         )
 
         # try to get existing character
-        result = EveCharacter.objects.get_character_by_id('1234')
+        result = EveCharacter.objects.get_character_by_id(1234)
 
-        self.assertEqual(result.character_id, '1234')
+        self.assertEqual(result.character_id, 1234)
         self.assertEqual(result.character_name, 'character.name')
 
         # try to get non existing character        
-        self.assertIsNone(EveCharacter.objects.get_character_by_id('9999'))
+        self.assertIsNone(EveCharacter.objects.get_character_by_id(9999))
 
 
 class EveAllianceProviderManagerTestCase(TestCase):
@@ -115,7 +114,7 @@ class EveAllianceProviderManagerTestCase(TestCase):
         expected = Alliance()
         provider.get_alliance.return_value = expected
 
-        result = EveAllianceInfo.provider.get_alliance('1234')
+        result = EveAllianceInfo.provider.get_alliance(1234)
 
         self.assertEqual(expected, result)
 
@@ -131,16 +130,16 @@ class EveAllianceManagerTestCase(TestCase):
     def test_create_alliance(self, provider, populate_alliance):
         # Also covers create_alliance_obj
         expected = self.TestAlliance(
-            id='3456', 
+            id=3456, 
             name='Test Alliance', 
             ticker='TEST',
-            corp_ids=['2345'], 
+            corp_ids=[2345], 
-            executor_corp_id='2345'
+            executor_corp_id=2345
         )
 
         provider.get_alliance.return_value = expected
 
-        result = EveAllianceInfo.objects.create_alliance('3456')
+        result = EveAllianceInfo.objects.create_alliance(3456)
 
         self.assertEqual(result.alliance_id, expected.id)
         self.assertEqual(result.alliance_name, expected.name)
@@ -152,22 +151,22 @@ class EveAllianceManagerTestCase(TestCase):
     def test_update_alliance(self, provider):
         # Also covers Model.update_alliance
         EveAllianceInfo.objects.create(
-            alliance_id='3456',
+            alliance_id=3456,
             alliance_name='alliance.name',
-            alliance_ticker='alliance.ticker',
+            alliance_ticker='at1',
-            executor_corp_id='alliance.executor_corp_id',
+            executor_corp_id=2345,
         )
         expected = self.TestAlliance(
-            id='3456', 
+            id=3456, 
             name='Test Alliance', 
             ticker='TEST',
-            corp_ids=['2345'], 
+            corp_ids=[2345], 
-            executor_corp_id='2345'
+            executor_corp_id=2345
         )
 
         provider.get_alliance.return_value = expected
 
-        result = EveAllianceInfo.objects.update_alliance('3456')
+        result = EveAllianceInfo.objects.update_alliance(3456)
 
         # This is the only thing ever updated in code
         self.assertEqual(result.executor_corp_id, expected.executor_corp_id)
@@ -179,7 +178,7 @@ class EveCorporationProviderManagerTestCase(TestCase):
         expected = Corporation()
         provider.get_corp.return_value = expected
 
-        result = EveCorporationInfo.provider.get_corporation('2345')
+        result = EveCorporationInfo.provider.get_corporation(2345)
 
         self.assertEqual(expected, result)
 
@@ -190,39 +189,39 @@ class EveCorporationManagerTestCase(TestCase):
         @property
         def alliance(self):
             return EveAllianceManagerTestCase.TestAlliance(
-                id='3456', 
+                id=3456, 
                 name='Test Alliance', 
                 ticker='TEST',
-                corp_ids=['2345'], 
+                corp_ids=[2345], 
-                executor_corp_id='2345'
+                executor_corp_id=2345
             )
 
         @property
         def ceo(self):
             return EveCharacterManagerTestCase.TestCharacter(
-                id='1234', 
+                id=1234, 
                 name='Test Character',
-                corp_id='2345', 
+                corp_id=2345, 
-                alliance_id='3456'
+                alliance_id=3456
             )
 
     @mock.patch('allianceauth.eveonline.managers.providers.provider')
     def test_create_corporation(self, provider):
         # Also covers create_corp_obj
         exp_alliance = EveAllianceInfo.objects.create(
-            alliance_id='3456',
+            alliance_id=3456,
             alliance_name='alliance.name',
-            alliance_ticker='alliance.ticker',
+            alliance_ticker='99bug',
-            executor_corp_id='alliance.executor_corp_id',
+            executor_corp_id=2345,
         )
 
         expected = self.TestCorporation(
-            id='2345', 
+            id=2345, 
             name='Test Corp', 
             ticker='0BUGS',
-            ceo_id='1234', 
+            ceo_id=1234, 
             members=1, 
-            alliance_id='3456'
+            alliance_id=3456
         )
 
         provider.get_corp.return_value = expected
@@ -240,17 +239,17 @@ class EveCorporationManagerTestCase(TestCase):
         # variant to test no alliance case
         # Also covers create_corp_obj        
         expected = self.TestCorporation(
-            id='2345', 
+            id=2345, 
             name='Test Corp', 
             ticker='0BUGS',
-            ceo_id='1234', 
+            ceo_id=1234, 
             members=1, 
-            alliance_id='3456'
+            alliance_id=3456
         )
 
         provider.get_corp.return_value = expected
 
-        result = EveCorporationInfo.objects.create_corporation('2345')
+        result = EveCorporationInfo.objects.create_corporation(2345)
 
         self.assertEqual(result.corporation_id, expected.id)
         self.assertEqual(result.corporation_name, expected.name)
@@ -262,27 +261,27 @@ class EveCorporationManagerTestCase(TestCase):
     def test_update_corporation(self, provider):
         # Also covers Model.update_corporation
         exp_alliance = EveAllianceInfo.objects.create(
-            alliance_id='3456',
+            alliance_id=3456,
             alliance_name='alliance.name',
-            alliance_ticker='alliance.ticker',
+            alliance_ticker='at1',
-            executor_corp_id='alliance.executor_corp_id',
+            executor_corp_id=2345,
         )
 
         EveCorporationInfo.objects.create(
-            corporation_id='2345',
+            corporation_id=2345,
             corporation_name='corp.name',
-            corporation_ticker='corp.ticker',
+            corporation_ticker='cc1',
             member_count=10,
             alliance=None,
         )
 
         expected = self.TestCorporation(
-            id='2345', 
+            id=2345, 
             name='Test Corp', 
             ticker='0BUGS',
-            ceo_id='1234', 
+            ceo_id=1234, 
             members=1, 
-            alliance_id='3456'
+            alliance_id=3456
         )
 
         provider.get_corp.return_value = expected

allianceauth/eveonline/tests/test_models.py

@@ -2,101 +2,11 @@ from unittest.mock import Mock, patch
 
 from django.test import TestCase
 
-from ..models import EveCharacter, EveCorporationInfo, \
+from ..models import (
-    EveAllianceInfo, _eve_entity_image_url
+    EveCharacter, EveCorporationInfo, EveAllianceInfo
+)
 from ..providers import Alliance, Corporation, Character
-
+from ..evelinks import eveimageserver
-
-class EveUniverseImageUrlTestCase(TestCase):
-    """unit test for _eve_entity_image_url()"""
-    
-    def test_sizes(self):        
-        self.assertEqual(
-            _eve_entity_image_url('character', 42),  
-            'https://images.evetech.net/characters/42/portrait?size=32'
-        )
-        self.assertEqual(
-            _eve_entity_image_url('character', 42, size=32),  
-            'https://images.evetech.net/characters/42/portrait?size=32'
-        )
-        self.assertEqual(
-            _eve_entity_image_url('character', 42, size=64),  
-            'https://images.evetech.net/characters/42/portrait?size=64'
-        )
-        self.assertEqual(
-            _eve_entity_image_url('character', 42, size=128),  
-            'https://images.evetech.net/characters/42/portrait?size=128'
-        )
-        self.assertEqual(
-            _eve_entity_image_url('character', 42, size=256),  
-            'https://images.evetech.net/characters/42/portrait?size=256'
-        )
-        self.assertEqual(
-            _eve_entity_image_url('character', 42, size=512),  
-            'https://images.evetech.net/characters/42/portrait?size=512'
-        )
-        self.assertEqual(
-            _eve_entity_image_url('character', 42, size=1024),  
-            'https://images.evetech.net/characters/42/portrait?size=1024'
-        )
-        with self.assertRaises(ValueError):
-            _eve_entity_image_url('corporation', 42, size=-5)
-
-        with self.assertRaises(ValueError):
-            _eve_entity_image_url('corporation', 42, size=0)
-        
-        with self.assertRaises(ValueError):
-            _eve_entity_image_url('corporation', 42, size=31)
-        
-        with self.assertRaises(ValueError):
-            _eve_entity_image_url('corporation', 42, size=1025)
-
-        with self.assertRaises(ValueError):
-            _eve_entity_image_url('corporation', 42, size=2048)
-
-
-    def test_variant(self):
-        self.assertEqual(
-            _eve_entity_image_url('character', 42, variant='portrait'),  
-            'https://images.evetech.net/characters/42/portrait?size=32'
-        )
-        self.assertEqual(
-            _eve_entity_image_url('alliance', 42, variant='logo'),  
-            'https://images.evetech.net/alliances/42/logo?size=32'
-        )
-        with self.assertRaises(ValueError):
-            _eve_entity_image_url('character', 42, variant='logo')
-    
-
-    def test_alliance(self):
-
-        self.assertEqual(
-            _eve_entity_image_url('alliance', 42),  
-            'https://images.evetech.net/alliances/42/logo?size=32'
-        )
-        self.assertEqual(
-            _eve_entity_image_url('corporation', 42),  
-            'https://images.evetech.net/corporations/42/logo?size=32'
-        )
-        self.assertEqual(
-            _eve_entity_image_url('character', 42),  
-            'https://images.evetech.net/characters/42/portrait?size=32'
-        )
-        with self.assertRaises(ValueError):
-            _eve_entity_image_url('station', 42)
-
-
-    def test_tenants(self):
-        self.assertEqual(
-            _eve_entity_image_url('character', 42, tenant='tranquility'),  
-            'https://images.evetech.net/characters/42/portrait?size=32&tenant=tranquility'
-        )
-        self.assertEqual(
-            _eve_entity_image_url('character', 42, tenant='singularity'),  
-            'https://images.evetech.net/characters/42/portrait?size=32&tenant=singularity'
-        )
-        with self.assertRaises(ValueError):
-            _eve_entity_image_url('character', 42, tenant='xxx')
 
 
 class EveCharacterTestCase(TestCase):
@@ -105,27 +15,27 @@ class EveCharacterTestCase(TestCase):
         Test that the correct corporation is returned by the corporation property
         """
         character = EveCharacter.objects.create(
-            character_id='1234',
+            character_id=1234,
             character_name='character.name',
-            corporation_id='2345',
+            corporation_id=2345,
             corporation_name='character.corp.name',
-            corporation_ticker='character.corp.ticker',
+            corporation_ticker='cc1',
-            alliance_id='character.alliance.id',
+            alliance_id=12345,
             alliance_name='character.alliance.name',
         )
 
         expected = EveCorporationInfo.objects.create(
-            corporation_id='2345',
+            corporation_id=2345,
             corporation_name='corp.name',
-            corporation_ticker='corp.ticker',
+            corporation_ticker='cc1',
             member_count=10,
             alliance=None,
         )
 
         incorrect = EveCorporationInfo.objects.create(
-            corporation_id='9999',
+            corporation_id=9999,
             corporation_name='corp.name1',
-            corporation_ticker='corp.ticker1',
+            corporation_ticker='cc11',
             member_count=10,
             alliance=None,
         )
@@ -139,44 +49,44 @@ class EveCharacterTestCase(TestCase):
         object is not in the database
         """
         character = EveCharacter.objects.create(
-            character_id='1234',
+            character_id=1234,
             character_name='character.name',
-            corporation_id='2345',
+            corporation_id=2345,
             corporation_name='character.corp.name',
-            corporation_ticker='character.corp.ticker',
+            corporation_ticker='cc1',
-            alliance_id='character.alliance.id',
+            alliance_id=123456,
             alliance_name='character.alliance.name',
         )
 
         with self.assertRaises(EveCorporationInfo.DoesNotExist):
-            result = character.corporation
+            character.corporation
 
     def test_alliance_prop(self):
         """
         Test that the correct alliance is returned by the alliance property
         """
         character = EveCharacter.objects.create(
-            character_id='1234',
+            character_id=1234,
             character_name='character.name',
-            corporation_id='2345',
+            corporation_id=2345,
             corporation_name='character.corp.name',
-            corporation_ticker='character.corp.ticker',
+            corporation_ticker='cc1',
-            alliance_id='3456',
+            alliance_id=3456,
             alliance_name='character.alliance.name',
         )
 
         expected = EveAllianceInfo.objects.create(
-            alliance_id='3456',
+            alliance_id=3456,
             alliance_name='alliance.name',
-            alliance_ticker='alliance.ticker',
+            alliance_ticker='ac2',
-            executor_corp_id='alliance.executor_corp_id',
+            executor_corp_id=2345,
         )
 
         incorrect = EveAllianceInfo.objects.create(
-            alliance_id='9001',
+            alliance_id=9001,
             alliance_name='alliance.name1',
-            alliance_ticker='alliance.ticker1',
+            alliance_ticker='ac1',
-            executor_corp_id='alliance.executor_corp_id1',
+            executor_corp_id=2654,
         )
 
         self.assertEqual(character.alliance, expected)
@@ -188,28 +98,28 @@ class EveCharacterTestCase(TestCase):
         object is not in the database
         """
         character = EveCharacter.objects.create(
-            character_id='1234',
+            character_id=1234,
             character_name='character.name',
-            corporation_id='2345',
+            corporation_id=2345,
             corporation_name='character.corp.name',
-            corporation_ticker='character.corp.ticker',
+            corporation_ticker='cc1',
-            alliance_id='3456',
+            alliance_id=3456,
             alliance_name='character.alliance.name',
         )
 
         with self.assertRaises(EveAllianceInfo.DoesNotExist):
-            result = character.alliance
+            character.alliance
 
     def test_alliance_prop_none(self):
         """
         Check that None is returned when the character has no alliance
         """
         character = EveCharacter.objects.create(
-            character_id='1234',
+            character_id=1234,
             character_name='character.name',
-            corporation_id='2345',
+            corporation_id=2345,
             corporation_name='character.corp.name',
-            corporation_ticker='character.corp.ticker',
+            corporation_ticker='cc1',
             alliance_id=None,
             alliance_name=None,
         )
@@ -227,12 +137,12 @@ class EveCharacterTestCase(TestCase):
         )
         
         my_character = EveCharacter.objects.create(
-            character_id='1001',
+            character_id=1001,
             character_name='Bruce Wayne',
-            corporation_id='2001',
+            corporation_id=2001,
             corporation_name='Dummy Corp 1',
             corporation_ticker='DC1',
-            alliance_id='3001',
+            alliance_id=3001,
             alliance_name='Dummy Alliance 1',
         )        
         my_updated_character = Character(
@@ -244,90 +154,87 @@ class EveCharacterTestCase(TestCase):
 
         # todo: add test cases not yet covered, e.g. with alliance
 
-
     def test_image_url(self):
         self.assertEqual(
             EveCharacter.generic_portrait_url(42),
-            _eve_entity_image_url('character', 42)
+            eveimageserver._eve_entity_image_url('character', 42)
         )
         self.assertEqual(
             EveCharacter.generic_portrait_url(42, 256),
-            _eve_entity_image_url('character', 42, 256)
+            eveimageserver._eve_entity_image_url('character', 42, 256)
         )
 
     def test_portrait_urls(self):
         x = EveCharacter(
-            character_id='42',
+            character_id=42,
             character_name='character.name',
-            corporation_id='123',
+            corporation_id=123,
             corporation_name='corporation.name',            
             corporation_ticker='ABC',            
         )
         self.assertEqual(
             x.portrait_url(),
-            _eve_entity_image_url('character', 42)
+            eveimageserver._eve_entity_image_url('character', 42)
         )
         self.assertEqual(
             x.portrait_url(64),
-            _eve_entity_image_url('character', 42, size=64)
+            eveimageserver._eve_entity_image_url('character', 42, size=64)
         )       
         self.assertEqual(
             x.portrait_url_32,
-            _eve_entity_image_url('character', 42, size=32)
+            eveimageserver._eve_entity_image_url('character', 42, size=32)
         )
         self.assertEqual(
             x.portrait_url_64,
-            _eve_entity_image_url('character', 42, size=64)
+            eveimageserver._eve_entity_image_url('character', 42, size=64)
         )
         self.assertEqual(
             x.portrait_url_128,
-            _eve_entity_image_url('character', 42, size=128)
+            eveimageserver._eve_entity_image_url('character', 42, size=128)
         )
         self.assertEqual(
             x.portrait_url_256,
-            _eve_entity_image_url('character', 42, size=256)
+            eveimageserver._eve_entity_image_url('character', 42, size=256)
         )
 
-
     def test_corporation_logo_urls(self):
         x = EveCharacter(
-            character_id='42',
+            character_id=42,
             character_name='character.name',
-            corporation_id='123',
+            corporation_id=123,
             corporation_name='corporation.name',            
             corporation_ticker='ABC',            
         )
         self.assertEqual(
             x.corporation_logo_url(),
-            _eve_entity_image_url('corporation', 123)
+            eveimageserver._eve_entity_image_url('corporation', 123)
         )
         self.assertEqual(
             x.corporation_logo_url(256),
-            _eve_entity_image_url('corporation', 123, size=256)
+            eveimageserver._eve_entity_image_url('corporation', 123, size=256)
         )
         self.assertEqual(
             x.corporation_logo_url_32,
-            _eve_entity_image_url('corporation', 123, size=32)
+            eveimageserver._eve_entity_image_url('corporation', 123, size=32)
         )
         self.assertEqual(
             x.corporation_logo_url_64,
-            _eve_entity_image_url('corporation', 123, size=64)
+            eveimageserver._eve_entity_image_url('corporation', 123, size=64)
         )
         self.assertEqual(
             x.corporation_logo_url_128,
-            _eve_entity_image_url('corporation', 123, size=128)
+            eveimageserver._eve_entity_image_url('corporation', 123, size=128)
         )
         self.assertEqual(
             x.corporation_logo_url_256,
-            _eve_entity_image_url('corporation', 123, size=256)
+            eveimageserver._eve_entity_image_url('corporation', 123, size=256)
         )
 
-
     def test_alliance_logo_urls(self):
         x = EveCharacter(
-            character_id='42',
+            character_id=42,
             character_name='character.name',
-            corporation_id='123',
+            corporation_id=123,
             corporation_name='corporation.name',            
             corporation_ticker='ABC',            
         )        
@@ -354,27 +261,27 @@ class EveCharacterTestCase(TestCase):
         x.alliance_id = 987
         self.assertEqual(
             x.alliance_logo_url(),
-            _eve_entity_image_url('alliance', 987)
+            eveimageserver._eve_entity_image_url('alliance', 987)
         )
         self.assertEqual(
             x.alliance_logo_url(128),
-            _eve_entity_image_url('alliance', 987, size=128)
+            eveimageserver._eve_entity_image_url('alliance', 987, size=128)
         )
         self.assertEqual(
             x.alliance_logo_url_32,
-            _eve_entity_image_url('alliance', 987, size=32)
+            eveimageserver._eve_entity_image_url('alliance', 987, size=32)
         )
         self.assertEqual(
             x.alliance_logo_url_64,
-            _eve_entity_image_url('alliance', 987, size=64)
+            eveimageserver._eve_entity_image_url('alliance', 987, size=64)
         )
         self.assertEqual(
             x.alliance_logo_url_128,
-            _eve_entity_image_url('alliance', 987, size=128)
+            eveimageserver._eve_entity_image_url('alliance', 987, size=128)
         )
         self.assertEqual(
             x.alliance_logo_url_256,
-            _eve_entity_image_url('alliance', 987, size=256)
+            eveimageserver._eve_entity_image_url('alliance', 987, size=256)
         )
 
 
@@ -456,7 +363,6 @@ class EveAllianceTestCase(TestCase):
         # potential bug
         # update_alliance() is only updateting executor_corp_id when object is given
 
-
     def test_update_alliance_wo_object(self):
         mock_EveAllianceProviderManager = Mock()
         mock_EveAllianceProviderManager.get_alliance.return_value = \
@@ -475,11 +381,11 @@ class EveAllianceTestCase(TestCase):
         )
         my_alliance.provider = mock_EveAllianceProviderManager
         my_alliance.save()
-        updated_alliance = Alliance(                
+        Alliance(                
-                name='Dummy Alliance 2',
+            name='Dummy Alliance 2',
-                corp_ids=[2004],                
+            corp_ids=[2004],                
-                executor_corp_id=2004
+            executor_corp_id=2004
-            )
+        )
         my_alliance.update_alliance()
         my_alliance.refresh_from_db()
         self.assertEqual(int(my_alliance.executor_corp_id), 2004)
@@ -487,23 +393,22 @@ class EveAllianceTestCase(TestCase):
         # potential bug
         # update_alliance() is only updateting executor_corp_id nothing else ???
 
-
     def test_image_url(self):
         self.assertEqual(
             EveAllianceInfo.generic_logo_url(42),
-            _eve_entity_image_url('alliance', 42)
+            eveimageserver._eve_entity_image_url('alliance', 42)
         )
         self.assertEqual(
             EveAllianceInfo.generic_logo_url(42, 256),
-            _eve_entity_image_url('alliance', 42, 256)
+            eveimageserver._eve_entity_image_url('alliance', 42, 256)
         )
 
     def test_logo_url(self):
         x = EveAllianceInfo(
-            alliance_id='42',
+            alliance_id=42,
             alliance_name='alliance.name',
             alliance_ticker='ABC',
-            executor_corp_id='123'
+            executor_corp_id=123
         )
         self.assertEqual(
             x.logo_url(),
@@ -563,9 +468,7 @@ class EveCorporationTestCase(TestCase):
     
     def test_update_corporation_no_object_w_alliance(self):
         mock_provider = Mock()
-        mock_provider.get_corporation.return_value =  Corporation(
+        mock_provider.get_corporation.return_value = Corporation(members=87)
-            members=87
-        )
         self.my_corp.provider = mock_provider
         
         self.my_corp.update_corporation()
@@ -585,15 +488,14 @@ class EveCorporationTestCase(TestCase):
         self.assertEqual(my_corp2.member_count, 8)
         self.assertIsNone(my_corp2.alliance)
 
-
     def test_image_url(self):
         self.assertEqual(
             EveCorporationInfo.generic_logo_url(42),
-            _eve_entity_image_url('corporation', 42)
+            eveimageserver._eve_entity_image_url('corporation', 42)
         )
         self.assertEqual(
             EveCorporationInfo.generic_logo_url(42, 256),
-            _eve_entity_image_url('corporation', 42, 256)
+            eveimageserver._eve_entity_image_url('corporation', 42, 256)
         )
 
     def test_logo_url(self):        
@@ -621,4 +523,3 @@ class EveCorporationTestCase(TestCase):
             self.my_corp.logo_url_256,
             'https://images.evetech.net/corporations/2001/logo?size=256'
         )
-        

allianceauth/eveonline/tests/test_providers.py

@@ -1,21 +1,28 @@
 import os
 from unittest.mock import Mock, patch
 
-from bravado.exception import HTTPNotFound, HTTPUnprocessableEntity
+from bravado.exception import HTTPNotFound
 from jsonschema.exceptions import RefResolutionError
 
 from django.test import TestCase
 
 from . import set_logger
-from ..models import EveCharacter, EveCorporationInfo, EveAllianceInfo
+from ..providers import (
-from ..providers import ObjectNotFound, Entity, Character, Corporation, \
+    ObjectNotFound, 
-    Alliance, ItemType, EveProvider, EveSwaggerProvider
+    Entity, 
+    Character, 
+    Corporation, 
+    Alliance, 
+    ItemType, 
+    EveProvider, 
+    EveSwaggerProvider
+)
 
 
 MODULE_PATH = 'allianceauth.eveonline.providers'
 SWAGGER_OLD_SPEC_PATH = os.path.join(os.path.dirname(
-        os.path.abspath(__file__)), 'swagger_old.json'
+    os.path.abspath(__file__)), 'swagger_old.json'
-    )
+)
 set_logger(MODULE_PATH, __file__)
 
 
@@ -51,7 +58,6 @@ class TestEntity(TestCase):
         x = Entity()
         self.assertEqual(repr(x), '<Entity (None): None>')
 
-    
     def test_bool(self):
         x = Entity(1001)
         self.assertTrue(bool(x))
@@ -99,7 +105,6 @@ class TestCorporation(TestCase):
         # should fetch alliance once only
         self.assertEqual(mock_provider_get_alliance.call_count, 1)
 
-
     @patch(MODULE_PATH + '.EveSwaggerProvider.get_alliance')
     def test_alliance_not_defined(self, mock_provider_get_alliance):        
         mock_provider_get_alliance.return_value = None
@@ -110,7 +115,6 @@ class TestCorporation(TestCase):
             Entity(None, None)
         )
         
-
     @patch(MODULE_PATH + '.EveSwaggerProvider.get_character')
     def test_ceo(self, mock_provider_get_character):        
         my_ceo = Character(
@@ -200,7 +204,6 @@ class TestAlliance(TestCase):
         # should be called once by used corp only
         self.assertEqual(mock_provider_get_corp.call_count, 2)
 
-
     @patch(MODULE_PATH + '.EveSwaggerProvider.get_corp')
     def test_corps(self, mock_provider_get_corp):
         mock_provider_get_corp.side_effect = TestAlliance._get_corp
@@ -254,7 +257,6 @@ class TestCharacter(TestCase):
         # should call the provider one time only
         self.assertEqual(mock_provider_get_corp.call_count, 1)
     
-    
     @patch(MODULE_PATH + '.EveSwaggerProvider.get_alliance')
     @patch(MODULE_PATH + '.EveSwaggerProvider.get_corp')
     def test_alliance_has_one(
@@ -283,7 +285,6 @@ class TestCharacter(TestCase):
         self.assertEqual(mock_provider_get_corp.call_count, 1)
         self.assertEqual(mock_provider_get_alliance.call_count, 1)
 
-
     def test_alliance_has_none(self):
         self.my_character.alliance_id = None
         self.assertEqual(self.my_character.alliance, Entity(None, None))
@@ -343,7 +344,6 @@ class TestEveSwaggerProvider(TestCase):
         else:
             raise HTTPNotFound(Mock())
 
-
     @staticmethod
     def esi_get_alliances_alliance_id_corporations(alliance_id):
         alliances = {
@@ -357,7 +357,6 @@ class TestEveSwaggerProvider(TestCase):
         else:
             raise HTTPNotFound(Mock())
 
-
     @staticmethod
     def esi_get_corporations_corporation_id(corporation_id):
         corporations = {
@@ -382,7 +381,6 @@ class TestEveSwaggerProvider(TestCase):
         else:
             raise HTTPNotFound(Mock())
 
-
     @staticmethod
     def esi_get_characters_character_id(character_id):
         characters = {
@@ -403,7 +401,6 @@ class TestEveSwaggerProvider(TestCase):
         else:
             raise HTTPNotFound(Mock())
 
-
     @staticmethod
     def esi_post_characters_affiliation(characters):
         character_data = {
@@ -428,7 +425,6 @@ class TestEveSwaggerProvider(TestCase):
         else:
             raise TypeError()
     
-
     @staticmethod
     def esi_get_universe_types_type_id(type_id):
         types = {
@@ -446,13 +442,11 @@ class TestEveSwaggerProvider(TestCase):
         else:
             raise HTTPNotFound(Mock())
 
-
     @patch(MODULE_PATH + '.esi_client_factory')
     def test_str(self, mock_esi_client_factory):        
         my_provider = EveSwaggerProvider()
         self.assertEqual(str(my_provider), 'esi')
 
-
     @patch(MODULE_PATH + '.esi_client_factory')
     def test_get_alliance(self, mock_esi_client_factory):
         mock_esi_client_factory.return_value\
@@ -481,7 +475,6 @@ class TestEveSwaggerProvider(TestCase):
         with self.assertRaises(ObjectNotFound):
             my_provider.get_alliance(3999)
 
-
     @patch(MODULE_PATH + '.esi_client_factory')
     def test_get_corp(self, mock_esi_client_factory):
         mock_esi_client_factory.return_value\
@@ -508,7 +501,6 @@ class TestEveSwaggerProvider(TestCase):
         with self.assertRaises(ObjectNotFound):
             my_provider.get_corp(2999)
         
-
     @patch(MODULE_PATH + '.esi_client_factory')
     def test_get_character(self, mock_esi_client_factory):
         mock_esi_client_factory.return_value\
@@ -536,7 +528,6 @@ class TestEveSwaggerProvider(TestCase):
         with self.assertRaises(ObjectNotFound):
             my_provider.get_character(1999)
 
-
     @patch(MODULE_PATH + '.esi_client_factory')
     def test_get_itemtype(self, mock_esi_client_factory):
         mock_esi_client_factory.return_value\
@@ -601,5 +592,3 @@ class TestEveSwaggerProvider(TestCase):
         self.assertTrue(mock_esi_client_factory.called)
         self.assertIsNotNone(my_provider._client)
         self.assertEqual(my_client, 'my_client')
-        
-

allianceauth/eveonline/tests/test_tasks.py

@@ -1,10 +1,14 @@
-from unittest.mock import patch, Mock
+from unittest.mock import patch
 
 from django.test import TestCase
 
 from ..models import EveCharacter, EveCorporationInfo, EveAllianceInfo
-from ..tasks import update_alliance, update_corp, update_character, \
+from ..tasks import (
+    update_alliance, 
+    update_corp, 
+    update_character, 
     run_model_update
+)
 
 
 class TestTasks(TestCase):
@@ -13,42 +17,33 @@ class TestTasks(TestCase):
     def test_update_corp(self, mock_EveCorporationInfo):
         update_corp(42)
         self.assertEqual(
-            mock_EveCorporationInfo.objects.update_corporation.call_count,
+            mock_EveCorporationInfo.objects.update_corporation.call_count, 1
-            1
         )
         self.assertEqual(
-            mock_EveCorporationInfo.objects.update_corporation.call_args[0][0], 
+            mock_EveCorporationInfo.objects.update_corporation.call_args[0][0], 42
-            42
         )
             
-    
     @patch('allianceauth.eveonline.tasks.EveAllianceInfo')
     def test_update_alliance(self, mock_EveAllianceInfo):
         update_alliance(42)
         self.assertEqual(
-            mock_EveAllianceInfo.objects.update_alliance.call_args[0][0], 
+            mock_EveAllianceInfo.objects.update_alliance.call_args[0][0], 42
-            42
         )
         self.assertEqual(
-            mock_EveAllianceInfo.objects\
+            mock_EveAllianceInfo.objects
-                .update_alliance.return_value.populate_alliance.call_count, 
+            .update_alliance.return_value.populate_alliance.call_count, 1
-            1
         )
 
-
     @patch('allianceauth.eveonline.tasks.EveCharacter')
     def test_update_character(self, mock_EveCharacter):
         update_character(42)
         self.assertEqual(
-            mock_EveCharacter.objects.update_character.call_count,
+            mock_EveCharacter.objects.update_character.call_count, 1
-            1
         )
         self.assertEqual(
-            mock_EveCharacter.objects.update_character.call_args[0][0], 
+            mock_EveCharacter.objects.update_character.call_args[0][0], 42
-            42
         )
 
-    
     @patch('allianceauth.eveonline.tasks.update_character')
     @patch('allianceauth.eveonline.tasks.update_alliance')
     @patch('allianceauth.eveonline.tasks.update_corp')
@@ -63,25 +58,25 @@ class TestTasks(TestCase):
         EveCharacter.objects.all().delete()
 
         EveCorporationInfo.objects.create(
-            corporation_id='2345',
+            corporation_id=2345,
             corporation_name='corp.name',
             corporation_ticker='corp.ticker',
             member_count=10,
             alliance=None,
         )
         EveAllianceInfo.objects.create(
-            alliance_id='3456',
+            alliance_id=3456,
             alliance_name='alliance.name',
             alliance_ticker='alliance.ticker',
-            executor_corp_id='alliance.executor_corp_id',
+            executor_corp_id='78910',
         )
         EveCharacter.objects.create(
-            character_id='1234',
+            character_id=1234,
             character_name='character.name',
-            corporation_id='character.corp.id',
+            corporation_id=2345,
             corporation_name='character.corp.name',
             corporation_ticker='c.c.t',  # max 5 chars 
-            alliance_id='character.alliance.id',
+            alliance_id=3456,
             alliance_name='character.alliance.name',
         )
 
@@ -89,22 +84,15 @@ class TestTasks(TestCase):
 
         self.assertEqual(mock_update_corp.apply_async.call_count, 1)
         self.assertEqual(
-            int(mock_update_corp.apply_async.call_args[1]['args'][0]), 
+            int(mock_update_corp.apply_async.call_args[1]['args'][0]), 2345
-            2345
         )
         
         self.assertEqual(mock_update_alliance.apply_async.call_count, 1)
         self.assertEqual(
-            int(mock_update_alliance.apply_async.call_args[1]['args'][0]), 
+            int(mock_update_alliance.apply_async.call_args[1]['args'][0]), 3456
-            3456
         )
         
         self.assertEqual(mock_update_character.apply_async.call_count, 1)
         self.assertEqual(
-            int(mock_update_character.apply_async.call_args[1]['args'][0]), 
+            int(mock_update_character.apply_async.call_args[1]['args'][0]), 1234
-            1234
         )
-
-
-
-    

allianceauth/fleetactivitytracking/auth_hooks.py

@@ -6,7 +6,7 @@ from allianceauth.services.hooks import MenuItemHook, UrlHook
 
 @hooks.register('menu_item_hook')
 def register_menu():
-    return MenuItemHook(_('Fleet Activity Tracking'), 'fa fa-users fa-lightbulb-o fa-fw', 'fatlink:view',
+    return MenuItemHook(_('Fleet Activity Tracking'), 'fas fa-users fa-fw', 'fatlink:view',
                         navactive=['fatlink:'])
 
 

allianceauth/groupmanagement/context_processors.py

@@ -1,5 +0,0 @@
-from allianceauth.groupmanagement.managers import GroupManager
-
-
-def can_manage_groups(request):
-    return {'can_manage_groups': GroupManager.can_manage_groups(request.user)}

allianceauth/groupmanagement/templates/groupmanagement/audit.html

@@ -33,7 +33,7 @@
                             <tbody>
                                 {% for entry in entries %}
                                     <tr>
-                                        <td class="text-center">{{ entry.date }}</td>
+                                        <td class="text-center">{{ entry.date|date:"Y-M-d H:i" }}</td>
                                         <td class="text-center">{{ entry.requestor }}</td>
                                         <td class="text-center">{{ entry.req_char }}</td>
                                         <td class="text-center">{{ entry.req_char.corporation_name }}</td>

allianceauth/groupmanagement/templates/groupmanagement/groupmembers.html

@@ -36,7 +36,7 @@
                                     <tr>                                                                
                                         <td class="text-right">
                                             {% if member.is_leader %}
-                                                <i class="fa fa-star"></i>&nbsp;
+                                                <i class="fas fa-star"></i>&nbsp;
                                             {% endif %}
                                             <img src="{{ member.main_char|character_portrait_url:32 }}" class="img-circle">                                            
                                         </td>
@@ -69,7 +69,7 @@
                                 {% endfor %}
                             </tbody>
                         </table>
-                        <p class="text-muted"><i class="fa fa-star"></i>: Group leader</p>
+                        <p class="text-muted"><i class="fas fa-star"></i>: Group leader</p>
                     </div>
                 {% else %}
                     <div class="alert alert-warning text-center">

allianceauth/groupmanagement/templates/groupmanagement/groupmembership.html

@@ -53,6 +53,10 @@
                                             <a href="{% url "groupmanagement:audit_log" group.id %}" class="btn btn-info" title="{% trans "Audit Members" %}">
                                                 <i class="glyphicon glyphicon-list-alt"></i>
                                             </a>
+                                            <a id="clipboard-copy" data-clipboard-text="{{ request.scheme }}://{{request.get_host}}{% url 'groupmanagement:request_add' group.id %}" class="btn btn-warning" title="{% trans "Copy Direct Join Link" %}">
+                                                <i class="glyphicon glyphicon-copy"></i>
+                                            </a>
+
                                         </td>
                                     </tr>
                                 {% endfor %}
@@ -68,3 +72,9 @@
         </div>
     </div>
 {% endblock content %}
+{% block extra_javascript %}    
+<script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.4/clipboard.min.js"></script>
+<script>
+    new ClipboardJS('#clipboard-copy');
+</script>
+{% endblock %}

allianceauth/groupmanagement/templates/groupmanagement/index.html

@@ -20,8 +20,22 @@
         {% include 'groupmanagement/menu.html' %}
         
         <ul class="nav nav-tabs">
-            <li class="active"><a data-toggle="tab" href="#add">{% trans "Join Requests" %}</a></li>
+            <li class="active">
-            <li><a data-toggle="tab" href="#leave">{% trans "Leave Requests" %}</a></li>
+                <a data-toggle="tab" href="#add">
+                    {% trans "Join Requests" %} 
+                    {% if acceptrequests %}
+                        <span class="badge">{{ acceptrequests|length }}</span>
+                    {% endif %}
+                </a>
+            </li>
+            <li>
+                <a data-toggle="tab" href="#leave">
+                    {% trans "Leave Requests" %}
+                    {% if leaverequests %}
+                        <span class="badge">{{ leaverequests|length }}</span>
+                    {% endif %}
+                </a>
+            </li>
         </ul>
         
         <div class="tab-content">

allianceauth/groupmanagement/templatetags/groupmanagement.py

@@ -0,0 +1,15 @@
+from django import template
+from django.contrib.auth.models import User
+
+from allianceauth.groupmanagement.managers import GroupManager
+
+
+register = template.Library()
+
+
+@register.filter
+def can_manage_groups(user: User) -> bool:
+    """returns True if the given user can manage groups. Returns False otherwise."""
+    if not isinstance(user, User):
+        return False
+    return GroupManager.can_manage_groups(user)

allianceauth/groupmanagement/tests/test_admin.py

@@ -11,11 +11,7 @@ from allianceauth.eveonline.models import (
     EveCharacter, EveCorporationInfo, EveAllianceInfo
 )
 
-from ..admin import (   
+from ..admin import HasLeaderFilter, GroupAdmin, Group
-   HasLeaderFilter,
-   GroupAdmin,   
-   Group
-)
 from . import get_admin_change_view_url
 
 if 'allianceauth.eveonline.autogroups' in settings.INSTALLED_APPS:
@@ -88,33 +84,33 @@ class TestGroupAdmin(TestCase):
         
         # user 1 - corp and alliance, normal user
         cls.character_1 = EveCharacter.objects.create(
-            character_id='1001',
+            character_id=1001,
             character_name='Bruce Wayne',
-            corporation_id='2001',
+            corporation_id=2001,
             corporation_name='Wayne Technologies',
             corporation_ticker='WT',
-            alliance_id='3001',
+            alliance_id=3001,
             alliance_name='Wayne Enterprises',
             alliance_ticker='WE',
         )
         cls.character_1a = EveCharacter.objects.create(
-            character_id='1002',
+            character_id=1002,
             character_name='Batman',
-            corporation_id='2001',
+            corporation_id=2001,
             corporation_name='Wayne Technologies',
             corporation_ticker='WT',
-            alliance_id='3001',
+            alliance_id=3001,
             alliance_name='Wayne Enterprises',
             alliance_ticker='WE',
         )
         alliance = EveAllianceInfo.objects.create(
-            alliance_id='3001',
+            alliance_id=3001,
             alliance_name='Wayne Enterprises',
             alliance_ticker='WE',            
-            executor_corp_id='2001'
+            executor_corp_id=2001
         )
         EveCorporationInfo.objects.create(
-            corporation_id='2001',
+            corporation_id=2001,
             corporation_name='Wayne Technologies',
             corporation_ticker='WT',            
             member_count=42,
@@ -189,10 +185,10 @@ class TestGroupAdmin(TestCase):
             alliance=None
         )
         EveAllianceInfo.objects.create(
-            alliance_id='3101',
+            alliance_id=3101,
             alliance_name='Lex World Domination',
             alliance_ticker='LWD',
-            executor_corp_id=''
+            executor_corp_id=2101
         )
         cls.user_3 = User.objects.create_user(
             cls.character_3.character_name.replace(' ', '_'),
@@ -219,8 +215,8 @@ class TestGroupAdmin(TestCase):
         """create autogroups for corps and alliances"""
         if _has_auto_groups:
             autogroups_config = AutogroupsConfig(
-                corp_groups = True,
+                corp_groups=True,
-                alliance_groups = True
+                alliance_groups=True
             )
             autogroups_config.save()
             for state in State.objects.all():
@@ -277,7 +273,7 @@ class TestGroupAdmin(TestCase):
 
     if _has_auto_groups:
         @patch(MODULE_PATH + '._has_auto_groups', True)
-        def test_properties_6(self):
+        def test_properties_7(self):
             self._create_autogroups()
             expected = ['Auto Group']
             my_group = Group.objects\
@@ -337,8 +333,8 @@ class TestGroupAdmin(TestCase):
             changelist = my_modeladmin.get_changelist_instance(request)
             queryset = changelist.get_queryset(request)
             expected = Group.objects.exclude(
-                        managedalliancegroup__isnull=True, 
+                managedalliancegroup__isnull=True, 
-                        managedcorpgroup__isnull=True
+                managedcorpgroup__isnull=True
             )
             self.assertSetEqual(set(queryset), set(expected))
          

allianceauth/groupmanagement/tests/test_templatetags.py

@@ -0,0 +1,27 @@
+from unittest.mock import patch
+
+from django.test import TestCase
+from allianceauth.tests.auth_utils import AuthUtils
+
+from ..templatetags.groupmanagement import can_manage_groups
+
+MODULE_PATH = 'allianceauth.groupmanagement.templatetags.groupmanagement'
+
+
+@patch(MODULE_PATH + '.GroupManager.can_manage_groups')
+class TestCanManageGroups(TestCase):
+        
+    def setUp(self):        
+        self.user = AuthUtils.create_user('Bruce Wayne')
+
+    def test_return_normal_result(self, mock_can_manage_groups):
+        mock_can_manage_groups.return_value = True
+
+        self.assertTrue(can_manage_groups(self.user))
+        self.assertTrue(mock_can_manage_groups.called)
+        
+    def test_return_false_if_not_user(self, mock_can_manage_groups):
+        mock_can_manage_groups.return_value = True
+
+        self.assertFalse(can_manage_groups('invalid'))
+        self.assertFalse(mock_can_manage_groups.called)

allianceauth/groupmanagement/views.py

@@ -6,7 +6,6 @@ from django.contrib.auth.decorators import login_required
 from django.contrib.auth.decorators import user_passes_test
 from django.contrib.auth.models import Group
 from django.core.exceptions import ObjectDoesNotExist, PermissionDenied
-from django.core.paginator import Paginator, EmptyPage
 from django.db.models import Count
 from django.http import Http404
 from django.shortcuts import render, redirect, get_object_or_404
@@ -28,7 +27,7 @@ def group_management(request):
     acceptrequests = []
     leaverequests = []
 
-    base_group_query = GroupRequest.objects.select_related('user', 'group')
+    base_group_query = GroupRequest.objects.select_related('user', 'group', 'user__profile__main_character')
     if GroupManager.has_management_permission(request.user):
         # Full access
         group_requests = base_group_query.all()
@@ -76,7 +75,6 @@ def group_membership_audit(request, group_id):
     logger.debug("group_management_audit called by user %s" % request.user)
     group = get_object_or_404(Group, id=group_id)
     try:
-
         # Check its a joinable group i.e. not corp or internal
         # And the user has permission to manage it
         if not GroupManager.check_internal_group(group) or not GroupManager.can_manage_group(request.user, group):
@@ -93,8 +91,6 @@ def group_membership_audit(request, group_id):
     return render(request, 'groupmanagement/audit.html', context=render_items)
 
 
-
-
 @login_required
 @user_passes_test(GroupManager.can_manage_groups)
 def group_membership_list(request, group_id):
@@ -124,7 +120,7 @@ def group_membership_list(request, group_id):
     for member in \
         group.user_set\
             .all()\
-            .select_related('profile')\
+            .select_related('profile', 'profile__main_character')\
             .order_by('profile__main_character__character_name'):
 
         members.append({

allianceauth/hrapplications/auth_hooks.py

@@ -8,7 +8,7 @@ class ApplicationsMenu(MenuItemHook):
     def __init__(self):
         MenuItemHook.__init__(self,
                               _('Applications'),
-                              'fa fa-file-o fa-fw',
+                              'far fa-file fa-fw',
                               'hrapplications:index',
                               navactive=['hrapplications:'])
 

allianceauth/locale/de/LC_MESSAGES/django.po

@@ -13,7 +13,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: PACKAGE VERSION\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2020-04-02 03:23+0000\n"
+"POT-Creation-Date: 2020-05-08 00:57+0000\n"
 "PO-Revision-Date: 2020-02-18 03:14+0000\n"
 "Last-Translator: Rounon Dax <rounon.dax@terra-nanotech.de>, 2020\n"
 "Language-Team: German (https://www.transifex.com/alliance-auth/teams/107430/de/)\n"
@@ -657,7 +657,11 @@ msgstr "Mitglieder ansehen"
 msgid "Audit Members"
 msgstr "Mitglieder Protokoll"
 
-#: allianceauth/groupmanagement/templates/groupmanagement/groupmembership.html:64
+#: allianceauth/groupmanagement/templates/groupmanagement/groupmembership.html:56
+msgid "Copy Direrct Join Link"
+msgstr ""
+
+#: allianceauth/groupmanagement/templates/groupmanagement/groupmembership.html:68
 msgid "No groups to list."
 msgstr "Keine Gruppen vorhanden."
 
@@ -1177,7 +1181,7 @@ msgstr "Änderungen für Operation timer %(opname)s gespeichert."
 #: allianceauth/permissions_tool/templates/permissions_tool/audit.html:6
 #: allianceauth/permissions_tool/templates/permissions_tool/audit.html:10
 msgid "Permissions Audit"
-msgstr "Berechtigungsprüfung"
+msgstr "Berechtigungsübersicht"
 
 #: allianceauth/permissions_tool/templates/permissions_tool/audit.html:22
 msgid "User / Character"
@@ -1912,12 +1916,6 @@ msgid_plural "%(tasks)s tasks"
 msgstr[0] "%(tasks)sAufgabe"
 msgstr[1] "%(tasks)sAufgaben"
 
-#: allianceauth/templates/allianceauth/help.html:4
-#: allianceauth/templates/allianceauth/help.html:9
-#: allianceauth/templates/allianceauth/side-menu.html:34
-msgid "Help"
-msgstr "Hilfe"
-
 #: allianceauth/templates/allianceauth/night-toggle.html:3
 msgid "Night"
 msgstr "Nacht"

allianceauth/locale/en/LC_MESSAGES/django.po

@@ -8,7 +8,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: PACKAGE VERSION\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2020-04-02 03:23+0000\n"
+"POT-Creation-Date: 2020-05-08 00:57+0000\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <LL@li.org>\n"
@@ -642,7 +642,11 @@ msgstr ""
 msgid "Audit Members"
 msgstr ""
 
-#: allianceauth/groupmanagement/templates/groupmanagement/groupmembership.html:64
+#: allianceauth/groupmanagement/templates/groupmanagement/groupmembership.html:56
+msgid "Copy Direrct Join Link"
+msgstr ""
+
+#: allianceauth/groupmanagement/templates/groupmanagement/groupmembership.html:68
 msgid "No groups to list."
 msgstr ""
 
@@ -1876,12 +1880,6 @@ msgid_plural "%(tasks)s tasks"
 msgstr[0] ""
 msgstr[1] ""
 
-#: allianceauth/templates/allianceauth/help.html:4
-#: allianceauth/templates/allianceauth/help.html:9
-#: allianceauth/templates/allianceauth/side-menu.html:34
-msgid "Help"
-msgstr ""
-
 #: allianceauth/templates/allianceauth/night-toggle.html:3
 msgid "Night"
 msgstr ""

allianceauth/locale/es/LC_MESSAGES/django.po

@@ -12,7 +12,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: PACKAGE VERSION\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2020-03-26 03:07+0000\n"
+"POT-Creation-Date: 2020-05-08 00:57+0000\n"
 "PO-Revision-Date: 2020-02-18 03:14+0000\n"
 "Last-Translator: frank1210 <francolopez_16@hotmail.com>, 2020\n"
 "Language-Team: Spanish (https://www.transifex.com/alliance-auth/teams/107430/es/)\n"
@@ -653,7 +653,11 @@ msgstr "Ver Miembros"
 msgid "Audit Members"
 msgstr "Auditar Miembros"
 
-#: allianceauth/groupmanagement/templates/groupmanagement/groupmembership.html:64
+#: allianceauth/groupmanagement/templates/groupmanagement/groupmembership.html:56
+msgid "Copy Direrct Join Link"
+msgstr ""
+
+#: allianceauth/groupmanagement/templates/groupmanagement/groupmembership.html:68
 msgid "No groups to list."
 msgstr "No hay grupos para listar"
 
@@ -785,21 +789,21 @@ msgid "Rejected application from %(mainchar)s to leave %(group)s."
 msgstr ""
 "Se rechazo la solicitud de %(mainchar)s para dejar el grupo %(group)s."
 
-#: allianceauth/groupmanagement/views.py:347
+#: allianceauth/groupmanagement/views.py:346
-#: allianceauth/groupmanagement/views.py:359
+#: allianceauth/groupmanagement/views.py:358
 msgid "You cannot join that group"
 msgstr "No puedes unirte a ese grupo"
 
-#: allianceauth/groupmanagement/views.py:353
+#: allianceauth/groupmanagement/views.py:352
 msgid "You are already a member of that group."
 msgstr ""
 
-#: allianceauth/groupmanagement/views.py:368
+#: allianceauth/groupmanagement/views.py:367
 msgid "You already have a pending application for that group."
 msgstr ""
 
-#: allianceauth/groupmanagement/views.py:371
+#: allianceauth/groupmanagement/views.py:370
-#: allianceauth/groupmanagement/views.py:409
+#: allianceauth/groupmanagement/views.py:408
 #: allianceauth/hrapplications/templates/hrapplications/management.html:37
 #: allianceauth/hrapplications/templates/hrapplications/management.html:72
 #: allianceauth/hrapplications/templates/hrapplications/management.html:99
@@ -811,24 +815,24 @@ msgstr ""
 msgid "Pending"
 msgstr "Pendiente"
 
-#: allianceauth/groupmanagement/views.py:377
+#: allianceauth/groupmanagement/views.py:376
 #, python-format
 msgid "Applied to group %(group)s."
 msgstr "Solicitud enviada al grupo %(group)s."
 
-#: allianceauth/groupmanagement/views.py:388
+#: allianceauth/groupmanagement/views.py:387
 msgid "You cannot leave that group"
 msgstr "No puedes dejar el grupos"
 
-#: allianceauth/groupmanagement/views.py:393
+#: allianceauth/groupmanagement/views.py:392
 msgid "You are not a member of that group"
 msgstr "No eres miembro de ese grupo"
 
-#: allianceauth/groupmanagement/views.py:402
+#: allianceauth/groupmanagement/views.py:401
 msgid "You already have a pending leave request for that group."
 msgstr ""
 
-#: allianceauth/groupmanagement/views.py:415
+#: allianceauth/groupmanagement/views.py:414
 #, python-format
 msgid "Applied to leave group %(group)s."
 msgstr "Solicitaste dejar el grupo %(group)s."
@@ -1894,12 +1898,6 @@ msgid_plural "%(tasks)s tasks"
 msgstr[0] ""
 msgstr[1] ""
 
-#: allianceauth/templates/allianceauth/help.html:4
-#: allianceauth/templates/allianceauth/help.html:9
-#: allianceauth/templates/allianceauth/side-menu.html:34
-msgid "Help"
-msgstr "Ayuda"
-
 #: allianceauth/templates/allianceauth/night-toggle.html:3
 msgid "Night"
 msgstr "Noche"

allianceauth/locale/ru/LC_MESSAGES/django.po

@@ -11,7 +11,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: PACKAGE VERSION\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2020-03-26 03:07+0000\n"
+"POT-Creation-Date: 2020-05-08 00:57+0000\n"
 "PO-Revision-Date: 2020-02-18 03:14+0000\n"
 "Last-Translator: Alexander Gess <de.alex.gess@gmail.com>, 2020\n"
 "Language-Team: Russian (https://www.transifex.com/alliance-auth/teams/107430/ru/)\n"
@@ -651,7 +651,11 @@ msgstr "Посмотреть участников"
 msgid "Audit Members"
 msgstr "Проверить участников"
 
-#: allianceauth/groupmanagement/templates/groupmanagement/groupmembership.html:64
+#: allianceauth/groupmanagement/templates/groupmanagement/groupmembership.html:56
+msgid "Copy Direrct Join Link"
+msgstr ""
+
+#: allianceauth/groupmanagement/templates/groupmanagement/groupmembership.html:68
 msgid "No groups to list."
 msgstr "Нет групп в списке"
 
@@ -782,21 +786,21 @@ msgstr ""
 msgid "Rejected application from %(mainchar)s to leave %(group)s."
 msgstr "Прошение об исключении %(mainchar)s из %(group)s – отклонено. "
 
-#: allianceauth/groupmanagement/views.py:347
+#: allianceauth/groupmanagement/views.py:346
-#: allianceauth/groupmanagement/views.py:359
+#: allianceauth/groupmanagement/views.py:358
 msgid "You cannot join that group"
 msgstr "Вы не можете вступить"
 
-#: allianceauth/groupmanagement/views.py:353
+#: allianceauth/groupmanagement/views.py:352
 msgid "You are already a member of that group."
 msgstr ""
 
-#: allianceauth/groupmanagement/views.py:368
+#: allianceauth/groupmanagement/views.py:367
 msgid "You already have a pending application for that group."
 msgstr ""
 
-#: allianceauth/groupmanagement/views.py:371
+#: allianceauth/groupmanagement/views.py:370
-#: allianceauth/groupmanagement/views.py:409
+#: allianceauth/groupmanagement/views.py:408
 #: allianceauth/hrapplications/templates/hrapplications/management.html:37
 #: allianceauth/hrapplications/templates/hrapplications/management.html:72
 #: allianceauth/hrapplications/templates/hrapplications/management.html:99
@@ -808,24 +812,24 @@ msgstr ""
 msgid "Pending"
 msgstr "Ожидание"
 
-#: allianceauth/groupmanagement/views.py:377
+#: allianceauth/groupmanagement/views.py:376
 #, python-format
 msgid "Applied to group %(group)s."
 msgstr "Вступить в группу %(group)s."
 
-#: allianceauth/groupmanagement/views.py:388
+#: allianceauth/groupmanagement/views.py:387
 msgid "You cannot leave that group"
 msgstr "Вы не можете покинуть эту группу"
 
-#: allianceauth/groupmanagement/views.py:393
+#: allianceauth/groupmanagement/views.py:392
 msgid "You are not a member of that group"
 msgstr "Вы не участник группыы"
 
-#: allianceauth/groupmanagement/views.py:402
+#: allianceauth/groupmanagement/views.py:401
 msgid "You already have a pending leave request for that group."
 msgstr ""
 
-#: allianceauth/groupmanagement/views.py:415
+#: allianceauth/groupmanagement/views.py:414
 #, python-format
 msgid "Applied to leave group %(group)s."
 msgstr "Запрос на выход из группы %(group)s."
@@ -1896,12 +1900,6 @@ msgstr[1] "%(tasks)s задач"
 msgstr[2] "%(tasks)s задач"
 msgstr[3] "%(tasks)s задач"
 
-#: allianceauth/templates/allianceauth/help.html:4
-#: allianceauth/templates/allianceauth/help.html:9
-#: allianceauth/templates/allianceauth/side-menu.html:34
-msgid "Help"
-msgstr "Помощь"
-
 #: allianceauth/templates/allianceauth/night-toggle.html:3
 msgid "Night"
 msgstr "Ночь"

allianceauth/notifications/context_processors.py

@@ -1,5 +1,11 @@
 from .models import Notification
-
+from django.core.cache import cache
 
 def user_notification_count(request):
-    return {'notifications': len(Notification.objects.filter(user__id=request.user.id).filter(viewed=False))}
+    user_id = request.user.id
+    notification_count = cache.get("u-note:{}".format(user_id), -1)
+    if notification_count<0:
+        notification_count = Notification.objects.filter(user__id=user_id).filter(viewed=False).count()
+        cache.set("u-note:{}".format(user_id),notification_count,5)
+
+    return {'notifications': notification_count}

allianceauth/notifications/tests.py

@@ -1 +0,0 @@
-# Create your tests here.

allianceauth/notifications/tests/test_processors.py

@@ -0,0 +1,76 @@
+from unittest import mock
+from django.test import TestCase
+from allianceauth.notifications.context_processors import user_notification_count
+from allianceauth.tests.auth_utils import AuthUtils
+from django.core.cache import cache
+from allianceauth.notifications.models import Notification
+
+class TestNotificationCount(TestCase):
+
+    @classmethod
+    def setUpTestData(cls):
+        cls.user = AuthUtils.create_user('magic_mike')
+        AuthUtils.add_main_character(cls.user, 'Magic Mike', '1', corp_id='2', corp_name='Pole Riders', corp_ticker='PRIDE', alliance_id='3', alliance_name='RIDERS')
+        cls.user.profile.refresh_from_db()
+
+        ### test notifications for mike
+        Notification.objects.all().delete()
+        Notification.objects.create(user=cls.user,
+                                    level="INFO",
+                                    title="Job 1 Failed",
+                                    message="Because it was broken",
+                                    viewed=True)
+        Notification.objects.create(user=cls.user,
+                                    level="INFO",
+                                    title="Job 2 Failed",
+                                    message="Because it was broken")
+        Notification.objects.create(user=cls.user,
+                                    level="INFO",
+                                    title="Job 3 Failed",
+                                    message="Because it was broken")
+        Notification.objects.create(user=cls.user,
+                                    level="INFO",
+                                    title="Job 4 Failed",
+                                    message="Because it was broken")
+        Notification.objects.create(user=cls.user,
+                                    level="INFO",
+                                    title="Job 5 Failed",
+                                    message="Because it was broken")
+        Notification.objects.create(user=cls.user,
+                                    level="INFO",
+                                    title="Job 6 Failed",
+                                    message="Because it was broken")
+
+        cls.user2 = AuthUtils.create_user('teh_kid')
+        AuthUtils.add_main_character(cls.user, 'The Kid', '2', corp_id='2', corp_name='Pole Riders', corp_ticker='PRIDE', alliance_id='3', alliance_name='RIDERS')
+        cls.user2.profile.refresh_from_db()
+
+        # Noitification for kid
+        Notification.objects.create(user=cls.user2,
+                                    level="INFO",
+                                    title="Job 6 Failed",
+                                    message="Because it was broken")
+
+
+    def test_no_cache(self):
+        mock_req = mock.MagicMock()
+        mock_req.user.id = self.user.id
+
+        cache.delete("u-note:{}".format(self.user.id)) # force the db to be hit
+        context_dict = user_notification_count(mock_req)
+        self.assertIsInstance(context_dict, dict)
+        self.assertEqual(context_dict.get('notifications'), 5)  # 5 only
+
+
+    @mock.patch('allianceauth.notifications.models.Notification.objects')
+    def test_cache(self, mock_foo):
+        mock_foo.filter.return_value = mock_foo
+        mock_foo.count.return_value = 5
+        mock_req = mock.MagicMock()
+        mock_req.user.id = self.user.id
+
+        cache.set("u-note:{}".format(self.user.id),10,5)
+        context_dict = user_notification_count(mock_req)
+        self.assertIsInstance(context_dict, dict)
+        self.assertEqual(context_dict.get('notifications'), 10) # cached value
+        self.assertEqual(mock_foo.called, 0)  # ensure the DB was not hit

allianceauth/optimer/auth_hooks.py

@@ -7,7 +7,7 @@ from . import urls
 class OpTimerboardMenu(MenuItemHook):
     def __init__(self):
         MenuItemHook.__init__(self, _('Fleet Operations'),
-                              'fa fa-exclamation  fa-fw',
+                              'fas fa-exclamation  fa-fw',
                               'optimer:view',
                               navactive=['optimer:'])
 

allianceauth/permissions_tool/auth_hooks.py

@@ -8,7 +8,7 @@ class PermissionsTool(MenuItemHook):
     def __init__(self):
         MenuItemHook.__init__(self,
                               'Permissions Audit',
-                              'fa fa-key fa-id-card',
+                              'fas fa-id-card fa-fw',
                               'permissions_tool:overview',
                               order=400,
                               navactive=['permissions_tool:'])

allianceauth/permissions_tool/tests.py

@@ -41,7 +41,7 @@ class PermissionsToolViewsTestCase(WebTest):
         response_content = response.content.decode('utf-8')
 
         self.assertInHTML('<li><a class="active" href="/permissions/overview/">'
-                          '<i class="fa fa-key fa-id-card"></i> Permissions Audit</a></li>', response_content)
+                          '<i class="fas fa-id-card fa-fw"></i> Permissions Audit</a></li>', response_content)
 
     def test_permissions_overview(self):
         self.app.set_user(self.member)

allianceauth/project_template/project_name/settings/base.py

@@ -104,7 +104,6 @@ TEMPLATES = [
                 'django.template.context_processors.static',
                 'django.template.context_processors.tz',
                 'allianceauth.notifications.context_processors.user_notification_count',                
-                'allianceauth.groupmanagement.context_processors.can_manage_groups',
                 'allianceauth.context_processors.auth_settings',
             ],
         },
@@ -221,7 +220,7 @@ LOGGING = {
             'backupCount': 5,  # edit this line to change number of log backups
         },
         'extension_file': {
-            'level': 'DEBUG',
+            'level': 'INFO',
             'class': 'logging.handlers.RotatingFileHandler',
             'filename': os.path.join(BASE_DIR, 'log/extensions.log'),
             'formatter': 'verbose',

allianceauth/project_template/project_name/settings/local.py

@@ -22,6 +22,10 @@ INSTALLED_APPS += [
     
 ]
 
+# To change the logging level for extensions, uncomment the following line.
+# LOGGING['handlers']['extension_file']['level'] = 'DEBUG'
+
+
 # Enter credentials to use MySQL/MariaDB. Comment out to use sqlite3
 DATABASES['default'] = {
     'ENGINE': 'django.db.backends.mysql',

allianceauth/services/admin.py

@@ -1,14 +1,14 @@
 from django import forms
 from django.contrib import admin
-from django.db.models.functions import Lower
-from django.urls import reverse
-from django.utils.html import format_html
 
 from allianceauth import hooks
-from allianceauth.eveonline.models import EveCharacter
+from allianceauth.authentication.admin import (
-from allianceauth.authentication.admin import user_profile_pic, \
+    user_profile_pic, 
-    user_username, user_main_organization, MainCorporationsFilter,\
+    user_username, 
+    user_main_organization, 
+    MainCorporationsFilter,
     MainAllianceFilter
+)
 
 from .models import NameFormatConfig
 
@@ -26,15 +26,23 @@ class ServicesUserAdmin(admin.ModelAdmin):
     list_display = (
         user_profile_pic,
         user_username,
+        '_state',
         user_main_organization, 
         '_date_joined'
     )
     list_filter = (        
+        'user__profile__state',
         MainCorporationsFilter,        
         MainAllianceFilter,
-        'user__date_joined'
+        'user__date_joined',
     )
 
+    def _state(self, obj):
+        return obj.user.profile.state.name
+
+    _state.short_description = 'state'
+    _state.admin_order_field = 'user__profile__state__name'
+
     def _date_joined(self, obj):
         return obj.user.date_joined
     
@@ -45,7 +53,8 @@ class ServicesUserAdmin(admin.ModelAdmin):
 class NameFormatConfigForm(forms.ModelForm):
     def __init__(self, *args, **kwargs):
         super(NameFormatConfigForm, self).__init__(*args, **kwargs)
-        SERVICE_CHOICES = [(s.name, s.name) for h in hooks.get_hooks('services_hook') for s in [h()]]
+        SERVICE_CHOICES = \
+            [(s.name, s.name) for h in hooks.get_hooks('services_hook') for s in [h()]]
         if self.instance.id:
             current_choice = (self.instance.service_name, self.instance.service_name)
             if current_choice not in SERVICE_CHOICES:

allianceauth/services/auth_hooks.py

@@ -9,7 +9,7 @@ class Services(MenuItemHook):
     def __init__(self):
         MenuItemHook.__init__(self,
                               _('Services'),
-                              'fa fa-cogs fa-fw',
+                              'fas fa-cogs fa-fw',
                               'services:services', 100)
 
     def render(self, request):

allianceauth/services/hooks.py

@@ -14,20 +14,22 @@ def get_extension_logger(name):
     Takes the name of a plugin/extension and generates a child logger of the extensions logger
     to be used by the extension to log events to the extensions logger.
 
-    The logging level is decided by whether or not DEBUG is set to true in the project settings. If
+    The logging level is determined by the level defined for the parent logger.
-    DEBUG is set to false, then the logging level is set to INFO.
 
     :param: name: the name of the extension doing the logging
     :return: an extensions child logger
     """
+    if not isinstance(name, str):
+        raise TypeError(f"get_extension_logger takes an argument of type string."
+                        f"Instead received argument of type {type(name).__name__}.")
+
     import logging
-    from django.conf import settings
+
+    parent_logger = logging.getLogger('extensions')
 
     logger = logging.getLogger('extensions.' + name)
     logger.name = name
-    logger.level = logging.INFO
+    logger.level = parent_logger.level
-    if settings.DEBUG:
-        logger.level = logging.DEBUG
 
     return logger
 

allianceauth/services/modules/discord/__init__.py

@@ -1 +1,3 @@
-default_app_config = 'allianceauth.services.modules.discord.apps.DiscordServiceConfig'
+default_app_config = 'allianceauth.services.modules.discord.apps.DiscordServiceConfig'  # noqa
+
+__title__ = 'Discord Service'

allianceauth/services/modules/discord/admin.py

@@ -1,13 +1,22 @@
+import logging
+
 from django.contrib import admin
 
-from .models import DiscordUser
+from . import __title__
 from ...admin import ServicesUserAdmin
+from .models import DiscordUser
+from .utils import LoggerAddTag
+
+
+logger = LoggerAddTag(logging.getLogger(__name__), __title__)
 
 
 @admin.register(DiscordUser)
 class DiscordUserAdmin(ServicesUserAdmin):            
-    list_display = ServicesUserAdmin.list_display + ('_uid',)
+    search_fields = ServicesUserAdmin.search_fields + ('uid', 'username')
-    search_fields = ServicesUserAdmin.search_fields + ('uid', )
+    list_display = ServicesUserAdmin.list_display + ('activated', '_username', '_uid')
+    list_filter = ServicesUserAdmin.list_filter + ('activated',)
+    ordering = ('-activated',)
    
     def _uid(self, obj):
         return obj.uid
@@ -15,3 +24,11 @@ class DiscordUserAdmin(ServicesUserAdmin):
     _uid.short_description = 'Discord ID (UID)'
     _uid.admin_order_field = 'uid'
 
+    def _username(self, obj):
+        if obj.username and obj.discriminator:
+            return f'{obj.username}#{obj.discriminator}'
+        else:
+            return ''
+    
+    _username.short_description = 'Discord Username'
+    _username.admin_order_field = 'username'

allianceauth/services/modules/discord/app_settings.py

@@ -0,0 +1,17 @@
+from .utils import clean_setting
+
+
+DISCORD_APP_ID = clean_setting('DISCORD_APP_ID', '')
+DISCORD_APP_SECRET = clean_setting('DISCORD_APP_SECRET', '')
+DISCORD_BOT_TOKEN = clean_setting('DISCORD_BOT_TOKEN', '')
+DISCORD_CALLBACK_URL = clean_setting('DISCORD_CALLBACK_URL', '')
+DISCORD_GUILD_ID = clean_setting('DISCORD_GUILD_ID', '')
+
+# max retries of tasks after an error occurred
+DISCORD_TASKS_MAX_RETRIES = clean_setting('DISCORD_TASKS_MAX_RETRIES', 3)
+
+# Pause in seconds until next retry for tasks after the API returned an error
+DISCORD_TASKS_RETRY_PAUSE = clean_setting('DISCORD_TASKS_RETRY_PAUSE', 60)
+
+# automatically sync Discord users names to user's main character name when created
+DISCORD_SYNC_NAMES = clean_setting('DISCORD_SYNC_NAMES', False)

allianceauth/services/modules/discord/auth_hooks.py

@@ -1,17 +1,26 @@
 import logging
 
+from django.contrib.auth.models import User 
 from django.template.loader import render_to_string
-from django.conf import settings
 
 from allianceauth import hooks
 from allianceauth.services.hooks import ServicesHook
-from .tasks import DiscordTasks
-from .urls import urlpatterns
 
-logger = logging.getLogger(__name__)
+from .models import DiscordUser
+from .urls import urlpatterns
+from .utils import LoggerAddTag
+from . import tasks, __title__
+
+
+logger = LoggerAddTag(logging.getLogger(__name__), __title__)
+
+# Default priority for single tasks like update group and sync nickname
+SINGLE_TASK_PRIORITY = 3
 
 
 class DiscordService(ServicesHook):
+    """Service for managing a Discord server with Auth"""
+
     def __init__(self):
         ServicesHook.__init__(self)
         self.urlpatterns = urlpatterns
@@ -20,36 +29,90 @@ class DiscordService(ServicesHook):
         self.access_perm = 'discord.access_discord'
         self.name_format = '{character_name}'
 
-    def delete_user(self, user, notify_user=False):
+    def delete_user(self, user: User, notify_user: bool = False) -> None:
-        logger.debug('Deleting user %s %s account' % (user, self.name))
+        if self.user_has_account(user):
-        return DiscordTasks.delete_user(user, notify_user=notify_user)
+            logger.debug('Deleting user %s %s account', user, self.name)
+            tasks.delete_user.apply_async(
+                kwargs={'user_pk': user.pk}, priority=SINGLE_TASK_PRIORITY
+            )        
     
-    def update_groups(self, user):
+    def render_services_ctrl(self, request):                
-        logger.debug('Processing %s groups for %s' % (self.name, user))
+        if self.user_has_account(request.user):
-        if DiscordTasks.has_account(user):
+            user_has_account = True
-            DiscordTasks.update_groups.delay(user.pk)
+            username = request.user.discord.username
+            discriminator = request.user.discord.discriminator
+            if username and discriminator:
+                discord_username = f'{username}#{discriminator}'
+            else:
+                discord_username = ''
+        else:
+            discord_username = ''
+            user_has_account = False
 
-    def validate_user(self, user):
+        return render_to_string(
-        logger.debug('Validating user %s %s account' % (user, self.name))
+            self.service_ctrl_template, 
-        if DiscordTasks.has_account(user) and not self.service_active_for_user(user):
+            {
-            self.delete_user(user, notify_user=True)
+                'server_name': DiscordUser.objects.server_name(),
-
+                'user_has_account': user_has_account,
-    def sync_nickname(self, user):
+                'discord_username': discord_username
-        logger.debug('Syncing %s nickname for user %s' % (self.name, user))
+            }, 
-        DiscordTasks.update_nickname.apply_async(args=[user.pk], countdown=5)
+            request=request
-
+        )
-    def update_all_groups(self):
-        logger.debug('Update all %s groups called' % self.name)
-        DiscordTasks.update_all_groups.delay()
 
     def service_active_for_user(self, user):
         return user.has_perm(self.access_perm)
 
-    def render_services_ctrl(self, request):
+    def sync_nickname(self, user):
-        return render_to_string(self.service_ctrl_template, {
+        logger.debug('Syncing %s nickname for user %s', self.name, user)
-            'discord_uid': request.user.discord.uid if DiscordTasks.has_account(request.user) else None,
+        if self.user_has_account(user):
-            'DISCORD_SERVER_ID': getattr(settings, 'DISCORD_GUILD_ID', ''),
+            tasks.update_nickname.apply_async(
-        }, request=request)
+                kwargs={'user_pk': user.pk}, priority=SINGLE_TASK_PRIORITY
+            )
+
+    def sync_nicknames_bulk(self, users: list):
+        """Sync nickname for a list of users in bulk. 
+        Preferred over sync_nickname(), because it will not break the rate limit
+        """
+        logger.debug(
+            'Syncing %s nicknames in bulk for %d users', self.name, len(users)
+        )
+        user_pks = [user.pk for user in users]
+        tasks.update_nicknames_bulk.delay(user_pks)
+
+    def update_all_groups(self):
+        logger.debug('Update all %s groups called', self.name)
+        tasks.update_all_groups.delay()
+
+    def update_groups(self, user):        
+        logger.debug('Processing %s groups for %s', self.name, user)
+        if self.user_has_account(user):            
+            tasks.update_groups.apply_async(
+                kwargs={'user_pk': user.pk}, priority=SINGLE_TASK_PRIORITY
+            )
+
+    def update_groups_bulk(self, users: list):
+        """Updates groups for a list of users in bulk. 
+        Preferred over update_groups(), because it will not break the rate limit
+        """
+        logger.debug(
+            'Processing %s groups in bulk for %d users', self.name, len(users)
+        )
+        user_pks = [user.pk for user in users]
+        tasks.update_groups_bulk.delay(user_pks)
+    
+    @staticmethod
+    def user_has_account(user: User) -> bool:
+        result = DiscordUser.objects.user_has_account(user)
+        if result:
+            logger.debug('User %s has a Discord account', user)
+        else:
+            logger.debug('User %s does not have a Discord account', user)
+        return result
+
+    def validate_user(self, user):
+        logger.debug('Validating user %s %s account', user, self.name)
+        if self.user_has_account(user) and not self.service_active_for_user(user):
+            self.delete_user(user, notify_user=True)
 
 
 @hooks.register('services_hook')

allianceauth/services/modules/discord/discord_client/__init__.py

@@ -0,0 +1,3 @@
+from .client import DiscordClient   # noqa
+from .exceptions import DiscordApiBackoff  # noqa
+from .helpers import DiscordRoles  # noqa

allianceauth/services/modules/discord/discord_client/app_settings.py

@@ -0,0 +1,40 @@
+from ..utils import clean_setting
+
+
+# Base URL for all API calls. Must end with /.
+DISCORD_API_BASE_URL = clean_setting(
+    'DISCORD_API_BASE_URL', 'https://discordapp.com/api/'
+)
+
+# Low level timeout for requests to the Discord API in ms
+DISCORD_API_TIMEOUT = clean_setting(
+    'DISCORD_API_TIMEOUT', 5000
+)
+
+# Base authorization URL for Discord Oauth
+DISCORD_OAUTH_BASE_URL = clean_setting(
+    'DISCORD_OAUTH_BASE_URL', 'https://discordapp.com/api/oauth2/authorize'
+)
+
+# Base authorization URL for Discord Oauth
+DISCORD_OAUTH_TOKEN_URL = clean_setting(
+    'DISCORD_OAUTH_TOKEN_URL', 'https://discordapp.com/api/oauth2/token'
+)
+
+# How long the Discord guild names retrieved from the server are 
+# caches locally in milliseconds.
+DISCORD_GUILD_NAME_CACHE_MAX_AGE = clean_setting(
+    'DISCORD_GUILD_NAME_CACHE_MAX_AGE', 3600 * 1 * 1000
+)
+
+# How long Discord roles retrieved from the server are caches locally in milliseconds.
+DISCORD_ROLES_CACHE_MAX_AGE = clean_setting(
+    'DISCORD_ROLES_CACHE_MAX_AGE', 3600 * 1 * 1000
+)
+
+# Turns off creation of new roles. In case the rate limit for creating roles is
+# exhausted, this setting allows the Discord service to continue to function 
+# and wait out the reset. Rate limit is about 250 per 48 hrs.
+DISCORD_DISABLE_ROLE_CREATION = clean_setting(
+    'DISCORD_DISABLE_ROLE_CREATION', False
+)

allianceauth/services/modules/discord/discord_client/client.py

@@ -0,0 +1,710 @@
+from hashlib import md5
+import json
+import logging
+from time import sleep
+from urllib.parse import urljoin
+from uuid import uuid1
+
+from redis import Redis
+import requests
+
+from django.core.cache import caches
+
+from allianceauth import __title__ as AUTH_TITLE, __url__, __version__
+
+from .. import __title__
+from .app_settings import (
+    DISCORD_API_BASE_URL,
+    DISCORD_API_TIMEOUT, 
+    DISCORD_DISABLE_ROLE_CREATION,
+    DISCORD_GUILD_NAME_CACHE_MAX_AGE,
+    DISCORD_OAUTH_BASE_URL, 
+    DISCORD_OAUTH_TOKEN_URL,    
+    DISCORD_ROLES_CACHE_MAX_AGE,    
+)
+from .exceptions import DiscordRateLimitExhausted, DiscordTooManyRequestsError
+from .helpers import DiscordRoles
+from ..utils import LoggerAddTag
+
+
+logger = LoggerAddTag(logging.getLogger(__name__), __title__)
+
+# max requests that can be executed until reset
+RATE_LIMIT_MAX_REQUESTS = 5        
+
+# Time until remaining requests are reset
+RATE_LIMIT_RESETS_AFTER = 5000
+
+# Delay used for API backoff in case no info returned from API on 429s
+DEFAULT_BACKOFF_DELAY = 5000
+
+# additional duration to compensate for potential clock discrepancies 
+# with the Discord server
+DURATION_CONTINGENCY = 500
+
+# Client will do a blocking wait rather than throwing a backoff exception if the
+# time until next reset is below this threshold
+WAIT_THRESHOLD = 250
+
+# Minimum wait duration when doing a blocking wait
+MINIMUM_BLOCKING_WAIT = 50
+
+# If the rate limit resets soon we will wait it out and then retry to
+# either get a remaining request from our cached counter 
+# or again wait out a short reset time and retry again.
+# This could happen several times within a high concurrency situation, 
+# but must fail after x tries to avoid an infinite loop
+RATE_LIMIT_RETRIES = 1000
+
+
+class DiscordClient:
+    """This class provides a web client for interacting with the Discord API
+    
+    The client has rate limiting that supports concurrency.
+    This means it is able to ensure the API rate limit is not violated, 
+    even when used concurrently, e.g. with multiple parallel celery tasks.
+
+    In addition the client support proper API backoff.
+
+    Synchronization of rate limit infos accross multiple processes 
+    is implemented with Redis and thus requires Redis as Django cache backend.
+
+    All durations are in milliseconds.
+    """
+    OAUTH_BASE_URL = DISCORD_OAUTH_BASE_URL
+    OAUTH_TOKEN_URL = DISCORD_OAUTH_TOKEN_URL
+
+    _KEY_GLOBAL_BACKOFF_UNTIL = 'DISCORD_GLOBAL_BACKOFF_UNTIL'
+    _KEY_GLOBAL_RATE_LIMIT_REMAINING = 'DISCORD_GLOBAL_RATE_LIMIT_REMAINING'
+    _KEYPREFIX_GUILD_NAME = 'DISCORD_GUILD_NAME'
+    _KEYPREFIX_GUILD_ROLES = 'DISCORD_GUILD_ROLES'
+    _KEYPREFIX_ROLE_NAME = 'DISCORD_ROLE_NAME'    
+    _NICK_MAX_CHARS = 32
+    
+    _HTTP_STATUS_CODE_NOT_FOUND = 404
+    _HTTP_STATUS_CODE_RATE_LIMITED = 429
+    _DISCORD_STATUS_CODE_UNKNOWN_MEMBER = 10007
+
+    def __init__(
+        self, 
+        access_token: str, 
+        redis: Redis = None, 
+        is_rate_limited: bool = True
+    ) -> None:
+        """        
+        Params:
+        - access_token: Discord access token used to authenticate all calls to the API
+        - redis: Redis instance to be used. 
+        - is_rate_limited: Set to False to run of rate limiting (use with care)
+        If not specified will try to use the Redis instance 
+        from the default Django cache backend.
+        """
+        self._access_token = str(access_token)
+        self._is_rate_limited = bool(is_rate_limited)
+        if not redis:
+            default_cache = caches['default']
+            self._redis = default_cache.get_master_client()
+            if not isinstance(self._redis, Redis):
+                raise RuntimeError(
+                    'This class requires a Redis client, but none was provided '
+                    'and the default Django cache backend is not Redis either.'
+                )
+        else:
+            self._redis = redis
+
+        lua_1 = """
+            if redis.call("exists", KEYS[1]) == 0 then
+                redis.call("set", KEYS[1], ARGV[1], 'px', ARGV[2])
+            end    
+            return redis.call("decr", KEYS[1])
+        """
+        self.__redis_script_decr_or_set = self._redis.register_script(lua_1)
+
+        lua_2 = """
+            local current_px = tonumber(redis.call("pttl", KEYS[1]))
+            if current_px < tonumber(ARGV[2]) then
+                return redis.call("set", KEYS[1], ARGV[1], 'px', ARGV[2])
+            else
+                return nil
+            end
+        """
+        self.__redis_script_set_longer = self._redis.register_script(lua_2)
+
+    @property
+    def access_token(self):
+        return self._access_token
+
+    @property
+    def is_rate_limited(self):
+        return self._is_rate_limited
+    
+    def __repr__(self):
+        return f'{type(self).__name__}(access_token=...{self.access_token[-5:]})'
+
+    def _redis_decr_or_set(self, name: str, value: str, px: int) -> bool:
+        """decreases the key value if it exists and returns the result
+        else sets the key
+        
+        Implemented as Lua script to ensure atomicity.
+        """
+        return self.__redis_script_decr_or_set(
+            keys=[str(name)], args=[str(value), int(px)]
+        )
+    
+    def _redis_set_if_longer(self, name: str, value: str, px: int) -> bool:
+        """like set, but only goes through if either key doesn't exist 
+        or px would be extended. 
+        
+        Implemented as Lua script to ensure atomicity.
+        """
+        return self.__redis_script_set_longer(
+            keys=[str(name)], args=[str(value), int(px)]
+        )
+
+    # users
+    
+    def current_user(self) -> dict:
+        """returns the user belonging to the current access_token"""
+        authorization = f'Bearer {self.access_token}'
+        r = self._api_request(
+            method='get', route='users/@me', authorization=authorization
+        )
+        return r.json()
+   
+    # guild
+
+    def guild_infos(self, guild_id: int) -> dict:
+        """Returns all basic infos about this guild"""
+        route = f"guilds/{guild_id}"
+        r = self._api_request(method='get', route=route)
+        return r.json()
+
+    def guild_name(self, guild_id: int) -> str:
+        """returns the name of this guild (cached) 
+        or an empty string if something went wrong
+        """
+        key_name = self._guild_name_cache_key(guild_id)
+        guild_name = self._redis_decode(self._redis.get(key_name))
+        if not guild_name:
+            guild_infos = self.guild_infos(guild_id)
+            if 'name' in guild_infos:
+                guild_name = guild_infos['name']
+                self._redis.set(
+                    name=key_name, 
+                    value=guild_name, 
+                    px=DISCORD_GUILD_NAME_CACHE_MAX_AGE
+                )
+            else:
+                guild_name = ''
+
+        return guild_name
+
+    @classmethod
+    def _guild_name_cache_key(cls, guild_id: int) -> str:        
+        """Returns key for accessing role given by name in the role cache"""
+        gen_key = DiscordClient._generate_hash(f'{guild_id}')
+        return f'{cls._KEYPREFIX_GUILD_NAME}__{gen_key}'
+
+    # guild roles
+
+    def guild_roles(self, guild_id: int, use_cache: bool = True) -> list:
+        """Returns the list of all roles for this guild
+        
+        If use_cache is set to False it will always hit the API to retrieve
+        fresh data and update the cache
+        """
+        cache_key = self._guild_roles_cache_key(guild_id)
+        if use_cache:                        
+            roles_raw = self._redis.get(name=cache_key)
+            if roles_raw:
+                logger.debug('Returning roles for guild %s from cache', guild_id)
+                return json.loads(self._redis_decode(roles_raw))
+            else:
+                logger.debug('No roles for guild %s in cache', guild_id)
+        
+        route = f"guilds/{guild_id}/roles"
+        r = self._api_request(method='get', route=route)            
+        roles = r.json()
+        if roles and isinstance(roles, list):
+            self._redis.set(
+                name=cache_key, 
+                value=json.dumps(roles), 
+                px=DISCORD_ROLES_CACHE_MAX_AGE
+            )
+        return roles
+
+    def create_guild_role(self, guild_id: int, role_name: str, **kwargs) -> dict:
+        """Create a new guild role with the given name. 
+        See official documentation for additional optional parameters.
+
+        Note that Discord allows the creation of multiple roles with the same name,
+        so to avoid duplicates it's important to check existing roles 
+        before creating new one
+        
+        returns a new role dict on success
+        """
+        route = f"guilds/{guild_id}/roles"
+        data = {'name': DiscordRoles.sanitize_role_name(role_name)}
+        data.update(kwargs)
+        r = self._api_request(method='post', route=route, data=data)
+        role = r.json()
+        if role:
+            self._invalidate_guild_roles_cache(guild_id)
+        return role
+
+    def delete_guild_role(self, guild_id: int, role_id: int) -> bool:
+        """Deletes a guild role"""
+        route = f"guilds/{guild_id}/roles/{role_id}"
+        r = self._api_request(method='delete', route=route)
+        if r.status_code == 204:
+            self._invalidate_guild_roles_cache(guild_id)
+            return True
+        else:
+            return False
+        
+    def _invalidate_guild_roles_cache(self, guild_id: int) -> None:        
+        cache_key = self._guild_roles_cache_key(guild_id)        
+        self._redis.delete(cache_key)
+        logger.debug('Guild roles cache invalidated')
+
+    @classmethod
+    def _guild_roles_cache_key(cls, guild_id: int) -> str:
+        """Returns key for accessing cached roles for a guild"""
+        gen_key = cls._generate_hash(f'{guild_id}')
+        return f'{cls._KEYPREFIX_GUILD_ROLES}__{gen_key}'
+    
+    def match_or_create_roles_from_names(self, guild_id: int, role_names: list) -> list:
+        """returns Discord roles matching the given names
+        
+        Returns as list of tuple of role and created flag
+
+        Will try to match with existing roles names
+        Non-existing roles will be created, then created flag will be True
+        Params:
+        - guild_id: ID of guild
+        - role_names: list of name strings each defining a role
+        """
+        roles = list()
+        guild_roles = DiscordRoles(self.guild_roles(guild_id))
+        role_names_cleaned = {
+            DiscordRoles.sanitize_role_name(name) for name in role_names
+        }
+        for role_name in role_names_cleaned:
+            role, created = self.match_or_create_role_from_name(
+                guild_id=guild_id, 
+                role_name=DiscordRoles.sanitize_role_name(role_name),
+                guild_roles=guild_roles
+            )
+            if role:
+                roles.append((role, created))
+            if created:
+                guild_roles = guild_roles.union(DiscordRoles([role]))
+        return roles
+
+    def match_or_create_role_from_name(
+        self, guild_id: int, role_name: str, guild_roles: DiscordRoles = None
+    ) -> tuple:
+        """returns Discord role matching the given name
+
+        Returns as tuple of role and created flag
+        
+        Will try to match with existing roles names
+        Non-existing roles will be created, then created flag will be True
+        Params:
+        - guild_id: ID of guild
+        - role_name: strings defining name of a role
+        - guild_roles: All known guild roles as DiscordRoles object. 
+        Helps to void redundant lookups of guild roles 
+        when this method is used multiple times.
+        """
+        if not isinstance(role_name, str):
+            raise TypeError('role_name must be of type string')
+
+        created = False        
+        if guild_roles is None:
+            guild_roles = DiscordRoles(self.guild_roles(guild_id))
+        role = guild_roles.role_by_name(role_name)
+        if not role:
+            if not DISCORD_DISABLE_ROLE_CREATION:
+                logger.debug('Need to create missing role: %s', role_name)
+                role = self.create_guild_role(guild_id, role_name)                
+                created = True
+            else:
+                role = None
+    
+        return role, created
+
+    # guild members
+
+    def add_guild_member(
+        self, 
+        guild_id: int, 
+        user_id: int, 
+        access_token: str, 
+        role_ids: list = None, 
+        nick: str = None
+    ) -> bool:           
+        """Adds a user to the guilds.
+        
+        Returns:
+        - True when a new user was added
+        - None if the user already existed
+        - False when something went wrong or raises exception
+        """
+        route = f"guilds/{guild_id}/members/{user_id}"
+        data = {
+            'access_token': str(access_token)
+        }
+        if role_ids:            
+            data['roles'] = self._sanitize_role_ids(role_ids)
+
+        if nick:
+            data['nick'] = str(nick)[:self._NICK_MAX_CHARS]
+
+        r = self._api_request(method='put', route=route, data=data)        
+        r.raise_for_status()
+        if r.status_code == 201:
+            return True
+        elif r.status_code == 204:
+            return None
+        else:
+            return False
+        
+    def guild_member(self, guild_id: int, user_id: int) -> dict:
+        """returns the user info for a guild member
+        
+        or None if the user is not a member of the guild
+        """
+        route = f'guilds/{guild_id}/members/{user_id}'
+        r = self._api_request(method='get', route=route, raise_for_status=False)
+        if self._is_member_unknown_error(r):
+            logger.warning("Discord user ID %s could not be found on server.", user_id)
+            return None
+        else:
+            r.raise_for_status()
+            return r.json()
+
+    def modify_guild_member(
+        self, guild_id: int, user_id: int, role_ids: list = None, nick: str = None
+    ) -> bool:
+        """Modify attributes of a guild member.
+
+        Returns
+        - True when successful
+        - None if user is not a member of this guild
+        - False otherwise
+        """
+        if not role_ids and not nick:
+            raise ValueError('Must specify role_ids or nick')
+        
+        if role_ids and not isinstance(role_ids, list):
+            raise TypeError('role_ids must be a list type')
+
+        data = dict()
+        if role_ids:            
+            data['roles'] = self._sanitize_role_ids(role_ids)
+        
+        if nick:
+            data['nick'] = self._sanitize_nick(nick)
+
+        route = f"guilds/{guild_id}/members/{user_id}"
+        r = self._api_request(
+            method='patch', route=route, data=data, raise_for_status=False
+        )
+        if self._is_member_unknown_error(r):
+            logger.warning('User ID %s is not a member of this guild', user_id)
+            return None
+        else:
+            r.raise_for_status()
+        
+        if r.status_code == 204:
+            return True
+        else:
+            return False
+
+    def remove_guild_member(self, guild_id: int, user_id: int) -> bool:
+        """Remove a member from a guild
+        
+        Returns:
+        - True when successful
+        - None if member does not exist
+        - False otherwise
+        """
+        route = f"guilds/{guild_id}/members/{user_id}"
+        r = self._api_request(
+            method='delete', route=route, raise_for_status=False
+        )        
+        if self._is_member_unknown_error(r):
+            logger.warning('User ID %s is not a member of this guild', user_id)
+            return None
+        else:
+            r.raise_for_status()
+
+        if r.status_code == 204:
+            return True
+        else:
+            return False
+
+    # Guild member roles
+    
+    def add_guild_member_role(
+        self, guild_id: int, user_id: int, role_id: int
+    ) -> bool:        
+        """Adds a role to a guild member
+        
+        Returns:
+        - True when successful
+        - None if member does not exist
+        - False otherwise
+        """
+        route = f"guilds/{guild_id}/members/{user_id}/roles/{role_id}"
+        r = self._api_request(method='put', route=route, raise_for_status=False)
+        if self._is_member_unknown_error(r):
+            logger.warning('User ID %s is not a member of this guild', user_id)
+            return None
+        else:
+            r.raise_for_status()
+        
+        if r.status_code == 204:
+            return True
+        else:
+            return False
+
+    def remove_guild_member_role(
+        self, guild_id: int, user_id: int, role_id: int
+    ) -> bool:
+        """Removes a role to a guild member
+        
+        Returns:
+        - True when successful
+        - None if member does not exist
+        - False otherwise
+        """
+        route = f"guilds/{guild_id}/members/{user_id}/roles/{role_id}"
+        r = self._api_request(method='delete', route=route, raise_for_status=False)
+        if self._is_member_unknown_error(r):
+            logger.warning('User ID %s is not a member of this guild', user_id)
+            return None
+        else:
+            r.raise_for_status()
+
+        if r.status_code == 204:
+            return True
+        else:
+            return False
+
+    @classmethod
+    def _is_member_unknown_error(cls, r: requests.Response) -> bool:
+        try:
+            result = (
+                r.status_code == cls._HTTP_STATUS_CODE_NOT_FOUND
+                and r.json()['code'] == cls._DISCORD_STATUS_CODE_UNKNOWN_MEMBER
+            )
+        except (ValueError, KeyError):
+            result = False
+        
+        return result
+
+    # Internal methods
+
+    def _api_request(
+        self, 
+        method: str, 
+        route: str, 
+        data: dict = None, 
+        authorization: str = None,
+        raise_for_status: bool = True
+    ) -> requests.Response:
+        """Core method for performing all API calls"""
+        uid = uuid1().hex
+        
+        if not hasattr(requests, method):
+            raise ValueError('Invalid method: %s' % method)
+
+        if not authorization:
+            authorization = f'Bot {self.access_token}'
+                
+        self._handle_ongoing_api_backoff(uid)        
+        if self.is_rate_limited:
+            self._ensure_rate_limed_not_exhausted(uid)        
+        headers = {
+            'User-Agent': f'{AUTH_TITLE} ({__url__}, {__version__})',
+            'accept': 'application/json',
+            'X-RateLimit-Precision': 'millisecond',
+            'authorization': str(authorization)
+        }
+        if data:
+            headers['content-type'] = 'application/json'
+
+        url = urljoin(DISCORD_API_BASE_URL, route)
+        args = {
+            'url': url,
+            'headers': headers,
+            'timeout': DISCORD_API_TIMEOUT / 1000
+        }
+        if data:
+            args['json'] = data
+        
+        logger.info('%s: sending %s request to url \'%s\'', uid, method.upper(), url)
+        logger.debug('%s: request headers: %s', uid, headers)
+        r = getattr(requests, method)(**args)
+        logger.debug(
+            '%s: returned status code %d with headers: %s', 
+            uid, 
+            r.status_code, 
+            r.headers
+        )
+        logger.debug('%s: response:\n%s', uid, r.text)
+        if not r.ok:
+            logger.warning(
+                '%s: Discord API returned error code %d and this response: %s',
+                uid, 
+                r.status_code,
+                r.text
+            )
+
+        if r.status_code == self._HTTP_STATUS_CODE_RATE_LIMITED:
+            self._handle_new_api_backoff(r, uid)
+
+        self._report_rate_limit_from_api(r, uid)
+                
+        if raise_for_status:
+            r.raise_for_status()
+        
+        return r
+
+    def _handle_ongoing_api_backoff(self, uid: str) -> None:        
+        """checks if api is currently on backoff
+        if on backoff: will do a blocking wait if it expires soon, 
+        else raises exception
+        """
+        global_backoff_duration = self._redis.pttl(self._KEY_GLOBAL_BACKOFF_UNTIL)
+        if global_backoff_duration > 0:
+            if global_backoff_duration < WAIT_THRESHOLD:
+                logger.info(
+                    '%s: Global API backoff still ongoing for %s ms. Waiting.',
+                    uid,
+                    global_backoff_duration
+                )
+                sleep(global_backoff_duration / 1000)
+            else:
+                logger.info(
+                    '%s: Global API backoff still ongoing for %s ms. Re-raising.',
+                    uid,
+                    global_backoff_duration
+                )
+                raise DiscordTooManyRequestsError(retry_after=global_backoff_duration)
+
+    def _ensure_rate_limed_not_exhausted(self, uid: str) -> int:
+        """ensures that the rate limit is not exhausted 
+        if exhausted: will do a blocking wait if rate limit resets soon, 
+        else raises exception
+
+        returns requests remaining on success
+        """
+        for _ in range(RATE_LIMIT_RETRIES):
+            requests_remaining = self._redis_decr_or_set(
+                name=self._KEY_GLOBAL_RATE_LIMIT_REMAINING, 
+                value=RATE_LIMIT_MAX_REQUESTS, 
+                px=RATE_LIMIT_RESETS_AFTER + DURATION_CONTINGENCY
+            )                        
+            resets_in = max(
+                MINIMUM_BLOCKING_WAIT, 
+                self._redis.pttl(self._KEY_GLOBAL_RATE_LIMIT_REMAINING)
+            )
+            if requests_remaining >= 0:
+                logger.debug(
+                    '%s: Got one of %d remaining requests until reset in %s ms',
+                    uid,                
+                    requests_remaining + 1,
+                    resets_in
+                )
+                return requests_remaining
+
+            elif resets_in < WAIT_THRESHOLD:                
+                sleep(resets_in / 1000)
+                logger.debug(
+                    '%s: No requests remaining until reset in %d ms. '
+                    'Waiting for reset.',
+                    uid, 
+                    resets_in
+                )
+                continue
+
+            else:                
+                logger.debug(
+                    '%s: No requests remaining until reset in %d ms. '
+                    'Raising exception.',
+                    uid, 
+                    resets_in
+                )
+                raise DiscordRateLimitExhausted(resets_in)
+
+        raise RuntimeError('Failed to handle rate limit after after too tries.')
+                    
+    def _handle_new_api_backoff(self, r: requests.Response, uid: str) -> None:
+        """raises exception for new API backoff error"""
+        response = r.json()
+        if 'retry_after' in response:
+            try:
+                retry_after = \
+                    int(response['retry_after']) + DURATION_CONTINGENCY
+            except ValueError:
+                retry_after = DEFAULT_BACKOFF_DELAY
+        else:
+            retry_after = DEFAULT_BACKOFF_DELAY
+        self._redis_set_if_longer(
+            name=self._KEY_GLOBAL_BACKOFF_UNTIL, 
+            value='GLOBAL_API_BACKOFF',
+            px=retry_after
+        )
+        logger.warning(
+            "%s: Rate limit violated. Need to back off for at least %d ms",
+            uid,
+            retry_after
+        )
+        raise DiscordTooManyRequestsError(retry_after=retry_after)
+
+    def _report_rate_limit_from_api(self, r, uid):
+        """Tries to log the current rate limit reported from API"""
+        if (
+            logger.getEffectiveLevel() <= logging.DEBUG
+            and 'x-ratelimit-limit' in r.headers 
+            and 'x-ratelimit-remaining' in r.headers 
+            and 'x-ratelimit-reset-after' in r.headers
+        ):
+            try:
+                limit = int(r.headers['x-ratelimit-limit'])
+                remaining = int(r.headers['x-ratelimit-remaining'])
+                reset_after = float(r.headers['x-ratelimit-reset-after']) * 1000
+                if remaining + 1 == limit:
+                    logger.debug(
+                        '%s: Rate limit reported from API: %d requests per %s ms',
+                        uid,
+                        limit,
+                        reset_after
+                    )
+            except ValueError:
+                pass
+       
+    @staticmethod
+    def _redis_decode(value: str) -> str:
+        """Decodes a string from Redis and passes through None and Booleans"""
+        if value is not None and not isinstance(value, bool):
+            return value.decode('utf-8')
+        else:
+            return value
+
+    @staticmethod
+    def _generate_hash(key: str) -> str:
+        return md5(key.encode('utf-8')).hexdigest()
+
+    @staticmethod
+    def _sanitize_role_ids(role_ids: list) -> list:
+        """make sure its a list of integers"""
+        return [int(role_id) for role_id in list(role_ids)]
+
+    @classmethod
+    def _sanitize_nick(cls, nick: str) -> str:
+        """shortens too long strings if necessary"""
+        return str(nick)[:cls._NICK_MAX_CHARS]

allianceauth/services/modules/discord/discord_client/exceptions.py

@@ -0,0 +1,33 @@
+import math
+
+
+class DiscordClientException(Exception):
+    """Base Exception for the Discord client"""
+   
+
+class DiscordApiBackoff(DiscordClientException):
+    """Exception signaling we need to backoff from sending requests to the API for now
+    """
+    
+    def __init__(self, retry_after: int):
+        """
+        :param retry_after: int time to retry after in milliseconds
+        """
+        super().__init__()
+        self.retry_after = int(retry_after)        
+
+    @property
+    def retry_after_seconds(self):
+        return math.ceil(self.retry_after / 1000)
+
+
+class DiscordRateLimitExhausted(DiscordApiBackoff):
+    """Exception signaling that the total number of requests allowed under the 
+    current rate limit have been exhausted and weed to wait until next reset.
+    """
+   
+
+class DiscordTooManyRequestsError(DiscordApiBackoff):
+    """API has responded with a 429 Too Many Requests Error. 
+    Need to backoff for now.
+    """    

allianceauth/services/modules/discord/discord_client/helpers.py

@@ -0,0 +1,132 @@
+from copy import copy
+
+
+class DiscordRoles:
+    """Container class that helps dealing with Discord roles.
+    
+    Objects of this class are immutable and work in many ways like sets.
+    
+    Ideally objects are initialized from raw API responses, 
+    e.g. from DiscordClient.guild.roles()
+    """
+    _ROLE_NAME_MAX_CHARS = 100
+
+    def __init__(self, roles_lst: list) -> None:
+        """roles_lst must be a list of dict, each defining a role"""
+        if not isinstance(roles_lst, (list, set, tuple)):
+            raise TypeError('roles_lst must be of type list, set or tuple')
+        self._roles = dict()
+        self._roles_by_name = dict()
+        for role in list(roles_lst):
+            self._assert_valid_role(role)
+            self._roles[int(role['id'])] = role
+            self._roles_by_name[self.sanitize_role_name(role['name'])] = role
+        
+    def __eq__(self, other):
+        if isinstance(other, type(self)):
+            return self.ids() == other.ids()
+        return NotImplemented
+
+    def __hash__(self):
+        return hash(tuple(sorted(self._roles.keys())))
+    
+    def __iter__(self):
+        for role in self._roles.values():
+            yield role
+
+    def __contains__(self, item) -> bool:        
+        return int(item) in self._roles
+
+    def __len__(self):        
+        return len(self._roles.keys())
+    
+    def has_roles(self, role_ids: set) -> bool:
+        """returns true if this objects contains all roles defined by given role_ids
+        incl. managed roles
+        """
+        role_ids = {int(id) for id in role_ids}
+        all_role_ids = self._roles.keys()        
+        return role_ids.issubset(all_role_ids)
+    
+    def ids(self) -> set:
+        """return a set of all role IDs"""
+        return set(self._roles.keys())
+
+    def subset(self, role_ids: set = None, managed_only: bool = False) -> object:
+        """returns a new object containing the subset of roles as defined 
+        by given role IDs and/or including managed roles only
+        """
+        if role_ids is not None:
+            role_ids = {int(id) for id in role_ids}
+
+        if role_ids is not None and not managed_only:
+            return type(self)([
+                role for role_id, role in self._roles.items() if role_id in role_ids
+            ])
+
+        elif role_ids is None and managed_only:
+            return type(self)([
+                role for _, role in self._roles.items() if role['managed']
+            ])
+        
+        elif role_ids is not None and managed_only:
+            return type(self)([
+                role for role_id, role in self._roles.items() 
+                if role_id in role_ids and role['managed']
+            ])
+        
+        else:
+            return copy(self)
+
+    def union(self, other: object) -> object:
+        """returns a new roles object that is the union of this roles object 
+        with other"""
+        return type(self)(list(self) + list(other))
+
+    def difference(self, other: object) -> object:
+        """returns a new roles object that only contains the roles 
+        that exist in the current objects, but not in other
+        """
+        new_ids = self.ids().difference(other.ids())
+        return self.subset(role_ids=new_ids)
+
+    def role_by_name(self, role_name: str) -> dict:
+        """returns role if one with matching name is found else an empty dict"""
+        role_name = self.sanitize_role_name(role_name)
+        if role_name in self._roles_by_name:
+            return self._roles_by_name[role_name]
+        else:
+            return dict()
+        
+    @classmethod
+    def create_from_matched_roles(cls, matched_roles: list) -> None:
+        """returns a new object created from the given list of matches roles
+        
+        matches_roles must be a list of tuples in the form: (role, created)
+        """
+        raw_roles = [x[0] for x in matched_roles]
+        return cls(raw_roles)
+
+    @staticmethod
+    def _assert_valid_role(role: dict):
+        if not isinstance(role, dict):
+            raise TypeError('Roles must be of type dict: %s' % role)
+            
+        if 'id' not in role or 'name' not in role or 'managed' not in role:
+            raise ValueError('This role is not valid: %s' % role)
+    
+    @classmethod
+    def sanitize_role_name(cls, role_name: str) -> str:
+        """shortens too long strings if necessary"""
+        return str(role_name)[:cls._ROLE_NAME_MAX_CHARS]
+
+
+def match_or_create_roles_from_names(
+    client: object, guild_id: int, role_names: list
+) -> DiscordRoles:
+    """Shortcut for getting the result of matching role names as DiscordRoles object"""
+    return DiscordRoles.create_from_matched_roles(
+        client.match_or_create_roles_from_names(
+            guild_id=guild_id, role_names=role_names
+        )
+    )

allianceauth/services/modules/discord/discord_client/tests/__init__.py

@@ -0,0 +1,38 @@
+TEST_GUILD_ID = 123456789012345678
+TEST_USER_ID = 198765432012345678
+TEST_USER_NAME = 'Peter Parker'
+TEST_USER_DISCRIMINATOR = '1234'
+TEST_BOT_TOKEN = 'abcdefhijlkmnopqastzvwxyz1234567890ABCDEFGHOJKLMNOPQRSTUVWXY'
+TEST_ROLE_ID = 654321012345678912
+
+
+def create_role(id: int, name: str, managed=False):
+    return {
+        'id': int(id),
+        'name': str(name),
+        'managed': bool(managed)
+    }
+
+
+def create_matched_role(role, created=False) -> tuple:
+    return role, created
+
+
+ROLE_ALPHA = create_role(1, 'alpha')
+ROLE_BRAVO = create_role(2, 'bravo')
+ROLE_CHARLIE = create_role(3, 'charlie')
+ROLE_MIKE = create_role(13, 'mike', True)
+
+ALL_ROLES = [ROLE_ALPHA, ROLE_BRAVO, ROLE_CHARLIE, ROLE_MIKE]
+
+
+def create_user_info(
+    id: int = TEST_USER_ID, 
+    username: str = TEST_USER_NAME, 
+    discriminator: str = TEST_USER_DISCRIMINATOR
+):
+    return {
+        'id': str(id),
+        'username': str(username[:32]),
+        'discriminator': str(discriminator[:4])
+    }

allianceauth/services/modules/discord/discord_client/tests/piloting_concurrency.py

@@ -0,0 +1,85 @@
+"""This is script is for concurrency testing the Discord client with a Discord server.
+
+It will run multiple requests against Discord with multiple workers in parallel.
+The results can be analysed in a special log file.
+
+This script is design to be run manually as unit test, e.g. by running the following:
+
+python manage.py test 
+allianceauth.services.modules.discord.discord_client.tests.piloting_concurrency
+
+To make it work please set the below mentioned environment variables for your server.
+Since this may cause lots of 429s we'd recommend NOT to use your 
+alliance Discord server for this.
+"""
+
+import os
+from random import random
+import threading
+from time import sleep
+from django.test import TestCase
+
+from .. import DiscordClient, DiscordApiBackoff
+
+from ...utils import set_logger_to_file
+
+logger = set_logger_to_file(
+    'allianceauth.services.modules.discord.discord_client.client', __file__
+)
+
+# Make sure to set these environnement variables for your Discord server and user
+DISCORD_GUILD_ID = os.environ['DISCORD_GUILD_ID']
+DISCORD_BOT_TOKEN = os.environ['DISCORD_BOT_TOKEN']
+DISCORD_USER_ID = os.environ['DISCORD_USER_ID']
+NICK = 'Dummy'
+
+# Configure these settings to adjust the load profile
+NUMBER_OF_WORKERS = 5
+NUMBER_OF_RUNS = 10
+
+# max seconds a worker waits before starting a new run
+# set to near 0 for max load preassure
+MAX_JITTER_PER_RUN_SECS = 1.0
+
+
+def worker(num: int):
+    """worker function"""
+    worker_info = 'worker %d' % num
+    logger.info('%s: started', worker_info)
+    client = DiscordClient(DISCORD_BOT_TOKEN)
+    try:
+        runs = 0
+        while runs < NUMBER_OF_RUNS:            
+            run_info = '%s: run %d' % (worker_info, runs + 1)
+            my_jitter_secs = random() * MAX_JITTER_PER_RUN_SECS
+            logger.info('%s - waiting %s secs', run_info, f'{my_jitter_secs:.3f}')
+            sleep(my_jitter_secs)
+            logger.info('%s - started', run_info)
+            try:
+                client.modify_guild_member(
+                    DISCORD_GUILD_ID, DISCORD_USER_ID, nick=NICK
+                )
+                runs += 1
+            except DiscordApiBackoff as bo:
+                message = '%s - waiting out API backoff for %d ms' % (
+                    run_info, bo.retry_after
+                )
+                logger.info(message)
+                print()
+                print(message)
+                sleep(bo.retry_after / 1000)                
+    
+    except Exception as ex:
+        logger.exception('%s: Processing aborted: %s', worker_info, ex)
+        
+    logger.info('%s: finished', worker_info)
+    return
+
+
+class TestMulti(TestCase):
+    
+    def test_multi(self):        
+        logger.info('Starting multi test')
+        for num in range(NUMBER_OF_WORKERS):
+            x = threading.Thread(target=worker, args=(num + 1,))
+            x.start()

allianceauth/services/modules/discord/discord_client/tests/piloting_functionality.py

@@ -0,0 +1,130 @@
+"""This script is for functional testing of the Discord client with a Discord server
+
+It will run single requests of the various functions to validate 
+that they actually work - excluding those that require Oauth, or does not work 
+with a bot token. The results can be also seen in a special log file.
+
+This script is design to be run manually as unit test, e.g. by running the following:
+
+python manage.py test
+allianceauth.services.modules.discord.discord_self.client.tests.piloting_functionality
+
+To make it work please set the below mentioned environment variables for your server.
+Since this may cause lots of 429s we'd recommend NOT to use your 
+alliance Discord server for this.
+"""
+
+from uuid import uuid1
+import os
+from unittest import TestCase
+from time import sleep
+
+from .. import DiscordClient
+from ...utils import set_logger_to_file
+
+logger = set_logger_to_file(
+    'allianceauth.services.modules.discord.discord_self.client.client', __file__
+)
+
+# Make sure to set these environnement variables for your Discord server and user
+DISCORD_GUILD_ID = os.environ['DISCORD_GUILD_ID']
+DISCORD_BOT_TOKEN = os.environ['DISCORD_BOT_TOKEN']
+DISCORD_USER_ID = os.environ['DISCORD_USER_ID']
+
+RATE_LIMIT_DELAY_SECS = 1
+
+
+class TestDiscordApiLive(TestCase):
+
+    @classmethod
+    def setUpClass(cls):
+        super().setUpClass()
+        logger.info('Live demo of the Discord API Client')
+        cls.client = DiscordClient(DISCORD_BOT_TOKEN)
+
+    def test_run_other_features(self):
+        """runs features that have not been run in any of the other tests"""
+        self.client.guild_infos(DISCORD_GUILD_ID)
+        sleep(RATE_LIMIT_DELAY_SECS)
+        
+        self.client.guild_name(DISCORD_GUILD_ID)
+        sleep(RATE_LIMIT_DELAY_SECS)
+
+        self.client.match_or_create_role_from_name(DISCORD_GUILD_ID, 'Testrole')
+        sleep(RATE_LIMIT_DELAY_SECS)
+
+        self.client.match_or_create_roles_from_names(
+            DISCORD_GUILD_ID, ['Testrole A', 'Testrole B']
+        )
+        sleep(RATE_LIMIT_DELAY_SECS)
+        
+    def test_create_and_remove_roles(self):        
+        # get base        
+        logger.info('guild_roles')
+        expected = {role['id'] for role in self.client.guild_roles(DISCORD_GUILD_ID)}
+
+        # add role
+        role_name = 'my test role 12345678'
+        logger.info('create_guild_role')
+        new_role = self.client.create_guild_role(
+            guild_id=DISCORD_GUILD_ID, role_name=role_name
+        )
+        sleep(RATE_LIMIT_DELAY_SECS)
+        self.assertEqual(new_role['name'], role_name)        
+        
+        # remove role again
+        logger.info('delete_guild_role')
+        self.client.delete_guild_role(
+            guild_id=DISCORD_GUILD_ID, role_id=new_role['id']
+        )
+        sleep(RATE_LIMIT_DELAY_SECS)
+
+        # verify it worked
+        logger.info('guild_roles')
+        role_ids = {role['id'] for role in self.client.guild_roles(DISCORD_GUILD_ID)}
+        sleep(RATE_LIMIT_DELAY_SECS)
+        self.assertSetEqual(role_ids, expected)
+
+    def test_change_member_nick(self):
+        # set new nick for user
+        logger.info('modify_guild_member')
+        new_nick = f'Testnick {uuid1().hex}'[:32]
+        self.assertTrue(
+            self.client.modify_guild_member(
+                guild_id=DISCORD_GUILD_ID, user_id=DISCORD_USER_ID, nick=new_nick
+            )
+        )
+        sleep(RATE_LIMIT_DELAY_SECS)
+
+        # verify it is saved
+        logger.info('guild_member')
+        user = self.client.guild_member(DISCORD_GUILD_ID, DISCORD_USER_ID)
+        sleep(RATE_LIMIT_DELAY_SECS)
+        self.assertEqual(user['nick'], new_nick)
+
+    def test_member_add_remove_roles(self):        
+        # create new guild role
+        logger.info('create_guild_role')
+        new_role = self.client.create_guild_role(
+            guild_id=DISCORD_GUILD_ID, role_name='Special role 98765'
+        )
+        sleep(RATE_LIMIT_DELAY_SECS)
+        new_role_id = new_role['id']
+        
+        # add to member
+        logger.info('add_guild_member_role')
+        self.assertTrue(
+            self.client.add_guild_member_role(
+                guild_id=DISCORD_GUILD_ID, user_id=DISCORD_USER_ID, role_id=new_role_id
+            )
+        )
+        sleep(RATE_LIMIT_DELAY_SECS)
+        
+        # remove again
+        logger.info('remove_guild_member_role')
+        self.assertTrue(
+            self.client.remove_guild_member_role(
+                guild_id=DISCORD_GUILD_ID, user_id=DISCORD_USER_ID, role_id=new_role_id
+            )
+        )
+        sleep(RATE_LIMIT_DELAY_SECS)

allianceauth/services/modules/discord/discord_client/tests/rate_limits.md

@@ -0,0 +1,26 @@
+# Discord rate limits
+
+The following table shows the rate limit as reported from the API for different routes.
+
+method | limit | reset | rate / s | bucket
+-- | -- | -- | -- | --
+add_guild_member | 10 | 10,000 | 1 | self
+create_guild_role | 250 | 180,000,000 | 0.001 | self
+delete_guild_role | g | g | g | g
+guild_member | 5 | 1,000 | 5 | self
+guild_roles | g | g | g | g
+add_guild_member_role | 10 | 10,000 | 1 | B1
+remove_guild_member_role | 10 | 10,000 | 1 | B1
+modify_guild_member | 10 | 10,000 | 1 | self
+remove_guild_member | 5 | 1,000 | 5 | self
+current_user | g | g | g | g
+
+Legend:
+
+- g: global rate limit. API does not provide any rate limit infos for those routes.
+
+- reset: Values in milliseconds.
+
+- bucket: "self" means the rate limit is only counted for that route, Bx means the same rate limit is counted for multiple routes.
+
+- Data was collected on 2020-MAY-07 and is subject to change.

allianceauth/services/modules/discord/discord_client/tests/test_exceptions.py

@@ -0,0 +1,33 @@
+from unittest import TestCase
+
+from ..exceptions import (
+    DiscordApiBackoff, 
+    DiscordClientException, 
+    DiscordRateLimitExhausted,
+    DiscordTooManyRequestsError
+)
+
+
+class TestExceptions(TestCase):
+
+    def test_DiscordApiException(self):
+        with self.assertRaises(DiscordClientException):
+            raise DiscordClientException()
+
+    def test_DiscordApiBackoff_raise(self):
+        with self.assertRaises(DiscordApiBackoff):
+            raise DiscordApiBackoff(999)
+
+    def test_DiscordApiBackoff_retry_after_seconds(self):
+        retry_after = 999
+        ex = DiscordApiBackoff(retry_after)
+        self.assertEqual(ex.retry_after, retry_after)
+        self.assertEqual(ex.retry_after_seconds, 1)
+
+    def test_DiscordRateLimitedExhausted_raise(self):
+        with self.assertRaises(DiscordRateLimitExhausted):
+            raise DiscordRateLimitExhausted(999)
+
+    def test_DiscordApiBackoffError_raise(self):
+        with self.assertRaises(DiscordTooManyRequestsError):
+            raise DiscordTooManyRequestsError(999)

allianceauth/services/modules/discord/discord_client/tests/test_helpers.py

@@ -0,0 +1,238 @@
+from unittest import TestCase
+
+from . import ROLE_ALPHA, ROLE_BRAVO, ROLE_CHARLIE, ROLE_MIKE, ALL_ROLES, create_role
+from .. import DiscordRoles
+
+
+MODULE_PATH = 'allianceauth.services.modules.discord.discord_client.client'
+
+
+class TestDiscordRoles(TestCase):
+
+    def setUp(self):
+        self.all_roles = DiscordRoles(ALL_ROLES)
+
+    def test_can_create_simple(self):
+        roles_raw = [ROLE_ALPHA]
+        roles = DiscordRoles(roles_raw)
+        self.assertListEqual(list(roles), roles_raw)
+
+    def test_can_create_empty(self):
+        roles_raw = []
+        roles = DiscordRoles(roles_raw)
+        self.assertListEqual(list(roles), [])
+
+    def test_raises_exception_if_roles_raw_of_wrong_type(self):
+        with self.assertRaises(TypeError):
+            DiscordRoles({'id': 1})
+    
+    def test_raises_exception_if_list_contains_non_dict(self):
+        roles_raw = [ROLE_ALPHA, 'not_valid']
+        with self.assertRaises(TypeError):
+            DiscordRoles(roles_raw)
+
+    def test_raises_exception_if_invalid_role_1(self):
+        roles_raw = [{'name': 'alpha', 'managed': False}]
+        with self.assertRaises(ValueError):
+            DiscordRoles(roles_raw)
+
+    def test_raises_exception_if_invalid_role_2(self):
+        roles_raw = [{'id': 1, 'managed': False}]
+        with self.assertRaises(ValueError):
+            DiscordRoles(roles_raw)
+
+    def test_raises_exception_if_invalid_role_3(self):
+        roles_raw = [{'id': 1, 'name': 'alpha'}]
+        with self.assertRaises(ValueError):
+            DiscordRoles(roles_raw)
+    
+    def test_roles_are_equal(self):
+        roles_a = DiscordRoles([ROLE_ALPHA, ROLE_BRAVO])
+        roles_b = DiscordRoles([ROLE_ALPHA, ROLE_BRAVO])
+        self.assertEqual(roles_a, roles_b)
+
+    def test_roles_are_not_equal(self):
+        roles_a = DiscordRoles([ROLE_ALPHA, ROLE_BRAVO])
+        roles_b = DiscordRoles([ROLE_ALPHA])
+        self.assertNotEqual(roles_a, roles_b)
+
+    def test_different_objects_are_not_equal(self):
+        roles_a = DiscordRoles([ROLE_ALPHA, ROLE_BRAVO])        
+        self.assertFalse(roles_a == "invalid")
+
+    def test_len(self):        
+        self.assertEqual(len(self.all_roles), 4)
+
+    def test_contains(self):
+        self.assertTrue(1 in self.all_roles)
+        self.assertFalse(99 in self.all_roles)
+
+    def test_sanitize_role_name(self):        
+        role_name_input = 'x' * 110
+        role_name_expected = 'x' * 100                
+        result = DiscordRoles.sanitize_role_name(role_name_input)
+        self.assertEqual(result, role_name_expected)
+
+    def test_objects_are_hashable(self):
+        roles_a = DiscordRoles([ROLE_ALPHA, ROLE_BRAVO])
+        roles_b = DiscordRoles([ROLE_BRAVO, ROLE_ALPHA])
+        roles_c = DiscordRoles([ROLE_ALPHA, ROLE_BRAVO, ROLE_MIKE])
+        self.assertIsNotNone(hash(roles_a))
+        self.assertEqual(hash(roles_a), hash(roles_b))
+        self.assertNotEqual(hash(roles_a), hash(roles_c))
+
+    def test_create_from_matched_roles(self):
+        matched_roles = [
+            (ROLE_ALPHA, True),
+            (ROLE_BRAVO, False)
+        ]
+        roles = DiscordRoles.create_from_matched_roles(matched_roles)
+        self.assertSetEqual(roles.ids(), {1, 2})
+
+
+class TestIds(TestCase):
+
+    def setUp(self):
+        self.all_roles = DiscordRoles(ALL_ROLES)
+        
+    def test_return_role_ids_default(self):        
+        result = self.all_roles.ids()
+        expected = {1, 2, 3, 13}
+        self.assertSetEqual(result, expected)
+
+    def test_return_role_ids_empty(self):
+        roles = DiscordRoles([])
+        self.assertSetEqual(roles.ids(), set())
+
+
+class TestSubset(TestCase):
+
+    def setUp(self):
+        self.all_roles = DiscordRoles(ALL_ROLES)
+
+    def test_ids_only(self):
+        role_ids = {1, 3}
+        roles_subset = self.all_roles.subset(role_ids)
+        expected = {1, 3}
+        self.assertSetEqual(roles_subset.ids(), expected)
+
+    def test_ids_as_string_work_too(self):
+        role_ids = {'1', '3'}
+        roles_subset = self.all_roles.subset(role_ids)
+        expected = {1, 3}
+        self.assertSetEqual(roles_subset.ids(), expected)
+
+    def test_managed_only(self):
+        roles = self.all_roles.subset(managed_only=True)
+        expected = {13}
+        self.assertSetEqual(roles.ids(), expected)
+
+    def test_ids_and_managed_only(self):
+        role_ids = {1, 3, 13}
+        roles_subset = self.all_roles.subset(role_ids, managed_only=True)
+        expected = {13}
+        self.assertSetEqual(roles_subset.ids(), expected)
+
+    def test_ids_are_empty(self):
+        roles = self.all_roles.subset([])
+        expected = set()
+        self.assertSetEqual(roles.ids(), expected)
+
+    def test_no_parameters(self):
+        roles = self.all_roles.subset()
+        expected = {1, 2, 3, 13}
+        self.assertSetEqual(roles.ids(), expected)
+
+
+class TestHasRoles(TestCase):
+
+    def setUp(self):
+        self.all_roles = DiscordRoles(ALL_ROLES)
+
+    def test_true_if_all_roles_exit(self):
+        self.assertTrue(self.all_roles.has_roles([1, 2]))
+
+    def test_true_if_all_roles_exit_str(self):
+        self.assertTrue(self.all_roles.has_roles(['1', '2']))
+    
+    def test_false_if_role_does_not_exit(self):
+        self.assertFalse(self.all_roles.has_roles([99]))
+
+    def test_false_if_one_role_does_not_exit(self):
+        self.assertFalse(self.all_roles.has_roles([1, 99]))
+
+    def test_true_for_empty_roles(self):
+        self.assertTrue(self.all_roles.has_roles([]))
+        
+
+class TestGetMatchingRolesByName(TestCase):
+
+    def setUp(self):
+        self.all_roles = DiscordRoles(ALL_ROLES)
+
+    def test_return_role_if_matches(self):
+        role_name = 'alpha'
+        expected = ROLE_ALPHA
+        result = self.all_roles.role_by_name(role_name)
+        self.assertEqual(result, expected)
+
+    def test_return_role_if_matches_and_limit_max_length(self):
+        role_name = 'x' * 120
+        expected = create_role(77, 'x' * 100)
+        roles = DiscordRoles([expected])
+        result = roles.role_by_name(role_name)
+        self.assertEqual(result, expected)
+
+    def test_return_empty_if_not_matches(self):
+        role_name = 'lima'
+        expected = {}
+        result = self.all_roles.role_by_name(role_name)
+        self.assertEqual(result, expected)
+
+
+class TestUnion(TestCase):
+
+    def test_distinct_sets(self):
+        roles_1 = DiscordRoles([ROLE_ALPHA, ROLE_BRAVO])
+        roles_2 = DiscordRoles([ROLE_CHARLIE, ROLE_MIKE])
+        roles_3 = roles_1.union(roles_2)
+        expected = DiscordRoles([ROLE_ALPHA, ROLE_BRAVO, ROLE_CHARLIE, ROLE_MIKE])
+        self.assertEqual(roles_3, expected)
+
+    def test_overlapping_sets(self):
+        roles_1 = DiscordRoles([ROLE_ALPHA, ROLE_BRAVO])
+        roles_2 = DiscordRoles([ROLE_BRAVO, ROLE_MIKE])
+        roles_3 = roles_1.union(roles_2)
+        expected = DiscordRoles([ROLE_ALPHA, ROLE_BRAVO, ROLE_MIKE])
+        self.assertEqual(roles_3, expected)
+
+    def test_identical_sets(self):
+        roles_1 = DiscordRoles([ROLE_ALPHA, ROLE_BRAVO])
+        roles_2 = DiscordRoles([ROLE_ALPHA, ROLE_BRAVO])
+        roles_3 = roles_1.union(roles_2)
+        expected = DiscordRoles([ROLE_ALPHA, ROLE_BRAVO])
+        self.assertEqual(roles_3, expected)
+
+
+class TestDifference(TestCase):
+
+    def test_distinct_sets(self):
+        roles_1 = DiscordRoles([ROLE_ALPHA, ROLE_BRAVO])
+        roles_2 = DiscordRoles([ROLE_CHARLIE, ROLE_MIKE])
+        roles_3 = roles_1.difference(roles_2)
+        expected = DiscordRoles([ROLE_ALPHA, ROLE_BRAVO])
+        self.assertEqual(roles_3, expected)
+
+    def test_overlapping_sets(self):
+        roles_1 = DiscordRoles([ROLE_ALPHA, ROLE_BRAVO])
+        roles_2 = DiscordRoles([ROLE_BRAVO, ROLE_MIKE])
+        roles_3 = roles_1.difference(roles_2)
+        expected = DiscordRoles([ROLE_ALPHA])
+        self.assertEqual(roles_3, expected)
+
+    def test_identical_sets(self):
+        roles_1 = DiscordRoles([ROLE_ALPHA, ROLE_BRAVO])
+        roles_2 = DiscordRoles([ROLE_ALPHA, ROLE_BRAVO])
+        roles_3 = roles_1.difference(roles_2)
+        expected = DiscordRoles([])
+        self.assertEqual(roles_3, expected)

allianceauth/services/modules/discord/manager.py

@@ -1,333 +0,0 @@
-import requests
-import math
-from django.conf import settings
-from requests_oauthlib import OAuth2Session
-from functools import wraps
-import logging
-import datetime
-import time
-from django.core.cache import cache
-from hashlib import md5
-
-logger = logging.getLogger(__name__)
-
-DISCORD_URL = "https://discordapp.com/api"
-
-AUTH_URL = "https://discordapp.com/api/oauth2/authorize"
-TOKEN_URL = "https://discordapp.com/api/oauth2/token"
-
-"""
-Previously all we asked for was permission to kick members, manage roles, and manage nicknames.
-Users have reported weird unauthorized errors we don't understand. So now we ask for full server admin.
-It's almost fixed the problem.
-"""
-# kick members, manage roles, manage nicknames, create instant invite
-# BOT_PERMISSIONS = 0x00000002 + 0x10000000 + 0x08000000 + 0x00000001
-BOT_PERMISSIONS = 0x00000008
-
-# get user ID, accept invite
-SCOPES = [
-    'identify',
-    'guilds.join',
-]
-
-GROUP_CACHE_MAX_AGE = getattr(settings, 'DISCORD_GROUP_CACHE_MAX_AGE', 2 * 60 * 60)  # 2 hours default
-
-
-class DiscordApiException(Exception):
-    def __init__(self):
-        super(Exception, self).__init__()
-
-
-class DiscordApiTooBusy(DiscordApiException):
-    def __init__(self):
-        super(DiscordApiException, self).__init__()
-        self.message = "The Discord API is too busy to process this request now, please try again later."
-
-
-class DiscordApiBackoff(DiscordApiException):
-    def __init__(self, retry_after, global_ratelimit):
-        """
-        :param retry_after: int time to retry after in milliseconds
-        :param global_ratelimit: bool Is the API under a global backoff
-        """
-        super(DiscordApiException, self).__init__()
-        self.retry_after = retry_after
-        self.global_ratelimit = global_ratelimit
-
-    @property
-    def retry_after_seconds(self):
-        return math.ceil(self.retry_after / 1000)
-
-
-cache_time_format = '%Y-%m-%d %H:%M:%S.%f'
-
-
-def api_backoff(func):
-    """
-    Decorator, Handles HTTP 429 "Too Many Requests" messages from the Discord API
-    If blocking=True is specified, this function will block and retry
-    the function up to max_retries=n times, or 3 if retries is not specified.
-    If the API call still recieves a backoff timer this function will raise
-    a <DiscordApiTooBusy> exception.
-    If the caller chooses blocking=False, the decorator will raise a DiscordApiBackoff
-    exception and the caller can choose to retry after the given timespan available in
-    the retry_after property in seconds.
-    """
-
-    class PerformBackoff(Exception):
-        def __init__(self, retry_after, retry_datetime, global_ratelimit):
-            super(Exception, self).__init__()
-            self.retry_after = int(retry_after)
-            self.retry_datetime = retry_datetime
-            self.global_ratelimit = global_ratelimit
-
-    @wraps(func)
-    def decorated(*args, **kwargs):
-        blocking = kwargs.get('blocking', False)
-        retries = kwargs.get('max_retries', 3)
-
-        # Strip our parameters
-        if 'max_retries' in kwargs:
-            del kwargs['max_retries']
-        if 'blocking' in kwargs:
-            del kwargs['blocking']
-
-        cache_key = 'DISCORD_BACKOFF_' + func.__name__
-        cache_global_key = 'DISCORD_BACKOFF_GLOBAL'
-
-        while retries > 0:
-            try:
-                try:
-                    # Check global backoff first, then route backoff
-                    existing_global_backoff = cache.get(cache_global_key)
-                    existing_backoff = existing_global_backoff or cache.get(cache_key)
-                    if existing_backoff:
-                        backoff_timer = datetime.datetime.strptime(existing_backoff, cache_time_format)
-                        if backoff_timer > datetime.datetime.utcnow():
-                            backoff_seconds = (backoff_timer - datetime.datetime.utcnow()).total_seconds()
-                            logger.debug("Still under backoff for %s seconds, backing off" % backoff_seconds)
-                            # Still under backoff
-                            raise PerformBackoff(
-                                retry_after=backoff_seconds,
-                                retry_datetime=backoff_timer,
-                                global_ratelimit=bool(existing_global_backoff)
-                            )
-                    logger.debug("Calling API calling function")
-                    return func(*args, **kwargs)
-                except requests.HTTPError as e:
-                    if e.response.status_code == 429:
-                        try:
-                            retry_after = int(e.response.headers['Retry-After'])
-                        except (TypeError, KeyError):
-                            # Pick some random time
-                            retry_after = 5000
-
-                        logger.info("Received backoff from API of %s seconds, handling" % retry_after)
-                        # Store value in redis
-                        backoff_until = (datetime.datetime.utcnow() +
-                                         datetime.timedelta(milliseconds=retry_after))
-                        global_backoff = bool(e.response.headers.get('X-RateLimit-Global', False))
-                        if global_backoff:
-                            logger.info("Global backoff!!")
-                            cache.set(cache_global_key, backoff_until.strftime(cache_time_format), retry_after)
-                        else:
-                            cache.set(cache_key, backoff_until.strftime(cache_time_format), retry_after)
-                        raise PerformBackoff(retry_after=retry_after, retry_datetime=backoff_until,
-                                             global_ratelimit=global_backoff)
-                    else:
-                        # Not 429, re-raise
-                        raise e
-            except PerformBackoff as bo:
-                # Sleep if we're blocking
-                if blocking:
-                    logger.info("Blocking Back off from API calls for %s seconds" % bo.retry_after)
-                    time.sleep((10 if bo.retry_after > 10 else bo.retry_after) / 1000)
-                else:
-                    # Otherwise raise exception and let caller handle the backoff
-                    raise DiscordApiBackoff(retry_after=bo.retry_after, global_ratelimit=bo.global_ratelimit)
-            finally:
-                retries -= 1
-        if retries == 0:
-            raise DiscordApiTooBusy()
-    return decorated
-
-
-class DiscordOAuthManager:
-    def __init__(self):
-        pass
-
-    @staticmethod
-    def _sanitize_name(name):
-        return name[:32]
-
-    @staticmethod
-    def _sanitize_group_name(name):
-        return name[:100]
-
-    @staticmethod
-    def generate_bot_add_url():
-        return AUTH_URL + '?client_id=' + settings.DISCORD_APP_ID + '&scope=bot&permissions=' + str(BOT_PERMISSIONS)
-
-    @staticmethod
-    def generate_oauth_redirect_url():
-        oauth = OAuth2Session(settings.DISCORD_APP_ID, redirect_uri=settings.DISCORD_CALLBACK_URL, scope=SCOPES)
-        url, state = oauth.authorization_url(AUTH_URL)
-        return url
-
-    @staticmethod
-    def _process_callback_code(code):
-        oauth = OAuth2Session(settings.DISCORD_APP_ID, redirect_uri=settings.DISCORD_CALLBACK_URL)
-        token = oauth.fetch_token(TOKEN_URL, client_secret=settings.DISCORD_APP_SECRET, code=code)
-        return token
-
-    @staticmethod
-    def add_user(code, groups, nickname=None):
-        try:
-            token = DiscordOAuthManager._process_callback_code(code)['access_token']
-            logger.debug("Received token from OAuth")
-
-            custom_headers = {'accept': 'application/json', 'authorization': 'Bearer ' + token}
-            path = DISCORD_URL + "/users/@me"
-            r = requests.get(path, headers=custom_headers)
-            logger.debug("Got status code %s after retrieving Discord profile" % r.status_code)
-            r.raise_for_status()
-
-            user_id = r.json()['id']
-
-            path = DISCORD_URL + "/guilds/" + str(settings.DISCORD_GUILD_ID) + "/members/" + str(user_id)
-            group_ids = [DiscordOAuthManager._group_name_to_id(DiscordOAuthManager._sanitize_group_name(g)) for g in
-                         groups]
-            data = {
-                'roles': group_ids,
-                'access_token': token,
-            }
-            if nickname:
-                data['nick'] = DiscordOAuthManager._sanitize_name(nickname)
-            custom_headers['authorization'] = 'Bot ' + settings.DISCORD_BOT_TOKEN
-            r = requests.put(path, headers=custom_headers, json=data)
-            logger.debug("Got status code %s after joining Discord server" % r.status_code)
-            r.raise_for_status()
-
-            logger.info("Added Discord user ID %s to server." % user_id)
-            return user_id
-        except:
-            logger.exception("Failed to add Discord user")
-            return None
-
-    @staticmethod
-    @api_backoff
-    def update_nickname(user_id, nickname):
-        nickname = DiscordOAuthManager._sanitize_name(nickname)
-        custom_headers = {'content-type': 'application/json', 'authorization': 'Bot ' + settings.DISCORD_BOT_TOKEN}
-        data = {'nick': nickname}
-        path = DISCORD_URL + "/guilds/" + str(settings.DISCORD_GUILD_ID) + "/members/" + str(user_id)
-        r = requests.patch(path, headers=custom_headers, json=data)
-        logger.debug("Got status code %s after setting nickname for Discord user ID %s (%s)" % (
-            r.status_code, user_id, nickname))
-        if r.status_code == 404:
-            logger.warn("Discord user ID %s could not be found in server." % user_id)
-            return True
-        r.raise_for_status()
-        return True
-
-    @staticmethod
-    def delete_user(user_id):
-        try:
-            custom_headers = {'accept': 'application/json', 'authorization': 'Bot ' + settings.DISCORD_BOT_TOKEN}
-            path = DISCORD_URL + "/guilds/" + str(settings.DISCORD_GUILD_ID) + "/members/" + str(user_id)
-            r = requests.delete(path, headers=custom_headers)
-            logger.debug("Got status code %s after removing Discord user ID %s" % (r.status_code, user_id))
-            if r.status_code == 404:
-                logger.warn("Discord user ID %s already left the server." % user_id)
-                return True
-            r.raise_for_status()
-            return True
-        except:
-            logger.exception("Failed to remove Discord user ID %s" % user_id)
-            return False
-
-    @staticmethod
-    def _get_groups():
-        custom_headers = {'accept': 'application/json', 'authorization': 'Bot ' + settings.DISCORD_BOT_TOKEN}
-        path = DISCORD_URL + "/guilds/" + str(settings.DISCORD_GUILD_ID) + "/roles"
-        r = requests.get(path, headers=custom_headers)
-        logger.debug("Got status code %s after retrieving Discord roles" % r.status_code)
-        r.raise_for_status()
-        return r.json()
-
-    @staticmethod
-    def _generate_cache_role_key(name):
-        return 'DISCORD_ROLE_NAME__%s' % md5(str(name).encode('utf-8')).hexdigest()
-
-    @staticmethod
-    def _group_name_to_id(name):
-        name = DiscordOAuthManager._sanitize_group_name(name)
-
-        def get_or_make_role():
-            groups = DiscordOAuthManager._get_groups()
-            for g in groups:
-                if g['name'] == name:
-                    return g['id']
-            return DiscordOAuthManager._create_group(name)['id']
-        return cache.get_or_set(DiscordOAuthManager._generate_cache_role_key(name), get_or_make_role, GROUP_CACHE_MAX_AGE)
-
-    @staticmethod
-    def __generate_role(name, **kwargs):
-        custom_headers = {'accept': 'application/json', 'authorization': 'Bot ' + settings.DISCORD_BOT_TOKEN}
-        path = DISCORD_URL + "/guilds/" + str(settings.DISCORD_GUILD_ID) + "/roles"
-        data = {'name': name}
-        data.update(kwargs)
-        r = requests.post(path, headers=custom_headers, json=data)
-        logger.debug("Received status code %s after generating new role." % r.status_code)
-        r.raise_for_status()
-        return r.json()
-
-    @staticmethod
-    def __edit_role(role_id, **kwargs):
-        custom_headers = {'content-type': 'application/json', 'authorization': 'Bot ' + settings.DISCORD_BOT_TOKEN}
-        path = DISCORD_URL + "/guilds/" + str(settings.DISCORD_GUILD_ID) + "/roles/" + str(role_id)
-        r = requests.patch(path, headers=custom_headers, json=kwargs)
-        logger.debug("Received status code %s after editing role id %s" % (r.status_code, role_id))
-        r.raise_for_status()
-        return r.json()
-
-    @staticmethod
-    def _create_group(name):
-        return DiscordOAuthManager.__generate_role(name)
-
-    @staticmethod
-    def _get_user(user_id):
-        custom_headers = {'content-type': 'application/json', 'authorization': 'Bot ' + settings.DISCORD_BOT_TOKEN}
-        path = DISCORD_URL + "/guilds/" + str(settings.DISCORD_GUILD_ID) + "/members/" + str(user_id)
-        r = requests.get(path, headers=custom_headers)
-        r.raise_for_status()
-        return r.json()
-
-    @staticmethod
-    def _get_user_roles(user_id):
-        user = DiscordOAuthManager._get_user(user_id)
-        return user['roles']
-
-    @staticmethod
-    def _modify_user_role(user_id, role_id, method):
-        custom_headers = {'content-type': 'application/json', 'authorization': 'Bot ' + settings.DISCORD_BOT_TOKEN}
-        path = DISCORD_URL + "/guilds/" + str(settings.DISCORD_GUILD_ID) + "/members/" + str(user_id) + "/roles/" + str(
-            role_id)
-        r = getattr(requests, method)(path, headers=custom_headers)
-        r.raise_for_status()
-        logger.debug("%s role %s for user %s" % (method, role_id, user_id))
-
-    @staticmethod
-    @api_backoff
-    def update_groups(user_id, groups):
-        group_ids = [DiscordOAuthManager._group_name_to_id(DiscordOAuthManager._sanitize_group_name(g)) for g in groups]
-        user_group_ids = DiscordOAuthManager._get_user_roles(user_id)
-        for g in group_ids:
-            if g not in user_group_ids:
-                DiscordOAuthManager._modify_user_role(user_id, g, 'put')
-                time.sleep(1)  # we're gonna be hammering the API here
-        for g in user_group_ids:
-            if g not in group_ids:
-                DiscordOAuthManager._modify_user_role(user_id, g, 'delete')
-                time.sleep(1)

allianceauth/services/modules/discord/managers.py

@@ -0,0 +1,180 @@
+import logging
+from urllib.parse import urlencode
+
+from requests_oauthlib import OAuth2Session
+from requests.exceptions import HTTPError
+
+from django.contrib.auth.models import User
+from django.db import models
+from django.utils.timezone import now
+
+from allianceauth.services.hooks import NameFormatter
+
+from . import __title__
+from .app_settings import (
+    DISCORD_APP_ID,
+    DISCORD_APP_SECRET,
+    DISCORD_BOT_TOKEN,
+    DISCORD_CALLBACK_URL,
+    DISCORD_GUILD_ID,    
+    DISCORD_SYNC_NAMES
+)
+from .discord_client import DiscordClient, DiscordApiBackoff
+from .discord_client.helpers import match_or_create_roles_from_names
+from .utils import LoggerAddTag
+
+
+logger = LoggerAddTag(logging.getLogger(__name__), __title__)
+
+
+class DiscordUserManager(models.Manager):
+    """Manager for DiscordUser"""
+
+    # full server admin
+    BOT_PERMISSIONS = 0x00000008
+
+    # get user ID, accept invite
+    SCOPES = [
+        'identify',
+        'guilds.join',
+    ]
+
+    def add_user(
+        self, 
+        user: User, 
+        authorization_code: str, 
+        is_rate_limited: bool = True
+    ) -> bool:
+        """adds a new Discord user
+
+        Params:
+        - user: Auth user to join
+        - authorization_code: authorization code returns from oauth
+        - is_rate_limited: When False will disable default rate limiting (use with care)
+        
+        Returns: True on success, else False or raises exception
+        """
+        try:        
+            nickname = self.user_formatted_nick(user) if DISCORD_SYNC_NAMES else None
+            group_names = self.user_group_names(user)
+            access_token = self._exchange_auth_code_for_token(authorization_code)
+            user_client = DiscordClient(access_token, is_rate_limited=is_rate_limited)
+            discord_user = user_client.current_user()
+            user_id = discord_user['id']
+            bot_client = self._bot_client(is_rate_limited=is_rate_limited)
+                
+            if group_names:                
+                role_ids = match_or_create_roles_from_names(
+                    client=bot_client, 
+                    guild_id=DISCORD_GUILD_ID, 
+                    role_names=group_names
+                ).ids()
+            else:
+                role_ids = None
+                        
+            created = bot_client.add_guild_member(
+                guild_id=DISCORD_GUILD_ID, 
+                user_id=user_id,
+                access_token=access_token,
+                role_ids=role_ids,
+                nick=nickname
+            )
+            if created is not False:
+                if created is None:
+                    logger.debug(
+                        "User %s with Discord ID %s is already a member.",
+                        user,
+                        user_id,
+                    )
+                self.update_or_create(
+                    user=user, 
+                    defaults={
+                        'uid': user_id, 
+                        'username': discord_user['username'][:32], 
+                        'discriminator': discord_user['discriminator'][:4],
+                        'activated': now()
+                    }
+                )
+                logger.info(
+                    "Added user %s with Discord ID %s to Discord server", user, user_id
+                )
+                return True
+
+            else:
+                logger.warning(
+                    "Failed to add user %s with Discord ID %s to Discord server",
+                    user,
+                    user_id,
+                )
+                return False
+
+        except (HTTPError, ConnectionError, DiscordApiBackoff) as ex:
+            logger.exception(
+                'Failed to add user %s to Discord server: %s', user, ex
+            )
+            return False
+
+    @staticmethod
+    def user_formatted_nick(user: User) -> str:
+        """returns the name of the given users main character with name formatting
+        or None if user has no main
+        """
+        from .auth_hooks import DiscordService
+        
+        if user.profile.main_character:
+            return NameFormatter(DiscordService(), user).format_name()
+        else:
+            return None
+
+    @staticmethod
+    def user_group_names(user: User) -> list:
+        """returns list of group names plus state the given user is a member of"""
+        return [group.name for group in user.groups.all()] + [user.profile.state.name]
+    
+    def user_has_account(self, user: User) -> bool:
+        """Returns True if the user has an Discord account, else False
+        
+        only checks locally, does not hit the API
+        """
+        if not isinstance(user, User):
+            return False
+        return self.filter(user=user).select_related('user').exists()
+
+    @classmethod
+    def generate_bot_add_url(cls):
+        params = urlencode({
+            'client_id': DISCORD_APP_ID,
+            'scope': 'bot',
+            'permissions': str(cls.BOT_PERMISSIONS)
+
+        })
+        return f'{DiscordClient.OAUTH_BASE_URL}?{params}'        
+
+    @classmethod
+    def generate_oauth_redirect_url(cls):
+        oauth = OAuth2Session(
+            DISCORD_APP_ID, redirect_uri=DISCORD_CALLBACK_URL, scope=cls.SCOPES
+        )
+        url, state = oauth.authorization_url(DiscordClient.OAUTH_BASE_URL)
+        return url
+
+    @staticmethod
+    def _exchange_auth_code_for_token(authorization_code: str) -> str:
+        oauth = OAuth2Session(DISCORD_APP_ID, redirect_uri=DISCORD_CALLBACK_URL)
+        token = oauth.fetch_token(
+            DiscordClient.OAUTH_TOKEN_URL, 
+            client_secret=DISCORD_APP_SECRET, 
+            code=authorization_code
+        )
+        logger.debug("Received token from OAuth")
+        return token['access_token']
+    
+    @classmethod
+    def server_name(cls):
+        """returns the name of the Discord server"""        
+        return cls._bot_client().guild_name(DISCORD_GUILD_ID)
+
+    @staticmethod
+    def _bot_client(is_rate_limited: bool = True):
+        """returns a bot client for access to the Discord API"""
+        return DiscordClient(DISCORD_BOT_TOKEN, is_rate_limited=is_rate_limited)

allianceauth/services/modules/discord/migrations/0003_big_overhaul.py

@@ -0,0 +1,40 @@
+# Generated by Django 2.2.12 on 2020-05-10 19:59
+
+from django.conf import settings
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('discord', '0002_service_permissions'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='discorduser',
+            name='activated',
+            field=models.DateTimeField(blank=True, default=None, help_text='Date & time this service account was activated', null=True),
+        ),
+        migrations.AddField(
+            model_name='discorduser',
+            name='discriminator',
+            field=models.CharField(blank=True, default='', help_text="user's discriminator on Discord", max_length=4),
+        ),
+        migrations.AddField(
+            model_name='discorduser',
+            name='username',
+            field=models.CharField(blank=True, db_index=True, default='', help_text="user's username on Discord", max_length=32),
+        ),
+        migrations.AlterField(
+            model_name='discorduser',
+            name='uid',
+            field=models.BigIntegerField(db_index=True, help_text="user's ID on Discord"),
+        ),
+        migrations.AlterField(
+            model_name='discorduser',
+            name='user',
+            field=models.OneToOneField(help_text='Auth user owning this Discord account', on_delete=django.db.models.deletion.CASCADE, primary_key=True, related_name='discord', serialize=False, to=settings.AUTH_USER_MODEL),
+        ),
+    ]

allianceauth/services/modules/discord/models.py

@@ -1,18 +1,242 @@
+import logging
+
+from requests.exceptions import HTTPError
+
 from django.contrib.auth.models import User
 from django.db import models
+from django.utils.translation import gettext_lazy
+
+from allianceauth.notifications import notify
+
+from . import __title__
+from .app_settings import DISCORD_GUILD_ID
+from .discord_client import DiscordApiBackoff, DiscordRoles
+from .discord_client.helpers import match_or_create_roles_from_names
+from .managers import DiscordUserManager
+from .utils import LoggerAddTag
+
+
+logger = LoggerAddTag(logging.getLogger(__name__), __title__)
 
 
 class DiscordUser(models.Model):
-    user = models.OneToOneField(User,
-                                primary_key=True,
-                                on_delete=models.CASCADE,
-                                related_name='discord')
-    uid = models.CharField(max_length=254)
 
-    def __str__(self):
+    USER_RELATED_NAME = 'discord'
-        return "{} - {}".format(self.user.username, self.uid)
+    
+    user = models.OneToOneField(
+        User, 
+        primary_key=True, 
+        on_delete=models.CASCADE, 
+        related_name=USER_RELATED_NAME,
+        help_text='Auth user owning this Discord account'
+    )
+    uid = models.BigIntegerField(
+        db_index=True,
+        help_text='user\'s ID on Discord'
+    )
+    username = models.CharField(
+        max_length=32, 
+        default='', 
+        blank=True,
+        db_index=True,
+        help_text='user\'s username on Discord'
+    )
+    discriminator = models.CharField(
+        max_length=4, 
+        default='', 
+        blank=True, 
+        help_text='user\'s discriminator on Discord'
+    )
+    activated = models.DateTimeField(
+        default=None, 
+        null=True, 
+        blank=True,
+        help_text='Date & time this service account was activated'
+    )
+
+    objects = DiscordUserManager()
 
     class Meta:
         permissions = (
-            ("access_discord", u"Can access the Discord service"),
+            ("access_discord", "Can access the Discord service"),
         )
+
+    def __str__(self):
+        return f'{self.user.username} - {self.uid}'
+
+    def __repr__(self):
+        return f'{type(self).__name__}(user=\'{self.user}\', uid={self.uid})'
+
+    def update_nickname(self) -> bool:
+        """Update nickname with formatted name of main character
+                
+        Returns:
+        - True on success
+        - None if user is no longer a member of the Discord server
+        - False on error or raises exception
+        """        
+        requested_nick = DiscordUser.objects.user_formatted_nick(self.user)
+        if requested_nick:            
+            client = DiscordUser.objects._bot_client()            
+            success = client.modify_guild_member(
+                guild_id=DISCORD_GUILD_ID,
+                user_id=self.uid,
+                nick=requested_nick
+            )
+            if success:
+                logger.info('Nickname for %s has been updated', self.user)
+            else:
+                logger.warning('Failed to update nickname for %s', self.user)
+            return success
+         
+        else:
+            return False
+
+    def update_groups(self) -> bool:
+        """update groups for a user based on his current group memberships. 
+        Will add or remove roles of a user as needed.
+        
+        Returns:
+        - True on success
+        - None if user is no longer a member of the Discord server
+        - False on error or raises exception
+        """        
+        client = DiscordUser.objects._bot_client()                                
+        member_info = client.guild_member(guild_id=DISCORD_GUILD_ID, user_id=self.uid)
+        if member_info is None:            
+            # User is no longer a member
+            return None
+        
+        guild_roles = DiscordRoles(client.guild_roles(guild_id=DISCORD_GUILD_ID))
+        logger.debug('Current guild roles: %s', guild_roles.ids())
+        if 'roles' in member_info:
+            if not guild_roles.has_roles(member_info['roles']):
+                guild_roles = DiscordRoles(
+                    client.guild_roles(guild_id=DISCORD_GUILD_ID, use_cache=False)
+                )
+                if not guild_roles.has_roles(member_info['roles']):
+                    raise RuntimeError(
+                        'Member %s has unknown roles: %s' % (
+                            self.user, 
+                            set(member_info['roles']).difference(guild_roles.ids())
+                        )
+                    )
+            member_roles = guild_roles.subset(member_info['roles'])
+        else:
+            raise RuntimeError('member_info from %s is not valid' % self.user)
+                
+        requested_roles = match_or_create_roles_from_names(
+            client=client, 
+            guild_id=DISCORD_GUILD_ID, 
+            role_names=DiscordUser.objects.user_group_names(self.user)
+        )
+        logger.debug(
+            'Requested roles for user %s: %s', self.user, requested_roles.ids()
+        )
+        logger.debug('Current roles user %s: %s', self.user, member_roles.ids())        
+        member_roles_managed = member_roles.subset(managed_only=True)
+        if requested_roles != member_roles.difference(member_roles_managed):
+            logger.debug('Need to update roles for user %s', self.user)
+            new_roles = requested_roles.union(member_roles_managed)
+            success = client.modify_guild_member(
+                guild_id=DISCORD_GUILD_ID,
+                user_id=self.uid,
+                role_ids=list(new_roles.ids())
+            )
+            if success:
+                logger.info('Groups for %s have been updated', self.user)
+            else:
+                logger.warning('Failed to update groups for %s', self.user)
+            return success
+
+        else:
+            logger.info('No need to update groups for user %s', self.user)
+            return True
+
+    def update_username(self) -> bool:
+        """Updates the username incl. the discriminator 
+        from the Discord server and saves it
+                
+        Returns:
+        - True on success
+        - None if user is no longer a member of the Discord server
+        - False on error or raises exception
+        """        
+    
+        client = DiscordUser.objects._bot_client()            
+        user_info = client.guild_member(guild_id=DISCORD_GUILD_ID, user_id=self.uid)
+        if user_info is None:
+            success = None
+        elif (
+            user_info 
+            and 'user' in user_info 
+            and 'username' in user_info['user'] 
+            and 'discriminator' in user_info['user']
+        ):            
+            self.username = user_info['user']['username']
+            self.discriminator = user_info['user']['discriminator']
+            self.save()
+            logger.info('Username for %s has been updated', self.user)
+            success = True
+        else:
+            logger.warning('Failed to update username for %s', self.user)
+            success = False
+        return success
+                
+    def delete_user(
+        self, 
+        notify_user: bool = False, 
+        is_rate_limited: bool = True,
+        handle_api_exceptions: bool = False
+    ) -> bool:
+        """Deletes the Discount user both on the server and locally
+
+        Params:
+        - notify_user: When True will sent a notification to the user 
+        informing him about the deleting of his account
+        - is_rate_limited: When False will disable default rate limiting (use with care)
+        - handle_api_exceptions: When True method will return False 
+        when an API exception occurs
+        
+        Returns True when successful, otherwise False or raises exceptions
+        Return None if user does no longer exist
+        """
+        try:
+            client = DiscordUser.objects._bot_client(is_rate_limited=is_rate_limited)
+            success = client.remove_guild_member(
+                guild_id=DISCORD_GUILD_ID, user_id=self.uid
+            )
+            if success is not False:
+                deleted_count, _ = self.delete()
+                if deleted_count > 0:
+                    if notify_user:
+                        notify(
+                            user=self.user, 
+                            title=gettext_lazy('Discord Account Disabled'), 
+                            message=gettext_lazy(
+                                'Your Discord account was disabeled automatically '
+                                'by Auth. If you think this was a mistake, '
+                                'please contact an admin.'
+                            ),
+                            level='warning'
+                        )
+                    logger.info('Account for user %s was deleted.', self.user)
+                    return True
+                else:
+                    logger.debug('Account for user %s was already deleted.', self.user)
+                    return None
+            
+            else:
+                logger.warning(
+                    'Failed to remove user %s from the Discord server', self.user
+                )
+                return False
+        
+        except (HTTPError, ConnectionError, DiscordApiBackoff) as ex:
+            if handle_api_exceptions:
+                logger.exception(
+                    'Failed to remove user %s from Discord server: %s', self.user, ex
+                )
+                return False        
+            else:
+                raise ex

allianceauth/services/modules/discord/tasks.py

@@ -1,148 +1,228 @@
 import logging
 
-from django.conf import settings
+from celery import shared_task, chain
-from django.contrib.auth.models import User
-from django.core.exceptions import ObjectDoesNotExist
-from allianceauth.notifications import notify
-from celery import shared_task
 from requests.exceptions import HTTPError
-from allianceauth.services.hooks import NameFormatter
+
-from .manager import DiscordOAuthManager, DiscordApiBackoff
+from django.contrib.auth.models import User
-from .models import DiscordUser
+from django.db.models.query import QuerySet
+
 from allianceauth.services.tasks import QueueOnce
 
-logger = logging.getLogger(__name__)
+from . import __title__
+from .app_settings import (
+    DISCORD_TASKS_MAX_RETRIES, DISCORD_TASKS_RETRY_PAUSE, DISCORD_SYNC_NAMES
+)
+from .discord_client import DiscordApiBackoff
+from .models import DiscordUser
+from .utils import LoggerAddTag
 
 
-class DiscordTasks:
+logger = LoggerAddTag(logging.getLogger(__name__), __title__)
-    def __init__(self):
-        pass
 
-    @classmethod
+# task priority of bulk tasks
-    def add_user(cls, user, code):
+BULK_TASK_PRIORITY = 6
-        groups = DiscordTasks.get_groups(user)
-        nickname = None
-        if settings.DISCORD_SYNC_NAMES:
-            nickname = DiscordTasks.get_nickname(user)
-        user_id = DiscordOAuthManager.add_user(code, groups, nickname=nickname)
-        if user_id:
-            discord_user = DiscordUser()
-            discord_user.user = user
-            discord_user.uid = user_id
-            discord_user.save()
-            return True
-        return False
 
-    @classmethod
-    def delete_user(cls, user, notify_user=False):
-        if cls.has_account(user):
-            logger.debug("User %s has discord account %s. Deleting." % (user, user.discord.uid))
-            if DiscordOAuthManager.delete_user(user.discord.uid):
-                user.discord.delete()
-                if notify_user:
-                    notify(user, 'Discord Account Disabled', level='danger')
-                return True
-        return False
 
-    @classmethod
+@shared_task(
-    def has_account(cls, user):
+    bind=True, name='discord.update_groups', base=QueueOnce, max_retries=None
-        """
+)
-        Check if the user has an account (has a DiscordUser record)
+def update_groups(self, user_pk: int) -> None:
-        :param user: django.contrib.auth.models.User
+    """Update roles on Discord for given user according to his current groups
-        :return: bool
+    
-        """
+    Params:
+    - user_pk: PK of given user
+    """
+    _task_perform_user_action(self, user_pk, 'update_groups')
+
+
+@shared_task(
+    bind=True, name='discord.update_nickname', base=QueueOnce, max_retries=None
+)
+def update_nickname(self, user_pk: int) -> None:
+    """Set nickname on Discord for given user to his main character name
+    
+    Params:
+    - user_pk: PK of given user
+    """
+    _task_perform_user_action(self, user_pk, 'update_nickname')
+
+
+@shared_task(
+    bind=True, name='discord.update_username', base=QueueOnce, max_retries=None
+)
+def update_username(self, user_pk: int) -> None:
+    """Update locally stored Discord username from Discord server for given user
+    
+    Params:
+    - user_pk: PK of given user
+    """
+    _task_perform_user_action(self, user_pk, 'update_username')
+
+
+@shared_task(
+    bind=True, name='discord.delete_user', base=QueueOnce, max_retries=None
+)
+def delete_user(self, user_pk: int, notify_user: bool = False) -> None:
+    """Delete Discord user
+    
+    Params:
+    - user_pk: PK of given user
+    """
+    _task_perform_user_action(self, user_pk, 'delete_user', notify_user=notify_user)
+
+
+def _task_perform_user_action(self, user_pk: int, method: str, **kwargs) -> None:
+    """perform a user related action incl. managing all exceptions"""
+    logger.debug("Starting %s for user with pk %s", method, user_pk)
+    user = User.objects.get(pk=user_pk)    
+    if DiscordUser.objects.user_has_account(user):
+        logger.info("Running %s for user %s", method, user)
         try:
-            user.discord
+            success = getattr(user.discord, method)(**kwargs)
-        except ObjectDoesNotExist:
-            return False
-        else:
-            return True
         
-    @staticmethod
+        except DiscordApiBackoff as bo:
-    @shared_task(bind=True, name='discord.update_groups', base=QueueOnce)
+            logger.info(
-    def update_groups(self, pk):
+                "API back off for %s wth user %s due to %r, retrying in %s seconds",
-        user = User.objects.get(pk=pk)
+                method,
-        logger.debug("Updating discord groups for user %s" % user)
+                user,
-        if DiscordTasks.has_account(user):
+                bo,
-            groups = DiscordTasks.get_groups(user)
+                bo.retry_after_seconds
-            logger.debug("Updating user %s discord groups to %s" % (user, groups))
+            )
-            try:
+            raise self.retry(countdown=bo.retry_after_seconds)     
-                DiscordOAuthManager.update_groups(user.discord.uid, groups)
-            except DiscordApiBackoff as bo:
-                logger.info("Discord group sync API back off for %s, "
-                            "retrying in %s seconds" % (user, bo.retry_after_seconds))
-                raise self.retry(countdown=bo.retry_after_seconds)
-            except HTTPError as e:
-                if e.response.status_code == 404:
-                    try:
-                        if e.response.json()['code'] == 10007:
-                            # user has left the server
-                            DiscordTasks.delete_user(user)
-                            return
-                    finally:
-                        raise e
-            except Exception as e:
-                if self:
-                    logger.exception("Discord group sync failed for %s, retrying in 10 mins" % user)
-                    raise self.retry(countdown=60 * 10)
-                else:
-                    # Rethrow
-                    raise e
-            logger.debug("Updated user %s discord groups." % user)
-        else:
-            logger.debug("User does not have a discord account, skipping")
         
-    @staticmethod
+        except AttributeError:
-    @shared_task(name='discord.update_all_groups')
+            raise ValueError(f'{method} not a valid method for DiscordUser: %r')
-    def update_all_groups():
-        logger.debug("Updating ALL discord groups")
-        for discord_user in DiscordUser.objects.exclude(uid__exact=''):
-            DiscordTasks.update_groups.delay(discord_user.user.pk)
 
-    @staticmethod
+        except (HTTPError, ConnectionError):           
-    @shared_task(bind=True, name='discord.update_nickname', base=QueueOnce)
+            logger.warning(
-    def update_nickname(self, pk):
+                '%s failed for user %s, retrying in %d secs', 
-        user = User.objects.get(pk=pk)
+                method,
-        logger.debug("Updating discord nickname for user %s" % user)
+                user,                    
-        if DiscordTasks.has_account(user):
+                DISCORD_TASKS_RETRY_PAUSE,
-            if user.profile.main_character:
+                exc_info=True
-                character = user.profile.main_character
+            )
-                logger.debug("Updating user %s discord nickname to %s" % (user, character.character_name))
+            if self.request.retries < DISCORD_TASKS_MAX_RETRIES:
-                try:
+                raise self.retry(countdown=DISCORD_TASKS_RETRY_PAUSE)
-                    DiscordOAuthManager.update_nickname(user.discord.uid, DiscordTasks.get_nickname(user))
-                except DiscordApiBackoff as bo:
-                    logger.info("Discord nickname update API back off for %s, "
-                                "retrying in %s seconds" % (user, bo.retry_after_seconds))
-                    raise self.retry(countdown=bo.retry_after_seconds)
-                except Exception as e:
-                    if self:
-                        logger.exception("Discord nickname sync failed for %s, retrying in 10 mins" % user)
-                        raise self.retry(countdown=60 * 10)
-                    else:
-                        # Rethrow
-                        raise e
-                logger.debug("Updated user %s discord nickname." % user)
             else:                                            
-                logger.debug("User %s does not have a main character" % user)
+                logger.error(
+                    '%s failed for user %s after max retries',
+                    method,
+                    user,                    
+                    exc_info=True
+                )
+        except Exception:
+            logger.error(
+                '%s for %s failed due to unexpected exception',
+                method,
+                user,
+                exc_info=True
+            )            
+        
         else:
-            logger.debug("User %s does not have a discord account" % user)
+            if success is None and method != 'delete_user':
+                delete_user.delay(user.pk, notify_user=True)
 
-    @staticmethod
+    else:
-    @shared_task(name='discord.update_all_nicknames')
+        logger.debug(
-    def update_all_nicknames():
+            'User %s does not have a discord account, skipping %s', user, method
-        logger.debug("Updating ALL discord nicknames")
+        )
-        for discord_user in DiscordUser.objects.exclude(uid__exact=''):
-            DiscordTasks.update_nickname.delay(discord_user.user.pk)
 
-    @classmethod
-    def disable(cls):
-        DiscordUser.objects.all().delete()
 
-    @staticmethod
+@shared_task(name='discord.update_all_groups')
-    def get_nickname(user):
+def update_all_groups() -> None:
-        from .auth_hooks import DiscordService
+    """Update roles for all known users with a Discord account."""    
-        return NameFormatter(DiscordService(), user).format_name()
+    discord_users_qs = DiscordUser.objects.all()
+    _bulk_update_groups_for_users(discord_users_qs)
 
-    @staticmethod
+
-    def get_groups(user):
+@shared_task(name='discord.update_groups_bulk')
-        return [g.name for g in user.groups.all()] + [user.profile.state.name]
+def update_groups_bulk(user_pks: list) -> None:
+    """Update roles for list of users with a Discord account in bulk."""    
+    discord_users_qs = DiscordUser.objects\
+        .filter(user__pk__in=user_pks)\
+        .select_related()
+    _bulk_update_groups_for_users(discord_users_qs)
+
+
+def _bulk_update_groups_for_users(discord_users_qs: QuerySet) -> None:
+    logger.info(
+        "Starting to bulk update discord roles for %d users", discord_users_qs.count()
+    )
+    update_groups_chain = list()
+    for discord_user in discord_users_qs:
+        update_groups_chain.append(update_groups.si(discord_user.user.pk))
+    
+    chain(update_groups_chain).apply_async(priority=BULK_TASK_PRIORITY)
+
+
+@shared_task(name='discord.update_all_nicknames')
+def update_all_nicknames() -> None:
+    """Update nicknames for all known users with a Discord account."""
+    discord_users_qs = DiscordUser.objects.all()
+    _bulk_update_nicknames_for_users(discord_users_qs)
+    
+
+@shared_task(name='discord.update_nicknames_bulk')
+def update_nicknames_bulk(user_pks: list) -> None:
+    """Update nicknames for list of users with a Discord account in bulk."""    
+    discord_users_qs = DiscordUser.objects\
+        .filter(user__pk__in=user_pks)\
+        .select_related()
+    _bulk_update_nicknames_for_users(discord_users_qs)
+
+
+def _bulk_update_nicknames_for_users(discord_users_qs: QuerySet) -> None:
+    logger.info(
+        "Starting to bulk update discord nicknames for %d users", 
+        discord_users_qs.count()
+    )
+    update_nicknames_chain = list()
+    for discord_user in discord_users_qs:
+        update_nicknames_chain.append(update_nickname.si(discord_user.user.pk))
+    
+    chain(update_nicknames_chain).apply_async(priority=BULK_TASK_PRIORITY)
+
+
+@shared_task(name='discord.update_all_usernames')
+def update_all_usernames() -> None:
+    """Update all usernames for all known users with a Discord account."""
+    discord_users_qs = DiscordUser.objects.all()
+    _bulk_update_usernames_for_users(discord_users_qs)
+    
+
+@shared_task(name='discord.update_usernames_bulk')
+def update_usernames_bulk(user_pks: list) -> None:
+    """Update usernames for list of users with a Discord account in bulk."""    
+    discord_users_qs = DiscordUser.objects\
+        .filter(user__pk__in=user_pks)\
+        .select_related()
+    _bulk_update_usernames_for_users(discord_users_qs)
+
+
+def _bulk_update_usernames_for_users(discord_users_qs: QuerySet) -> None:
+    logger.info(
+        "Starting to bulk update discord usernames for %d users", 
+        discord_users_qs.count()
+    )
+    update_usernames_chain = list()
+    for discord_user in discord_users_qs:
+        update_usernames_chain.append(update_username.si(discord_user.user.pk))
+    
+    chain(update_usernames_chain).apply_async(priority=BULK_TASK_PRIORITY)
+
+
+@shared_task(name='discord.update_all')
+def update_all() -> None:
+    """Updates groups and nicknames (when activated) for all users."""
+    discord_users_qs = DiscordUser.objects.all()
+    logger.info(
+        'Starting to bulk update all for %s Discord users', discord_users_qs.count()
+    )
+    update_all_chain = list()
+    for discord_user in discord_users_qs:
+        update_all_chain.append(update_groups.si(discord_user.user.pk))
+        update_all_chain.append(update_username.si(discord_user.user.pk))
+        if DISCORD_SYNC_NAMES:
+            update_all_chain.append(update_nickname.si(discord_user.user.pk))
+        
+    chain(update_all_chain).apply_async(priority=BULK_TASK_PRIORITY)

allianceauth/services/modules/discord/templates/services/discord/discord_service_ctrl.html

@@ -3,24 +3,34 @@
 
 <tr>
     <td class="text-center">Discord</td>
-    <td class="text-center"></td>
-    <td class="text-center"><a href="https://discordapp.com/channels/{{ DISCORD_SERVER_ID }}/{{ DISCORD_SERVER_ID}}">https://discordapp.com</a></td>
     <td class="text-center">
-        {% if not discord_uid %}
+        {% if not user_has_account %}
-            <a href="{% url 'discord:activate' %}" title="Activate" class="btn btn-warning">
+            (not activated)
+        {% else %}
+            {{discord_username}}
+        {% endif %}
+    </td>
+    <td class="text-center">
+        {{server_name}}
+    </td>
+    <td class="text-center">
+        {% if not user_has_account %}
+            <a href="{% url 'discord:activate' %}" title="{% trans 'Join the Discord server' %}" class="btn btn-primary">
                 <span class="glyphicon glyphicon-ok"></span>
             </a>
         {% else %}
-            <a href="{% url 'discord:reset' %}" title="Reset" class="btn btn-primary">
+            <a href="{% url 'discord:reset' %}" title="{% trans 'Leave- and rejoin the Discord Server (Reset)' %}" class="btn btn-warning">
                 <span class="glyphicon glyphicon-refresh"></span>
             </a>
-            <a href="{% url 'discord:deactivate' %}" title="Deactivate" class="btn btn-danger">
+            <a href="{% url 'discord:deactivate' %}" title="{% trans 'Leave the Discord server' %}" class="btn btn-danger">
                 <span class="glyphicon glyphicon-remove"></span>
             </a>
         {% endif %}
         {% if request.user.is_superuser %}
             <div class="text-center" style="padding-top:5px;">
-                <a type="button" class="btn btn-success" href="{% url 'discord:add_bot' %}">{% trans "Link Discord Server" %}</a>
+                <a type="button" class="btn btn-default" href="{% url 'discord:add_bot' %}">
+                    {% trans "Link Discord Server" %}
+                </a>
             </div>
         {% endif %}
     </td>

allianceauth/services/modules/discord/tests/__init__.py

@@ -1,10 +1,26 @@
-from django.contrib.auth.models import User, Group, Permission
+from django.contrib.auth.models import Group
 from allianceauth.tests.auth_utils import AuthUtils
+from ..discord_client.tests import (    # noqa
+    TEST_GUILD_ID,
+    TEST_USER_ID,
+    TEST_USER_NAME,
+    TEST_USER_DISCRIMINATOR,
+    create_role, 
+    ROLE_ALPHA, 
+    ROLE_BRAVO, 
+    ROLE_CHARLIE, 
+    ROLE_MIKE, 
+    create_user_info
+)   
 
 DEFAULT_AUTH_GROUP = 'Member'
 MODULE_PATH = 'allianceauth.services.modules.discord'
 
-def add_permissions():
+TEST_MAIN_NAME = 'Spiderman'
-    permission = Permission.objects.get(codename='access_discord')
+TEST_MAIN_ID = 1005
+
+
+def add_permissions_to_members():
+    permission = AuthUtils.get_permission_by_name('discord.access_discord')
     members = Group.objects.get_or_create(name=DEFAULT_AUTH_GROUP)[0]
     AuthUtils.add_permissions_to_groups([permission], [members])

allianceauth/services/modules/discord/tests/piloting_tasks.py

@@ -0,0 +1,83 @@
+# flake8: noqa
+
+"""Concurrency testing Discord service tasks
+
+This script will run many Discord service tasks in parallel to test concurrency
+Note that it will run against your main Auth database and not test!
+
+Check allianceauth.log for the results.
+
+To run this test start a bunch of celery workers and then run this script directly.
+Make sure to also set the environment variable AUTH_PROJECT_PATH to your Auth path
+and DJANGO_SETTINGS_MODULE to the relative location of your settings:
+
+Example:
+export AUTH_PROJECT_PATH="/home/erik997/dev/python/aa/allianceauth-dev/myauth"
+export DJANGO_SETTINGS_MODULE="myauth.settings.local"
+
+Careful: This script will utilize all existing Discord users and make changes!
+"""
+# start django project
+import os
+import sys
+if not 'AUTH_PROJECT_PATH' in os.environ:
+    print('AUTH_PROJECT_PATH is not set')
+    exit(1)
+if not 'DJANGO_SETTINGS_MODULE' in os.environ:
+    print('DJANGO_SETTINGS_MODULE is not set')
+    exit(1)
+sys.path.insert(0, os.environ['AUTH_PROJECT_PATH'])
+import django
+django.setup()
+
+# normal imports
+import logging
+from uuid import uuid1
+import random
+
+from django.core.cache import caches
+from django.contrib.auth.models import User, Group
+
+from allianceauth.services.modules.discord.models import DiscordUser
+
+logger = logging.getLogger('allianceauth')
+MAX_RUNS = 3
+
+def clear_cache():
+    default_cache = caches['default']
+    redis = default_cache.get_master_client()
+    redis.flushall()
+    logger.info('Cache flushed')
+
+def run_many_updates(runs):
+    logger.info('Starting piloting_tasks for %d runs', runs)
+    users = list()
+    all_groups = Group.objects.all()
+    for i in range(runs):        
+        if not users:
+            users = list(User.objects.filter(discord__isnull=False))
+        user = users.pop()
+        logger.info('%d/%d: Starting run with user %s', i + 1, runs, user)
+        # force change of nick        
+        new_nick = f'Testnick {uuid1().hex}'[:32]
+        logger.info(
+            '%d/%d: Changing nickname of %s to "%s"', i + 1, runs, user, new_nick
+        )
+        user.profile.main_character.character_name = new_nick
+        user.profile.main_character.save()        
+        
+        # force change of groups
+        user_groups = user.groups.all()        
+        user.groups.remove(random.choice(user_groups))
+        while True:
+            new_group = random.choice(all_groups)
+            if new_group not in user_groups:
+                break
+        logger.info('%d/%d: Adding group "%s" to user %s', i + 1, runs, new_group, user)
+        user.groups.add(new_group)
+
+    logger.info('All %d runs have been started', runs)
+
+if __name__ == "__main__":
+    clear_cache()
+    run_many_updates(MAX_RUNS)

allianceauth/services/modules/discord/tests/test_admin.py

@@ -1,9 +1,7 @@
-from unittest.mock import patch
-
 from django.test import TestCase, RequestFactory
-from django.contrib import admin
 from django.contrib.admin.sites import AdminSite
 from django.contrib.auth.models import User
+from django.utils.timezone import now
 
 from allianceauth.authentication.models import CharacterOwnership
 from allianceauth.eveonline.models import (
@@ -18,47 +16,51 @@ from ....admin import (
     MainCorporationsFilter,
     MainAllianceFilter
 )
-from ..admin import (        
+from ..admin import DiscordUserAdmin
-    DiscordUser,
+from ..models import DiscordUser
-    DiscordUserAdmin    
-)
 
 
-class TestDiscordUserAdmin(TestCase):
+class TestDataMixin(TestCase):
 
     @classmethod
     def setUpClass(cls):
         super().setUpClass()
 
+        EveCharacter.objects.all().delete()
+        EveCorporationInfo.objects.all().delete()
+        EveAllianceInfo.objects.all().delete()
+        User.objects.all().delete()
+        DiscordUser.objects.all().delete()
+        
         # user 1 - corp and alliance, normal user
         cls.character_1 = EveCharacter.objects.create(
-            character_id='1001',
+            character_id=1001,
             character_name='Bruce Wayne',
-            corporation_id='2001',
+            corporation_id=2001,
             corporation_name='Wayne Technologies',
             corporation_ticker='WT',
-            alliance_id='3001',
+            alliance_id=3001,
             alliance_name='Wayne Enterprises',
             alliance_ticker='WE',
         )
         cls.character_1a = EveCharacter.objects.create(
-            character_id='1002',
+            character_id=1002,
             character_name='Batman',
-            corporation_id='2001',
+            corporation_id=2001,
             corporation_name='Wayne Technologies',
             corporation_ticker='WT',
-            alliance_id='3001',
+            alliance_id=3001,
             alliance_name='Wayne Enterprises',
             alliance_ticker='WE',
         )
         alliance = EveAllianceInfo.objects.create(
-            alliance_id='3001',
+            alliance_id=3001,
             alliance_name='Wayne Enterprises',
             alliance_ticker='WE',            
-            executor_corp_id='2001'
+            executor_corp_id=2001
         )
         EveCorporationInfo.objects.create(
-            corporation_id='2001',
+            corporation_id=2001,
             corporation_name='Wayne Technologies',
             corporation_ticker='WT',            
             member_count=42,
@@ -83,7 +85,10 @@ class TestDiscordUserAdmin(TestCase):
         cls.user_1.profile.save()
         DiscordUser.objects.create(
             user=cls.user_1,
-            uid=1001
+            uid=1001,
+            username='Bruce Wayne',
+            discriminator='1234',
+            activated=now()
         )
 
         # user 2 - corp only, staff
@@ -136,10 +141,10 @@ class TestDiscordUserAdmin(TestCase):
             alliance=None
         )
         EveAllianceInfo.objects.create(
-            alliance_id='3101',
+            alliance_id=3101,
             alliance_name='Lex World Domination',
             alliance_ticker='LWD',
-            executor_corp_id=''
+            executor_corp_id=2101
         )
         cls.user_3 = User.objects.create_user(
             cls.character_3.character_name.replace(' ', '_'),
@@ -156,18 +161,20 @@ class TestDiscordUserAdmin(TestCase):
             uid=1003
         )
         
-
     def setUp(self):
         self.factory = RequestFactory()
         self.modeladmin = DiscordUserAdmin(
             model=DiscordUser, admin_site=AdminSite()
         )    
     
-    # column rendering
+
+class TestColumnRendering(TestDataMixin, TestCase):
 
     def test_user_profile_pic_u1(self):
-        expected = ('<img src="https://images.evetech.net/characters/1001/'
+        expected = (
-            'portrait?size=32" class="img-circle">')        
+            '<img src="https://images.evetech.net/characters/1001/'
+            'portrait?size=32" class="img-circle">'
+        )
         self.assertEqual(user_profile_pic(self.user_1.discord), expected)
 
     def test_user_profile_pic_u3(self):
@@ -204,9 +211,26 @@ class TestDiscordUserAdmin(TestCase):
         result = user_main_organization(self.user_3.discord)
         self.assertEqual(result, expected)
 
+    def test_uid(self):
+        expected = 1001
+        result = self.modeladmin._uid(self.user_1.discord)
+        self.assertEqual(result, expected)
+
+    def test_username_when_defined(self):
+        expected = 'Bruce Wayne#1234'
+        result = self.modeladmin._username(self.user_1.discord)
+        self.assertEqual(result, expected)
+
+    def test_username_when_not_defined(self):
+        expected = ''
+        result = self.modeladmin._username(self.user_2.discord)
+        self.assertEqual(result, expected)
+
     # actions
 
-    # filters    
+
+class TestFilters(TestDataMixin, TestCase):
+    
     def test_filter_main_corporations(self):
         
         class DiscordUserAdminTest(ServicesUserAdmin): 
@@ -221,15 +245,14 @@ class TestDiscordUserAdmin(TestCase):
         filters = changelist.get_filters(request)
         filterspec = filters[0][0]
         expected = [            
-            ('2002', 'Daily Planet'),
+            (2002, 'Daily Planet'),
-            ('2001', 'Wayne Technologies'),
+            (2001, 'Wayne Technologies'),
         ]
         self.assertEqual(filterspec.lookup_choices, expected)
 
         # Make sure the correct queryset is returned
         request = self.factory.get(
-            '/', 
+            '/', {'main_corporation_id__exact': self.character_1.corporation_id}
-            {'main_corporation_id__exact': self.character_1.corporation_id}
         )
         request.user = self.user_1                
         changelist = my_modeladmin.get_changelist_instance(request)
@@ -251,18 +274,16 @@ class TestDiscordUserAdmin(TestCase):
         filters = changelist.get_filters(request)
         filterspec = filters[0][0]
         expected = [
-            ('3001', 'Wayne Enterprises'),            
+            (3001, 'Wayne Enterprises'),
         ]
         self.assertEqual(filterspec.lookup_choices, expected)
 
         # Make sure the correct queryset is returned
         request = self.factory.get(
-            '/', 
+            '/', {'main_alliance_id__exact': self.character_1.alliance_id}
-            {'main_alliance_id__exact': self.character_1.alliance_id}
         )
         request.user = self.user_1                
         changelist = my_modeladmin.get_changelist_instance(request)
         queryset = changelist.get_queryset(request)
         expected = [self.user_1.discord]
         self.assertSetEqual(set(queryset), set(expected))
-    

allianceauth/services/modules/discord/tests/test_auth_hooks.py

@@ -0,0 +1,141 @@
+from unittest.mock import patch
+
+from django.test import TestCase, RequestFactory
+from django.test.utils import override_settings
+
+from allianceauth.tests.auth_utils import AuthUtils
+
+from . import TEST_USER_NAME, TEST_USER_ID, add_permissions_to_members, MODULE_PATH
+from ..auth_hooks import DiscordService
+from ..discord_client import DiscordClient
+from ..models import DiscordUser
+from ..utils import set_logger_to_file
+
+
+logger = set_logger_to_file(MODULE_PATH + '.auth_hooks', __file__)
+
+
+@override_settings(CELERY_ALWAYS_EAGER=True)
+class TestDiscordService(TestCase):
+
+    def setUp(self):        
+        self.member = AuthUtils.create_member(TEST_USER_NAME)
+        DiscordUser.objects.create(
+            user=self.member, 
+            uid=TEST_USER_ID, 
+            username=TEST_USER_NAME,
+            discriminator='1234'
+        )
+        self.none_member = AuthUtils.create_user('Lex Luther')
+        self.service = DiscordService
+        add_permissions_to_members()
+        self.factory = RequestFactory()
+
+    def test_service_enabled(self):
+        service = self.service()        
+        self.assertTrue(service.service_active_for_user(self.member))
+        self.assertFalse(service.service_active_for_user(self.none_member))
+
+    @patch(MODULE_PATH + '.tasks.update_all_groups')
+    def test_update_all_groups(self, mock_update_all_groups):
+        service = self.service()
+        service.update_all_groups()        
+        self.assertTrue(mock_update_all_groups.delay.called)
+        
+    @patch(MODULE_PATH + '.tasks.update_groups_bulk')
+    def test_update_groups_bulk(self, mock_update_groups_bulk):
+        service = self.service()        
+        service.update_groups_bulk([self.member])
+        self.assertTrue(mock_update_groups_bulk.delay.called)        
+
+    @patch(MODULE_PATH + '.tasks.update_groups')
+    def test_update_groups_for_member(self, mock_update_groups):    
+        service = self.service()        
+        service.update_groups(self.member)
+        self.assertTrue(mock_update_groups.apply_async.called)        
+
+    @patch(MODULE_PATH + '.tasks.update_groups')
+    def test_update_groups_for_none_member(self, mock_update_groups):    
+        service = self.service()
+        service.update_groups(self.none_member)
+        self.assertFalse(mock_update_groups.apply_async.called)        
+
+    @patch(MODULE_PATH + '.models.notify')
+    @patch(MODULE_PATH + '.tasks.DiscordUser')
+    @patch(MODULE_PATH + '.managers.DiscordClient', spec=DiscordClient)
+    def test_validate_user(
+        self, mock_DiscordClient, mock_DiscordUser, mock_notify
+    ):
+        mock_DiscordClient.return_value.remove_guild_member.return_value = True
+        
+        # Test member is not deleted
+        service = self.service()
+        service.validate_user(self.member)
+        self.assertTrue(DiscordUser.objects.filter(user=self.member).exists())
+
+        # Test none member is deleted        
+        DiscordUser.objects.create(user=self.none_member, uid=TEST_USER_ID)
+        service.validate_user(self.none_member)        
+        self.assertFalse(DiscordUser.objects.filter(user=self.none_member).exists())
+
+    @patch(MODULE_PATH + '.tasks.update_nickname')
+    def test_sync_nickname(self, mock_update_nickname):
+        service = self.service()        
+        service.sync_nickname(self.member)
+        self.assertTrue(mock_update_nickname.apply_async.called)
+        
+    @patch(MODULE_PATH + '.tasks.update_nicknames_bulk')
+    def test_sync_nicknames_bulk(self, mock_update_nicknames_bulk):
+        service = self.service()        
+        service.sync_nicknames_bulk([self.member])        
+        self.assertTrue(mock_update_nicknames_bulk.delay.called)
+        
+    @patch(MODULE_PATH + '.managers.DiscordClient', spec=DiscordClient)
+    def test_delete_user_is_member(self, mock_DiscordClient):        
+        mock_DiscordClient.return_value.remove_guild_member.return_value = True
+
+        service = self.service()        
+        service.delete_user(self.member)
+        
+        self.assertTrue(mock_DiscordClient.return_value.remove_guild_member.called)
+        self.assertFalse(DiscordUser.objects.filter(user=self.member).exists())
+
+    @patch(MODULE_PATH + '.managers.DiscordClient', spec=DiscordClient)
+    def test_delete_user_is_not_member(self, mock_DiscordClient):
+        mock_DiscordClient.return_value.remove_guild_member.return_value = True
+
+        service = self.service()        
+        service.delete_user(self.none_member)
+
+        self.assertFalse(mock_DiscordClient.return_value.remove_guild_member.called)
+        
+    @patch(MODULE_PATH + '.managers.DiscordClient', spec=DiscordClient)
+    def test_render_services_ctrl_with_username(self, mock_DiscordClient):
+        service = self.service()        
+        request = self.factory.get('/services/')
+        request.user = self.member
+
+        response = service.render_services_ctrl(request)
+        self.assertTemplateUsed(service.service_ctrl_template)
+        self.assertIn('/discord/reset/', response)
+        self.assertIn('/discord/deactivate/', response)
+
+        # Test register becomes available
+        self.member.discord.delete()
+        self.member.refresh_from_db()
+        request.user = self.member
+        response = service.render_services_ctrl(request)
+        self.assertIn('/discord/activate/', response)
+
+    @patch(MODULE_PATH + '.managers.DiscordClient', spec=DiscordClient)
+    def test_render_services_ctrl_wo_username(self, mock_DiscordClient):
+        my_member = AuthUtils.create_member('John Doe')
+        DiscordUser.objects.create(user=my_member, uid=111222333)
+        service = self.service()
+        request = self.factory.get('/services/')
+        request.user = my_member
+
+        response = service.render_services_ctrl(request)
+        self.assertTemplateUsed(service.service_ctrl_template)
+        self.assertIn('/discord/reset/', response)
+        self.assertIn('/discord/deactivate/', response)

allianceauth/services/modules/discord/tests/test_hooks.py

@@ -1,127 +0,0 @@
-from unittest import mock
-
-from django.test import TestCase, RequestFactory
-from django.contrib.auth.models import User
-from django.core.exceptions import ObjectDoesNotExist
-from allianceauth.tests.auth_utils import AuthUtils
-
-from ..auth_hooks import DiscordService
-from ..models import DiscordUser
-from ..tasks import DiscordTasks
-from ..manager import DiscordOAuthManager
-
-from . import DEFAULT_AUTH_GROUP, add_permissions, MODULE_PATH
-
-
-class DiscordHooksTestCase(TestCase):
-    def setUp(self):
-        self.member = 'member_user'
-        member = AuthUtils.create_member(self.member)
-        DiscordUser.objects.create(user=member, uid='12345')
-        self.none_user = 'none_user'
-        none_user = AuthUtils.create_user(self.none_user)
-        self.service = DiscordService
-        add_permissions()
-
-    def test_has_account(self):
-        member = User.objects.get(username=self.member)
-        none_user = User.objects.get(username=self.none_user)
-        self.assertTrue(DiscordTasks.has_account(member))
-        self.assertFalse(DiscordTasks.has_account(none_user))
-
-    def test_service_enabled(self):
-        service = self.service()
-        member = User.objects.get(username=self.member)
-        none_user = User.objects.get(username=self.none_user)
-
-        self.assertTrue(service.service_active_for_user(member))
-        self.assertFalse(service.service_active_for_user(none_user))
-
-    @mock.patch(MODULE_PATH + '.tasks.DiscordOAuthManager')
-    def test_update_all_groups(self, manager):
-        service = self.service()
-        service.update_all_groups()
-        # Check member and blue user have groups updated
-        self.assertTrue(manager.update_groups.called)
-        self.assertEqual(manager.update_groups.call_count, 1)
-
-    def test_update_groups(self):
-        # Check member has Member group updated
-        with mock.patch(MODULE_PATH + '.tasks.DiscordOAuthManager') as manager:
-            service = self.service()
-            member = User.objects.get(username=self.member)
-            AuthUtils.disconnect_signals()
-            service.update_groups(member)
-            self.assertTrue(manager.update_groups.called)
-            args, kwargs = manager.update_groups.call_args
-            user_id, groups = args
-            self.assertIn(DEFAULT_AUTH_GROUP, groups)
-            self.assertEqual(user_id, member.discord.uid)
-
-        # Check none user does not have groups updated
-        with mock.patch(MODULE_PATH + '.tasks.DiscordOAuthManager') as manager:
-            service = self.service()
-            none_user = User.objects.get(username=self.none_user)
-            service.update_groups(none_user)
-            self.assertFalse(manager.update_groups.called)
-
-    @mock.patch(MODULE_PATH + '.tasks.DiscordOAuthManager')
-    def test_validate_user(self, manager):
-        service = self.service()
-        # Test member is not deleted
-        member = User.objects.get(username=self.member)
-        service.validate_user(member)
-        self.assertTrue(member.discord)
-
-        # Test none user is deleted
-        none_user = User.objects.get(username=self.none_user)
-        DiscordUser.objects.create(user=none_user, uid='abc123')
-        service.validate_user(none_user)
-        self.assertTrue(manager.delete_user.called)
-        with self.assertRaises(ObjectDoesNotExist):
-            none_discord = User.objects.get(username=self.none_user).discord
-
-    @mock.patch(MODULE_PATH + '.tasks.DiscordOAuthManager')
-    def test_sync_nickname(self, manager):
-        service = self.service()
-        member = User.objects.get(username=self.member)
-        AuthUtils.add_main_character(member, 'test user', '12345', corp_ticker='AAUTH')
-
-        service.sync_nickname(member)
-
-        self.assertTrue(manager.update_nickname.called)
-        args, kwargs = manager.update_nickname.call_args
-        self.assertEqual(args[0], member.discord.uid)
-        self.assertEqual(args[1], 'test user')
-
-    @mock.patch(MODULE_PATH + '.tasks.DiscordOAuthManager')
-    def test_delete_user(self, manager):
-        member = User.objects.get(username=self.member)
-
-        service = self.service()
-        result = service.delete_user(member)
-
-        self.assertTrue(result)
-        self.assertTrue(manager.delete_user.called)
-        with self.assertRaises(ObjectDoesNotExist):
-            discord_user = User.objects.get(username=self.member).discord
-
-    def test_render_services_ctrl(self):
-        service = self.service()
-        member = User.objects.get(username=self.member)
-        request = RequestFactory().get('/services/')
-        request.user = member
-
-        response = service.render_services_ctrl(request)
-        self.assertTemplateUsed(service.service_ctrl_template)
-        self.assertIn('/discord/reset/', response)
-        self.assertIn('/discord/deactivate/', response)
-
-        # Test register becomes available
-        member.discord.delete()
-        member = User.objects.get(username=self.member)
-        request.user = member
-        response = service.render_services_ctrl(request)
-        self.assertIn('/discord/activate/', response)
-
-    # TODO: Test update nicknames

allianceauth/services/modules/discord/tests/test_integration.py

@@ -0,0 +1,476 @@
+"""Integration tests
+
+Testing all components of the service, with the exception of the Discord API.
+
+Please note that these tests require Redis and will flush it
+"""
+from collections import namedtuple
+import logging
+from unittest.mock import patch, Mock
+from uuid import uuid1
+
+from django_webtest import WebTest
+from requests.exceptions import HTTPError
+import requests_mock
+
+from django.contrib.auth.models import Group, User
+from django.core.cache import caches
+from django.shortcuts import reverse
+from django.test import TransactionTestCase
+from django.test.utils import override_settings
+
+from allianceauth.tests.auth_utils import AuthUtils
+
+from . import (
+    TEST_GUILD_ID,
+    TEST_USER_NAME, 
+    TEST_USER_ID,
+    TEST_USER_DISCRIMINATOR, 
+    TEST_MAIN_NAME, 
+    TEST_MAIN_ID, 
+    MODULE_PATH,
+    add_permissions_to_members,
+    ROLE_ALPHA,
+    ROLE_BRAVO,
+    ROLE_CHARLIE,
+    ROLE_MIKE,
+    create_role,
+    create_user_info
+)
+from ..discord_client.app_settings import DISCORD_API_BASE_URL
+from ..models import DiscordUser
+
+logger = logging.getLogger('allianceauth')
+
+ROLE_MEMBER = create_role(99, 'Member')
+
+# Putting all requests to Discord into objects so we can compare them better
+DiscordRequest = namedtuple('DiscordRequest', ['method', 'url'])
+user_get_current_request = DiscordRequest(
+    method='GET',
+    url=f'{DISCORD_API_BASE_URL}users/@me'
+)
+guild_infos_request = DiscordRequest(
+    method='GET',
+    url=f'{DISCORD_API_BASE_URL}guilds/{TEST_GUILD_ID}'
+)
+guild_roles_request = DiscordRequest(
+    method='GET',
+    url=f'{DISCORD_API_BASE_URL}guilds/{TEST_GUILD_ID}/roles'
+)
+create_guild_role_request = DiscordRequest(
+    method='POST',
+    url=f'{DISCORD_API_BASE_URL}guilds/{TEST_GUILD_ID}/roles'
+)
+guild_member_request = DiscordRequest(
+    method='GET',
+    url=f'{DISCORD_API_BASE_URL}guilds/{TEST_GUILD_ID}/members/{TEST_USER_ID}'
+)
+add_guild_member_request = DiscordRequest(
+    method='PUT',
+    url=f'{DISCORD_API_BASE_URL}guilds/{TEST_GUILD_ID}/members/{TEST_USER_ID}'
+)            
+modify_guild_member_request = DiscordRequest(
+    method='PATCH',
+    url=f'{DISCORD_API_BASE_URL}guilds/{TEST_GUILD_ID}/members/{TEST_USER_ID}'
+)            
+remove_guild_member_request = DiscordRequest(
+    method='DELETE',
+    url=f'{DISCORD_API_BASE_URL}guilds/{TEST_GUILD_ID}/members/{TEST_USER_ID}'
+)
+
+
+def clear_cache():
+    default_cache = caches['default']
+    redis = default_cache.get_master_client()
+    redis.flushall()
+    logger.info('Cache flushed')
+
+
+@patch(MODULE_PATH + '.models.DISCORD_GUILD_ID', TEST_GUILD_ID)
+@override_settings(CELERY_ALWAYS_EAGER=True)
+@requests_mock.Mocker()
+class TestServiceFeatures(TransactionTestCase):
+
+    @classmethod
+    def setUpClass(cls):
+        super().setUpClass()
+        cls.maxDiff = None
+        
+    def setUp(self):
+        clear_cache()
+        AuthUtils.disconnect_signals()
+        Group.objects.all().delete()
+        User.objects.all().delete()
+        AuthUtils.connect_signals()
+        self.group_3 = Group.objects.create(name='charlie')        
+        self.user = AuthUtils.create_member(TEST_USER_NAME)
+        AuthUtils.add_main_character_2(
+            self.user, 
+            TEST_MAIN_NAME, 
+            TEST_MAIN_ID, 
+            corp_id='2', 
+            corp_name='test_corp', 
+            corp_ticker='TEST',
+            disconnect_signals=True
+        )
+        self.discord_user = DiscordUser.objects.create(user=self.user, uid=TEST_USER_ID)
+        add_permissions_to_members()
+        
+    def test_name_of_main_changes(self, requests_mocker):      
+        # modify_guild_member()        
+        requests_mocker.patch(modify_guild_member_request.url, status_code=204)
+        
+        # changing nick to trigger signals
+        new_nick = f'Testnick {uuid1().hex}'[:32]
+        self.user.profile.main_character.character_name = new_nick
+        self.user.profile.main_character.save()
+
+        # Need to have called modify_guild_member two times only
+        # Once for sync nickname
+        # Once for change of main character        
+        requests_made = list()
+        for r in requests_mocker.request_history:            
+            requests_made.append(DiscordRequest(r.method, r.url))
+
+        expected = [modify_guild_member_request, modify_guild_member_request]        
+        self.assertListEqual(requests_made, expected)
+
+    def test_name_of_main_changes_but_user_deleted(self, requests_mocker):      
+        # modify_guild_member()        
+        requests_mocker.patch(
+            modify_guild_member_request.url, status_code=404, json={'code': 10007}
+        )
+        # remove_guild_member()
+        requests_mocker.delete(remove_guild_member_request.url, status_code=204)
+        
+        # changing nick to trigger signals
+        new_nick = f'Testnick {uuid1().hex}'[:32]
+        self.user.profile.main_character.character_name = new_nick
+        self.user.profile.main_character.save()
+
+        # Need to have called modify_guild_member two times only
+        # Once for sync nickname
+        # Once for change of main character        
+        requests_made = list()
+        for r in requests_mocker.request_history:            
+            requests_made.append(DiscordRequest(r.method, r.url))
+
+        expected = [
+            modify_guild_member_request, 
+            remove_guild_member_request,            
+        ]            
+        self.assertListEqual(requests_made, expected)
+        # self.assertFalse(DiscordUser.objects.user_has_account(self.user))
+
+    def test_name_of_main_changes_but_user_rate_limited(
+        self, requests_mocker
+    ):
+        # modify_guild_member()        
+        requests_mocker.patch(modify_guild_member_request.url, status_code=204)
+        
+        # exhausting rate limit
+        client = DiscordUser.objects._bot_client()
+        client._redis.set(
+            name=client._KEY_GLOBAL_RATE_LIMIT_REMAINING,
+            value=0,
+            px=2000
+        )
+        
+        # changing nick to trigger signals
+        new_nick = f'Testnick {uuid1().hex}'[:32]
+        self.user.profile.main_character.character_name = new_nick
+        self.user.profile.main_character.save()
+
+        # should not have called the API
+        requests_made = list()
+        for r in requests_mocker.request_history:            
+            requests_made.append(DiscordRequest(r.method, r.url))
+        
+        expected = list()  
+        self.assertListEqual(requests_made, expected)
+
+    def test_user_demoted_to_guest(self, requests_mocker):        
+        # remove_guild_member()        
+        requests_mocker.delete(remove_guild_member_request.url, status_code=204)
+        self.user.groups.clear()
+
+        requests_made = list()
+        for r in requests_mocker.request_history:            
+            requests_made.append(DiscordRequest(r.method, r.url))
+        
+        # compare the list of made requests with expected
+        expected = [remove_guild_member_request]
+        self.assertListEqual(requests_made, expected)
+
+    def test_adding_group_to_user_role_exists(self, requests_mocker):
+        # guild_member()                
+        requests_mocker.get(
+            guild_member_request.url,
+            json={
+                'user': create_user_info(),
+                'roles': ['1', '13', '99']
+            }
+        )        
+        # guild_roles()        
+        requests_mocker.get(
+            guild_roles_request.url, 
+            json=[ROLE_ALPHA, ROLE_BRAVO, ROLE_CHARLIE, ROLE_MIKE, ROLE_MEMBER]
+        )        
+        # create_guild_role()        
+        requests_mocker.post(create_guild_role_request.url, json=ROLE_CHARLIE)
+        # modify_guild_member()                
+        requests_mocker.patch(modify_guild_member_request.url, status_code=204)
+                
+        # adding new group to trigger signals
+        self.user.groups.add(self.group_3)        
+        self.user.refresh_from_db()
+        
+        # compare the list of made requests with expected
+        requests_made = list()
+        for r in requests_mocker.request_history:            
+            requests_made.append(DiscordRequest(r.method, r.url))
+
+        expected = [
+            guild_member_request,
+            guild_roles_request,            
+            modify_guild_member_request
+        ]        
+        self.assertListEqual(requests_made, expected)
+
+    def test_adding_group_to_user_role_does_not_exist(self, requests_mocker):    
+        # guild_member()                
+        requests_mocker.get(
+            guild_member_request.url,
+            json={
+                'user': {'id': str(TEST_USER_ID), 'username': TEST_MAIN_NAME},
+                'roles': ['1', '13', '99']
+            }
+        )        
+        # guild_roles()        
+        requests_mocker.get(
+            guild_roles_request.url, 
+            json=[ROLE_ALPHA, ROLE_BRAVO, ROLE_MIKE, ROLE_MEMBER]
+        )        
+        # create_guild_role()        
+        requests_mocker.post(create_guild_role_request.url, json=ROLE_CHARLIE)
+        # modify_guild_member()                
+        requests_mocker.patch(modify_guild_member_request.url, status_code=204)
+                
+        # adding new group to trigger signals
+        self.user.groups.add(self.group_3)        
+        self.user.refresh_from_db()
+        
+        # compare the list of made requests with expected
+        requests_made = list()
+        for r in requests_mocker.request_history:            
+            requests_made.append(DiscordRequest(r.method, r.url))
+
+        expected = [
+            guild_member_request,
+            guild_roles_request,
+            create_guild_role_request,
+            modify_guild_member_request
+        ]        
+        self.assertListEqual(requests_made, expected)
+    
+
+@patch(MODULE_PATH + '.managers.DISCORD_GUILD_ID', TEST_GUILD_ID)
+@patch(MODULE_PATH + '.models.DISCORD_GUILD_ID', TEST_GUILD_ID)
+@requests_mock.Mocker()
+class TestUserFeatures(WebTest):
+    
+    def setUp(self):
+        clear_cache()
+        self.member = AuthUtils.create_member(TEST_USER_NAME)
+        AuthUtils.add_main_character_2(
+            self.member, 
+            TEST_MAIN_NAME, 
+            TEST_MAIN_ID,
+            disconnect_signals=True
+        )
+        add_permissions_to_members()
+        
+    @patch(MODULE_PATH + '.views.messages')    
+    @patch(MODULE_PATH + '.managers.OAuth2Session')
+    def test_user_activation_normal(
+        self, requests_mocker, mock_OAuth2Session, mock_messages
+    ): 
+        # user_get_current()
+        requests_mocker.get(
+            user_get_current_request.url, 
+            json=create_user_info(
+                TEST_USER_ID, TEST_USER_NAME, TEST_USER_DISCRIMINATOR
+            )
+        )        
+        # guild_roles()        
+        requests_mocker.get(
+            guild_roles_request.url, 
+            json=[ROLE_ALPHA, ROLE_BRAVO, ROLE_MIKE, ROLE_MEMBER]
+        )        
+        # add_guild_member()
+        requests_mocker.put(add_guild_member_request.url, status_code=201)
+        
+        authentication_code = 'auth_code'        
+        oauth_url = 'https://www.example.com/oauth'
+        state = ''
+        mock_OAuth2Session.return_value.authorization_url.return_value = \
+            oauth_url, state
+        
+        # login
+        self.app.set_user(self.member)
+        
+        # click activate on the service page
+        response = self.app.get(reverse('discord:activate'))
+        
+        # check we got a redirect to Discord OAuth        
+        self.assertRedirects(
+            response, expected_url=oauth_url, fetch_redirect_response=False
+        )
+
+        # simulate Discord callback
+        response = self.app.get(
+            reverse('discord:callback'), params={'code': authentication_code}
+        )
+        
+        # user got a success message
+        self.assertTrue(mock_messages.success.called)
+        self.assertFalse(mock_messages.error.called)
+        
+        requests_made = list()
+        for r in requests_mocker.request_history:            
+            obj = DiscordRequest(r.method, r.url)            
+            requests_made.append(obj)
+                
+        expected = [
+            user_get_current_request, guild_roles_request, add_guild_member_request
+        ]
+        self.assertListEqual(requests_made, expected)
+
+    @patch(MODULE_PATH + '.views.messages')    
+    @patch(MODULE_PATH + '.managers.OAuth2Session')
+    def test_user_activation_failed(
+        self, requests_mocker, mock_OAuth2Session, mock_messages
+    ): 
+        # user_get_current()
+        requests_mocker.get(
+            user_get_current_request.url, 
+            json=create_user_info(
+                TEST_USER_ID, TEST_USER_NAME, TEST_USER_DISCRIMINATOR
+            )
+        )        
+        # guild_roles()        
+        requests_mocker.get(
+            guild_roles_request.url, 
+            json=[ROLE_ALPHA, ROLE_BRAVO, ROLE_MIKE, ROLE_MEMBER]
+        )        
+        # add_guild_member()
+        mock_exception = HTTPError('error')
+        mock_exception.response = Mock()
+        mock_exception.response.status_code = 503
+        requests_mocker.put(add_guild_member_request.url, exc=mock_exception)
+        
+        authentication_code = 'auth_code'        
+        oauth_url = 'https://www.example.com/oauth'
+        state = ''
+        mock_OAuth2Session.return_value.authorization_url.return_value = \
+            oauth_url, state
+        
+        # login
+        self.app.set_user(self.member)
+        
+        # click activate on the service page
+        response = self.app.get(reverse('discord:activate'))
+        
+        # check we got a redirect to Discord OAuth        
+        self.assertRedirects(
+            response, expected_url=oauth_url, fetch_redirect_response=False
+        )
+
+        # simulate Discord callback
+        response = self.app.get(
+            reverse('discord:callback'), params={'code': authentication_code}
+        )
+        
+        # user got a success message
+        self.assertFalse(mock_messages.success.called)
+        self.assertTrue(mock_messages.error.called)
+        
+        requests_made = list()
+        for r in requests_mocker.request_history:            
+            obj = DiscordRequest(r.method, r.url)            
+            requests_made.append(obj)
+                
+        expected = [
+            user_get_current_request, guild_roles_request, add_guild_member_request
+        ]
+        self.assertListEqual(requests_made, expected)
+
+    @patch(MODULE_PATH + '.views.messages')
+    def test_user_deactivation_normal(self, requests_mocker, mock_messages): 
+        # guild_infos()
+        requests_mocker.get(
+            guild_infos_request.url, json={'id': TEST_GUILD_ID, 'name': 'Test Guild'})
+
+        # remove_guild_member()
+        requests_mocker.delete(remove_guild_member_request.url, status_code=204)
+        
+        # user needs have an account
+        DiscordUser.objects.create(user=self.member, uid=TEST_USER_ID)
+        
+        # login
+        self.app.set_user(self.member)
+        
+        # click deactivate on the service page
+        response = self.app.get(reverse('discord:deactivate'))
+        
+        # check we got a redirect to service page
+        self.assertRedirects(response, expected_url=reverse('services:services'))
+
+        # user got a success message
+        self.assertTrue(mock_messages.success.called)
+        self.assertFalse(mock_messages.error.called)
+        
+        requests_made = list()
+        for r in requests_mocker.request_history:            
+            obj = DiscordRequest(r.method, r.url)            
+            requests_made.append(obj)
+                
+        expected = [remove_guild_member_request, guild_infos_request]
+        self.assertListEqual(requests_made, expected)
+
+    @patch(MODULE_PATH + '.views.messages')
+    def test_user_deactivation_fails(self, requests_mocker, mock_messages): 
+        # guild_infos()
+        requests_mocker.get(
+            guild_infos_request.url, json={'id': TEST_GUILD_ID, 'name': 'Test Guild'})
+
+        # remove_guild_member()        
+        mock_exception = HTTPError('error')
+        mock_exception.response = Mock()
+        mock_exception.response.status_code = 503
+        requests_mocker.delete(remove_guild_member_request.url, exc=mock_exception)
+        
+        # user needs have an account
+        DiscordUser.objects.create(user=self.member, uid=TEST_USER_ID)
+        
+        # login
+        self.app.set_user(self.member)
+        
+        # click deactivate on the service page
+        response = self.app.get(reverse('discord:deactivate'))
+        
+        # check we got a redirect to service page
+        self.assertRedirects(response, expected_url=reverse('services:services'))
+
+        # user got a success message
+        self.assertFalse(mock_messages.success.called)
+        self.assertTrue(mock_messages.error.called)
+        
+        requests_made = list()
+        for r in requests_mocker.request_history:            
+            obj = DiscordRequest(r.method, r.url)            
+            requests_made.append(obj)
+                
+        expected = [remove_guild_member_request, guild_infos_request]
+        self.assertListEqual(requests_made, expected)

allianceauth/services/modules/discord/tests/test_managers.py

@@ -1,244 +1,363 @@
-import json
+from unittest.mock import patch, Mock
 import urllib
-import datetime
-import requests_mock
-from unittest import mock
 
+from requests.exceptions import HTTPError
+
+from django.contrib.auth.models import Group, User
 from django.test import TestCase
-from django.conf import settings
 
-from ..manager import DiscordOAuthManager
+from allianceauth.tests.auth_utils import AuthUtils
-from .. import manager
 
-from . import DEFAULT_AUTH_GROUP, add_permissions, MODULE_PATH
+from . import (
+    TEST_GUILD_ID, 
+    TEST_USER_NAME, 
+    TEST_USER_ID, 
+    TEST_MAIN_NAME, 
+    TEST_MAIN_ID, 
+    MODULE_PATH,
+    ROLE_ALPHA,
+    ROLE_BRAVO,
+    ROLE_CHARLIE
+)
+from ..discord_client.tests import create_matched_role
+from ..app_settings import (
+    DISCORD_APP_ID, 
+    DISCORD_APP_SECRET,     
+    DISCORD_CALLBACK_URL,    
+)
+from ..discord_client import DiscordClient, DiscordApiBackoff
+from ..models import DiscordUser
+from ..utils import set_logger_to_file
 
 
-class DiscordManagerTestCase(TestCase):
+logger = set_logger_to_file(MODULE_PATH + '.managers', __file__)
+
+
+@patch(MODULE_PATH + '.managers.DISCORD_GUILD_ID', TEST_GUILD_ID)
+@patch(MODULE_PATH + '.managers.DiscordClient', spec=DiscordClient)
+@patch(MODULE_PATH + '.models.DiscordUser.objects._exchange_auth_code_for_token')
+@patch(MODULE_PATH + '.models.DiscordUser.objects.user_group_names')
+@patch(MODULE_PATH + '.models.DiscordUser.objects.user_formatted_nick')
+class TestAddUser(TestCase):
+        
     def setUp(self):
-        pass
+        self.user = AuthUtils.create_user(TEST_USER_NAME)
+        self.user_info = {
+            'id': TEST_USER_ID, 
+            'name': TEST_USER_NAME,
+            'username': TEST_USER_NAME,
+            'discriminator': '1234',
+        }
+        self.access_token = 'accesstoken'
     
-    def test__sanitize_group_name(self):
+    def test_can_create_user_no_roles_no_nick(
-        test_group_name = str(10**103)
+        self, 
-        group_name = DiscordOAuthManager._sanitize_group_name(test_group_name)
+        mock_user_formatted_nick,
+        mock_user_group_names,                
+        mock_exchange_auth_code_for_token, 
+        mock_DiscordClient
+    ):
+        mock_user_formatted_nick.return_value = None
+        mock_user_group_names.return_value = []                
+        mock_exchange_auth_code_for_token.return_value = self.access_token
+        mock_DiscordClient.return_value.current_user.return_value = self.user_info
+        mock_DiscordClient.return_value.match_or_create_roles_from_names\
+            .return_value = []
+        mock_DiscordClient.return_value.add_guild_member.return_value = True
         
-        self.assertEqual(group_name, test_group_name[:100])
+        result = DiscordUser.objects.add_user(self.user, authorization_code='abcdef')
+        self.assertTrue(result)
+        self.assertTrue(
+            DiscordUser.objects.filter(user=self.user, uid=TEST_USER_ID).exists()
+        )
+        self.assertTrue(mock_DiscordClient.return_value.add_guild_member.called)
+        args, kwargs = mock_DiscordClient.return_value.add_guild_member.call_args
+        self.assertEqual(kwargs['guild_id'], TEST_GUILD_ID)
+        self.assertEqual(kwargs['user_id'], TEST_USER_ID)
+        self.assertEqual(kwargs['access_token'], self.access_token)
+        self.assertIsNone(kwargs['role_ids'])
+        self.assertIsNone(kwargs['nick'])
 
-    def test_generate_Bot_add_url(self):
+    def test_can_create_user_with_roles_no_nick(
-        bot_add_url = DiscordOAuthManager.generate_bot_add_url()
+        self, 
+        mock_user_formatted_nick,
+        mock_user_group_names,        
+        mock_exchange_auth_code_for_token, 
+        mock_DiscordClient
+    ):
+        roles = [
+            create_matched_role(ROLE_ALPHA), 
+            create_matched_role(ROLE_BRAVO), 
+            create_matched_role(ROLE_CHARLIE)
+        ]
+        mock_user_formatted_nick.return_value = None
+        mock_user_group_names.return_value = ['a', 'b', 'c']        
+        mock_exchange_auth_code_for_token.return_value = self.access_token        
+        mock_DiscordClient.return_value.current_user.return_value = self.user_info
+        mock_DiscordClient.return_value.match_or_create_roles_from_names\
+            .return_value = roles
+        mock_DiscordClient.return_value.add_guild_member.return_value = True
         
-        auth_url = manager.AUTH_URL
+        result = DiscordUser.objects.add_user(self.user, authorization_code='abcdef')
-        real_bot_add_url = '{}?client_id=appid&scope=bot&permissions={}'.format(auth_url, manager.BOT_PERMISSIONS)
+        self.assertTrue(result)
+        self.assertTrue(
+            DiscordUser.objects.filter(user=self.user, uid=TEST_USER_ID).exists()
+        )
+        self.assertTrue(mock_DiscordClient.return_value.add_guild_member.called)
+        args, kwargs = mock_DiscordClient.return_value.add_guild_member.call_args
+        self.assertEqual(kwargs['guild_id'], TEST_GUILD_ID)
+        self.assertEqual(kwargs['user_id'], TEST_USER_ID)
+        self.assertEqual(kwargs['access_token'], self.access_token)
+        self.assertSetEqual(set(kwargs['role_ids']), {1, 2, 3})
+        self.assertIsNone(kwargs['nick'])
+
+    @patch(MODULE_PATH + '.managers.DISCORD_SYNC_NAMES', True)
+    def test_can_create_user_no_roles_with_nick(
+        self, 
+        mock_user_formatted_nick,
+        mock_user_group_names,        
+        mock_exchange_auth_code_for_token, 
+        mock_DiscordClient
+    ):        
+        mock_user_formatted_nick.return_value = TEST_MAIN_NAME
+        mock_user_group_names.return_value = []        
+        mock_exchange_auth_code_for_token.return_value = self.access_token
+        mock_DiscordClient.return_value.current_user.return_value = self.user_info
+        mock_DiscordClient.return_value.match_or_create_roles_from_names\
+            .return_value = []
+        mock_DiscordClient.return_value.add_guild_member.return_value = True
+        
+        result = DiscordUser.objects.add_user(self.user, authorization_code='abcdef')
+        self.assertTrue(result)
+        self.assertTrue(
+            DiscordUser.objects.filter(user=self.user, uid=TEST_USER_ID).exists()
+        )
+        self.assertTrue(mock_DiscordClient.return_value.add_guild_member.called)
+        args, kwargs = mock_DiscordClient.return_value.add_guild_member.call_args
+        self.assertEqual(kwargs['guild_id'], TEST_GUILD_ID)
+        self.assertEqual(kwargs['user_id'], TEST_USER_ID)
+        self.assertEqual(kwargs['access_token'], self.access_token)
+        self.assertIsNone(kwargs['role_ids'])
+        self.assertEqual(kwargs['nick'], TEST_MAIN_NAME)
+
+    @patch(MODULE_PATH + '.managers.DISCORD_SYNC_NAMES', False)
+    def test_can_create_user_no_roles_and_without_nick_if_turned_off(
+        self, 
+        mock_user_formatted_nick,
+        mock_user_group_names,                
+        mock_exchange_auth_code_for_token, 
+        mock_DiscordClient
+    ):        
+        mock_user_formatted_nick.return_value = TEST_MAIN_NAME
+        mock_user_group_names.return_value = []        
+        mock_exchange_auth_code_for_token.return_value = self.access_token
+        mock_DiscordClient.return_value.current_user.return_value = self.user_info
+        mock_DiscordClient.return_value.match_or_create_roles_from_names\
+            .return_value = []
+        mock_DiscordClient.return_value.add_guild_member.return_value = True
+        
+        result = DiscordUser.objects.add_user(self.user, authorization_code='abcdef')
+        self.assertTrue(result)
+        self.assertTrue(
+            DiscordUser.objects.filter(user=self.user, uid=TEST_USER_ID).exists()
+        )
+        self.assertTrue(mock_DiscordClient.return_value.add_guild_member.called)
+        args, kwargs = mock_DiscordClient.return_value.add_guild_member.call_args
+        self.assertEqual(kwargs['guild_id'], TEST_GUILD_ID)
+        self.assertEqual(kwargs['user_id'], TEST_USER_ID)
+        self.assertEqual(kwargs['access_token'], self.access_token)
+        self.assertIsNone(kwargs['role_ids'])
+        self.assertIsNone(kwargs['nick'])
+    
+    def test_can_activate_existing_guild_member(
+        self, 
+        mock_user_formatted_nick,
+        mock_user_group_names,                
+        mock_exchange_auth_code_for_token, 
+        mock_DiscordClient
+    ):
+        mock_user_formatted_nick.return_value = None
+        mock_user_group_names.return_value = []                
+        mock_exchange_auth_code_for_token.return_value = self.access_token
+        mock_DiscordClient.return_value.current_user.return_value = self.user_info
+        mock_DiscordClient.return_value.match_or_create_roles_from_names\
+            .return_value = []
+        mock_DiscordClient.return_value.add_guild_member.return_value = None
+        
+        result = DiscordUser.objects.add_user(self.user, authorization_code='abcdef')
+        self.assertTrue(result)
+        self.assertTrue(
+            DiscordUser.objects.filter(user=self.user, uid=TEST_USER_ID).exists()
+        )
+        self.assertTrue(mock_DiscordClient.return_value.add_guild_member.called)
+        
+    def test_return_false_when_user_creation_fails(
+        self, 
+        mock_user_formatted_nick,
+        mock_user_group_names,                
+        mock_exchange_auth_code_for_token, 
+        mock_DiscordClient
+    ):        
+        mock_user_formatted_nick.return_value = None
+        mock_user_group_names.return_value = []                
+        mock_exchange_auth_code_for_token.return_value = self.access_token
+        mock_DiscordClient.return_value.current_user.return_value = self.user_info
+        mock_DiscordClient.return_value.match_or_create_roles_from_names\
+            .return_value = []
+        mock_DiscordClient.return_value.add_guild_member.return_value = False
+        
+        result = DiscordUser.objects.add_user(self.user, authorization_code='abcdef')
+        self.assertFalse(result)
+        self.assertFalse(
+            DiscordUser.objects.filter(user=self.user, uid=TEST_USER_ID).exists()
+        )
+        self.assertTrue(mock_DiscordClient.return_value.add_guild_member.called)
+
+    def test_return_false_when_on_api_backoff(
+        self, 
+        mock_user_formatted_nick,
+        mock_user_group_names,                
+        mock_exchange_auth_code_for_token, 
+        mock_DiscordClient
+    ):        
+        mock_user_formatted_nick.return_value = None
+        mock_user_group_names.return_value = []        
+        mock_exchange_auth_code_for_token.return_value = self.access_token
+        mock_DiscordClient.return_value.current_user.return_value = self.user_info
+        mock_DiscordClient.return_value.match_or_create_roles_from_names\
+            .return_value = []
+        mock_DiscordClient.return_value.add_guild_member.side_effect = \
+            DiscordApiBackoff(999)
+        
+        result = DiscordUser.objects.add_user(self.user, authorization_code='abcdef')
+        self.assertFalse(result)
+        self.assertFalse(
+            DiscordUser.objects.filter(user=self.user, uid=TEST_USER_ID).exists()
+        )
+        self.assertTrue(mock_DiscordClient.return_value.add_guild_member.called)
+
+    def test_return_false_on_http_error(
+        self, 
+        mock_user_formatted_nick,
+        mock_user_group_names,                
+        mock_exchange_auth_code_for_token, 
+        mock_DiscordClient
+    ):        
+        mock_user_formatted_nick.return_value = None
+        mock_user_group_names.return_value = []        
+        mock_exchange_auth_code_for_token.return_value = self.access_token
+        mock_DiscordClient.return_value.current_user.return_value = self.user_info
+        mock_DiscordClient.return_value.match_or_create_roles_from_names\
+            .return_value = []
+        mock_exception = HTTPError('error')
+        mock_exception.response = Mock()
+        mock_exception.response.status_code = 500
+        mock_DiscordClient.return_value.add_guild_member.side_effect = mock_exception
+        
+        result = DiscordUser.objects.add_user(self.user, authorization_code='abcdef')
+        self.assertFalse(result)
+        self.assertFalse(
+            DiscordUser.objects.filter(user=self.user, uid=TEST_USER_ID).exists()
+        )
+        self.assertTrue(mock_DiscordClient.return_value.add_guild_member.called)
+        
+
+class TestOauthHelpers(TestCase):
+        
+    @patch(MODULE_PATH + '.managers.DISCORD_APP_ID', '123456')    
+    def test_generate_bot_add_url(self):
+        bot_add_url = DiscordUser.objects.generate_bot_add_url()
+
+        auth_url = DiscordClient.OAUTH_BASE_URL
+        real_bot_add_url = (
+            f'{auth_url}?client_id=123456&scope=bot'
+            f'&permissions={DiscordUser.objects.BOT_PERMISSIONS}'
+        )
         self.assertEqual(bot_add_url, real_bot_add_url)
 
     def test_generate_oauth_redirect_url(self):
-        oauth_url = DiscordOAuthManager.generate_oauth_redirect_url()
+        oauth_url = DiscordUser.objects.generate_oauth_redirect_url()
 
-        self.assertIn(manager.AUTH_URL, oauth_url)
+        self.assertIn(DiscordClient.OAUTH_BASE_URL, oauth_url)
-        self.assertIn('+'.join(manager.SCOPES), oauth_url)
+        self.assertIn('+'.join(DiscordUser.objects.SCOPES), oauth_url)
-        self.assertIn(settings.DISCORD_APP_ID, oauth_url)
+        self.assertIn(DISCORD_APP_ID, oauth_url)
-        self.assertIn(urllib.parse.quote_plus(settings.DISCORD_CALLBACK_URL), oauth_url)
+        self.assertIn(urllib.parse.quote_plus(DISCORD_CALLBACK_URL), oauth_url)
 
-    @mock.patch(MODULE_PATH + '.manager.OAuth2Session')
+    @patch(MODULE_PATH + '.managers.OAuth2Session')
-    def test__process_callback_code(self, oauth):
+    def test_process_callback_code(self, oauth):
         instance = oauth.return_value
         instance.fetch_token.return_value = {'access_token': 'mywonderfultoken'}
 
-        token = DiscordOAuthManager._process_callback_code('12345')
+        token = DiscordUser.objects._exchange_auth_code_for_token('12345')
 
         self.assertTrue(oauth.called)
         args, kwargs = oauth.call_args
-        self.assertEqual(args[0], settings.DISCORD_APP_ID)
+        self.assertEqual(args[0], DISCORD_APP_ID)
-        self.assertEqual(kwargs['redirect_uri'], settings.DISCORD_CALLBACK_URL)
+        self.assertEqual(kwargs['redirect_uri'], DISCORD_CALLBACK_URL)
         self.assertTrue(instance.fetch_token.called)
         args, kwargs = instance.fetch_token.call_args
-        self.assertEqual(args[0], manager.TOKEN_URL)
+        self.assertEqual(args[0], DiscordClient.OAUTH_TOKEN_URL)
-        self.assertEqual(kwargs['client_secret'], settings.DISCORD_APP_SECRET)
+        self.assertEqual(kwargs['client_secret'], DISCORD_APP_SECRET)
         self.assertEqual(kwargs['code'], '12345')
-        self.assertEqual(token['access_token'], 'mywonderfultoken')
+        self.assertEqual(token, 'mywonderfultoken')
 
-    @mock.patch(MODULE_PATH + '.manager.DiscordOAuthManager._process_callback_code')
-    @requests_mock.Mocker()
-    def test_add_user(self, oauth_token, m):
-        # Arrange
-        oauth_token.return_value = {'access_token': 'accesstoken'}
 
-        headers = {'accept': 'application/json', 'authorization': 'Bearer accesstoken'}
+class TestUserFormattedNick(TestCase):
     
-        m.register_uri('GET',
+    def setUp(self):        
-                       manager.DISCORD_URL + "/users/@me",
+        self.user = AuthUtils.create_user(TEST_USER_NAME)
-                       request_headers=headers,
-                       text=json.dumps({'id': "123456"}))
     
-        headers = {'accept': 'application/json', 'authorization': 'Bot ' + settings.DISCORD_BOT_TOKEN}
+    def test_return_nick_when_user_has_main(self):
+        AuthUtils.add_main_character_2(self.user, TEST_MAIN_NAME, TEST_MAIN_ID)
+        result = DiscordUser.objects.user_formatted_nick(self.user)
+        expected = TEST_MAIN_NAME
+        self.assertEqual(result, expected)
 
-        m.register_uri('PUT',
+    def test_return_none_if_user_has_no_main(self):        
-                       manager.DISCORD_URL + '/guilds/' + str(settings.DISCORD_GUILD_ID) + '/members/123456',
+        result = DiscordUser.objects.user_formatted_nick(self.user)        
-                       request_headers=headers,
+        self.assertIsNone(result)
-                       text='{}')
 
-        # Act
-        return_value = DiscordOAuthManager.add_user('abcdef', [])
 
-        # Assert
+class TestUserGroupNames(TestCase):
-        self.assertEqual(return_value, '123456')
-        self.assertEqual(m.call_count, 2)
 
-    @requests_mock.Mocker()
+    @classmethod
-    def test_delete_user(self, m):
+    def setUpClass(cls):
-        # Arrange
+        super().setUpClass()
-        headers = {'accept': 'application/json', 'authorization': 'Bot ' + settings.DISCORD_BOT_TOKEN}
+        cls.group_1 = Group.objects.create(name='Group 1')
+        cls.group_2 = Group.objects.create(name='Group 2')
     
-        user_id = 12345
+    def setUp(self):
-        request_url = '{}/guilds/{}/members/{}'.format(manager.DISCORD_URL, settings.DISCORD_GUILD_ID, user_id)
+        self.user = AuthUtils.create_member(TEST_USER_NAME)        
-        m.register_uri('DELETE',
-                       request_url,
-                       request_headers=headers,
-                       text=json.dumps({}))
 
-        # Act
+    def test_return_groups_and_state_names_for_user(self):
-        result = DiscordOAuthManager.delete_user(user_id)
+        self.user.groups.add(self.group_1)
+        result = DiscordUser.objects.user_group_names(self.user)
+        expected = ['Group 1', 'Member']
+        self.assertSetEqual(set(result), set(expected))
     
-        # Assert
+    def test_return_state_only_if_user_has_no_groups(self):
-        self.assertTrue(result)
+        result = DiscordUser.objects.user_group_names(self.user)
+        expected = ['Member']
+        self.assertSetEqual(set(result), set(expected))
 
-        ###
-        # Test 404 (already deleted)
-        # Arrange
-        m.register_uri('DELETE',
-                       request_url,
-                       request_headers=headers,
-                       status_code=404)
 
-        # Act
+class TestUserHasAccount(TestCase):
-        result = DiscordOAuthManager.delete_user(user_id)
 
-        # Assert
+    @classmethod
-        self.assertTrue(result)
+    def setUpClass(cls):
+        super().setUpClass()
+        cls.user = AuthUtils.create_user(TEST_USER_NAME)
 
-        ###
+    def test_return_true_if_user_has_account(self):
-        # Test 500 (some random API error)
+        DiscordUser.objects.create(user=self.user, uid=TEST_USER_ID)
-        # Arrange
+        self.assertTrue(DiscordUser.objects.user_has_account(self.user))
-        m.register_uri('DELETE',
-                       request_url,
-                       request_headers=headers,
-                       status_code=500)
 
-        # Act
+    def test_return_false_if_user_has_no_account(self):
-        result = DiscordOAuthManager.delete_user(user_id)
+        self.assertFalse(DiscordUser.objects.user_has_account(self.user))
 
-        # Assert
+    def test_return_false_if_user_does_not_exist(self):        
-        self.assertFalse(result)
+        my_user = User(username='Dummy')
+        self.assertFalse(DiscordUser.objects.user_has_account(my_user))
 
-    @requests_mock.Mocker()
+    def test_return_false_if_not_called_with_user_object(self):                
-    def test_update_nickname(self, m):
+        self.assertFalse(DiscordUser.objects.user_has_account('abc'))
-        # Arrange
-        headers = {'content-type': 'application/json', 'authorization': 'Bot ' + settings.DISCORD_BOT_TOKEN}
-
-        user_id = 12345
-        request_url = '{}/guilds/{}/members/{}'.format(manager.DISCORD_URL, settings.DISCORD_GUILD_ID, user_id)
-        m.patch(request_url,
-                request_headers=headers)
-
-        # Act
-        result = DiscordOAuthManager.update_nickname(user_id, 'somenick')
-
-        # Assert
-        self.assertTrue(result)
-
-    @mock.patch(MODULE_PATH + '.manager.DiscordOAuthManager._get_user_roles')
-    @mock.patch(MODULE_PATH + '.manager.DiscordOAuthManager._get_groups')
-    @requests_mock.Mocker()
-    def test_update_groups(self, group_cache, user_roles, m):
-        # Arrange
-        groups = ['Member', 'Blue', 'SpecialGroup']
-
-        group_cache.return_value = [{'id': '111', 'name': 'Member'},
-                                    {'id': '222', 'name': 'Blue'},
-                                    {'id': '333', 'name': 'SpecialGroup'},
-                                    {'id': '444', 'name': 'NotYourGroup'}]
-        user_roles.return_value = ['444']
-
-        headers = {'content-type': 'application/json', 'authorization': 'Bot ' + settings.DISCORD_BOT_TOKEN}
-        user_id = 12345
-        user_request_url = '{}/guilds/{}/members/{}'.format(manager.DISCORD_URL, settings.DISCORD_GUILD_ID, user_id)
-        group_request_urls = ['{}/guilds/{}/members/{}/roles/{}'.format(manager.DISCORD_URL, settings.DISCORD_GUILD_ID, user_id, g['id']) for g in group_cache.return_value]
-
-        m.patch(user_request_url, request_headers=headers)
-        [m.put(url, request_headers=headers) for url in group_request_urls[:-1]]
-        m.delete(group_request_urls[-1], request_headers=headers)
-
-        # Act
-        DiscordOAuthManager.update_groups(user_id, groups)
-
-        # Assert
-        self.assertEqual(len(m.request_history), 4, 'Must be 4 HTTP calls made')
-
-    @mock.patch(MODULE_PATH + '.manager.cache')
-    @mock.patch(MODULE_PATH + '.manager.DiscordOAuthManager._get_user_roles')
-    @mock.patch(MODULE_PATH + '.manager.DiscordOAuthManager._group_name_to_id')
-    @requests_mock.Mocker()
-    def test_update_groups_backoff(self, name_to_id, user_groups, djcache, m):
-        # Arrange
-        groups = ['Member']
-        user_groups.return_value = []
-        name_to_id.return_value = '111'
-
-        headers = {'content-type': 'application/json', 'authorization': 'Bot ' + settings.DISCORD_BOT_TOKEN}
-        user_id = 12345
-        request_url = '{}/guilds/{}/members/{}/roles/{}'.format(manager.DISCORD_URL, settings.DISCORD_GUILD_ID, user_id, name_to_id.return_value)
-
-        djcache.get.return_value = None  # No existing backoffs in cache
-
-        m.put(request_url,
-              request_headers=headers,
-              headers={'Retry-After': '200000'},
-              status_code=429)
-
-        # Act & Assert
-        with self.assertRaises(manager.DiscordApiBackoff) as bo:
-            try:
-                DiscordOAuthManager.update_groups(user_id, groups, blocking=False)
-            except manager.DiscordApiBackoff as bo:
-                self.assertEqual(bo.retry_after, 200000, 'Retry-After time must be equal to Retry-After set in header')
-                self.assertFalse(bo.global_ratelimit, 'global_ratelimit must be False')
-                raise bo
-
-        self.assertTrue(djcache.set.called)
-        args, kwargs = djcache.set.call_args
-        self.assertEqual(args[0], 'DISCORD_BACKOFF_update_groups')
-        self.assertTrue(datetime.datetime.strptime(args[1], manager.cache_time_format) > datetime.datetime.now())
-
-    @mock.patch(MODULE_PATH + '.manager.cache')
-    @mock.patch(MODULE_PATH + '.manager.DiscordOAuthManager._get_user_roles')
-    @mock.patch(MODULE_PATH + '.manager.DiscordOAuthManager._group_name_to_id')
-    @requests_mock.Mocker()
-    def test_update_groups_global_backoff(self, name_to_id, user_groups, djcache, m):
-        # Arrange
-        groups = ['Member']
-        user_groups.return_value = []
-        name_to_id.return_value = '111'
-
-        headers = {'content-type': 'application/json', 'authorization': 'Bot ' + settings.DISCORD_BOT_TOKEN}
-        user_id = 12345
-        request_url = '{}/guilds/{}/members/{}/roles/{}'.format(manager.DISCORD_URL, settings.DISCORD_GUILD_ID, user_id, name_to_id.return_value)
-
-        djcache.get.return_value = None  # No existing backoffs in cache
-
-        m.put(request_url,
-              request_headers=headers,
-              headers={'Retry-After': '200000', 'X-RateLimit-Global': 'true'},
-              status_code=429)
-
-        # Act & Assert
-        with self.assertRaises(manager.DiscordApiBackoff) as bo:
-            try:
-                DiscordOAuthManager.update_groups(user_id, groups, blocking=False)
-            except manager.DiscordApiBackoff as bo:
-                self.assertEqual(bo.retry_after, 200000, 'Retry-After time must be equal to Retry-After set in header')
-                self.assertTrue(bo.global_ratelimit, 'global_ratelimit must be True')
-                raise bo
-
-        self.assertTrue(djcache.set.called)
-        args, kwargs = djcache.set.call_args
-        self.assertEqual(args[0], 'DISCORD_BACKOFF_GLOBAL')
-        self.assertTrue(datetime.datetime.strptime(args[1], manager.cache_time_format) > datetime.datetime.now())

allianceauth/services/modules/discord/tests/test_models.py

@@ -0,0 +1,437 @@
+from unittest.mock import patch, Mock
+
+from requests.exceptions import HTTPError
+
+from django.test import TestCase
+
+from allianceauth.tests.auth_utils import AuthUtils
+
+from . import (
+    TEST_USER_NAME, 
+    TEST_USER_ID, 
+    TEST_MAIN_NAME, 
+    TEST_MAIN_ID, 
+    MODULE_PATH,
+    ROLE_ALPHA, 
+    ROLE_BRAVO, 
+    ROLE_CHARLIE, 
+    ROLE_MIKE    
+)
+from ..discord_client import DiscordClient, DiscordApiBackoff
+from ..discord_client.tests import create_matched_role
+from ..models import DiscordUser
+from ..utils import set_logger_to_file
+
+
+logger = set_logger_to_file(MODULE_PATH + '.models', __file__)
+
+
+class TestBasicsAndHelpers(TestCase):
+
+    def test_str(self):
+        user = AuthUtils.create_user(TEST_USER_NAME)
+        discord_user = DiscordUser.objects.create(user=user, uid=TEST_USER_ID)
+        expected = 'Peter Parker - 198765432012345678'
+        self.assertEqual(str(discord_user), expected)
+
+    def test_repr(self):
+        user = AuthUtils.create_user(TEST_USER_NAME)
+        discord_user = DiscordUser.objects.create(user=user, uid=TEST_USER_ID)
+        expected = 'DiscordUser(user=\'Peter Parker\', uid=198765432012345678)'
+        self.assertEqual(repr(discord_user), expected)
+
+
+@patch(MODULE_PATH + '.managers.DiscordClient', spec=DiscordClient)
+class TestUpdateNick(TestCase):
+
+    def setUp(self):        
+        self.user = AuthUtils.create_user(TEST_USER_NAME)
+        self.discord_user = DiscordUser.objects.create(
+            user=self.user, uid=TEST_USER_ID
+        )
+   
+    def test_can_update(self, mock_DiscordClient):
+        AuthUtils.add_main_character_2(self.user, TEST_MAIN_NAME, TEST_MAIN_ID)        
+        mock_DiscordClient.return_value.modify_guild_member.return_value = True
+        
+        result = self.discord_user.update_nickname()
+        self.assertTrue(result)
+        self.assertTrue(mock_DiscordClient.return_value.modify_guild_member.called)
+
+    def test_dont_update_if_user_has_no_main(self, mock_DiscordClient):        
+        mock_DiscordClient.return_value.modify_guild_member.return_value = False
+        
+        result = self.discord_user.update_nickname()
+        self.assertFalse(result)
+        self.assertFalse(mock_DiscordClient.return_value.modify_guild_member.called)
+    
+    def test_return_none_if_user_no_longer_a_member(self, mock_DiscordClient):
+        AuthUtils.add_main_character_2(self.user, TEST_MAIN_NAME, TEST_MAIN_ID)
+        mock_DiscordClient.return_value.modify_guild_member.return_value = None
+        
+        result = self.discord_user.update_nickname()
+        self.assertIsNone(result)
+        self.assertTrue(mock_DiscordClient.return_value.modify_guild_member.called)        
+
+    def test_return_false_if_api_returns_false(self, mock_DiscordClient):
+        AuthUtils.add_main_character_2(self.user, TEST_MAIN_NAME, TEST_MAIN_ID)        
+        mock_DiscordClient.return_value.modify_guild_member.return_value = False
+        
+        result = self.discord_user.update_nickname()
+        self.assertFalse(result)
+        self.assertTrue(mock_DiscordClient.return_value.modify_guild_member.called)
+
+
+@patch(MODULE_PATH + '.managers.DiscordClient', spec=DiscordClient)
+class TestUpdateUsername(TestCase):
+
+    @classmethod
+    def setUpClass(cls):
+        super().setUpClass()
+        cls.user = AuthUtils.create_user(TEST_USER_NAME)
+    
+    def setUp(self):         
+        self.discord_user = DiscordUser.objects.create(
+            user=self.user, 
+            uid=TEST_USER_ID, 
+            username=TEST_MAIN_NAME, 
+            discriminator='1234'
+        )
+    
+    def test_can_update(self, mock_DiscordClient):        
+        new_username = 'New name'
+        new_discriminator = '9876'
+        user_info = {
+            'user': {
+                'id': str(TEST_USER_ID),
+                'username': new_username,
+                'discriminator': new_discriminator,
+            }
+        }
+        mock_DiscordClient.return_value.guild_member.return_value = user_info
+        
+        result = self.discord_user.update_username()
+        self.assertTrue(result)
+        self.assertTrue(mock_DiscordClient.return_value.guild_member.called)
+        self.discord_user.refresh_from_db()
+        self.assertEqual(self.discord_user.username, new_username)
+        self.assertEqual(self.discord_user.discriminator, new_discriminator)
+
+    def test_return_none_if_user_no_longer_a_member(self, mock_DiscordClient):
+        mock_DiscordClient.return_value.guild_member.return_value = None
+        result = self.discord_user.update_username()
+        self.assertIsNone(result)
+        self.assertTrue(mock_DiscordClient.return_value.guild_member.called)
+
+    def test_return_false_if_api_returns_false(self, mock_DiscordClient):
+        mock_DiscordClient.return_value.guild_member.return_value = False
+        result = self.discord_user.update_username()
+        self.assertFalse(result)
+        self.assertTrue(mock_DiscordClient.return_value.guild_member.called)
+
+    def test_return_false_if_api_returns_corrput_data_1(self, mock_DiscordClient):
+        mock_DiscordClient.return_value.guild_member.return_value = {'invalid': True}
+        result = self.discord_user.update_username()
+        self.assertFalse(result)
+        self.assertTrue(mock_DiscordClient.return_value.guild_member.called)
+
+    def test_return_false_if_api_returns_corrput_data_2(self, mock_DiscordClient):
+        user_info = {
+            'user': {
+                'id': str(TEST_USER_ID),                
+                'discriminator': '1234',
+            }
+        }
+        mock_DiscordClient.return_value.guild_member.return_value = user_info
+        result = self.discord_user.update_username()
+        self.assertFalse(result)
+        self.assertTrue(mock_DiscordClient.return_value.guild_member.called)
+
+    def test_return_false_if_api_returns_corrput_data_3(self, mock_DiscordClient):
+        user_info = {
+            'user': {
+                'id': str(TEST_USER_ID),                
+                'username': TEST_USER_NAME,
+            }
+        }
+        mock_DiscordClient.return_value.guild_member.return_value = user_info
+        result = self.discord_user.update_username()
+        self.assertFalse(result)
+        self.assertTrue(mock_DiscordClient.return_value.guild_member.called)
+
+
+@patch(MODULE_PATH + '.models.notify')
+@patch(MODULE_PATH + '.managers.DiscordClient', spec=DiscordClient)
+class TestDeleteUser(TestCase):
+
+    @classmethod
+    def setUpClass(cls):
+        super().setUpClass()
+        cls.user = AuthUtils.create_user(TEST_USER_NAME)
+
+    def setUp(self):         
+        self.discord_user = DiscordUser.objects.create(
+            user=self.user, uid=TEST_USER_ID
+        )
+
+    def test_can_delete_user(self, mock_DiscordClient, mock_notify):        
+        mock_DiscordClient.return_value.remove_guild_member.return_value = True
+        result = self.discord_user.delete_user()
+        self.assertTrue(result)
+        self.assertFalse(
+            DiscordUser.objects.filter(user=self.user, uid=TEST_USER_ID).exists()
+        )
+        self.assertTrue(mock_DiscordClient.return_value.remove_guild_member.called)
+        self.assertFalse(mock_notify.called)
+
+    def test_can_delete_user_and_notify_user(self, mock_DiscordClient, mock_notify):
+        mock_DiscordClient.return_value.remove_guild_member.return_value = True
+        result = self.discord_user.delete_user(notify_user=True)
+        self.assertTrue(result)
+        self.assertTrue(mock_notify.called)
+
+    def test_can_delete_user_when_member_is_unknown(
+        self, mock_DiscordClient, mock_notify
+    ): 
+        mock_DiscordClient.return_value.remove_guild_member.return_value = None
+        result = self.discord_user.delete_user()
+        self.assertTrue(result)
+        self.assertFalse(
+            DiscordUser.objects.filter(user=self.user, uid=TEST_USER_ID).exists()
+        )
+        self.assertTrue(mock_DiscordClient.return_value.remove_guild_member.called)
+        self.assertFalse(mock_notify.called)
+
+    def test_return_false_when_api_fails(self, mock_DiscordClient, mock_notify):
+        mock_DiscordClient.return_value.remove_guild_member.return_value = False
+        result = self.discord_user.delete_user()
+        self.assertFalse(result)
+
+    def test_dont_notify_if_user_was_already_deleted_and_return_none(
+        self, mock_DiscordClient, mock_notify
+    ):
+        mock_DiscordClient.return_value.remove_guild_member.return_value = None
+        DiscordUser.objects.get(pk=self.discord_user.pk).delete()
+        result = self.discord_user.delete_user()
+        self.assertIsNone(result)
+        self.assertFalse(
+            DiscordUser.objects.filter(user=self.user, uid=TEST_USER_ID).exists()
+        )
+        self.assertTrue(mock_DiscordClient.return_value.remove_guild_member.called)
+        self.assertFalse(mock_notify.called)
+    
+    def test_raise_exception_on_api_backoff(
+        self, mock_DiscordClient, mock_notify
+    ):
+        mock_DiscordClient.return_value.remove_guild_member.side_effect = \
+            DiscordApiBackoff(999)
+        with self.assertRaises(DiscordApiBackoff):
+            self.discord_user.delete_user()
+        
+    def test_return_false_on_api_backoff_and_exception_handling_on(
+        self, mock_DiscordClient, mock_notify
+    ):
+        mock_DiscordClient.return_value.remove_guild_member.side_effect = \
+            DiscordApiBackoff(999)
+        result = self.discord_user.delete_user(handle_api_exceptions=True)
+        self.assertFalse(result)
+
+    def test_raise_exception_on_http_error(
+        self, mock_DiscordClient, mock_notify
+    ):
+        mock_exception = HTTPError('error')
+        mock_exception.response = Mock()
+        mock_exception.response.status_code = 500
+        mock_DiscordClient.return_value.remove_guild_member.side_effect = \
+            mock_exception
+        
+        with self.assertRaises(HTTPError):
+            self.discord_user.delete_user()        
+
+    def test_return_false_on_http_error_and_exception_handling_on(
+        self, mock_DiscordClient, mock_notify
+    ):
+        mock_exception = HTTPError('error')
+        mock_exception.response = Mock()
+        mock_exception.response.status_code = 500
+        mock_DiscordClient.return_value.remove_guild_member.side_effect = \
+            mock_exception
+        result = self.discord_user.delete_user(handle_api_exceptions=True)
+        self.assertFalse(result)
+
+
+@patch(MODULE_PATH + '.managers.DiscordClient', spec=DiscordClient)
+@patch(MODULE_PATH + '.models.DiscordUser.objects.user_group_names')
+class TestUpdateGroups(TestCase):
+
+    def setUp(self): 
+        self.user = AuthUtils.create_user(TEST_USER_NAME)
+        self.discord_user = DiscordUser.objects.create(
+            user=self.user, uid=TEST_USER_ID
+        )
+        self.guild_roles = [ROLE_ALPHA, ROLE_BRAVO, ROLE_CHARLIE, ROLE_MIKE]
+        self.roles_requested = [
+            create_matched_role(ROLE_ALPHA), create_matched_role(ROLE_BRAVO)
+        ]  
+        
+    def test_update_if_needed(
+        self, 
+        mock_user_group_names,         
+        mock_DiscordClient
+    ):
+        roles_current = [1]        
+        mock_user_group_names.return_value = []
+        mock_DiscordClient.return_value.match_or_create_roles_from_names\
+            .return_value = self.roles_requested
+        mock_DiscordClient.return_value.guild_roles.return_value = self.guild_roles
+        mock_DiscordClient.return_value.guild_member.return_value = \
+            {'roles': roles_current}
+        mock_DiscordClient.return_value.modify_guild_member.return_value = True
+        
+        result = self.discord_user.update_groups()
+        self.assertTrue(result)
+        self.assertTrue(mock_DiscordClient.return_value.modify_guild_member.called)
+        args, kwargs = mock_DiscordClient.return_value.modify_guild_member.call_args
+        self.assertEqual(set(kwargs['role_ids']), {1, 2})
+
+    def test_update_if_needed_and_preserve_managed_roles(
+        self, 
+        mock_user_group_names,         
+        mock_DiscordClient
+    ):
+        roles_current = [1, 13]          
+        mock_user_group_names.return_value = []
+        mock_DiscordClient.return_value.match_or_create_roles_from_names\
+            .return_value = self.roles_requested
+        mock_DiscordClient.return_value.guild_roles.return_value = self.guild_roles
+        mock_DiscordClient.return_value.guild_member.return_value = \
+            {'roles': roles_current}
+        mock_DiscordClient.return_value.modify_guild_member.return_value = True
+        
+        result = self.discord_user.update_groups()
+        self.assertTrue(result)
+        self.assertTrue(mock_DiscordClient.return_value.modify_guild_member.called)
+        args, kwargs = mock_DiscordClient.return_value.modify_guild_member.call_args
+        self.assertEqual(set(kwargs['role_ids']), {1, 2, 13})
+
+    def test_dont_update_if_not_needed(
+        self, 
+        mock_user_group_names,         
+        mock_DiscordClient
+    ):
+        roles_current = [1, 2, 13]        
+        mock_user_group_names.return_value = []
+        mock_DiscordClient.return_value.match_or_create_roles_from_names\
+            .return_value = self.roles_requested
+        mock_DiscordClient.return_value.guild_roles.return_value = self.guild_roles
+        mock_DiscordClient.return_value.guild_member.return_value = \
+            {'roles': roles_current}
+                
+        result = self.discord_user.update_groups()
+        self.assertTrue(result)
+        self.assertFalse(mock_DiscordClient.return_value.modify_guild_member.called)
+
+    def test_update_if_user_has_no_roles_on_discord(
+        self, 
+        mock_user_group_names,         
+        mock_DiscordClient
+    ):
+        roles_current = []        
+        mock_user_group_names.return_value = []
+        mock_DiscordClient.return_value.match_or_create_roles_from_names\
+            .return_value = self.roles_requested
+        mock_DiscordClient.return_value.guild_roles.return_value = self.guild_roles
+        mock_DiscordClient.return_value.guild_member.return_value = \
+            {'roles': roles_current}
+        mock_DiscordClient.return_value.modify_guild_member.return_value = True
+        
+        result = self.discord_user.update_groups()
+        self.assertTrue(result)
+        self.assertTrue(mock_DiscordClient.return_value.modify_guild_member.called)
+        args, kwargs = mock_DiscordClient.return_value.modify_guild_member.call_args
+        self.assertEqual(set(kwargs['role_ids']), {1, 2})
+    
+    def test_return_none_if_user_no_longer_a_member(
+        self, 
+        mock_user_group_names,         
+        mock_DiscordClient
+    ):                        
+        mock_DiscordClient.return_value.guild_member.return_value = None
+                
+        result = self.discord_user.update_groups()
+        self.assertIsNone(result)
+        self.assertFalse(mock_DiscordClient.return_value.modify_guild_member.called)
+
+    def test_return_false_if_api_returns_false(
+        self, 
+        mock_user_group_names,         
+        mock_DiscordClient
+    ):
+        roles_current = [1]        
+        mock_user_group_names.return_value = []
+        mock_DiscordClient.return_value.match_or_create_roles_from_names\
+            .return_value = self.roles_requested
+        mock_DiscordClient.return_value.guild_roles.return_value = self.guild_roles
+        mock_DiscordClient.return_value.guild_member.return_value = \
+            {'roles': roles_current}
+        mock_DiscordClient.return_value.modify_guild_member.return_value = False
+        
+        result = self.discord_user.update_groups()
+        self.assertFalse(result)
+        self.assertTrue(mock_DiscordClient.return_value.modify_guild_member.called)
+
+    def test_raise_exception_if_member_has_unknown_roles(
+        self, 
+        mock_user_group_names,         
+        mock_DiscordClient
+    ):
+        roles_current = [99]        
+        mock_user_group_names.return_value = []
+        mock_DiscordClient.return_value.match_or_create_roles_from_names\
+            .return_value = self.roles_requested
+        mock_DiscordClient.return_value.guild_roles.return_value = self.guild_roles
+        mock_DiscordClient.return_value.guild_member.return_value = \
+            {'roles': roles_current}
+        mock_DiscordClient.return_value.modify_guild_member.return_value = True
+        
+        with self.assertRaises(RuntimeError):
+            self.discord_user.update_groups()
+
+    def test_refresh_guild_roles_user_roles_dont_not_match(
+        self, 
+        mock_user_group_names,         
+        mock_DiscordClient
+    ):                
+        def my_guild_roles(guild_id, use_cache=True):
+            if use_cache:
+                return [ROLE_ALPHA, ROLE_BRAVO, ROLE_MIKE]
+            else:
+                return [ROLE_ALPHA, ROLE_BRAVO, ROLE_CHARLIE, ROLE_MIKE]
+        
+        roles_current = [3]
+        mock_user_group_names.return_value = []
+        mock_DiscordClient.return_value.match_or_create_roles_from_names\
+            .return_value = self.roles_requested
+        mock_DiscordClient.return_value.guild_roles.side_effect = my_guild_roles
+        mock_DiscordClient.return_value.guild_member.return_value = \
+            {'roles': roles_current}
+        mock_DiscordClient.return_value.modify_guild_member.return_value = True
+        result = self.discord_user.update_groups()
+        self.assertTrue(result)
+        self.assertEqual(mock_DiscordClient.return_value.guild_roles.call_count, 2)
+
+    def test_raise_exception_if_member_info_is_invalid(
+        self, 
+        mock_user_group_names,         
+        mock_DiscordClient
+    ):        
+        mock_user_group_names.return_value = []
+        mock_DiscordClient.return_value.match_or_create_roles_from_names\
+            .return_value = self.roles_requested
+        mock_DiscordClient.return_value.guild_roles.return_value = self.guild_roles
+        mock_DiscordClient.return_value.guild_member.return_value = \
+            {'user': 'dummy'}
+        mock_DiscordClient.return_value.modify_guild_member.return_value = True
+        
+        with self.assertRaises(RuntimeError):
+            self.discord_user.update_groups()

allianceauth/services/modules/discord/tests/test_tasks.py

@@ -0,0 +1,363 @@
+from unittest.mock import MagicMock, patch
+
+from celery.exceptions import Retry
+from requests.exceptions import HTTPError
+
+from django.test import TestCase
+from django.contrib.auth.models import Group
+from django.test.utils import override_settings
+
+from allianceauth.tests.auth_utils import AuthUtils
+
+from . import TEST_USER_NAME, TEST_USER_ID, TEST_MAIN_NAME, TEST_MAIN_ID
+from ..models import DiscordUser
+from ..discord_client import DiscordApiBackoff
+from .. import tasks
+from ..utils import set_logger_to_file
+
+
+MODULE_PATH = 'allianceauth.services.modules.discord.tasks'
+logger = set_logger_to_file(MODULE_PATH, __file__)
+
+
+@patch(MODULE_PATH + '.DiscordUser.update_groups')
+class TestUpdateGroups(TestCase):
+    
+    @classmethod
+    def setUpClass(cls):
+        super().setUpClass()
+        cls.user = AuthUtils.create_member(TEST_USER_NAME)
+        cls.group_1 = Group.objects.create(name='Group 1')
+        cls.group_2 = Group.objects.create(name='Group 2')
+        cls.group_1.user_set.add(cls.user)
+        cls.group_2.user_set.add(cls.user)
+        
+    def test_can_update_groups(self, mock_update_groups):
+        DiscordUser.objects.create(user=self.user, uid=TEST_USER_ID)
+        tasks.update_groups(self.user.pk)
+        self.assertTrue(mock_update_groups.called)
+
+    def test_no_action_if_user_has_no_discord_account(self, mock_update_groups):
+        tasks.update_groups(self.user.pk)
+        self.assertFalse(mock_update_groups.called)
+    
+    def test_retries_on_api_backoff(self, mock_update_groups):
+        DiscordUser.objects.create(user=self.user, uid=TEST_USER_ID)
+        mock_exception = DiscordApiBackoff(999)
+        mock_update_groups.side_effect = mock_exception
+
+        with self.assertRaises(Retry):
+            tasks.update_groups(self.user.pk)
+
+    def test_retry_on_http_error_except_404(self, mock_update_groups):
+        DiscordUser.objects.create(user=self.user, uid=TEST_USER_ID)
+        mock_exception = HTTPError('error')
+        mock_exception.response = MagicMock()
+        mock_exception.response.status_code = 500
+        mock_update_groups.side_effect = mock_exception
+
+        with self.assertRaises(Retry):
+            tasks.update_groups(self.user.pk)
+    
+    def test_retry_on_http_error_404_when_user_not_deleted(self, mock_update_groups):
+        DiscordUser.objects.create(user=self.user, uid=TEST_USER_ID)
+        mock_exception = HTTPError('error')
+        mock_exception.response = MagicMock()
+        mock_exception.response.status_code = 404
+        mock_update_groups.side_effect = mock_exception
+
+        with self.assertRaises(Retry):
+            tasks.update_groups(self.user.pk)
+        
+    def test_retry_on_non_http_error(self, mock_update_groups):        
+        DiscordUser.objects.create(user=self.user, uid=TEST_USER_ID)
+        mock_update_groups.side_effect = ConnectionError
+
+        with self.assertRaises(Retry):
+            tasks.update_groups(self.user.pk)
+        
+    @patch(MODULE_PATH + '.DISCORD_TASKS_MAX_RETRIES', 3)
+    def test_log_error_if_retries_exhausted(self, mock_update_groups):
+        DiscordUser.objects.create(user=self.user, uid=TEST_USER_ID)        
+        mock_task = MagicMock(**{'request.retries': 3})
+        mock_update_groups.side_effect = ConnectionError
+        update_groups_inner = tasks.update_groups.__wrapped__.__func__
+                
+        update_groups_inner(mock_task, self.user.pk)
+                
+    @patch(MODULE_PATH + '.delete_user.delay')
+    def test_delete_user_if_user_is_no_longer_member_of_discord_server(
+        self, mock_delete_user, mock_update_groups
+    ):
+        mock_update_groups.return_value = None
+        
+        DiscordUser.objects.create(user=self.user, uid=TEST_USER_ID)
+        tasks.update_groups(self.user.pk)
+        self.assertTrue(mock_update_groups.called)
+        self.assertTrue(mock_delete_user.called)
+
+
+@patch(MODULE_PATH + '.DiscordUser.update_nickname')
+class TestUpdateNickname(TestCase):
+    
+    @classmethod
+    def setUpClass(cls):
+        super().setUpClass()
+        cls.user = AuthUtils.create_member(TEST_USER_NAME)
+        AuthUtils.add_main_character_2(
+            cls.user, 
+            TEST_MAIN_NAME, 
+            TEST_MAIN_ID, 
+            corp_id='2', 
+            corp_name='test_corp', 
+            corp_ticker='TEST',
+            disconnect_signals=True
+        )
+        cls.discord_user = DiscordUser.objects.create(user=cls.user, uid=TEST_USER_ID)
+
+    def test_can_update_nickname(self, mock_update_nickname):        
+        mock_update_nickname.return_value = True        
+        
+        tasks.update_nickname(self.user.pk)
+        self.assertTrue(mock_update_nickname.called)
+
+    def test_no_action_when_user_had_no_account(self, mock_update_nickname):
+        my_user = AuthUtils.create_user('Dummy User')
+        mock_update_nickname.return_value = False
+        
+        tasks.update_nickname(my_user.pk)
+        self.assertFalse(mock_update_nickname.called)
+        
+    def test_retries_on_api_backoff(self, mock_update_nickname):                
+        mock_exception = DiscordApiBackoff(999)
+        mock_update_nickname.side_effect = mock_exception
+        
+        with self.assertRaises(Retry):
+            tasks.update_nickname(self.user.pk)
+
+    def test_retries_on_general_exception(self, mock_update_nickname):        
+        mock_update_nickname.side_effect = ConnectionError
+        
+        with self.assertRaises(Retry):
+            tasks.update_nickname(self.user.pk)
+
+    @patch(MODULE_PATH + '.DISCORD_TASKS_MAX_RETRIES', 3)
+    def test_log_error_if_retries_exhausted(self, mock_update_nickname):
+        mock_task = MagicMock(**{'request.retries': 3})
+        mock_update_nickname.side_effect = ConnectionError
+        update_nickname_inner = tasks.update_nickname.__wrapped__.__func__
+                
+        update_nickname_inner(mock_task, self.user.pk)
+        
+
+@patch(MODULE_PATH + '.DiscordUser.update_username')
+class TestUpdateUsername(TestCase):
+
+    @classmethod
+    def setUpClass(cls):
+        super().setUpClass()
+        cls.user = AuthUtils.create_member(TEST_USER_NAME)
+        cls.discord_user = DiscordUser.objects.create(user=cls.user, uid=TEST_USER_ID)
+
+    def test_can_update_username(self, mock_update_username):
+        mock_update_username.return_value = True
+
+        tasks.update_username(self.user.pk)
+        self.assertTrue(mock_update_username.called)
+
+
+@patch(MODULE_PATH + '.DiscordUser.delete_user')
+class TestDeleteUser(TestCase):
+
+    @classmethod
+    def setUpClass(cls):
+        super().setUpClass()
+        cls.user = AuthUtils.create_member(TEST_USER_NAME)
+        cls.discord_user = DiscordUser.objects.create(user=cls.user, uid=TEST_USER_ID)
+
+    def test_can_delete_user(self, mock_delete_user):
+        mock_delete_user.return_value = True
+
+        tasks.delete_user(self.user.pk)
+        self.assertTrue(mock_delete_user.called)
+
+    def test_can_delete_user_with_notify(self, mock_delete_user):
+        mock_delete_user.return_value = True
+
+        tasks.delete_user(self.user.pk, notify_user=True)
+        self.assertTrue(mock_delete_user.called)
+        args, kwargs = mock_delete_user.call_args
+        self.assertTrue(kwargs['notify_user'])
+
+    @patch(MODULE_PATH + '.delete_user.delay')
+    def test_dont_retry_delete_user_if_user_is_no_longer_member_of_discord_server(
+        self, mock_delete_user_delay, mock_delete_user
+    ):
+        mock_delete_user.return_value = None
+        
+        tasks.delete_user(self.user.pk)
+        self.assertTrue(mock_delete_user.called)
+        self.assertFalse(mock_delete_user_delay.called)
+
+
+@patch(MODULE_PATH + '.DiscordUser.update_groups')
+class TestTaskPerformUserAction(TestCase):
+
+    @classmethod
+    def setUpClass(cls):
+        super().setUpClass()
+        cls.user = AuthUtils.create_member('Peter Parker')    
+        cls.discord_user = DiscordUser.objects.create(user=cls.user, uid=TEST_USER_ID)
+
+    def test_raise_value_error_on_unknown_method(self, mock_update_groups):
+        mock_task = MagicMock(**{'request.retries': 0})
+        
+        with self.assertRaises(ValueError):
+            tasks._task_perform_user_action(mock_task, self.user.pk, 'invalid_method')
+    
+    def test_catch_and_log_unexpected_exceptions(self, mock_update_groups):
+        mock_task = MagicMock(**{'request.retries': 0})
+        mock_update_groups.side_effect = RuntimeError
+
+        tasks._task_perform_user_action(mock_task, self.user.pk, 'update_groups')
+
+
+@override_settings(CELERY_ALWAYS_EAGER=True)
+class TestBulkTasks(TestCase):
+    
+    @classmethod
+    def setUpClass(cls):
+        super().setUpClass()
+        cls.user_1 = AuthUtils.create_user('Peter Parker')
+        cls.user_2 = AuthUtils.create_user('Kara Danvers')
+        cls.user_3 = AuthUtils.create_user('Clark Kent')
+        DiscordUser.objects.all().delete()
+
+    @patch(MODULE_PATH + '.update_groups.si')
+    def test_can_update_groups_for_multiple_users(self, mock_update_groups):
+        du_1 = DiscordUser.objects.create(user=self.user_1, uid=123)
+        du_2 = DiscordUser.objects.create(user=self.user_2, uid=456)
+        DiscordUser.objects.create(user=self.user_3, uid=789)
+        expected_pks = [du_1.pk, du_2.pk]
+
+        tasks.update_groups_bulk(expected_pks)
+        self.assertEqual(mock_update_groups.call_count, 2)
+        current_pks = [args[0][0] for args in mock_update_groups.call_args_list]
+        
+        self.assertSetEqual(set(current_pks), set(expected_pks))
+
+    @patch(MODULE_PATH + '.update_groups.si')
+    def test_can_update_all_groups(self, mock_update_groups):
+        du_1 = DiscordUser.objects.create(user=self.user_1, uid=123)
+        du_2 = DiscordUser.objects.create(user=self.user_2, uid=456)
+        du_3 = DiscordUser.objects.create(user=self.user_3, uid=789)
+
+        tasks.update_all_groups()
+        self.assertEqual(mock_update_groups.call_count, 3)
+        current_pks = [args[0][0] for args in mock_update_groups.call_args_list]
+        expected_pks = [du_1.pk, du_2.pk, du_3.pk]
+        self.assertSetEqual(set(current_pks), set(expected_pks))
+
+    @patch(MODULE_PATH + '.update_nickname.si')
+    def test_can_update_nicknames_for_multiple_users(self, mock_update_nickname):
+        du_1 = DiscordUser.objects.create(user=self.user_1, uid=123)
+        du_2 = DiscordUser.objects.create(user=self.user_2, uid=456)
+        DiscordUser.objects.create(user=self.user_3, uid=789)
+        expected_pks = [du_1.pk, du_2.pk]
+
+        tasks.update_nicknames_bulk(expected_pks)
+        self.assertEqual(mock_update_nickname.call_count, 2)
+        current_pks = [
+            args[0][0] for args in mock_update_nickname.call_args_list
+        ]        
+        self.assertSetEqual(set(current_pks), set(expected_pks))
+
+    @patch(MODULE_PATH + '.update_nickname.si')
+    def test_can_update_nicknames_for_all_users(self, mock_update_nickname):
+        du_1 = DiscordUser.objects.create(user=self.user_1, uid='123')
+        du_2 = DiscordUser.objects.create(user=self.user_2, uid='456')
+        du_3 = DiscordUser.objects.create(user=self.user_3, uid='789')
+
+        tasks.update_all_nicknames()
+        self.assertEqual(mock_update_nickname.call_count, 3)
+        current_pks = [
+            args[0][0] for args in mock_update_nickname.call_args_list
+        ]
+        expected_pks = [du_1.pk, du_2.pk, du_3.pk]
+        self.assertSetEqual(set(current_pks), set(expected_pks))
+
+    @patch(MODULE_PATH + '.update_username.si')
+    def test_can_update_username_for_multiple_users(self, mock_update_username):
+        du_1 = DiscordUser.objects.create(user=self.user_1, uid=123)
+        du_2 = DiscordUser.objects.create(user=self.user_2, uid=456)
+        DiscordUser.objects.create(user=self.user_3, uid=789)
+        expected_pks = [du_1.pk, du_2.pk]
+
+        tasks.update_usernames_bulk(expected_pks)
+        self.assertEqual(mock_update_username.call_count, 2)
+        current_pks = [args[0][0] for args in mock_update_username.call_args_list]
+        
+        self.assertSetEqual(set(current_pks), set(expected_pks))
+
+    @patch(MODULE_PATH + '.update_username.si')
+    def test_can_update_all_usernames(self, mock_update_username):
+        du_1 = DiscordUser.objects.create(user=self.user_1, uid=123)
+        du_2 = DiscordUser.objects.create(user=self.user_2, uid=456)
+        du_3 = DiscordUser.objects.create(user=self.user_3, uid=789)
+
+        tasks.update_all_usernames()
+        self.assertEqual(mock_update_username.call_count, 3)
+        current_pks = [args[0][0] for args in mock_update_username.call_args_list]
+        expected_pks = [du_1.pk, du_2.pk, du_3.pk]
+        self.assertSetEqual(set(current_pks), set(expected_pks))
+
+    @patch(MODULE_PATH + '.DISCORD_SYNC_NAMES', True)
+    @patch(MODULE_PATH + '.update_nickname')
+    @patch(MODULE_PATH + '.update_groups')
+    @patch(MODULE_PATH + '.update_username')
+    def test_can_update_all_incl_nicknames(
+        self, mock_update_usernames, mock_update_groups, mock_update_nickname
+    ):
+        du_1 = DiscordUser.objects.create(user=self.user_1, uid=123)
+        du_2 = DiscordUser.objects.create(user=self.user_2, uid=456)
+        du_3 = DiscordUser.objects.create(user=self.user_3, uid=789)
+
+        tasks.update_all()
+        self.assertEqual(mock_update_groups.si.call_count, 3)        
+        current_pks = [args[0][0] for args in mock_update_groups.si.call_args_list]
+        expected_pks = [du_1.pk, du_2.pk, du_3.pk]
+        self.assertSetEqual(set(current_pks), set(expected_pks))
+
+        self.assertEqual(mock_update_nickname.si.call_count, 3)
+        current_pks = [args[0][0] for args in mock_update_nickname.si.call_args_list]
+        expected_pks = [du_1.pk, du_2.pk, du_3.pk]
+        self.assertSetEqual(set(current_pks), set(expected_pks))
+
+        self.assertEqual(mock_update_usernames.si.call_count, 3)        
+        current_pks = [args[0][0] for args in mock_update_usernames.si.call_args_list]
+        expected_pks = [du_1.pk, du_2.pk, du_3.pk]
+        self.assertSetEqual(set(current_pks), set(expected_pks))
+
+    @patch(MODULE_PATH + '.DISCORD_SYNC_NAMES', False)
+    @patch(MODULE_PATH + '.update_nickname')
+    @patch(MODULE_PATH + '.update_groups')
+    @patch(MODULE_PATH + '.update_username')
+    def test_can_update_all_excl_nicknames(
+        self, mock_update_usernames, mock_update_groups, mock_update_nickname
+    ):
+        du_1 = DiscordUser.objects.create(user=self.user_1, uid=123)
+        du_2 = DiscordUser.objects.create(user=self.user_2, uid=456)
+        du_3 = DiscordUser.objects.create(user=self.user_3, uid=789)
+
+        tasks.update_all()
+        self.assertEqual(mock_update_groups.si.call_count, 3)        
+        current_pks = [args[0][0] for args in mock_update_groups.si.call_args_list]
+        expected_pks = [du_1.pk, du_2.pk, du_3.pk]
+        self.assertSetEqual(set(current_pks), set(expected_pks))
+
+        self.assertEqual(mock_update_nickname.si.call_count, 0)
+
+        self.assertEqual(mock_update_usernames.si.call_count, 3)        
+        current_pks = [args[0][0] for args in mock_update_usernames.si.call_args_list]
+        expected_pks = [du_1.pk, du_2.pk, du_3.pk]
+        self.assertSetEqual(set(current_pks), set(expected_pks))

allianceauth/services/modules/discord/tests/test_utils.py

@@ -0,0 +1,102 @@
+from unittest.mock import Mock, patch
+from django.test import TestCase
+
+from ..utils import clean_setting
+
+MODULE_PATH = 'allianceauth.services.modules.discord.utils'
+
+
+class TestCleanSetting(TestCase):
+
+    @patch(MODULE_PATH + '.settings')
+    def test_default_if_not_set(self, mock_settings):        
+        mock_settings.TEST_SETTING_DUMMY = Mock(spec=None)
+        result = clean_setting(
+            'TEST_SETTING_DUMMY',             
+            False,             
+        )
+        self.assertEqual(result, False)
+
+    @patch(MODULE_PATH + '.settings')
+    def test_default_if_not_set_for_none(self, mock_settings):        
+        mock_settings.TEST_SETTING_DUMMY = Mock(spec=None)
+        result = clean_setting(
+            'TEST_SETTING_DUMMY',             
+            None,
+            required_type=int
+        )
+        self.assertEqual(result, None)
+
+    @patch(MODULE_PATH + '.settings')
+    def test_true_stays_true(self, mock_settings):
+        mock_settings.TEST_SETTING_DUMMY = True
+        result = clean_setting(
+            'TEST_SETTING_DUMMY',             
+            False,         
+        )
+        self.assertEqual(result, True)
+
+    @patch(MODULE_PATH + '.settings')
+    def test_false_stays_false(self, mock_settings):
+        mock_settings.TEST_SETTING_DUMMY = False
+        result = clean_setting(
+            'TEST_SETTING_DUMMY',             
+            False
+        )
+        self.assertEqual(result, False)
+
+    @patch(MODULE_PATH + '.settings')
+    def test_default_for_invalid_type_bool(self, mock_settings):
+        mock_settings.TEST_SETTING_DUMMY = 'invalid type'
+        result = clean_setting(
+            'TEST_SETTING_DUMMY',             
+            False
+        )
+        self.assertEqual(result, False)
+
+    @patch(MODULE_PATH + '.settings')
+    def test_default_for_invalid_type_int(self, mock_settings):
+        mock_settings.TEST_SETTING_DUMMY = 'invalid type'
+        result = clean_setting(
+            'TEST_SETTING_DUMMY',             
+            50
+        )
+        self.assertEqual(result, 50)
+
+    @patch(MODULE_PATH + '.settings')
+    def test_default_if_below_minimum_1(self, mock_settings):
+        mock_settings.TEST_SETTING_DUMMY = -5
+        result = clean_setting(
+            'TEST_SETTING_DUMMY',             
+            default_value=50
+        )
+        self.assertEqual(result, 50)
+
+    @patch(MODULE_PATH + '.settings')
+    def test_default_if_below_minimum_2(self, mock_settings):
+        mock_settings.TEST_SETTING_DUMMY = -50
+        result = clean_setting(
+            'TEST_SETTING_DUMMY',             
+            default_value=50,
+            min_value=-10
+        )
+        self.assertEqual(result, 50)
+
+    @patch(MODULE_PATH + '.settings')
+    def test_default_for_invalid_type_int_2(self, mock_settings):
+        mock_settings.TEST_SETTING_DUMMY = 1000
+        result = clean_setting(
+            'TEST_SETTING_DUMMY',             
+            default_value=50,
+            max_value=100
+        )
+        self.assertEqual(result, 50)
+
+    @patch(MODULE_PATH + '.settings')
+    def test_default_is_none_needs_required_type(self, mock_settings):
+        mock_settings.TEST_SETTING_DUMMY = 'invalid type'
+        with self.assertRaises(ValueError):
+            clean_setting(
+                'TEST_SETTING_DUMMY',             
+                default_value=None
+            )

allianceauth/services/modules/discord/tests/test_views.py

@@ -1,71 +1,168 @@
-from django_webtest import WebTest
+from unittest.mock import patch
-from unittest import mock
 
-from django.test import TestCase
 from django.contrib.auth.models import User
-from django.core.exceptions import ObjectDoesNotExist
+from django.test import TestCase, RequestFactory
-from django.conf import settings
+from django.urls import reverse
+
 from allianceauth.tests.auth_utils import AuthUtils
 
+from . import MODULE_PATH, add_permissions_to_members, TEST_USER_NAME, TEST_USER_ID
+from ..discord_client import DiscordClient
 from ..models import DiscordUser
-from ..manager import DiscordOAuthManager
+from ..utils import set_logger_to_file
-
+from ..views import (
-from . import DEFAULT_AUTH_GROUP, add_permissions, MODULE_PATH
+    discord_callback, 
+    reset_discord, 
+    deactivate_discord, 
+    discord_add_bot, 
+    activate_discord
+)
 
 
-class DiscordViewsTestCase(WebTest):
+logger = set_logger_to_file(MODULE_PATH + '.views', __file__)
+
+
+class SetupClassMixin(TestCase):
+
+    @classmethod
+    def setUpClass(cls):
+        super().setUpClass()
+        cls.factory = RequestFactory()
+        cls.user = AuthUtils.create_member(TEST_USER_NAME)
+        add_permissions_to_members()
+        cls.services_url = reverse('services:services')
+
+
+class TestActivateDiscord(SetupClassMixin, TestCase):
+
+    @patch(MODULE_PATH + '.views.DiscordUser.objects.generate_oauth_redirect_url')
+    def test_redirects_to_correct_url(self, mock_generate_oauth_redirect_url):
+        expected_url = '/example.com/oauth/'
+        mock_generate_oauth_redirect_url.return_value = expected_url
+        request = self.factory.get(reverse('discord:activate'))
+        request.user = self.user
+        response = activate_discord(request)
+        self.assertEqual(response.status_code, 302)
+        self.assertEqual(response.url, expected_url)
+
+
+@patch(MODULE_PATH + '.views.messages')
+@patch(MODULE_PATH + '.managers.DiscordClient', spec=DiscordClient)
+class TestDeactivateDiscord(SetupClassMixin, TestCase):
+    
     def setUp(self):
-        self.member = AuthUtils.create_member('auth_member')
+        DiscordUser.objects.create(user=self.user, uid=TEST_USER_ID)
-        AuthUtils.add_main_character(self.member, 'test character', '1234', '2345', 'test corp', 'testc')
-        add_permissions()
     
-    def login(self):
+    def test_when_successful_show_success_message(
-        self.app.set_user(self.member)
+        self, mock_DiscordClient, mock_messages
+    ):
+        mock_DiscordClient.return_value.remove_guild_member.return_value = True
+        request = self.factory.get(reverse('discord:deactivate'))
+        request.user = self.user
+        response = deactivate_discord(request)
+        self.assertEqual(response.status_code, 302)
+        self.assertEqual(response.url, self.services_url)
+        self.assertTrue(mock_messages.success.called)
+        self.assertFalse(mock_messages.error.called)
 
-    @mock.patch(MODULE_PATH + '.views.DiscordOAuthManager')
+    def test_when_unsuccessful_show_error_message(
-    def test_activate(self, manager):
+        self, mock_DiscordClient, mock_messages
-        self.login()
+    ):
-        manager.generate_oauth_redirect_url.return_value = '/example.com/oauth/'
+        mock_DiscordClient.return_value.remove_guild_member.return_value = False
-        response = self.app.get('/discord/activate/', auto_follow=False)
+        request = self.factory.get(reverse('discord:deactivate'))
-        self.assertRedirects(
+        request.user = self.user
-            response,
+        response = deactivate_discord(request)
-            expected_url="/example.com/oauth/",
+        self.assertEqual(response.status_code, 302)
-            target_status_code=404,
+        self.assertEqual(response.url, self.services_url)
-            fetch_redirect_response=False,
+        self.assertFalse(mock_messages.success.called)
+        self.assertTrue(mock_messages.error.called)
+
+
+@patch(MODULE_PATH + '.views.messages')
+@patch(MODULE_PATH + '.managers.DiscordClient')
+class TestResetDiscord(SetupClassMixin, TestCase):
+    
+    def setUp(self):
+        DiscordUser.objects.create(user=self.user, uid=TEST_USER_ID)
+
+    def test_when_successful_redirect_to_activate(
+        self, mock_DiscordClient, mock_messages
+    ):
+        mock_DiscordClient.return_value.remove_guild_member.return_value = True
+        request = self.factory.get(reverse('discord:reset'))
+        request.user = self.user
+        response = reset_discord(request)
+        self.assertEqual(response.status_code, 302)
+        self.assertEqual(response.url, reverse("discord:activate"))        
+        self.assertFalse(mock_messages.error.called)
+
+    def test_when_unsuccessful_message_error_and_redirect_to_service(
+        self, mock_DiscordClient, mock_messages
+    ):
+        mock_DiscordClient.return_value.remove_guild_member.return_value = False
+        request = self.factory.get(reverse('discord:reset'))
+        request.user = self.user
+        response = reset_discord(request)
+        self.assertEqual(response.status_code, 302)
+        self.assertEqual(response.url, self.services_url)
+        self.assertTrue(mock_messages.error.called)
+
+
+@patch(MODULE_PATH + '.views.messages')
+@patch(MODULE_PATH + '.views.DiscordUser.objects.add_user')
+class TestDiscordCallback(SetupClassMixin, TestCase):
+    
+    def setUp(self):
+        DiscordUser.objects.create(user=self.user, uid=TEST_USER_ID)
+
+    def test_success_message_when_ok(self, mock_add_user, mock_messages):
+        mock_add_user.return_value = True
+        request = self.factory.get(
+            reverse('discord:callback'), data={'code': '1234'}
         )
+        request.user = self.user
+        response = discord_callback(request)
+        self.assertEqual(response.status_code, 302)
+        self.assertEqual(response.url, self.services_url)
+        self.assertTrue(mock_messages.success.called)
+        self.assertFalse(mock_messages.error.called)
     
-    @mock.patch(MODULE_PATH + '.tasks.DiscordOAuthManager')
+    def test_handle_no_code(self, mock_add_user, mock_messages):
-    def test_callback(self, manager):
+        mock_add_user.return_value = True
-        self.login()
+        request = self.factory.get(
-        manager.add_user.return_value = '1234'
+            reverse('discord:callback'), data={}
-        response = self.app.get('/discord/callback/', params={'code': '1234'})
+        )
+        request.user = self.user
+        response = discord_callback(request)
+        self.assertEqual(response.status_code, 302)
+        self.assertEqual(response.url, self.services_url)
+        self.assertFalse(mock_messages.success.called)
+        self.assertTrue(mock_messages.error.called)
     
-        self.member = User.objects.get(pk=self.member.pk)
+    def test_error_message_when_user_creation_failed(
+        self, mock_add_user, mock_messages
+    ):
+        mock_add_user.return_value = False
+        request = self.factory.get(
+            reverse('discord:callback'), data={'code': '1234'}
+        )
+        request.user = self.user
+        response = discord_callback(request)
+        self.assertEqual(response.status_code, 302)
+        self.assertEqual(response.url, self.services_url)
+        self.assertFalse(mock_messages.success.called)
+        self.assertTrue(mock_messages.error.called)
 
-        self.assertTrue(manager.add_user.called)
-        self.assertEqual(manager.update_nickname.called, settings.DISCORD_SYNC_NAMES)
-        self.assertEqual(self.member.discord.uid, '1234')
-        self.assertRedirects(response, expected_url='/services/', target_status_code=200)
 
-    @mock.patch(MODULE_PATH + '.tasks.DiscordOAuthManager')
+@patch(MODULE_PATH + '.views.DiscordUser.objects.generate_bot_add_url')
-    def test_reset(self, manager):
+class TestDiscordAddBot(TestCase):
-        self.login()
-        DiscordUser.objects.create(user=self.member, uid='12345')
-        manager.delete_user.return_value = True
     
-        response = self.app.get('/discord/reset/')
+    def test_add_bot(self, mock_generate_bot_add_url):
-
+        bot_url = 'https://www.example.com/bot'
-        self.assertRedirects(response, expected_url='/discord/activate/', target_status_code=302)
+        mock_generate_bot_add_url.return_value = bot_url
-
+        my_user = User.objects.create_superuser('Lex Luthor', 'abc', 'def')
-    @mock.patch(MODULE_PATH + '.tasks.DiscordOAuthManager')
+        request = RequestFactory().get(reverse('discord:add_bot'))
-    def test_deactivate(self, manager):
+        request.user = my_user
-        self.login()
+        response = discord_add_bot(request)
-        DiscordUser.objects.create(user=self.member, uid='12345')
+        self.assertEqual(response.status_code, 302)
-        manager.delete_user.return_value = True
+        self.assertEqual(response.url, bot_url)
-
-        response = self.app.get('/discord/deactivate/')
-
-        self.assertTrue(manager.delete_user.called)
-        self.assertRedirects(response, expected_url='/services/', target_status_code=200)
-        with self.assertRaises(ObjectDoesNotExist):
-            discord_user = User.objects.get(pk=self.member.pk).discord

allianceauth/services/modules/discord/utils.py

@@ -0,0 +1,89 @@
+import logging
+import os
+
+from django.conf import settings
+
+
+logger = logging.getLogger(__name__)
+
+
+class LoggerAddTag(logging.LoggerAdapter):
+    """add custom tag to a logger"""
+    def __init__(self, logger, prefix):
+        super(LoggerAddTag, self).__init__(logger, {})
+        self.prefix = prefix
+
+    def process(self, msg, kwargs):
+        return '[%s] %s' % (self.prefix, msg), kwargs
+        
+
+def clean_setting(
+    name: str,
+    default_value: object,
+    min_value: int = None,
+    max_value: int = None,
+    required_type: type = None
+):
+    """cleans the input for a custom setting
+
+    Will use `default_value` if settings does not exit or has the wrong type
+    or is outside define boundaries (for int only)
+
+    Need to define `required_type` if `default_value` is `None`
+
+    Will assume `min_value` of 0 for int (can be overriden)
+
+    Returns cleaned value for setting
+    """
+    if default_value is None and not required_type:
+        raise ValueError('You must specify a required_type for None defaults')
+
+    if not required_type:
+        required_type = type(default_value)
+
+    if min_value is None and required_type == int:
+        min_value = 0
+
+    if not hasattr(settings, name):
+        cleaned_value = default_value
+    else:
+        if (
+            isinstance(getattr(settings, name), required_type)
+            and (min_value is None or getattr(settings, name) >= min_value)
+            and (max_value is None or getattr(settings, name) <= max_value)
+        ):
+            cleaned_value = getattr(settings, name)
+        else:
+            logger.warning(
+                'You setting for %s it not valid. Please correct it. '
+                'Using default for now: %s',
+                name,
+                default_value                
+            )
+            cleaned_value = default_value
+    return cleaned_value
+
+
+def set_logger_to_file(logger_name: str, name: str) -> object:
+    """set logger for current module to log into a file. Useful for tests.
+    
+    Args:
+    - logger: current logger object
+    - name: name of current module, e.g. __file__
+    
+    Returns:
+    - amended logger
+    """
+    
+    # reconfigure logger so we get logging from tested module
+    f_format = logging.Formatter(
+        '%(asctime)s - %(levelname)s - %(module)s:%(funcName)s - %(message)s'
+    )
+    path = os.path.splitext(name)[0]
+    f_handler = logging.FileHandler('{}.log'.format(path), 'w+')
+    f_handler.setFormatter(f_format)
+    logger = logging.getLogger(logger_name)
+    logger.level = logging.DEBUG
+    logger.addHandler(f_handler)
+    logger.propagate = False
+    return logger

allianceauth/services/modules/discord/views.py

@@ -9,10 +9,12 @@ from django.utils.translation import gettext_lazy as _
 
 from allianceauth.services.views import superuser_test
 
-from .manager import DiscordOAuthManager
+from . import __title__
-from .tasks import DiscordTasks
+from .models import DiscordUser
+from .utils import LoggerAddTag
 
-logger = logging.getLogger(__name__)
+
+logger = LoggerAddTag(logging.getLogger(__name__), __title__)
 
 ACCESS_PERM = 'discord.access_discord'
 
@@ -20,53 +22,98 @@ ACCESS_PERM = 'discord.access_discord'
 @login_required
 @permission_required(ACCESS_PERM)
 def deactivate_discord(request):
-    logger.debug("deactivate_discord called by user %s" % request.user)
+    logger.debug("deactivate_discord called by user %s", request.user)
-    if DiscordTasks.delete_user(request.user):
+    if request.user.discord.delete_user(
-        logger.info("Successfully deactivated discord for user %s" % request.user)
+        is_rate_limited=False, handle_api_exceptions=True
+    ):
+        logger.info("Successfully deactivated discord for user %s", request.user)
         messages.success(request, _('Deactivated Discord account.'))
     else:
-        logger.error("Unsuccessful attempt to deactivate discord for user %s" % request.user)
+        logger.error(
-        messages.error(request, _('An error occurred while processing your Discord account.'))
+            "Unsuccessful attempt to deactivate discord for user %s", request.user
+        )
+        messages.error(
+            request, _('An error occurred while processing your Discord account.')
+        )
     return redirect("services:services")
 
 
 @login_required
 @permission_required(ACCESS_PERM)
 def reset_discord(request):
-    logger.debug("reset_discord called by user %s" % request.user)
+    logger.debug("reset_discord called by user %s", request.user)
-    if DiscordTasks.delete_user(request.user):
+    if request.user.discord.delete_user(
-        logger.info("Successfully deleted discord user for user %s - forwarding to discord activation." % request.user)
+        is_rate_limited=False, handle_api_exceptions=True
+    ):
+        logger.info(
+            "Successfully deleted discord user for user %s - "
+            "forwarding to discord activation.", 
+            request.user
+        )
         return redirect("discord:activate")
-    logger.error("Unsuccessful attempt to reset discord for user %s" % request.user)
+    
-    messages.error(request, _('An error occurred while processing your Discord account.'))
+    logger.error(
+        "Unsuccessful attempt to reset discord for user %s", request.user
+    )
+    messages.error(
+        request, _('An error occurred while processing your Discord account.')
+    )
     return redirect("services:services")
 
 
 @login_required
 @permission_required(ACCESS_PERM)
 def activate_discord(request):
-    logger.debug("activate_discord called by user %s" % request.user)
+    logger.debug("activate_discord called by user %s", request.user)
-    return redirect(DiscordOAuthManager.generate_oauth_redirect_url())
+    return redirect(DiscordUser.objects.generate_oauth_redirect_url())
 
 
 @login_required
 @permission_required(ACCESS_PERM)
 def discord_callback(request):
-    logger.debug("Received Discord callback for activation of user %s" % request.user)
+    logger.debug(
-    code = request.GET.get('code', None)
+        "Received Discord callback for activation of user %s", request.user
-    if not code:
+    )
-        logger.warn("Did not receive OAuth code from callback of user %s" % request.user)
+    authorization_code = request.GET.get('code', None)    
-        return redirect("services:services")
+    if not authorization_code:
-    if DiscordTasks.add_user(request.user, code):
+        logger.warning(
-        logger.info("Successfully activated Discord for user %s" % request.user)
+            "Did not receive OAuth code from callback for user %s", request.user
-        messages.success(request, _('Activated Discord account.'))
+        )
+        success = False
     else:
-        logger.error("Failed to activate Discord for user %s" % request.user)
+        if DiscordUser.objects.add_user(
-        messages.error(request, _('An error occurred while processing your Discord account.'))
+            user=request.user, 
+            authorization_code=authorization_code, 
+            is_rate_limited=False
+        ):
+            logger.info(
+                "Successfully activated Discord account for user %s", request.user
+            )
+            success = True
+            
+        else:
+            logger.error(
+                "Failed to activate Discord account for user %s", request.user
+            )
+            success = False
+        
+    if success:
+        messages.success(
+            request, _('Your Discord account has been successfully activated.')
+        )
+    else:
+        messages.error(
+            request, 
+            _(
+                'An error occurred while trying to activate your Discord account. '
+                'Please try again.'
+            )
+        )
+    
     return redirect("services:services")
 
 
 @login_required
 @user_passes_test(superuser_test)
 def discord_add_bot(request):
-    return redirect(DiscordOAuthManager.generate_bot_add_url())
+    return redirect(DiscordUser.objects.generate_bot_add_url())

allianceauth/services/modules/discourse/manager.py

@@ -168,7 +168,7 @@ class DiscourseManager:
         for arg in kwargs:
             if arg not in endpoint['args']['required'] and arg not in endpoint['args']['optional'] and not silent:
                 logger.warn("Received unrecognized kwarg %s for endpoint %s" % (arg, endpoint))
-        r = getattr(requests, endpoint['method'])(settings.DISCOURSE_URL + endpoint['parsed_url'], params=params,
+        r = getattr(requests, endpoint['method'])(settings.DISCOURSE_URL + endpoint['parsed_url'], headers=params,
                                                   json=data)
         try:
             if 'errors' in r.json() and not silent:

allianceauth/services/modules/mumble/migrations/0010_mumbleuser_certhash.py

@@ -0,0 +1,18 @@
+# Generated by Django 2.2.11 on 2020-05-22 13:02
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('mumble', '0009_set_mumble_dissplay_names'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='mumbleuser',
+            name='certhash',
+            field=models.CharField(blank=True, editable=False, help_text='Hash of Mumble client certificate as presented when user authenticates', max_length=254, null=True, verbose_name='Certificate Hash'),
+        ),
+    ]

allianceauth/services/modules/mumble/models.py

@@ -66,11 +66,18 @@ class MumbleUser(AbstractServiceModel):
     pwhash = models.CharField(max_length=80)
     hashfn = models.CharField(max_length=20, default='sha1')
     groups = models.TextField(blank=True, null=True)
+    certhash = models.CharField(
+        verbose_name="Certificate Hash",
+        max_length=254,
+        blank=True,
+        null=True,
+        editable=False,
+        help_text="Hash of Mumble client certificate as presented when user authenticates"
+    )
+    display_name = models.CharField(max_length=254, unique=True)
 
     objects = MumbleManager()
 
-    display_name = models.CharField(max_length=254, unique=True)
-
     def __str__(self):
         return self.username
 

allianceauth/services/modules/openfire/auth_hooks.py

@@ -76,7 +76,7 @@ class JabberBroadcast(MenuItemHook):
     def __init__(self):
         MenuItemHook.__init__(self,
                               _('Jabber Broadcast'),
-                              'fa fa-lock fa-fw fa-bullhorn',
+                              'fas fa-bullhorn fa-fw',
                               'openfire:broadcast')
 
     def render(self, request):
@@ -89,7 +89,7 @@ class FleetBroadcastFormatter(MenuItemHook):
     def __init__(self):
         MenuItemHook.__init__(self,
                               _('Fleet Broadcast Formatter'),
-                              'fa fa-lock fa-fw fa-space-shuttle',
+                              'fas fa-space-shuttle fa-fw',
                               'services:fleet_format_tool')
 
     def render(self, request):

allianceauth/srp/auth_hooks.py

@@ -7,7 +7,7 @@ from . import urls
 class SrpMenu(MenuItemHook):
     def __init__(self):
         MenuItemHook.__init__(self, _('Ship Replacement'),
-                              'fa fa-money fa-fw',
+                              'far fa-money-bill-alt fa-fw',
                               'srp:management',
                               navactive=['srp:'])