Version Bump 2.7.2

Improve page load performance by replacing groups context manager

See merge request allianceauth/allianceauth!1219

.gitignore

@@ -69,3 +69,11 @@ celerybeat-schedule
 
 #gitlab configs
 .gitlab/
+
+#transifex
+.tx/
+
+#other
+.flake8
+.pylintrc
+Makefile

.gitlab-ci.yml

@@ -1,16 +1,14 @@
 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
 
-test-3.5-core:
-  image: python:3.5-buster
-  script:  
-  - tox -e py35-core
-
 test-3.6-core:
   image: python:3.6-buster
   script:  
@@ -26,11 +24,6 @@ test-3.8-core:
   script:  
   - tox -e py38-core
 
-test-3.5-all:
-  image: python:3.5-buster
-  script:  
-  - tox -e py35-all
-
 test-3.6-all:
   image: python:3.6-buster
   script:  
@@ -57,5 +50,5 @@ deploy_production:
     - python setup.py sdist
     - twine upload dist/*
 
-  only:
-    - tags
+  rules:
+    - if: $CI_COMMIT_TAG

.readthedocs.yml

@@ -0,0 +1,27 @@
+# .readthedocs.yml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# Build documentation with MkDocs
+#mkdocs:
+#  configuration: mkdocs.yml
+
+# Optionally build your docs in additional formats such as PDF and ePub
+formats: all
+
+# Optionally set the version of Python and requirements required to build your docs
+python:
+   version: 3.7
+   install:      
+      - method: pip
+        path: .        
+        extra_requirements:
+           - testing
+   system_packages: true

README.md

@@ -11,32 +11,34 @@
 
 An auth system for EVE Online to help in-game organizations manage online service access.
 
-## Contens
+## Content
 
 - [Overview](#overview)
 - [Documentation](http://allianceauth.rtfd.io)
 - [Support](#support)
 - [Release Notes](https://gitlab.com/allianceauth/allianceauth/-/releases)
-- [Devloper Team](#developer-team)
+- [Developer Team](#developer-team)
 - [Contributing](#contributing)
 
 ## Overview
 
-Alliance Auth (AA) is a web application that helps Eve Online organizations efficiently manage access to their applications and services.
+Alliance Auth (AA) is a web site that helps Eve Online organizations efficiently manage access to applications and services.
 
 Main features:
 
-- Automatically grants or revokes user access to external applications / services (e.g. Discord, Mumble) and web apps (e.g. SRP requests) based on the user's current membership to [in-game organizations](https://allianceauth.readthedocs.io/en/latest/features/states/) and [groups](https://allianceauth.readthedocs.io/en/latest/features/groups/)
+- Automatically grants or revokes user access to external services (e.g. Discord, Mumble) and web apps (e.g. SRP requests) based on the user's current membership to [in-game organizations](https://allianceauth.readthedocs.io/en/latest/features/core/states/) and [groups](https://allianceauth.readthedocs.io/en/latest/features/core/groups/)
 
 - Provides a central web site where users can directly access web apps (e.g. SRP requests, Fleet Schedule) and manage their access to external services and groups.
 
-- Includes a set of connectors (called ["services"](https://allianceauth.readthedocs.io/en/latest/installation/services/)) for integrating access management with many popular external applications / services like Discord, Mumble, Teamspeak 3, SMF and others
+- Includes a set of connectors (called ["services"](https://allianceauth.readthedocs.io/en/latest/features/services/)) for integrating access management with many popular external applications / services like Discord, Mumble, Teamspeak 3, SMF and others
 
-- Includes a set of web apps called ["plug-in apps"](https://allianceauth.readthedocs.io/en/latest/features/) which add many useful functions: fleet schedule, timer board, SRP request management, fleet activity tracker and character application management
+- Includes a set of web [apps](https://allianceauth.readthedocs.io/en/latest/features/apps/) which add many useful functions, e.g.: fleet schedule, timer board, SRP request management, fleet activity tracker
 
-- Can be easily extended with new services and plugin-apps. Many additional services and plugin-apps are provided by the community and can be found here: [Community Creations](https://gitlab.com/allianceauth/community-creations)
+- Can be easily extended with additional services and apps. Many are provided by the community and can be found here: [Community Creations](https://gitlab.com/allianceauth/community-creations)
 
-For further details about AA - including an installation guide and a full list of included services and plugin apps - please see the [offical documentation](http://allianceauth.rtfd.io).
+- Chinese :cn:, English :us:, German :de: and Spanish :es: localization
+
+For further details about AA - including an installation guide and a full list of included services and plugin apps - please see the [official documentation](http://allianceauth.rtfd.io).
 
 ## Screenshot
 

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.1'
-NAME = 'Alliance Auth v%s' % __version__
+__version__ = '2.7.2'
+__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?
-            service.update_groups(user)
+        if hasattr(service, 'update_groups_bulk'):
+            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?
-            service.sync_nickname(user)
+        if hasattr(service, 'sync_nicknames_bulk'):
+            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)
@@ -506,7 +512,7 @@ class BaseOwnershipAdmin(admin.ModelAdmin):
         'character',
     )
     search_fields = (
-        'user__user', 
+        'user__username', 
         'character__character_name', 
         'character__corporation_name', 
         'character__alliance_name'

allianceauth/authentication/templates/authentication/dashboard.html

@@ -94,12 +94,12 @@
             <div class="col-sm-6 text-center">
                 <div class="panel panel-success" style="height:100%">
                     <div class="panel-heading">
-                        <h3 class="panel-title">{% trans "Groups" %}</h3>
+                        <h3 class="panel-title">{% trans "Group Memberships" %}</h3>
                     </div>
                     <div class="panel-body">
                         <div style="height: 240px;overflow:-moz-scrollbars-vertical;overflow-y:auto;">
                             <table class="table table-aa">
-                                {% for group in user.groups.all %}
+                                {% for group in groups %}
                                     <tr>
                                         <td>{{ group.name }}</td>
                                     </tr>
@@ -128,34 +128,30 @@
                         </tr>
                     </thead>
                     <tbody>
-                        {% for ownership in request.user.character_ownerships.all %}
-                            {% with ownership.character as char %}
-                                <tr>
-                                    <td class="text-center"><img class="ra-avatar img-circle" src="{{ char.portrait_url_32 }}">
-                                    </td>
-                                    <td class="text-center">{{ char.character_name }}</td>
-                                    <td class="text-center">{{ char.corporation_name }}</td>
-                                    <td class="text-center">{{ char.alliance_name }}</td>
-                                </tr>
-                            {% endwith %}
+                        {% for char in characters %}                            
+                            <tr>
+                                <td class="text-center"><img class="ra-avatar img-circle" src="{{ char.portrait_url_32 }}">
+                                </td>
+                                <td class="text-center">{{ char.character_name }}</td>
+                                <td class="text-center">{{ char.corporation_name }}</td>
+                                <td class="text-center">{{ char.alliance_name }}</td>
+                            </tr>                        
                         {% endfor %}
                     </tbody>
                 </table>
                 <table class="table table-aa visible-xs-block" style="width: 100%">
                     <tbody>
-                        {% for ownership in request.user.character_ownerships.all %}
-                            {% with ownership.character as char %}
-                                <tr>
-                                    <td class="text-center" style="vertical-align: middle">
-                                        <img class="ra-avatar img-circle" src="{{ char.portrait_url_32 }}">
-                                    </td>
-                                    <td class="text-center" style="vertical-align: middle; width: 100%">
-                                        <strong>{{ char.character_name }}</strong><br>
-                                        {{ char.corporation_name }}<br>
-                                        {{ char.alliance_name|default:"" }}
-                                    </td> 
-                                </tr>
-                            {% endwith %}
+                        {% for char in characters %}                            
+                            <tr>
+                                <td class="text-center" style="vertical-align: middle">
+                                    <img class="ra-avatar img-circle" src="{{ char.portrait_url_32 }}">
+                                </td>
+                                <td class="text-center" style="vertical-align: middle; width: 100%">
+                                    <strong>{{ char.character_name }}</strong><br>
+                                    {{ char.corporation_name }}<br>
+                                    {{ char.alliance_name|default:"" }}
+                                </td> 
+                            </tr>
                         {% 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/templates/registration/password_reset_email.html

@@ -1,5 +1,5 @@
 {% load i18n %}{% autoescape off %}
-    {% blocktrans %}You're receiving this email because you requested a password reset for your
+    {% blocktrans trimmed %}You're receiving this email because you requested a password reset for your
         user account.{% endblocktrans %}
 
     {% trans "Please go to the following page and choose a new password:" %}

allianceauth/authentication/tests/__init__.py

@@ -2,10 +2,17 @@ from django.urls import reverse
 
 
 def get_admin_change_view_url(obj: object) -> str:
+    """returns URL to admin change view for given object"""
     return reverse(
         'admin:{}_{}_change'.format(
-            obj._meta.app_label,
-            type(obj).__name__.lower()
+            obj._meta.app_label, type(obj).__name__.lower()
         ),
         args=(obj.pk,)
+    )
+
+def get_admin_search_url(ModelClass: type) -> str:
+    """returns URL to search URL for model of given object"""
+    return '{}{}/'.format(
+        reverse('admin:app_list', args=(ModelClass._meta.app_label,)),
+        ModelClass.__name__.lower()
     )

allianceauth/authentication/tests/test_admin.py

@@ -1,4 +1,5 @@
-from unittest.mock import patch
+from urllib.parse import quote
+from unittest.mock import patch, MagicMock
 
 from django.conf import settings
 from django.contrib import admin
@@ -6,11 +7,13 @@ from django.contrib.admin.sites import AdminSite
 from django.contrib.auth.models import User as BaseUser, Group
 from django.test import TestCase, RequestFactory, Client
 
-from allianceauth.authentication.models import CharacterOwnership, State, \
-    OwnershipRecord
+from allianceauth.authentication.models import (
+    CharacterOwnership, State, OwnershipRecord
+)
 from allianceauth.eveonline.models import (
     EveCharacter, EveCorporationInfo, EveAllianceInfo
 )
+from allianceauth.services.hooks import ServicesHook
 from allianceauth.tests.auth_utils import AuthUtils
 
 from ..admin import (
@@ -26,9 +29,11 @@ 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
+from . import get_admin_change_view_url, get_admin_search_url
 
 if 'allianceauth.eveonline.autogroups' in settings.INSTALLED_APPS:
     _has_auto_groups = True
@@ -43,144 +48,158 @@ class MockRequest(object):
     def __init__(self, user=None):
         self.user = user
 
+class TestCaseWithTestData(TestCase):
 
-def create_test_data():        
-    # groups
-    group_1 = Group.objects.create(
-        name='Group 1'
-    )
-    group_2 = Group.objects.create(
-        name='Group 2'
-    )
-    
-    # user 1 - corp and alliance, normal user
-    character_1 = EveCharacter.objects.create(
-        character_id='1001',
-        character_name='Bruce Wayne',
-        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
-    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
-    )
-    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
-    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=''
-    )
-    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=user_3
-    )
-    user_3.is_superuser = True
-    user_3.save()
-    return user_1, user_2, user_3, group_1, group_2
-
-
-class TestCharacterOwnershipAdmin(TestCase):
-    
     @classmethod
     def setUpClass(cls):
-        super().setUpClass()        
-        cls.user_1, _, _, _, _ = create_test_data()
+        super().setUpClass()
+
+        for MyModel in [
+            EveAllianceInfo, EveCorporationInfo, EveCharacter, Group, User
+        ]:
+            MyModel.objects.all().delete()
+        
+        # groups
+        cls.group_1 = Group.objects.create(
+            name='Group 1'
+        )
+        cls.group_2 = Group.objects.create(
+            name='Group 2'
+        )
+
+        # user 1 - corp and alliance, normal user
+        character_1 = EveCharacter.objects.create(
+            character_id=1001,
+            character_name='Bruce Wayne',
+            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
+        )        
+        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):
+    User.objects.create_superuser(
+        username='superuser', password='secret', email='admin@example.com'
+    )
+    c = Client()
+    c.login(username='superuser', password='secret')    
+    return c.get(
+        '%s?q=%s' % (get_admin_search_url(ModelClass), quote(search_term))
+    )    
+
+
+class TestCharacterOwnershipAdmin(TestCaseWithTestData):
     
     def setUp(self):
         self.modeladmin = CharacterOwnershipAdmin(
@@ -197,13 +216,16 @@ class TestCharacterOwnershipAdmin(TestCase):
         response = c.get(get_admin_change_view_url(ownership))
         self.assertEqual(response.status_code, 200)
 
+    def test_search_works(self):
+        obj = CharacterOwnership.objects\
+            .filter(user=self.user_1)\
+            .first()
+        response = make_generic_search_request(type(obj), obj.user.username)
+        expected = 200
+        self.assertEqual(response.status_code, expected)
 
-class TestOwnershipRecordAdmin(TestCase):
-    
-    @classmethod
-    def setUpClass(cls):
-        super().setUpClass()        
-        cls.user_1, _, _, _, _ = create_test_data()
+
+class TestOwnershipRecordAdmin(TestCaseWithTestData):
     
     def setUp(self):
         self.modeladmin = OwnershipRecordAdmin(
@@ -222,14 +244,15 @@ class TestOwnershipRecordAdmin(TestCase):
         response = c.get(get_admin_change_view_url(ownership_record))
         self.assertEqual(response.status_code, 200)
 
+    def test_search_works(self):
+        obj = OwnershipRecord.objects.first()
+        response = make_generic_search_request(type(obj), obj.user.username)
+        expected = 200
+        self.assertEqual(response.status_code, expected)
 
-class TestStateAdmin(TestCase):
-    
-    @classmethod
-    def setUpClass(cls):
-        super().setUpClass()        
-        create_test_data()
-    
+
+class TestStateAdmin(TestCaseWithTestData):
+        
     def setUp(self):
         self.modeladmin = StateAdmin(
             model=User, admin_site=AdminSite()
@@ -250,14 +273,13 @@ class TestStateAdmin(TestCase):
         response = c.get(get_admin_change_view_url(member_state))
         self.assertEqual(response.status_code, 200)
 
+    def test_search_works(self):
+        obj = State.objects.first()
+        response = make_generic_search_request(type(obj), obj.name)
+        expected = 200
+        self.assertEqual(response.status_code, expected)
 
-class TestUserAdmin(TestCase):
-
-    @classmethod
-    def setUpClass(cls):
-        super().setUpClass()        
-        cls.user_1, cls.user_2, cls.user_3, cls.group_1, cls.group_2  = \
-            create_test_data()
+class TestUserAdmin(TestCaseWithTestData):
 
     def setUp(self):
         self.factory = RequestFactory()
@@ -488,8 +510,8 @@ class TestUserAdmin(TestCase):
         filters = changelist.get_filters(request)
         filterspec = filters[0][0]
         expected = [            
-            ('2002', 'Daily Planet'),
-            ('2001', 'Wayne Technologies'),
+            (2002, 'Daily Planet'),
+            (2001, 'Wayne Technologies'),
         ]
         self.assertEqual(filterspec.lookup_choices, expected)
 
@@ -518,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)
 
@@ -541,3 +563,73 @@ class TestUserAdmin(TestCase):
         c.login(username='superuser', password='secret')                
         response = c.get(get_admin_change_view_url(self.user_1))
         self.assertEqual(response.status_code, 200)
+
+    def test_search_works(self):
+        obj = User.objects.first()
+        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/authentication/urls.py

@@ -7,11 +7,21 @@ from . import views
 app_name = 'authentication'
 
 urlpatterns = [
-    url(r'^$', login_required(TemplateView.as_view(template_name='authentication/dashboard.html')),),
-    url(r'^account/login/$', TemplateView.as_view(template_name='public/login.html'), name='login'),
-    url(r'^account/characters/main/$', views.main_character_change, name='change_main_character'),
-    url(r'^account/characters/add/$', views.add_character, name='add_character'),
-    url(r'^help/$', login_required(TemplateView.as_view(template_name='allianceauth/help.html')), name='help'),
-    url(r'^dashboard/$',
-        login_required(TemplateView.as_view(template_name='authentication/dashboard.html')), name='dashboard'),
+    url(r'^$', views.index, name='index'),
+    url(
+        r'^account/login/$', 
+        TemplateView.as_view(template_name='public/login.html'), 
+        name='login'
+    ),
+    url(
+        r'^account/characters/main/$',
+        views.main_character_change,
+        name='change_main_character'
+    ),
+    url(
+        r'^account/characters/add/$', 
+        views.add_character, 
+        name='add_character'
+    ),   
+    url(r'^dashboard/$', views.dashboard, name='dashboard'),
 ]

allianceauth/authentication/views.py

@@ -7,20 +7,58 @@ from django.contrib.auth.decorators import login_required
 from django.contrib.auth.models import User
 from django.core import signing
 from django.urls import reverse
-from django.shortcuts import redirect
-from django.utils.translation import ugettext_lazy as _
+from django.shortcuts import redirect, render
+from django.utils.translation import gettext_lazy as _
+
+from allianceauth.eveonline.models import EveCharacter
 from esi.decorators import token_required
 from esi.models import Token
-from registration.backends.hmac.views import RegistrationView as BaseRegistrationView, \
-    ActivationView as BaseActivationView, REGISTRATION_SALT
+
+from registration.backends.hmac.views import (
+    RegistrationView as BaseRegistrationView, 
+    ActivationView as BaseActivationView, 
+    REGISTRATION_SALT
+)
 from registration.signals import user_registered
 
 from .models import CharacterOwnership
 from .forms import RegistrationForm
 
+if 'allianceauth.eveonline.autogroups' in settings.INSTALLED_APPS:
+    _has_auto_groups = True
+    from allianceauth.eveonline.autogroups.models import *
+else:
+    _has_auto_groups = False
+
+
 logger = logging.getLogger(__name__)
 
 
+@login_required
+def index(request):
+    return redirect('authentication:dashboard')
+
+
+@login_required
+def dashboard(request):
+    groups = request.user.groups.all()
+    if _has_auto_groups:
+        groups = groups\
+            .filter(managedalliancegroup__isnull=True)\
+            .filter(managedcorpgroup__isnull=True)
+    groups = groups.order_by('name')
+    characters = EveCharacter.objects\
+        .filter(character_ownership__user=request.user)\
+        .select_related()\
+        .order_by('character_name')
+        
+    context = {
+        'groups': groups,
+        'characters': characters
+    }
+    return render(request, 'authentication/dashboard.html', context)
+
+
 @login_required
 @token_required(scopes=settings.LOGIN_TOKEN_SCOPES)
 def main_character_change(request, token):
@@ -31,7 +69,10 @@ def main_character_change(request, token):
         if not CharacterOwnership.objects.filter(character__character_id=token.character_id).exists():
             co = CharacterOwnership.objects.create_by_token(token)
         else:
-            messages.error(request, 'Cannot change main character to %(char)s: character owned by a different account.' % ({'char': token.character_name}))
+            messages.error(
+                request, 
+                _('Cannot change main character to %(char)s: character owned by a different account.') % ({'char': token.character_name})
+            )
             co = None
     if co:
         request.user.profile.main_character = co.character

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.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.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.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')
-        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)
+        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.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.corp = EveCorporationInfo.objects.create(corporation_id='2', corporation_name='test corp', corporation_ticker='TEST', 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.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.corp = EveCorporationInfo.objects.create(corporation_id='2', corporation_name='test corp', corporation_ticker='TEST', member_count=1)
+        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.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_ALLIANCE = "alliance"
-ESI_CATEGORY_CHARACTER = "character"
-ESI_CATEGORY_CONSTELLATION = "constellation"
-ESI_CATEGORY_CORPORATION = "corporation"
-ESI_CATEGORY_FACTION = "faction"
-ESI_CATEGORY_INVENTORYTYPE = "inventory_type"
-ESI_CATEGORY_REGION = "region"
-ESI_CATEGORY_SOLARSYSTEM = "solar_system"
-ESI_CATEGORY_STATION = "station"
-ESI_CATEGORY_WORMHOLE = "wormhole"
+_ESI_CATEGORY_AGENT = "agent"
+_ESI_CATEGORY_ALLIANCE = "alliance"
+_ESI_CATEGORY_CHARACTER = "character"
+_ESI_CATEGORY_CONSTELLATION = "constellation"
+_ESI_CATEGORY_CORPORATION = "corporation"
+_ESI_CATEGORY_FACTION = "faction"
+_ESI_CATEGORY_INVENTORYTYPE = "inventory_type"
+_ESI_CATEGORY_REGION = "region"
+_ESI_CATEGORY_SOLARSYSTEM = "solar_system"
+_ESI_CATEGORY_STATION = "station"
+_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
 
-
-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
+_DEFAULT_IMAGE_SIZE = 32
 
 
 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(alliance=self).exclude(corporation_id__in=alliance.corp_ids).update(
-            alliance=None)
+        EveCorporationInfo.objects.filter(
+            corporation_id__in=alliance.corp_ids).update(alliance=self
+        )
+        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/tasks.py

@@ -7,6 +7,7 @@ from .models import EveCorporationInfo
 
 logger = logging.getLogger(__name__)
 
+TASK_PRIORITY = 7
 
 @shared_task
 def update_corp(corp_id):
@@ -27,11 +28,12 @@ def update_character(character_id):
 def run_model_update():
     # update existing corp models
     for corp in EveCorporationInfo.objects.all().values('corporation_id'):
-        update_corp.delay(corp['corporation_id'])
+        update_corp.apply_async(args=[corp['corporation_id']], priority=TASK_PRIORITY)
 
     # update existing alliance models
     for alliance in EveAllianceInfo.objects.all().values('alliance_id'):
-        update_alliance.delay(alliance['alliance_id'])
+        update_alliance.apply_async(args=[alliance['alliance_id']], priority=TASK_PRIORITY)
 
+    #update existing character models
     for character in EveCharacter.objects.all().values('character_id'):
-        update_character.delay(character['character_id'])
+        update_character.apply_async(args=[character['character_id']], priority=TASK_PRIORITY)

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', 
-                ticker='0BUGS'
+                alliance_id=3456, 
+                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', 
-            alliance_id='3456'
+            corp_id=2345, 
+            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',
-            alliance_id='character.alliance.id',
+            corporation_ticker='cc1',
+            alliance_id=34567,
             alliance_name='character.alliance.name',
         )
 
         expected = self.TestCharacter(
-            id='1234', 
+            id=1234, 
             name='Test Character', 
-            corp_id='2345', 
-            alliance_id='3456'
+            corp_id=2345, 
+            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',
-            alliance_id='character.alliance.id',
+            corporation_ticker='cc1',
+            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'], 
-            executor_corp_id='2345'
+            corp_ids=[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',
-            executor_corp_id='alliance.executor_corp_id',
+            alliance_ticker='at1',
+            executor_corp_id=2345,
         )
         expected = self.TestAlliance(
-            id='3456', 
+            id=3456, 
             name='Test Alliance', 
             ticker='TEST',
-            corp_ids=['2345'], 
-            executor_corp_id='2345'
+            corp_ids=[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'], 
-                executor_corp_id='2345'
+                corp_ids=[2345], 
+                executor_corp_id=2345
             )
 
         @property
         def ceo(self):
             return EveCharacterManagerTestCase.TestCharacter(
-                id='1234', 
+                id=1234, 
                 name='Test Character',
-                corp_id='2345', 
-                alliance_id='3456'
+                corp_id=2345, 
+                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',
-            executor_corp_id='alliance.executor_corp_id',
+            alliance_ticker='99bug',
+            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',
-            executor_corp_id='alliance.executor_corp_id',
+            alliance_ticker='at1',
+            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,130 +2,40 @@ from unittest.mock import Mock, patch
 
 from django.test import TestCase
 
-from ..models import EveCharacter, EveCorporationInfo, \
-    EveAllianceInfo, _eve_entity_image_url
+from ..models import (
+    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):
     def test_corporation_prop(self):
         """
         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',
-            alliance_id='character.alliance.id',
+            corporation_ticker='cc1',
+            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',
-            alliance_id='character.alliance.id',
+            corporation_ticker='cc1',
+            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',
-            alliance_id='3456',
+            corporation_ticker='cc1',
+            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',
-            executor_corp_id='alliance.executor_corp_id',
+            alliance_ticker='ac2',
+            executor_corp_id=2345,
         )
 
         incorrect = EveAllianceInfo.objects.create(
-            alliance_id='9001',
+            alliance_id=9001,
             alliance_name='alliance.name1',
-            alliance_ticker='alliance.ticker1',
-            executor_corp_id='alliance.executor_corp_id1',
+            alliance_ticker='ac1',
+            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',
-            alliance_id='3456',
+            corporation_ticker='cc1',
+            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(                
-                name='Dummy Alliance 2',
-                corp_ids=[2004],                
-                executor_corp_id=2004
-            )
+        Alliance(                
+            name='Dummy Alliance 2',
+            corp_ids=[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(
-            members=87
-        )
+        mock_provider.get_corporation.return_value = Corporation(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 ObjectNotFound, Entity, Character, Corporation, \
-    Alliance, ItemType, EveProvider, EveSwaggerProvider
+from ..providers import (
+    ObjectNotFound, 
+    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
@@ -253,7 +256,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')
@@ -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,
-            1
+            mock_EveCorporationInfo.objects.update_corporation.call_count, 1
         )
         self.assertEqual(
-            mock_EveCorporationInfo.objects.update_corporation.call_args[0][0], 
-            42
+            mock_EveCorporationInfo.objects.update_corporation.call_args[0][0], 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], 
-            42
+            mock_EveAllianceInfo.objects.update_alliance.call_args[0][0], 42
         )
         self.assertEqual(
-            mock_EveAllianceInfo.objects\
-                .update_alliance.return_value.populate_alliance.call_count, 
-            1
+            mock_EveAllianceInfo.objects
+            .update_alliance.return_value.populate_alliance.call_count, 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,
-            1
+            mock_EveCharacter.objects.update_character.call_count, 1
         )
         self.assertEqual(
-            mock_EveCharacter.objects.update_character.call_args[0][0], 
-            42
+            mock_EveCharacter.objects.update_character.call_args[0][0], 42
         )
 
-    
     @patch('allianceauth.eveonline.tasks.update_character')
     @patch('allianceauth.eveonline.tasks.update_alliance')
     @patch('allianceauth.eveonline.tasks.update_corp')
@@ -63,48 +58,41 @@ 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='character.corp.ticker',
-            alliance_id='character.alliance.id',
+            corporation_ticker='c.c.t',  # max 5 chars 
+            alliance_id=3456,
             alliance_name='character.alliance.name',
         )
 
         run_model_update()
 
-        self.assertEqual(mock_update_corp.delay.call_count, 1)
+        self.assertEqual(mock_update_corp.apply_async.call_count, 1)
         self.assertEqual(
-            int(mock_update_corp.delay.call_args[0][0]), 
-            2345
+            int(mock_update_corp.apply_async.call_args[1]['args'][0]), 2345
         )
         
-        self.assertEqual(mock_update_alliance.delay.call_count, 1)
+        self.assertEqual(mock_update_alliance.apply_async.call_count, 1)
         self.assertEqual(
-            int(mock_update_alliance.delay.call_args[0][0]), 
-            3456
+            int(mock_update_alliance.apply_async.call_args[1]['args'][0]), 3456
         )
         
-        self.assertEqual(mock_update_character.delay.call_count, 1)
+        self.assertEqual(mock_update_character.apply_async.call_count, 1)
         self.assertEqual(
-            int(mock_update_character.delay.call_args[0][0]), 
-            1234
+            int(mock_update_character.apply_async.call_args[1]['args'][0]), 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/fleetactivitytracking/templates/fleetactivitytracking/fatlinkpersonalmonthlystatisticsview.html

@@ -15,7 +15,13 @@
             </div>
             {% endif %}
         </h1>
-        <h2>{% blocktrans %}{{ user }} has collected {{ n_fats }} link{{ n_fats|pluralize }} this month.{% endblocktrans %}</h2>
+        <h2>
+            {% blocktrans count links=n_fats trimmed %}
+                {{ user }} has collected one link this month.
+            {% plural %}
+                {{ user }} has collected {{ links }} links this month.
+            {% endblocktrans %}
+        </h2>
         <table class="table table-responsive">
             <tr>
                 <th class="col-md-2 text-center">{% trans "Ship" %}</th>
@@ -29,7 +35,13 @@
             {% endfor %}
         </table>
         {%  if created_fats %}
-         <h2>{% blocktrans %}{{ user }} has created {{ n_created_fats }} link{{ n_created_fats|pluralize }} this month.{% endblocktrans %}</h2>
+        <h2>
+            {% blocktrans count links=n_created_fats trimmed  %}
+                {{ user }} has created one link this month.
+            {% plural %}
+                {{ user }} has created {{ links }} links this month.
+            {% endblocktrans %}
+        </h2>
         {% if created_fats %}
         <table class="table">
             <tr>

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/managers.py

@@ -1,27 +1,53 @@
-from django.contrib.auth.models import Group
-from django.db.models import Q
+import logging
+
+from django.contrib.auth.models import Group, User
+from django.db.models import Q, QuerySet
+
+from allianceauth.authentication.models import State
+
+
+logger = logging.getLogger(__name__)
 
 
 class GroupManager:
-    def __init__(self):
-        pass
+    
+    @classmethod
+    def get_joinable_groups_for_user(
+        cls, user: User, include_hidden = True
+    ) -> QuerySet:
+        """get groups a user could join incl. groups already joined"""
+        groups_qs = cls.get_joinable_groups(user.profile.state)
+
+        if not user.has_perm('groupmanagement.request_groups'):
+            groups_qs = groups_qs.filter(authgroup__public=True)
+        
+        if not include_hidden:
+            groups_qs = groups_qs.filter(authgroup__hidden=False)
+
+        return groups_qs
 
     @staticmethod
-    def get_joinable_groups(state):
-        return Group.objects.select_related('authgroup').exclude(authgroup__internal=True)\
+    def get_joinable_groups(state: State) -> QuerySet:
+        """get groups that can be joined by user with given state"""
+        return Group.objects\
+            .select_related('authgroup')\
+            .exclude(authgroup__internal=True)\
             .filter(Q(authgroup__states=state) | Q(authgroup__states=None))
 
     @staticmethod
-    def get_all_non_internal_groups():
-        return Group.objects.select_related('authgroup').exclude(authgroup__internal=True)
+    def get_all_non_internal_groups() -> QuerySet:
+        """get groups that are not internal"""
+        return Group.objects\
+            .select_related('authgroup')\
+            .exclude(authgroup__internal=True)
 
     @staticmethod
-    def get_group_leaders_groups(user):
+    def get_group_leaders_groups(user: User):
         return Group.objects.select_related('authgroup').filter(authgroup__group_leaders__in=[user]) | \
                Group.objects.select_related('authgroup').filter(authgroup__group_leader_groups__in=user.groups.all())
 
     @staticmethod
-    def joinable_group(group, state):
+    def joinable_group(group: Group, state: State) -> bool:
         """
         Check if a group is a user/state joinable group, i.e.
         not an internal group for Corp, Alliance, Members etc,
@@ -30,12 +56,15 @@ class GroupManager:
         :param state: allianceauth.authentication.State object
         :return: bool True if its joinable, False otherwise
         """
-        if len(group.authgroup.states.all()) != 0 and state not in group.authgroup.states.all():
+        if (len(group.authgroup.states.all()) != 0 
+            and state not in group.authgroup.states.all()
+        ):
             return False
-        return not group.authgroup.internal
+        else:
+            return not group.authgroup.internal
 
     @staticmethod
-    def check_internal_group(group):
+    def check_internal_group(group: Group) -> bool:
         """
         Check if a group is auditable, i.e not an internal group
         :param group: django.contrib.auth.models.Group object
@@ -44,20 +73,11 @@ class GroupManager:
         return not group.authgroup.internal
 
     @staticmethod
-    def check_internal_group(group):
-        """
-        Check if a group is auditable, i.e not an internal group
-        :param group: django.contrib.auth.models.Group object
-        :return: bool True if it is auditable, false otherwise
-        """
-        return not group.authgroup.internal
-
-    @staticmethod
-    def has_management_permission(user):
+    def has_management_permission(user: User) -> bool:
         return user.has_perm('auth.group_management')
 
     @classmethod
-    def can_manage_groups(cls, user):
+    def can_manage_groups(cls, user:User ) -> bool:
         """
         For use with user_passes_test decorator.
         Check if the user can manage groups. Either has the
@@ -71,7 +91,7 @@ class GroupManager:
         return False
 
     @classmethod
-    def can_manage_group(cls, user, group):
+    def can_manage_group(cls, user: User, group: Group) -> bool:
         """
         Check user has permission to manage the given group
         :param user: User object to test permission of
@@ -79,5 +99,5 @@ class GroupManager:
         :return: True if the user can manage the group
         """
         if user.is_authenticated:
-            return cls.has_management_permission(user) or user.leads_groups.filter(group=group).exists()
+            return cls.has_management_permission(user) or cls.get_group_leaders_groups(user).filter(pk=group.pk).exists()
         return False

allianceauth/groupmanagement/templates/groupmanagement/audit.html

@@ -15,7 +15,7 @@
             <div class="panel-body">            
                 <p> 
                     <a class="btn btn-default" href="{% url 'groupmanagement:membership' %}" role="button">
-                        Back
+                        {% trans "Back" %}
                     </a>
                 </p>              
                 {% if entries %}
@@ -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

@@ -17,7 +17,7 @@
             <div class="panel-body">                
                 <p>                    
                     <a class="btn btn-default" href="{% url 'groupmanagement:membership' %}" role="button">
-                        Back
+                        {% trans "Back" %}
                     </a>
                 </p>                
                 {% if group.user_set %}                    
@@ -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

@@ -11,7 +11,7 @@
         {% include 'groupmanagement/menu.html' %}
         <div class="panel panel-default">
             <div class="panel-heading">
-                Groups
+                {% trans "Groups" %}
             </div>
             <div class="panel-body">
                 {% if groups %}                    
@@ -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><a data-toggle="tab" href="#leave">{% trans "Leave Requests" %}</a></li>
+            <li class="active">
+                <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 (   
-   HasLeaderFilter,
-   GroupAdmin,   
-   Group
-)
+from ..admin import 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,
-                alliance_groups = True
+                corp_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, 
-                        managedcorpgroup__isnull=True
+                managedalliancegroup__isnull=True, 
+                managedcorpgroup__isnull=True
             )
             self.assertSetEqual(set(queryset), set(expected))
          
@@ -394,4 +390,4 @@ class TestGroupAdmin(TestCase):
         c = Client()
         c.login(username='superuser', password='secret')                
         response = c.get(get_admin_change_view_url(self.group_1))
-        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.status_code, 200)

allianceauth/groupmanagement/tests/test_all.py

@@ -1,92 +0,0 @@
-from unittest import mock
-
-from django.test import TestCase
-from allianceauth.tests.auth_utils import AuthUtils
-from allianceauth.eveonline.models import EveCorporationInfo, EveAllianceInfo, EveCharacter
-from django.contrib.auth.models import User, Group
-from allianceauth.groupmanagement.managers import GroupManager
-from allianceauth.groupmanagement.signals import check_groups_on_state_change
-
-class GroupManagementVisibilityTestCase(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')
-        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.corp = EveCorporationInfo.objects.create(corporation_id='2', corporation_name='test corp', corporation_ticker='TEST', alliance=cls.alliance, member_count=1)
-        cls.group1 = Group.objects.create(name='group1')
-        cls.group2 = Group.objects.create(name='group2')
-        cls.group3 = Group.objects.create(name='group3')
-
-    def setUp(self):
-        self.user.refresh_from_db()
-
-    def _refresh_user(self):
-        self.user = User.objects.get(pk=self.user.pk)
-
-
-    def test_can_manage_group(self):
-        
-
-        self.group1.authgroup.group_leaders.add(self.user)
-        self.group2.authgroup.group_leader_groups.add(self.group1)
-        self._refresh_user()
-        groups = GroupManager.get_group_leaders_groups(self.user)
-
-        self.assertIn(self.group1, groups) #avail due to user
-        self.assertNotIn(self.group2, groups) #not avail due to group
-        self.assertNotIn(self.group3, groups) #not avail at all 
-
-        self.user.groups.add(self.group1)
-        self._refresh_user()
-        groups = GroupManager.get_group_leaders_groups(self.user)
-
-        self.assertIn(self.group1, groups) #avail due to user
-        self.assertIn(self.group2, groups) #avail due to group1
-        self.assertNotIn(self.group3, groups) #not avail at all 
-
-class GroupManagementStateTestCase(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')
-        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.corp = EveCorporationInfo.objects.create(corporation_id='2', corporation_name='test corp', corporation_ticker='TEST', alliance=cls.alliance, member_count=1)
-        cls.state_group = Group.objects.create(name='state_group')
-        cls.open_group = Group.objects.create(name='open_group')
-        cls.state = AuthUtils.create_state('test state', 500)
-        cls.state_group.authgroup.states.add(cls.state)
-        cls.state_group.authgroup.internal = False
-        cls.state_group.save()
-
-    def setUp(self):
-        self.user.refresh_from_db()
-        self.state.refresh_from_db()
-
-    def _refresh_user(self):
-        self.user = User.objects.get(pk=self.user.pk)
-
-    def _refresh_test_group(self):
-        self.state_group = Group.objects.get(pk=self.state_group.pk)
-
-    def test_drop_state_group(self):
-
-        self.user.groups.add(self.open_group)
-        self.user.groups.add(self.state_group)     
-        self.assertEqual(self.user.profile.state.name, "Guest")
-
-        self.state.member_corporations.add(self.corp)
-        self._refresh_user()
-        self.assertEqual(self.user.profile.state, self.state)
-        groups = self.user.groups.all()
-        self.assertIn(self.state_group, groups) #keeps group
-        self.assertIn(self.open_group, groups) #public group unafected
-
-        self.state.member_corporations.clear()
-        self._refresh_user()
-        self.assertEqual(self.user.profile.state.name, "Guest")
-        groups = self.user.groups.all()
-        self.assertNotIn(self.state_group, groups) #looses group
-        self.assertIn(self.open_group, groups) #public group unafected

allianceauth/groupmanagement/tests/test_managers.py

@@ -0,0 +1,337 @@
+from unittest.mock import Mock, patch
+
+from django.contrib.auth.models import Group, User
+from django.test import TestCase
+from django.urls import reverse
+
+from allianceauth.eveonline.models import EveCorporationInfo, EveAllianceInfo
+from allianceauth.tests.auth_utils import AuthUtils
+
+from ..models import AuthGroup
+from ..managers import GroupManager
+
+
+class MockUserNotAuthenticated():
+    def __init__(self):
+        self.is_authenticated = False
+
+class GroupManagementVisibilityTestCase(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'
+        )
+        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.corp = EveCorporationInfo.objects.create(
+            corporation_id='2', corporation_name='test corp', corporation_ticker='TEST', alliance=cls.alliance, member_count=1
+        )
+        cls.group1 = Group.objects.create(name='group1')
+        cls.group2 = Group.objects.create(name='group2')
+        cls.group3 = Group.objects.create(name='group3')
+
+    def setUp(self):
+        self.user.refresh_from_db()
+
+    def _refresh_user(self):
+        self.user = User.objects.get(pk=self.user.pk)
+
+
+    def test_get_group_leaders_groups(self):
+        self.group1.authgroup.group_leaders.add(self.user)
+        self.group2.authgroup.group_leader_groups.add(self.group1)
+        self._refresh_user()
+        groups = GroupManager.get_group_leaders_groups(self.user)
+
+        self.assertIn(self.group1, groups) #avail due to user
+        self.assertNotIn(self.group2, groups) #not avail due to group
+        self.assertNotIn(self.group3, groups) #not avail at all 
+
+        self.user.groups.add(self.group1)
+        self._refresh_user()
+        groups = GroupManager.get_group_leaders_groups(self.user)
+
+
+    def test_can_manage_group(self):
+        self.group1.authgroup.group_leaders.add(self.user)
+        self.user.groups.add(self.group1)
+        self._refresh_user()
+
+        self.assertTrue(GroupManager.can_manage_group(self.user, self.group1))
+        self.assertFalse(GroupManager.can_manage_group(self.user, self.group2))
+        self.assertFalse(GroupManager.can_manage_group(self.user, self.group3))
+        
+        self.group2.authgroup.group_leader_groups.add(self.group1)
+        self.group1.authgroup.group_leaders.remove(self.user)
+        self._refresh_user()
+
+        self.assertFalse(GroupManager.can_manage_group(self.user, self.group1))
+        self.assertTrue(GroupManager.can_manage_group(self.user, self.group2))
+        self.assertFalse(GroupManager.can_manage_group(self.user, self.group3))
+
+
+class TestGroupManager(TestCase):
+        
+    @classmethod
+    def setUpClass(cls):
+        super().setUpClass()
+
+        # group 1
+        cls.group_default = Group.objects.create(name='default')        
+        cls.group_default.authgroup.description = 'Default Group'
+        cls.group_default.authgroup.internal = False
+        cls.group_default.authgroup.hidden = False
+        cls.group_default.authgroup.save()
+
+        # group 2
+        cls.group_internal = Group.objects.create(name='internal')
+        cls.group_internal.authgroup.description = 'Internal Group'
+        cls.group_internal.authgroup.internal = True        
+        cls.group_internal.authgroup.save()
+
+        # group 3
+        cls.group_hidden = Group.objects.create(name='hidden')
+        cls.group_hidden.authgroup.description = 'Hidden Group'
+        cls.group_hidden.authgroup.internal = False
+        cls.group_hidden.authgroup.hidden = True
+        cls.group_hidden.authgroup.save()
+
+        # group 4
+        cls.group_open = Group.objects.create(name='open')
+        cls.group_open.authgroup.description = 'Open Group'
+        cls.group_open.authgroup.internal = False
+        cls.group_open.authgroup.hidden = False
+        cls.group_open.authgroup.open = True
+        cls.group_open.authgroup.save()
+
+        # group 5
+        cls.group_public_1 = Group.objects.create(name='public 1')
+        cls.group_public_1.authgroup.description = 'Public Group 1'
+        cls.group_public_1.authgroup.internal = False
+        cls.group_public_1.authgroup.hidden = False
+        cls.group_public_1.authgroup.public = True
+        cls.group_public_1.authgroup.save()
+
+        # group 6
+        cls.group_public_2 = Group.objects.create(name='public 2')
+        cls.group_public_2.authgroup.description = 'Public Group 2'
+        cls.group_public_2.authgroup.internal = False
+        cls.group_public_2.authgroup.hidden = True
+        cls.group_public_2.authgroup.open = True
+        cls.group_public_2.authgroup.public = True
+        cls.group_public_2.authgroup.save()
+
+        # group 7
+        cls.group_default_member = Group.objects.create(name='default members')
+        cls.group_default_member.authgroup.description = \
+            'Default Group for members only'
+        cls.group_default_member.authgroup.internal = False
+        cls.group_default_member.authgroup.hidden = False
+        cls.group_default_member.authgroup.open = False
+        cls.group_default_member.authgroup.public = False
+        cls.group_default_member.authgroup.states.add(
+            AuthUtils.get_member_state()
+        )
+        cls.group_default_member.authgroup.save()
+    
+    def setUp(self):
+        self.user = AuthUtils.create_user('Bruce Wayne')
+
+    def test_get_joinable_group_member(self):        
+        result = GroupManager.get_joinable_groups(
+            AuthUtils.get_member_state()
+        )
+        expected = {
+            self.group_default, 
+            self.group_hidden, 
+            self.group_open, 
+            self.group_public_1, 
+            self.group_public_2,
+            self.group_default_member
+        }
+        self.assertSetEqual(set(result), expected)
+
+    def test_get_joinable_group_guest(self):
+        result = GroupManager.get_joinable_groups(
+            AuthUtils.get_guest_state()
+        )
+        expected = {
+            self.group_default, 
+            self.group_hidden, 
+            self.group_open, 
+            self.group_public_1, 
+            self.group_public_2
+        }
+        self.assertSetEqual(set(result), expected)
+
+    def test_joinable_group_member(self):
+        member_state = AuthUtils.get_member_state()
+        for x in [
+            self.group_default, 
+            self.group_hidden, 
+            self.group_open, 
+            self.group_public_1, 
+            self.group_public_2,
+            self.group_default_member
+        ]:
+            self.assertTrue(GroupManager.joinable_group(x, member_state))
+
+        for x in [
+            self.group_internal,             
+        ]:
+            self.assertFalse(GroupManager.joinable_group(x, member_state))
+
+
+    def test_joinable_group_guest(self):
+        guest_state = AuthUtils.get_guest_state()
+        for x in [
+            self.group_default, 
+            self.group_hidden, 
+            self.group_open, 
+            self.group_public_1, 
+            self.group_public_2
+        ]:
+            self.assertTrue(GroupManager.joinable_group(x, guest_state))
+
+        for x in [
+            self.group_internal,
+            self.group_default_member
+        ]:
+            self.assertFalse(GroupManager.joinable_group(x, guest_state))
+
+        
+    def test_get_all_non_internal_groups(self):
+        result = GroupManager.get_all_non_internal_groups()
+        expected = {
+            self.group_default, 
+            self.group_hidden, 
+            self.group_open, 
+            self.group_public_1, 
+            self.group_public_2, 
+            self.group_default_member
+        }
+        self.assertSetEqual(set(result), expected)
+
+    def test_check_internal_group(self):
+        self.assertTrue(
+            GroupManager.check_internal_group(self.group_default)
+        )
+        self.assertFalse(
+            GroupManager.check_internal_group(self.group_internal)
+        )
+
+    def test_get_joinable_groups_for_user_no_permission(self):
+        AuthUtils.assign_state(self.user, AuthUtils.get_guest_state())
+        result = GroupManager.get_joinable_groups_for_user(self.user)
+        expected= {self.group_public_1, self.group_public_2}
+        self.assertSetEqual(set(result), expected)
+
+    def test_get_joinable_groups_for_user_guest_w_permission_(self):
+        AuthUtils.assign_state(self.user, AuthUtils.get_guest_state())
+        AuthUtils.add_permission_to_user_by_name(
+            'groupmanagement.request_groups', self.user
+        )
+        result = GroupManager.get_joinable_groups_for_user(self.user)
+        expected = {
+            self.group_default, 
+            self.group_hidden, 
+            self.group_open, 
+            self.group_public_1, 
+            self.group_public_2
+        }
+        self.assertSetEqual(set(result), expected)
+
+    def test_get_joinable_groups_for_user_member_w_permission(self):
+        AuthUtils.assign_state(self.user, AuthUtils.get_member_state(), True)
+        AuthUtils.add_permission_to_user_by_name(
+            'groupmanagement.request_groups', self.user
+        )
+        result = GroupManager.get_joinable_groups_for_user(self.user)
+        expected = {
+            self.group_default,
+            self.group_hidden,
+            self.group_open,
+            self.group_public_1,
+            self.group_public_2,
+            self.group_default_member
+        }
+        self.assertSetEqual(set(result), expected)
+
+    def test_get_joinable_groups_for_user_member_w_permission_no_hidden(self):
+        AuthUtils.assign_state(self.user, AuthUtils.get_member_state(), True)
+        AuthUtils.add_permission_to_user_by_name(
+            'groupmanagement.request_groups', self.user
+        )
+        result = GroupManager.get_joinable_groups_for_user(
+            self.user, include_hidden=False
+        )
+        expected = {
+            self.group_default,
+            self.group_open, 
+            self.group_public_1,            
+            self.group_default_member
+        }
+        self.assertSetEqual(set(result), expected)
+
+    def test_has_management_permission(self):        
+        user = AuthUtils.create_user('Clark Kent')
+        AuthUtils.add_permission_to_user_by_name(
+            'auth.group_management', user
+        )        
+        self.assertTrue(GroupManager.has_management_permission(user))
+
+    def test_can_manage_groups_no_perm_no_group(self):        
+        user = AuthUtils.create_user('Clark Kent')
+        self.assertFalse(GroupManager.can_manage_groups(user))
+
+    def test_can_manage_groups_user_not_authenticated(self):        
+        user = MockUserNotAuthenticated()
+        self.assertFalse(GroupManager.can_manage_groups(user))
+
+    def test_can_manage_groups_has_perm(self):        
+        user = AuthUtils.create_user('Clark Kent')
+        AuthUtils.add_permission_to_user_by_name(
+            'auth.group_management', user
+        )        
+        self.assertTrue(GroupManager.can_manage_groups(user))
+
+    def test_can_manage_groups_no_perm_leads_group(self):        
+        user = AuthUtils.create_user('Clark Kent')
+        self.group_default.authgroup.group_leaders.add(user)
+        self.assertTrue(GroupManager.can_manage_groups(user))
+
+    def test_can_manage_group_no_perm_no_group(self):        
+        user = AuthUtils.create_user('Clark Kent')
+        self.assertFalse(
+            GroupManager.can_manage_group(user, self.group_default)
+        )
+
+    def test_can_manage_group_has_perm(self):        
+        user = AuthUtils.create_user('Clark Kent')
+        AuthUtils.add_permission_to_user_by_name(
+            'auth.group_management', user
+        )        
+        self.assertTrue(
+            GroupManager.can_manage_group(user, self.group_default)
+        )
+
+    def test_can_manage_group_no_perm_leads_correct_group(self):        
+        user = AuthUtils.create_user('Clark Kent')
+        self.group_default.authgroup.group_leaders.add(user)
+        self.assertTrue(
+            GroupManager.can_manage_group(user, self.group_default)
+        )
+
+    def test_can_manage_group_no_perm_leads_other_group(self):        
+        user = AuthUtils.create_user('Clark Kent')
+        self.group_hidden.authgroup.group_leaders.add(user)
+        self.assertFalse(
+            GroupManager.can_manage_group(user, self.group_default)
+        )
+
+    def test_can_manage_group_user_not_authenticated(self):        
+        user = MockUserNotAuthenticated()
+        self.assertFalse(
+            GroupManager.can_manage_group(user, self.group_default)
+        )

allianceauth/groupmanagement/tests/test_models.py

@@ -0,0 +1,167 @@
+from unittest import mock
+
+from django.contrib.auth.models import User, Group
+from django.test import TestCase
+
+from allianceauth.tests.auth_utils import AuthUtils
+from allianceauth.eveonline.models import (
+    EveCorporationInfo, EveAllianceInfo, EveCharacter
+)
+
+from ..models import GroupRequest, RequestLog
+
+
+def create_testdata():    
+    # clear DB
+    User.objects.all().delete()
+    Group.objects.all().delete()
+    EveCharacter.objects.all().delete()
+    EveCorporationInfo.objects.all().delete()
+    EveAllianceInfo.objects.all().delete()
+
+    # group 1
+    group = Group.objects.create(name='Superheros')        
+    group.authgroup.description = 'Default Group'
+    group.authgroup.internal = False
+    group.authgroup.hidden = False
+    group.authgroup.save()
+    
+    # user 1        
+    user_1 = AuthUtils.create_user('Bruce Wayne')
+    AuthUtils.add_main_character_2(
+        user_1,
+        name='Bruce Wayne',
+        character_id=1001,
+        corp_id=2001,
+        corp_name='Wayne Technologies'
+    )        
+    user_1.groups.add(group)
+    group.authgroup.group_leaders.add(user_1)
+
+    # user 2
+    user_2 = AuthUtils.create_user('Clark Kent')
+    AuthUtils.add_main_character_2(
+        user_2,
+        name='Clark Kent',
+        character_id=1002,
+        corp_id=2002,
+        corp_name='Wayne Technologies'
+    )            
+    return group, user_1, user_2
+
+
+
+class TestGroupRequest(TestCase):
+    
+    @classmethod
+    def setUpClass(cls):
+        super().setUpClass()
+        cls.group, cls.user_1, _ = create_testdata()
+
+    def test_main_char(self):
+        group_request = GroupRequest.objects.create(
+            status='Pending',
+            user=self.user_1,
+            group=self.group
+        )
+        expected = self.user_1.profile.main_character
+        self.assertEqual(group_request.main_char, expected)
+
+    def test_str(self):
+        group_request = GroupRequest.objects.create(
+            status='Pending',
+            user=self.user_1,
+            group=self.group
+        )
+        expected = 'Bruce Wayne:Superheros'
+        self.assertEqual(str(group_request), expected)
+
+
+class TestRequestLog(TestCase):
+    
+    @classmethod
+    def setUpClass(cls):
+        super().setUpClass()
+        cls.group, cls.user_1, cls.user_2 = create_testdata()
+
+    def test_requestor(self):
+        request_log = RequestLog.objects.create(
+            group=self.group,
+            request_info='Clark Kent:Superheros',
+            request_actor=self.user_1
+        )
+        expected = 'Clark Kent'
+        self.assertEqual(request_log.requestor(), expected)
+
+    def test_type_to_str_removed(self):
+        request_log = RequestLog.objects.create(
+            request_type=None,
+            group=self.group,
+            request_info='Clark Kent:Superheros',
+            request_actor=self.user_1
+        )
+        expected = 'Removed'
+        self.assertEqual(request_log.type_to_str(), expected)
+
+    def test_type_to_str_leave(self):
+        request_log = RequestLog.objects.create(
+            request_type=True,
+            group=self.group,
+            request_info='Clark Kent:Superheros',
+            request_actor=self.user_1
+        )
+        expected = 'Leave'
+        self.assertEqual(request_log.type_to_str(), expected)
+
+    def test_type_to_str_join(self):
+        request_log = RequestLog.objects.create(
+            request_type=False,
+            group=self.group,
+            request_info='Clark Kent:Superheros',
+            request_actor=self.user_1
+        )
+        expected = 'Join'
+        self.assertEqual(request_log.type_to_str(), expected)
+
+    def test_action_to_str_accept(self):
+        request_log = RequestLog.objects.create(            
+            group=self.group,
+            request_info='Clark Kent:Superheros',
+            request_actor=self.user_1,
+            action = True
+        )
+        expected = 'Accept'
+        self.assertEqual(request_log.action_to_str(), expected)
+
+    def test_action_to_str_reject(self):
+        request_log = RequestLog.objects.create(            
+            group=self.group,
+            request_info='Clark Kent:Superheros',
+            request_actor=self.user_1,
+            action = False
+        )
+        expected = 'Reject'
+        self.assertEqual(request_log.action_to_str(), expected)
+
+    def test_req_char(self):
+        request_log = RequestLog.objects.create(            
+            group=self.group,
+            request_info='Clark Kent:Superheros',
+            request_actor=self.user_1,
+            action = False
+        )
+        expected = self.user_2.profile.main_character
+        self.assertEqual(request_log.req_char(), expected)
+
+
+class TestAuthGroup(TestCase):
+
+    def test_str(self):
+        group = Group.objects.create(name='Superheros')        
+        group.authgroup.description = 'Default Group'
+        group.authgroup.internal = False
+        group.authgroup.hidden = False
+        group.authgroup.save()
+
+        expected = 'Superheros'
+        self.assertEqual(str(group.authgroup), expected)

allianceauth/groupmanagement/tests/test_signals.py

@@ -0,0 +1,61 @@
+from unittest import mock
+
+from django.test import TestCase
+from django.contrib.auth.models import User, Group
+
+from allianceauth.eveonline.models import EveCorporationInfo, EveAllianceInfo
+from allianceauth.tests.auth_utils import AuthUtils
+
+from ..signals import check_groups_on_state_change
+
+
+class GroupManagementStateTestCase(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'
+        )
+        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.corp = EveCorporationInfo.objects.create(
+            corporation_id='2', corporation_name='test corp', corporation_ticker='TEST', alliance=cls.alliance, member_count=1
+        )
+        cls.state_group = Group.objects.create(name='state_group')
+        cls.open_group = Group.objects.create(name='open_group')
+        cls.state = AuthUtils.create_state('test state', 500)
+        cls.state_group.authgroup.states.add(cls.state)
+        cls.state_group.authgroup.internal = False
+        cls.state_group.save()
+
+    def setUp(self):
+        self.user.refresh_from_db()
+        self.state.refresh_from_db()
+
+    def _refresh_user(self):
+        self.user = User.objects.get(pk=self.user.pk)
+
+    def _refresh_test_group(self):
+        self.state_group = Group.objects.get(pk=self.state_group.pk)
+
+    def test_drop_state_group(self):
+        self.user.groups.add(self.open_group)
+        self.user.groups.add(self.state_group)     
+        self.assertEqual(self.user.profile.state.name, "Guest")
+
+        self.state.member_corporations.add(self.corp)
+        self._refresh_user()
+        self.assertEqual(self.user.profile.state, self.state)
+        groups = self.user.groups.all()
+        self.assertIn(self.state_group, groups) #keeps group
+        self.assertIn(self.open_group, groups) #public group unafected
+
+        self.state.member_corporations.clear()
+        self._refresh_user()
+        self.assertEqual(self.user.profile.state.name, "Guest")
+        groups = self.user.groups.all()
+        self.assertNotIn(self.state_group, groups) #looses group
+        self.assertIn(self.open_group, groups) #public group unafected

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/tests/test_views.py

@@ -0,0 +1,22 @@
+from unittest.mock import Mock, patch
+
+from django.test import RequestFactory, TestCase
+from django.urls import reverse
+
+from allianceauth.tests.auth_utils import AuthUtils
+from esi.models import Token
+
+from .. import views
+
+
+class TestViews(TestCase):
+        
+    def setUp(self):
+        self.factory = RequestFactory()
+        self.user = AuthUtils.create_user('Bruce Wayne')        
+
+    def test_groups_view_can_load(self):
+        request = self.factory.get(reverse('groupmanagement:groups'))
+        request.user = self.user
+        response = views.groups_view(request)
+        self.assertEqual(response.status_code, 200)        

allianceauth/groupmanagement/views.py

@@ -1,21 +1,21 @@
 import logging
 
+from django.conf import settings
 from django.contrib import messages
 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
 from django.utils.translation import ugettext_lazy as _
-from .managers import GroupManager
-from .models import GroupRequest, RequestLog
 
 from allianceauth.notifications import notify
 
-from django.conf import settings
+from .managers import GroupManager
+from .models import GroupRequest, RequestLog
+
 
 logger = logging.getLogger(__name__)
 
@@ -27,13 +27,14 @@ 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()
     else:
         # Group specific leader
-        group_requests = base_group_query.filter(group__authgroup__group_leaders__in=[request.user])
+        users__groups = GroupManager.get_group_leaders_groups(request.user)
+        group_requests = base_group_query.filter(group__in=users__groups)
 
     for grouprequest in group_requests:
         if grouprequest.leave_request:
@@ -74,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):
@@ -91,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):
@@ -122,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({
@@ -234,7 +232,7 @@ def group_reject_request(request, group_request_id):
         raise p
     except:
         messages.error(request, _('An unhandled error occurred while processing the application from %(mainchar)s to %(group)s.') % {"mainchar": group_request.main_char, "group": group_request.group})
-        logger.exception("Unhandled exception occured while user %s attempting to reject group request id %s" % (
+        logger.exception("Unhandled exception occurred while user %s attempting to reject group request id %s" % (
             request.user, group_request_id))
         pass
 
@@ -268,9 +266,9 @@ def group_leave_accept_request(request, group_request_id):
                        (request.user, group_request_id))
         raise p
     except:
-        messages.error(request, _('An unhandled error occured while processing the application from %(mainchar)s to leave %(group)s.') % {
+        messages.error(request, _('An unhandled error occurred while processing the application from %(mainchar)s to leave %(group)s.') % {
             "mainchar": group_request.main_char, "group": group_request.group})
-        logger.exception("Unhandled exception occured while user %s attempting to accept group leave request id %s" % (
+        logger.exception("Unhandled exception occurred while user %s attempting to accept group leave request id %s" % (
             request.user, group_request_id))
         pass
 
@@ -302,9 +300,9 @@ def group_leave_reject_request(request, group_request_id):
                        (request.user, group_request_id))
         raise p
     except:
-        messages.error(request, _('An unhandled error occured while processing the application from %(mainchar)s to leave %(group)s.') % {
+        messages.error(request, _('An unhandled error occurred while processing the application from %(mainchar)s to leave %(group)s.') % {
             "mainchar": group_request.main_char, "group": group_request.group})
-        logger.exception("Unhandled exception occured while user %s attempting to reject group leave request id %s" % (
+        logger.exception("Unhandled exception occurred while user %s attempting to reject group leave request id %s" % (
             request.user, group_request_id))
         pass
 
@@ -314,24 +312,23 @@ def group_leave_reject_request(request, group_request_id):
 @login_required
 def groups_view(request):
     logger.debug("groups_view called by user %s" % request.user)
+    
+    groups_qs = GroupManager.get_joinable_groups_for_user(
+        request.user, include_hidden=False
+    )
+    groups_qs = groups_qs.order_by('name')
     groups = []
+    for group in groups_qs:        
+        group_request = GroupRequest.objects\
+            .filter(user=request.user)\
+            .filter(group=group)
+        groups.append({
+            'group': group, 
+            'request': group_request[0] if group_request else None
+        })
 
-    group_query = GroupManager.get_joinable_groups(request.user.profile.state)
-
-    if not request.user.has_perm('groupmanagement.request_groups'):
-        # Filter down to public groups only for non-members
-        group_query = group_query.filter(authgroup__public=True)
-        logger.debug("Not a member, only public groups will be available")
-
-    for group in group_query:
-        # Exclude hidden
-        if not group.authgroup.hidden:
-            group_request = GroupRequest.objects.filter(user=request.user).filter(group=group)
-
-            groups.append({'group': group, 'request': group_request[0] if group_request else None})
-
-    render_items = {'groups': groups}
-    return render(request, 'groupmanagement/groups.html', context=render_items)
+    context = {'groups': groups}
+    return render(request, 'groupmanagement/groups.html', context=context)
 
 
 @login_required
@@ -348,13 +345,13 @@ def group_request_add(request, group_id):
         # User is already a member of this group.
         logger.warning("User %s attempted to join group id %s but they are already a member." %
                        (request.user, group_id))
-        messages.warning(request, "You are already a member of that group.")
+        messages.warning(request, _("You are already a member of that group."))
         return redirect('groupmanagement:groups')
     if not request.user.has_perm('groupmanagement.request_groups') and not group.authgroup.public:
         # Does not have the required permission, trying to join a non-public group
         logger.warning("User %s attempted to join group id %s but it is not a public group" %
                        (request.user, group_id))
-        messages.warning(request, "You cannot join that group")
+        messages.warning(request, _("You cannot join that group"))
         return redirect('groupmanagement:groups')
     if group.authgroup.open:
         logger.info("%s joining %s as is an open group" % (request.user, group))
@@ -363,7 +360,7 @@ def group_request_add(request, group_id):
     req = GroupRequest.objects.filter(user=request.user, group=group)
     if len(req) > 0:
         logger.info("%s attempted to join %s but already has an open application" % (request.user, group))
-        messages.warning(request, "You already have a pending application for that group.")
+        messages.warning(request, _("You already have a pending application for that group."))
         return redirect("groupmanagement:groups")
     grouprequest = GroupRequest()
     grouprequest.status = _('Pending')
@@ -397,7 +394,7 @@ def group_request_leave(request, group_id):
     req = GroupRequest.objects.filter(user=request.user, group=group)
     if len(req) > 0:
         logger.info("%s attempted to leave %s but already has an pending leave request." % (request.user, group))
-        messages.warning(request, "You already have a pending leave request for that group.")
+        messages.warning(request, _("You already have a pending leave request for that group."))
         return redirect("groupmanagement:groups")
     if getattr(settings, 'AUTO_LEAVE', False):
         logger.info("%s leaving joinable group %s due to auto_leave" % (request.user, group))

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/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/celery.py

@@ -11,6 +11,15 @@ app = Celery('{{ project_name }}')
 # Using a string here means the worker don't have to serialize
 # the configuration object to child processes.
 app.config_from_object('django.conf:settings')
+
+# setup priorities ( 0 Highest, 9 Lowest )
+app.conf.broker_transport_options = {
+    'priority_steps': list(range(10)),  # setup que to have 10 steps
+    'queue_order_strategy': 'priority',  # setup que to use prio sorting
+}
+app.conf.task_default_priority = 5  # anything called with the task.delay() will be given normal priority (5)
+app.conf.worker_prefetch_multiplier = 1  # only prefetch single tasks at a time on the workers so that prio tasks happen
+
 app.conf.ONCE = {
     'backend': 'allianceauth.services.tasks.DjangoBackend',
     'settings': {}

allianceauth/project_template/project_name/settings/base.py

@@ -83,6 +83,9 @@ LANGUAGES = (
     ('en', ugettext('English')),
     ('de', ugettext('German')),
     ('es', ugettext('Spanish')),
+    ('zh-hans', ugettext('Chinese Simplified')),
+    ('ru', ugettext('Russian')),
+    ('ko', ugettext('Korean')),
 )
 
 TEMPLATES = [
@@ -100,8 +103,7 @@ TEMPLATES = [
                 'django.template.context_processors.media',
                 '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.notifications.context_processors.user_notification_count',                
                 'allianceauth.context_processors.auth_settings',
             ],
         },
@@ -217,6 +219,14 @@ LOGGING = {
             'maxBytes': 1024 * 1024 * 5,  # edit this line to change max log file size
             'backupCount': 5,  # edit this line to change number of log backups
         },
+        'extension_file': {
+            'level': 'INFO',
+            'class': 'logging.handlers.RotatingFileHandler',
+            'filename': os.path.join(BASE_DIR, 'log/extensions.log'),
+            'formatter': 'verbose',
+            'maxBytes': 1024 * 1024 * 5,  # edit this line to change max log file size
+            'backupCount': 5,  # edit this line to change number of log backups
+        },
         'console': {
             'level': 'DEBUG',  # edit this line to change logging level to console
             'class': 'logging.StreamHandler',
@@ -233,6 +243,10 @@ LOGGING = {
             'handlers': ['log_file', 'console', 'notifications'],
             'level': 'DEBUG',
         },
+        'extensions': {
+            'handlers': ['extension_file', 'console'],
+            'level': 'DEBUG',
+        },
         'django': {
             'handlers': ['log_file', 'console'],
             'level': 'ERROR',

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/project_template/project_name/urls.py

@@ -4,3 +4,8 @@ from allianceauth import urls
 urlpatterns = [
     url(r'', include(urls)),
 ]
+
+handler500 = 'allianceauth.views.Generic500Redirect'
+handler404 = 'allianceauth.views.Generic404Redirect'
+handler403 = 'allianceauth.views.Generic403Redirect'
+handler400 = 'allianceauth.views.Generic400Redirect'

allianceauth/services/abstract.py

@@ -17,6 +17,7 @@ from django.contrib.auth.mixins import LoginRequiredMixin, PermissionRequiredMix
 from django.db import models, IntegrityError
 from django.core.exceptions import ObjectDoesNotExist
 from django.shortcuts import render, Http404, redirect
+from django.utils.translation import gettext_lazy as _
 
 from .forms import ServicePasswordModelForm
 
@@ -68,7 +69,7 @@ class BaseCreatePasswordServiceAccountView(BaseServiceView, ServiceCredentialsVi
         try:
             svc_obj = self.model.objects.create(user=request.user)
         except IntegrityError:
-            messages.error(request, "That service account already exists")
+            messages.error(request, _("That service account already exists"))
             return redirect(self.index_redirect)
 
         return render(request, self.template_name,
@@ -100,7 +101,7 @@ class BaseSetPasswordServiceAccountView(ServicesCRUDMixin, BaseServiceView, Upda
     def post(self, request, *args, **kwargs):
         result = super(BaseSetPasswordServiceAccountView, self).post(request, *args, **kwargs)
         if self.get_form().is_valid():
-            messages.success(request, "Successfully set your {} password".format(self.service_name))
+            messages.success(request, _("Successfully set your {} password".format(self.service_name)))
         return result
 
 

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 user_profile_pic, \
-    user_username, user_main_organization, MainCorporationsFilter,\
+from allianceauth.authentication.admin import (
+    user_profile_pic, 
+    user_username, 
+    user_main_organization, 
+    MainCorporationsFilter,
     MainAllianceFilter
+)
 
 from .models import NameFormatConfig
 
@@ -25,16 +25,24 @@ class ServicesUserAdmin(admin.ModelAdmin):
     list_select_related = True              
     list_display = (
         user_profile_pic,
-        user_username,  
+        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

@@ -1,4 +1,6 @@
+from django.utils.translation import gettext_lazy as _
 from allianceauth import hooks
+
 from .hooks import MenuItemHook
 from .hooks import ServicesHook
 
@@ -6,8 +8,8 @@ from .hooks import ServicesHook
 class Services(MenuItemHook):
     def __init__(self):
         MenuItemHook.__init__(self,
-                              'Services',
-                              'fa fa-cogs fa-fw',
+                              _('Services'),
+                              'fas fa-cogs fa-fw',
                               'services:services', 100)
 
     def render(self, request):

allianceauth/services/hooks.py

@@ -9,6 +9,31 @@ from allianceauth.hooks import get_hooks
 from .models import NameFormatConfig
 
 
+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 determined by the level defined for the parent logger.
+
+    :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
+
+    parent_logger = logging.getLogger('extensions')
+
+    logger = logging.getLogger('extensions.' + name)
+    logger.name = name
+    logger.level = parent_logger.level
+
+    return logger
+
+
 class ServicesHook:
     """
     Abstract base class for creating a compatible services

allianceauth/services/migrations/0001_initial.py

@@ -1,38 +0,0 @@
-# -*- coding: utf-8 -*-
-# Generated by Django 1.10.1 on 2016-09-05 21:40
-from __future__ import unicode_literals
-
-from django.conf import settings
-from django.db import migrations, models
-import django.db.models.deletion
-
-
-class Migration(migrations.Migration):
-
-    initial = True
-
-    dependencies = [
-        ('auth', '0008_alter_user_username_max_length'),
-        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
-    ]
-
-    operations = [
-        migrations.CreateModel(
-            name='DiscordAuthToken',
-            fields=[
-                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
-                ('email', models.CharField(max_length=254, unique=True)),
-                ('token', models.CharField(max_length=254)),
-                ('user', models.ForeignKey(null=True, on_delete=django.db.models.deletion.CASCADE, to=settings.AUTH_USER_MODEL)),
-            ],
-        ),
-        migrations.CreateModel(
-            name='GroupCache',
-            fields=[
-                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
-                ('created', models.DateTimeField(auto_now_add=True)),
-                ('groups', models.TextField(default={})),
-                ('service', models.CharField(choices=[(b'discourse', b'discourse'), (b'discord', b'discord')], max_length=254, unique=True)),
-            ],
-        ),
-    ]

allianceauth/services/migrations/0002_auto_20161016_0135.py

@@ -1,22 +0,0 @@
-# -*- coding: utf-8 -*-
-# Generated by Django 1.10.1 on 2016-10-16 01:35
-from __future__ import unicode_literals
-
-from django.db import migrations
-
-
-class Migration(migrations.Migration):
-
-    dependencies = [
-        ('services', '0001_initial'),
-    ]
-
-    operations = [
-        migrations.RemoveField(
-            model_name='discordauthtoken',
-            name='user',
-        ),
-        migrations.DeleteModel(
-            name='DiscordAuthToken',
-        ),
-    ]

allianceauth/services/migrations/0003_delete_groupcache.py

@@ -1,18 +0,0 @@
-# -*- coding: utf-8 -*-
-# Generated by Django 1.10.5 on 2017-09-02 06:07
-from __future__ import unicode_literals
-
-from django.db import migrations
-
-
-class Migration(migrations.Migration):
-
-    dependencies = [
-        ('services', '0002_auto_20161016_0135'),
-    ]
-
-    operations = [
-        migrations.DeleteModel(
-            name='GroupCache',
-        ),
-    ]

allianceauth/services/migrations/0003_remove_broken_link.py

@@ -0,0 +1,18 @@
+# Generated by Django 2.2.10 on 2020-03-21 13:11
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('services', '0002_nameformatter'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='nameformatconfig',
+            name='format',
+            field=models.CharField(help_text='For information on constructing name formats please see the official documentation, topic "Services Name Formats".', max_length=100),
+        ),
+    ]

allianceauth/services/models.py

@@ -4,14 +4,30 @@ from allianceauth.authentication.models import State
 
 
 class NameFormatConfig(models.Model):
-    service_name = models.CharField(max_length=100, blank=False, null=False)
-    default_to_username = models.BooleanField(default=True, help_text="If a user has no main_character, "
-                                                                      "default to using their Auth username instead.")
-    format = models.CharField(max_length=100, blank=False, null=False,
-                              help_text='For information on constructing name formats, please see the '
-                                        '<a href="https://allianceauth.readthedocs.io/en/latest/features/nameformats">'
-                                        'name format documentation</a>')
-    states = models.ManyToManyField(State, help_text="States to apply this format to. You should only have one "
-                                                     "formatter for each state for each service.")
+    service_name = models.CharField(max_length=100, blank=False)
+    default_to_username = models.BooleanField(
+        default=True, 
+        help_text=
+            'If a user has no main_character, '
+            'default to using their Auth username instead.'
+    )
+    format = models.CharField(
+        max_length=100,
+        blank=False,
+        help_text=
+            'For information on constructing name formats '
+            'please see the official documentation, '
+            'topic "Services Name Formats".'
+    )
+    states = models.ManyToManyField(
+        State, 
+        help_text=
+            "States to apply this format to. You should only have one "
+            "formatter for each state for each service."        
+    )
 
+    def __str__(self):
+        return '%s: %s' % (
+            self.service_name, ', '.join([str(x) for x in self.states.all()])
+        )
 

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', )
+    search_fields = ServicesUserAdmin.search_fields + ('uid', 'username')
+    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):
-        logger.debug('Deleting user %s %s account' % (user, self.name))
-        return DiscordTasks.delete_user(user, notify_user=notify_user)
+    def delete_user(self, user: User, notify_user: bool = False) -> None:
+        if self.user_has_account(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 render_services_ctrl(self, request):                
+        if self.user_has_account(request.user):
+            user_has_account = True
+            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 update_groups(self, user):
-        logger.debug('Processing %s groups for %s' % (self.name, user))
-        if DiscordTasks.has_account(user):
-            DiscordTasks.update_groups.delay(user.pk)
-
-    def validate_user(self, user):
-        logger.debug('Validating user %s %s account' % (user, self.name))
-        if DiscordTasks.has_account(user) and not self.service_active_for_user(user):
-            self.delete_user(user, notify_user=True)
-
-    def sync_nickname(self, user):
-        logger.debug('Syncing %s nickname for user %s' % (self.name, user))
-        DiscordTasks.update_nickname.delay(user.pk)
-
-    def update_all_groups(self):
-        logger.debug('Update all %s groups called' % self.name)
-        DiscordTasks.update_all_groups.delay()
+        return render_to_string(
+            self.service_ctrl_template, 
+            {
+                'server_name': DiscordUser.objects.server_name(),
+                'user_has_account': user_has_account,
+                'discord_username': discord_username
+            }, 
+            request=request
+        )
 
     def service_active_for_user(self, user):
         return user.has_perm(self.access_perm)
 
-    def render_services_ctrl(self, request):
-        return render_to_string(self.service_ctrl_template, {
-            'discord_uid': request.user.discord.uid if DiscordTasks.has_account(request.user) else None,
-            'DISCORD_SERVER_ID': getattr(settings, 'DISCORD_GUILD_ID', ''),
-        }, request=request)
+    def sync_nickname(self, user):
+        logger.debug('Syncing %s nickname for user %s', self.name, user)
+        if self.user_has_account(user):
+            tasks.update_nickname.apply_async(
+                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)