Mitja Nikolaus | 03e412b | 2018-09-18 17:50:15 +0200 | [diff] [blame] | 1 | """Utility functions shared by all crashreport stats tests.""" |
| 2 | |
Mitja Nikolaus | 7dc8672 | 2018-11-27 14:57:39 +0100 | [diff] [blame] | 3 | from datetime import datetime |
Mitja Nikolaus | 1509d8f | 2018-12-06 11:33:17 +0100 | [diff] [blame] | 4 | from typing import Any, Union, Type |
Mitja Nikolaus | 03e412b | 2018-09-18 17:50:15 +0200 | [diff] [blame] | 5 | |
| 6 | import pytz |
| 7 | from django.contrib.auth.models import Group |
| 8 | from rest_framework import status |
| 9 | from rest_framework.authtoken.models import Token |
| 10 | from rest_framework.test import APITestCase, APIClient |
| 11 | |
| 12 | from crashreport_stats.models import ( |
| 13 | Version, |
| 14 | VersionDaily, |
| 15 | RadioVersion, |
| 16 | RadioVersionDaily, |
| 17 | StatsMetadata, |
| 18 | ) |
| 19 | |
Mitja Nikolaus | 7dc8672 | 2018-11-27 14:57:39 +0100 | [diff] [blame] | 20 | from crashreports.models import User |
| 21 | from crashreports.tests.utils import Dummy as CrashreportsDummy |
Mitja Nikolaus | 03e412b | 2018-09-18 17:50:15 +0200 | [diff] [blame] | 22 | from hiccup.allauth_adapters import FP_STAFF_GROUP_NAME |
| 23 | |
| 24 | |
Mitja Nikolaus | 7dc8672 | 2018-11-27 14:57:39 +0100 | [diff] [blame] | 25 | class Dummy(CrashreportsDummy): |
Mitja Nikolaus | 03e412b | 2018-09-18 17:50:15 +0200 | [diff] [blame] | 26 | """Class for creating dummy instances for testing.""" |
| 27 | |
Mitja Nikolaus | 77dd565 | 2018-12-06 11:27:01 +0100 | [diff] [blame] | 28 | DEFAULT_VERSION_VALUES = { |
Mitja Nikolaus | 7dc8672 | 2018-11-27 14:57:39 +0100 | [diff] [blame] | 29 | "build_fingerprint": CrashreportsDummy.BUILD_FINGERPRINTS[0], |
| 30 | "first_seen_on": CrashreportsDummy.DATES[1], |
| 31 | "released_on": CrashreportsDummy.DATES[0], |
Mitja Nikolaus | 03e412b | 2018-09-18 17:50:15 +0200 | [diff] [blame] | 32 | "is_beta_release": False, |
| 33 | "is_official_release": True, |
| 34 | } |
| 35 | |
Mitja Nikolaus | 77dd565 | 2018-12-06 11:27:01 +0100 | [diff] [blame] | 36 | DEFAULT_VERSION_DAILY_VALUES = {"date": CrashreportsDummy.DATES[1]} |
Mitja Nikolaus | 03e412b | 2018-09-18 17:50:15 +0200 | [diff] [blame] | 37 | |
Mitja Nikolaus | 77dd565 | 2018-12-06 11:27:01 +0100 | [diff] [blame] | 38 | DEFAULT_RADIO_VERSION_VALUES = { |
Mitja Nikolaus | 7dc8672 | 2018-11-27 14:57:39 +0100 | [diff] [blame] | 39 | "radio_version": CrashreportsDummy.RADIO_VERSIONS[0], |
| 40 | "first_seen_on": CrashreportsDummy.DATES[1], |
| 41 | "released_on": CrashreportsDummy.DATES[0], |
Mitja Nikolaus | 03e412b | 2018-09-18 17:50:15 +0200 | [diff] [blame] | 42 | } |
| 43 | |
Mitja Nikolaus | 77dd565 | 2018-12-06 11:27:01 +0100 | [diff] [blame] | 44 | DEFAULT_RADIO_VERSION_DAILY_VALUES = {"date": CrashreportsDummy.DATES[1]} |
Mitja Nikolaus | 03e412b | 2018-09-18 17:50:15 +0200 | [diff] [blame] | 45 | |
Mitja Nikolaus | 77dd565 | 2018-12-06 11:27:01 +0100 | [diff] [blame] | 46 | DEFAULT_STATSMETADATA_VALUES = { |
Mitja Nikolaus | 03e412b | 2018-09-18 17:50:15 +0200 | [diff] [blame] | 47 | "updated_at": datetime(2018, 6, 15, 2, 12, 24, tzinfo=pytz.utc) |
| 48 | } |
| 49 | |
Mitja Nikolaus | 03e412b | 2018-09-18 17:50:15 +0200 | [diff] [blame] | 50 | @staticmethod |
Mitja Nikolaus | 1509d8f | 2018-12-06 11:33:17 +0100 | [diff] [blame] | 51 | def create_version( |
| 52 | version_type: Type[Union[Version, RadioVersion]] = Version, |
| 53 | **kwargs: Any |
| 54 | ) -> Union[Version, RadioVersion]: |
Mitja Nikolaus | 03e412b | 2018-09-18 17:50:15 +0200 | [diff] [blame] | 55 | """Create a dummy version instance. |
| 56 | |
| 57 | The dummy instance is created and saved to the database. |
| 58 | Args: |
Mitja Nikolaus | 35a0265 | 2018-10-01 15:10:18 +0200 | [diff] [blame] | 59 | version_type: The class of the version type to be created. |
Mitja Nikolaus | 03e412b | 2018-09-18 17:50:15 +0200 | [diff] [blame] | 60 | **kwargs: |
| 61 | Optional arguments to extend/overwrite the default values. |
| 62 | |
| 63 | Returns: The created version instance. |
| 64 | |
Mitja Nikolaus | 35a0265 | 2018-10-01 15:10:18 +0200 | [diff] [blame] | 65 | Raises: |
| 66 | ValueError: If version_type is not a valid version class type. |
Mitja Nikolaus | 03e412b | 2018-09-18 17:50:15 +0200 | [diff] [blame] | 67 | |
| 68 | """ |
Mitja Nikolaus | 35a0265 | 2018-10-01 15:10:18 +0200 | [diff] [blame] | 69 | if version_type == Version: |
| 70 | entity = Version( |
Mitja Nikolaus | 77dd565 | 2018-12-06 11:27:01 +0100 | [diff] [blame] | 71 | **Dummy._update_copy(Dummy.DEFAULT_VERSION_VALUES, kwargs) |
Mitja Nikolaus | 03e412b | 2018-09-18 17:50:15 +0200 | [diff] [blame] | 72 | ) |
Mitja Nikolaus | 35a0265 | 2018-10-01 15:10:18 +0200 | [diff] [blame] | 73 | elif version_type == RadioVersion: |
| 74 | entity = RadioVersion( |
Mitja Nikolaus | 77dd565 | 2018-12-06 11:27:01 +0100 | [diff] [blame] | 75 | **Dummy._update_copy(Dummy.DEFAULT_RADIO_VERSION_VALUES, kwargs) |
Mitja Nikolaus | 35a0265 | 2018-10-01 15:10:18 +0200 | [diff] [blame] | 76 | ) |
| 77 | else: |
| 78 | raise ValueError( |
| 79 | "No dummy version instance can be created for {}".format( |
| 80 | version_type.__name__ |
| 81 | ) |
| 82 | ) |
Mitja Nikolaus | 03e412b | 2018-09-18 17:50:15 +0200 | [diff] [blame] | 83 | entity.save() |
| 84 | return entity |
| 85 | |
| 86 | @staticmethod |
Mitja Nikolaus | 1509d8f | 2018-12-06 11:33:17 +0100 | [diff] [blame] | 87 | def create_daily_version(version: Version, **kwargs: Any) -> VersionDaily: |
Mitja Nikolaus | 03e412b | 2018-09-18 17:50:15 +0200 | [diff] [blame] | 88 | """Create a dummy daily version instance. |
| 89 | |
| 90 | The dummy instance is created and saved to the database. |
| 91 | Args: |
| 92 | **kwargs: |
| 93 | Optional arguments to extend/overwrite the default values. |
| 94 | |
| 95 | Returns: The created daily version instance. |
| 96 | |
| 97 | """ |
| 98 | entity = VersionDaily( |
| 99 | version=version, |
Mitja Nikolaus | 77dd565 | 2018-12-06 11:27:01 +0100 | [diff] [blame] | 100 | **Dummy._update_copy(Dummy.DEFAULT_VERSION_DAILY_VALUES, kwargs) |
Mitja Nikolaus | 03e412b | 2018-09-18 17:50:15 +0200 | [diff] [blame] | 101 | ) |
| 102 | entity.save() |
| 103 | return entity |
| 104 | |
| 105 | @staticmethod |
Mitja Nikolaus | 1509d8f | 2018-12-06 11:33:17 +0100 | [diff] [blame] | 106 | def create_daily_radio_version( |
| 107 | version: RadioVersion, **kwargs: Any |
| 108 | ) -> RadioVersionDaily: |
Mitja Nikolaus | 03e412b | 2018-09-18 17:50:15 +0200 | [diff] [blame] | 109 | """Create a dummy daily radio version instance. |
| 110 | |
| 111 | The dummy instance is created and saved to the database. |
| 112 | Args: |
| 113 | **kwargs: |
| 114 | Optional arguments to extend/overwrite the default values. |
| 115 | |
| 116 | Returns: The created daily radio version instance. |
| 117 | |
| 118 | """ |
| 119 | entity = RadioVersionDaily( |
| 120 | version=version, |
Mitja Nikolaus | 7dc8672 | 2018-11-27 14:57:39 +0100 | [diff] [blame] | 121 | **Dummy._update_copy( |
Mitja Nikolaus | 77dd565 | 2018-12-06 11:27:01 +0100 | [diff] [blame] | 122 | Dummy.DEFAULT_RADIO_VERSION_DAILY_VALUES, kwargs |
Mitja Nikolaus | 03e412b | 2018-09-18 17:50:15 +0200 | [diff] [blame] | 123 | ) |
| 124 | ) |
| 125 | entity.save() |
| 126 | return entity |
| 127 | |
| 128 | @staticmethod |
Mitja Nikolaus | 1509d8f | 2018-12-06 11:33:17 +0100 | [diff] [blame] | 129 | def create_stats_metadata(**kwargs: Any) -> StatsMetadata: |
Mitja Nikolaus | 03e412b | 2018-09-18 17:50:15 +0200 | [diff] [blame] | 130 | """Create a dummy stats metadata instance. |
| 131 | |
| 132 | The dummy instance is created and saved to the database. |
| 133 | Args: |
| 134 | **kwargs: |
| 135 | Optional arguments to extend/overwrite the default values. |
| 136 | |
| 137 | Returns: The created stats metadata instance. |
| 138 | |
| 139 | """ |
| 140 | entity = StatsMetadata( |
Mitja Nikolaus | 77dd565 | 2018-12-06 11:27:01 +0100 | [diff] [blame] | 141 | **Dummy._update_copy(Dummy.DEFAULT_STATSMETADATA_VALUES, kwargs) |
Mitja Nikolaus | 03e412b | 2018-09-18 17:50:15 +0200 | [diff] [blame] | 142 | ) |
| 143 | entity.save() |
| 144 | return entity |
| 145 | |
| 146 | |
| 147 | class HiccupStatsAPITestCase(APITestCase): |
| 148 | """Abstract class for Hiccup stats REST API test cases to inherit from.""" |
| 149 | |
| 150 | @classmethod |
| 151 | def setUpTestData(cls): # noqa: N802 |
Mitja Nikolaus | e0e8377 | 2018-11-05 10:00:53 +0100 | [diff] [blame] | 152 | """Create client users for accessing the API. |
Mitja Nikolaus | 03e412b | 2018-09-18 17:50:15 +0200 | [diff] [blame] | 153 | |
| 154 | The APIClient that can be used to make authenticated requests as |
Mitja Nikolaus | e0e8377 | 2018-11-05 10:00:53 +0100 | [diff] [blame] | 155 | Fairphone staff user is stored in self.fp_staff_client. Additionally, a |
| 156 | client which is related to a device owner user is stored in |
| 157 | self.device_owner_client. |
Mitja Nikolaus | 03e412b | 2018-09-18 17:50:15 +0200 | [diff] [blame] | 158 | """ |
Mitja Nikolaus | d6907dd | 2018-10-17 14:13:06 +0200 | [diff] [blame] | 159 | fp_staff_group = Group.objects.get(name=FP_STAFF_GROUP_NAME) |
Mitja Nikolaus | 03e412b | 2018-09-18 17:50:15 +0200 | [diff] [blame] | 160 | fp_staff_user = User.objects.create_user( |
| 161 | "fp_staff", "somebody@fairphone.com", "thepassword" |
| 162 | ) |
| 163 | fp_staff_user.groups.add(fp_staff_group) |
| 164 | cls.fp_staff_client = APIClient() |
| 165 | cls.fp_staff_client.force_login(fp_staff_user) |
| 166 | |
| 167 | cls.device_owner_user = User.objects.create_user( |
| 168 | "device_owner", "somebody@somemail.com", "thepassword" |
| 169 | ) |
| 170 | Token.objects.create(user=cls.device_owner_user) |
Mitja Nikolaus | 77dd565 | 2018-12-06 11:27:01 +0100 | [diff] [blame] | 171 | cls.device_owner_device = Dummy.create_device( |
Mitja Nikolaus | 03e412b | 2018-09-18 17:50:15 +0200 | [diff] [blame] | 172 | user=cls.device_owner_user |
| 173 | ) |
| 174 | cls.device_owner_client = APIClient() |
| 175 | cls.device_owner_client.credentials( |
| 176 | HTTP_AUTHORIZATION="Token " + cls.device_owner_user.auth_token.key |
| 177 | ) |
Mitja Nikolaus | 39f42a1 | 2018-12-10 15:40:22 +0100 | [diff] [blame] | 178 | cls.device_owner_client.force_login(cls.device_owner_user) |
Mitja Nikolaus | 03e412b | 2018-09-18 17:50:15 +0200 | [diff] [blame] | 179 | |
Mitja Nikolaus | 03e412b | 2018-09-18 17:50:15 +0200 | [diff] [blame] | 180 | def _assert_get_as_fp_staff_succeeds( |
| 181 | self, url, expected_status=status.HTTP_200_OK |
| 182 | ): |
| 183 | response = self.fp_staff_client.get(url) |
| 184 | self.assertEqual(response.status_code, expected_status) |
| 185 | |
| 186 | def _assert_get_without_authentication_fails( |
| 187 | self, url, expected_status=status.HTTP_401_UNAUTHORIZED |
| 188 | ): |
| 189 | response = self.client.get(url) |
| 190 | self.assertEqual(response.status_code, expected_status) |
| 191 | |
| 192 | def _assert_get_as_device_owner_fails( |
| 193 | self, url, expected_status=status.HTTP_403_FORBIDDEN |
| 194 | ): |
| 195 | response = self.device_owner_client.get(url) |
| 196 | self.assertEqual(response.status_code, expected_status) |