2982461137

Build Type

github

Committed by GitHub

Commit Message

<a href="https://github.com/kobotoolbox/kpi/commit/<a class=hub.com/kobotoolbox/kpi/commit/<a class="double-link" href="https://git"><a class=hub.com/kobotoolbox/kpi/commit/<a class="double-link" href="https://git"><a class=hub.com/kobotoolbox/kpi/commit/<a class="double-link" href="https://git"><a class=hub.com/kobotoolbox/kpi/commit/6429bb61554bdf09839213e1c9c64295ace1eba8">6429bb615">&lt;a href=&quot;https://github.com/kobotoolbox/kpi/commit/</a><a class="double-link" href="https://github.com/kobotoolbox/kpi/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/kobotoolbox/kpi/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/kobotoolbox/kpi/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/kobotoolbox/kpi/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/kobotoolbox/kpi/commit/6429bb61554bdf09839213e1c9c64295ace1eba8">6429bb615</a><a href="https://github.com/kobotoolbox/kpi/commit/6429bb61554bdf09839213e1c9c64295ace1eba8">&quot;&gt;&amp;lt;a href=&amp;quot;https://github.com/kobotoolbox/kpi/commit/&lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/kobotoolbox/kpi/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/kobotoolbox/kpi/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/kobotoolbox/kpi/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/kobotoolbox/kpi/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/kobotoolbox/kpi/commit/6429bb61554bdf09839213e1c9c64295ace1eba8&quot;&gt;6429bb615&lt;/a&gt;&lt;a href=&quot;https://github.com/kobotoolbox/kpi/commit/6429bb61554bdf09839213e1c9c64295ace1eba8&quot;&gt;&amp;quot;&amp;gt;&amp;amp;lt;a href=&amp;amp;quot;https://github.com/kobotoolbox/kpi/commit/&amp;lt;/a&amp;gt;&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://github.com/kobotoolbox/kpi/commit/&amp;amp;lt;a class=&amp;amp;quot;double-link&am... (continued)

Pull Request Pull Request #3985: Replace KobocatSubmissionCounter

Run Details

2181 of 3580 branches covered (60.92%)

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

9357 of 12288 relevant lines covered (76.15%)

1.52 hits per line

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

40.3

/kobo/apps/superuser_stats/admin.py

# coding: utf-8
import csv
from datetime import date
from dateutil.relativedelta import relativedelta

from django.contrib import admin
from django.contrib.admin import DateFieldListFilter
from django.contrib.auth.admin import UserAdmin
from django.contrib.auth.models import User
from django.db.models import Count, Sum
from django.utils import timezone

from kobo.static_lists import COUNTRIES
from kpi.constants import ASSET_TYPE_SURVEY
from kpi.deployment_backends.kc_access.shadow_models import (
    KobocatXForm,
    ReadOnlyKobocatInstance,
    ReadOnlyKobocatMonthlyXFormSubmissionCounter,
)
from kpi.models.asset import Asset


class TimePeriodFilter(admin.SimpleListFilter):
    title = 'Period Filters'
    parameter_name = 'timeframe'

    def __init__(self, request, params, model, model_admin):
        super().__init__(request, params, model, model_admin)
        self.__model = model

    def lookups(self, request, model_admin):
        return (
            ('1', '1 Month'),
            ('3', '3 Months'),
            ('6', '6 Months'),
            ('9', '9 Months'),
            ('12', '12 Months'),
        )

    def queryset(self, request, queryset):
        if not self.value():
            return queryset

        # minus one so that it includes the current
        # month when retrieving data and not pull
        # the data from an extra month earlier
        months = int(self.value()) - 1
        today = date.today()
        first_day_month = today.replace(day=1)
        from_date = first_day_month - relativedelta(months=months)

        if self.__model == Asset:
            condition = {'date_created__gte': from_date}
        else:
            condition = {'timestamp__gte': from_date}

        return queryset.filter(**condition)


class CountryFilter(admin.SimpleListFilter):
    title = 'Country'
    parameter_name = 'Country'

    def __init__(self, request, params, *args, **kwargs):
        super().__init__(request, params, None, None)

    def lookups(self, request, model_admin):
        return COUNTRIES

    def queryset(self, request, queryset):
        pass


