PyInventory 0.19.0__py3-none-any.whl

inventory_project/settings/prod.py

@@ -0,0 +1,393 @@
+"""
+    Base Django settings
+"""
+
+import logging
+from pathlib import Path as __Path
+
+from ckeditor.configs import DEFAULT_CONFIG
+from django.utils.translation import gettext_lazy as _
+
+
+###############################################################################
+
+# Build paths relative to the project root:
+BASE_PATH = __Path(__file__).parent.parent.parent
+print(f'BASE_PATH:{BASE_PATH}')
+assert __Path(BASE_PATH, 'inventory_project').is_dir()
+
+###############################################################################
+# PyInventory:
+
+# Max length of Item/Location "path name" in change list:
+TREE_PATH_STR_MAX_LENGTH = 70
+
+###############################################################################
+
+
+# SECURITY WARNING: don't run with debug turned on in production!
+DEBUG = False
+
+# Serve static/media files by Django?
+# In production the Webserver should serve this!
+SERVE_FILES = False
+
+
+# SECURITY WARNING: keep the secret key used in production secret!
+__SECRET_FILE = __Path(BASE_PATH, 'secret.txt').resolve()
+if not __SECRET_FILE.is_file():
+    print(f'Generate {__SECRET_FILE}')
+    from secrets import token_urlsafe as __token_urlsafe
+
+    __SECRET_FILE.open('w').write(__token_urlsafe(128))
+
+SECRET_KEY = __SECRET_FILE.open('r').read().strip()
+
+
+# Application definition
+
+INSTALLED_APPS = [
+    'django.contrib.admin',
+    'django.contrib.auth',
+    'django.contrib.contenttypes',
+    'django.contrib.sessions',
+    'django.contrib.messages',
+    'django.contrib.staticfiles',
+    'bx_django_utils',  # https://github.com/boxine/bx_django_utils
+    'import_export',  # https://github.com/django-import-export/django-import-export
+    'dbbackup',  # https://github.com/django-dbbackup/django-dbbackup
+    'ckeditor',  # https://github.com/django-ckeditor/django-ckeditor
+    'ckeditor_uploader',  # https://github.com/django-ckeditor/django-ckeditor
+    'reversion',  # https://github.com/etianen/django-reversion
+    'reversion_compare',  # https://github.com/jedie/django-reversion-compare
+    'tagulous',  # https://github.com/radiac/django-tagulous
+    'adminsortable2',  # https://github.com/jrief/django-admin-sortable2
+    # https://github.com/jedie/django-tools/tree/master/django_tools/serve_media_app
+    'django_tools.serve_media_app.apps.UserMediaFilesConfig',
+    # https://github.com/jedie/django-tools/tree/master/django_tools/model_version_protect
+    'django_tools.model_version_protect.apps.ModelVersionProtectConfig',
+    'inventory.apps.InventoryConfig',
+]
+
+ROOT_URLCONF = 'inventory_project.urls'
+WSGI_APPLICATION = 'inventory_project.wsgi.application'
+
+AUTHENTICATION_BACKENDS = [
+    'django.contrib.auth.backends.ModelBackend',
+]
+
+MIDDLEWARE = [
+    'django.contrib.sessions.middleware.SessionMiddleware',
+    'django.middleware.locale.LocaleMiddleware',
+    'django.middleware.common.CommonMiddleware',
+    'django.middleware.csrf.CsrfViewMiddleware',
+    'django.contrib.auth.middleware.AuthenticationMiddleware',
+    'inventory.middlewares.RequestDictMiddleware',
+    'django.contrib.messages.middleware.MessageMiddleware',
+    'django.middleware.clickjacking.XFrameOptionsMiddleware',
+    'django.middleware.security.SecurityMiddleware',
+]
+
+__TEMPLATE_DIR = __Path(BASE_PATH, 'inventory_project', 'templates')
+assert __TEMPLATE_DIR.is_dir(), f'Directory not exists: {__TEMPLATE_DIR}'
+TEMPLATES = [
+    {
+        'BACKEND': 'django.template.backends.django.DjangoTemplates',
+        "DIRS": [str(__TEMPLATE_DIR)],
+        'APP_DIRS': True,
+        'OPTIONS': {
+            'context_processors': [
+                'django.contrib.auth.context_processors.auth',
+                'django.contrib.messages.context_processors.messages',
+                'django.template.context_processors.i18n',
+                'django.template.context_processors.debug',
+                'django.template.context_processors.request',
+                'django.template.context_processors.media',
+                'django.template.context_processors.csrf',
+                'django.template.context_processors.tz',
+                'django.template.context_processors.static',
+                'inventory.context_processors.inventory_version_string',
+            ],
+        },
+    },
+]
+
+# _____________________________________________________________________________
+
+DEFAULT_AUTO_FIELD = 'django.db.models.AutoField'
+
+# _____________________________________________________________________________
+
+# Mark CSRF cookie as "secure" -> browsers sent cookie only with an HTTPS connection:
+CSRF_COOKIE_SECURE = True
+
+# Mark session cookie as "secure" -> browsers sent cookie only with an HTTPS connection:
+SESSION_COOKIE_SECURE = True
+
+# HTTP header/value combination that signifies a request is secure
+# Your nginx.conf must set "X-Forwarded-Protocol" proxy header!
+SECURE_PROXY_SSL_HEADER = ('HTTP_X_FORWARDED_PROTOCOL', 'https')
+
+# SecurityMiddleware should redirects all non-HTTPS requests to HTTPS:
+SECURE_SSL_REDIRECT = True
+
+# SecurityMiddleware should preload directive to the HTTP Strict Transport Security header:
+SECURE_HSTS_PRELOAD = True
+
+# Instruct modern browsers to refuse to connect to your domain name via an insecure connection:
+SECURE_HSTS_SECONDS = 3600
+
+# SecurityMiddleware should add the "includeSubDomains" directive to the Strict-Transport-Security
+# header: All subdomains of your domain should be served exclusively via SSL!
+SECURE_HSTS_INCLUDE_SUBDOMAINS = True
+
+# _____________________________________________________________________________
+# Internationalization
+
+LANGUAGE_CODE = 'en'
+
+LANGUAGES = [('ca', _('Catalan')), ('de', _('German')), ('en', _('English')), ('es', _('Spanish'))]
+USE_I18N = True
+USE_L10N = True
+TIME_ZONE = 'Europe/Paris'
+USE_TZ = True
+
+# _____________________________________________________________________________
+# Static files (CSS, JavaScript, Images)
+
+STATIC_URL = '/static/'
+STATIC_ROOT = str(__Path(BASE_PATH, 'static'))
+
+MEDIA_URL = '/media/'
+MEDIA_ROOT = str(__Path(BASE_PATH, 'media'))
+
+# _____________________________________________________________________________
+# Cache Backend
+
+CACHES = {
+    'default': {
+        'BACKEND': 'django.core.cache.backends.locmem.LocMemCache',
+        'LOCATION': 'unique-snowflake',
+    }
+}
+
+# _____________________________________________________________________________
+# Django-dbbackup
+
+DBBACKUP_STORAGE = 'django.core.files.storage.FileSystemStorage'
+DBBACKUP_STORAGE_OPTIONS = {'location': str(__Path(BASE_PATH, 'backups'))}
+
+# _____________________________________________________________________________
+# django-ckeditor
+
+CKEDITOR_BASEPATH = STATIC_URL + 'ckeditor/ckeditor/'
+CKEDITOR_FILENAME_GENERATOR = 'inventory.ckeditor_upload.get_filename'
+CKEDITOR_DEFAULT_CONFIG = DEFAULT_CONFIG
+CKEDITOR_DEFAULT_CONFIG.update(
+    {
+        'removeButtons': 'Language,Cut,Copy,Paste,Undo,Redo,Anchor',
+        # plugins are here: .../site-packages/ckeditor/static/ckeditor/ckeditor/plugins
+        # and here: https://github.com/ckeditor/ckeditor4/tree/major/plugins
+        # See also: .../site-packages/ckeditor/static/ckeditor/ckeditor/build-config.js
+        'removePlugins': (
+            # Generated with devshell command:
+            # (inventory) ckeditor_info
+            'a11yhelp',
+            # 'about',
+            'adobeair',
+            'ajax',
+            'autoembed',
+            # 'autogrow',
+            'autolink',
+            # 'basicstyles',
+            'bbcode',
+            'bidi',
+            # 'blockquote',
+            'clipboard',
+            'codesnippet',
+            'codesnippetgeshi',
+            # 'colorbutton',
+            # 'colordialog',
+            'contextmenu',
+            'copyformatting',
+            'devtools',
+            'dialog',
+            'dialogadvtab',
+            'div',
+            'divarea',
+            'docprops',
+            # 'elementspath',
+            'embed',
+            'embedbase',
+            'embedsemantic',
+            'enterkey',
+            # 'entities',
+            'exportpdf',
+            # 'filebrowser',
+            # 'filetools',
+            'find',
+            'flash',
+            # 'floatingspace',
+            # 'font',
+            # 'format',
+            'forms',
+            # 'horizontalrule',
+            'htmlwriter',
+            'iframe',
+            'iframedialog',
+            # 'image',
+            # 'image2',
+            # 'indentblock',
+            # 'indentlist',
+            # 'justify',
+            'language',
+            # 'lineutils',
+            # 'link',
+            # 'list',
+            # 'liststyle',
+            'magicline',
+            'mathjax',
+            # 'maximize',
+            # 'menubutton',
+            'newpage',
+            'notification',
+            'notificationaggregator',
+            'pagebreak',
+            'pastefromgdocs',
+            'pastefromword',
+            'pastetext',
+            'pastetools',
+            'placeholder',
+            'preview',
+            'print',
+            # 'removeformat',
+            # 'resize',
+            'save',
+            'scayt',
+            'selectall',
+            'sharedspace',
+            # 'showblocks',
+            # 'showborders',
+            'smiley',
+            # 'sourcearea',
+            'sourcedialog',
+            'specialchar',
+            'stylescombo',
+            'stylesheetparser',
+            'tab',
+            # 'table',
+            # 'tableresize',
+            # 'tableselection',
+            # 'tabletools',
+            'templates',
+            # 'toolbar',
+            'uicolor',
+            # 'undo',
+            # 'uploadimage',
+            # 'uploadwidget',
+            'widget',
+            'wsc',
+            # 'wysiwygarea',
+            'xml',
+        ),
+        'toolbar_PyInventoryToolbarConfig': [
+            {'name': 'basicstyles', 'items': ['Bold', 'Italic', 'Underline', 'Strike', '-', 'RemoveFormat']},
+            {
+                'name': 'paragraph',
+                'items': [
+                    'NumberedList',
+                    'BulletedList',
+                    '-',
+                    'Outdent',
+                    'Indent',
+                    '-',
+                    'Blockquote',
+                    '-',
+                    'JustifyLeft',
+                    'JustifyCenter',
+                    'JustifyRight',
+                    'JustifyBlock',
+                ],
+            },
+            {'name': 'links', 'items': ['Link', 'Unlink', 'Anchor']},
+            {'name': 'insert', 'items': ['Image', 'Table', 'HorizontalRule']},
+            '/',
+            {'name': 'styles', 'items': ['Styles', 'Format', 'Font', 'FontSize']},
+            {'name': 'colors', 'items': ['TextColor', 'BGColor']},
+            {'name': 'tools', 'items': ['Maximize', 'ShowBlocks', 'Source']},
+            {'name': 'about', 'items': ['About']},
+        ],
+        'toolbar': 'PyInventoryToolbarConfig',
+        'height': '25em',
+        'width': '100%',
+    }
+)
+CKEDITOR_CONFIGS = {
+    'ItemModel.description': CKEDITOR_DEFAULT_CONFIG,
+    'LocationModel.description': CKEDITOR_DEFAULT_CONFIG,
+    'MemoModel.description': CKEDITOR_DEFAULT_CONFIG,
+}
+CKEDITOR_RESTRICT_BY_USER = True
+CKEDITOR_RESTRICT_BY_DATE = True
+CKEDITOR_UPLOAD_PATH = 'uploads/'
+CKEDITOR_IMAGE_BACKEND = 'pillow'
+CKEDITOR_THUMBNAIL_SIZE = (300, 300)
+CKEDITOR_IMAGE_QUALITY = 40
+CKEDITOR_BROWSE_SHOW_DIRS = True
+CKEDITOR_ALLOW_NONIMAGE_FILES = True
+
+# _____________________________________________________________________________
+# http://radiac.net/projects/django-tagulous/documentation/installation/#settings
+
+TAGULOUS_NAME_MAX_LENGTH = 255
+TAGULOUS_SLUG_MAX_LENGTH = 50
+TAGULOUS_LABEL_MAX_LENGTH = TAGULOUS_NAME_MAX_LENGTH
+TAGULOUS_SLUG_TRUNCATE_UNIQUE = 5
+TAGULOUS_SLUG_ALLOW_UNICODE = False
+
+SERIALIZATION_MODULES = {
+    'xml': 'tagulous.serializers.xml_serializer',
+    'json': 'tagulous.serializers.json',
+    'python': 'tagulous.serializers.python',
+    'yaml': 'tagulous.serializers.pyyaml',
+}
+
+# _____________________________________________________________________________
+# cut 'pathname' in log output
+
+old_factory = logging.getLogRecordFactory()
+
+
+def cut_path(pathname, max_length):
+    if len(pathname) <= max_length:
+        return pathname
+    return f'...{pathname[-(max_length - 3):]}'
+
+
+def record_factory(*args, **kwargs):
+    record = old_factory(*args, **kwargs)
+    record.cut_path = cut_path(record.pathname, 30)
+    return record
+
+
+logging.setLogRecordFactory(record_factory)
+
+# -----------------------------------------------------------------------------
+
+LOGGING = {
+    'version': 1,
+    'disable_existing_loggers': True,
+    'formatters': {
+        'colored': {  # https://github.com/borntyping/python-colorlog
+            '()': 'colorlog.ColoredFormatter',
+            'format': '%(log_color)s%(asctime)s %(levelname)8s %(cut_path)s:%(lineno)-3s %(message)s',
+        }
+    },
+    'handlers': {'console': {'class': 'colorlog.StreamHandler', 'formatter': 'colored'}},
+    'loggers': {
+        '': {'handlers': ['console'], 'level': 'DEBUG', 'propagate': False},
+        'django': {'handlers': ['console'], 'level': 'INFO', 'propagate': False},
+        'django_tools': {'handlers': ['console'], 'level': 'INFO', 'propagate': False},
+        'inventory': {'handlers': ['console'], 'level': 'DEBUG', 'propagate': False},
+    },
+}

