PyInventory 0.19.0__py3-none-any.whl

inventory/tests/test_management_command_tree.py

@@ -0,0 +1,27 @@
+import io
+
+from django.core import management
+from django.test import TestCase
+from model_bakery import baker
+
+from inventory.management.commands import tree
+from inventory.models import ItemModel
+
+
+class ManagementCommandTestCase(TestCase):
+    def test_tree_command(self):
+        baker.make(ItemModel, name='Foo Bar')
+        ItemModel.objects.update(path_str='OLD', path=['OLD'])
+
+        output = io.StringIO()
+
+        management.call_command(tree.Command(), stdout=output)
+
+        output = output.getvalue()
+        assert 'Repair tree information' in output
+
+        assert "Old information about model: 'Item'" in output
+        assert "{'level': 1, 'path_str': 'OLD', 'path': ['OLD'], 'name': 'Foo Bar'}" in output
+
+        assert "New information about model: 'Item'" in output
+        assert "{'level': 1, 'path_str': 'foobar', 'path': ['Foo Bar'], 'name': 'Foo Bar'}" in output

inventory/tests/test_parent_tree.py

@@ -0,0 +1,40 @@
+import random
+
+from inventory.parent_tree import ValuesListTree
+
+
+def test_values_list_tree():
+    values_list = [
+        (1, '1.', None),
+        (2, '1.1.', 1),
+        (3, '1.1.1', 2),
+        (4, '1.1.2', 2),
+        (5, '1.2.', 1),
+        (6, '2.', None),
+    ]
+    random.shuffle(values_list)
+    values = [{'pk': entry[0], 'name': entry[1], 'parent__pk': entry[2], 'path': ''} for entry in values_list]
+    tree = ValuesListTree(values)
+
+    tree_path = tree.get_tree_path()
+    assert tree_path == [
+        '1.',
+        '1. / 1.1.',
+        '1. / 1.1. / 1.1.1',
+        '1. / 1.1. / 1.1.2',
+        '1. / 1.2.',
+        '2.',
+    ]
+    update_path_info = tree.get_update_path_info()
+    assert update_path_info == {
+        1: ['1.'],
+        2: ['1.', '1.1.'],
+        3: ['1.', '1.1.', '1.1.1'],
+        4: ['1.', '1.1.', '1.1.2'],
+        5: ['1.', '1.2.'],
+        6: ['2.'],
+    }
+
+    node_three = tree.nodes[2]
+    assert str(node_three) == 'pk:3 name:"1.1.1" path:"1. / 1.1. / 1.1.1"'
+    assert repr(node_three) == '<TreeNode pk:3 name:"1.1.1" path:"1. / 1.1. / 1.1.1">'

inventory/tests/test_parent_tree_model.py