class ExtendUserAdmin(UserAdmin):
    """
    This extends the changelist view of the User Model on the
    Django admin page
    """
    def __init__(self, *args, **kwargs):
        super(UserAdmin, self).__init__(*args, **kwargs)
        UserAdmin.list_display += ('date_joined',)
        UserAdmin.list_filter += ('date_joined',)
        UserAdmin.readonly_fields += ('deployed_forms_count', 'monthly_submissions_count')
        UserAdmin.fieldsets += (
            'Deployed forms and Submissions Counts', {
                'fields': ('deployed_forms_count', 'monthly_submissions_count'),
            }
        ),

    def deployed_forms_count(self, obj):
        """
        Gets the count of deployed forms to be displayed on the
        Django admin user changelist page
        """
        assets_count = obj.assets.filter(
            _deployment_data__active=True
        ).aggregate(count=Count('pk'))
        return assets_count['count']

    def monthly_submissions_count(self, obj):
        """
        Gets the number of this month's submissions a user has to be
        displayed in the Django admin user changelist page
        """
        today = timezone.now().date()
        instances = ReadOnlyKobocatMonthlyXFormSubmissionCounter.objects.filter(
            user=obj.user,
            year=today.year,
            month=today.month,
        ).aggregate(
            count=Sum('counter')
        )
        return instances['count']


class SubmissionsByCountry(admin.ModelAdmin):
    change_list_template = 'submissions_by_country.html'
    list_filter = (('date_created', DateFieldListFilter), CountryFilter)
    actions = None

    def has_add_permission(self, request, obj=None):
        return False

    def has_change_permission(self, request, obj=None):
        return False

    def changelist_view(self, request, extra_context=None):
        response = super().changelist_view(
            request,
            extra_context=extra_context,
        )
        response.context_data['summary'] = self.__get_serialized_data(request)
        return response

    def __get_serialized_data(self, request) -> list:
        cl = self.get_changelist_instance(request)
        qs = cl.get_queryset(request)

        data = []

        country_filter = CountryFilter(
            request, request.GET.dict()
        )

        asset_queryset = Asset.objects.filter(
            asset_type=ASSET_TYPE_SURVEY
        )

        countries = COUNTRIES
        if country_filter.value():
            countries = [country for country in COUNTRIES if country[0] == country_filter.value()]

        # Filter for individual countries
        for code, name in countries:
            instances_count = 0
            assets = asset_queryset.filter(
                settings__country__value=code,
            )
            if assets.count() != 0:
                xform_id_strings = list(assets.values_list(
                    '_deployment_data__backend_response__id_string', flat=True
                ).filter(
                    _deployment_data__backend='kobocat',
                    asset_type=ASSET_TYPE_SURVEY,
                ))

                result = KobocatXForm.objects.filter(id_string__in=xform_id_strings).aggregate(
                    instances_count=Sum('num_of_submissions'))
                instances_count = result['instances_count']

            data.append({
                'country': name,
                'count': instances_count,
            })

        return data


class UserStatisticsAdmin(admin.ModelAdmin):
    change_list_template = 'user_statistics.html'
    list_filter = (TimePeriodFilter,)
    actions = None

    def has_add_permission(self, request):
        return False

    def has_change_permission(self, request, obj=None):
        return False

    def changelist_view(self, request, extra_context=None):
        response = super().changelist_view(
            request,
            extra_context=extra_context,
        )
        response.context_data['summary'] = self.__get_serialized_data(request)
        return response

    def __get_serialized_data(self, request) -> list:
        cl = self.get_changelist_instance(request)
        qs = cl.get_queryset(request)

        data = []

        # Filter the assets for the counter
        asset_filter = TimePeriodFilter(
            request, request.GET.dict(), Asset, self.__class__
        )
        asset_queryset = Asset.objects.values('owner_id').filter(
            asset_type=ASSET_TYPE_SURVEY
        )
        records = asset_filter.queryset(request, asset_queryset).annotate(
            form_count=Count('pk')
        ).order_by()
        forms_count = {
            record['owner_id']: record['form_count'] for record in records
        }

        # Filter the asset_queryset for active deployments
        asset_queryset = asset_queryset.filter(_deployment_data__active=True)
        records = asset_filter.queryset(request, asset_queryset).annotate(
            deployment_count=Count('pk')
        ).order_by()
        deployment_count = {
            record['owner_id']: record['deployment_count']
            for record in records
        }

        # Get records from SubmissionCounter
        records = (
            qs.values('user_id', 'user__username', 'user__date_joined')
            .order_by('user__date_joined')
            .annotate(count_sum=Sum('counter'))
        )
        for record in records:
            data.append({
                'username': record['user__username'],
                'date_joined': record['user__date_joined'],
                'submission_count': record['count_sum'],
                'form_count': forms_count.get(record['user_id'], 0),
                'deployed_form_count': deployment_count.get(
                    record['user_id'], 0
                ),
            })

        return data


