+
@@ -503,17 +512,6 @@ def keyvalue(dict, key):
return dict.get(key)
-@register.simple_tag()
-def call_method(obj, method_name, *args):
- """Enables calling model methods / functions from templates with arguments.
-
- Usage:
- {% call_method model_object 'fnc_name' argument1 %}
- """
- method = getattr(obj, method_name)
- return method(*args)
-
-
@register.simple_tag()
def authorized_owners(group):
"""Return authorized owners."""
diff --git a/InvenTree/InvenTree/test_api.py b/InvenTree/InvenTree/test_api.py
index aefe27cfec..58e18df2e5 100644
--- a/InvenTree/InvenTree/test_api.py
+++ b/InvenTree/InvenTree/test_api.py
@@ -25,7 +25,7 @@ class HTMLAPITests(InvenTreeTestCase):
url = reverse('api-part-list')
# Check JSON response
- response = self.client.get(url, HTTP_ACCEPT='application/json')
+ response = self.client.get(url, headers={'accept': 'application/json'})
self.assertEqual(response.status_code, 200)
def test_build_api(self):
@@ -33,7 +33,7 @@ class HTMLAPITests(InvenTreeTestCase):
url = reverse('api-build-list')
# Check JSON response
- response = self.client.get(url, HTTP_ACCEPT='application/json')
+ response = self.client.get(url, headers={'accept': 'application/json'})
self.assertEqual(response.status_code, 200)
def test_stock_api(self):
@@ -41,7 +41,7 @@ class HTMLAPITests(InvenTreeTestCase):
url = reverse('api-stock-list')
# Check JSON response
- response = self.client.get(url, HTTP_ACCEPT='application/json')
+ response = self.client.get(url, headers={'accept': 'application/json'})
self.assertEqual(response.status_code, 200)
def test_company_list(self):
@@ -49,7 +49,7 @@ class HTMLAPITests(InvenTreeTestCase):
url = reverse('api-company-list')
# Check JSON response
- response = self.client.get(url, HTTP_ACCEPT='application/json')
+ response = self.client.get(url, headers={'accept': 'application/json'})
self.assertEqual(response.status_code, 200)
def test_not_found(self):
diff --git a/InvenTree/InvenTree/test_api_version.py b/InvenTree/InvenTree/test_api_version.py
index 4b2a3b49b5..8bddb0c561 100644
--- a/InvenTree/InvenTree/test_api_version.py
+++ b/InvenTree/InvenTree/test_api_version.py
@@ -18,6 +18,11 @@ class ApiVersionTests(InvenTreeAPITestCase):
self.assertEqual(len(data), 10)
+ response = self.client.get(reverse('api-version'), format='json').json()
+ self.assertIn('version', response)
+ self.assertIn('dev', response)
+ self.assertIn('up_to_date', response)
+
def test_inventree_api_text(self):
"""Test that the inventreeApiText function works expected."""
# Normal run
diff --git a/InvenTree/InvenTree/test_middleware.py b/InvenTree/InvenTree/test_middleware.py
index f750a339b2..c4fcc52858 100644
--- a/InvenTree/InvenTree/test_middleware.py
+++ b/InvenTree/InvenTree/test_middleware.py
@@ -2,6 +2,7 @@
from django.conf import settings
from django.http import Http404
+from django.test import tag
from django.urls import reverse
from error_report.models import Error
@@ -10,12 +11,16 @@ from InvenTree.exceptions import log_error
from InvenTree.unit_test import InvenTreeTestCase
+# TODO change test to not rely on CUI
+@tag('cui')
class MiddlewareTests(InvenTreeTestCase):
"""Test for middleware functions."""
def check_path(self, url, code=200, **kwargs):
"""Helper function to run a request."""
- response = self.client.get(url, HTTP_ACCEPT='application/json', **kwargs)
+ response = self.client.get(
+ url, headers={'accept': 'application/json'}, **kwargs
+ )
self.assertEqual(response.status_code, code)
return response
diff --git a/InvenTree/InvenTree/test_urls.py b/InvenTree/InvenTree/test_urls.py
index d15493a750..42744e0a16 100644
--- a/InvenTree/InvenTree/test_urls.py
+++ b/InvenTree/InvenTree/test_urls.py
@@ -4,10 +4,11 @@ import os
import re
from pathlib import Path
-from django.test import TestCase
+from django.test import TestCase, tag
from django.urls import reverse
+@tag('cui')
class URLTest(TestCase):
"""Test all files for broken url tags."""
diff --git a/InvenTree/InvenTree/test_views.py b/InvenTree/InvenTree/test_views.py
index 8bbfa7ffc9..0ad1ae5e45 100644
--- a/InvenTree/InvenTree/test_views.py
+++ b/InvenTree/InvenTree/test_views.py
@@ -3,6 +3,7 @@
import os
from django.contrib.auth import get_user_model
+from django.test import tag
from django.urls import reverse
from InvenTree.unit_test import InvenTreeTestCase
@@ -35,6 +36,7 @@ class ViewTests(InvenTreeTestCase):
return str(response.content.decode())
+ @tag('cui')
def test_panels(self):
"""Test that the required 'panels' are present."""
content = self.get_index_page()
@@ -43,6 +45,7 @@ class ViewTests(InvenTreeTestCase):
# TODO: In future, run the javascript and ensure that the panels get created!
+ @tag('cui')
def test_settings_page(self):
"""Test that the 'settings' page loads correctly."""
# Settings page loads
@@ -101,6 +104,8 @@ class ViewTests(InvenTreeTestCase):
self.assertNotIn(f'select-{panel}', content)
self.assertNotIn(f'panel-{panel}', content)
+ # TODO: Replace this with a PUI test
+ @tag('cui')
def test_url_login(self):
"""Test logging in via arguments."""
# Log out
diff --git a/InvenTree/InvenTree/tests.py b/InvenTree/InvenTree/tests.py
index a054185075..ff60d83881 100644
--- a/InvenTree/InvenTree/tests.py
+++ b/InvenTree/InvenTree/tests.py
@@ -10,16 +10,18 @@ from unittest import mock
import django.core.exceptions as django_exceptions
from django.conf import settings
from django.contrib.auth import get_user_model
-from django.contrib.sites.models import Site
from django.core import mail
from django.core.exceptions import ValidationError
-from django.test import TestCase, override_settings
+from django.test import TestCase, override_settings, tag
from django.urls import reverse
+from django.utils import timezone
import pint.errors
+import pytz
from djmoney.contrib.exchange.exceptions import MissingRate
from djmoney.contrib.exchange.models import Rate, convert_money
from djmoney.money import Money
+from maintenance_mode.core import get_maintenance_mode, set_maintenance_mode
from sesame.utils import get_user
import InvenTree.conversion
@@ -29,6 +31,7 @@ import InvenTree.helpers_model
import InvenTree.tasks
from common.models import CustomUnit, InvenTreeSetting
from common.settings import currency_codes
+from InvenTree.helpers_mixin import ClassProviderMixin, ClassValidationMixin
from InvenTree.sanitizer import sanitize_svg
from InvenTree.unit_test import InvenTreeTestCase
from part.models import Part, PartCategory
@@ -39,6 +42,147 @@ from .tasks import offload_task
from .validators import validate_overage
+class HostTest(InvenTreeTestCase):
+ """Test for host configuration."""
+
+ @override_settings(ALLOWED_HOSTS=['testserver'])
+ def test_allowed_hosts(self):
+ """Test that the ALLOWED_HOSTS functions as expected."""
+ self.assertIn('testserver', settings.ALLOWED_HOSTS)
+
+ response = self.client.get('/api/', headers={'host': 'testserver'})
+
+ self.assertEqual(response.status_code, 200)
+
+ response = self.client.get('/api/', headers={'host': 'invalidserver'})
+
+ self.assertEqual(response.status_code, 400)
+
+ @override_settings(ALLOWED_HOSTS=['invalidserver.co.uk'])
+ def test_allowed_hosts_2(self):
+ """Another test for ALLOWED_HOSTS functionality."""
+ response = self.client.get('/api/', headers={'host': 'invalidserver.co.uk'})
+
+ self.assertEqual(response.status_code, 200)
+
+
+class CorsTest(TestCase):
+ """Unit tests for CORS functionality."""
+
+ def cors_headers(self):
+ """Return a list of CORS headers."""
+ return [
+ 'access-control-allow-origin',
+ 'access-control-allow-credentials',
+ 'access-control-allow-methods',
+ 'access-control-allow-headers',
+ ]
+
+ def preflight(self, url, origin, method='GET'):
+ """Make a CORS preflight request to the specified URL."""
+ headers = {'origin': origin, 'access-control-request-method': method}
+
+ return self.client.options(url, headers=headers)
+
+ def test_no_origin(self):
+ """Test that CORS headers are not included for regular requests.
+
+ - We use the /api/ endpoint for this test (it does not require auth)
+ - By default, in debug mode *all* CORS origins are allowed
+ """
+ # Perform an initial response without the "origin" header
+ response = self.client.get('/api/')
+ self.assertEqual(response.status_code, 200)
+
+ for header in self.cors_headers():
+ self.assertNotIn(header, response.headers)
+
+ # Now, perform a "preflight" request with the "origin" header
+ response = self.preflight('/api/', origin='http://random-external-server.com')
+ self.assertEqual(response.status_code, 200)
+
+ for header in self.cors_headers():
+ self.assertIn(header, response.headers)
+
+ self.assertEqual(response.headers['content-length'], '0')
+ self.assertEqual(
+ response.headers['access-control-allow-origin'],
+ 'http://random-external-server.com',
+ )
+
+ @override_settings(
+ CORS_ALLOW_ALL_ORIGINS=False,
+ CORS_ALLOWED_ORIGINS=['http://my-external-server.com'],
+ CORS_ALLOWED_ORIGIN_REGEXES=[],
+ )
+ def test_auth_view(self):
+ """Test that CORS requests work for the /auth/ view.
+
+ Here, we are not authorized by default,
+ but the CORS headers should still be included.
+ """
+ url = '/auth/'
+
+ # First, a preflight request with a "valid" origin
+
+ response = self.preflight(url, origin='http://my-external-server.com')
+
+ self.assertEqual(response.status_code, 200)
+
+ for header in self.cors_headers():
+ self.assertIn(header, response.headers)
+
+ # Next, a preflight request with an "invalid" origin
+ response = self.preflight(url, origin='http://random-external-server.com')
+
+ self.assertEqual(response.status_code, 200)
+
+ for header in self.cors_headers():
+ self.assertNotIn(header, response.headers)
+
+ # Next, make a GET request (without a token)
+ response = self.client.get(
+ url, headers={'origin': 'http://my-external-server.com'}
+ )
+
+ # Unauthorized
+ self.assertEqual(response.status_code, 401)
+
+ self.assertIn('access-control-allow-origin', response.headers)
+ self.assertNotIn('access-control-allow-methods', response.headers)
+
+ @override_settings(
+ CORS_ALLOW_ALL_ORIGINS=False,
+ CORS_ALLOWED_ORIGINS=[],
+ CORS_ALLOWED_ORIGIN_REGEXES=['http://.*myserver.com'],
+ )
+ def test_cors_regex(self):
+ """Test that CORS regexes work as expected."""
+ valid_urls = [
+ 'http://www.myserver.com',
+ 'http://test.myserver.com',
+ 'http://myserver.com',
+ 'http://www.myserver.com:8080',
+ ]
+
+ invalid_urls = [
+ 'http://myserver.org',
+ 'http://www.other-server.org',
+ 'http://google.com',
+ 'http://myserver.co.uk:8080',
+ ]
+
+ for url in valid_urls:
+ response = self.preflight('/api/', origin=url)
+ self.assertEqual(response.status_code, 200)
+ self.assertIn('access-control-allow-origin', response.headers)
+
+ for url in invalid_urls:
+ response = self.preflight('/api/', origin=url)
+ self.assertEqual(response.status_code, 200)
+ self.assertNotIn('access-control-allow-origin', response.headers)
+
+
class ConversionTest(TestCase):
"""Tests for conversion of physical units."""
@@ -57,6 +201,68 @@ class ConversionTest(TestCase):
q = InvenTree.conversion.convert_physical_value(val, 'm')
self.assertAlmostEqual(q, expected, 3)
+ def test_engineering_units(self):
+ """Test that conversion works with engineering notation."""
+ # Run some basic checks over the helper function
+ tests = [
+ ('3', '3'),
+ ('3k3', '3.3k'),
+ ('123R45', '123.45R'),
+ ('10n5F', '10.5nF'),
+ ]
+
+ for val, expected in tests:
+ self.assertEqual(
+ InvenTree.conversion.from_engineering_notation(val), expected
+ )
+
+ # Now test the conversion function
+ tests = [('33k3ohm', 33300), ('123kohm45', 123450), ('10n005', 0.000000010005)]
+
+ for val, expected in tests:
+ output = InvenTree.conversion.convert_physical_value(
+ val, 'ohm', strip_units=True
+ )
+ self.assertAlmostEqual(output, expected, 12)
+
+ def test_scientific_notation(self):
+ """Test that scientific notation is handled correctly."""
+ tests = [
+ ('3E2', 300),
+ ('-12.3E-3', -0.0123),
+ ('1.23E-3', 0.00123),
+ ('99E9', 99000000000),
+ ]
+
+ for val, expected in tests:
+ output = InvenTree.conversion.convert_physical_value(val, strip_units=True)
+ self.assertAlmostEqual(output, expected, 6)
+
+ def test_temperature_units(self):
+ """Test conversion of temperature units.
+
+ Ref: https://github.com/inventree/InvenTree/issues/6495
+ """
+ tests = [
+ ('3.3°F', '°C', -15.944),
+ ('273°K', '°F', 31.73),
+ ('900', '°C', 900),
+ ('900°F', 'degF', 900),
+ ('900°K', '°C', 626.85),
+ ('800', 'kelvin', 800),
+ ('-100°C', 'fahrenheit', -148),
+ ('-100 °C', 'Fahrenheit', -148),
+ ('-100 Celsius', 'fahrenheit', -148),
+ ('-123.45 fahrenheit', 'kelvin', 186.7888),
+ ('-99Fahrenheit', 'Celsius', -72.7777),
+ ]
+
+ for val, unit, expected in tests:
+ output = InvenTree.conversion.convert_physical_value(
+ val, unit, strip_units=True
+ )
+ self.assertAlmostEqual(output, expected, 3)
+
def test_base_units(self):
"""Test conversion to specified base units."""
tests = {
@@ -75,6 +281,24 @@ class ConversionTest(TestCase):
q = InvenTree.conversion.convert_physical_value(val, 'W', strip_units=False)
self.assertAlmostEqual(float(q.magnitude), expected, places=2)
+ def test_imperial_lengths(self):
+ """Test support of imperial length measurements."""
+ tests = [
+ ('1 inch', 'mm', 25.4),
+ ('1 "', 'mm', 25.4),
+ ('2 "', 'inches', 2),
+ ('3 feet', 'inches', 36),
+ ("3'", 'inches', 36),
+ ("7 '", 'feet', 7),
+ ]
+
+ for val, unit, expected in tests:
+ output = InvenTree.conversion.convert_physical_value(
+ val, unit, strip_units=True
+ )
+
+ self.assertAlmostEqual(output, expected, 3)
+
def test_dimensionless_units(self):
"""Tests for 'dimensionless' unit quantities."""
# Test some dimensionless units
@@ -320,35 +544,37 @@ class FormatTest(TestCase):
def test_currency_formatting(self):
"""Test that currency formatting works correctly for multiple currencies."""
test_data = (
- (Money(3651.285718, 'USD'), 4, '$3,651.2857'), # noqa: E201,E202
- (Money(487587.849178, 'CAD'), 5, 'CA$487,587.84918'), # noqa: E201,E202
- (Money(0.348102, 'EUR'), 1, '€0.3'), # noqa: E201,E202
- (Money(0.916530, 'GBP'), 1, '£0.9'), # noqa: E201,E202
- (Money(61.031024, 'JPY'), 3, '¥61.031'), # noqa: E201,E202
- (Money(49609.694602, 'JPY'), 1, '¥49,609.7'), # noqa: E201,E202
- (Money(155565.264777, 'AUD'), 2, 'A$155,565.26'), # noqa: E201,E202
- (Money(0.820437, 'CNY'), 4, 'CN¥0.8204'), # noqa: E201,E202
- (Money(7587.849178, 'EUR'), 0, '€7,588'), # noqa: E201,E202
- (Money(0.348102, 'GBP'), 3, '£0.348'), # noqa: E201,E202
- (Money(0.652923, 'CHF'), 0, 'CHF1'), # noqa: E201,E202
- (Money(0.820437, 'CNY'), 1, 'CN¥0.8'), # noqa: E201,E202
- (Money(98789.5295680, 'CHF'), 0, 'CHF98,790'), # noqa: E201,E202
- (Money(0.585787, 'USD'), 1, '$0.6'), # noqa: E201,E202
- (Money(0.690541, 'CAD'), 3, 'CA$0.691'), # noqa: E201,E202
- (Money(427.814104, 'AUD'), 5, 'A$427.81410'), # noqa: E201,E202
+ (Money(3651.285718, 'USD'), 4, True, '$3,651.2857'), # noqa: E201,E202
+ (Money(487587.849178, 'CAD'), 5, True, 'CA$487,587.84918'), # noqa: E201,E202
+ (Money(0.348102, 'EUR'), 1, False, '0.3'), # noqa: E201,E202
+ (Money(0.916530, 'GBP'), 1, True, '£0.9'), # noqa: E201,E202
+ (Money(61.031024, 'JPY'), 3, False, '61.031'), # noqa: E201,E202
+ (Money(49609.694602, 'JPY'), 1, True, '¥49,609.7'), # noqa: E201,E202
+ (Money(155565.264777, 'AUD'), 2, False, '155,565.26'), # noqa: E201,E202
+ (Money(0.820437, 'CNY'), 4, True, 'CN¥0.8204'), # noqa: E201,E202
+ (Money(7587.849178, 'EUR'), 0, True, '€7,588'), # noqa: E201,E202
+ (Money(0.348102, 'GBP'), 3, False, '0.348'), # noqa: E201,E202
+ (Money(0.652923, 'CHF'), 0, True, 'CHF1'), # noqa: E201,E202
+ (Money(0.820437, 'CNY'), 1, True, 'CN¥0.8'), # noqa: E201,E202
+ (Money(98789.5295680, 'CHF'), 0, False, '98,790'), # noqa: E201,E202
+ (Money(0.585787, 'USD'), 1, True, '$0.6'), # noqa: E201,E202
+ (Money(0.690541, 'CAD'), 3, True, 'CA$0.691'), # noqa: E201,E202
+ (Money(427.814104, 'AUD'), 5, True, 'A$427.81410'), # noqa: E201,E202
)
with self.settings(LANGUAGE_CODE='en-us'):
- for value, decimal_places, expected_result in test_data:
+ for value, decimal_places, include_symbol, expected_result in test_data:
result = InvenTree.format.format_money(
- value, decimal_places=decimal_places
+ value, decimal_places=decimal_places, include_symbol=include_symbol
)
- assert result == expected_result
+
+ self.assertEqual(result, expected_result)
class TestHelpers(TestCase):
"""Tests for InvenTree helper functions."""
+ @override_settings(SITE_URL=None)
def test_absolute_url(self):
"""Test helper function for generating an absolute URL."""
base = 'https://demo.inventree.org:12345'
@@ -372,7 +598,7 @@ class TestHelpers(TestCase):
for url, expected in tests.items():
# Test with supplied base URL
self.assertEqual(
- InvenTree.helpers_model.construct_absolute_url(url, site_url=base),
+ InvenTree.helpers_model.construct_absolute_url(url, base_url=base),
expected,
)
@@ -508,6 +734,61 @@ class TestHelpers(TestCase):
self.assertNotIn(PartCategory, models)
self.assertNotIn(InvenTreeSetting, models)
+ def test_test_key(self):
+ """Test for the generateTestKey function."""
+ tests = {
+ ' Hello World ': 'helloworld',
+ ' MY NEW TEST KEY ': 'mynewtestkey',
+ ' 1234 5678': '_12345678',
+ ' 100 percenT': '_100percent',
+ ' MY_NEW_TEST': 'my_new_test',
+ ' 100_new_tests': '_100_new_tests',
+ }
+
+ for name, key in tests.items():
+ self.assertEqual(helpers.generateTestKey(name), key)
+
+
+class TestTimeFormat(TestCase):
+ """Unit test for time formatting functionality."""
+
+ @override_settings(TIME_ZONE='UTC')
+ def test_tz_utc(self):
+ """Check UTC timezone."""
+ self.assertEqual(InvenTree.helpers.server_timezone(), 'UTC')
+
+ @override_settings(TIME_ZONE='Europe/London')
+ def test_tz_london(self):
+ """Check London timezone."""
+ self.assertEqual(InvenTree.helpers.server_timezone(), 'Europe/London')
+
+ @override_settings(TIME_ZONE='Australia/Sydney')
+ def test_to_local_time(self):
+ """Test that the local time conversion works as expected."""
+ source_time = timezone.datetime(
+ year=2000,
+ month=1,
+ day=1,
+ hour=0,
+ minute=0,
+ second=0,
+ tzinfo=pytz.timezone('Europe/London'),
+ )
+
+ tests = [
+ ('UTC', '2000-01-01 00:01:00+00:00'),
+ ('Europe/London', '2000-01-01 00:00:00-00:01'),
+ ('America/New_York', '1999-12-31 19:01:00-05:00'),
+ # All following tests should result in the same value
+ ('Australia/Sydney', '2000-01-01 11:01:00+11:00'),
+ (None, '2000-01-01 11:01:00+11:00'),
+ ('', '2000-01-01 11:01:00+11:00'),
+ ]
+
+ for tz, expected in tests:
+ local_time = InvenTree.helpers.to_local_time(source_time, tz)
+ self.assertEqual(str(local_time), expected)
+
class TestQuoteWrap(TestCase):
"""Tests for string wrapping."""
@@ -816,6 +1097,7 @@ class TestVersionNumber(TestCase):
hash = str(
subprocess.check_output('git rev-parse --short HEAD'.split()), 'utf-8'
).strip()
+
self.assertEqual(hash, version.inventreeCommitHash())
d = (
@@ -990,9 +1272,12 @@ class TestSettings(InvenTreeTestCase):
)
# with env set
- with self.in_env_context({'INVENTREE_CONFIG_FILE': 'my_special_conf.yaml'}):
+ with self.in_env_context({
+ 'INVENTREE_CONFIG_FILE': '_testfolder/my_special_conf.yaml'
+ }):
self.assertIn(
- 'inventree/my_special_conf.yaml', str(config.get_config_file()).lower()
+ 'inventree/_testfolder/my_special_conf.yaml',
+ str(config.get_config_file()).lower(),
)
def test_helpers_plugin_file(self):
@@ -1006,8 +1291,12 @@ class TestSettings(InvenTreeTestCase):
)
# with env set
- with self.in_env_context({'INVENTREE_PLUGIN_FILE': 'my_special_plugins.txt'}):
- self.assertIn('my_special_plugins.txt', str(config.get_plugin_file()))
+ with self.in_env_context({
+ 'INVENTREE_PLUGIN_FILE': '_testfolder/my_special_plugins.txt'
+ }):
+ self.assertIn(
+ '_testfolder/my_special_plugins.txt', str(config.get_plugin_file())
+ )
def test_helpers_setting(self):
"""Test get_setting."""
@@ -1049,10 +1338,17 @@ class TestInstanceName(InvenTreeTestCase):
self.assertEqual(version.inventreeInstanceTitle(), 'Testing title')
+ try:
+ from django.contrib.sites.models import Site
+ except (ImportError, RuntimeError):
+ # Multi-site support not enabled
+ return
+
# The site should also be changed
site_obj = Site.objects.all().order_by('id').first()
self.assertEqual(site_obj.name, 'Testing title')
+ @override_settings(SITE_URL=None)
def test_instance_url(self):
"""Test instance url settings."""
# Set up required setting
@@ -1060,9 +1356,18 @@ class TestInstanceName(InvenTreeTestCase):
'INVENTREE_BASE_URL', 'http://127.1.2.3', self.user
)
+ # No further tests if multi-site support is not enabled
+ if not settings.SITE_MULTI:
+ return
+
# The site should also be changed
- site_obj = Site.objects.all().order_by('id').first()
- self.assertEqual(site_obj.domain, 'http://127.1.2.3')
+ try:
+ from django.contrib.sites.models import Site
+
+ site_obj = Site.objects.all().order_by('id').first()
+ self.assertEqual(site_obj.domain, 'http://127.1.2.3')
+ except Exception:
+ pass
class TestOffloadTask(InvenTreeTestCase):
@@ -1234,7 +1539,7 @@ class MagicLoginTest(InvenTreeTestCase):
self.assertEqual(resp.status_code, 200)
self.assertEqual(resp.data, {'status': 'ok'})
self.assertEqual(len(mail.outbox), 1)
- self.assertEqual(mail.outbox[0].subject, '[example.com] Log in to the app')
+ self.assertEqual(mail.outbox[0].subject, '[InvenTree] Log in to the app')
# Check that the token is in the email
self.assertTrue('http://testserver/api/email/login/' in mail.outbox[0].body)
@@ -1247,9 +1552,155 @@ class MagicLoginTest(InvenTreeTestCase):
# Check that the login works
resp = self.client.get(reverse('sesame-login') + '?sesame=' + token)
self.assertEqual(resp.status_code, 302)
- self.assertEqual(resp.url, '/index/')
- # Note: 2023-08-08 - This test has been changed because "platform UI" is not generally available yet
- # TODO: In the future, the URL comparison will need to be reverted
- # self.assertEqual(resp.url, f'/{settings.FRONTEND_URL_BASE}/logged-in/')
+ self.assertEqual(resp.url, '/api/auth/login-redirect/')
# And we should be logged in again
self.assertEqual(resp.wsgi_request.user, self.user)
+
+
+# TODO - refactor to not use CUI
+@tag('cui')
+class MaintenanceModeTest(InvenTreeTestCase):
+ """Unit tests for maintenance mode."""
+
+ def test_basic(self):
+ """Test basic maintenance mode operation."""
+ for value in [False, True, False]:
+ set_maintenance_mode(value)
+ self.assertEqual(get_maintenance_mode(), value)
+
+ # API request is blocked in maintenance mode
+ set_maintenance_mode(True)
+
+ response = self.client.get('/api/')
+ self.assertEqual(response.status_code, 503)
+
+ set_maintenance_mode(False)
+
+ response = self.client.get('/api/')
+ self.assertEqual(response.status_code, 200)
+
+ def test_timestamp(self):
+ """Test that the timestamp value is interpreted correctly."""
+ KEY = '_MAINTENANCE_MODE'
+
+ # Deleting the setting means maintenance mode is off
+ InvenTreeSetting.objects.filter(key=KEY).delete()
+
+ self.assertFalse(get_maintenance_mode())
+
+ def set_timestamp(value):
+ InvenTreeSetting.set_setting(KEY, value, None)
+
+ # Test blank value
+ set_timestamp('')
+ self.assertFalse(get_maintenance_mode())
+
+ # Test timestamp in the past
+ ts = datetime.now() - timedelta(minutes=10)
+ set_timestamp(ts.isoformat())
+ self.assertFalse(get_maintenance_mode())
+
+ # Test timestamp in the future
+ ts = datetime.now() + timedelta(minutes=10)
+ set_timestamp(ts.isoformat())
+ self.assertTrue(get_maintenance_mode())
+
+ # Set to false, check for empty string
+ set_maintenance_mode(False)
+ self.assertFalse(get_maintenance_mode())
+ self.assertEqual(InvenTreeSetting.get_setting(KEY, None), '')
+
+
+class ClassValidationMixinTest(TestCase):
+ """Tests for the ClassValidationMixin class."""
+
+ class BaseTestClass(ClassValidationMixin):
+ """A valid class that inherits from ClassValidationMixin."""
+
+ NAME: str
+
+ def test(self):
+ """Test function."""
+ pass
+
+ def test1(self):
+ """Test function."""
+ pass
+
+ def test2(self):
+ """Test function."""
+ pass
+
+ required_attributes = ['NAME']
+ required_overrides = [test, [test1, test2]]
+
+ class InvalidClass:
+ """An invalid class that does not inherit from ClassValidationMixin."""
+
+ pass
+
+ def test_valid_class(self):
+ """Test that a valid class passes the validation."""
+
+ class TestClass(self.BaseTestClass):
+ """A valid class that inherits from BaseTestClass."""
+
+ NAME = 'Test'
+
+ def test(self):
+ """Test function."""
+ pass
+
+ def test2(self):
+ """Test function."""
+ pass
+
+ TestClass.validate()
+
+ def test_invalid_class(self):
+ """Test that an invalid class fails the validation."""
+
+ class TestClass1(self.BaseTestClass):
+ """A bad class that inherits from BaseTestClass."""
+
+ with self.assertRaisesRegex(
+ NotImplementedError,
+ r'\'<.*TestClass1\'>\' did not provide the following attributes: NAME and did not override the required attributes: test, one of test1 or test2',
+ ):
+ TestClass1.validate()
+
+ class TestClass2(self.BaseTestClass):
+ """A bad class that inherits from BaseTestClass."""
+
+ NAME = 'Test'
+
+ def test2(self):
+ """Test function."""
+ pass
+
+ with self.assertRaisesRegex(
+ NotImplementedError,
+ r'\'<.*TestClass2\'>\' did not override the required attributes: test',
+ ):
+ TestClass2.validate()
+
+
+class ClassProviderMixinTest(TestCase):
+ """Tests for the ClassProviderMixin class."""
+
+ class TestClass(ClassProviderMixin):
+ """This class is a dummy class to test the ClassProviderMixin."""
+
+ pass
+
+ def test_get_provider_file(self):
+ """Test the get_provider_file function."""
+ self.assertEqual(self.TestClass.get_provider_file(), __file__)
+
+ def test_provider_plugin(self):
+ """Test the provider_plugin function."""
+ self.assertEqual(self.TestClass.get_provider_plugin(), None)
+
+ def test_get_is_builtin(self):
+ """Test the get_is_builtin function."""
+ self.assertTrue(self.TestClass.get_is_builtin())
diff --git a/InvenTree/InvenTree/tracing.py b/InvenTree/InvenTree/tracing.py
index b14dcc4a0d..3d3eda28a3 100644
--- a/InvenTree/InvenTree/tracing.py
+++ b/InvenTree/InvenTree/tracing.py
@@ -19,6 +19,7 @@ from opentelemetry.sdk.metrics.export import (
from opentelemetry.sdk.trace import TracerProvider
from opentelemetry.sdk.trace.export import BatchSpanProcessor, ConsoleSpanExporter
+import InvenTree.ready
from InvenTree.version import inventreeVersion
# Logger configuration
@@ -42,6 +43,9 @@ def setup_tracing(
resources_input: The resources to send with the traces.
console: Whether to output the traces to the console.
"""
+ if InvenTree.ready.isImportingData() or InvenTree.ready.isRunningMigrations():
+ return
+
if resources_input is None:
resources_input = {}
if auth is None:
diff --git a/InvenTree/InvenTree/urls.py b/InvenTree/InvenTree/urls.py
index 5111e4c67c..d7ba4d1770 100644
--- a/InvenTree/InvenTree/urls.py
+++ b/InvenTree/InvenTree/urls.py
@@ -22,6 +22,7 @@ import build.api
import common.api
import company.api
import label.api
+import machine.api
import order.api
import part.api
import plugin.api
@@ -35,6 +36,7 @@ from order.urls import order_urls
from part.urls import part_urls
from plugin.urls import get_plugin_urls
from stock.urls import stock_urls
+from web.urls import api_urls as web_api_urls
from web.urls import urlpatterns as platform_urls
from .api import APISearchView, InfoView, NotFoundView, VersionTextView, VersionView
@@ -82,8 +84,10 @@ apipatterns = [
path('order/', include(order.api.order_api_urls)),
path('label/', include(label.api.label_api_urls)),
path('report/', include(report.api.report_api_urls)),
+ path('machine/', include(machine.api.machine_api_urls)),
path('user/', include(users.api.user_urls)),
path('admin/', include(common.api.admin_api_urls)),
+ path('web/', include(web_api_urls)),
# Plugin endpoints
path('', include(plugin.api.plugin_api_urls)),
# Common endpoints endpoint
@@ -148,6 +152,12 @@ apipatterns = [
SocialAccountDisconnectView.as_view(),
name='social_account_disconnect',
),
+ path('logout/', users.api.Logout.as_view(), name='api-logout'),
+ path(
+ 'login-redirect/',
+ users.api.LoginRedirect.as_view(),
+ name='api-login-redirect',
+ ),
path('', include('dj_rest_auth.urls')),
]),
),
@@ -352,15 +362,19 @@ translated_javascript_urls = [
]
backendpatterns = [
- # "Dynamic" javascript files which are rendered using InvenTree templating.
- path('js/dynamic/', include(dynamic_javascript_urls)),
- path('js/i18n/', include(translated_javascript_urls)),
path('auth/', include('rest_framework.urls', namespace='rest_framework')),
path('auth/', auth_request),
path('api/', include(apipatterns)),
path('api-doc/', SpectacularRedocView.as_view(url_name='schema'), name='api-doc'),
]
+if settings.ENABLE_CLASSIC_FRONTEND:
+ # "Dynamic" javascript files which are rendered using InvenTree templating.
+ backendpatterns += [
+ re_path(r'^js/dynamic/', include(dynamic_javascript_urls)),
+ re_path(r'^js/i18n/', include(translated_javascript_urls)),
+ ]
+
classic_frontendpatterns = [
# Apps
path('build/', include(build_urls)),
@@ -425,6 +439,15 @@ if settings.ENABLE_CLASSIC_FRONTEND:
frontendpatterns += classic_frontendpatterns
if settings.ENABLE_PLATFORM_FRONTEND:
frontendpatterns += platform_urls
+ if not settings.ENABLE_CLASSIC_FRONTEND:
+ # Add a redirect for login views
+ frontendpatterns += [
+ path(
+ 'accounts/login/',
+ RedirectView.as_view(url=settings.FRONTEND_URL_BASE, permanent=False),
+ name='account_login',
+ )
+ ]
urlpatterns += frontendpatterns
@@ -450,5 +473,14 @@ urlpatterns.append(
# Send any unknown URLs to the parts page
urlpatterns += [
- re_path(r'^.*$', RedirectView.as_view(url='/index/', permanent=False), name='index')
+ re_path(
+ r'^.*$',
+ RedirectView.as_view(
+ url='/index/'
+ if settings.ENABLE_CLASSIC_FRONTEND
+ else settings.FRONTEND_URL_BASE,
+ permanent=False,
+ ),
+ name='index',
+ )
]
diff --git a/InvenTree/InvenTree/version.py b/InvenTree/InvenTree/version.py
index bd84bd7d7c..ef7e6c69b7 100644
--- a/InvenTree/InvenTree/version.py
+++ b/InvenTree/InvenTree/version.py
@@ -19,7 +19,7 @@ from dulwich.repo import NotGitRepository, Repo
from .api_version import INVENTREE_API_TEXT, INVENTREE_API_VERSION
# InvenTree software version
-INVENTREE_SW_VERSION = '0.14.0 dev'
+INVENTREE_SW_VERSION = '0.15.0 dev'
# Discover git
try:
diff --git a/InvenTree/_testfolder/.gitignore b/InvenTree/_testfolder/.gitignore
new file mode 100644
index 0000000000..eeb6f71057
--- /dev/null
+++ b/InvenTree/_testfolder/.gitignore
@@ -0,0 +1,8 @@
+# Files used for testing
+dummy_image.*
+_tmp.csv
+part_image_123abc.png
+label.pdf
+label.png
+my_special*
+_tests*.txt
diff --git a/InvenTree/build/admin.py b/InvenTree/build/admin.py
index fb99a898d9..b3d14c6ec6 100644
--- a/InvenTree/build/admin.py
+++ b/InvenTree/build/admin.py
@@ -51,6 +51,7 @@ class BuildResource(InvenTreeResource):
notes = Field(attribute='notes')
+@admin.register(Build)
class BuildAdmin(ImportExportModelAdmin):
"""Class for managing the Build model via the admin interface"""
@@ -83,6 +84,7 @@ class BuildAdmin(ImportExportModelAdmin):
]
+@admin.register(BuildItem)
class BuildItemAdmin(admin.ModelAdmin):
"""Class for managing the BuildItem model via the admin interface."""
@@ -98,6 +100,7 @@ class BuildItemAdmin(admin.ModelAdmin):
]
+@admin.register(BuildLine)
class BuildLineAdmin(admin.ModelAdmin):
"""Class for managing the BuildLine model via the admin interface"""
@@ -112,8 +115,3 @@ class BuildLineAdmin(admin.ModelAdmin):
'build__reference',
'bom_item__sub_part__name',
]
-
-
-admin.site.register(Build, BuildAdmin)
-admin.site.register(BuildItem, BuildItemAdmin)
-admin.site.register(BuildLine, BuildLineAdmin)
diff --git a/InvenTree/build/api.py b/InvenTree/build/api.py
index 47fd8ae0cf..291e0694ae 100644
--- a/InvenTree/build/api.py
+++ b/InvenTree/build/api.py
@@ -314,11 +314,21 @@ class BuildLineEndpoint:
queryset = BuildLine.objects.all()
serializer_class = build.serializers.BuildLineSerializer
+ def get_source_build(self) -> Build:
+ """Return the source Build object for the BuildLine queryset.
+
+ This source build is used to filter the available stock for each BuildLine.
+
+ - If this is a "detail" view, use the build associated with the line
+ - If this is a "list" view, use the build associated with the request
+ """
+ raise NotImplementedError("get_source_build must be implemented in the child class")
+
def get_queryset(self):
"""Override queryset to select-related and annotate"""
queryset = super().get_queryset()
-
- queryset = build.serializers.BuildLineSerializer.annotate_queryset(queryset)
+ source_build = self.get_source_build()
+ queryset = build.serializers.BuildLineSerializer.annotate_queryset(queryset, build=source_build)
return queryset
@@ -353,10 +363,26 @@ class BuildLineList(BuildLineEndpoint, ListCreateAPI):
'bom_item__reference',
]
+ def get_source_build(self) -> Build:
+ """Return the target build for the BuildLine queryset."""
+
+ try:
+ build_id = self.request.query_params.get('build', None)
+ if build_id:
+ build = Build.objects.get(pk=build_id)
+ return build
+ except (Build.DoesNotExist, AttributeError, ValueError):
+ pass
+
+ return None
class BuildLineDetail(BuildLineEndpoint, RetrieveUpdateDestroyAPI):
"""API endpoint for detail view of a BuildLine object."""
- pass
+
+ def get_source_build(self) -> Build:
+ """Return the target source location for the BuildLine queryset."""
+
+ return None
class BuildOrderContextMixin:
diff --git a/InvenTree/build/migrations/0013_auto_20200425_0507.py b/InvenTree/build/migrations/0013_auto_20200425_0507.py
index 4468b9aca5..15be35eea6 100644
--- a/InvenTree/build/migrations/0013_auto_20200425_0507.py
+++ b/InvenTree/build/migrations/0013_auto_20200425_0507.py
@@ -3,12 +3,6 @@
from django.db import migrations, models
import django.db.models.deletion
import mptt.fields
-from build.models import Build
-
-
-def update_tree(apps, schema_editor):
- # Update the Build MPTT model
- Build.objects.rebuild()
class Migration(migrations.Migration):
@@ -49,5 +43,4 @@ class Migration(migrations.Migration):
field=models.PositiveIntegerField(db_index=True, default=0, editable=False),
preserve_default=False,
),
- migrations.RunPython(update_tree, reverse_code=migrations.RunPython.noop),
]
diff --git a/InvenTree/build/migrations/0029_auto_20210601_1525.py b/InvenTree/build/migrations/0029_auto_20210601_1525.py
index 68b1f098e1..3c98b504df 100644
--- a/InvenTree/build/migrations/0029_auto_20210601_1525.py
+++ b/InvenTree/build/migrations/0029_auto_20210601_1525.py
@@ -57,6 +57,4 @@ class Migration(migrations.Migration):
('build', '0028_builditem_bom_item'),
]
- operations = [
- migrations.RunPython(assign_bom_items, reverse_code=migrations.RunPython.noop),
- ]
+ operations = []
diff --git a/InvenTree/build/models.py b/InvenTree/build/models.py
index 7c6b9c6bac..43308ad9ba 100644
--- a/InvenTree/build/models.py
+++ b/InvenTree/build/models.py
@@ -4,6 +4,7 @@ import decimal
import logging
import os
from datetime import datetime
+from django.conf import settings
from django.contrib.auth.models import User
from django.core.exceptions import ValidationError
@@ -28,7 +29,6 @@ from build.validators import generate_next_build_reference, validate_build_order
import InvenTree.fields
import InvenTree.helpers
import InvenTree.helpers_model
-import InvenTree.mixins
import InvenTree.models
import InvenTree.ready
import InvenTree.tasks
@@ -45,7 +45,7 @@ import users.models
logger = logging.getLogger('inventree')
-class Build(MPTTModel, InvenTree.mixins.DiffMixin, InvenTree.models.InvenTreeBarcodeMixin, InvenTree.models.InvenTreeNotesMixin, InvenTree.models.MetadataMixin, InvenTree.models.ReferenceIndexingMixin):
+class Build(InvenTree.models.InvenTreeBarcodeMixin, InvenTree.models.InvenTreeNotesMixin, InvenTree.models.MetadataMixin, InvenTree.models.PluginValidationMixin, InvenTree.models.ReferenceIndexingMixin, MPTTModel):
"""A Build object organises the creation of new StockItem objects from other existing StockItem objects.
Attributes:
@@ -162,7 +162,9 @@ class Build(MPTTModel, InvenTree.mixins.DiffMixin, InvenTree.models.InvenTreeBar
def get_absolute_url(self):
"""Return the web URL associated with this BuildOrder"""
- return reverse('build-detail', kwargs={'pk': self.id})
+ if settings.ENABLE_CLASSIC_FRONTEND:
+ return reverse('build-detail', kwargs={'pk': self.id})
+ return InvenTree.helpers.pui_url(f'/build/{self.id}')
reference = models.CharField(
unique=True,
@@ -516,9 +518,25 @@ class Build(MPTTModel, InvenTree.mixins.DiffMixin, InvenTree.models.InvenTreeBar
return True
+ @transaction.atomic
+ def complete_allocations(self, user):
+ """Complete all stock allocations for this build order.
+
+ - This function is called when a build order is completed
+ """
+ # Remove untracked allocated stock
+ self.subtract_allocated_stock(user)
+
+ # Ensure that there are no longer any BuildItem objects
+ # which point to this Build Order
+ self.allocated_stock.delete()
+
@transaction.atomic
def complete_build(self, user):
"""Mark this build as complete."""
+
+ import build.tasks
+
if self.incomplete_count > 0:
return
@@ -527,12 +545,12 @@ class Build(MPTTModel, InvenTree.mixins.DiffMixin, InvenTree.models.InvenTreeBar
self.status = BuildStatus.COMPLETE.value
self.save()
- # Remove untracked allocated stock
- self.subtract_allocated_stock(user)
-
- # Ensure that there are no longer any BuildItem objects
- # which point to this Build Order
- self.allocated_stock.delete()
+ # Offload task to complete build allocations
+ InvenTree.tasks.offload_task(
+ build.tasks.complete_build_allocations,
+ self.pk,
+ user.pk if user else None
+ )
# Register an event
trigger_event('build.completed', id=self.pk)
@@ -916,6 +934,11 @@ class Build(MPTTModel, InvenTree.mixins.DiffMixin, InvenTree.models.InvenTreeBar
# List the allocated BuildItem objects for the given output
allocated_items = output.items_to_install.all()
+ if (common.settings.prevent_build_output_complete_on_incompleted_tests() and output.hasRequiredTests() and not output.passedAllRequiredTests()):
+ serial = output.serial
+ raise ValidationError(
+ _(f"Build output {serial} has not passed all required tests"))
+
for build_item in allocated_items:
# Complete the allocation of stock for that item
build_item.complete_allocation(user)
@@ -1247,7 +1270,7 @@ class BuildOrderAttachment(InvenTree.models.InvenTreeAttachment):
build = models.ForeignKey(Build, on_delete=models.CASCADE, related_name='attachments')
-class BuildLine(models.Model):
+class BuildLine(InvenTree.models.InvenTreeModel):
"""A BuildLine object links a BOMItem to a Build.
When a new Build is created, the BuildLine objects are created automatically.
@@ -1326,7 +1349,7 @@ class BuildLine(models.Model):
return self.allocated_quantity() > self.quantity
-class BuildItem(InvenTree.models.MetadataMixin, models.Model):
+class BuildItem(InvenTree.models.InvenTreeMetadataModel):
"""A BuildItem links multiple StockItem objects to a Build.
These are used to allocate part stock to a build. Once the Build is completed, the parts are removed from stock and the BuildItemAllocation objects are removed.
diff --git a/InvenTree/build/serializers.py b/InvenTree/build/serializers.py
index 337c00452d..0ae06ef18f 100644
--- a/InvenTree/build/serializers.py
+++ b/InvenTree/build/serializers.py
@@ -1,5 +1,7 @@
"""JSON serializers for Build API."""
+from decimal import Decimal
+
from django.db import transaction
from django.core.exceptions import ValidationError as DjangoValidationError
from django.utils.translation import gettext_lazy as _
@@ -7,22 +9,25 @@ from django.utils.translation import gettext_lazy as _
from django.db import models
from django.db.models import ExpressionWrapper, F, FloatField
from django.db.models import Case, Sum, When, Value
-from django.db.models import BooleanField
+from django.db.models import BooleanField, Q
from django.db.models.functions import Coalesce
from rest_framework import serializers
from rest_framework.serializers import ValidationError
+from sql_util.utils import SubquerySum
+
from InvenTree.serializers import InvenTreeModelSerializer, InvenTreeAttachmentSerializer
from InvenTree.serializers import UserSerializer
import InvenTree.helpers
from InvenTree.serializers import InvenTreeDecimalField
-from InvenTree.status_codes import StockStatus
+from InvenTree.status_codes import BuildStatusGroups, StockStatus
from stock.models import generate_batch_code, StockItem, StockLocation
from stock.serializers import StockItemSerializerBrief, LocationSerializer
+import common.models
from common.serializers import ProjectCodeSerializer
import part.filters
from part.serializers import BomItemSerializer, PartSerializer, PartBriefSerializer
@@ -519,6 +524,17 @@ class BuildOutputCompleteSerializer(serializers.Serializer):
outputs = data.get('outputs', [])
+ if common.settings.prevent_build_output_complete_on_incompleted_tests():
+ errors = []
+ for output in outputs:
+ stock_item = output['output']
+ if stock_item.hasRequiredTests() and not stock_item.passedAllRequiredTests():
+ serial = stock_item.serial
+ errors.append(_(f"Build output {serial} has not passed all required tests"))
+
+ if errors:
+ raise ValidationError(errors)
+
if len(outputs) == 0:
raise ValidationError(_("A list of build outputs must be provided"))
@@ -904,18 +920,24 @@ class BuildAllocationSerializer(serializers.Serializer):
if build_line.bom_item.consumable:
continue
+ params = {
+ "build_line": build_line,
+ "stock_item": stock_item,
+ "install_into": output,
+ }
+
try:
- # Create a new BuildItem to allocate stock
- build_item, created = BuildItem.objects.get_or_create(
- build_line=build_line,
- stock_item=stock_item,
- install_into=output,
- )
- if created:
- build_item.quantity = quantity
- else:
+ if build_item := BuildItem.objects.filter(**params).first():
+ # Find an existing BuildItem for this stock item
+ # If it exists, increase the quantity
build_item.quantity += quantity
- build_item.save()
+ build_item.save()
+ else:
+ # Create a new BuildItem to allocate stock
+ build_item = BuildItem.objects.create(
+ quantity=quantity,
+ **params
+ )
except (ValidationError, DjangoValidationError) as exc:
# Catch model errors and re-throw as DRF errors
raise ValidationError(detail=serializers.as_serializer_error(exc))
@@ -1019,7 +1041,7 @@ class BuildItemSerializer(InvenTreeModelSerializer):
"""Determine which extra details fields should be included"""
part_detail = kwargs.pop('part_detail', True)
location_detail = kwargs.pop('location_detail', True)
- stock_detail = kwargs.pop('stock_detail', False)
+ stock_detail = kwargs.pop('stock_detail', True)
build_detail = kwargs.pop('build_detail', False)
super().__init__(*args, **kwargs)
@@ -1055,11 +1077,13 @@ class BuildLineSerializer(InvenTreeModelSerializer):
# Annotated fields
'allocated',
+ 'in_production',
'on_order',
'available_stock',
'available_substitute_stock',
'available_variant_stock',
'total_available_stock',
+ 'external_stock',
]
read_only_fields = [
@@ -1070,26 +1094,54 @@ class BuildLineSerializer(InvenTreeModelSerializer):
quantity = serializers.FloatField()
+ bom_item = serializers.PrimaryKeyRelatedField(label=_('BOM Item'), read_only=True)
+
# Foreign key fields
bom_item_detail = BomItemSerializer(source='bom_item', many=False, read_only=True, pricing=False)
part_detail = PartSerializer(source='bom_item.sub_part', many=False, read_only=True, pricing=False)
allocations = BuildItemSerializer(many=True, read_only=True)
# Annotated (calculated) fields
- allocated = serializers.FloatField(read_only=True)
- on_order = serializers.FloatField(read_only=True)
- available_stock = serializers.FloatField(read_only=True)
+ allocated = serializers.FloatField(
+ label=_('Allocated Stock'),
+ read_only=True
+ )
+
+ on_order = serializers.FloatField(
+ label=_('On Order'),
+ read_only=True
+ )
+
+ in_production = serializers.FloatField(
+ label=_('In Production'),
+ read_only=True
+ )
+
+ available_stock = serializers.FloatField(
+ label=_('Available Stock'),
+ read_only=True
+ )
+
available_substitute_stock = serializers.FloatField(read_only=True)
available_variant_stock = serializers.FloatField(read_only=True)
total_available_stock = serializers.FloatField(read_only=True)
+ external_stock = serializers.FloatField(read_only=True)
@staticmethod
- def annotate_queryset(queryset):
+ def annotate_queryset(queryset, build=None):
"""Add extra annotations to the queryset:
- allocated: Total stock quantity allocated against this build line
- available: Total stock available for allocation against this build line
- on_order: Total stock on order for this build line
+ - in_production: Total stock currently in production for this build line
+
+ Arguments:
+ queryset: The queryset to annotate
+ build: The build order to filter against (optional)
+
+ Note: If the 'build' is provided, we can use it to filter available stock, depending on the specified location for the build
+
"""
queryset = queryset.select_related(
'build', 'bom_item',
@@ -1126,6 +1178,23 @@ class BuildLineSerializer(InvenTreeModelSerializer):
ref = 'bom_item__sub_part__'
+ stock_filter = None
+
+ if build is not None and build.take_from is not None:
+ location = build.take_from
+ # Filter by locations below the specified location
+ stock_filter = Q(
+ location__tree_id=location.tree_id,
+ location__lft__gte=location.lft,
+ location__rght__lte=location.rght,
+ location__level__gte=location.level,
+ )
+
+ # Annotate the "in_production" quantity
+ queryset = queryset.annotate(
+ in_production=part.filters.annotate_in_production_quantity(reference=ref)
+ )
+
# Annotate the "on_order" quantity
# Difficulty: Medium
queryset = queryset.annotate(
@@ -1133,10 +1202,8 @@ class BuildLineSerializer(InvenTreeModelSerializer):
)
# Annotate the "available" quantity
- # TODO: In the future, this should be refactored.
- # TODO: Note that part.serializers.BomItemSerializer also has a similar annotation
queryset = queryset.alias(
- total_stock=part.filters.annotate_total_stock(reference=ref),
+ total_stock=part.filters.annotate_total_stock(reference=ref, filter=stock_filter),
allocated_to_sales_orders=part.filters.annotate_sales_order_allocations(reference=ref),
allocated_to_build_orders=part.filters.annotate_build_order_allocations(reference=ref),
)
@@ -1149,11 +1216,21 @@ class BuildLineSerializer(InvenTreeModelSerializer):
)
)
+ external_stock_filter = Q(location__external=True)
+
+ if stock_filter:
+ external_stock_filter &= stock_filter
+
+ # Add 'external stock' annotations
+ queryset = queryset.annotate(
+ external_stock=part.filters.annotate_total_stock(reference=ref, filter=external_stock_filter)
+ )
+
ref = 'bom_item__substitutes__part__'
# Extract similar information for any 'substitute' parts
queryset = queryset.alias(
- substitute_stock=part.filters.annotate_total_stock(reference=ref),
+ substitute_stock=part.filters.annotate_total_stock(reference=ref, filter=stock_filter),
substitute_build_allocations=part.filters.annotate_build_order_allocations(reference=ref),
substitute_sales_allocations=part.filters.annotate_sales_order_allocations(reference=ref)
)
@@ -1167,7 +1244,7 @@ class BuildLineSerializer(InvenTreeModelSerializer):
)
# Annotate the queryset with 'available variant stock' information
- variant_stock_query = part.filters.variant_stock_query(reference='bom_item__sub_part__')
+ variant_stock_query = part.filters.variant_stock_query(reference='bom_item__sub_part__', filter=stock_filter)
queryset = queryset.alias(
variant_stock_total=part.filters.annotate_variant_quantity(variant_stock_query, reference='quantity'),
diff --git a/InvenTree/build/tasks.py b/InvenTree/build/tasks.py
index 46fd97cab4..472b8c5166 100644
--- a/InvenTree/build/tasks.py
+++ b/InvenTree/build/tasks.py
@@ -4,6 +4,7 @@ from datetime import datetime, timedelta
from decimal import Decimal
import logging
+from django.contrib.auth.models import User
from django.utils.translation import gettext_lazy as _
from django.template.loader import render_to_string
@@ -24,6 +25,27 @@ import part.models as part_models
logger = logging.getLogger('inventree')
+def complete_build_allocations(build_id: int, user_id: int):
+ """Complete build allocations for a specified BuildOrder."""
+
+ build_order = build.models.Build.objects.filter(pk=build_id).first()
+
+ if user_id:
+ try:
+ user = User.objects.get(pk=user_id)
+ except User.DoesNotExist:
+ logger.warning("Could not complete build allocations for BuildOrder <%s> - User does not exist", build_id)
+ return
+ else:
+ user = None
+
+ if not build_order:
+ logger.warning("Could not complete build allocations for BuildOrder <%s> - BuildOrder does not exist", build_id)
+ return
+
+ build_order.complete_allocations(user)
+
+
def update_build_order_lines(bom_item_pk: int):
"""Update all BuildOrderLineItem objects which reference a particular BomItem.
diff --git a/InvenTree/build/templates/build/detail.html b/InvenTree/build/templates/build/detail.html
index ffde5c2878..3d2e5d4e96 100644
--- a/InvenTree/build/templates/build/detail.html
+++ b/InvenTree/build/templates/build/detail.html
@@ -200,6 +200,11 @@
{% include "filter_list.html" with id='buildlines' %}
+ {% if build.take_from %}
+
+ {% trans "Available stock has been filtered based on specified source location for this build order" %}
+
+ {% endif %}