@@ -0,0 +1,139 @@
+from bx_django_utils.test_utils.assert_queries import AssertQueries
+from django.db.models import QuerySet
+from django.test import TestCase
+
+from inventory.admin import ItemModelAdmin, LocationModelAdmin
+from inventory.models import ItemModel, LocationModel
+from inventory_project.tests.fixtures import get_normal_user
+
+
+class TreeModelTests(TestCase):
+    @classmethod
+    def setUpTestData(cls):
+        cls.normaluser = get_normal_user()
+
+    def test_parent_tree_model(self):
+        for main_item_no in range(1, 3):
+            main_item = ItemModel.objects.create(
+                user=self.normaluser,
+                name=f'{main_item_no}.',
+            )
+            main_item.full_clean()
+
+            for sub_item_no in range(1, 3):
+                sub_item = ItemModel.objects.create(
+                    parent=main_item,
+                    user=self.normaluser,
+                    name=f'{main_item_no}.{sub_item_no}.',
+                )
+                sub_item.full_clean()
+
+                for sub_sub_item_no in range(1, 3):
+                    sub_sub_item = ItemModel.objects.create(
+                        parent=sub_item,
+                        user=self.normaluser,
+                        name=f'{main_item_no}.{sub_item_no}.{sub_sub_item_no}.',
+                    )
+                    sub_sub_item.full_clean()
+
+        data = list(ItemModel.objects.values_list('level', 'path_str', 'name'))
+        assert data == [
+            (1, '1', '1.'),
+            (2, '1 0 11', '1.1.'),
+            (3, '1 0 11 0 111', '1.1.1.'),
+            (3, '1 0 11 0 112', '1.1.2.'),
+            (2, '1 0 12', '1.2.'),
+            (3, '1 0 12 0 121', '1.2.1.'),
+            (3, '1 0 12 0 122', '1.2.2.'),
+            (1, '2', '2.'),
+            (2, '2 0 21', '2.1.'),
+            (3, '2 0 21 0 211', '2.1.1.'),
+            (3, '2 0 21 0 212', '2.1.2.'),
+            (2, '2 0 22', '2.2.'),
+            (3, '2 0 22 0 221', '2.2.1.'),
+            (3, '2 0 22 0 222', '2.2.2.'),
+        ]
+
+        item_2_1 = ItemModel.objects.get(name='2.1.')
+
+        related_qs = ItemModel.tree_objects.related_objects(instance=item_2_1)
+        data = list(related_qs.values_list('name', flat=True))
+        assert data == ['2.', '2.1.', '2.1.1.', '2.1.2.', '2.2.', '2.2.1.', '2.2.2.']
+
+        item_2_1.name = 'NEW 2.1. Name'
+        with AssertQueries() as queries:
+            item_2_1.save()
+
+        data = list(ItemModel.objects.values_list('level', 'path_str', 'name'))
+        assert data == [
+            (1, '1', '1.'),
+            (2, '1 0 11', '1.1.'),
+            (3, '1 0 11 0 111', '1.1.1.'),
+            (3, '1 0 11 0 112', '1.1.2.'),
+            (2, '1 0 12', '1.2.'),
+            (3, '1 0 12 0 121', '1.2.1.'),
+            (3, '1 0 12 0 122', '1.2.2.'),
+            (1, '2', '2.'),
+            (2, '2 0 22', '2.2.'),
+            (3, '2 0 22 0 221', '2.2.1.'),
+            (3, '2 0 22 0 222', '2.2.2.'),
+            (2, '2 0 new21name', 'NEW 2.1. Name'),
+            (3, '2 0 new21name 0 211', '2.1.1.'),
+            (3, '2 0 new21name 0 212', '2.1.2.'),
+        ]
+
+        itemmodel_count = 1  # full_clean(): Check if parent exists
+        itemmodel_count += 1  # VersionProtectBaseModel: Check version
+        itemmodel_count += 1  # VersionProtectBaseModel: Save new version
+        itemmodel_count += 1  # Get info for tree update
+        itemmodel_count += 1  # Fetch the items to update
+        itemmodel_count += 1  # Bulk update save
+
+        queries.assert_queries(
+            table_counts={
+                'inventory_itemmodel': itemmodel_count,
+                'auth_user': 1,  # full_clean(): Check if user exists
+            },
+            double_tables=False,
+            duplicated=True,
+            similar=True,
+        )
+
+    def test_related_objects(self):
+        item = ItemModel()
+        qs = ItemModel.tree_objects.related_objects(instance=item)
+        assert isinstance(qs, QuerySet)
+        assert qs.query.is_empty() is True
+
+    def test_parent_tree_model_ordering(self):
+        assert LocationModel._meta.ordering == ('path_str',)
+        assert LocationModelAdmin.ordering == ('path_str',)
+
+        assert ItemModel._meta.ordering == ('path_str',)
+        assert ItemModelAdmin.ordering == ('path_str',)
+
+        def create(name, parent=None):
+            instance = ItemModel.objects.create(user=self.normaluser, name=name, parent=parent)
+            instance.full_clean()
+            return instance
+
+        # Create a "Special" case for the correct ordering:
+        #  1. all "PC-1" entries
+        #  2. all "PC1640" entries
+        #
+        # The correct order depends on the seperator, here: " 0 "
+
+        pc1 = create(name='PC-1')
+        pc1640 = create(name='PC1640 SD')
+        create(name='FZ-502 Rev A 5.25″ Floppy', parent=pc1)
+        create(name='1,44MB / 3.5" Floppy FD-235HF- 3800-U', parent=pc1)
+        create(name='PC 1640ECD', parent=pc1640)
+
+        data = list(ItemModel.objects.values_list('level', 'path_str', 'name'))
+        assert data == [
+            (1, 'pc1', 'PC-1'),
+            (2, 'pc1 0 144mb35floppyfd235hf3800u', '1,44MB / 3.5" Floppy FD-235HF- 3800-U'),
+            (2, 'pc1 0 fz502reva525floppy', 'FZ-502 Rev A 5.25″ Floppy'),
+            (1, 'pc1640sd', 'PC1640 SD'),
+            (2, 'pc1640sd 0 pc1640ecd', 'PC 1640ECD'),
+        ]