# TODO Update this admin page
admin.site.register(ReadOnlyKobocatMonthlyXFormSubmissionCounter, UserStatisticsAdmin)
admin.site.register(ReadOnlyKobocatInstance, SubmissionsByCountry)
admin.site.unregister(User)
admin.site.register(User, ExtendUserAdmin)

1	# coding: utf-8
2	import csv	2✔
3	from datetime import date	2✔
4	from dateutil.relativedelta import relativedelta	2✔
5
6	from django.contrib import admin	2✔
7	from django.contrib.admin import DateFieldListFilter	2✔
8	from django.contrib.auth.admin import UserAdmin	2✔
9	from django.contrib.auth.models import User	2✔
10	from django.db.models import Count, Sum	2✔
11	from django.utils import timezone	2✔
12
13	from kobo.static_lists import COUNTRIES	2✔
14	from kpi.constants import ASSET_TYPE_SURVEY	2✔
15	from kpi.deployment_backends.kc_access.shadow_models import (	2✔
16	KobocatXForm,
17	ReadOnlyKobocatInstance,
18	ReadOnlyKobocatMonthlyXFormSubmissionCounter,
19	)
20	from kpi.models.asset import Asset	2✔
21
22
23	class TimePeriodFilter(admin.SimpleListFilter):	2✔
24	title = 'Period Filters'	2✔
25	parameter_name = 'timeframe'	2✔
26
27	def __init__(self, request, params, model, model_admin):	2✔
28	super().__init__(request, params, model, model_admin)	×
29	self.__model = model	×
30
31	def lookups(self, request, model_admin):	2✔
32	return (	×
33	('1', '1 Month'),
34	('3', '3 Months'),
35	('6', '6 Months'),
36	('9', '9 Months'),
37	('12', '12 Months'),
38	)
39
40	def queryset(self, request, queryset):	2✔
41	if not self.value():	×
42	return queryset	×
43
44	# minus one so that it includes the current
45	# month when retrieving data and not pull
46	# the data from an extra month earlier
47	months = int(self.value()) - 1	×
48	today = date.today()	×
49	first_day_month = today.replace(day=1)	×
50	from_date = first_day_month - relativedelta(months=months)	×
51
52	if self.__model == Asset:	×
53	condition = {'date_created__gte': from_date}	×
54	else:
55	condition = {'timestamp__gte': from_date}	×
56
57	return queryset.filter(**condition)	×
58
59
60	class CountryFilter(admin.SimpleListFilter):	2✔
61	title = 'Country'	2✔
62	parameter_name = 'Country'	2✔
63
64	def __init__(self, request, params, args, *kwargs):	2✔
65	super().__init__(request, params, None, None)	×
66
67	def lookups(self, request, model_admin):	2✔
68	return COUNTRIES	×
69
70	def queryset(self, request, queryset):	2✔
71	pass	×
72
73
74	class ExtendUserAdmin(UserAdmin):	2✔
75	"""
76	This extends the changelist view of the User Model on the
77	Django admin page
78	"""
79	def __init__(self, args, *kwargs):	2✔
80	super(UserAdmin, self).__init__(args, *kwargs)	2✔
81	UserAdmin.list_display += ('date_joined',)	2✔
82	UserAdmin.list_filter += ('date_joined',)	2✔
83	UserAdmin.readonly_fields += ('deployed_forms_count', 'monthly_submissions_count')	2✔
84	UserAdmin.fieldsets += (	2✔
85	'Deployed forms and Submissions Counts', {
86	'fields': ('deployed_forms_count', 'monthly_submissions_count'),
87	}
88	),
89
90	def deployed_forms_count(self, obj):	2✔
91	"""
92	Gets the count of deployed forms to be displayed on the
93	Django admin user changelist page
94	"""
95	assets_count = obj.assets.filter(	×
96	_deployment_data__active=True
97	).aggregate(count=Count('pk'))
98	return assets_count['count']	×
99
100	def monthly_submissions_count(self, obj):	2✔
101	"""
102	Gets the number of this month's submissions a user has to be
103	displayed in the Django admin user changelist page
104	"""
105	today = timezone.now().date()	×
106	instances = ReadOnlyKobocatMonthlyXFormSubmissionCounter.objects.filter(	×
107	user=obj.user,
108	year=today.year,
109	month=today.month,
110	).aggregate(
111	count=Sum('counter')
112	)
113	return instances['count']	×
114
115
116	class SubmissionsByCountry(admin.ModelAdmin):	2✔
117	change_list_template = 'submissions_by_country.html'	2✔
118	list_filter = (('date_created', DateFieldListFilter), CountryFilter)	2✔
119	actions = None	2✔
120
121	def has_add_permission(self, request, obj=None):	2✔
122	return False	×
123
124	def has_change_permission(self, request, obj=None):	2✔
125	return False	×
126
127	def changelist_view(self, request, extra_context=None):	2✔
128	response = super().changelist_view(	×
129	request,
130	extra_context=extra_context,
131	)
132	response.context_data['summary'] = self.__get_serialized_data(request)	×
133	return response	×
134
135	def __get_serialized_data(self, request) -> list:	2✔
136	cl = self.get_changelist_instance(request)	×
137	qs = cl.get_queryset(request)	×
138
139	data = []	×
140
141	country_filter = CountryFilter(	×
142	request, request.GET.dict()
143	)
144
145	asset_queryset = Asset.objects.filter(	×
146	asset_type=ASSET_TYPE_SURVEY
147	)
148
149	countries = COUNTRIES	×
150	if country_filter.value():	×
151	countries = [country for country in COUNTRIES if country[0] == country_filter.value()]	×
152
153	# Filter for individual countries
154	for code, name in countries:	×
155	instances_count = 0	×
156	assets = asset_queryset.filter(	×
157	settings__country__value=code,
158	)
159	if assets.count() != 0:	×
160	xform_id_strings = list(assets.values_list(	×
161	'_deployment_data__backend_response__id_string', flat=True
162	).filter(
163	_deployment_data__backend='kobocat',
164	asset_type=ASSET_TYPE_SURVEY,
165	))
166
167	result = KobocatXForm.objects.filter(id_string__in=xform_id_strings).aggregate(	×
168	instances_count=Sum('num_of_submissions'))
169	instances_count = result['instances_count']	×
170
171	data.append({	×
172	'country': name,
173	'count': instances_count,
174	})
175
176	return data	×
177
178
179	class UserStatisticsAdmin(admin.ModelAdmin):	2✔
180	change_list_template = 'user_statistics.html'	2✔
181	list_filter = (TimePeriodFilter,)	2✔
182	actions = None	2✔
183
184	def has_add_permission(self, request):	2✔
185	return False	×
186
187	def has_change_permission(self, request, obj=None):	2✔
188	return False	×
189
190	def changelist_view(self, request, extra_context=None):	2✔
191	response = super().changelist_view(	×
192	request,
193	extra_context=extra_context,
194	)
195	response.context_data['summary'] = self.__get_serialized_data(request)	×
196	return response	×
197
198	def __get_serialized_data(self, request) -> list:	2✔
199	cl = self.get_changelist_instance(request)	×
200	qs = cl.get_queryset(request)	×
201
202	data = []	×
203
204	# Filter the assets for the counter
205	asset_filter = TimePeriodFilter(	×
206	request, request.GET.dict(), Asset, self.__class__
207	)
208	asset_queryset = Asset.objects.values('owner_id').filter(	×
209	asset_type=ASSET_TYPE_SURVEY
210	)
211	records = asset_filter.queryset(request, asset_queryset).annotate(	×
212	form_count=Count('pk')
213	).order_by()
214	forms_count = {	×
215	record['owner_id']: record['form_count'] for record in records
216	}
217
218	# Filter the asset_queryset for active deployments
219	asset_queryset = asset_queryset.filter(_deployment_data__active=True)	×
220	records = asset_filter.queryset(request, asset_queryset).annotate(	×
221	deployment_count=Count('pk')
222	).order_by()
223	deployment_count = {	×
224	record['owner_id']: record['deployment_count']
225	for record in records
226	}
227
228	# Get records from SubmissionCounter
229	records = (	×
230	qs.values('user_id', 'user__username', 'user__date_joined')
231	.order_by('user__date_joined')
232	.annotate(count_sum=Sum('counter'))
233	)
234	for record in records:	×
235	data.append({	×
236	'username': record['user__username'],
237	'date_joined': record['user__date_joined'],
238	'submission_count': record['count_sum'],
239	'form_count': forms_count.get(record['user_id'], 0),
240	'deployed_form_count': deployment_count.get(
241	record['user_id'], 0
242	),
243	})
244
245	return data	×
246
247
248	# TODO Update this admin page
249	admin.site.register(ReadOnlyKobocatMonthlyXFormSubmissionCounter, UserStatisticsAdmin)	2✔
250	admin.site.register(ReadOnlyKobocatInstance, SubmissionsByCountry)	2✔
251	admin.site.unregister(User)	2✔
252	admin.site.register(User, ExtendUserAdmin)	2✔

kobotoolbox / kpi / 2982461137

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