From 7bec3ff5ddf81230d92cc5353b12c877b2fd18d7 Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Sat, 6 Mar 2021 20:58:57 +1100 Subject: [PATCH 001/137] django-q --- InvenTree/InvenTree/settings.py | 13 +++++++++++++ requirements.txt | 1 + 2 files changed, 14 insertions(+) diff --git a/InvenTree/InvenTree/settings.py b/InvenTree/InvenTree/settings.py index 1a298240bc..0826c7d042 100644 --- a/InvenTree/InvenTree/settings.py +++ b/InvenTree/InvenTree/settings.py @@ -211,6 +211,7 @@ INSTALLED_APPS = [ 'djmoney', # django-money integration 'djmoney.contrib.exchange', # django-money exchange rates 'error_report', # Error reporting in the admin interface + 'django_q', ] MIDDLEWARE = CONFIG.get('middleware', [ @@ -285,6 +286,18 @@ REST_FRAMEWORK = { WSGI_APPLICATION = 'InvenTree.wsgi.application' +# django-q configuration +Q_CLUSTER = { + 'name': 'InvenTree', + 'workers': 4, + 'timeout': 90, + 'retry': 120, + 'queue_limit': 50, + 'bulk': 10, + 'orm': 'default', + 'sync': True, +} + # Markdownx configuration # Ref: https://neutronx.github.io/django-markdownx/customization/ MARKDOWNX_MEDIA_PATH = datetime.now().strftime('markdownx/%Y/%m/%d') diff --git a/requirements.txt b/requirements.txt index 7bbc14bd54..2c8bd9f3e7 100644 --- a/requirements.txt +++ b/requirements.txt @@ -30,5 +30,6 @@ django-error-report==0.2.0 # Error report viewer for the admin interface django-test-migrations==1.1.0 # Unit testing for database migrations python-barcode[images]==0.13.1 # Barcode generator qrcode[pil]==6.1 # QR code generator +django-q==1.3.4 # Background task scheduling inventree # Install the latest version of the InvenTree API python library From 45b3c68930842b662c9e40958016e0c09b18567e Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Sat, 6 Mar 2021 21:41:19 +1100 Subject: [PATCH 002/137] New status info --- InvenTree/InvenTree/context.py | 14 ++++++++++++-- InvenTree/InvenTree/status.py | 31 +++++++++++++++++++------------ InvenTree/templates/stats.html | 15 ++++++++++++++- 3 files changed, 45 insertions(+), 15 deletions(-) diff --git a/InvenTree/InvenTree/context.py b/InvenTree/InvenTree/context.py index 9fee5deaab..1d07511fa9 100644 --- a/InvenTree/InvenTree/context.py +++ b/InvenTree/InvenTree/context.py @@ -30,10 +30,20 @@ def health_status(request): request._inventree_health_status = True - return { - "system_healthy": InvenTree.status.check_system_health(), + status = { + 'django_q_running': InvenTree.status.is_q_cluster_running(), } + all_healthy = True + + for k in status.keys(): + if status[k] is not True: + all_healthy = False + + status['system_healthy'] = all_healthy + + return status + def status_codes(request): """ diff --git a/InvenTree/InvenTree/status.py b/InvenTree/InvenTree/status.py index ec2422a254..e02e476a51 100644 --- a/InvenTree/InvenTree/status.py +++ b/InvenTree/InvenTree/status.py @@ -1,15 +1,32 @@ """ Provides system status functionality checks. """ +# -*- coding: utf-8 -*- -from django.utils.translation import ugettext as _ +from __future__ import unicode_literals import logging +from django.utils.translation import ugettext as _ + +from django_q.monitor import Stat logger = logging.getLogger(__name__) +def is_q_cluster_running(**kwargs): + """ + Return True if at least one cluster worker is running + """ + + clusters = Stat.get_all() + + for cluster in clusters: + print("Cluster:", cluster) + + return len(clusters) > 0 + + def check_system_health(**kwargs): """ Check that the InvenTree system is running OK. @@ -19,7 +36,7 @@ def check_system_health(**kwargs): result = True - if not check_celery_worker(**kwargs): + if not is_q_cluster_running(**kwargs): result = False logger.warning(_("Celery worker check failed")) @@ -27,13 +44,3 @@ def check_system_health(**kwargs): logger.warning(_("InvenTree system health checks failed")) return result - - -def check_celery_worker(**kwargs): - """ - Check that a celery worker is running. - """ - - # TODO - Checks that the configured celery worker thing is running - - return True diff --git a/InvenTree/templates/stats.html b/InvenTree/templates/stats.html index 7b8a9bb93a..30d3f3d881 100644 --- a/InvenTree/templates/stats.html +++ b/InvenTree/templates/stats.html @@ -13,8 +13,9 @@ {% trans "Instance Name" %} {% inventree_instance_name %} + {% if user.is_staff %} - + {% trans "Server status" %} {% if system_healthy %} @@ -24,6 +25,18 @@ {% endif %} + + + {% trans "Background Worker" %} + + {% if django_q_running %} + {% trans "Operational" %} + {% else %} + {% trans "Not running" %} + {% endif %} + + + {% endif %} {% if not system_healthy %} {% for issue in system_issues %} From 660fed9196df26ae8f96d35c490608b50cfcda3d Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Wed, 10 Mar 2021 14:03:09 +1100 Subject: [PATCH 003/137] Remove unused code from settings.py --- InvenTree/InvenTree/settings.py | 5 ----- 1 file changed, 5 deletions(-) diff --git a/InvenTree/InvenTree/settings.py b/InvenTree/InvenTree/settings.py index 0826c7d042..0a72dce33e 100644 --- a/InvenTree/InvenTree/settings.py +++ b/InvenTree/InvenTree/settings.py @@ -414,11 +414,6 @@ CACHES = { 'default': { 'BACKEND': 'django.core.cache.backends.locmem.LocMemCache', }, - 'qr-code': { - 'BACKEND': 'django.core.cache.backends.locmem.LocMemCache', - 'LOCATION': 'qr-code-cache', - 'TIMEOUT': 3600 - } } # Password validation From 5b68d82fa316486ec820de30ba2ce0cb2506ef54 Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Wed, 10 Mar 2021 14:03:19 +1100 Subject: [PATCH 004/137] Skeleton for background tasks --- InvenTree/InvenTree/tasks.py | 39 ++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 InvenTree/InvenTree/tasks.py diff --git a/InvenTree/InvenTree/tasks.py b/InvenTree/InvenTree/tasks.py new file mode 100644 index 0000000000..0ebfc5a2fd --- /dev/null +++ b/InvenTree/InvenTree/tasks.py @@ -0,0 +1,39 @@ +# -*- coding: utf-8 -*- +from __future__ import unicode_literals + +import json +import requests +import logging + +from datetime import timedelta + + +logger = logging.getLogger(__name__) + + +def delete_successful_tasks(): + """ + Delete successful task logs + which are more than a week old. + """ + + pass + +def check_for_updates(): + """ + Check if there is an update for InvenTree + """ + + response = requests.get('https://api.github.com/repos/inventree/inventree/releases/latest') + + if not response.status_code == 200: + logger.warning(f'Unexpected status code from GitHub API: {response.status_code}') + return + + data = json.loads(response.text) + + # TODO + + +def test(x): + print(f"Running at task! {x}") \ No newline at end of file From 1532a0c3a18e2e32fc5491dde5b9fe11cb6d2f53 Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Thu, 11 Mar 2021 17:18:57 +1100 Subject: [PATCH 005/137] Add InvenTree/apps.py --- InvenTree/InvenTree/apps.py | 12 ++++++++++++ InvenTree/InvenTree/settings.py | 1 + 2 files changed, 13 insertions(+) create mode 100644 InvenTree/InvenTree/apps.py diff --git a/InvenTree/InvenTree/apps.py b/InvenTree/InvenTree/apps.py new file mode 100644 index 0000000000..a13c5b8d31 --- /dev/null +++ b/InvenTree/InvenTree/apps.py @@ -0,0 +1,12 @@ +# -*- coding: utf-8 -*- + +from django.apps import AppConfig + + +class InvenTreeConfig(AppConfig): + name = 'InvenTree' + + def ready(self): + + print("Starting background tasks") + pass diff --git a/InvenTree/InvenTree/settings.py b/InvenTree/InvenTree/settings.py index 0a72dce33e..323eade258 100644 --- a/InvenTree/InvenTree/settings.py +++ b/InvenTree/InvenTree/settings.py @@ -188,6 +188,7 @@ INSTALLED_APPS = [ 'build.apps.BuildConfig', 'common.apps.CommonConfig', 'company.apps.CompanyConfig', + 'InvenTree.apps.InvenTreeConfig', 'label.apps.LabelConfig', 'order.apps.OrderConfig', 'part.apps.PartConfig', From 3cf5aec289fdac940a74ca6278f2503837fe2b6f Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Thu, 11 Mar 2021 19:21:28 +1100 Subject: [PATCH 006/137] Refactor --- InvenTree/InvenTree/apps.py | 28 ++++++++++++++++++++++++++-- InvenTree/InvenTree/settings.py | 2 +- InvenTree/InvenTree/tasks.py | 29 +++++++++++++++++++++++++++++ 3 files changed, 56 insertions(+), 3 deletions(-) diff --git a/InvenTree/InvenTree/apps.py b/InvenTree/InvenTree/apps.py index a13c5b8d31..0b5283706c 100644 --- a/InvenTree/InvenTree/apps.py +++ b/InvenTree/InvenTree/apps.py @@ -1,6 +1,12 @@ # -*- coding: utf-8 -*- from django.apps import AppConfig +import logging + +import InvenTree.tasks + + +logger = logging.getLogger(__name__) class InvenTreeConfig(AppConfig): @@ -8,5 +14,23 @@ class InvenTreeConfig(AppConfig): def ready(self): - print("Starting background tasks") - pass + self.start_background_tasks() + + def start_background_tasks(self): + + try: + from django_q.models import Schedule + except (AppRegistryNotReady): + return + + logger.info("Starting background tasks...") + + InvenTree.tasks.schedule_task( + 'InvenTree.tasks.delete_successful_tasks', + schedule_type=Schedule.WEEKLY, + ) + + InvenTree.tasks.schedule_task( + 'InvenTree.tasks.check_for_updates', + schedule_type=Schedule.DAILY + ) diff --git a/InvenTree/InvenTree/settings.py b/InvenTree/InvenTree/settings.py index 323eade258..2c96fa8706 100644 --- a/InvenTree/InvenTree/settings.py +++ b/InvenTree/InvenTree/settings.py @@ -188,13 +188,13 @@ INSTALLED_APPS = [ 'build.apps.BuildConfig', 'common.apps.CommonConfig', 'company.apps.CompanyConfig', - 'InvenTree.apps.InvenTreeConfig', 'label.apps.LabelConfig', 'order.apps.OrderConfig', 'part.apps.PartConfig', 'report.apps.ReportConfig', 'stock.apps.StockConfig', 'users.apps.UsersConfig', + 'InvenTree.apps.InvenTreeConfig', # InvenTree app runs last # Third part add-ons 'django_filters', # Extended filter functionality diff --git a/InvenTree/InvenTree/tasks.py b/InvenTree/InvenTree/tasks.py index 0ebfc5a2fd..e34c7e8c21 100644 --- a/InvenTree/InvenTree/tasks.py +++ b/InvenTree/InvenTree/tasks.py @@ -7,10 +7,35 @@ import logging from datetime import timedelta +from django.core.exceptions import AppRegistryNotReady + logger = logging.getLogger(__name__) +def schedule_task(taskname, **kwargs): + """ + Create a scheduled task. + If the task has already been scheduled, ignore! + """ + + try: + from django_q.models import Schedule + except (AppRegistryNotReady): + logger.warning("Could not start background tasks - App registry not ready") + return + + if Schedule.objects.filter(func=taskname).exists(): + logger.info(f"Scheduled task '{taskname}' already exists. (Skipping)") + else: + logger.info(f"Creating scheduled task '{taskname}'") + + Schedule.objects.create( + func=taskname, + **kwargs + ) + + def delete_successful_tasks(): """ Delete successful task logs @@ -32,8 +57,12 @@ def check_for_updates(): data = json.loads(response.text) + print("Response:") + print(data) # TODO + return data + def test(x): print(f"Running at task! {x}") \ No newline at end of file From 18defcff160acca611518b95f9dd444bc0c98a26 Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Thu, 11 Mar 2021 19:56:22 +1100 Subject: [PATCH 007/137] Read version number from GitHub --- InvenTree/InvenTree/tasks.py | 42 ++++++++++++++++++++++++++++------ InvenTree/InvenTree/tests.py | 13 +++++++++++ InvenTree/InvenTree/version.py | 23 +++++++++++++++++++ InvenTree/common/models.py | 2 +- 4 files changed, 72 insertions(+), 8 deletions(-) diff --git a/InvenTree/InvenTree/tasks.py b/InvenTree/InvenTree/tasks.py index e34c7e8c21..61b6885b03 100644 --- a/InvenTree/InvenTree/tasks.py +++ b/InvenTree/InvenTree/tasks.py @@ -1,6 +1,7 @@ # -*- coding: utf-8 -*- from __future__ import unicode_literals +import re import json import requests import logging @@ -35,7 +36,7 @@ def schedule_task(taskname, **kwargs): **kwargs ) - + def delete_successful_tasks(): """ Delete successful task logs @@ -49,6 +50,12 @@ def check_for_updates(): Check if there is an update for InvenTree """ + try: + import common.models + import InvenTree.version + except AppRegistryNotReady: + return + response = requests.get('https://api.github.com/repos/inventree/inventree/releases/latest') if not response.status_code == 200: @@ -57,12 +64,33 @@ def check_for_updates(): data = json.loads(response.text) - print("Response:") - print(data) - # TODO + tag = data.get('tag_name', None) - return data + if not tag: + logger.warning(f"'tag_name' missing from GitHub response") + return + match = re.match(r"^.*(\d+)\.(\d+)\.(\d+).*$", tag) -def test(x): - print(f"Running at task! {x}") \ No newline at end of file + if not len(match.groups()) == 3: + logger.warning(f"Version '{tag}' did not match expected pattern") + return + + try: + latest_version = [int(x) for x in match.groups()] + except (ValueError): + logger.warning(f"Version '{tag}' not integer format") + return + + if not len(latest_version) == 3: + logger.warning(f"Version '{tag}' is not correct format") + return + + logger.info(f"Latest InvenTree version: '{tag}'") + + # Save the version to the database + common.models.InvenTreeSetting.set_setting( + 'INVENTREE_LATEST_VERSION', + tag, + None + ) diff --git a/InvenTree/InvenTree/tests.py b/InvenTree/InvenTree/tests.py index 96f32e7f57..1cb382e338 100644 --- a/InvenTree/InvenTree/tests.py +++ b/InvenTree/InvenTree/tests.py @@ -7,6 +7,7 @@ from django.core.exceptions import ValidationError from .validators import validate_overage, validate_part_name from . import helpers +from . import version from mptt.exceptions import InvalidMove @@ -269,3 +270,15 @@ class TestSerialNumberExtraction(TestCase): with self.assertRaises(ValidationError): e("10, a, 7-70j", 4) + + +class TestVersionNumber(TestCase): + + def test_tuple(self): + + v = version.inventreeVersionTuple() + self.assertEqual(len(v), 3) + + s = '.'.join(v) + + self.assertTrue(s in version.inventreeVersion()) diff --git a/InvenTree/InvenTree/version.py b/InvenTree/InvenTree/version.py index 4d3d546789..6aa5c2616c 100644 --- a/InvenTree/InvenTree/version.py +++ b/InvenTree/InvenTree/version.py @@ -4,9 +4,11 @@ Provides information on the current InvenTree version import subprocess import django +import re import common.models + INVENTREE_SW_VERSION = "0.1.8 pre" # Increment this number whenever there is a significant change to the API that any clients need to know about @@ -23,6 +25,27 @@ def inventreeVersion(): return INVENTREE_SW_VERSION +def inventreeVersionTuple(): + """ Return the InvenTree version string as (maj, min, sub) tuple """ + + match = re.match(r"^.*(\d+)\.(\d+)\.(\d+).*$", INVENTREE_SW_VERSION) + + return [int(g) for g in match.groups()] + + +def versionTupleToInt(version): + """ + Convert a version tuple (x, y, z) to an integer. + This simple integer can then be used for direct version comparison + """ + + n = version[0] * 1000 * 1000 + n += version[1] * 1000 + n += version[2] + + return n + + def inventreeApiVersion(): return INVENTREE_API_VERSION diff --git a/InvenTree/common/models.py b/InvenTree/common/models.py index 06c06bde05..23e0773605 100644 --- a/InvenTree/common/models.py +++ b/InvenTree/common/models.py @@ -486,7 +486,7 @@ class InvenTreeSetting(models.Model): create: If True, create a new setting if the specified key does not exist. """ - if not user.is_staff: + if user is not None and not user.is_staff: return try: From 4925f24ca9983e7f06e2a7bcdd465382b2be6698 Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Thu, 11 Mar 2021 20:07:59 +1100 Subject: [PATCH 008/137] Add "up to date" info to the "about" window --- InvenTree/InvenTree/context.py | 2 ++ InvenTree/InvenTree/version.py | 32 +++++++++++++++++++++++++++++--- InvenTree/templates/about.html | 19 +++++++++++++++---- InvenTree/templates/navbar.html | 17 +++++++++++++---- 4 files changed, 59 insertions(+), 11 deletions(-) diff --git a/InvenTree/InvenTree/context.py b/InvenTree/InvenTree/context.py index 1d07511fa9..43e8b904b9 100644 --- a/InvenTree/InvenTree/context.py +++ b/InvenTree/InvenTree/context.py @@ -42,6 +42,8 @@ def health_status(request): status['system_healthy'] = all_healthy + status['up_to_date'] = InvenTree.version.isInvenTreeUpToDate() + return status diff --git a/InvenTree/InvenTree/version.py b/InvenTree/InvenTree/version.py index 6aa5c2616c..bd11c50882 100644 --- a/InvenTree/InvenTree/version.py +++ b/InvenTree/InvenTree/version.py @@ -25,10 +25,13 @@ def inventreeVersion(): return INVENTREE_SW_VERSION -def inventreeVersionTuple(): +def inventreeVersionTuple(version=None): """ Return the InvenTree version string as (maj, min, sub) tuple """ - match = re.match(r"^.*(\d+)\.(\d+)\.(\d+).*$", INVENTREE_SW_VERSION) + if version is None: + version = INVENTREE_SW_VERSION + + match = re.match(r"^.*(\d+)\.(\d+)\.(\d+).*$", str(version)) return [int(g) for g in match.groups()] @@ -44,7 +47,30 @@ def versionTupleToInt(version): n += version[2] return n - + + +def isInvenTreeUpToDate(): + """ + Test if the InvenTree instance is "up to date" with the latest version. + + A background task periodically queries GitHub for latest version, + and stores it to the database as INVENTREE_LATEST_VERSION + """ + + latest = common.models.InvenTreeSetting.get_setting('INVENTREE_LATEST_VERSION', None) + + # No record for "latest" version - we must assume we are up to date! + if not latest: + return True + + # Extract "tuple" version + version = inventreeVersionTuple(latest) + version_int = versionTupleToInt(version) + + inventree_int = versionTupleToInt(inventreeVersionTuple()) + + return inventree_int >= version_int + def inventreeApiVersion(): return INVENTREE_API_VERSION diff --git a/InvenTree/templates/about.html b/InvenTree/templates/about.html index cedfb40ca1..30f9bd19d7 100644 --- a/InvenTree/templates/about.html +++ b/InvenTree/templates/about.html @@ -19,19 +19,30 @@ - {% trans "InvenTree Version" %}{% inventree_version %} + {% trans "InvenTree Version" %} + + {% inventree_version %} + {% if up_to_date %} + {% trans "Up to Date" %} + {% else %} + {% trans "Update Available" %} + {% endif %} + - {% trans "Django Version" %}{% django_version %} + {% trans "Django Version" %} + {% django_version %} - {% trans "Commit Hash" %}{% inventree_commit_hash %} + {% trans "Commit Hash" %} + {% inventree_commit_hash %} - {% trans "Commit Date" %}{% inventree_commit_date %} + {% trans "Commit Date" %} + {% inventree_commit_date %} diff --git a/InvenTree/templates/navbar.html b/InvenTree/templates/navbar.html index 6e3fe024ca..c52e87d753 100644 --- a/InvenTree/templates/navbar.html +++ b/InvenTree/templates/navbar.html @@ -59,8 +59,8 @@ {% endif %}
  • - {% if not system_healthy %} - + {% if not system_healthy or not up_to_date %} + {% endif %} {{ user.get_username }}
    • From bfb0cb3b4754109657fb29c353d450f4de94f5dd Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Fri, 12 Mar 2021 15:27:28 +1100 Subject: [PATCH 009/137] Add a "heartbeat" task which runs every 5 minutes - Allows us to track if the worker is running - Due to Stat.get_all() not always working --- InvenTree/InvenTree/apps.py | 10 +++++++++- InvenTree/InvenTree/status.py | 23 ++++++++++++++++++++--- InvenTree/InvenTree/tasks.py | 17 +++++++++++++---- InvenTree/templates/navbar.html | 4 +++- 4 files changed, 45 insertions(+), 9 deletions(-) diff --git a/InvenTree/InvenTree/apps.py b/InvenTree/InvenTree/apps.py index 0b5283706c..902ef2c648 100644 --- a/InvenTree/InvenTree/apps.py +++ b/InvenTree/InvenTree/apps.py @@ -1,8 +1,10 @@ # -*- coding: utf-8 -*- -from django.apps import AppConfig import logging +from django.apps import AppConfig +from django.core.exceptions import AppRegistryNotReady + import InvenTree.tasks @@ -34,3 +36,9 @@ class InvenTreeConfig(AppConfig): 'InvenTree.tasks.check_for_updates', schedule_type=Schedule.DAILY ) + + InvenTree.tasks.schedule_task( + 'InvenTree.tasks.heartbeat', + schedule_type=Schedule.MINUTES, + minutes=5 + ) \ No newline at end of file diff --git a/InvenTree/InvenTree/status.py b/InvenTree/InvenTree/status.py index e02e476a51..1f6b01053c 100644 --- a/InvenTree/InvenTree/status.py +++ b/InvenTree/InvenTree/status.py @@ -6,9 +6,11 @@ Provides system status functionality checks. from __future__ import unicode_literals import logging +from datetime import datetime, timedelta from django.utils.translation import ugettext as _ +from django_q.models import Success from django_q.monitor import Stat logger = logging.getLogger(__name__) @@ -21,10 +23,25 @@ def is_q_cluster_running(**kwargs): clusters = Stat.get_all() - for cluster in clusters: - print("Cluster:", cluster) + if len(clusters) > 0: + return True - return len(clusters) > 0 + """ + Sometimes Stat.get_all() returns []. + In this case we have the 'heartbeat' task running every five minutes. + Check to see if we have a result within the last ten minutes + """ + + now = datetime.now() + past = now - timedelta(minutes=10) + + results = Success.objects.filter( + func='InvenTree.tasks.heartbeat', + started__gte=past + ) + + # If any results are returned, then the background worker is running! + return results.exists() def check_system_health(**kwargs): diff --git a/InvenTree/InvenTree/tasks.py b/InvenTree/InvenTree/tasks.py index 61b6885b03..985b9e24da 100644 --- a/InvenTree/InvenTree/tasks.py +++ b/InvenTree/InvenTree/tasks.py @@ -6,8 +6,6 @@ import json import requests import logging -from datetime import timedelta - from django.core.exceptions import AppRegistryNotReady @@ -37,6 +35,17 @@ def schedule_task(taskname, **kwargs): ) +def heartbeat(): + """ + Simple task which runs at 5 minute intervals, + so we can determine that the background worker + is actually running. + + (There is probably a less "hacky" way of achieving this) + """ + pass + + def delete_successful_tasks(): """ Delete successful task logs @@ -45,6 +54,7 @@ def delete_successful_tasks(): pass + def check_for_updates(): """ Check if there is an update for InvenTree @@ -52,7 +62,6 @@ def check_for_updates(): try: import common.models - import InvenTree.version except AppRegistryNotReady: return @@ -67,7 +76,7 @@ def check_for_updates(): tag = data.get('tag_name', None) if not tag: - logger.warning(f"'tag_name' missing from GitHub response") + logger.warning("'tag_name' missing from GitHub response") return match = re.match(r"^.*(\d+)\.(\d+)\.(\d+).*$", tag) diff --git a/InvenTree/templates/navbar.html b/InvenTree/templates/navbar.html index c52e87d753..acd71f0cd8 100644 --- a/InvenTree/templates/navbar.html +++ b/InvenTree/templates/navbar.html @@ -59,8 +59,10 @@ {% endif %}
  • - {% if not system_healthy or not up_to_date %} + {% if not system_healthy %} + {% elif not up_to_date %} + {% endif %} {{ user.get_username }}
      From 5b8eb1c53089cd45d91725a937b386ee93a478ee Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Fri, 12 Mar 2021 15:27:53 +1100 Subject: [PATCH 010/137] Newline --- InvenTree/InvenTree/apps.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/InvenTree/InvenTree/apps.py b/InvenTree/InvenTree/apps.py index 902ef2c648..1022a75301 100644 --- a/InvenTree/InvenTree/apps.py +++ b/InvenTree/InvenTree/apps.py @@ -41,4 +41,4 @@ class InvenTreeConfig(AppConfig): 'InvenTree.tasks.heartbeat', schedule_type=Schedule.MINUTES, minutes=5 - ) \ No newline at end of file + ) From 006dd10a7958de7e565c766458d8dc60fbc615e5 Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Fri, 12 Mar 2021 15:35:33 +1100 Subject: [PATCH 011/137] Delete successful tasks more than a month old --- InvenTree/InvenTree/tasks.py | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/InvenTree/InvenTree/tasks.py b/InvenTree/InvenTree/tasks.py index 985b9e24da..def9abc35d 100644 --- a/InvenTree/InvenTree/tasks.py +++ b/InvenTree/InvenTree/tasks.py @@ -6,6 +6,7 @@ import json import requests import logging +from datetime import datetime, timedelta from django.core.exceptions import AppRegistryNotReady @@ -49,10 +50,16 @@ def heartbeat(): def delete_successful_tasks(): """ Delete successful task logs - which are more than a week old. + which are more than a month old. """ - pass + threshold = datetime.now() - timedelta(days=30) + + results = Success.objects.filter( + started__lte=threshold + ) + + results.delete() def check_for_updates(): From ef4dbda22304e6a2261abc960d4d5d449df3353d Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Fri, 12 Mar 2021 15:35:55 +1100 Subject: [PATCH 012/137] Catch errors if the DB is not up --- InvenTree/InvenTree/tasks.py | 22 ++++++++++++++-------- 1 file changed, 14 insertions(+), 8 deletions(-) diff --git a/InvenTree/InvenTree/tasks.py b/InvenTree/InvenTree/tasks.py index def9abc35d..3dcfb66422 100644 --- a/InvenTree/InvenTree/tasks.py +++ b/InvenTree/InvenTree/tasks.py @@ -7,7 +7,9 @@ import requests import logging from datetime import datetime, timedelta + from django.core.exceptions import AppRegistryNotReady +from django.db.utils import OperationalError, ProgrammingError logger = logging.getLogger(__name__) @@ -25,15 +27,19 @@ def schedule_task(taskname, **kwargs): logger.warning("Could not start background tasks - App registry not ready") return - if Schedule.objects.filter(func=taskname).exists(): - logger.info(f"Scheduled task '{taskname}' already exists. (Skipping)") - else: - logger.info(f"Creating scheduled task '{taskname}'") + try: + if Schedule.objects.filter(func=taskname).exists(): + logger.info(f"Scheduled task '{taskname}' already exists. (Skipping)") + else: + logger.info(f"Creating scheduled task '{taskname}'") - Schedule.objects.create( - func=taskname, - **kwargs - ) + Schedule.objects.create( + func=taskname, + **kwargs + ) + except (OperationalError, ProgrammingError): + # Required if the DB is not ready yet + pass def heartbeat(): From 9d404afec0be035e8166fa1ee70934b27080028b Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Fri, 12 Mar 2021 16:00:25 +1100 Subject: [PATCH 013/137] Add 'ignore' rules for the django-q tables --- InvenTree/users/models.py | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/InvenTree/users/models.py b/InvenTree/users/models.py index 5c95abfe46..57821bb22f 100644 --- a/InvenTree/users/models.py +++ b/InvenTree/users/models.py @@ -132,6 +132,13 @@ class RuleSet(models.Model): 'error_report_error', 'exchange_rate', 'exchange_exchangebackend', + + # Django-q + 'django_q_ormq', + 'django_q_failure', + 'django_q_task', + 'django_q_schedule', + 'django_q_success', ] RULE_OPTIONS = [ From 18b559fee7cb4fcae802c8f1a76521f635fd2f02 Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Fri, 12 Mar 2021 16:28:54 +1100 Subject: [PATCH 014/137] Fix for unit test --- InvenTree/InvenTree/tests.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/InvenTree/InvenTree/tests.py b/InvenTree/InvenTree/tests.py index 1cb382e338..5fadb7b68d 100644 --- a/InvenTree/InvenTree/tests.py +++ b/InvenTree/InvenTree/tests.py @@ -279,6 +279,6 @@ class TestVersionNumber(TestCase): v = version.inventreeVersionTuple() self.assertEqual(len(v), 3) - s = '.'.join(v) + s = '.'.join([str(i) for i in v]) self.assertTrue(s in version.inventreeVersion()) From 700effcee794be4c46fd6c14b633bc1142ed6a51 Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Fri, 12 Mar 2021 16:57:27 +1100 Subject: [PATCH 015/137] Remove celery reference --- InvenTree/InvenTree/status.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/InvenTree/InvenTree/status.py b/InvenTree/InvenTree/status.py index 1f6b01053c..f7c955c394 100644 --- a/InvenTree/InvenTree/status.py +++ b/InvenTree/InvenTree/status.py @@ -55,7 +55,7 @@ def check_system_health(**kwargs): if not is_q_cluster_running(**kwargs): result = False - logger.warning(_("Celery worker check failed")) + logger.warning(_("Background worker check failed")) if not result: logger.warning(_("InvenTree system health checks failed")) From de85d614512ce596568bf17caa855b3f71f86419 Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Mon, 15 Mar 2021 08:31:19 +1100 Subject: [PATCH 016/137] Directly compare version tuples, rather than converting to primitive --- InvenTree/InvenTree/version.py | 23 ++++------------------- 1 file changed, 4 insertions(+), 19 deletions(-) diff --git a/InvenTree/InvenTree/version.py b/InvenTree/InvenTree/version.py index bd11c50882..05946059fc 100644 --- a/InvenTree/InvenTree/version.py +++ b/InvenTree/InvenTree/version.py @@ -36,19 +36,6 @@ def inventreeVersionTuple(version=None): return [int(g) for g in match.groups()] -def versionTupleToInt(version): - """ - Convert a version tuple (x, y, z) to an integer. - This simple integer can then be used for direct version comparison - """ - - n = version[0] * 1000 * 1000 - n += version[1] * 1000 - n += version[2] - - return n - - def isInvenTreeUpToDate(): """ Test if the InvenTree instance is "up to date" with the latest version. @@ -63,13 +50,11 @@ def isInvenTreeUpToDate(): if not latest: return True - # Extract "tuple" version - version = inventreeVersionTuple(latest) - version_int = versionTupleToInt(version) + # Extract "tuple" version (Python can directly compare version tuples) + latest_version = inventreeVersionTuple(latest) + inventree_version = inventreeVersionTuple() - inventree_int = versionTupleToInt(inventreeVersionTuple()) - - return inventree_int >= version_int + return inventree_version >= latest_version def inventreeApiVersion(): From f6dd710d6eec11fc81384134703e715ca56643d9 Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Mon, 15 Mar 2021 08:35:06 +1100 Subject: [PATCH 017/137] Automatically delete old heartbeat messages --- InvenTree/InvenTree/tasks.py | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/InvenTree/InvenTree/tasks.py b/InvenTree/InvenTree/tasks.py index 3dcfb66422..ca84f93ee7 100644 --- a/InvenTree/InvenTree/tasks.py +++ b/InvenTree/InvenTree/tasks.py @@ -8,6 +8,7 @@ import logging from datetime import datetime, timedelta +from django_q.models import Success from django.core.exceptions import AppRegistryNotReady from django.db.utils import OperationalError, ProgrammingError @@ -48,9 +49,19 @@ def heartbeat(): so we can determine that the background worker is actually running. - (There is probably a less "hacky" way of achieving this) + (There is probably a less "hacky" way of achieving this)? """ - pass + + threshold = datetime.now() - timedelta(minutes=30) + + # Delete heartbeat results more than half an hour old, + # otherwise they just create extra noise + heartbeats = Success.objects.filter( + func='InvenTree.tasks.heartbeat', + started__lte=threshold + ) + + heartbeats.delete() def delete_successful_tasks(): From 6ea846ce45cbe114e2cb6b9e30ba9e35c7529864 Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Mon, 15 Mar 2021 08:36:27 +1100 Subject: [PATCH 018/137] Add a #TODO --- InvenTree/InvenTree/status.py | 1 + 1 file changed, 1 insertion(+) diff --git a/InvenTree/InvenTree/status.py b/InvenTree/InvenTree/status.py index f7c955c394..8c65bdc302 100644 --- a/InvenTree/InvenTree/status.py +++ b/InvenTree/InvenTree/status.py @@ -24,6 +24,7 @@ def is_q_cluster_running(**kwargs): clusters = Stat.get_all() if len(clusters) > 0: + # TODO - Introspect on any cluster information return True """ From 24823adc6df036bf7b79be366e505c33e3a4247f Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Mon, 15 Mar 2021 08:51:50 +1100 Subject: [PATCH 019/137] Adds unit tests for version number comparison --- InvenTree/InvenTree/tasks.py | 7 ++++++- InvenTree/InvenTree/tests.py | 18 ++++++++++++++++++ 2 files changed, 24 insertions(+), 1 deletion(-) diff --git a/InvenTree/InvenTree/tasks.py b/InvenTree/InvenTree/tasks.py index ca84f93ee7..96f53e1e4c 100644 --- a/InvenTree/InvenTree/tasks.py +++ b/InvenTree/InvenTree/tasks.py @@ -8,7 +8,6 @@ import logging from datetime import datetime, timedelta -from django_q.models import Success from django.core.exceptions import AppRegistryNotReady from django.db.utils import OperationalError, ProgrammingError @@ -52,6 +51,12 @@ def heartbeat(): (There is probably a less "hacky" way of achieving this)? """ + try: + from django_q.models import Success + logger.warning("Could not perform heartbeat task - App registry not ready") + except AppRegistryNotReady: + return + threshold = datetime.now() - timedelta(minutes=30) # Delete heartbeat results more than half an hour old, diff --git a/InvenTree/InvenTree/tests.py b/InvenTree/InvenTree/tests.py index 5fadb7b68d..0da45e9373 100644 --- a/InvenTree/InvenTree/tests.py +++ b/InvenTree/InvenTree/tests.py @@ -273,6 +273,9 @@ class TestSerialNumberExtraction(TestCase): class TestVersionNumber(TestCase): + """ + Unit tests for version number functions + """ def test_tuple(self): @@ -282,3 +285,18 @@ class TestVersionNumber(TestCase): s = '.'.join([str(i) for i in v]) self.assertTrue(s in version.inventreeVersion()) + + def test_comparison(self): + """ + Test direct comparison of version numbers + """ + + v_a = version.inventreeVersionTuple('1.2.0') + v_b = version.inventreeVersionTuple('1.2.3') + v_c = version.inventreeVersionTuple('1.2.4') + v_d = version.inventreeVersionTuple('2.0.0') + + self.assertTrue(v_b > v_a) + self.assertTrue(v_c > v_b) + self.assertTrue(v_d > v_c) + self.assertTrue(v_d > v_a) From c1aed51de1aeb7f3bbb0c9378d22349dfb47a38e Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Mon, 15 Mar 2021 09:34:32 +1100 Subject: [PATCH 020/137] Fix import error --- InvenTree/InvenTree/settings.py | 9 +++++++-- InvenTree/InvenTree/tasks.py | 6 ++++++ 2 files changed, 13 insertions(+), 2 deletions(-) diff --git a/InvenTree/InvenTree/settings.py b/InvenTree/InvenTree/settings.py index 2c96fa8706..73a38b484d 100644 --- a/InvenTree/InvenTree/settings.py +++ b/InvenTree/InvenTree/settings.py @@ -45,6 +45,8 @@ def get_setting(environment_var, backup_val, default_value=None): return default_value +# Determine if we are running in "test" mode e.g. "manage.py test" +TESTING = 'test' in sys.argv # Build paths inside the project like this: os.path.join(BASE_DIR, ...) BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__))) @@ -336,7 +338,7 @@ DATABASES = {} When running unit tests, enforce usage of sqlite3 database, so that the tests can be run in RAM without any setup requirements """ -if 'test' in sys.argv: +if TESTING: logger.info('InvenTree: Running tests - Using sqlite3 memory database') DATABASES['default'] = { # Ensure sqlite3 backend is being used @@ -479,7 +481,10 @@ USE_I18N = True USE_L10N = True -USE_TZ = True +# Do not use native timezone support in "test" mode +# It generates a *lot* of cruft in the logs +if not TESTING: + USE_TZ = True DATE_INPUT_FORMATS = [ "%Y-%m-%d", diff --git a/InvenTree/InvenTree/tasks.py b/InvenTree/InvenTree/tasks.py index 96f53e1e4c..4ba34ca7ba 100644 --- a/InvenTree/InvenTree/tasks.py +++ b/InvenTree/InvenTree/tasks.py @@ -75,6 +75,12 @@ def delete_successful_tasks(): which are more than a month old. """ + try: + from django_q.models import Success + logger.warning("Could not perform 'delete_successful_tasks' - App registry not ready") + except AppRegistryNotReady: + return + threshold = datetime.now() - timedelta(days=30) results = Success.objects.filter( From c6e154f996255e7f9e401e12696fd2072e1905f2 Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Mon, 15 Mar 2021 10:15:48 +1100 Subject: [PATCH 021/137] PEP style fixes --- InvenTree/InvenTree/settings.py | 1 + InvenTree/InvenTree/tests.py | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/InvenTree/InvenTree/settings.py b/InvenTree/InvenTree/settings.py index 73a38b484d..6d7c937d54 100644 --- a/InvenTree/InvenTree/settings.py +++ b/InvenTree/InvenTree/settings.py @@ -45,6 +45,7 @@ def get_setting(environment_var, backup_val, default_value=None): return default_value + # Determine if we are running in "test" mode e.g. "manage.py test" TESTING = 'test' in sys.argv diff --git a/InvenTree/InvenTree/tests.py b/InvenTree/InvenTree/tests.py index 0da45e9373..8465473901 100644 --- a/InvenTree/InvenTree/tests.py +++ b/InvenTree/InvenTree/tests.py @@ -275,7 +275,7 @@ class TestSerialNumberExtraction(TestCase): class TestVersionNumber(TestCase): """ Unit tests for version number functions - """ + """ def test_tuple(self): From 283663633aa3341f8fad44a4a0cfa864a32d8980 Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Fri, 19 Mar 2021 21:52:36 +1100 Subject: [PATCH 022/137] First pass at a supervisor.conf file --- deploy/inventree.conf | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 deploy/inventree.conf diff --git a/deploy/inventree.conf b/deploy/inventree.conf new file mode 100644 index 0000000000..5893b19e67 --- /dev/null +++ b/deploy/inventree.conf @@ -0,0 +1,31 @@ +; # Supervisor Config File +; Example configuration file for running InvenTree using supervisor +; There are two separate processes which must be managed: +; +; ## Web Server +; The InvenTree server must be launched and managed as a process +; The recommended way to handle the web server is to use gunicorn +; +; ## Background Tasks +; A background task manager processes long-running and periodic tasks +; InvenTree uses django-q for this purpose + +[supervisord] +environment=INVENTREE_SRC_DIR="/mnt/c/inventree/InvenTree", INVENTREE_BIN_DIR="/mnt/c/inventree/InvenTree" + +[program:inventree-server] +directory=/mnt/c/inventree/InvenTree +command=/mnt/c/inventree/inventree-env/bin/gunicorn -c gunicorn.conf.py InvenTree.wsgi +autostart=true +autorestart=true +startretries=3 +stderr_logfile=/var/log/inventree/server.err.log +stdout_logfile=/var/log/inventree/server.out.log + +[program:inventree-cluster] +directory=/mnt/c/inventree/InvenTree +command=/mnt/c/inventree/inventree-env/bin/python manage.py qcluster +autostart=true +autorestart=true +stderr_logfile=/var/log/inventree/cluster.err.log +stdout_logfile=/var/log/inventree/cluster.out.log From b7718d9c6c59361ae7d269c2d5e3061cfc01286f Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Fri, 19 Mar 2021 22:08:11 +1100 Subject: [PATCH 023/137] Specify user and logfile --- deploy/inventree.conf | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/deploy/inventree.conf b/deploy/inventree.conf index 5893b19e67..8acaf04cac 100644 --- a/deploy/inventree.conf +++ b/deploy/inventree.conf @@ -11,7 +11,8 @@ ; InvenTree uses django-q for this purpose [supervisord] -environment=INVENTREE_SRC_DIR="/mnt/c/inventree/InvenTree", INVENTREE_BIN_DIR="/mnt/c/inventree/InvenTree" +;environment=INVENTREE_SRC_DIR="/mnt/c/inventree/InvenTree", INVENTREE_BIN_DIR="/mnt/c/inventree/InvenTree" +logfile=/var/log/inventree/supervisor.log [program:inventree-server] directory=/mnt/c/inventree/InvenTree @@ -21,6 +22,7 @@ autorestart=true startretries=3 stderr_logfile=/var/log/inventree/server.err.log stdout_logfile=/var/log/inventree/server.out.log +user=inventree [program:inventree-cluster] directory=/mnt/c/inventree/InvenTree @@ -29,3 +31,4 @@ autostart=true autorestart=true stderr_logfile=/var/log/inventree/cluster.err.log stdout_logfile=/var/log/inventree/cluster.out.log +user=inventree \ No newline at end of file From 8fd666e6629653fe3675708d2cc2e5c122dc3c0d Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Mon, 22 Mar 2021 11:20:09 +1100 Subject: [PATCH 024/137] Improvements for "check for updates" task - Let it throw an error if something fails - Errors are caught as "unsuccessful tasks" --- InvenTree/InvenTree/apps.py | 2 +- InvenTree/InvenTree/tasks.py | 21 ++++++++++----------- 2 files changed, 11 insertions(+), 12 deletions(-) diff --git a/InvenTree/InvenTree/apps.py b/InvenTree/InvenTree/apps.py index 1022a75301..6a2e363789 100644 --- a/InvenTree/InvenTree/apps.py +++ b/InvenTree/InvenTree/apps.py @@ -29,7 +29,7 @@ class InvenTreeConfig(AppConfig): InvenTree.tasks.schedule_task( 'InvenTree.tasks.delete_successful_tasks', - schedule_type=Schedule.WEEKLY, + schedule_type=Schedule.DAILY, ) InvenTree.tasks.schedule_task( diff --git a/InvenTree/InvenTree/tasks.py b/InvenTree/InvenTree/tasks.py index 4ba34ca7ba..eba145c660 100644 --- a/InvenTree/InvenTree/tasks.py +++ b/InvenTree/InvenTree/tasks.py @@ -21,6 +21,9 @@ def schedule_task(taskname, **kwargs): If the task has already been scheduled, ignore! """ + # If unspecified, repeat indefinitely + repeats = kwargs.pop('repeats', -1) + try: from django_q.models import Schedule except (AppRegistryNotReady): @@ -34,7 +37,9 @@ def schedule_task(taskname, **kwargs): logger.info(f"Creating scheduled task '{taskname}'") Schedule.objects.create( + name=taskname, func=taskname, + repeats=repeats, **kwargs ) except (OperationalError, ProgrammingError): @@ -98,21 +103,20 @@ def check_for_updates(): try: import common.models except AppRegistryNotReady: + # Apps not yet loaded! return response = requests.get('https://api.github.com/repos/inventree/inventree/releases/latest') if not response.status_code == 200: - logger.warning(f'Unexpected status code from GitHub API: {response.status_code}') - return + raise ValueError(f'Unexpected status code from GitHub API: {response.status_code}') data = json.loads(response.text) tag = data.get('tag_name', None) if not tag: - logger.warning("'tag_name' missing from GitHub response") - return + raise ValueError("'tag_name' missing from GitHub response") match = re.match(r"^.*(\d+)\.(\d+)\.(\d+).*$", tag) @@ -120,15 +124,10 @@ def check_for_updates(): logger.warning(f"Version '{tag}' did not match expected pattern") return - try: - latest_version = [int(x) for x in match.groups()] - except (ValueError): - logger.warning(f"Version '{tag}' not integer format") - return + latest_version = [int(x) for x in match.groups()] if not len(latest_version) == 3: - logger.warning(f"Version '{tag}' is not correct format") - return + raise ValueError(f"Version '{tag}' is not correct format") logger.info(f"Latest InvenTree version: '{tag}'") From edbbfff1afe5f137ec14a9dd38ac19f8a43c8293 Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Tue, 23 Mar 2021 19:58:29 +1100 Subject: [PATCH 025/137] Reduce frequency of heartbeat --- InvenTree/InvenTree/apps.py | 2 +- InvenTree/InvenTree/status.py | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/InvenTree/InvenTree/apps.py b/InvenTree/InvenTree/apps.py index 6a2e363789..07f565e012 100644 --- a/InvenTree/InvenTree/apps.py +++ b/InvenTree/InvenTree/apps.py @@ -40,5 +40,5 @@ class InvenTreeConfig(AppConfig): InvenTree.tasks.schedule_task( 'InvenTree.tasks.heartbeat', schedule_type=Schedule.MINUTES, - minutes=5 + minutes=15 ) diff --git a/InvenTree/InvenTree/status.py b/InvenTree/InvenTree/status.py index 8c65bdc302..841a54f92b 100644 --- a/InvenTree/InvenTree/status.py +++ b/InvenTree/InvenTree/status.py @@ -29,12 +29,12 @@ def is_q_cluster_running(**kwargs): """ Sometimes Stat.get_all() returns []. - In this case we have the 'heartbeat' task running every five minutes. - Check to see if we have a result within the last ten minutes + In this case we have the 'heartbeat' task running every 15 minutes. + Check to see if we have a result within the last 20 minutes """ now = datetime.now() - past = now - timedelta(minutes=10) + past = now - timedelta(minutes=20) results = Success.objects.filter( func='InvenTree.tasks.heartbeat', From e3f49b8996a664d5f1b9012327c6954761a8dc97 Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Wed, 24 Mar 2021 08:31:53 +1100 Subject: [PATCH 026/137] Install invoke and gunicorn as part of requirements.txt --- requirements.txt | 2 ++ 1 file changed, 2 insertions(+) diff --git a/requirements.txt b/requirements.txt index 2c8bd9f3e7..4749a78a91 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,3 +1,4 @@ +invoke>=1.4.0 # Invoke build tool wheel>=0.34.2 # Wheel Django==3.0.7 # Django package pillow==7.1.0 # Image manipulation @@ -31,5 +32,6 @@ django-test-migrations==1.1.0 # Unit testing for database migrations python-barcode[images]==0.13.1 # Barcode generator qrcode[pil]==6.1 # QR code generator django-q==1.3.4 # Background task scheduling +gunicorn>=20.0.4 # Gunicorn web server inventree # Install the latest version of the InvenTree API python library From ce64feb79dcb084750d53ce936c070a1aa165bb1 Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Wed, 24 Mar 2021 08:32:00 +1100 Subject: [PATCH 027/137] Update supervisor conf file --- deploy/inventree.conf | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/deploy/inventree.conf b/deploy/inventree.conf index 8acaf04cac..a99bbe58e3 100644 --- a/deploy/inventree.conf +++ b/deploy/inventree.conf @@ -11,24 +11,28 @@ ; InvenTree uses django-q for this purpose [supervisord] -;environment=INVENTREE_SRC_DIR="/mnt/c/inventree/InvenTree", INVENTREE_BIN_DIR="/mnt/c/inventree/InvenTree" -logfile=/var/log/inventree/supervisor.log +; Change this path if log files are stored elsewhere +logfile=/home/inventree/log/supervisor.log [program:inventree-server] +user=inventree directory=/mnt/c/inventree/InvenTree command=/mnt/c/inventree/inventree-env/bin/gunicorn -c gunicorn.conf.py InvenTree.wsgi +startsecs=10 autostart=true autorestart=true startretries=3 -stderr_logfile=/var/log/inventree/server.err.log -stdout_logfile=/var/log/inventree/server.out.log -user=inventree +; Change these paths if log files are stored elsewhere +stderr_logfile=/home/inventree/log/server.err.log +stdout_logfile=/home/inventree/log/server.out.log [program:inventree-cluster] +user=inventree directory=/mnt/c/inventree/InvenTree command=/mnt/c/inventree/inventree-env/bin/python manage.py qcluster +startsecs=10 autostart=true autorestart=true -stderr_logfile=/var/log/inventree/cluster.err.log -stdout_logfile=/var/log/inventree/cluster.out.log -user=inventree \ No newline at end of file +; Change these paths if log files are stored elsewhere +stderr_logfile=/home/inventree/log/cluster.err.log +stdout_logfile=/home/inventree/log/cluster.out.log \ No newline at end of file From df0ab2359f8c3911d644cf7aba36f1c0c4400e0c Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Wed, 24 Mar 2021 22:24:47 +1100 Subject: [PATCH 028/137] Remove invoke tasks which perform system commands - tasks.py is now for InvenTree specific tasks only --- InvenTree/InvenTree/settings.py | 1 - InvenTree/config_template.yaml | 31 ++++++++++++++++++------------- deploy/inventree.conf | 8 ++++---- tasks.py | 22 ---------------------- 4 files changed, 22 insertions(+), 40 deletions(-) diff --git a/InvenTree/InvenTree/settings.py b/InvenTree/InvenTree/settings.py index 6d7c937d54..73a38b484d 100644 --- a/InvenTree/InvenTree/settings.py +++ b/InvenTree/InvenTree/settings.py @@ -45,7 +45,6 @@ def get_setting(environment_var, backup_val, default_value=None): return default_value - # Determine if we are running in "test" mode e.g. "manage.py test" TESTING = 'test' in sys.argv diff --git a/InvenTree/config_template.yaml b/InvenTree/config_template.yaml index 18e3197cca..343ab312e4 100644 --- a/InvenTree/config_template.yaml +++ b/InvenTree/config_template.yaml @@ -7,11 +7,9 @@ # with the prefix INVENTREE_DB_ # e.g INVENTREE_DB_NAME / INVENTREE_DB_USER / INVENTREE_DB_PASSWORD database: - # Default configuration - sqlite filesystem database - ENGINE: sqlite3 - NAME: '../inventree_default_db.sqlite3' + # Uncomment (and edit) one of the database configurations below, + # or specify database options using environment variables - # For more complex database installations, further parameters are required # Refer to the django documentation for full list of options # --- Available options: --- @@ -27,14 +25,22 @@ database: # --- Example Configuration - sqlite3 --- # ENGINE: sqlite3 - # NAME: '/path/to/database.sqlite3' + # NAME: '/home/inventree/database.sqlite3' # --- Example Configuration - MySQL --- #ENGINE: django.db.backends.mysql #NAME: inventree - #USER: inventree_username + #USER: inventree #PASSWORD: inventree_password - #HOST: '127.0.0.1' + #HOST: 'localhost' + #PORT: '3306' + + # --- Example Configuration - Postgresql --- + #ENGINE: django.db.backends.postgresql + #NAME: inventree + #USER: inventree + #PASSWORD: inventree_password + #HOST: 'localhost' #PORT: '5432' # Select default system language (default is 'en-us') @@ -86,13 +92,12 @@ cors: # - https://sub.example.com # MEDIA_ROOT is the local filesystem location for storing uploaded files -# By default, it is stored in a directory named 'inventree_media' local to the InvenTree directory -# This should be changed for a production installation -media_root: '../inventree_media' +# By default, it is stored under /home/inventree +media_root: '/home/inventree/media' # STATIC_ROOT is the local filesystem location for storing static files -# By default it is stored in a directory named 'inventree_static' local to the InvenTree directory -static_root: '../inventree_static' +# By default, it is stored under /home/inventree +static_root: '/home/inventree/static' # Optional URL schemes to allow in URL fields # By default, only the following schemes are allowed: ['http', 'https', 'ftp', 'ftps'] @@ -105,7 +110,7 @@ static_root: '../inventree_static' # Backup options # Set the backup_dir parameter to store backup files in a specific location # If unspecified, the local user's temp directory will be used -#backup_dir: '/home/inventree/backup/' +backup_dir: '/home/inventree/backup/' # Permit custom authentication backends #authentication_backends: diff --git a/deploy/inventree.conf b/deploy/inventree.conf index a99bbe58e3..782b6ae2f6 100644 --- a/deploy/inventree.conf +++ b/deploy/inventree.conf @@ -16,8 +16,8 @@ logfile=/home/inventree/log/supervisor.log [program:inventree-server] user=inventree -directory=/mnt/c/inventree/InvenTree -command=/mnt/c/inventree/inventree-env/bin/gunicorn -c gunicorn.conf.py InvenTree.wsgi +directory=/home/inventree/src/InvenTree +command=/home/inventree/env/bin/gunicorn -c gunicorn.conf.py InvenTree.wsgi startsecs=10 autostart=true autorestart=true @@ -28,8 +28,8 @@ stdout_logfile=/home/inventree/log/server.out.log [program:inventree-cluster] user=inventree -directory=/mnt/c/inventree/InvenTree -command=/mnt/c/inventree/inventree-env/bin/python manage.py qcluster +directory=/home/inventree/src/InvenTree +command=/home/inventree/env/bin/python manage.py qcluster startsecs=10 autostart=true autorestart=true diff --git a/tasks.py b/tasks.py index 579887c809..179d73546a 100644 --- a/tasks.py +++ b/tasks.py @@ -231,28 +231,6 @@ def coverage(c): # Generate coverage report c.run('coverage html') -@task -def mysql(c): - """ - Install packages required for using InvenTree with a MySQL database. - """ - - print('Installing packages required for MySQL') - - c.run('sudo apt-get install mysql-server libmysqlclient-dev') - c.run('pip3 install mysqlclient') - -@task -def postgresql(c): - """ - Install packages required for using InvenTree with a PostgreSQL database - """ - - print("Installing packages required for PostgreSQL") - - c.run('sudo apt-get install postgresql postgresql-contrib libpq-dev') - c.run('pip3 install psycopg2') - @task(help={'filename': "Output filename (default = 'data.json')"}) def export_records(c, filename='data.json'): """ From 3a0c68bf5c0cd84b225fcbe32fd2cba12e5217f0 Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Wed, 24 Mar 2021 22:42:04 +1100 Subject: [PATCH 029/137] Add invoke task to start background worker --- tasks.py | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/tasks.py b/tasks.py index 179d73546a..2d7d395d10 100644 --- a/tasks.py +++ b/tasks.py @@ -111,6 +111,13 @@ def shell(c): manage(c, 'shell', pty=True) +@task +def worker(c): + """ + Run the InvenTree background worker process + """ + + manage(c, 'qcluster', pty=True) @task def superuser(c): From 3ddbb6a6cd9e85f5d81f845ce5ef564db5091a7c Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Tue, 30 Mar 2021 20:53:26 +1100 Subject: [PATCH 030/137] Check for empty values --- InvenTree/InvenTree/settings.py | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/InvenTree/InvenTree/settings.py b/InvenTree/InvenTree/settings.py index 73a38b484d..2822202f13 100644 --- a/InvenTree/InvenTree/settings.py +++ b/InvenTree/InvenTree/settings.py @@ -362,6 +362,10 @@ else: # Extract database configuration from the config.yaml file db_config = CONFIG.get('database', {}) + # Default action if db_config not specified in yaml file + if not db_config: + db_config = {} + # If a particular database option is not specified in the config file, # look for it in the environmental variables # e.g. INVENTREE_DB_NAME / INVENTREE_DB_USER / etc From 39b2c5f943cc3de5de03e6ca347411c40a4c1cef Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Tue, 30 Mar 2021 21:18:09 +1100 Subject: [PATCH 031/137] Reintroduce default database config --- InvenTree/config_template.yaml | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/InvenTree/config_template.yaml b/InvenTree/config_template.yaml index 343ab312e4..c529182bb7 100644 --- a/InvenTree/config_template.yaml +++ b/InvenTree/config_template.yaml @@ -10,6 +10,11 @@ database: # Uncomment (and edit) one of the database configurations below, # or specify database options using environment variables + # Default installation uses a simple sqlite database + # For production, consider changing this! + ENGINE: sqlite3 + NAME: '/home/inventree/database.sqlite3' + # Refer to the django documentation for full list of options # --- Available options: --- From e7ed4c4eab1fdaf8585a57fa1271b8be9a7ef604 Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Tue, 30 Mar 2021 21:24:06 +1100 Subject: [PATCH 032/137] Travis fixes --- .travis.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.travis.yml b/.travis.yml index 52d0ef1c5c..fdf3be5bc7 100644 --- a/.travis.yml +++ b/.travis.yml @@ -14,6 +14,8 @@ addons: - sqlite3 before_install: + - sudo useradd --create-home inventree + - sudo mkdir /home/inventree/media /home/media/static /home/media/backup - sudo apt-get update - sudo apt-get install gettext - sudo apt-get install mysql-server libmysqlclient-dev From 83f8afe113022b6f7ca6d6f3d0ed0caecdd7ba87 Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Tue, 30 Mar 2021 21:33:49 +1100 Subject: [PATCH 033/137] Add github actions --- .github/workflows/ci.yaml | 32 ++++++++++++++++++++++++++++++++ .github/workflows/style.yaml | 11 +++++++++++ 2 files changed, 43 insertions(+) create mode 100644 .github/workflows/ci.yaml create mode 100644 .github/workflows/style.yaml diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml new file mode 100644 index 0000000000..f935bdda7f --- /dev/null +++ b/.github/workflows/ci.yaml @@ -0,0 +1,32 @@ +name: Django CI + +on: + push: + branches: [ $default-branch ] + pull_request: + branches: [ $default-branch ] + +jobs: + + # Run tests on an SQLite database + sqlite: + + runs-on: ubuntu-latest + + strategy: + max-parallel: 4 + matrix: + python-version: [3.7, 3.8, 3.9] + + steps: + - uses: actions/checkout@v2 + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@v2 + with: + python-version: ${{ matrix.python-version }} + - name: Install dependencies + run: | + pip3 install invoke + invoke install + - name: Run Tests + run: invoke coverage \ No newline at end of file diff --git a/.github/workflows/style.yaml b/.github/workflows/style.yaml new file mode 100644 index 0000000000..90dae47857 --- /dev/null +++ b/.github/workflows/style.yaml @@ -0,0 +1,11 @@ +name: Style Checks + +on: push + +jobs: + pep: + runs-on: ubuntu-latest + + steps: + - name: Checkout code + uses: actions/checkout@v2 \ No newline at end of file From 3f257279ee3a53ba7bfa1f27c3daec8842617770 Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Wed, 31 Mar 2021 22:31:50 +1100 Subject: [PATCH 034/137] Specify directories for CI --- .github/workflows/coverage.yaml | 2 ++ .github/workflows/mariadb.yaml | 2 ++ .github/workflows/mysql.yaml | 2 ++ .github/workflows/postgresql.yaml | 2 ++ InvenTree/config_template.yaml | 3 +++ 5 files changed, 11 insertions(+) diff --git a/.github/workflows/coverage.yaml b/.github/workflows/coverage.yaml index 85362ae917..2b883490d2 100644 --- a/.github/workflows/coverage.yaml +++ b/.github/workflows/coverage.yaml @@ -16,6 +16,8 @@ jobs: INVENTREE_DB_NAME: './test_db.sqlite' INVENTREE_DB_ENGINE: django.db.backends.sqlite3 INVENTREE_DEBUG: info + INVENTREE_MEDIA_ROOT: ./media + INVENTREE_STATIC_ROOT: ./static steps: - name: Checkout Code diff --git a/.github/workflows/mariadb.yaml b/.github/workflows/mariadb.yaml index 2ae02c2bd0..f976cfa088 100644 --- a/.github/workflows/mariadb.yaml +++ b/.github/workflows/mariadb.yaml @@ -16,6 +16,8 @@ jobs: INVENTREE_DB_HOST: '127.0.0.1' INVENTREE_DB_PORT: 3306 INVENTREE_DEBUG: info + INVENTREE_MEDIA_ROOT: ./media + INVENTREE_STATIC_ROOT: ./static services: mariadb: diff --git a/.github/workflows/mysql.yaml b/.github/workflows/mysql.yaml index 7d3ee8d6ae..70acad66a1 100644 --- a/.github/workflows/mysql.yaml +++ b/.github/workflows/mysql.yaml @@ -18,6 +18,8 @@ jobs: INVENTREE_DB_HOST: '127.0.0.1' INVENTREE_DB_PORT: 3306 INVENTREE_DEBUG: info + INVENTREE_MEDIA_ROOT: ./media + INVENTREE_STATIC_ROOT: ./static services: mysql: diff --git a/.github/workflows/postgresql.yaml b/.github/workflows/postgresql.yaml index aab05205cc..76981e5a1b 100644 --- a/.github/workflows/postgresql.yaml +++ b/.github/workflows/postgresql.yaml @@ -18,6 +18,8 @@ jobs: INVENTREE_DB_HOST: '127.0.0.1' INVENTREE_DB_PORT: 5432 INVENTREE_DEBUG: info + INVENTREE_MEDIA_ROOT: ./media + INVENTREE_STATIC_ROOT: ./static services: postgres: diff --git a/InvenTree/config_template.yaml b/InvenTree/config_template.yaml index c529182bb7..bab673306f 100644 --- a/InvenTree/config_template.yaml +++ b/InvenTree/config_template.yaml @@ -98,10 +98,12 @@ cors: # MEDIA_ROOT is the local filesystem location for storing uploaded files # By default, it is stored under /home/inventree +# Use environment variable INVENTREE_MEDIA_ROOT media_root: '/home/inventree/media' # STATIC_ROOT is the local filesystem location for storing static files # By default, it is stored under /home/inventree +# Use environment variable INVENTREE_STATIC_ROOT static_root: '/home/inventree/static' # Optional URL schemes to allow in URL fields @@ -115,6 +117,7 @@ static_root: '/home/inventree/static' # Backup options # Set the backup_dir parameter to store backup files in a specific location # If unspecified, the local user's temp directory will be used +# Use environment variable INVENTREE_BACKUP_DIR backup_dir: '/home/inventree/backup/' # Permit custom authentication backends From c0a0ca458873e1bf3aec855b7646b974d675a8d8 Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Wed, 31 Mar 2021 22:35:48 +1100 Subject: [PATCH 035/137] PEP fix --- InvenTree/InvenTree/settings.py | 1 + 1 file changed, 1 insertion(+) diff --git a/InvenTree/InvenTree/settings.py b/InvenTree/InvenTree/settings.py index f49c5d1f75..eee69c0780 100644 --- a/InvenTree/InvenTree/settings.py +++ b/InvenTree/InvenTree/settings.py @@ -45,6 +45,7 @@ def get_setting(environment_var, backup_val, default_value=None): return default_value + # Determine if we are running in "test" mode e.g. "manage.py test" TESTING = 'test' in sys.argv From ab57fd3b764a3e0411c81919a175daecb6627afc Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Wed, 31 Mar 2021 22:45:42 +1100 Subject: [PATCH 036/137] Build docker image --- .github/workflows/docker.yaml | 16 ++++++++++++ docker/Dockerfile | 46 +++++++++++++++++++++++++++++++++++ 2 files changed, 62 insertions(+) create mode 100644 .github/workflows/docker.yaml create mode 100644 docker/Dockerfile diff --git a/.github/workflows/docker.yaml b/.github/workflows/docker.yaml new file mode 100644 index 0000000000..448babcc31 --- /dev/null +++ b/.github/workflows/docker.yaml @@ -0,0 +1,16 @@ +# Test that the docker file builds correctly + +name: Docker + +on: ["push", "pull_request"] + +jobs: + + docker: + runs-on: ubtun-latest + + steps: + - uses: actions/checkout@v2 + - name: Build Docker Image + run: docker build . --file docker/Dockerfile --tag inventree-:$(date +%s) + \ No newline at end of file diff --git a/docker/Dockerfile b/docker/Dockerfile new file mode 100644 index 0000000000..da0ddebf39 --- /dev/null +++ b/docker/Dockerfile @@ -0,0 +1,46 @@ +FROM python:alpine as production + +# Configuration params +ARG INVENTREE_REPO="https://github.com/inventree/InvenTree.git" +ARG INVENTREE_VERSION="master" +ARG INVENTREE_HOME="/home/inventree" + +ENV PYTHONUNBUFFERED 1 + +# InvenTree paths +ENV INVENTREE_SRC_DIR="$INVENTREE_HOME/src" +ENV INVENTREE_STATIC_ROOT="$INVENTREE_HOME/static" +ENV INVENTREE_MEDIA_ROOT="$INVENTREE_HOME/media" +ENV INVENTREE_LOG_DIR="$INVENTREE_HOME/log" +ENV INVENTREE_BACKUP_DIR="$INVENTREE_HOME/backup" +ENV INVENTREE_VENV="$INVENTREE_HOME/env" + +RUN echo "Installing InvenTree '${INVENTREE_VERSION}' from ${INVENTREE_REPO}" + +# Create user account +RUN useradd -ms /bin/bash inventree +USER inventree +WORKDIR /home/inventree + +# Clone source code +RUN git clone --branch $INVENTREE_VERSION --depth 1 ${INVENTREE_REPO} ${INVENTREE_SRC_DIR} + +# Install required system packages +RUN apk add --no-cache postgresql-contrib postgresql-dev libpq-dev +RUN apk add --no-cache libmysqlclient-dev + +# Install required PIP packages +RUN python -m venv $INVENTREE_VENV && pip install --upgrade pip setuptools wheel +RUN python -m venv $INVENTREE_VENV && pip install --no-cache-dir -U invoke +RUN python -m venv $INVENTREE_VENV && pip install --no-cache-dir -U psycopg2 mysqlclient pgcli mariadb + +# Install InvenTree packages +RUN python -m venv $INVENTREE_VENV && pip install --no-cache-dir -U -r $INVENTREE_SRC_DIR/requirements.txt + +# Install supervisor +RUN apt add --no-cache supervisor + +# Copy supervisor file +COPY deploy/inventree.conf /etc/supervisor/conf.d/inventree.conf + +RUN sudo service supervisor start From 1a7b6e26136418cb7bea2289b56c5d902c5cddfd Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Wed, 31 Mar 2021 22:47:41 +1100 Subject: [PATCH 037/137] Fix --- .github/workflows/docker.yaml | 2 +- docker/Dockerfile | 3 +++ 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/.github/workflows/docker.yaml b/.github/workflows/docker.yaml index 448babcc31..9d08869db3 100644 --- a/.github/workflows/docker.yaml +++ b/.github/workflows/docker.yaml @@ -7,7 +7,7 @@ on: ["push", "pull_request"] jobs: docker: - runs-on: ubtun-latest + runs-on: ubtunu-latest steps: - uses: actions/checkout@v2 diff --git a/docker/Dockerfile b/docker/Dockerfile index da0ddebf39..d2301e66fb 100644 --- a/docker/Dockerfile +++ b/docker/Dockerfile @@ -40,6 +40,9 @@ RUN python -m venv $INVENTREE_VENV && pip install --no-cache-dir -U -r $INVENTRE # Install supervisor RUN apt add --no-cache supervisor +# Create required directories +RUN mkdir /home/inventree/media /home/inventree/static /home/inventree/log /home/inventree/backup + # Copy supervisor file COPY deploy/inventree.conf /etc/supervisor/conf.d/inventree.conf From 6017cad6b3ed6e4595025ed56803f6198778fadf Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Wed, 31 Mar 2021 22:48:58 +1100 Subject: [PATCH 038/137] So apparently I cannot spell... --- .github/workflows/docker.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docker.yaml b/.github/workflows/docker.yaml index 9d08869db3..270ddc3600 100644 --- a/.github/workflows/docker.yaml +++ b/.github/workflows/docker.yaml @@ -7,7 +7,7 @@ on: ["push", "pull_request"] jobs: docker: - runs-on: ubtunu-latest + runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 From 2746396d11a8fb93cf8bfee5f42de0cb2b396975 Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Wed, 31 Mar 2021 22:50:41 +1100 Subject: [PATCH 039/137] Fix tag name --- .github/workflows/docker.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docker.yaml b/.github/workflows/docker.yaml index 270ddc3600..749616d716 100644 --- a/.github/workflows/docker.yaml +++ b/.github/workflows/docker.yaml @@ -12,5 +12,5 @@ jobs: steps: - uses: actions/checkout@v2 - name: Build Docker Image - run: docker build . --file docker/Dockerfile --tag inventree-:$(date +%s) + run: docker build . --file docker/Dockerfile --tag inventree:$(date +%s) \ No newline at end of file From 58bfc80f793e8bc3ff538cfd0d637a367b38a907 Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Wed, 31 Mar 2021 22:54:17 +1100 Subject: [PATCH 040/137] Alpine uses different commands --- docker/Dockerfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docker/Dockerfile b/docker/Dockerfile index d2301e66fb..de3c79235f 100644 --- a/docker/Dockerfile +++ b/docker/Dockerfile @@ -18,7 +18,7 @@ ENV INVENTREE_VENV="$INVENTREE_HOME/env" RUN echo "Installing InvenTree '${INVENTREE_VERSION}' from ${INVENTREE_REPO}" # Create user account -RUN useradd -ms /bin/bash inventree +RUN addgroup -S inventreegroup && adduser -S inventree -G inventreegroup USER inventree WORKDIR /home/inventree From 601aff82832b6a20e0d7672da46d17abf22c9617 Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Wed, 31 Mar 2021 22:55:44 +1100 Subject: [PATCH 041/137] Install git --- docker/Dockerfile | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docker/Dockerfile b/docker/Dockerfile index de3c79235f..24f99764d6 100644 --- a/docker/Dockerfile +++ b/docker/Dockerfile @@ -22,6 +22,9 @@ RUN addgroup -S inventreegroup && adduser -S inventree -G inventreegroup USER inventree WORKDIR /home/inventree +# Install git +RUN apt add --no-cache git + # Clone source code RUN git clone --branch $INVENTREE_VERSION --depth 1 ${INVENTREE_REPO} ${INVENTREE_SRC_DIR} From 42b400e619464bd22fd7328d422880f527eb6687 Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Wed, 31 Mar 2021 22:58:32 +1100 Subject: [PATCH 042/137] typo fix --- docker/Dockerfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docker/Dockerfile b/docker/Dockerfile index 24f99764d6..f4ad7efddd 100644 --- a/docker/Dockerfile +++ b/docker/Dockerfile @@ -23,7 +23,7 @@ USER inventree WORKDIR /home/inventree # Install git -RUN apt add --no-cache git +RUN apk add --no-cache git # Clone source code RUN git clone --branch $INVENTREE_VERSION --depth 1 ${INVENTREE_REPO} ${INVENTREE_SRC_DIR} From 1f881dd041eaf648981a33eeabea9473abb8c6b3 Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Wed, 31 Mar 2021 23:00:22 +1100 Subject: [PATCH 043/137] Run as root --- docker/Dockerfile | 1 - 1 file changed, 1 deletion(-) diff --git a/docker/Dockerfile b/docker/Dockerfile index f4ad7efddd..a00cf1982a 100644 --- a/docker/Dockerfile +++ b/docker/Dockerfile @@ -19,7 +19,6 @@ RUN echo "Installing InvenTree '${INVENTREE_VERSION}' from ${INVENTREE_REPO}" # Create user account RUN addgroup -S inventreegroup && adduser -S inventree -G inventreegroup -USER inventree WORKDIR /home/inventree # Install git From 61f8b982ce216d512f32dea0b70f67a07dfe6c4a Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Wed, 31 Mar 2021 23:03:13 +1100 Subject: [PATCH 044/137] lib name fix --- docker/Dockerfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docker/Dockerfile b/docker/Dockerfile index a00cf1982a..c01fca9075 100644 --- a/docker/Dockerfile +++ b/docker/Dockerfile @@ -28,7 +28,7 @@ RUN apk add --no-cache git RUN git clone --branch $INVENTREE_VERSION --depth 1 ${INVENTREE_REPO} ${INVENTREE_SRC_DIR} # Install required system packages -RUN apk add --no-cache postgresql-contrib postgresql-dev libpq-dev +RUN apk add --no-cache postgresql-contrib postgresql-dev libpq RUN apk add --no-cache libmysqlclient-dev # Install required PIP packages From 251ec7a02f82325b9a30ac7e663874aa0d5d9fc9 Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Wed, 31 Mar 2021 23:06:54 +1100 Subject: [PATCH 045/137] Fix lib names --- docker/Dockerfile | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docker/Dockerfile b/docker/Dockerfile index c01fca9075..b049e2f886 100644 --- a/docker/Dockerfile +++ b/docker/Dockerfile @@ -29,7 +29,8 @@ RUN git clone --branch $INVENTREE_VERSION --depth 1 ${INVENTREE_REPO} ${INVENTRE # Install required system packages RUN apk add --no-cache postgresql-contrib postgresql-dev libpq -RUN apk add --no-cache libmysqlclient-dev +RUN apk add --no-cache libmysqlclient +RUN apk add --no-cache mariadb-connector-c mariadb-dev # Install required PIP packages RUN python -m venv $INVENTREE_VENV && pip install --upgrade pip setuptools wheel From 24d36e0b661ef793f55489e5dbd3b57213fdc303 Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Wed, 31 Mar 2021 23:09:24 +1100 Subject: [PATCH 046/137] Getting there... --- docker/Dockerfile | 1 - 1 file changed, 1 deletion(-) diff --git a/docker/Dockerfile b/docker/Dockerfile index b049e2f886..01f6b16d99 100644 --- a/docker/Dockerfile +++ b/docker/Dockerfile @@ -29,7 +29,6 @@ RUN git clone --branch $INVENTREE_VERSION --depth 1 ${INVENTREE_REPO} ${INVENTRE # Install required system packages RUN apk add --no-cache postgresql-contrib postgresql-dev libpq -RUN apk add --no-cache libmysqlclient RUN apk add --no-cache mariadb-connector-c mariadb-dev # Install required PIP packages From 286cf9b102b51ed4045676f26d3886e608965f23 Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Wed, 31 Mar 2021 23:12:27 +1100 Subject: [PATCH 047/137] gcc required --- docker/Dockerfile | 1 + 1 file changed, 1 insertion(+) diff --git a/docker/Dockerfile b/docker/Dockerfile index 01f6b16d99..567e3390b0 100644 --- a/docker/Dockerfile +++ b/docker/Dockerfile @@ -28,6 +28,7 @@ RUN apk add --no-cache git RUN git clone --branch $INVENTREE_VERSION --depth 1 ${INVENTREE_REPO} ${INVENTREE_SRC_DIR} # Install required system packages +RUN apk add --no-cache gcc g++ RUN apk add --no-cache postgresql-contrib postgresql-dev libpq RUN apk add --no-cache mariadb-connector-c mariadb-dev From 8b227ce297ab8d315b91cf0801230d1da7ffa528 Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Wed, 31 Mar 2021 23:20:32 +1100 Subject: [PATCH 048/137] More required packages, I guess... --- README.md | 1 + docker/Dockerfile | 18 +++++++++++------- 2 files changed, 12 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 63948c35af..ef0556cceb 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Coverage Status](https://coveralls.io/repos/github/inventree/InvenTree/badge.svg)](https://coveralls.io/github/inventree/InvenTree) ![PEP](https://github.com/inventree/inventree/actions/workflows/style.yaml/badge.svg) +![Docker Build](https://github.com/inventree/inventree/actions/workflows/docker.yaml/badge.svg) ![SQLite](https://github.com/inventree/inventree/actions/workflows/coverage.yaml/badge.svg) ![MySQL](https://github.com/inventree/inventree/actions/workflows/mysql.yaml/badge.svg) ![MariaDB](https://github.com/inventree/inventree/actions/workflows/mariadb.yaml/badge.svg) diff --git a/docker/Dockerfile b/docker/Dockerfile index 567e3390b0..51f147b670 100644 --- a/docker/Dockerfile +++ b/docker/Dockerfile @@ -21,17 +21,21 @@ RUN echo "Installing InvenTree '${INVENTREE_VERSION}' from ${INVENTREE_REPO}" RUN addgroup -S inventreegroup && adduser -S inventree -G inventreegroup WORKDIR /home/inventree -# Install git -RUN apk add --no-cache git +# Install required system packages +RUN apk add --no-cache git make bash \ + gcc libgcc g++ libstdc++ \ + libjpeg-turbo libjpeg-turbo-dev jpeg jpeg-dev \ + libffi libffi-dev \ + zlib zlib-dev \ +RUN apk add --no-cache cairo cairo-dev pango pango-dev +RUN apk add --no-cache fontconfig ttf-droid ttf-liberation ttf-dejavu ttf-opensans ttf-ubuntu-font-family font-croscore font-noto +RUN apk add --no-cache python3 +RUN apk add --no-cache postgresql-contrib postgresql-dev libpq +RUN apk add --no-cache mariadb-connector-c mariadb-dev # Clone source code RUN git clone --branch $INVENTREE_VERSION --depth 1 ${INVENTREE_REPO} ${INVENTREE_SRC_DIR} -# Install required system packages -RUN apk add --no-cache gcc g++ -RUN apk add --no-cache postgresql-contrib postgresql-dev libpq -RUN apk add --no-cache mariadb-connector-c mariadb-dev - # Install required PIP packages RUN python -m venv $INVENTREE_VENV && pip install --upgrade pip setuptools wheel RUN python -m venv $INVENTREE_VENV && pip install --no-cache-dir -U invoke From ff6b127f1b52e77c46380cced4ba8919529c19b5 Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Wed, 31 Mar 2021 23:22:17 +1100 Subject: [PATCH 049/137] Typo fixin' --- docker/Dockerfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docker/Dockerfile b/docker/Dockerfile index 51f147b670..6f15ddbd2d 100644 --- a/docker/Dockerfile +++ b/docker/Dockerfile @@ -26,7 +26,7 @@ RUN apk add --no-cache git make bash \ gcc libgcc g++ libstdc++ \ libjpeg-turbo libjpeg-turbo-dev jpeg jpeg-dev \ libffi libffi-dev \ - zlib zlib-dev \ + zlib zlib-dev RUN apk add --no-cache cairo cairo-dev pango pango-dev RUN apk add --no-cache fontconfig ttf-droid ttf-liberation ttf-dejavu ttf-opensans ttf-ubuntu-font-family font-croscore font-noto RUN apk add --no-cache python3 From 7683cc1aaa4c2d833499792eab3cdba8f6e7d0ce Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Wed, 31 Mar 2021 23:27:01 +1100 Subject: [PATCH 050/137] APK not APT --- docker/Dockerfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docker/Dockerfile b/docker/Dockerfile index 6f15ddbd2d..b5a1826dd2 100644 --- a/docker/Dockerfile +++ b/docker/Dockerfile @@ -45,7 +45,7 @@ RUN python -m venv $INVENTREE_VENV && pip install --no-cache-dir -U psycopg2 mys RUN python -m venv $INVENTREE_VENV && pip install --no-cache-dir -U -r $INVENTREE_SRC_DIR/requirements.txt # Install supervisor -RUN apt add --no-cache supervisor +RUN apk add --no-cache supervisor # Create required directories RUN mkdir /home/inventree/media /home/inventree/static /home/inventree/log /home/inventree/backup From b9f9b26ca5c2b75ba514037734691a911dfa03a7 Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Wed, 31 Mar 2021 23:32:03 +1100 Subject: [PATCH 051/137] Sudo not required, I guess? --- docker/Dockerfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docker/Dockerfile b/docker/Dockerfile index b5a1826dd2..2b5878f223 100644 --- a/docker/Dockerfile +++ b/docker/Dockerfile @@ -53,4 +53,4 @@ RUN mkdir /home/inventree/media /home/inventree/static /home/inventree/log /home # Copy supervisor file COPY deploy/inventree.conf /etc/supervisor/conf.d/inventree.conf -RUN sudo service supervisor start +RUN service supervisor start From b9e81c3c0e685890690f6792277e6f65acd111c2 Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Wed, 31 Mar 2021 23:39:16 +1100 Subject: [PATCH 052/137] Start supervisord Ref: https://advancedweb.hu/supervisor-with-docker-lessons-learned/ --- deploy/inventree.conf | 1 + docker/Dockerfile | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/deploy/inventree.conf b/deploy/inventree.conf index 782b6ae2f6..a55c7163f6 100644 --- a/deploy/inventree.conf +++ b/deploy/inventree.conf @@ -13,6 +13,7 @@ [supervisord] ; Change this path if log files are stored elsewhere logfile=/home/inventree/log/supervisor.log +nodaemon=true [program:inventree-server] user=inventree diff --git a/docker/Dockerfile b/docker/Dockerfile index 2b5878f223..c0b088d952 100644 --- a/docker/Dockerfile +++ b/docker/Dockerfile @@ -53,4 +53,4 @@ RUN mkdir /home/inventree/media /home/inventree/static /home/inventree/log /home # Copy supervisor file COPY deploy/inventree.conf /etc/supervisor/conf.d/inventree.conf -RUN service supervisor start +CMD ["/usr/bin/supervisord"] From 38b9655ad9831eec6410afa21200a1427f316068 Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Thu, 1 Apr 2021 08:43:58 +1100 Subject: [PATCH 053/137] Remove unused workflow --- .github/workflows/ci.yaml | 32 -------------------------------- 1 file changed, 32 deletions(-) delete mode 100644 .github/workflows/ci.yaml diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml deleted file mode 100644 index f935bdda7f..0000000000 --- a/.github/workflows/ci.yaml +++ /dev/null @@ -1,32 +0,0 @@ -name: Django CI - -on: - push: - branches: [ $default-branch ] - pull_request: - branches: [ $default-branch ] - -jobs: - - # Run tests on an SQLite database - sqlite: - - runs-on: ubuntu-latest - - strategy: - max-parallel: 4 - matrix: - python-version: [3.7, 3.8, 3.9] - - steps: - - uses: actions/checkout@v2 - - name: Set up Python ${{ matrix.python-version }} - uses: actions/setup-python@v2 - with: - python-version: ${{ matrix.python-version }} - - name: Install dependencies - run: | - pip3 install invoke - invoke install - - name: Run Tests - run: invoke coverage \ No newline at end of file From 76ab38a06b18ef3d05058cfaeb4906c3b17341c4 Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Thu, 1 Apr 2021 11:35:03 +1100 Subject: [PATCH 054/137] Add docker info --- docker/Dockerfile | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docker/Dockerfile b/docker/Dockerfile index c0b088d952..a0f0595c93 100644 --- a/docker/Dockerfile +++ b/docker/Dockerfile @@ -15,6 +15,16 @@ ENV INVENTREE_LOG_DIR="$INVENTREE_HOME/log" ENV INVENTREE_BACKUP_DIR="$INVENTREE_HOME/backup" ENV INVENTREE_VENV="$INVENTREE_HOME/env" +LABEL org.label-schema.schema-version="1.0" \ + org.label-schema.build-date=$DATE \ + org.label-schema.vendor="inventree" \ + org.label-schema.name="inventree/inventree" \ + org.label-schema.url="https://hub.docker.com/r/inventree/inventree-docker" \ + org.label-schema.version=$INVENTREE_VERSION \ + org.label-schema.vcs-url=$INVENTREE_REPO \ + org.label-schema.vcs-branch=$BRANCH \ + org.label-schema.vcs-ref=$COMMIT + RUN echo "Installing InvenTree '${INVENTREE_VERSION}' from ${INVENTREE_REPO}" # Create user account From 08a1a6cf43761500a4d79dbb940edacdc9b4e831 Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Thu, 1 Apr 2021 20:14:17 +1100 Subject: [PATCH 055/137] Add configuration options for the Dockerfile --- docker/Dockerfile | 51 +++++++++++++++++++++++++++++++---------------- 1 file changed, 34 insertions(+), 17 deletions(-) diff --git a/docker/Dockerfile b/docker/Dockerfile index a0f0595c93..ffba72f4c6 100644 --- a/docker/Dockerfile +++ b/docker/Dockerfile @@ -4,26 +4,43 @@ FROM python:alpine as production ARG INVENTREE_REPO="https://github.com/inventree/InvenTree.git" ARG INVENTREE_VERSION="master" ARG INVENTREE_HOME="/home/inventree" +ARG INVENTREE_PORT="80" + +# Database configuration options +ARG INVENTREE_DB_ENGINE="sqlite" +ARG INVENTREE_DB_NAME="inventree_db.sqlite3" +ARG INVENTREE_DB_HOST="127.0.0.1" +ARG INVENTREE_DB_PORT="" +ARG INVENTREE_DB_USER="" +ARG INVENTREE_DB_PASSWORD="" ENV PYTHONUNBUFFERED 1 # InvenTree paths -ENV INVENTREE_SRC_DIR="$INVENTREE_HOME/src" -ENV INVENTREE_STATIC_ROOT="$INVENTREE_HOME/static" -ENV INVENTREE_MEDIA_ROOT="$INVENTREE_HOME/media" -ENV INVENTREE_LOG_DIR="$INVENTREE_HOME/log" -ENV INVENTREE_BACKUP_DIR="$INVENTREE_HOME/backup" -ENV INVENTREE_VENV="$INVENTREE_HOME/env" +ENV INVENTREE_SRC_DIR="${INVENTREE_HOME}/src" +ENV INVENTREE_STATIC_ROOT="${INVENTREE_HOME}/static" +ENV INVENTREE_MEDIA_ROOT="${INVENTREE_HOME}/media" +ENV INVENTREE_LOG_DIR="${INVENTREE_HOME}/log" +ENV INVENTREE_BACKUP_DIR="${INVENTREE_HOME}/backup" +ENV INVENTREE_VENV="${INVENTREE_HOME}/env" + +# Pass DB configuration through as environment variables +ENV INVENTREE_DB_ENGINE="${INVENTREE_DB_ENGINE}" +ENV INVENTREE_DB_NAME="${INVENTREE_DB_NAME}" +ENV INVENTREE_DB_HOST="${INVENTREE_DB_HOST}" +ENV INVENTREE_DB_PORT="${INVENTREE_DB_PORT}" +ENV INVENTREE_DB_USER="${INVENTREE_DB_USER}" +ENV INVENTREE_DB_PASSWORD="${INVENTREE_DB_PASSWORD}" LABEL org.label-schema.schema-version="1.0" \ - org.label-schema.build-date=$DATE \ + org.label-schema.build-date=${DATE} \ org.label-schema.vendor="inventree" \ org.label-schema.name="inventree/inventree" \ org.label-schema.url="https://hub.docker.com/r/inventree/inventree-docker" \ - org.label-schema.version=$INVENTREE_VERSION \ - org.label-schema.vcs-url=$INVENTREE_REPO \ - org.label-schema.vcs-branch=$BRANCH \ - org.label-schema.vcs-ref=$COMMIT + org.label-schema.version=${INVENTREE_VERSION} \ + org.label-schema.vcs-url=${INVENTREE_REPO} \ + org.label-schema.vcs-branch=${BRANCH} \ + org.label-schema.vcs-ref=${COMMIT} RUN echo "Installing InvenTree '${INVENTREE_VERSION}' from ${INVENTREE_REPO}" @@ -44,15 +61,15 @@ RUN apk add --no-cache postgresql-contrib postgresql-dev libpq RUN apk add --no-cache mariadb-connector-c mariadb-dev # Clone source code -RUN git clone --branch $INVENTREE_VERSION --depth 1 ${INVENTREE_REPO} ${INVENTREE_SRC_DIR} +RUN git clone --branch ${INVENTREE_VERSION} --depth 1 ${INVENTREE_REPO} ${INVENTREE_SRC_DIR} # Install required PIP packages -RUN python -m venv $INVENTREE_VENV && pip install --upgrade pip setuptools wheel -RUN python -m venv $INVENTREE_VENV && pip install --no-cache-dir -U invoke -RUN python -m venv $INVENTREE_VENV && pip install --no-cache-dir -U psycopg2 mysqlclient pgcli mariadb +RUN python -m venv ${INVENTREE_VENV} && pip install --upgrade pip setuptools wheel +RUN python -m venv ${INVENTREE_VENV} && pip install --no-cache-dir -U invoke +RUN python -m venv ${INVENTREE_VENV} && pip install --no-cache-dir -U psycopg2 mysqlclient pgcli mariadb # Install InvenTree packages -RUN python -m venv $INVENTREE_VENV && pip install --no-cache-dir -U -r $INVENTREE_SRC_DIR/requirements.txt +RUN python -m venv ${INVENTREE_VENV} && pip install --no-cache-dir -U -r ${INVENTREE_SRC_DIR}/requirements.txt # Install supervisor RUN apk add --no-cache supervisor @@ -61,6 +78,6 @@ RUN apk add --no-cache supervisor RUN mkdir /home/inventree/media /home/inventree/static /home/inventree/log /home/inventree/backup # Copy supervisor file -COPY deploy/inventree.conf /etc/supervisor/conf.d/inventree.conf +COPY docker/inventree.conf /etc/supervisor/conf.d/inventree.conf CMD ["/usr/bin/supervisord"] From d446f8ddd121f0fa0d6431b33beeab9be1917df8 Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Thu, 1 Apr 2021 20:14:31 +1100 Subject: [PATCH 056/137] Add supervisor conf file specific to docker --- deploy/inventree.conf | 1 - docker/inventree.conf | 41 +++++++++++++++++++++++++++++++++++++++++ 2 files changed, 41 insertions(+), 1 deletion(-) create mode 100644 docker/inventree.conf diff --git a/deploy/inventree.conf b/deploy/inventree.conf index a55c7163f6..782b6ae2f6 100644 --- a/deploy/inventree.conf +++ b/deploy/inventree.conf @@ -13,7 +13,6 @@ [supervisord] ; Change this path if log files are stored elsewhere logfile=/home/inventree/log/supervisor.log -nodaemon=true [program:inventree-server] user=inventree diff --git a/docker/inventree.conf b/docker/inventree.conf new file mode 100644 index 0000000000..dabf9ddafb --- /dev/null +++ b/docker/inventree.conf @@ -0,0 +1,41 @@ +; # Supervisor Config File (for docker build) +; +; This config file is specific to the InvenTree docker build! +; +; There are two separate processes which must be managed: +; +; ## Web Server +; The InvenTree server must be launched and managed as a process +; The recommended way to handle the web server is to use gunicorn +; +; ## Background Tasks +; A background task manager processes long-running and periodic tasks +; InvenTree uses django-q for this purpose + +[supervisord] +; Change this path if log files are stored elsewhere +logfile=/home/inventree/log/supervisor.log +nodaemon=true + +[program:inventree-server] +user=inventree +directory=/home/inventree/src/InvenTree +command=/home/inventree/env/bin/gunicorn -c gunicorn.conf.py InvenTree.wsgi -b 0.0.0.0:%(INVENTREE_PORT)s +startsecs=10 +autostart=true +autorestart=true +startretries=3 +; Change these paths if log files are stored elsewhere +stderr_logfile=/home/inventree/log/server.err.log +stdout_logfile=/home/inventree/log/server.out.log + +[program:inventree-cluster] +user=inventree +directory=/home/inventree/src/InvenTree +command=/home/inventree/env/bin/python manage.py qcluster +startsecs=10 +autostart=true +autorestart=true +; Change these paths if log files are stored elsewhere +stderr_logfile=/home/inventree/log/cluster.err.log +stdout_logfile=/home/inventree/log/cluster.out.log \ No newline at end of file From 839c29117dc516e2a4b76cc194d2da8c3fae3e31 Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Thu, 1 Apr 2021 20:30:51 +1100 Subject: [PATCH 057/137] Dockerfile updates - Pipe supervisor logs to stdout (so they are passed to the docker instance) - Fix supervisor service - Expose home dir and port as env vars --- docker/Dockerfile | 8 ++++++-- docker/{inventree.conf => supervisor.conf} | 16 ++++++++-------- 2 files changed, 14 insertions(+), 10 deletions(-) rename docker/{inventree.conf => supervisor.conf} (69%) diff --git a/docker/Dockerfile b/docker/Dockerfile index ffba72f4c6..04d85184bd 100644 --- a/docker/Dockerfile +++ b/docker/Dockerfile @@ -16,6 +16,10 @@ ARG INVENTREE_DB_PASSWORD="" ENV PYTHONUNBUFFERED 1 +# InvenTree key settings +ENV INVENTREE_HOME="${INVENTREE_HOME}" +ENV INVENTREE_PORT="${INVENTREE_PORT}" + # InvenTree paths ENV INVENTREE_SRC_DIR="${INVENTREE_HOME}/src" ENV INVENTREE_STATIC_ROOT="${INVENTREE_HOME}/static" @@ -78,6 +82,6 @@ RUN apk add --no-cache supervisor RUN mkdir /home/inventree/media /home/inventree/static /home/inventree/log /home/inventree/backup # Copy supervisor file -COPY docker/inventree.conf /etc/supervisor/conf.d/inventree.conf +COPY docker/supervisor.conf /etc/supervisord.conf -CMD ["/usr/bin/supervisord"] +CMD ["/usr/bin/supervisord", "-c", "/etc/supervisord.conf"] diff --git a/docker/inventree.conf b/docker/supervisor.conf similarity index 69% rename from docker/inventree.conf rename to docker/supervisor.conf index dabf9ddafb..72609e5bac 100644 --- a/docker/inventree.conf +++ b/docker/supervisor.conf @@ -13,8 +13,6 @@ ; InvenTree uses django-q for this purpose [supervisord] -; Change this path if log files are stored elsewhere -logfile=/home/inventree/log/supervisor.log nodaemon=true [program:inventree-server] @@ -25,9 +23,10 @@ startsecs=10 autostart=true autorestart=true startretries=3 -; Change these paths if log files are stored elsewhere -stderr_logfile=/home/inventree/log/server.err.log -stdout_logfile=/home/inventree/log/server.out.log +stdout_logfile=/dev/fd/1 +stdout_logfile_maxbytes=0 +stderr_logfile=/dev/fd/2 +stderr_logfile_maxbytes=0 [program:inventree-cluster] user=inventree @@ -36,6 +35,7 @@ command=/home/inventree/env/bin/python manage.py qcluster startsecs=10 autostart=true autorestart=true -; Change these paths if log files are stored elsewhere -stderr_logfile=/home/inventree/log/cluster.err.log -stdout_logfile=/home/inventree/log/cluster.out.log \ No newline at end of file +stdout_logfile=/dev/fd/1 +stdout_logfile_maxbytes=0 +stderr_logfile=/dev/fd/2 +stderr_logfile_maxbytes=0 \ No newline at end of file From 148600a9c4263627ec3eb1c3dbd8c98f1d7de7c3 Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Thu, 1 Apr 2021 20:38:18 +1100 Subject: [PATCH 058/137] Copy gunicorn.conf.py --- docker/Dockerfile | 3 +++ docker/gunicorn.conf.py | 6 ++++++ docker/supervisor.conf | 2 +- 3 files changed, 10 insertions(+), 1 deletion(-) create mode 100644 docker/gunicorn.conf.py diff --git a/docker/Dockerfile b/docker/Dockerfile index 04d85184bd..d3517b1a05 100644 --- a/docker/Dockerfile +++ b/docker/Dockerfile @@ -84,4 +84,7 @@ RUN mkdir /home/inventree/media /home/inventree/static /home/inventree/log /home # Copy supervisor file COPY docker/supervisor.conf /etc/supervisord.conf +# Copy gunicorn config file +COPY docker/gunicorn.conf.py /home/inventree/gunicorn.conf.py + CMD ["/usr/bin/supervisord", "-c", "/etc/supervisord.conf"] diff --git a/docker/gunicorn.conf.py b/docker/gunicorn.conf.py new file mode 100644 index 0000000000..1071c2d745 --- /dev/null +++ b/docker/gunicorn.conf.py @@ -0,0 +1,6 @@ +import multiprocessing + +workers = multiprocessing.cpu_count() * 2 + 1 + +max_requests = 1000 +max_requests_jitter = 50 diff --git a/docker/supervisor.conf b/docker/supervisor.conf index 72609e5bac..47eeaf6c28 100644 --- a/docker/supervisor.conf +++ b/docker/supervisor.conf @@ -18,7 +18,7 @@ nodaemon=true [program:inventree-server] user=inventree directory=/home/inventree/src/InvenTree -command=/home/inventree/env/bin/gunicorn -c gunicorn.conf.py InvenTree.wsgi -b 0.0.0.0:%(INVENTREE_PORT)s +command=/home/inventree/env/bin/gunicorn -c /home/inventree/gunicorn.conf.py InvenTree.wsgi -b 0.0.0.0:%(ENV_INVENTREE_PORT)s startsecs=10 autostart=true autorestart=true From db858b3cfc9611f12f93dbc0bf71287b2ad99070 Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Thu, 1 Apr 2021 20:44:13 +1100 Subject: [PATCH 059/137] Install packages inside venv --- docker/Dockerfile | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/docker/Dockerfile b/docker/Dockerfile index d3517b1a05..fe1877b99d 100644 --- a/docker/Dockerfile +++ b/docker/Dockerfile @@ -67,13 +67,18 @@ RUN apk add --no-cache mariadb-connector-c mariadb-dev # Clone source code RUN git clone --branch ${INVENTREE_VERSION} --depth 1 ${INVENTREE_REPO} ${INVENTREE_SRC_DIR} -# Install required PIP packages -RUN python -m venv ${INVENTREE_VENV} && pip install --upgrade pip setuptools wheel -RUN python -m venv ${INVENTREE_VENV} && pip install --no-cache-dir -U invoke -RUN python -m venv ${INVENTREE_VENV} && pip install --no-cache-dir -U psycopg2 mysqlclient pgcli mariadb +# Setup Python virtual environment +RUN apk add python3-venv +RUN python -m venv ${INVENTREE_VENV}} +RUN source ${INVENTREE_VENV}/bin/activate + +# Install required PIP packages (into the virtual environment!) +RUN pip install --upgrade pip setuptools wheel +RUN pip install --no-cache-dir -U invoke +RUN pip install --no-cache-dir -U psycopg2 mysqlclient pgcli mariadb # Install InvenTree packages -RUN python -m venv ${INVENTREE_VENV} && pip install --no-cache-dir -U -r ${INVENTREE_SRC_DIR}/requirements.txt +RUN pip install --no-cache-dir -U -r ${INVENTREE_SRC_DIR}/requirements.txt # Install supervisor RUN apk add --no-cache supervisor From 47ba0599eb2467239f6bb95ac050ae9cdbd227ca Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Thu, 1 Apr 2021 20:44:27 +1100 Subject: [PATCH 060/137] Reference environment variables in supervisor conf file --- docker/supervisor.conf | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docker/supervisor.conf b/docker/supervisor.conf index 47eeaf6c28..363bbe6b4a 100644 --- a/docker/supervisor.conf +++ b/docker/supervisor.conf @@ -17,8 +17,8 @@ nodaemon=true [program:inventree-server] user=inventree -directory=/home/inventree/src/InvenTree -command=/home/inventree/env/bin/gunicorn -c /home/inventree/gunicorn.conf.py InvenTree.wsgi -b 0.0.0.0:%(ENV_INVENTREE_PORT)s +directory=%(ENV_INVENTREE_SRC_DIR)s/InvenTree +command=%(ENV_INVENTREE_VENV)s/bin/gunicorn -c %(ENV_INVENTREE_HOME)s/gunicorn.conf.py InvenTree.wsgi -b 0.0.0.0:%(ENV_INVENTREE_PORT)s startsecs=10 autostart=true autorestart=true @@ -30,8 +30,8 @@ stderr_logfile_maxbytes=0 [program:inventree-cluster] user=inventree -directory=/home/inventree/src/InvenTree -command=/home/inventree/env/bin/python manage.py qcluster +directory=%(ENV_INVENTREE_SRC_DIR)s/InvenTree +command=%(ENV_INVENTREE_VENV)s/bin/python manage.py qcluster startsecs=10 autostart=true autorestart=true From 8e7e36089b4eedf95f5ae3491bac9c5c0428f4cf Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Thu, 1 Apr 2021 21:11:59 +1100 Subject: [PATCH 061/137] Fix venv --- docker/Dockerfile | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/docker/Dockerfile b/docker/Dockerfile index fe1877b99d..4d59ec4b8e 100644 --- a/docker/Dockerfile +++ b/docker/Dockerfile @@ -1,9 +1,10 @@ FROM python:alpine as production -# Configuration params +# GitHub source ARG INVENTREE_REPO="https://github.com/inventree/InvenTree.git" ARG INVENTREE_VERSION="master" -ARG INVENTREE_HOME="/home/inventree" + +# InvenTree server port ARG INVENTREE_PORT="80" # Database configuration options @@ -17,7 +18,7 @@ ARG INVENTREE_DB_PASSWORD="" ENV PYTHONUNBUFFERED 1 # InvenTree key settings -ENV INVENTREE_HOME="${INVENTREE_HOME}" +ENV INVENTREE_HOME="/home/inventree" ENV INVENTREE_PORT="${INVENTREE_PORT}" # InvenTree paths @@ -50,7 +51,7 @@ RUN echo "Installing InvenTree '${INVENTREE_VERSION}' from ${INVENTREE_REPO}" # Create user account RUN addgroup -S inventreegroup && adduser -S inventree -G inventreegroup -WORKDIR /home/inventree +WORKDIR ${INVENTREE_HOME} # Install required system packages RUN apk add --no-cache git make bash \ @@ -68,28 +69,27 @@ RUN apk add --no-cache mariadb-connector-c mariadb-dev RUN git clone --branch ${INVENTREE_VERSION} --depth 1 ${INVENTREE_REPO} ${INVENTREE_SRC_DIR} # Setup Python virtual environment -RUN apk add python3-venv -RUN python -m venv ${INVENTREE_VENV}} -RUN source ${INVENTREE_VENV}/bin/activate +RUN python3 -m venv ${INVENTREE_VENV} # Install required PIP packages (into the virtual environment!) -RUN pip install --upgrade pip setuptools wheel -RUN pip install --no-cache-dir -U invoke -RUN pip install --no-cache-dir -U psycopg2 mysqlclient pgcli mariadb +RUN source ${INVENTREE_VENV}/bin/activate && pip install --upgrade pip setuptools wheel +RUN source ${INVENTREE_VENV}/bin/activate && pip install --no-cache-dir -U invoke +RUN source ${INVENTREE_VENV}/bin/activate && pip install --no-cache-dir -U psycopg2 mysqlclient pgcli mariadb +RUN source ${INVENTREE_VENV}/bin/activate && pip install --no-cache-dir -U gunicorn # Install InvenTree packages -RUN pip install --no-cache-dir -U -r ${INVENTREE_SRC_DIR}/requirements.txt +RUN source ${INVENTREE_VENV}/bin/activate && pip install --no-cache-dir -U -r ${INVENTREE_SRC_DIR}/requirements.txt # Install supervisor RUN apk add --no-cache supervisor # Create required directories -RUN mkdir /home/inventree/media /home/inventree/static /home/inventree/log /home/inventree/backup +RUN mkdir ${INVENTREE_HOME}/media ${INVENTREE_HOME}/static ${INVENTREE_HOME}/backup # Copy supervisor file COPY docker/supervisor.conf /etc/supervisord.conf # Copy gunicorn config file -COPY docker/gunicorn.conf.py /home/inventree/gunicorn.conf.py +COPY docker/gunicorn.conf.py ${INVENTREE_HOME}/gunicorn.conf.py CMD ["/usr/bin/supervisord", "-c", "/etc/supervisord.conf"] From be41be3981858e182bb9d7029a09496f305ee94d Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Fri, 2 Apr 2021 00:03:56 +1100 Subject: [PATCH 062/137] Add "wait_for_db" management command --- .../management/commands/wait_for_db.py | 31 +++++++++++++++++++ InvenTree/config_template.yaml | 5 --- docker/Dockerfile | 1 + 3 files changed, 32 insertions(+), 5 deletions(-) create mode 100644 InvenTree/InvenTree/management/commands/wait_for_db.py diff --git a/InvenTree/InvenTree/management/commands/wait_for_db.py b/InvenTree/InvenTree/management/commands/wait_for_db.py new file mode 100644 index 0000000000..5d152d26ca --- /dev/null +++ b/InvenTree/InvenTree/management/commands/wait_for_db.py @@ -0,0 +1,31 @@ +""" +Custom management command, wait for the database to be ready! +""" + +from django.core.management.base import BaseCommand + +from django.db import connections +from django.db.utils import OperationalError + +import time + + +class Command(BaseCommand): + """ + django command to pause execution until the database is ready + """ + + def handle(self, *args, **kwargs): + self.stdout.write("Waiting for database...") + + db_conn = None + + while not db_conn: + try: + # get the database with keyword 'default' from settings.py + db_conn = connections['default'] + # prints success messge in green + self.stdout.write(self.style.SUCCESS('InvenTree database connected')) + except OperationalError: + self.stdout.write("Database unavailable, waiting 5 seconds ...") + time.sleep(5) diff --git a/InvenTree/config_template.yaml b/InvenTree/config_template.yaml index bab673306f..7ce62e887d 100644 --- a/InvenTree/config_template.yaml +++ b/InvenTree/config_template.yaml @@ -9,11 +9,6 @@ database: # Uncomment (and edit) one of the database configurations below, # or specify database options using environment variables - - # Default installation uses a simple sqlite database - # For production, consider changing this! - ENGINE: sqlite3 - NAME: '/home/inventree/database.sqlite3' # Refer to the django documentation for full list of options diff --git a/docker/Dockerfile b/docker/Dockerfile index 4d59ec4b8e..c49c6e53f0 100644 --- a/docker/Dockerfile +++ b/docker/Dockerfile @@ -23,6 +23,7 @@ ENV INVENTREE_PORT="${INVENTREE_PORT}" # InvenTree paths ENV INVENTREE_SRC_DIR="${INVENTREE_HOME}/src" +ENV INVENTREE_MNG_DIR="${INVENTREE_SRC_DIR}/InvenTree" ENV INVENTREE_STATIC_ROOT="${INVENTREE_HOME}/static" ENV INVENTREE_MEDIA_ROOT="${INVENTREE_HOME}/media" ENV INVENTREE_LOG_DIR="${INVENTREE_HOME}/log" From 8d3b9e2ca4fd6137660a04e70a9804bb5d48adbf Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Fri, 2 Apr 2021 00:06:17 +1100 Subject: [PATCH 063/137] Updates to settings.py - Create secret_key.txt if it does not exist - Copy default settings file if it does not exist --- InvenTree/InvenTree/settings.py | 31 ++++++++++++++++++++++++++++--- tasks.py | 32 +++++++------------------------- 2 files changed, 35 insertions(+), 28 deletions(-) diff --git a/InvenTree/InvenTree/settings.py b/InvenTree/InvenTree/settings.py index eee69c0780..3f705ae70c 100644 --- a/InvenTree/InvenTree/settings.py +++ b/InvenTree/InvenTree/settings.py @@ -13,6 +13,9 @@ database setup in this file. import logging import os +import random +import string +import shutil import sys import tempfile from datetime import datetime @@ -55,8 +58,10 @@ BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__))) cfg_filename = os.path.join(BASE_DIR, 'config.yaml') if not os.path.exists(cfg_filename): - print("Error: config.yaml not found") - sys.exit(-1) + print("InvenTree configuration file 'config.yaml' not found - creating default file") + + cfg_template = os.path.join(BASE_DIR, "config_template.yaml") + shutil.copyfile(cfg_template, cfg_filename) with open(cfg_filename, 'r') as cfg: CONFIG = yaml.safe_load(cfg) @@ -99,6 +104,17 @@ LOGGING = { # Get a logger instance for this setup file logger = logging.getLogger(__name__) +""" +Specify a secret key to be used by django. + +Following options are tested, in descending order of preference: + +A) Check for environment variable INVENTREE_SECRET_KEY => Use raw key data +B) Check for environment variable INVENTREE_SECRET_KEY_FILE => Load key data from file +C) Look for default key file "secret_key.txt" +d) Create "secret_key.txt" if it does not exist +""" + if os.getenv("INVENTREE_SECRET_KEY"): # Secret key passed in directly SECRET_KEY = os.getenv("INVENTREE_SECRET_KEY").strip() @@ -111,11 +127,20 @@ else: if os.path.isfile(key_file): logger.info("SECRET_KEY loaded by INVENTREE_SECRET_KEY_FILE") else: - logger.error(f"Secret key file {key_file} not found") + logger.error(f"Secret key file '{key_file}'' not found") exit(-1) else: # default secret key location key_file = os.path.join(BASE_DIR, "secret_key.txt") + + if not os.path.exists(key_file): + logger.info("Creating key file 'secret_key.txt'") + # Create a random key file + with open(key_file, 'w') as f: + options = string.digits + string.ascii_letters + string.punctuation + key = ''.join([random.choice(options) for i in range(50)]) + f.write(key) + logger.info(f"SECRET_KEY loaded from {key_file}") try: SECRET_KEY = open(key_file, "r").read().strip() diff --git a/tasks.py b/tasks.py index 2d7d395d10..83a99949f3 100644 --- a/tasks.py +++ b/tasks.py @@ -3,11 +3,10 @@ from invoke import task from shutil import copyfile -import random -import string import os import sys + def apps(): """ Returns a list of installed apps @@ -27,6 +26,7 @@ def apps(): 'users', ] + def localDir(): """ Returns the directory of *THIS* file. @@ -35,6 +35,7 @@ def localDir(): """ return os.path.dirname(os.path.abspath(__file__)) + def managePyDir(): """ Returns the directory of the manage.py file @@ -42,6 +43,7 @@ def managePyDir(): return os.path.join(localDir(), 'InvenTree') + def managePyPath(): """ Return the path of the manage.py file @@ -49,6 +51,7 @@ def managePyPath(): return os.path.join(managePyDir(), 'manage.py') + def manage(c, cmd, pty=False): """ Runs a given command against django's "manage.py" script. @@ -63,32 +66,11 @@ def manage(c, cmd, pty=False): cmd=cmd ), pty=pty) -@task(help={'length': 'Length of secret key (default=50)'}) -def key(c, length=50, force=False): - """ - Generates a SECRET_KEY file which InvenTree uses for generating security hashes - """ - SECRET_KEY_FILE = os.path.join(localDir(), 'InvenTree', 'secret_key.txt') - - # If a SECRET_KEY file does not exist, generate a new one! - if force or not os.path.exists(SECRET_KEY_FILE): - print("Generating SECRET_KEY file - " + SECRET_KEY_FILE) - with open(SECRET_KEY_FILE, 'w') as key_file: - options = string.digits + string.ascii_letters + string.punctuation - - key = ''.join([random.choice(options) for i in range(length)]) - - key_file.write(key) - - else: - print("SECRET_KEY file already exists - skipping") - - -@task(post=[key]) +@task def install(c): """ - Installs required python packages, and runs initial setup functions. + Installs required python packages """ # Install required Python packages with PIP From 2436b1f2c985a36abf72dde35bd365790ed184db Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Fri, 2 Apr 2021 00:40:47 +1100 Subject: [PATCH 064/137] Entrypoint script - start.sh --- InvenTree/config_template.yaml | 4 ++-- docker/Dockerfile | 18 ++++++++++++++--- docker/start.sh | 35 ++++++++++++++++++++++++++++++++++ tasks.py | 2 +- 4 files changed, 53 insertions(+), 6 deletions(-) create mode 100644 docker/start.sh diff --git a/InvenTree/config_template.yaml b/InvenTree/config_template.yaml index 7ce62e887d..fb30f2d339 100644 --- a/InvenTree/config_template.yaml +++ b/InvenTree/config_template.yaml @@ -28,7 +28,7 @@ database: # NAME: '/home/inventree/database.sqlite3' # --- Example Configuration - MySQL --- - #ENGINE: django.db.backends.mysql + #ENGINE: mysql #NAME: inventree #USER: inventree #PASSWORD: inventree_password @@ -36,7 +36,7 @@ database: #PORT: '3306' # --- Example Configuration - Postgresql --- - #ENGINE: django.db.backends.postgresql + #ENGINE: postgresql #NAME: inventree #USER: inventree #PASSWORD: inventree_password diff --git a/docker/Dockerfile b/docker/Dockerfile index c49c6e53f0..a9eaef612b 100644 --- a/docker/Dockerfile +++ b/docker/Dockerfile @@ -3,12 +3,13 @@ FROM python:alpine as production # GitHub source ARG INVENTREE_REPO="https://github.com/inventree/InvenTree.git" ARG INVENTREE_VERSION="master" +ARG INVENTREE_CONFIG_FILE="InvenTree/config_template.yaml" # InvenTree server port ARG INVENTREE_PORT="80" # Database configuration options -ARG INVENTREE_DB_ENGINE="sqlite" +ARG INVENTREE_DB_ENGINE="sqlite3" ARG INVENTREE_DB_NAME="inventree_db.sqlite3" ARG INVENTREE_DB_HOST="127.0.0.1" ARG INVENTREE_DB_PORT="" @@ -21,6 +22,8 @@ ENV PYTHONUNBUFFERED 1 ENV INVENTREE_HOME="/home/inventree" ENV INVENTREE_PORT="${INVENTREE_PORT}" +ENV INVENTREE_LOG_LEVEL="INFO" + # InvenTree paths ENV INVENTREE_SRC_DIR="${INVENTREE_HOME}/src" ENV INVENTREE_MNG_DIR="${INVENTREE_SRC_DIR}/InvenTree" @@ -42,7 +45,7 @@ LABEL org.label-schema.schema-version="1.0" \ org.label-schema.build-date=${DATE} \ org.label-schema.vendor="inventree" \ org.label-schema.name="inventree/inventree" \ - org.label-schema.url="https://hub.docker.com/r/inventree/inventree-docker" \ + org.label-schema.url="https://hub.docker.com/r/inventree/inventree" \ org.label-schema.version=${INVENTREE_VERSION} \ org.label-schema.vcs-url=${INVENTREE_REPO} \ org.label-schema.vcs-branch=${BRANCH} \ @@ -93,4 +96,13 @@ COPY docker/supervisor.conf /etc/supervisord.conf # Copy gunicorn config file COPY docker/gunicorn.conf.py ${INVENTREE_HOME}/gunicorn.conf.py -CMD ["/usr/bin/supervisord", "-c", "/etc/supervisord.conf"] +# Copy default InvenTree config file +COPY ${INVENTREE_CONFIG_FILE} ${INVENTREE_SRC_DIR}/InvenTree/config.yaml + +# Copy startup script +COPY docker/start.sh ${INVENTREE_HOME}/start.sh + +RUN chmod 755 ${INVENTREE_HOME}/start.sh + +# Let us begin +CMD "./start.sh" diff --git a/docker/start.sh b/docker/start.sh new file mode 100644 index 0000000000..3e1287527b --- /dev/null +++ b/docker/start.sh @@ -0,0 +1,35 @@ +#!/bin/sh + +# Check that the database engine is specified +if [ -z "$INVENTREE_DB_ENGINE" ]; then + echo "INVENTREE_DB_ENGINE not configured" + exit 1 +fi + +# Check that the base dir is set +if [ -z "$INVENTREE_HOME" ]; then + echo "INVENTREE_HOME not configured" + exit 1 +fi + +# Activate virtual environment +source $INVENTREE_VENV/bin/activate + +# Wait for the database to be ready +cd $INVENTREE_MNG_DIR +python manage.py wait_for_db + +sleep 10 + +echo "Running InvenTree database migrations and collecting static files..." + +# We assume at this stage that the database is up and running +# Ensure that the database schema are up to date +python manage.py check || exit 1 +python manage.py migrate --noinput || exit 1 +python manage.py migrate --run-syncdb || exit 1 +python manage.py collectstatic --noinput || exit 1 +python manage.py clearsessions || exit 1 + +# Now we can launch the server and background worker +/usr/bin/supervisord -c /etc/supervisord.conf diff --git a/tasks.py b/tasks.py index 83a99949f3..c6d7dd0173 100644 --- a/tasks.py +++ b/tasks.py @@ -143,7 +143,7 @@ def static(c): as per Django requirements. """ - manage(c, "collectstatic") + manage(c, "collectstatic --no-input") @task(pre=[install, migrate, static]) From 00c4519d2863a6d801ad12ad17de549b605d36c7 Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Fri, 2 Apr 2021 00:54:29 +1100 Subject: [PATCH 065/137] Simplify dockerfile --- docker/Dockerfile | 12 ------------ docker/supervisor.conf | 2 +- 2 files changed, 1 insertion(+), 13 deletions(-) diff --git a/docker/Dockerfile b/docker/Dockerfile index a9eaef612b..99131700ee 100644 --- a/docker/Dockerfile +++ b/docker/Dockerfile @@ -5,22 +5,10 @@ ARG INVENTREE_REPO="https://github.com/inventree/InvenTree.git" ARG INVENTREE_VERSION="master" ARG INVENTREE_CONFIG_FILE="InvenTree/config_template.yaml" -# InvenTree server port -ARG INVENTREE_PORT="80" - -# Database configuration options -ARG INVENTREE_DB_ENGINE="sqlite3" -ARG INVENTREE_DB_NAME="inventree_db.sqlite3" -ARG INVENTREE_DB_HOST="127.0.0.1" -ARG INVENTREE_DB_PORT="" -ARG INVENTREE_DB_USER="" -ARG INVENTREE_DB_PASSWORD="" - ENV PYTHONUNBUFFERED 1 # InvenTree key settings ENV INVENTREE_HOME="/home/inventree" -ENV INVENTREE_PORT="${INVENTREE_PORT}" ENV INVENTREE_LOG_LEVEL="INFO" diff --git a/docker/supervisor.conf b/docker/supervisor.conf index 363bbe6b4a..554200837d 100644 --- a/docker/supervisor.conf +++ b/docker/supervisor.conf @@ -18,7 +18,7 @@ nodaemon=true [program:inventree-server] user=inventree directory=%(ENV_INVENTREE_SRC_DIR)s/InvenTree -command=%(ENV_INVENTREE_VENV)s/bin/gunicorn -c %(ENV_INVENTREE_HOME)s/gunicorn.conf.py InvenTree.wsgi -b 0.0.0.0:%(ENV_INVENTREE_PORT)s +command=%(ENV_INVENTREE_VENV)s/bin/gunicorn -c %(ENV_INVENTREE_HOME)s/gunicorn.conf.py InvenTree.wsgi -b 0.0.0.0:80 startsecs=10 autostart=true autorestart=true From 698b94640380ae4546e8bb84bbc64017fd1ec99a Mon Sep 17 00:00:00 2001 From: Matthias Date: Fri, 2 Apr 2021 23:03:24 +0200 Subject: [PATCH 066/137] activated translations for settings --- InvenTree/templates/InvenTree/settings/setting.html | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/InvenTree/templates/InvenTree/settings/setting.html b/InvenTree/templates/InvenTree/settings/setting.html index b7932fc30a..7376adf8d9 100644 --- a/InvenTree/templates/InvenTree/settings/setting.html +++ b/InvenTree/templates/InvenTree/settings/setting.html @@ -8,7 +8,7 @@ {% endif %} - {{ setting.name }} + {% trans setting.name %} {% if setting.is_bool %}
      @@ -24,7 +24,7 @@ {% endif %} {% endif %} - {{ setting.description }} + {% trans setting.description %}
      From 2de6fcbfa422d91727523edad7d94a3a2a45d887 Mon Sep 17 00:00:00 2001 From: Matthias Date: Sat, 3 Apr 2021 03:59:09 +0200 Subject: [PATCH 067/137] added missing translation fields #753 --- InvenTree/InvenTree/models.py | 10 +++++++--- InvenTree/build/forms.py | 4 +++- InvenTree/build/models.py | 5 ++++- InvenTree/company/forms.py | 1 + InvenTree/company/models.py | 12 ++++++------ InvenTree/part/models.py | 21 +++++++++++---------- InvenTree/stock/forms.py | 2 +- InvenTree/stock/models.py | 6 +++--- 8 files changed, 36 insertions(+), 25 deletions(-) diff --git a/InvenTree/InvenTree/models.py b/InvenTree/InvenTree/models.py index cffe48cc0b..8494b52a10 100644 --- a/InvenTree/InvenTree/models.py +++ b/InvenTree/InvenTree/models.py @@ -56,19 +56,20 @@ class InvenTreeAttachment(models.Model): def __str__(self): return os.path.basename(self.attachment.name) - attachment = models.FileField(upload_to=rename_attachment, + attachment = models.FileField(upload_to=rename_attachment, verbose_name=_('Attachment'), help_text=_('Select file to attach')) - comment = models.CharField(blank=True, max_length=100, help_text=_('File comment')) + comment = models.CharField(blank=True, max_length=100, verbose_name=_('Comment'), help_text=_('File comment')) user = models.ForeignKey( User, on_delete=models.SET_NULL, blank=True, null=True, + verbose_name=_('User'), help_text=_('User'), ) - upload_date = models.DateField(auto_now_add=True, null=True, blank=True) + upload_date = models.DateField(auto_now_add=True, null=True, blank=True, verbose_name=_('upload date')) @property def basename(self): @@ -103,12 +104,14 @@ class InvenTreeTree(MPTTModel): blank=False, max_length=100, validators=[validate_tree_name], + verbose_name=_("Name"), help_text=_("Name"), ) description = models.CharField( blank=True, max_length=250, + verbose_name=_("Description"), help_text=_("Description (optional)") ) @@ -117,6 +120,7 @@ class InvenTreeTree(MPTTModel): on_delete=models.DO_NOTHING, blank=True, null=True, + verbose_name=_("parent"), related_name='children') @property diff --git a/InvenTree/build/forms.py b/InvenTree/build/forms.py index 4892fa631f..380c72f50d 100644 --- a/InvenTree/build/forms.py +++ b/InvenTree/build/forms.py @@ -36,11 +36,13 @@ class EditBuildForm(HelperForm): } target_date = DatePickerFormField( + label=_('Target Date'), help_text=_('Target date for build completion. Build will be overdue after this date.') ) quantity = RoundingDecimalFormField( max_digits=10, decimal_places=5, + label=_('Quantity'), help_text=_('Number of items to build') ) @@ -87,7 +89,7 @@ class BuildOutputCreateForm(HelperForm): ) serial_numbers = forms.CharField( - label=_('Serial numbers'), + label=_('Serial Numbers'), required=False, help_text=_('Enter serial numbers for build outputs'), ) diff --git a/InvenTree/build/models.py b/InvenTree/build/models.py index ada9db1e08..1c668324a5 100644 --- a/InvenTree/build/models.py +++ b/InvenTree/build/models.py @@ -224,12 +224,13 @@ class Build(MPTTModel): help_text=_('Target date for build completion. Build will be overdue after this date.') ) - completion_date = models.DateField(null=True, blank=True) + completion_date = models.DateField(null=True, blank=True, verbose_name=_('Completion Date')) completed_by = models.ForeignKey( User, on_delete=models.SET_NULL, blank=True, null=True, + verbose_name=_('completed by'), related_name='builds_completed' ) @@ -237,6 +238,7 @@ class Build(MPTTModel): User, on_delete=models.SET_NULL, blank=True, null=True, + verbose_name=_('Issued by'), help_text=_('User who issued this build order'), related_name='builds_issued', ) @@ -245,6 +247,7 @@ class Build(MPTTModel): UserModels.Owner, on_delete=models.SET_NULL, blank=True, null=True, + verbose_name=_('Responsible'), help_text=_('User responsible for this build order'), related_name='builds_responsible', ) diff --git a/InvenTree/company/forms.py b/InvenTree/company/forms.py index 67ac402ba7..3d2826fdec 100644 --- a/InvenTree/company/forms.py +++ b/InvenTree/company/forms.py @@ -34,6 +34,7 @@ class EditCompanyForm(HelperForm): currency = django.forms.ChoiceField( required=False, + label=_('Currency'), help_text=_('Default currency used for this company'), choices=[('', '----------')] + djmoney.settings.CURRENCY_CHOICES, initial=common.settings.currency_code_default, diff --git a/InvenTree/company/models.py b/InvenTree/company/models.py index e4386712c8..c1b0594aac 100644 --- a/InvenTree/company/models.py +++ b/InvenTree/company/models.py @@ -126,11 +126,11 @@ class Company(models.Model): notes = MarkdownxField(blank=True) - is_customer = models.BooleanField(default=False, help_text=_('Do you sell items to this company?')) + is_customer = models.BooleanField(default=False, verbose_name=_('is customer'), help_text=_('Do you sell items to this company?')) - is_supplier = models.BooleanField(default=True, help_text=_('Do you purchase items from this company?')) + is_supplier = models.BooleanField(default=True, verbose_name=_('is supplier'), help_text=_('Do you purchase items from this company?')) - is_manufacturer = models.BooleanField(default=False, help_text=_('Does this company manufacture parts?')) + is_manufacturer = models.BooleanField(default=False, verbose_name=_('is manufacturer'), help_text=_('Does this company manufacture parts?')) currency = models.CharField( max_length=3, @@ -366,11 +366,11 @@ class SupplierPart(models.Model): help_text=_('Notes') ) - base_cost = models.DecimalField(max_digits=10, decimal_places=3, default=0, validators=[MinValueValidator(0)], help_text=_('Minimum charge (e.g. stocking fee)')) + base_cost = models.DecimalField(max_digits=10, decimal_places=3, default=0, validators=[MinValueValidator(0)], verbose_name=('base cost'), help_text=_('Minimum charge (e.g. stocking fee)')) - packaging = models.CharField(max_length=50, blank=True, null=True, help_text=_('Part packaging')) + packaging = models.CharField(max_length=50, blank=True, null=True, verbose_name=_('Packaging'), help_text=_('Part packaging')) - multiple = models.PositiveIntegerField(default=1, validators=[MinValueValidator(1)], help_text=('Order multiple')) + multiple = models.PositiveIntegerField(default=1, validators=[MinValueValidator(1)], verbose_name=_('multiple'), help_text=('Order multiple')) # TODO - Reimplement lead-time as a charfield with special validation (pattern matching). # lead_time = models.DurationField(blank=True, null=True) diff --git a/InvenTree/part/models.py b/InvenTree/part/models.py index 2824a89e75..9003e800d8 100644 --- a/InvenTree/part/models.py +++ b/InvenTree/part/models.py @@ -69,10 +69,11 @@ class PartCategory(InvenTreeTree): 'stock.StockLocation', related_name="default_categories", null=True, blank=True, on_delete=models.SET_NULL, + verbose_name=_('Default Location'), help_text=_('Default location for parts in this category') ) - default_keywords = models.CharField(null=True, blank=True, max_length=250, help_text=_('Default keywords for parts in this category')) + default_keywords = models.CharField(null=True, blank=True, max_length=250, verbose_name=_('Default keywords'), help_text=_('Default keywords for parts in this category')) def get_absolute_url(self): return reverse('category-detail', kwargs={'pk': self.id}) @@ -870,18 +871,18 @@ class Part(MPTTModel): help_text=_('Part notes - supports Markdown formatting') ) - bom_checksum = models.CharField(max_length=128, blank=True, help_text=_('Stored BOM checksum')) + bom_checksum = models.CharField(max_length=128, blank=True, verbose_name=_('BOM checksum'), help_text=_('Stored BOM checksum')) bom_checked_by = models.ForeignKey(User, on_delete=models.SET_NULL, blank=True, null=True, - related_name='boms_checked') + verbose_name=_('BOM checked by'), related_name='boms_checked') - bom_checked_date = models.DateField(blank=True, null=True) + bom_checked_date = models.DateField(blank=True, null=True, verbose_name=_('BOM checked date')) - creation_date = models.DateField(auto_now_add=True, editable=False, blank=True, null=True) + creation_date = models.DateField(auto_now_add=True, editable=False, blank=True, null=True, verbose_name=_('Creation Date')) - creation_user = models.ForeignKey(User, on_delete=models.SET_NULL, blank=True, null=True, related_name='parts_created') + creation_user = models.ForeignKey(User, on_delete=models.SET_NULL, blank=True, null=True, verbose_name=_('Creation User'), related_name='parts_created') - responsible = models.ForeignKey(User, on_delete=models.SET_NULL, blank=True, null=True, related_name='parts_responible') + responsible = models.ForeignKey(User, on_delete=models.SET_NULL, blank=True, null=True, verbose_name=_('Responsible'), related_name='parts_responible') def format_barcode(self, **kwargs): """ Return a JSON string for formatting a barcode for this Part object """ @@ -2050,11 +2051,11 @@ class PartParameter(models.Model): # Prevent multiple instances of a parameter for a single part unique_together = ('part', 'template') - part = models.ForeignKey(Part, on_delete=models.CASCADE, related_name='parameters', help_text=_('Parent Part')) + part = models.ForeignKey(Part, on_delete=models.CASCADE, related_name='parameters', verbose_name=_('Part'), help_text=_('Parent Part')) - template = models.ForeignKey(PartParameterTemplate, on_delete=models.CASCADE, related_name='instances', help_text=_('Parameter Template')) + template = models.ForeignKey(PartParameterTemplate, on_delete=models.CASCADE, related_name='instances', verbose_name=_('Template'), help_text=_('Parameter Template')) - data = models.CharField(max_length=500, help_text=_('Parameter Value')) + data = models.CharField(max_length=500, verbose_name=_('Data'), help_text=_('Parameter Value')) @classmethod def create(cls, part, template, data, save=False): diff --git a/InvenTree/stock/forms.py b/InvenTree/stock/forms.py index 0bec20a3e8..9bc5063925 100644 --- a/InvenTree/stock/forms.py +++ b/InvenTree/stock/forms.py @@ -114,7 +114,7 @@ class CreateStockItemForm(HelperForm): help_text=('Expiration date for this stock item'), ) - serial_numbers = forms.CharField(label=_('Serial numbers'), required=False, help_text=_('Enter unique serial numbers (or leave blank)')) + serial_numbers = forms.CharField(label=_('Serial Numbers'), required=False, help_text=_('Enter unique serial numbers (or leave blank)')) def __init__(self, *args, **kwargs): diff --git a/InvenTree/stock/models.py b/InvenTree/stock/models.py index 1be988fed0..df767a3a70 100644 --- a/InvenTree/stock/models.py +++ b/InvenTree/stock/models.py @@ -1548,11 +1548,11 @@ class StockItemTracking(models.Model): date = models.DateTimeField(auto_now_add=True, editable=False) - title = models.CharField(blank=False, max_length=250, help_text=_('Tracking entry title')) + title = models.CharField(blank=False, max_length=250, verbose_name=_('Title'), help_text=_('Tracking entry title')) - notes = models.CharField(blank=True, max_length=512, help_text=_('Entry notes')) + notes = models.CharField(blank=True, max_length=512, verbose_name=_('Notes'), help_text=_('Entry notes')) - link = InvenTreeURLField(blank=True, help_text=_('Link to external page for further information')) + link = InvenTreeURLField(blank=True, verbose_name=_('Link'), help_text=_('Link to external page for further information')) user = models.ForeignKey(User, on_delete=models.SET_NULL, blank=True, null=True) From 446bc06c1bf172d0b806a5b9f5b2e79ad5bf6c5f Mon Sep 17 00:00:00 2001 From: Matthias Date: Sat, 3 Apr 2021 04:01:40 +0200 Subject: [PATCH 068/137] switched translation methode to lazy --- InvenTree/InvenTree/forms.py | 2 +- InvenTree/build/forms.py | 2 +- InvenTree/build/models.py | 2 +- InvenTree/build/views.py | 2 +- InvenTree/common/models.py | 2 +- InvenTree/company/forms.py | 2 +- InvenTree/company/models.py | 2 +- InvenTree/order/forms.py | 2 +- InvenTree/order/models.py | 2 +- InvenTree/part/forms.py | 2 +- InvenTree/stock/forms.py | 2 +- InvenTree/stock/views.py | 2 +- 12 files changed, 12 insertions(+), 12 deletions(-) diff --git a/InvenTree/InvenTree/forms.py b/InvenTree/InvenTree/forms.py index 56a1a116da..79cdf49c3d 100644 --- a/InvenTree/InvenTree/forms.py +++ b/InvenTree/InvenTree/forms.py @@ -5,7 +5,7 @@ Helper forms which subclass Django forms to provide additional functionality # -*- coding: utf-8 -*- from __future__ import unicode_literals -from django.utils.translation import ugettext as _ +from django.utils.translation import ugettext_lazy as _ from django import forms from crispy_forms.helper import FormHelper from crispy_forms.layout import Layout, Field diff --git a/InvenTree/build/forms.py b/InvenTree/build/forms.py index 380c72f50d..48be9a0ffa 100644 --- a/InvenTree/build/forms.py +++ b/InvenTree/build/forms.py @@ -5,7 +5,7 @@ Django Forms for interacting with Build objects # -*- coding: utf-8 -*- from __future__ import unicode_literals -from django.utils.translation import ugettext as _ +from django.utils.translation import ugettext_lazy as _ from django import forms from InvenTree.forms import HelperForm diff --git a/InvenTree/build/models.py b/InvenTree/build/models.py index 1c668324a5..ad0149ed48 100644 --- a/InvenTree/build/models.py +++ b/InvenTree/build/models.py @@ -9,7 +9,7 @@ import os from datetime import datetime from django.contrib.auth.models import User -from django.utils.translation import ugettext as _ +from django.utils.translation import ugettext_lazy as _ from django.core.exceptions import ValidationError from django.urls import reverse diff --git a/InvenTree/build/views.py b/InvenTree/build/views.py index e8a1d33ddc..15ced77130 100644 --- a/InvenTree/build/views.py +++ b/InvenTree/build/views.py @@ -5,7 +5,7 @@ Django views for interacting with Build objects # -*- coding: utf-8 -*- from __future__ import unicode_literals -from django.utils.translation import ugettext as _ +from django.utils.translation import ugettext_lazy as _ from django.core.exceptions import ValidationError from django.views.generic import DetailView, ListView, UpdateView from django.forms import HiddenInput diff --git a/InvenTree/common/models.py b/InvenTree/common/models.py index df8e3b2d37..12b51438cb 100644 --- a/InvenTree/common/models.py +++ b/InvenTree/common/models.py @@ -17,7 +17,7 @@ from djmoney.models.fields import MoneyField from djmoney.contrib.exchange.models import convert_money from djmoney.contrib.exchange.exceptions import MissingRate -from django.utils.translation import ugettext as _ +from django.utils.translation import ugettext_lazy as _ from django.core.validators import MinValueValidator, URLValidator from django.core.exceptions import ValidationError diff --git a/InvenTree/company/forms.py b/InvenTree/company/forms.py index 3d2826fdec..2677402334 100644 --- a/InvenTree/company/forms.py +++ b/InvenTree/company/forms.py @@ -8,7 +8,7 @@ from __future__ import unicode_literals from InvenTree.forms import HelperForm from InvenTree.fields import RoundingDecimalFormField -from django.utils.translation import ugettext as _ +from django.utils.translation import ugettext_lazy as _ import django.forms import djmoney.settings diff --git a/InvenTree/company/models.py b/InvenTree/company/models.py index c1b0594aac..e05d81a16a 100644 --- a/InvenTree/company/models.py +++ b/InvenTree/company/models.py @@ -9,7 +9,7 @@ import os import math -from django.utils.translation import gettext_lazy as _ +from django.utils.translation import ugettext_lazy as _ from django.core.validators import MinValueValidator from django.db import models from django.db.models import Sum, Q, UniqueConstraint diff --git a/InvenTree/order/forms.py b/InvenTree/order/forms.py index bb6cb40889..c8501d68b2 100644 --- a/InvenTree/order/forms.py +++ b/InvenTree/order/forms.py @@ -6,7 +6,7 @@ Django Forms for interacting with Order objects from __future__ import unicode_literals from django import forms -from django.utils.translation import ugettext as _ +from django.utils.translation import ugettext_lazy as _ from mptt.fields import TreeNodeChoiceField diff --git a/InvenTree/order/models.py b/InvenTree/order/models.py index cb78eabc6a..b1ee7f7c74 100644 --- a/InvenTree/order/models.py +++ b/InvenTree/order/models.py @@ -15,7 +15,7 @@ from django.core.validators import MinValueValidator from django.core.exceptions import ValidationError from django.contrib.auth.models import User from django.urls import reverse -from django.utils.translation import ugettext as _ +from django.utils.translation import ugettext_lazy as _ from markdownx.models import MarkdownxField diff --git a/InvenTree/part/forms.py b/InvenTree/part/forms.py index 7962ec3252..42970ccfb1 100644 --- a/InvenTree/part/forms.py +++ b/InvenTree/part/forms.py @@ -11,7 +11,7 @@ from InvenTree.fields import RoundingDecimalFormField from mptt.fields import TreeNodeChoiceField from django import forms -from django.utils.translation import ugettext as _ +from django.utils.translation import ugettext_lazy as _ import common.models diff --git a/InvenTree/stock/forms.py b/InvenTree/stock/forms.py index 9bc5063925..3560f205cc 100644 --- a/InvenTree/stock/forms.py +++ b/InvenTree/stock/forms.py @@ -7,7 +7,7 @@ from __future__ import unicode_literals from django import forms from django.forms.utils import ErrorDict -from django.utils.translation import ugettext as _ +from django.utils.translation import ugettext_lazy as _ from django.core.validators import MinValueValidator from django.core.exceptions import ValidationError diff --git a/InvenTree/stock/views.py b/InvenTree/stock/views.py index 6edcb8cf70..eeee13ad3a 100644 --- a/InvenTree/stock/views.py +++ b/InvenTree/stock/views.py @@ -14,7 +14,7 @@ from django.urls import reverse from django.contrib.auth import get_user_model from django.contrib.auth.models import Group -from django.utils.translation import ugettext as _ +from django.utils.translation import ugettext_lazy as _ from moneyed import CURRENCIES From 0547e1c03bf1d9b82a914555b7272c545552c0fa Mon Sep 17 00:00:00 2001 From: Matthias Date: Sat, 3 Apr 2021 04:05:59 +0200 Subject: [PATCH 069/137] added more translations in html / js --- .../build/templates/build/build_base.html | 4 +-- .../templates/company/company_base.html | 6 ++-- .../company/supplier_part_orders.html | 2 +- .../order/order_wizard/select_parts.html | 2 +- .../order/order_wizard/select_pos.html | 2 +- .../order/templates/order/receive_parts.html | 2 +- .../templates/order/sales_order_base.html | 2 +- .../part/bom_upload/select_fields.html | 4 +-- InvenTree/part/templates/part/params.html | 4 +-- InvenTree/part/templates/part/part_base.html | 2 +- .../part/templates/part/part_pricing.html | 30 ++++++++++--------- .../stock/templates/stock/item_base.html | 2 +- InvenTree/stock/templates/stock/location.html | 6 ++-- .../stock/templates/stock/stock_adjust.html | 2 +- InvenTree/templates/InvenTree/search.html | 8 ++--- InvenTree/templates/js/modals.js | 2 +- InvenTree/templates/js/stock.js | 4 +-- InvenTree/templates/qr_button.html | 2 +- 18 files changed, 44 insertions(+), 42 deletions(-) diff --git a/InvenTree/build/templates/build/build_base.html b/InvenTree/build/templates/build/build_base.html index 83cef5bd44..a8e5e53377 100644 --- a/InvenTree/build/templates/build/build_base.html +++ b/InvenTree/build/templates/build/build_base.html @@ -164,7 +164,7 @@ src="{% static 'img/blank_image.png' %}" launchModalForm("{% url 'build-cancel' build.id %}", { reload: true, - submit_text: "Cancel Build", + submit_text: '{% trans "Cancel Build" %}', }); }); @@ -173,7 +173,7 @@ src="{% static 'img/blank_image.png' %}" "{% url 'build-complete' build.id %}", { reload: true, - submit_text: "Complete Build", + submit_text: '{% trans "Complete Build" %}', } ); }); diff --git a/InvenTree/company/templates/company/company_base.html b/InvenTree/company/templates/company/company_base.html index 9331e5d895..236cc58981 100644 --- a/InvenTree/company/templates/company/company_base.html +++ b/InvenTree/company/templates/company/company_base.html @@ -43,17 +43,17 @@ InvenTree | {% trans "Company" %} - {{ company.name }}

      {{ company.description }}

      {% if company.is_supplier and roles.purchase_order.add %} - {% endif %} {% if perms.company.change_company %} - {% endif %} {% if perms.company.delete_company %} - {% endif %} diff --git a/InvenTree/company/templates/company/supplier_part_orders.html b/InvenTree/company/templates/company/supplier_part_orders.html index ae4b025b11..f01bfa68d1 100644 --- a/InvenTree/company/templates/company/supplier_part_orders.html +++ b/InvenTree/company/templates/company/supplier_part_orders.html @@ -14,7 +14,7 @@ {% if roles.purchase_order.add %}
      -
      diff --git a/InvenTree/order/templates/order/order_wizard/select_parts.html b/InvenTree/order/templates/order/order_wizard/select_parts.html index c93e26e363..21e23266bb 100644 --- a/InvenTree/order/templates/order/order_wizard/select_parts.html +++ b/InvenTree/order/templates/order/order_wizard/select_parts.html @@ -66,7 +66,7 @@
      - diff --git a/InvenTree/order/templates/order/order_wizard/select_pos.html b/InvenTree/order/templates/order/order_wizard/select_pos.html index 3c322410ca..616e618deb 100644 --- a/InvenTree/order/templates/order/order_wizard/select_pos.html +++ b/InvenTree/order/templates/order/order_wizard/select_pos.html @@ -42,7 +42,7 @@
      - diff --git a/InvenTree/order/templates/order/sales_order_base.html b/InvenTree/order/templates/order/sales_order_base.html index ac4ebcf2bc..dfab8d1ae7 100644 --- a/InvenTree/order/templates/order/sales_order_base.html +++ b/InvenTree/order/templates/order/sales_order_base.html @@ -49,7 +49,7 @@ src="{% static 'img/blank_image.png' %}" {% if roles.sales_order.change %} - {% if order.status == SalesOrderStatus.PENDING %} diff --git a/InvenTree/part/templates/part/bom_upload/select_fields.html b/InvenTree/part/templates/part/bom_upload/select_fields.html index 5e44cee2b9..e82223da88 100644 --- a/InvenTree/part/templates/part/bom_upload/select_fields.html +++ b/InvenTree/part/templates/part/bom_upload/select_fields.html @@ -44,7 +44,7 @@
      {{ col.name }} -
      @@ -73,7 +73,7 @@ {% for row in bom_rows %} - diff --git a/InvenTree/part/templates/part/params.html b/InvenTree/part/templates/part/params.html index 52b32d0643..b8cb1ae563 100644 --- a/InvenTree/part/templates/part/params.html +++ b/InvenTree/part/templates/part/params.html @@ -65,8 +65,8 @@ reload: true, secondary: [{ field: 'template', - label: 'New Template', - title: 'Create New Parameter Template', + label: '{% trans "New Template" %}', + title: '{% trans "Create New Parameter Template" %}', url: "{% url 'part-param-template-create' %}" }], }); diff --git a/InvenTree/part/templates/part/part_base.html b/InvenTree/part/templates/part/part_base.html index 96c9636c88..f11fe879ce 100644 --- a/InvenTree/part/templates/part/part_base.html +++ b/InvenTree/part/templates/part/part_base.html @@ -246,7 +246,7 @@ launchModalForm( "{% url 'part-pricing' part.id %}", { - submit_text: 'Calculate', + submit_text: '{% trans "Calculate" %}', hideErrorMessage: true, } ); diff --git a/InvenTree/part/templates/part/part_pricing.html b/InvenTree/part/templates/part/part_pricing.html index c0b23ffbd7..7865bb2fbe 100644 --- a/InvenTree/part/templates/part/part_pricing.html +++ b/InvenTree/part/templates/part/part_pricing.html @@ -1,35 +1,37 @@ {% extends "modal_form.html" %} +{% load i18n %} + {% block pre_form_content %}
      -Pricing information for:
      +{% trans 'Pricing information for:' %}
      {{ part }}.
      -

      Quantity

      +

      {% trans 'Quantity' %}

      - + - +
      Part{% trans 'Part' %} {{ part }}
      Quantity{% trans 'Quantity' %} {{ quantity }}
      {% if part.supplier_count > 0 %} -

      Supplier Pricing

      +

      {% trans 'Supplier Pricing' %}

      {% if min_total_buy_price %} - + {% if quantity > 1 %} - + @@ -37,7 +39,7 @@ Pricing information for:
      {% else %} {% endif %} @@ -45,17 +47,17 @@ Pricing information for:
      {% endif %} {% if part.bom_count > 0 %} -

      BOM Pricing

      +

      {% trans 'BOM Pricing' %}

      Unit Cost{% trans 'Unit Cost' %} Min: {% include "price.html" with price=min_unit_buy_price %} Max: {% include "price.html" with price=max_unit_buy_price %}
      Total Cost{% trans 'Total Cost' %} Min: {% include "price.html" with price=min_total_buy_price %} Max: {% include "price.html" with price=max_total_buy_price %}
      - No supplier pricing available + {% trans 'No supplier pricing available' %}
      {% if min_total_bom_price %} - + {% if quantity > 1 %} - + @@ -63,14 +65,14 @@ Pricing information for:
      {% if part.has_complete_bom_pricing == False %} {% endif %} {% else %} {% endif %} @@ -80,7 +82,7 @@ Pricing information for:
      {% if min_unit_buy_price or min_unit_bom_price %} {% else %}
      - No pricing information is available for this part. + {% trans 'No pricing information is available for this part.' %}
      {% endif %} diff --git a/InvenTree/stock/templates/stock/item_base.html b/InvenTree/stock/templates/stock/item_base.html index f5459dac27..a72b727f69 100644 --- a/InvenTree/stock/templates/stock/item_base.html +++ b/InvenTree/stock/templates/stock/item_base.html @@ -451,7 +451,7 @@ $("#stock-edit").click(function () { "{% url 'stock-item-edit' item.id %}", { reload: true, - submit_text: "Save", + submit_text: '{% trans "Save" %}', } ); }); diff --git a/InvenTree/stock/templates/stock/location.html b/InvenTree/stock/templates/stock/location.html index 5c2b4e04db..74e43f88bb 100644 --- a/InvenTree/stock/templates/stock/location.html +++ b/InvenTree/stock/templates/stock/location.html @@ -160,7 +160,7 @@ $("#stock-export").click(function() { launchModalForm("{% url 'stock-export-options' %}", { - submit_text: "Export", + submit_text: '{% trans "Export" %}', success: function(response) { var url = "{% url 'stock-export' %}"; @@ -188,8 +188,8 @@ secondary: [ { field: 'parent', - label: 'New Location', - title: 'Create new location', + label: '{% trans "New Location" %}', + title: '{% trans "Create new location" %}', url: "{% url 'stock-location-create' %}", }, ] diff --git a/InvenTree/stock/templates/stock/stock_adjust.html b/InvenTree/stock/templates/stock/stock_adjust.html index a72407f735..5ba98231b0 100644 --- a/InvenTree/stock/templates/stock/stock_adjust.html +++ b/InvenTree/stock/templates/stock/stock_adjust.html @@ -40,7 +40,7 @@ {% endif %} - + {% endfor %}
      Unit Cost{% trans 'Unit Cost' %} Min: {% include "price.html" with price=min_unit_bom_price %} Max: {% include "price.html" with price=max_unit_bom_price %}
      Total Cost{% trans 'Total Cost' %} Min: {% include "price.html" with price=min_total_bom_price %} Max: {% include "price.html" with price=max_total_bom_price %}
      - Note: BOM pricing is incomplete for this part + {% trans 'Note: BOM pricing is incomplete for this part' %}
      - No BOM pricing available + {% trans 'No BOM pricing available' %}
      diff --git a/InvenTree/templates/InvenTree/search.html b/InvenTree/templates/InvenTree/search.html index 5eb755dcb2..b65ec00c00 100644 --- a/InvenTree/templates/InvenTree/search.html +++ b/InvenTree/templates/InvenTree/search.html @@ -133,14 +133,14 @@ InvenTree | {% trans "Search Results" %} columns: [ { field: 'name', - title: 'Name', + title: '{% trans "Name" %}', formatter: function(value, row, index, field) { return renderLink(value, '/part/category/' + row.pk + '/'); }, }, { field: 'description', - title: 'Description', + title: '{% trans "Description" %}', }, ], }); @@ -270,14 +270,14 @@ InvenTree | {% trans "Search Results" %} columns: [ { field: 'name', - title: 'Name', + title: '{% trans "Name" %}', formatter: function(value, row, index, field) { return renderLink(row.pathstring, '/stock/location/' + row.pk + '/'); }, }, { field: 'description', - title: 'Description', + title: '{% trans "Description" %}', }, ], }); diff --git a/InvenTree/templates/js/modals.js b/InvenTree/templates/js/modals.js index 2c246d2a36..004e81c000 100644 --- a/InvenTree/templates/js/modals.js +++ b/InvenTree/templates/js/modals.js @@ -253,7 +253,7 @@ function loadingMessageContent() { */ // TODO - This can be made a lot better - return " Waiting for server..."; + return " {% trans 'Waiting for server...' %}"; } diff --git a/InvenTree/templates/js/stock.js b/InvenTree/templates/js/stock.js index bfb539c3c5..02714810e3 100644 --- a/InvenTree/templates/js/stock.js +++ b/InvenTree/templates/js/stock.js @@ -976,8 +976,8 @@ function loadStockTrackingTable(table, options) { formatter: function(value, row, index, field) { // Manually created entries can be edited or deleted if (!row.system) { - var bEdit = ""; - var bDel = ""; + var bEdit = ""; + var bDel = ""; return "
      " + bEdit + bDel + "
      "; } else { diff --git a/InvenTree/templates/qr_button.html b/InvenTree/templates/qr_button.html index cc10e0cd26..5ed65d32ab 100644 --- a/InvenTree/templates/qr_button.html +++ b/InvenTree/templates/qr_button.html @@ -1 +1 @@ - \ No newline at end of file + \ No newline at end of file From 1854da380b7e758501261d9731ea86adef338a68 Mon Sep 17 00:00:00 2001 From: Matthias Date: Sat, 3 Apr 2021 04:07:27 +0200 Subject: [PATCH 070/137] made filters.js dynamic for translation --- InvenTree/InvenTree/urls.py | 1 + InvenTree/templates/base.html | 2 +- .../script/inventree => templates/js}/filters.js | 10 ++++++---- 3 files changed, 8 insertions(+), 5 deletions(-) rename InvenTree/{InvenTree/static/script/inventree => templates/js}/filters.js (94%) diff --git a/InvenTree/InvenTree/urls.py b/InvenTree/InvenTree/urls.py index a9f53a7014..7c22639e65 100644 --- a/InvenTree/InvenTree/urls.py +++ b/InvenTree/InvenTree/urls.py @@ -110,6 +110,7 @@ dynamic_javascript_urls = [ url(r'^stock.js', DynamicJsView.as_view(template_name='js/stock.js'), name='stock.js'), url(r'^tables.js', DynamicJsView.as_view(template_name='js/tables.js'), name='tables.js'), url(r'^table_filters.js', DynamicJsView.as_view(template_name='js/table_filters.js'), name='table_filters.js'), + url(r'^filters.js', DynamicJsView.as_view(template_name='js/filters.js'), name='filters.js'), ] urlpatterns = [ diff --git a/InvenTree/templates/base.html b/InvenTree/templates/base.html index 2120d0ccfb..aa571ef19a 100644 --- a/InvenTree/templates/base.html +++ b/InvenTree/templates/base.html @@ -139,7 +139,6 @@ InvenTree - @@ -156,6 +155,7 @@ InvenTree + diff --git a/InvenTree/InvenTree/static/script/inventree/filters.js b/InvenTree/templates/js/filters.js similarity index 94% rename from InvenTree/InvenTree/static/script/inventree/filters.js rename to InvenTree/templates/js/filters.js index df767441d4..01b74763e0 100644 --- a/InvenTree/InvenTree/static/script/inventree/filters.js +++ b/InvenTree/templates/js/filters.js @@ -1,3 +1,5 @@ +{% load i18n %} + /** * Code for managing query filters / table options. * @@ -188,7 +190,7 @@ function generateAvailableFilterList(tableKey) { var html = `