11474688772

Committed 23 Oct 2024 06:57AM UTC coverage: 85.219% (+0.2%) from 84.979%

Build # 11474688772

Build Type

push

github

Committed by

felixrindt

Commit Message

add default organization name

Run Details

2956 of 3482 branches covered (84.89%)

Branch coverage included in aggregate %.

2 of 2 new or added lines in 2 files covered. (100.0%)

31 existing lines in 4 files now uncovered.

11752 of 13777 relevant lines covered (85.3%)

0.85 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

98.67

/ephios/core/dynamic_preferences_registry.py

from datetime import datetime, timedelta

from django.conf import settings
from django.contrib.auth.models import Group
from django.utils import timezone
from django.utils.safestring import mark_safe
from django.utils.timezone import make_aware
from django.utils.translation import gettext_lazy as _
from django_select2.forms import Select2MultipleWidget
from dynamic_preferences.preferences import Section
from dynamic_preferences.registries import (
    PerInstancePreferenceRegistry,
    global_preferences_registry,
)
from dynamic_preferences.types import (
    BooleanPreference,
    DateTimePreference,
    ModelMultipleChoicePreference,
    MultipleChoicePreference,
    StringPreference,
)
from dynamic_preferences.users.registries import user_preferences_registry

from ephios.core import plugins
from ephios.core.models import Qualification, UserProfile
from ephios.core.services.notifications.backends import CORE_NOTIFICATION_BACKENDS
from ephios.core.services.notifications.types import CORE_NOTIFICATION_TYPES
from ephios.extra.preferences import JSONPreference


class EventTypeRegistry(PerInstancePreferenceRegistry):
    pass


event_type_preference_registry = EventTypeRegistry()

notifications_user_section = Section("notifications")
responsible_notifications_user_section = Section("responsible_notifications")
general_global_section = Section("general")
internal_section = Section("internal")  # for settings/stats that should not be exposed to users


@global_preferences_registry.register
class OrganizationName(StringPreference):
    name = "organization_name"
    verbose_name = _("Organization display name")
    default = "ephios"
    section = general_global_section
    required = False


@global_preferences_registry.register
class HideLoginForm(BooleanPreference):
    name = "hide_login_form"
    verbose_name = _("Hide login form")
    help_text = _(
        "Hide the login form on the login page. This only takes effect if you configured at least one identity provider."
    )
    default = False
    section = general_global_section
    required = False


@global_preferences_registry.register
class LoginRedirectToSoleIndentityProvider(BooleanPreference):
    name = "login_redirect_to_sole_identity_provider"
    verbose_name = _("Directly redirect to Identity Provider")
    help_text = _(
        "If the login form is hidden and there is a single identity provider, users trying to login"
        "will be directly redirected to that identity provider. The provider must have a valid logout endpoint."
    )
    default = False
    section = general_global_section
    required = False


@global_preferences_registry.register
class EnabledPlugins(MultipleChoicePreference):
    name = "enabled_plugins"
    verbose_name = _("Enabled plugins")
    default = [
        "ephios.plugins.baseshiftstructures",
        "ephios.plugins.basesignupflows",
        "ephios.plugins.pages",
    ]
    section = general_global_section
    required = False

    @staticmethod
    def get_choices():
        return [
            (plugin.module, mark_safe(f"<strong>{plugin.name}</strong>: {plugin.description}"))
            for plugin in plugins.get_all_plugins()
            if getattr(plugin, "visible", True)
        ]


@global_preferences_registry.register
class LastRunPeriodicCall(DateTimePreference):
    NONE_VALUE = make_aware(datetime(1970, 1, 1))
    name = "last_run_periodic_call"
    verbose_name = _("Last run_periodic call")
    section = internal_section
    required = False

    def get_default(self):
        return self.NONE_VALUE

    @classmethod
    def get_last_call(cls):
        preferences = global_preferences_registry.manager()
        last_call = preferences[f"{cls.section.name}__{cls.name}"]
        if last_call == cls.NONE_VALUE:
            return None
        return last_call

    @classmethod
    def is_stuck(cls):
        last_call = cls.get_last_call()
        return last_call is None or (
            (timezone.now() - last_call) > timedelta(seconds=settings.RUN_PERIODIC_MAX_INTERVAL)
        )

    @classmethod
    def set_last_call(cls, value):
        preferences = global_preferences_registry.manager()
        preferences[f"{cls.section.name}__{cls.name}"] = value