inventory_project/settings/tests.py

@@ -0,0 +1,45 @@
+# flake8: noqa: E405
+"""
+    Settings used to run tests
+"""
+import os
+
+from inventory_project.settings.prod import *  # noqa
+
+
+# _____________________________________________________________________________
+# Manage Django Project
+
+INSTALLED_APPS.append('manage_django_project')
+
+# _____________________________________________________________________________
+
+
+DATABASES = {
+    'default': {
+        'ENGINE': 'django.db.backends.sqlite3',
+        'NAME': ':memory:',
+    }
+}
+
+DEBUG = True
+
+# Speedup tests by change the Password hasher:
+PASSWORD_HASHERS = ('django.contrib.auth.hashers.MD5PasswordHasher',)
+
+# _____________________________________________________________________________
+
+
+# All tests should use django-override-storage!
+# Set root to not existing path, so that wrong tests will fail:
+STATIC_ROOT = '/not/exists/static/'
+MEDIA_ROOT = '/not/exists/media/'
+
+
+# _____________________________________________________________________________
+# Playwright
+# Avoid django.core.exceptions.SynchronousOnlyOperation. Playwright uses an event loop,
+# even when using he sync API. Django only checks whether _any_ event loop is running,
+# but not if _itself_ is running in an even loop.
+# see https://github.com/microsoft/playwright-python/issues/439#issuecomment-763339612.
+os.environ.setdefault('DJANGO_ALLOW_ASYNC_UNSAFE', '1')