inventory_project/__init__.py

@@ -0,0 +1,12 @@
+from pathlib import Path
+
+from bx_py_utils.path import assert_is_dir
+
+import inventory
+
+
+PACKAGE_ROOT = Path(inventory.__file__).parent.parent
+assert_is_dir(PACKAGE_ROOT / 'inventory')
+
+
+__version__ = inventory.__version__

inventory_project/__main__.py

@@ -0,0 +1,17 @@
+"""
+    Allow your-cool-package to be executable
+    through `python -m inventory`.
+"""
+from manage_django_project.manage import execute_django_from_command_line
+
+
+def main():
+    """
+    entrypoint installed via pyproject.toml and [project.scripts] section.
+    Must be set in ./manage.py and PROJECT_SHELL_SCRIPT
+    """
+    execute_django_from_command_line()
+
+
+if __name__ == '__main__':
+    main()

inventory_project/manage.py

@@ -0,0 +1,41 @@
+import os
+import sys
+
+from django import __version__ as django_version
+
+from inventory import __version__
+
+
+def main(argv):
+    os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'inventory_project.settings.local')
+
+    if '--version' not in argv:
+        print(f'PyInventory v{__version__} (Django v{django_version})', file=sys.stderr)
+        print(f'DJANGO_SETTINGS_MODULE={os.environ["DJANGO_SETTINGS_MODULE"]!r}', file=sys.stderr)
+
+    try:
+        from django.core.management import execute_from_command_line
+    except ImportError as exc:
+        raise ImportError(
+            'Couldn\'t import Django. Are you sure it\'s installed and '
+            'available on your PYTHONPATH environment variable? Did you '
+            'forget to activate a virtual environment?'
+        ) from exc
+    try:
+        execute_from_command_line(argv)
+    except Exception as err:
+        from bx_py_utils.error_handling import print_exc_plus
+
+        print_exc_plus(err)
+        raise
+
+
+def start_test_server():
+    """
+    Entrypoint for "[tool.poetry.scripts]" script started by devshell command.
+    """
+    main(argv=[__file__, "run_testserver"] + sys.argv[1:])
+
+
+if __name__ == '__main__':
+    main(argv=sys.argv)

inventory_project/middlewares.py

@@ -0,0 +1,23 @@
+import logging
+from pathlib import Path
+
+from debug_toolbar.middleware import show_toolbar
+from django.conf import settings
+
+
+logger = logging.getLogger(__name__)
+
+
+def djdt_show(request):
+    """
+    Determining whether the Django Debug Toolbar should show or not.
+    """
+    if not settings.DEBUG:
+        return False
+
+    if Path('/.dockerenv').exists():
+        # We run in a docker container
+        # skip the `request.META['REMOTE_ADDR'] in settings.INTERNAL_IPS` check.
+        return True
+
+    return show_toolbar(request)

inventory_project/publish.py