@user_preferences_registry.register
class NotificationPreference(JSONPreference):
    name = "notifications"
    verbose_name = _("Notification preferences")
    section = notifications_user_section
    default = dict(
        zip(
            [not_type.slug for not_type in CORE_NOTIFICATION_TYPES],
            [[backend.slug for backend in CORE_NOTIFICATION_BACKENDS]]
            * len(CORE_NOTIFICATION_TYPES),
        )
    )


@event_type_preference_registry.register
class VisibleForPreference(ModelMultipleChoicePreference):
    name = "visible_for"
    verbose_name = _("Events of this type should by default be visible for")
    model = Group
    default = Group.objects.all()
    field_kwargs = {"widget": Select2MultipleWidget}


@event_type_preference_registry.register
class ResponsibleUsersPreference(ModelMultipleChoicePreference):
    name = "responsible_users"
    verbose_name = _("Users that are responsible for this event type by default")
    model = UserProfile
    default = UserProfile.objects.none()
    field_kwargs = {"widget": Select2MultipleWidget}


@event_type_preference_registry.register
class ResponsibleGroupsPreference(ModelMultipleChoicePreference):
    name = "responsible_groups"
    verbose_name = _("Groups that are responsible for this event type by default")
    model = Group
    default = Group.objects.none()
    field_kwargs = {"widget": Select2MultipleWidget}


@event_type_preference_registry.register
class GeneralRequiredQualificationPreference(ModelMultipleChoicePreference):
    name = "general_required_qualifications"
    verbose_name = _("General required qualifications for this event type")
    help_text = _(
        "These qualifications are required for all events of this event type. Users without these qualification will not be able to sign up, so make sure to use this field appropriately."
    )
    model = Qualification
    default = Qualification.objects.none()
    field_kwargs = {"widget": Select2MultipleWidget}