inventory_project/templates/admin/base_site.html

@@ -0,0 +1,22 @@
+{% extends "admin/base.html" %}
+{% load i18n static %}
+
+{% block extrahead %}{{ block.super }}
+    <meta name="google" content="notranslate">
+    <meta name="robots" content="noindex,nofollow" />
+    <link rel="stylesheet" type="text/css" href="{% static 'inventory.css' %}">
+{% endblock %}
+
+{% block title %}{{ title }} | PyInventory {{ inventory_version_string }}{% endblock %}
+
+{% block branding %}
+<h1 id="site-name">
+    <a href="{% url 'admin:index' %}">PyInventory {{ inventory_version_string }}</a>
+</h1>
+{% endblock %}
+
+{% block nav-global %}{% endblock %}
+
+{% block footer %}<div id="footer">
+    <a href="https://github.com/jedie/PyInventory">https://github.com/jedie/PyInventory</a>
+</div>{% endblock %}

inventory_project/templates/admin/login.html

@@ -0,0 +1,32 @@
+{% extends "admin/login.html" %}
+{% load i18n static %}
+
+{% block branding %}{# remove branding #}{% endblock %}
+
+{% block extrastyle %}{{ block.super }}
+<style>.form-row {display: none;}</style>
+{% endblock %}
+
+{% block content %}
+    <script>document.write('<fo'+'rm act'+'ion="{{ app_path }}" met'+'hod="po'+'st" id="lo'+'gin-fo'+'rm">');</script>
+    {% csrf_token %}
+        <div class="form-row">
+            {{ form.as_p }}
+        </div>
+        <div class="submit-row">
+            <noscript>Please enable JavaScript ;)</noscript>
+            <label>&nbsp;</label>
+            <script>document.write('<in'+'put type="sub'+'mit" val'+'ue="{% trans 'Log in' %}">');</script>
+        </div>
+    <script>
+        'use strict';
+        document.write('</fo'+'rm>');
+        document.addEventListener('DOMContentLoaded', () => {
+            for (const object of document.querySelectorAll('.form-row')) {
+                object.style.display = "block";
+            }
+        });
+    </script>
+{% endblock %}
+
+{% block footer %}{# remove footer #}{% endblock %}

inventory_project/tests/fixtures.py

@@ -0,0 +1,40 @@
+import tempfile
+
+from django.contrib.auth.models import User
+from model_bakery import baker
+from PIL import Image
+
+from inventory.permissions import get_or_create_normal_user_group
+
+
+def get_normal_user():
+    user = baker.make(
+        User,
+        id=1,
+        username='NormalUser',
+        is_staff=True,
+        is_active=True,
+        is_superuser=False,
+    )
+    assert user.user_permissions.count() == 0
+    group = get_or_create_normal_user_group()[0]
+    user.groups.set([group])
+    user.full_clean()
+    return user
+
+
+class TempImageFile:
+    def __init__(self, prefix='test_image', format='png', size=(1, 1)):
+        self.format = format
+        self.image_size = size
+        self.temp = tempfile.NamedTemporaryFile(prefix=prefix, suffix=f'.{format}')
+
+    def __enter__(self):
+        self.temp_file = self.temp.__enter__()
+        pil_image = Image.new('RGB', self.image_size)
+        pil_image.save(self.temp_file, format=self.format)
+        self.temp_file.seek(0)
+        return self.temp_file
+
+    def __exit__(self, exc_type, exc_val, exc_tb):
+        self.temp_file.__exit__(exc_type, exc_val, exc_tb)

inventory_project/tests/mocks.py

@@ -0,0 +1,15 @@
+from unittest import mock
+
+from bx_py_utils.test_utils.context_managers import MassContextManager
+
+from inventory import context_processors
+
+
+class MockInventoryVersionString(MassContextManager):
+    def __init__(self):
+        self.mocks = [
+            mock.patch.object(context_processors, '__version__', self),
+        ]
+
+    def __repr__(self):
+        return 'MockedVersionString'

inventory_project/tests/playwright_utils.py

@@ -0,0 +1,22 @@
+from django.conf import settings
+from django.contrib.auth.models import User
+from django.test.client import Client
+from playwright.sync_api import Page
+
+
+def login(page: Page, client: Client, url: str, user: User) -> None:
+    """
+    Helper to fast login, without using the login page.
+    """
+    # Create a session by using Django's test login:
+    client.force_login(user=user)
+    session_cookie = client.cookies[settings.SESSION_COOKIE_NAME]
+    assert session_cookie
+
+    # Inject the session Cookie to playwright browser:
+    cookie_object = {
+        'name': session_cookie.key,
+        'value': session_cookie.value,
+        'url': url,
+    }
+    page.context.add_cookies([cookie_object])

inventory_project/tests/test_admin.py

@@ -0,0 +1,15 @@
+from django.test import TestCase
+
+
+class AdminAnonymousTests(TestCase):
+    """
+    Anonymous will be redirected to the login page.
+    """
+
+    def test_login_en(self):
+        response = self.client.get('/admin/', secure=True, HTTP_ACCEPT_LANGUAGE='en')
+        self.assertRedirects(response, expected_url='/admin/login/?next=/admin/', fetch_redirect_response=False)
+
+    def test_login_de(self):
+        response = self.client.get('/admin/', secure=True, HTTP_ACCEPT_LANGUAGE='de')
+        self.assertRedirects(response, expected_url='/admin/login/?next=/admin/', fetch_redirect_response=False)