@@ -0,0 +1,21 @@
+from poetry_publish.publish import poetry_publish
+from poetry_publish.utils.subprocess_utils import verbose_check_call
+
+# https://github.com/jedie/PyInventory
+import inventory
+from inventory_project import PACKAGE_ROOT
+
+
+def publish():
+    """
+    Publish to PyPi
+    Call this via:
+        $ poetry run publish
+    """
+    verbose_check_call('make', 'pytest')  # don't publish if tests fail
+    verbose_check_call('make', 'fix-code-style')  # don't publish if code style wrong
+
+    poetry_publish(
+        package_root=PACKAGE_ROOT,
+        version=inventory.__version__,
+    )

inventory_project/settings/local.py

@@ -0,0 +1,74 @@
+# flake8: noqa: E405
+
+"""
+    Django settings for local development
+"""
+
+import os as __os
+import sys as __sys
+
+from inventory_project.settings.prod import *  # noqa
+
+
+# SECURITY WARNING: don't run with debug turned on in production!
+DEBUG = True
+
+
+# Serve static/media files for local development:
+SERVE_FILES = True
+
+
+# Disable caches:
+CACHES = {'default': {'BACKEND': 'django.core.cache.backends.dummy.DummyCache'}}
+
+# Required for the debug toolbar to be displayed:
+INTERNAL_IPS = ('127.0.0.1', '0.0.0.0', 'localhost')
+
+ALLOWED_HOSTS = INTERNAL_IPS
+
+DATABASES = {
+    'default': {
+        'ENGINE': 'django.db.backends.sqlite3',
+        'NAME': str(BASE_PATH / 'inventory-database.sqlite3'),
+        # https://docs.djangoproject.com/en/dev/ref/databases/#database-is-locked-errors
+        'timeout': 30,
+    }
+}
+print(f'Use Database: {DATABASES["default"]["NAME"]!r}', file=__sys.stderr)
+
+# _____________________________________________________________________________
+
+# Download map via geotiler in inventory.gpx_tools.gpxpy2map.generate_map
+MAP_DOWNLOAD = True
+
+if __os.environ.get('AUTOLOGIN') == '1':
+    # Auto login for dev. server:
+    MIDDLEWARE = MIDDLEWARE.copy()
+    MIDDLEWARE += ['django_tools.middlewares.local_auto_login.AlwaysLoggedInAsSuperUserMiddleware']
+
+# _____________________________________________________________________________
+# Manage Django Project
+
+INSTALLED_APPS.append('manage_django_project')
+
+# _____________________________________________________________________________
+# Django-Debug-Toolbar
+
+
+INSTALLED_APPS.append('debug_toolbar')
+MIDDLEWARE.append('debug_toolbar.middleware.DebugToolbarMiddleware')
+
+DEBUG_TOOLBAR_PATCH_SETTINGS = True
+from debug_toolbar.settings import CONFIG_DEFAULTS as DEBUG_TOOLBAR_CONFIG  # noqa
+
+
+# Disable some more panels that will slow down the page:
+DEBUG_TOOLBAR_CONFIG['DISABLE_PANELS'].add('debug_toolbar.panels.sql.SQLPanel')
+DEBUG_TOOLBAR_CONFIG['DISABLE_PANELS'].add('debug_toolbar.panels.cache.CachePanel')
+
+# don't load jquery from ajax.googleapis.com, just use django's version:
+DEBUG_TOOLBAR_CONFIG['JQUERY_URL'] = STATIC_URL + 'admin/js/vendor/jquery/jquery.min.js'
+
+DEBUG_TOOLBAR_CONFIG['SHOW_TEMPLATE_CONTEXT'] = True
+DEBUG_TOOLBAR_CONFIG['SHOW_COLLAPSED'] = True  # Show toolbar collapsed by default.
+DEBUG_TOOLBAR_CONFIG['SHOW_TOOLBAR_CALLBACK'] = 'inventory_project.middlewares.djdt_show'