1	from datetime import datetime, timedelta	1✔
2
3	from django.conf import settings	1✔
4	from django.contrib.auth.models import Group	1✔
5	from django.utils import timezone	1✔
6	from django.utils.safestring import mark_safe	1✔
7	from django.utils.timezone import make_aware	1✔
8	from django.utils.translation import gettext_lazy as _	1✔
9	from django_select2.forms import Select2MultipleWidget	1✔
10	from dynamic_preferences.preferences import Section	1✔
11	from dynamic_preferences.registries import (	1✔
12	PerInstancePreferenceRegistry,
13	global_preferences_registry,
14	)
15	from dynamic_preferences.types import (	1✔
16	BooleanPreference,
17	DateTimePreference,
18	ModelMultipleChoicePreference,
19	MultipleChoicePreference,
20	StringPreference,
21	)
22	from dynamic_preferences.users.registries import user_preferences_registry	1✔
23
24	from ephios.core import plugins	1✔
25	from ephios.core.models import Qualification, UserProfile	1✔
26	from ephios.core.services.notifications.backends import CORE_NOTIFICATION_BACKENDS	1✔
27	from ephios.core.services.notifications.types import CORE_NOTIFICATION_TYPES	1✔
28	from ephios.extra.preferences import JSONPreference	1✔
29
30
31	class EventTypeRegistry(PerInstancePreferenceRegistry):	1✔
32	pass	1✔
33
34
35	event_type_preference_registry = EventTypeRegistry()	1✔
36
37	notifications_user_section = Section("notifications")	1✔
38	responsible_notifications_user_section = Section("responsible_notifications")	1✔
39	general_global_section = Section("general")	1✔
40	internal_section = Section("internal") # for settings/stats that should not be exposed to users	1✔
41
42
43	@global_preferences_registry.register	1✔
44	class OrganizationName(StringPreference):	1✔
45	name = "organization_name"	1✔
46	verbose_name = _("Organization display name")	1✔
47	default = "ephios"	1✔
48	section = general_global_section	1✔
49	required = False	1✔
50
51
52	@global_preferences_registry.register	1✔
53	class HideLoginForm(BooleanPreference):	1✔
54	name = "hide_login_form"	1✔
55	verbose_name = _("Hide login form")	1✔
56	help_text = _(	1✔
57	"Hide the login form on the login page. This only takes effect if you configured at least one identity provider."
58	)
59	default = False	1✔
60	section = general_global_section	1✔
61	required = False	1✔
62
63
64	@global_preferences_registry.register	1✔
65	class LoginRedirectToSoleIndentityProvider(BooleanPreference):	1✔
66	name = "login_redirect_to_sole_identity_provider"	1✔
67	verbose_name = _("Directly redirect to Identity Provider")	1✔
68	help_text = _(	1✔
69	"If the login form is hidden and there is a single identity provider, users trying to login"
70	"will be directly redirected to that identity provider. The provider must have a valid logout endpoint."
71	)
72	default = False	1✔
73	section = general_global_section	1✔
74	required = False	1✔
75
76
77	@global_preferences_registry.register	1✔
78	class EnabledPlugins(MultipleChoicePreference):	1✔
79	name = "enabled_plugins"	1✔
80	verbose_name = _("Enabled plugins")	1✔
81	default = [	1✔
82	"ephios.plugins.baseshiftstructures",
83	"ephios.plugins.basesignupflows",
84	"ephios.plugins.pages",
85	]
86	section = general_global_section	1✔
87	required = False	1✔
88
89	@staticmethod	1✔
90	def get_choices():	1✔
91	return [	1✔
92	(plugin.module, mark_safe(f"<strong>{plugin.name}</strong>: {plugin.description}"))
93	for plugin in plugins.get_all_plugins()
94	if getattr(plugin, "visible", True)
95	]
96
97
98	@global_preferences_registry.register	1✔
99	class LastRunPeriodicCall(DateTimePreference):	1✔
100	NONE_VALUE = make_aware(datetime(1970, 1, 1))	1✔
101	name = "last_run_periodic_call"	1✔
102	verbose_name = _("Last run_periodic call")	1✔
103	section = internal_section	1✔
104	required = False	1✔
105
106	def get_default(self):	1✔
107	return self.NONE_VALUE	1✔
108
109	@classmethod	1✔
110	def get_last_call(cls):	1✔
111	preferences = global_preferences_registry.manager()	1✔
112	last_call = preferences[f"{cls.section.name}__{cls.name}"]	1✔
113	if last_call == cls.NONE_VALUE:	1!
114	return None	1✔
UNCOV 115	return last_call	×
116
117	@classmethod	1✔
118	def is_stuck(cls):	1✔
119	last_call = cls.get_last_call()	1✔
120	return last_call is None or (	1✔
121	(timezone.now() - last_call) > timedelta(seconds=settings.RUN_PERIODIC_MAX_INTERVAL)
122	)
123
124	@classmethod	1✔
125	def set_last_call(cls, value):	1✔
126	preferences = global_preferences_registry.manager()	1✔
127	preferences[f"{cls.section.name}__{cls.name}"] = value	1✔
128
129
130	@user_preferences_registry.register	1✔
131	class NotificationPreference(JSONPreference):	1✔
132	name = "notifications"	1✔
133	verbose_name = _("Notification preferences")	1✔
134	section = notifications_user_section	1✔
135	default = dict(	1✔
136	zip(
137	[not_type.slug for not_type in CORE_NOTIFICATION_TYPES],
138	[[backend.slug for backend in CORE_NOTIFICATION_BACKENDS]]
139	* len(CORE_NOTIFICATION_TYPES),
140	)
141	)
142
143
144	@event_type_preference_registry.register	1✔
145	class VisibleForPreference(ModelMultipleChoicePreference):	1✔
146	name = "visible_for"	1✔
147	verbose_name = _("Events of this type should by default be visible for")	1✔
148	model = Group	1✔
149	default = Group.objects.all()	1✔
150	field_kwargs = {"widget": Select2MultipleWidget}	1✔
151
152
153	@event_type_preference_registry.register	1✔
154	class ResponsibleUsersPreference(ModelMultipleChoicePreference):	1✔
155	name = "responsible_users"	1✔
156	verbose_name = _("Users that are responsible for this event type by default")	1✔
157	model = UserProfile	1✔
158	default = UserProfile.objects.none()	1✔
159	field_kwargs = {"widget": Select2MultipleWidget}	1✔
160
161
162	@event_type_preference_registry.register	1✔
163	class ResponsibleGroupsPreference(ModelMultipleChoicePreference):	1✔
164	name = "responsible_groups"	1✔
165	verbose_name = _("Groups that are responsible for this event type by default")	1✔
166	model = Group	1✔
167	default = Group.objects.none()	1✔
168	field_kwargs = {"widget": Select2MultipleWidget}	1✔
169
170
171	@event_type_preference_registry.register	1✔
172	class GeneralRequiredQualificationPreference(ModelMultipleChoicePreference):	1✔
173	name = "general_required_qualifications"	1✔
174	verbose_name = _("General required qualifications for this event type")	1✔
175	help_text = _(	1✔
176	"These qualifications are required for all events of this event type. Users without these qualification will not be able to sign up, so make sure to use this field appropriately."
177	)
178	model = Qualification	1✔
179	default = Qualification.objects.none()	1✔
180	field_kwargs = {"widget": Select2MultipleWidget}	1✔

ephios-dev / ephios / 11474688772

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous