Ещё нет личного кабинета?
14 | Зарегистрироваться 15 |Уже есть личный кабинет?
14 | Войти 15 |Номер {{ picture.foreign_id }}
14 |13 | Тут мы делаем простое приложение: 14 |
{{ message }}
5 | {% endfor %} 6 | {% endif %} 7 | -------------------------------------------------------------------------------- /server/common/django/templates/common/txt/humans.txt: -------------------------------------------------------------------------------- 1 | # The humans responsible & technology colophon 2 | # http://humanstxt.org/ 3 | 4 | 5 | ## wemake.services 6 | 7 | Team: 8 | - Architect: Nikita Sobolev 9 | 10 | 11 | ## Technologies 12 | 13 | Language: English 14 | Doctype: HTML5 15 | Technologies: Python, Django 16 | -------------------------------------------------------------------------------- /server/common/django/templates/common/txt/robots.txt: -------------------------------------------------------------------------------- 1 | User-agent: * 2 | Disallow: 3 | -------------------------------------------------------------------------------- /server/common/django/types.py: -------------------------------------------------------------------------------- 1 | """ 2 | This file is only required for better typing. 3 | 4 | Most of the things here are fixes / missing features in `django-stubs`. 5 | It is better to have links for open bug reports / feature requests 6 | near each type, so we can easily track them and refactor 7 | our code when new versions are released. 8 | """ 9 | 10 | from typing import Protocol 11 | 12 | 13 | # TODO: bug in django-stubs with settings 14 | class Settings(Protocol): 15 | """Our plugin cannot resolve some settings during type checking.""" 16 | 17 | PLACEHOLDER_API_URL: str 18 | PLACEHOLDER_API_TIMEOUT: int 19 | -------------------------------------------------------------------------------- /server/common/pydantic_model.py: -------------------------------------------------------------------------------- 1 | import pydantic 2 | 3 | 4 | class BaseModel(pydantic.BaseModel): 5 | """Base immutable model for our internal use.""" 6 | 7 | model_config = pydantic.ConfigDict(frozen=True) 8 | -------------------------------------------------------------------------------- /server/common/services/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tough-dev-school/python-testing-homework/352aa9b27d17d25f9aa6d67ddb4bec03503ae326/server/common/services/__init__.py -------------------------------------------------------------------------------- /server/common/services/http.py: -------------------------------------------------------------------------------- 1 | from typing import ClassVar 2 | from urllib.parse import urljoin 3 | 4 | from attr import dataclass 5 | 6 | 7 | @dataclass(frozen=True, slots=True) 8 | class BaseFetcher(object): 9 | """Base class for our HTTP actions.""" 10 | 11 | #: Dependencies: 12 | _api_url: str 13 | _api_timeout: int 14 | 15 | #: This must be defined in all subclasses: 16 | _url_path: ClassVar[str] 17 | 18 | def url_path(self) -> str: 19 | """Full URL for the request.""" 20 | return urljoin(self._api_url, self._url_path) 21 | -------------------------------------------------------------------------------- /server/settings/__init__.py: -------------------------------------------------------------------------------- 1 | """ 2 | This is a django-split-settings main file. 3 | 4 | For more information read this: 5 | https://github.com/sobolevn/django-split-settings 6 | https://sobolevn.me/2017/04/managing-djangos-settings 7 | 8 | To change settings file: 9 | `DJANGO_ENV=production python manage.py runserver` 10 | """ 11 | 12 | from os import environ 13 | 14 | import django_stubs_ext 15 | from split_settings.tools import include, optional 16 | 17 | # Monkeypatching Django, so stubs will work for all generics, 18 | # see: https://github.com/typeddjango/django-stubs 19 | django_stubs_ext.monkeypatch() 20 | 21 | # Managing environment via `DJANGO_ENV` variable: 22 | environ.setdefault('DJANGO_ENV', 'development') 23 | _ENV = environ['DJANGO_ENV'] 24 | 25 | _base_settings = ( 26 | 'components/common.py', 27 | 'components/identity.py', 28 | 'components/logging.py', 29 | 'components/csp.py', 30 | 'components/caches.py', 31 | 'components/placeholder.py', 32 | 33 | # Select the right env: 34 | 'environments/{0}.py'.format(_ENV), 35 | 36 | # Optionally override some settings: 37 | optional('environments/local.py'), 38 | ) 39 | 40 | # Include settings: 41 | include(*_base_settings) 42 | -------------------------------------------------------------------------------- /server/settings/components/__init__.py: -------------------------------------------------------------------------------- 1 | from pathlib import Path 2 | 3 | from decouple import AutoConfig 4 | 5 | # Build paths inside the project like this: BASE_DIR.joinpath('some') 6 | # `pathlib` is better than writing: dirname(dirname(dirname(__file__))) 7 | BASE_DIR = Path(__file__).parent.parent.parent.parent 8 | 9 | # Loading `.env` files 10 | # See docs: https://gitlab.com/mkleehammer/autoconfig 11 | config = AutoConfig(search_path=BASE_DIR.joinpath('config')) 12 | -------------------------------------------------------------------------------- /server/settings/components/caches.py: -------------------------------------------------------------------------------- 1 | # Caching 2 | # https://docs.djangoproject.com/en/4.2/topics/cache/ 3 | 4 | CACHES = { 5 | 'default': { 6 | # TODO: use some other cache in production, 7 | # like https://github.com/jazzband/django-redis 8 | 'BACKEND': 'django.core.cache.backends.locmem.LocMemCache', 9 | }, 10 | } 11 | 12 | 13 | # django-axes 14 | # https://django-axes.readthedocs.io/en/latest/4_configuration.html#configuring-caches 15 | 16 | AXES_CACHE = 'default' 17 | -------------------------------------------------------------------------------- /server/settings/components/common.py: -------------------------------------------------------------------------------- 1 | """ 2 | Django settings for server project. 3 | 4 | For more information on this file, see 5 | https://docs.djangoproject.com/en/4.2/topics/settings/ 6 | 7 | For the full list of settings and their config, see 8 | https://docs.djangoproject.com/en/4.2/ref/settings/ 9 | """ 10 | 11 | from django.utils.translation import gettext_lazy as _ 12 | 13 | from server.settings.components import BASE_DIR, config 14 | 15 | # Quick-start development settings - unsuitable for production 16 | # See https://docs.djangoproject.com/en/4.2/howto/deployment/checklist/ 17 | 18 | SECRET_KEY = config('DJANGO_SECRET_KEY') 19 | 20 | # Application definition: 21 | 22 | INSTALLED_APPS: tuple[str, ...] = ( 23 | # Your apps go here: 24 | 'server.apps.pictures', 25 | 'server.apps.identity', 26 | 27 | # Default django apps: 28 | 'django.contrib.auth', 29 | 'django.contrib.contenttypes', 30 | 'django.contrib.sessions', 31 | 'django.contrib.messages', 32 | 'django.contrib.staticfiles', 33 | 34 | # django-admin: 35 | 'django.contrib.admin', 36 | 'django.contrib.admindocs', 37 | 38 | # Security: 39 | 'axes', 40 | 41 | # Health checks: 42 | # You may want to enable other checks as well, 43 | # see: https://github.com/KristianOellegaard/django-health-check 44 | 'health_check', 45 | 'health_check.db', 46 | 'health_check.cache', 47 | 'health_check.storage', 48 | ) 49 | 50 | MIDDLEWARE: tuple[str, ...] = ( 51 | # Logging: 52 | 'server.settings.components.logging.LoggingContextVarsMiddleware', 53 | 54 | # Content Security Policy: 55 | 'csp.middleware.CSPMiddleware', 56 | 57 | # Django: 58 | 'django.middleware.security.SecurityMiddleware', 59 | # django-permissions-policy 60 | 'django_permissions_policy.PermissionsPolicyMiddleware', 61 | 'django.contrib.sessions.middleware.SessionMiddleware', 62 | 'django.middleware.locale.LocaleMiddleware', 63 | 'django.middleware.common.CommonMiddleware', 64 | 'django.middleware.csrf.CsrfViewMiddleware', 65 | 'django.contrib.auth.middleware.AuthenticationMiddleware', 66 | 'django.contrib.messages.middleware.MessageMiddleware', 67 | 'django.middleware.clickjacking.XFrameOptionsMiddleware', 68 | 69 | # Axes: 70 | 'axes.middleware.AxesMiddleware', 71 | 72 | # Django HTTP Referrer Policy: 73 | 'django_http_referrer_policy.middleware.ReferrerPolicyMiddleware', 74 | ) 75 | 76 | ROOT_URLCONF = 'server.urls' 77 | 78 | WSGI_APPLICATION = 'server.wsgi.application' 79 | 80 | 81 | # Database 82 | # https://docs.djangoproject.com/en/4.2/ref/settings/#databases 83 | 84 | DATABASES = { 85 | 'default': { 86 | 'ENGINE': 'django.db.backends.postgresql', 87 | 'NAME': config('POSTGRES_DB'), 88 | 'USER': config('POSTGRES_USER'), 89 | 'PASSWORD': config('POSTGRES_PASSWORD'), 90 | 'HOST': config('DJANGO_DATABASE_HOST'), 91 | 'PORT': config('DJANGO_DATABASE_PORT', cast=int), 92 | 'CONN_MAX_AGE': config('CONN_MAX_AGE', cast=int, default=60), 93 | 'OPTIONS': { 94 | 'connect_timeout': 10, 95 | 'options': '-c statement_timeout=15000ms', 96 | }, 97 | }, 98 | } 99 | 100 | 101 | # Internationalization 102 | # https://docs.djangoproject.com/en/4.2/topics/i18n/ 103 | 104 | LANGUAGE_CODE = 'ru' 105 | 106 | USE_I18N = True 107 | USE_L10N = True 108 | 109 | LANGUAGES = ( 110 | ('ru', _('Russian')), 111 | ) 112 | 113 | LOCALE_PATHS = ( 114 | 'locale/', 115 | ) 116 | 117 | USE_TZ = True 118 | TIME_ZONE = 'UTC' 119 | 120 | 121 | # Static files (CSS, JavaScript, Images) 122 | # https://docs.djangoproject.com/en/4.2/howto/static-files/ 123 | 124 | STATIC_URL = 'static/' 125 | 126 | 127 | # Templates 128 | # https://docs.djangoproject.com/en/4.2/ref/templates/api 129 | 130 | TEMPLATES = [{ 131 | 'APP_DIRS': True, 132 | 'BACKEND': 'django.template.backends.django.DjangoTemplates', 133 | 'DIRS': [ 134 | # Contains plain text templates, like `robots.txt`: 135 | BASE_DIR.joinpath('server', 'common', 'django', 'templates'), 136 | ], 137 | 'OPTIONS': { 138 | 'context_processors': [ 139 | # Default template context processors: 140 | 'django.contrib.auth.context_processors.auth', 141 | 'django.template.context_processors.debug', 142 | 'django.template.context_processors.i18n', 143 | 'django.template.context_processors.media', 144 | 'django.contrib.messages.context_processors.messages', 145 | 'django.template.context_processors.request', 146 | ], 147 | }, 148 | }] 149 | 150 | 151 | # Media files 152 | # Media root dir is commonly changed in production 153 | # (see development.py and production.py). 154 | # https://docs.djangoproject.com/en/4.2/topics/files/ 155 | 156 | MEDIA_URL = '/media/' 157 | MEDIA_ROOT = BASE_DIR.joinpath('media') 158 | 159 | 160 | # Security 161 | # https://docs.djangoproject.com/en/4.2/topics/security/ 162 | 163 | SESSION_COOKIE_HTTPONLY = True 164 | CSRF_COOKIE_HTTPONLY = True 165 | SECURE_CONTENT_TYPE_NOSNIFF = True 166 | SECURE_BROWSER_XSS_FILTER = True 167 | 168 | X_FRAME_OPTIONS = 'DENY' 169 | 170 | # https://github.com/DmytroLitvinov/django-http-referrer-policy 171 | # https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referrer-Policy 172 | REFERRER_POLICY = 'same-origin' 173 | 174 | # https://github.com/adamchainz/django-permissions-policy#setting 175 | PERMISSIONS_POLICY: dict[str, str | list[str]] = {} # noqa: WPS234 176 | 177 | 178 | # Default primary key field type 179 | # https://docs.djangoproject.com/en/4.2/ref/settings/#default-auto-field 180 | DEFAULT_AUTO_FIELD = 'django.db.models.AutoField' 181 | -------------------------------------------------------------------------------- /server/settings/components/csp.py: -------------------------------------------------------------------------------- 1 | """ 2 | This file contains a definition for Content-Security-Policy headers. 3 | 4 | Read more about it: 5 | https://developer.mozilla.org/ru/docs/Web/HTTP/Headers/Content-Security-Policy 6 | 7 | We are using `django-csp` to provide these headers. 8 | Docs: https://github.com/mozilla/django-csp 9 | """ 10 | 11 | # These settings are overriden during development: 12 | CSP_SCRIPT_SRC: tuple[str, ...] = ("'self'",) 13 | CSP_IMG_SRC: tuple[str, ...] = ("'self'", 'https://via.placeholder.com') 14 | CSP_FONT_SRC: tuple[str, ...] = ("'self'",) 15 | CSP_STYLE_SRC: tuple[str, ...] = ("'self'", 'https://cdn.simplecss.org') 16 | CSP_DEFAULT_SRC: tuple[str, ...] = ("'none'",) 17 | CSP_CONNECT_SRC: tuple[str, ...] = () 18 | -------------------------------------------------------------------------------- /server/settings/components/identity.py: -------------------------------------------------------------------------------- 1 | from django.urls import reverse_lazy 2 | 3 | # Django authentication system 4 | # https://docs.djangoproject.com/en/4.2/topics/auth/ 5 | 6 | AUTH_USER_MODEL = 'identity.User' 7 | 8 | AUTHENTICATION_BACKENDS = ( 9 | 'axes.backends.AxesBackend', 10 | 'django.contrib.auth.backends.ModelBackend', 11 | ) 12 | 13 | PASSWORD_HASHERS = [ 14 | 'django.contrib.auth.hashers.Argon2PasswordHasher', 15 | 'django.contrib.auth.hashers.PBKDF2PasswordHasher', 16 | 'django.contrib.auth.hashers.PBKDF2SHA1PasswordHasher', 17 | 'django.contrib.auth.hashers.BCryptSHA256PasswordHasher', 18 | ] 19 | 20 | 21 | # Login settings 22 | # https://docs.djangoproject.com/en/4.2/ref/settings/ 23 | 24 | LOGIN_URL = reverse_lazy('identity:login') 25 | LOGIN_REDIRECT_URL = reverse_lazy('pictures:dashboard') 26 | LOGOUT_REDIRECT_URL = reverse_lazy('index') 27 | 28 | 29 | # django-ratelimit 30 | # https://django-ratelimit.readthedocs.io/en/stable/ 31 | 32 | RATELIMIT_ENABLE = True 33 | 34 | 35 | # django-axes 36 | # https://django-axes.readthedocs.io/ 37 | 38 | AXES_LOCKOUT_PARAMETERS = ['username', 'user_agent'] 39 | AXES_RESET_ON_SUCCESS = True 40 | AXES_FAILURE_LIMIT = 5 41 | 42 | 43 | # django-password-reset 44 | # https://django-password-reset.readthedocs.io 45 | 46 | PASSWORD_RESET_TOKEN_EXPIRES = 3600 # one hour 47 | RECOVER_ONLY_ACTIVE_USERS = True 48 | -------------------------------------------------------------------------------- /server/settings/components/logging.py: -------------------------------------------------------------------------------- 1 | # Logging 2 | # https://docs.djangoproject.com/en/4.2/topics/logging/ 3 | 4 | # See also: 5 | # 'Do not log' by Nikita Sobolev (@sobolevn) 6 | # https://sobolevn.me/2020/03/do-not-log 7 | 8 | from typing import TYPE_CHECKING, Callable, final 9 | 10 | import structlog 11 | 12 | if TYPE_CHECKING: 13 | from django.http import HttpRequest, HttpResponse 14 | 15 | LOGGING = { 16 | 'version': 1, 17 | 'disable_existing_loggers': False, 18 | 19 | # We use these formatters in our `'handlers'` configuration. 20 | # Probably, you won't need to modify these lines. 21 | # Unless, you know what you are doing. 22 | 'formatters': { 23 | 'json_formatter': { 24 | '()': structlog.stdlib.ProcessorFormatter, 25 | 'processor': structlog.processors.JSONRenderer(), 26 | }, 27 | 'console': { 28 | '()': structlog.stdlib.ProcessorFormatter, 29 | 'processor': structlog.processors.KeyValueRenderer( 30 | key_order=['timestamp', 'level', 'event', 'logger'], 31 | ), 32 | }, 33 | }, 34 | 35 | # You can easily swap `key/value` (default) output and `json` ones. 36 | # Use `'json_console'` if you need `json` logs. 37 | 'handlers': { 38 | 'console': { 39 | 'class': 'logging.StreamHandler', 40 | 'formatter': 'console', 41 | }, 42 | 'json_console': { 43 | 'class': 'logging.StreamHandler', 44 | 'formatter': 'json_formatter', 45 | }, 46 | }, 47 | 48 | # These loggers are required by our app: 49 | # - django is required when using `logger.getLogger('django')` 50 | # - security is required by `axes` 51 | 'loggers': { 52 | 'django': { 53 | 'handlers': ['console'], 54 | 'propagate': True, 55 | 'level': 'INFO', 56 | }, 57 | 'security': { 58 | 'handlers': ['console'], 59 | 'level': 'ERROR', 60 | 'propagate': False, 61 | }, 62 | }, 63 | } 64 | 65 | 66 | @final 67 | class LoggingContextVarsMiddleware(object): 68 | """Used to reset ContextVars in structlog on each request.""" 69 | 70 | def __init__( 71 | self, 72 | get_response: 'Callable[[HttpRequest], HttpResponse]', 73 | ) -> None: 74 | """Django's API-compatible constructor.""" 75 | self.get_response = get_response 76 | 77 | def __call__(self, request: 'HttpRequest') -> 'HttpResponse': 78 | """ 79 | Handle requests. 80 | 81 | Add your logging metadata here. 82 | Example: https://github.com/jrobichaud/django-structlog 83 | """ 84 | response = self.get_response(request) 85 | structlog.contextvars.clear_contextvars() 86 | return response 87 | 88 | 89 | if not structlog.is_configured(): 90 | structlog.configure( 91 | processors=[ 92 | structlog.contextvars.merge_contextvars, 93 | structlog.stdlib.filter_by_level, 94 | structlog.processors.TimeStamper(fmt='iso'), 95 | structlog.stdlib.add_logger_name, 96 | structlog.stdlib.add_log_level, 97 | structlog.stdlib.PositionalArgumentsFormatter(), 98 | structlog.processors.StackInfoRenderer(), 99 | structlog.processors.format_exc_info, 100 | structlog.processors.UnicodeDecoder(), 101 | structlog.processors.ExceptionPrettyPrinter(), 102 | structlog.stdlib.ProcessorFormatter.wrap_for_formatter, 103 | ], 104 | logger_factory=structlog.stdlib.LoggerFactory(), 105 | wrapper_class=structlog.stdlib.BoundLogger, 106 | cache_logger_on_first_use=True, 107 | ) 108 | -------------------------------------------------------------------------------- /server/settings/components/placeholder.py: -------------------------------------------------------------------------------- 1 | # Custom settings for Placeholder API integration. 2 | # All settings must be documented! 3 | 4 | from server.settings.components import config 5 | 6 | # API url we use to fetch data, can be switched from real Placeholder API 7 | # to your custom one, that can be defined in `docker/placeholder`: 8 | PLACEHOLDER_API_URL = config('DJANGO_PLACEHOLDER_API_URL') 9 | 10 | # API default timeout in seconds: 11 | PLACEHOLDER_API_TIMEOUT = config('DJANGO_PLACEHOLDER_API_TIMEOUT', cast=int) 12 | -------------------------------------------------------------------------------- /server/settings/environments/__init__.py: -------------------------------------------------------------------------------- 1 | 2 | """Overriding settings based on the environment.""" 3 | -------------------------------------------------------------------------------- /server/settings/environments/development.py: -------------------------------------------------------------------------------- 1 | """ 2 | This file contains all the settings that defines the development server. 3 | 4 | SECURITY WARNING: don't run with debug turned on in production! 5 | """ 6 | 7 | import logging 8 | import socket 9 | from typing import TYPE_CHECKING 10 | 11 | from server.settings.components import config 12 | from server.settings.components.common import ( 13 | DATABASES, 14 | INSTALLED_APPS, 15 | MIDDLEWARE, 16 | ) 17 | from server.settings.components.csp import ( 18 | CSP_CONNECT_SRC, 19 | CSP_IMG_SRC, 20 | CSP_SCRIPT_SRC, 21 | ) 22 | 23 | if TYPE_CHECKING: 24 | from django.http import HttpRequest 25 | 26 | # Setting the development status: 27 | 28 | DEBUG = True 29 | 30 | ALLOWED_HOSTS = [ 31 | config('DOMAIN_NAME'), 32 | 'localhost', 33 | '0.0.0.0', # noqa: S104 34 | '127.0.0.1', 35 | '[::1]', 36 | ] 37 | 38 | 39 | # Installed apps for development only: 40 | 41 | INSTALLED_APPS += ( 42 | # Better debug: 43 | 'debug_toolbar', 44 | 'nplusone.ext.django', 45 | 46 | # Linting migrations: 47 | 'django_migration_linter', 48 | 49 | # django-test-migrations: 50 | 'django_test_migrations.contrib.django_checks.AutoNames', 51 | # This check might be useful in production as well, 52 | # so it might be a good idea to move `django-test-migrations` 53 | # to prod dependencies and use this check in the main `settings.py`. 54 | # This will check that your database is configured properly, 55 | # when you run `python manage.py check` before deploy. 56 | 'django_test_migrations.contrib.django_checks.DatabaseConfiguration', 57 | 58 | # django-extra-checks: 59 | 'extra_checks', 60 | ) 61 | 62 | 63 | # Django debug toolbar: 64 | # https://django-debug-toolbar.readthedocs.io 65 | 66 | MIDDLEWARE += ( 67 | 'debug_toolbar.middleware.DebugToolbarMiddleware', 68 | 69 | # https://github.com/bradmontgomery/django-querycount 70 | # Prints how many queries were executed, useful for the APIs. 71 | 'querycount.middleware.QueryCountMiddleware', 72 | ) 73 | 74 | # https://django-debug-toolbar.readthedocs.io/en/stable/installation.html#configure-internal-ips 75 | # This might fail on some OS 76 | try: # pragma: no cover 77 | INTERNAL_IPS = [ 78 | '{0}.1'.format(ip[:ip.rfind('.')]) 79 | for ip in socket.gethostbyname_ex(socket.gethostname())[2] 80 | ] 81 | except socket.error: # pragma: no cover 82 | INTERNAL_IPS = [] 83 | INTERNAL_IPS += ['127.0.0.1', '10.0.2.2'] 84 | 85 | 86 | def _custom_show_toolbar(request: 'HttpRequest') -> bool: 87 | """Only show the debug toolbar to users with the superuser flag.""" 88 | return DEBUG and request.user.is_superuser 89 | 90 | 91 | DEBUG_TOOLBAR_CONFIG = { 92 | 'SHOW_TOOLBAR_CALLBACK': 93 | 'server.settings.environments.development._custom_show_toolbar', 94 | } 95 | 96 | # This will make debug toolbar to work with django-csp, 97 | # since `ddt` loads some scripts from `ajax.googleapis.com`: 98 | CSP_SCRIPT_SRC += ('ajax.googleapis.com',) 99 | CSP_IMG_SRC += ('data:',) 100 | CSP_CONNECT_SRC += ("'self'",) 101 | 102 | 103 | # nplusone 104 | # https://github.com/jmcarp/nplusone 105 | 106 | # Should be the first in line: 107 | MIDDLEWARE = ( # noqa: WPS440 108 | 'nplusone.ext.django.NPlusOneMiddleware', 109 | ) + MIDDLEWARE 110 | 111 | # Logging N+1 requests: 112 | NPLUSONE_RAISE = True # comment out if you want to allow N+1 requests 113 | NPLUSONE_LOGGER = logging.getLogger('django') 114 | NPLUSONE_LOG_LEVEL = logging.WARN 115 | NPLUSONE_WHITELIST = [ 116 | {'model': 'admin.*'}, 117 | ] 118 | 119 | 120 | # django-test-migrations 121 | # https://github.com/wemake-services/django-test-migrations 122 | 123 | # Set of badly named migrations to ignore: 124 | DTM_IGNORED_MIGRATIONS = frozenset(( 125 | ('axes', '*'), 126 | )) 127 | 128 | 129 | # django-migration-linter 130 | # https://github.com/3YOURMIND/django-migration-linter 131 | 132 | MIGRATION_LINTER_OPTIONS = { 133 | 'exclude_apps': ['axes'], 134 | 'exclude_migration_tests': ['CREATE_INDEX', 'CREATE_INDEX_EXCLUSIVE'], 135 | } 136 | 137 | 138 | # django-extra-checks 139 | # https://github.com/kalekseev/django-extra-checks 140 | 141 | EXTRA_CHECKS = { 142 | 'checks': [ 143 | # Forbid `unique_together`: 144 | 'no-unique-together', 145 | # Use the indexes option instead: 146 | 'no-index-together', 147 | # Each model must be registered in admin: 148 | 'model-admin', 149 | # FileField/ImageField must have non empty `upload_to` argument: 150 | 'field-file-upload-to', 151 | # Text fields shouldn't use `null=True`: 152 | 'field-text-null', 153 | # Don't pass `null=False` to model fields (this is django default) 154 | 'field-null', 155 | # ForeignKey fields must specify db_index explicitly if used in 156 | # other indexes: 157 | {'id': 'field-foreign-key-db-index', 'when': 'indexes'}, 158 | # If field nullable `(null=True)`, 159 | # then default=None argument is redundant and should be removed: 160 | 'field-default-null', 161 | # Fields with choices must have companion CheckConstraint 162 | # to enforce choices on database level 163 | 'field-choices-constraint', 164 | ], 165 | } 166 | 167 | # Disable persistent DB connections 168 | # https://docs.djangoproject.com/en/4.2/ref/databases/#caveats 169 | DATABASES['default']['CONN_MAX_AGE'] = 0 170 | -------------------------------------------------------------------------------- /server/settings/environments/local.py.template: -------------------------------------------------------------------------------- 1 | """Override any custom settings here.""" 2 | -------------------------------------------------------------------------------- /server/settings/environments/production.py: -------------------------------------------------------------------------------- 1 | """ 2 | This file contains all the settings used in production. 3 | 4 | This file is required and if development.py is present these 5 | values are overridden. 6 | """ 7 | 8 | from server.settings.components import config 9 | 10 | # Production flags: 11 | # https://docs.djangoproject.com/en/4.2/howto/deployment/ 12 | 13 | DEBUG = False 14 | 15 | ALLOWED_HOSTS = [ 16 | # TODO: check production hosts 17 | config('DOMAIN_NAME'), 18 | 19 | # We need this value for `healthcheck` to work: 20 | 'localhost', 21 | ] 22 | 23 | 24 | # Staticfiles 25 | # https://docs.djangoproject.com/en/4.2/ref/contrib/staticfiles/ 26 | 27 | # This is a hack to allow a special flag to be used with `--dry-run` 28 | # to test things locally. 29 | _COLLECTSTATIC_DRYRUN = config( 30 | 'DJANGO_COLLECTSTATIC_DRYRUN', cast=bool, default=False, 31 | ) 32 | # Adding STATIC_ROOT to collect static files via 'collectstatic': 33 | STATIC_ROOT = '.static' if _COLLECTSTATIC_DRYRUN else '/var/www/django/static' 34 | 35 | STATICFILES_STORAGE = ( 36 | # This is a string, not a tuple, 37 | # but it does not fit into 80 characters rule. 38 | 'django.contrib.staticfiles.storage.ManifestStaticFilesStorage' 39 | ) 40 | 41 | 42 | # Media files 43 | # https://docs.djangoproject.com/en/4.2/topics/files/ 44 | 45 | MEDIA_ROOT = '/var/www/django/media' 46 | 47 | 48 | # Password validation 49 | # https://docs.djangoproject.com/en/4.2/ref/settings/#auth-password-validators 50 | 51 | _PASS = 'django.contrib.auth.password_validation' # noqa: S105 52 | AUTH_PASSWORD_VALIDATORS = [ 53 | {'NAME': '{0}.UserAttributeSimilarityValidator'.format(_PASS)}, 54 | {'NAME': '{0}.MinimumLengthValidator'.format(_PASS)}, 55 | {'NAME': '{0}.CommonPasswordValidator'.format(_PASS)}, 56 | {'NAME': '{0}.NumericPasswordValidator'.format(_PASS)}, 57 | ] 58 | 59 | 60 | # Security 61 | # https://docs.djangoproject.com/en/4.2/topics/security/ 62 | 63 | SECURE_HSTS_SECONDS = 31536000 # the same as Caddy has 64 | SECURE_HSTS_INCLUDE_SUBDOMAINS = True 65 | SECURE_HSTS_PRELOAD = True 66 | 67 | SECURE_PROXY_SSL_HEADER = ('HTTP_X_FORWARDED_PROTO', 'https') 68 | SECURE_SSL_REDIRECT = True 69 | SECURE_REDIRECT_EXEMPT = [ 70 | # This is required for healthcheck to work: 71 | '^health/', 72 | ] 73 | 74 | SESSION_COOKIE_SECURE = True 75 | CSRF_COOKIE_SECURE = True 76 | -------------------------------------------------------------------------------- /server/urls.py: -------------------------------------------------------------------------------- 1 | """ 2 | Main URL mapping configuration file. 3 | 4 | Include other URLConfs from external apps using method `include()`. 5 | 6 | It is also a good practice to keep a single URL to the root index page. 7 | 8 | This examples uses Django's default media 9 | files serving technique in development. 10 | """ 11 | 12 | from django.conf import settings 13 | from django.contrib import admin 14 | from django.contrib.admindocs import urls as admindocs_urls 15 | from django.urls import include, path 16 | from django.views.generic import TemplateView 17 | from health_check import urls as health_urls 18 | 19 | from server.apps.identity import urls as identity_urls 20 | from server.apps.pictures import urls as pictures_urls 21 | from server.apps.pictures.views import IndexView 22 | 23 | admin.autodiscover() 24 | 25 | urlpatterns = [ 26 | # Apps: 27 | path('pictures/', include(pictures_urls, namespace='pictures')), 28 | path('identity/', include(identity_urls, namespace='identity')), 29 | 30 | # Health checks: 31 | path('health/', include(health_urls)), 32 | 33 | # django-admin: 34 | path('admin/doc/', include(admindocs_urls)), 35 | path('admin/', admin.site.urls), 36 | 37 | # Text and xml static files: 38 | path('robots.txt', TemplateView.as_view( 39 | template_name='common/txt/robots.txt', 40 | content_type='text/plain', 41 | )), 42 | path('humans.txt', TemplateView.as_view( 43 | template_name='common/txt/humans.txt', 44 | content_type='text/plain', 45 | )), 46 | 47 | # It is a good practice to have an explicit index view: 48 | path('', IndexView.as_view(), name='index'), 49 | ] 50 | 51 | if settings.DEBUG: # pragma: no cover 52 | import debug_toolbar # noqa: WPS433 53 | from django.conf.urls.static import static # noqa: WPS433 54 | 55 | urlpatterns = [ 56 | # URLs specific only to django-debug-toolbar: 57 | path('__debug__/', include(debug_toolbar.urls)), 58 | *urlpatterns, 59 | # Serving media files in development only: 60 | *static(settings.MEDIA_URL, document_root=settings.MEDIA_ROOT), 61 | ] 62 | -------------------------------------------------------------------------------- /server/wsgi.py: -------------------------------------------------------------------------------- 1 | """ 2 | WSGI config for server project. 3 | 4 | It exposes the WSGI callable as a module-level variable named ``application``. 5 | 6 | For more information on this file, see 7 | https://docs.djangoproject.com/en/4.2/howto/deployment/wsgi/ 8 | """ 9 | 10 | import os 11 | 12 | from django.core.wsgi import get_wsgi_application 13 | 14 | os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'server.settings') 15 | application = get_wsgi_application() 16 | -------------------------------------------------------------------------------- /setup.cfg: -------------------------------------------------------------------------------- 1 | # All configuration for plugins and other utils is defined here. 2 | # Read more about `setup.cfg`: 3 | # https://docs.python.org/3/distutils/configfile.html 4 | 5 | 6 | [flake8] 7 | # flake8 configuration: 8 | # https://flake8.pycqa.org/en/latest/user/configuration.html 9 | format = wemake 10 | show-source = true 11 | statistics = false 12 | doctests = true 13 | enable-extensions = G 14 | 15 | # darglint configuration: 16 | # https://github.com/terrencepreilly/darglint 17 | strictness = long 18 | docstring-style = numpy 19 | 20 | # Flake plugins: 21 | max-line-length = 80 22 | max-complexity = 6 23 | max-imports = 14 24 | 25 | # Excluding some directories: 26 | exclude = .git,__pycache__,.venv,.eggs,*.egg,frontend,landing 27 | 28 | # Disable some pydocstyle checks: 29 | ignore = D100, D104, D106, D401, X100, W504, RST303, RST304, DAR103, DAR203 30 | 31 | # Docs: https://github.com/snoack/flake8-per-file-ignores 32 | # You can completely or partially disable our custom checks, 33 | # to do so you have to ignore `WPS` letters for all python files: 34 | per-file-ignores = 35 | # Allow upper-case constants in classes, because it is settings: 36 | server/common/django/types.py: WPS115 37 | # Allow `__init__.py` with logic for configuration: 38 | server/settings/*.py: WPS226, WPS407, WPS412, WPS432 39 | # Allow to have magic numbers and wrong module names inside migrations: 40 | server/*/migrations/*.py: WPS102, WPS114, WPS432 41 | # Tests have some more freedom: 42 | tests/*.py: S101, WPS201, WPS202, WPS218, WPS226, WPS436, WPS442 43 | 44 | 45 | [isort] 46 | # isort configuration: 47 | # https://github.com/PyCQA/isort/wiki/isort-Settings 48 | profile = wemake 49 | 50 | 51 | [tool:pytest] 52 | # pytest configuration: 53 | # https://docs.pytest.org/en/stable/customize.html 54 | 55 | # pytest-django configuration: 56 | # https://pytest-django.readthedocs.io/en/latest/ 57 | DJANGO_SETTINGS_MODULE = server.settings 58 | 59 | # Timeout for tests, so they can not take longer 60 | # than this amount of seconds. 61 | # You should adjust this value to be as low as possible. 62 | # Configuration: 63 | # https://pypi.org/project/pytest-timeout/ 64 | timeout = 5 65 | 66 | # Strict `@xfail` by default: 67 | xfail_strict = true 68 | 69 | # Directories that are not visited by pytest collector: 70 | norecursedirs = *.egg .eggs dist build docs .tox .git __pycache__ frontend landing 71 | 72 | # You will need to measure your tests speed with `-n auto` and without it, 73 | # so you can see whether it gives you any performance gain, or just gives 74 | # you an overhead. See `docs/template/development-process.rst`. 75 | addopts = 76 | --strict-markers 77 | --strict-config 78 | --doctest-modules 79 | --fail-on-template-vars 80 | # Output: 81 | --tb=short 82 | # Parallelism: 83 | # -n auto 84 | # --boxed 85 | # Coverage: 86 | --cov=server 87 | --cov=tests 88 | --cov-branch 89 | --cov-report=term-missing:skip-covered 90 | --cov-report=html 91 | --cov-report=xml 92 | --cov-fail-under=0 93 | 94 | filterwarnings = 95 | # TODO: get rid of these warnings in our code: 96 | ignore::django.utils.deprecation.RemovedInDjango50Warning 97 | ignore::django.utils.deprecation.RemovedInDjango51Warning 98 | # Some dependencies have deprecation warnings, we don't want to see them, 99 | # but, we want to list them here: 100 | ignore::DeprecationWarning:password_reset.*: 101 | ignore::DeprecationWarning:pytest_freezegun: 102 | 103 | 104 | [coverage:run] 105 | # Coverage configuration: 106 | # https://coverage.readthedocs.io/en/latest/config.html 107 | plugins = 108 | # Docs: https://github.com/nedbat/django_coverage_plugin 109 | django_coverage_plugin 110 | # Docs: https://pypi.org/project/covdefaults 111 | covdefaults 112 | 113 | omit = 114 | # Is not reported, because is imported during setup: 115 | server/settings/components/logging.py 116 | 117 | 118 | [mypy] 119 | # Mypy configuration: 120 | # https://mypy.readthedocs.io/en/latest/config_file.html 121 | enable_error_code = 122 | truthy-bool, 123 | truthy-iterable, 124 | redundant-expr, 125 | unused-awaitable, 126 | ignore-without-code, 127 | possibly-undefined, 128 | redundant-self, 129 | 130 | extra_checks = true 131 | 132 | disable_error_code = 133 | literal-required, 134 | 135 | enable_incomplete_feature = 136 | Unpack, 137 | 138 | allow_redefinition = false 139 | check_untyped_defs = true 140 | disallow_untyped_decorators = true 141 | disallow_any_explicit = false 142 | disallow_any_generics = true 143 | disallow_untyped_calls = true 144 | disallow_incomplete_defs = true 145 | explicit_package_bases = true 146 | ignore_errors = false 147 | ignore_missing_imports = true 148 | implicit_reexport = false 149 | local_partial_types = true 150 | strict_optional = true 151 | strict_equality = true 152 | no_implicit_optional = true 153 | warn_unused_ignores = true 154 | warn_redundant_casts = true 155 | warn_unused_configs = true 156 | warn_unreachable = true 157 | warn_no_return = true 158 | 159 | plugins = 160 | mypy_django_plugin.main, 161 | pydantic.mypy 162 | 163 | [mypy-server.apps.*.migrations.*] 164 | # Django migrations should not produce any errors (they are tested anyway): 165 | ignore_errors = true 166 | 167 | [mypy.plugins.django-stubs] 168 | # Docs: https://github.com/typeddjango/django-stubs 169 | django_settings_module = server.settings 170 | strict_settings = false 171 | 172 | 173 | [doc8] 174 | # doc8 configuration: 175 | # https://github.com/pycqa/doc8 176 | ignore-path = docs/_build 177 | max-line-length = 80 178 | sphinx = true 179 | -------------------------------------------------------------------------------- /tests/conftest.py: -------------------------------------------------------------------------------- 1 | """ 2 | This module is used to provide configuration, fixtures, and plugins for pytest. 3 | 4 | It may be also used for extending doctest's context: 5 | 1. https://docs.python.org/3/library/doctest.html 6 | 2. https://docs.pytest.org/en/latest/doctest.html 7 | """ 8 | 9 | pytest_plugins = [ 10 | # Should be the first custom one: 11 | 'plugins.django_settings', 12 | 13 | # TODO: add your own plugins here! 14 | ] 15 | -------------------------------------------------------------------------------- /tests/plugins/django_settings.py: -------------------------------------------------------------------------------- 1 | import pytest 2 | from django.conf import LazySettings 3 | from django.core.cache import BaseCache, caches 4 | 5 | 6 | @pytest.fixture(autouse=True) 7 | def _media_root( 8 | settings: LazySettings, 9 | tmpdir_factory: pytest.TempPathFactory, 10 | ) -> None: 11 | """Forces django to save media files into temp folder.""" 12 | settings.MEDIA_ROOT = tmpdir_factory.mktemp('media', numbered=True) 13 | 14 | 15 | @pytest.fixture(autouse=True) 16 | def _password_hashers(settings: LazySettings) -> None: 17 | """Forces django to use fast password hashers for tests.""" 18 | settings.PASSWORD_HASHERS = [ 19 | 'django.contrib.auth.hashers.MD5PasswordHasher', 20 | ] 21 | 22 | 23 | @pytest.fixture(autouse=True) 24 | def _auth_backends(settings: LazySettings) -> None: 25 | """Deactivates security backend from Axes app.""" 26 | settings.AUTHENTICATION_BACKENDS = ( 27 | 'django.contrib.auth.backends.ModelBackend', 28 | ) 29 | 30 | 31 | @pytest.fixture(autouse=True) 32 | def _debug(settings: LazySettings) -> None: 33 | """Sets proper DEBUG and TEMPLATE debug mode for coverage.""" 34 | settings.DEBUG = False 35 | for template in settings.TEMPLATES: 36 | template['OPTIONS']['debug'] = True 37 | 38 | 39 | @pytest.fixture(autouse=True) 40 | def cache(settings: LazySettings) -> BaseCache: 41 | """Modifies how cache is used in Django tests.""" 42 | test_cache = 'test' 43 | 44 | # Patching cache settings: 45 | settings.CACHES[test_cache] = { 46 | 'BACKEND': 'django.core.cache.backends.locmem.LocMemCache', 47 | } 48 | settings.RATELIMIT_USE_CACHE = test_cache 49 | settings.AXES_CACHE = test_cache 50 | 51 | # Clearing cache: 52 | caches[test_cache].clear() 53 | return caches[test_cache] 54 | -------------------------------------------------------------------------------- /tests/plugins/identity/.gitkeep: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tough-dev-school/python-testing-homework/352aa9b27d17d25f9aa6d67ddb4bec03503ae326/tests/plugins/identity/.gitkeep -------------------------------------------------------------------------------- /tests/plugins/pictures/.gitkeep: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tough-dev-school/python-testing-homework/352aa9b27d17d25f9aa6d67ddb4bec03503ae326/tests/plugins/pictures/.gitkeep -------------------------------------------------------------------------------- /tests/test_apps/test_identity/.gitkeep: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tough-dev-school/python-testing-homework/352aa9b27d17d25f9aa6d67ddb4bec03503ae326/tests/test_apps/test_identity/.gitkeep -------------------------------------------------------------------------------- /tests/test_apps/test_pictures/.gitkeep: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tough-dev-school/python-testing-homework/352aa9b27d17d25f9aa6d67ddb4bec03503ae326/tests/test_apps/test_pictures/.gitkeep -------------------------------------------------------------------------------- /tests/test_server/test_urls.py: -------------------------------------------------------------------------------- 1 | from http import HTTPStatus 2 | 3 | import pytest 4 | from django.test import Client 5 | 6 | 7 | @pytest.mark.django_db() 8 | def test_health_check(client: Client) -> None: 9 | """This test ensures that health check is accessible.""" 10 | response = client.get('/health/') 11 | 12 | assert response.status_code == HTTPStatus.OK 13 | 14 | 15 | def test_admin_unauthorized(client: Client) -> None: 16 | """This test ensures that admin panel requires auth.""" 17 | response = client.get('/admin/') 18 | 19 | assert response.status_code == HTTPStatus.FOUND 20 | 21 | 22 | @pytest.mark.django_db() 23 | def test_admin_authorized(admin_client: Client) -> None: 24 | """This test ensures that admin panel is accessible.""" 25 | response = admin_client.get('/admin/') 26 | 27 | assert response.status_code == HTTPStatus.OK 28 | 29 | 30 | def test_admin_docs_unauthorized(client: Client) -> None: 31 | """This test ensures that admin panel docs requires auth.""" 32 | response = client.get('/admin/doc/') 33 | 34 | assert response.status_code == HTTPStatus.FOUND 35 | 36 | 37 | @pytest.mark.django_db() 38 | def test_admin_docs_authorized(admin_client: Client) -> None: 39 | """This test ensures that admin panel docs are accessible.""" 40 | response = admin_client.get('/admin/doc/') 41 | 42 | assert response.status_code == HTTPStatus.OK 43 | assert b'docutils' not in response.content 44 | 45 | 46 | @pytest.mark.parametrize('page', [ 47 | '/robots.txt', 48 | '/humans.txt', 49 | ]) 50 | def test_specials_txt(client: Client, page: str) -> None: 51 | """This test ensures that special `txt` files are accessible.""" 52 | response = client.get(page) 53 | 54 | assert response.status_code == HTTPStatus.OK 55 | assert response.get('Content-Type') == 'text/plain' 56 | --------------------------------------------------------------------------------