2
0
mirror of https://github.com/inventree/InvenTree.git synced 2025-06-17 04:25:42 +00:00

Reference fields (#3267)

* Adds a configurable 'reference pattern' to the IndexingReferenceMixin class

* Expand tests for reference_pattern validator:

- Prevent inclusion of illegal characters
- Prevent multiple groups of hash (#) characters
- Add unit tests

* Validator now checks for valid strftime formatter

* Adds build order reference pattern

* Adds function for creating a valid regex from the supplied pattern

- More unit tests
- Use it to validate BuildOrder reference field

* Refactoring the whole thing again - try using python string.format

* remove datetime-matcher from requirements.txt

* Add some more formatting helper functions

- Construct a regular expression from a format string
- Extract named values from a string, based on a format string

* Fix validator for build order reference field

* Adding unit tests for the new format string functionality

* Adds validation for reference fields

* Require the 'ref' format key as part of a valid reference pattern

* Extend format extraction to allow specification of integer groups

* Remove unused import

* Fix requirements

* Add method for generating the 'next' reference field for a model

* Fix function for generating next BuildOrder reference value

- A function is required as class methods cannot be used
- Simply wraps the existing class method

* Remove BUILDORDER_REFERENCE_REGEX setting

* Add unit test for build order reference field validation

* Adds unit testing for extracting integer values from a reference field

* Fix bugs from previous commit

* Add unit test for generation of default build order reference

* Add data migration for BuildOrder model

- Update reference field with old prefix
- Construct new pattern based on old prefix

* Adds unit test for data migration

- Check that the BuildOrder reference field is updated as expected

* Remove 'BUILDORDER_REFERENCE_PREFIX' setting

* Adds new setting for SalesOrder reference pattern

* Update method by which next reference value is generated

* Improved error handling in api_tester code

* Improve automated generation of order reference fields

- Handle potential errors
- Return previous reference if something goes wrong

* SalesOrder reference has now been updated also

- New reference pattern setting
- Updated default and validator for reference field
- Updated serializer and API
- Added unit tests

* Migrate the "PurchaseOrder" reference field to the new system

* Data migration for SalesOrder and PurchaseOrder reference fields

* Remove PURCHASEORDER_REFERENCE_PREFIX

* Remove references to SALESORDER_REFERENCE_PREFIX

* Re-add maximum value validation

* Bug fixes

* Improve algorithm for generating new reference

- Handle case where most recent reference does not conform to the reference pattern

* Fixes for 'order' unit tests

* Unit test fixes for order app

* More unit test fixes

* More unit test fixing

* Revert behaviour for "extract_int" clipping function

* Unit test value fix

* Prevent build order notification if we are importing records
This commit is contained in:
Oliver
2022-07-11 00:01:46 +10:00
committed by GitHub
parent 6133c745d7
commit 648faf4ed2
45 changed files with 1166 additions and 294 deletions

View File

@ -5,7 +5,7 @@
fields:
part: 100 # Build against part 100 "Bob"
batch: 'B1'
reference: "0001"
reference: "BO-0001"
title: 'Building 7 parts'
quantity: 7
notes: 'Some simple notes'
@ -21,7 +21,7 @@
pk: 2
fields:
part: 50
reference: "0002"
reference: "BO-0002"
title: 'Making things'
batch: 'B2'
status: 40 # COMPLETE
@ -37,7 +37,7 @@
pk: 3
fields:
part: 50
reference: "0003"
reference: "BO-003"
title: 'Making things'
batch: 'B2'
status: 40 # COMPLETE
@ -53,7 +53,7 @@
pk: 4
fields:
part: 50
reference: "0004"
reference: "BO-4"
title: 'Making things'
batch: 'B4'
status: 40 # COMPLETE
@ -69,7 +69,7 @@
pk: 5
fields:
part: 25
reference: "0005"
reference: "BO-0005"
title: "Building some Widgets"
batch: "B10"
status: 40 # Complete

View File

@ -1,6 +1,6 @@
# Generated by Django 3.0.7 on 2020-10-19 13:02
import InvenTree.validators
import build.validators
from django.db import migrations, models
@ -18,6 +18,6 @@ class Migration(migrations.Migration):
migrations.AlterField(
model_name='build',
name='reference',
field=models.CharField(help_text='Build Order Reference', max_length=64, unique=True, validators=[InvenTree.validators.validate_build_order_reference], verbose_name='Reference'),
field=models.CharField(help_text='Build Order Reference', max_length=64, unique=True, validators=[build.validators.validate_build_order_reference], verbose_name='Reference'),
),
]

View File

@ -1,6 +1,6 @@
# Generated by Django 3.2.4 on 2021-07-08 14:14
import InvenTree.validators
import build.validators
import build.models
from django.db import migrations, models
@ -15,6 +15,6 @@ class Migration(migrations.Migration):
migrations.AlterField(
model_name='build',
name='reference',
field=models.CharField(default=build.models.get_next_build_number, help_text='Build Order Reference', max_length=64, unique=True, validators=[InvenTree.validators.validate_build_order_reference], verbose_name='Reference'),
field=models.CharField(default=build.validators.generate_next_build_reference, help_text='Build Order Reference', max_length=64, unique=True, validators=[build.validators.validate_build_order_reference], verbose_name='Reference'),
),
]

View File

@ -0,0 +1,69 @@
# Generated by Django 3.2.14 on 2022-07-07 11:01
from django.db import migrations
def update_build_reference(apps, schema_editor):
"""Update the build order reference.
Ref: https://github.com/inventree/InvenTree/pull/3267
Performs the following steps:
- Extract existing 'prefix' value
- Generate a build order pattern based on the prefix value
- Update any existing build order references with the specified prefix
"""
InvenTreeSetting = apps.get_model('common', 'inventreesetting')
try:
prefix = InvenTreeSetting.objects.get(key='BUILDORDER_REFERENCE_PREFIX').value
except Exception:
prefix = 'BO-'
# Construct a reference pattern
pattern = prefix + '{ref:04d}'
# Create or update the BuildOrder.reference pattern
try:
setting = InvenTreeSetting.objects.get(key='BUILDORDER_REFERENCE_PATTERN')
setting.value = pattern
setting.save()
except InvenTreeSetting.DoesNotExist:
setting = InvenTreeSetting.objects.create(
key='BUILDORDER_REFERENCE_PATTERN',
value=pattern,
)
# Update any existing build order references with the prefix
Build = apps.get_model('build', 'build')
n = 0
for build in Build.objects.all():
if not build.reference.startswith(prefix):
build.reference = prefix + build.reference
build.save()
n += 1
if n > 0:
print(f"Updated reference field for {n} BuildOrder objects")
def nupdate_build_reference(apps, schema_editor):
"""Reverse migration code. Does nothing."""
pass
class Migration(migrations.Migration):
dependencies = [
('build', '0035_alter_build_notes'),
]
operations = [
migrations.RunPython(
update_build_reference,
reverse_code=nupdate_build_reference,
)
]

View File

@ -22,12 +22,14 @@ from mptt.exceptions import InvalidMove
from rest_framework import serializers
from InvenTree.status_codes import BuildStatus, StockStatus, StockHistoryCode
from InvenTree.helpers import increment, getSetting, normalize, MakeBarcode, notify_responsible
from InvenTree.helpers import increment, normalize, MakeBarcode, notify_responsible
from InvenTree.models import InvenTreeAttachment, ReferenceIndexingMixin
from InvenTree.validators import validate_build_order_reference
from build.validators import generate_next_build_reference, validate_build_order_reference
import InvenTree.fields
import InvenTree.helpers
import InvenTree.ready
import InvenTree.tasks
from plugin.events import trigger_event
@ -38,32 +40,6 @@ from stock import models as StockModels
from users import models as UserModels
def get_next_build_number():
"""Returns the next available BuildOrder reference number."""
if Build.objects.count() == 0:
return '0001'
build = Build.objects.exclude(reference=None).last()
attempts = {build.reference}
reference = build.reference
while 1:
reference = increment(reference)
if reference in attempts:
# Escape infinite recursion
return reference
if Build.objects.filter(reference=reference).exists():
attempts.add(reference)
else:
break
return reference
class Build(MPTTModel, ReferenceIndexingMixin):
"""A Build object organises the creation of new StockItem objects from other existing StockItem objects.
@ -89,6 +65,9 @@ class Build(MPTTModel, ReferenceIndexingMixin):
OVERDUE_FILTER = Q(status__in=BuildStatus.ACTIVE_CODES) & ~Q(target_date=None) & Q(target_date__lte=datetime.now().date())
# Global setting for specifying reference pattern
REFERENCE_PATTERN_SETTING = 'BUILDORDER_REFERENCE_PATTERN'
@staticmethod
def get_api_url():
"""Return the API URL associated with the BuildOrder model"""
@ -106,7 +85,7 @@ class Build(MPTTModel, ReferenceIndexingMixin):
def api_defaults(cls, request):
"""Return default values for this model when issuing an API OPTIONS request."""
defaults = {
'reference': get_next_build_number(),
'reference': generate_next_build_reference(),
}
if request and request.user:
@ -116,7 +95,8 @@ class Build(MPTTModel, ReferenceIndexingMixin):
def save(self, *args, **kwargs):
"""Custom save method for the BuildOrder model"""
self.rebuild_reference_field()
self.validate_reference_field(self.reference)
self.reference_int = self.rebuild_reference_field(self.reference)
try:
super().save(*args, **kwargs)
@ -172,9 +152,7 @@ class Build(MPTTModel, ReferenceIndexingMixin):
def __str__(self):
"""String representation of a BuildOrder"""
prefix = getSetting("BUILDORDER_REFERENCE_PREFIX")
return f"{prefix}{self.reference}"
return self.reference
def get_absolute_url(self):
"""Return the web URL associated with this BuildOrder"""
@ -186,9 +164,9 @@ class Build(MPTTModel, ReferenceIndexingMixin):
blank=False,
help_text=_('Build Order Reference'),
verbose_name=_('Reference'),
default=get_next_build_number,
default=generate_next_build_reference,
validators=[
validate_build_order_reference
validate_build_order_reference,
]
)
@ -199,7 +177,6 @@ class Build(MPTTModel, ReferenceIndexingMixin):
help_text=_('Brief description of the build')
)
# TODO - Perhaps delete the build "tree"
parent = TreeForeignKey(
'self',
on_delete=models.SET_NULL,
@ -1092,6 +1069,10 @@ class Build(MPTTModel, ReferenceIndexingMixin):
@receiver(post_save, sender=Build, dispatch_uid='build_post_save_log')
def after_save_build(sender, instance: Build, created: bool, **kwargs):
"""Callback function to be executed after a Build instance is saved."""
# Escape if we are importing data
if InvenTree.ready.isImportingData() or not InvenTree.ready.canAppAccessDatabase(allow_test=True):
return
from . import tasks as build_tasks
if created:

View File

@ -11,7 +11,7 @@ from rest_framework import serializers
from rest_framework.serializers import ValidationError
from InvenTree.serializers import InvenTreeModelSerializer, InvenTreeAttachmentSerializer
from InvenTree.serializers import ReferenceIndexingSerializerMixin, UserSerializer
from InvenTree.serializers import UserSerializer
import InvenTree.helpers
from InvenTree.helpers import extract_serial_numbers
@ -28,7 +28,7 @@ from users.serializers import OwnerSerializer
from .models import Build, BuildItem, BuildOrderAttachment
class BuildSerializer(ReferenceIndexingSerializerMixin, InvenTreeModelSerializer):
class BuildSerializer(InvenTreeModelSerializer):
"""Serializes a Build object."""
url = serializers.CharField(source='get_absolute_url', read_only=True)
@ -74,6 +74,16 @@ class BuildSerializer(ReferenceIndexingSerializerMixin, InvenTreeModelSerializer
if part_detail is not True:
self.fields.pop('part_detail')
reference = serializers.CharField(required=True)
def validate_reference(self, reference):
"""Custom validation for the Build reference field"""
# Ensure the reference matches the required pattern
Build.validate_reference_field(reference)
return reference
class Meta:
"""Serializer metaclass"""
model = Build

View File

@ -748,6 +748,7 @@ class BuildListTest(BuildAPITest):
Build.objects.create(
part=part,
reference="BO-0006",
quantity=10,
title='Just some thing',
status=BuildStatus.PRODUCTION,
@ -773,20 +774,23 @@ class BuildListTest(BuildAPITest):
Build.objects.create(
part=part,
quantity=10,
reference=f"build-000{i}",
reference=f"BO-{i + 10}",
title=f"Sub build {i}",
parent=parent
)
# And some sub-sub builds
for sub_build in Build.objects.filter(parent=parent):
for ii, sub_build in enumerate(Build.objects.filter(parent=parent)):
for i in range(3):
x = ii * 10 + i + 50
Build.objects.create(
part=part,
reference=f"{sub_build.reference}-00{i}-sub",
reference=f"BO-{x}",
title=f"{sub_build.reference}-00{i}-sub",
quantity=40,
title=f"sub sub build {i}",
parent=sub_build
)

View File

@ -12,7 +12,7 @@ from InvenTree import status_codes as status
import common.models
import build.tasks
from build.models import Build, BuildItem, get_next_build_number
from build.models import Build, BuildItem, generate_next_build_reference
from part.models import Part, BomItem, BomItemSubstitute
from stock.models import StockItem
from users.models import Owner
@ -88,7 +88,7 @@ class BuildTestBase(TestCase):
quantity=2
)
ref = get_next_build_number()
ref = generate_next_build_reference()
# Create a "Build" object to make 10x objects
self.build = Build.objects.create(
@ -133,20 +133,97 @@ class BuildTest(BuildTestBase):
def test_ref_int(self):
"""Test the "integer reference" field used for natural sorting"""
for ii in range(10):
common.models.InvenTreeSetting.set_setting('BUILDORDER_REFERENCE_PATTERN', 'BO-{ref}-???', change_user=None)
refs = {
'BO-123-456': 123,
'BO-456-123': 456,
'BO-999-ABC': 999,
'BO-123ABC-ABC': 123,
'BO-ABC123-ABC': 123,
}
for ref, ref_int in refs.items():
build = Build(
reference=f"{ii}_abcde",
reference=ref,
quantity=1,
part=self.assembly,
title="Making some parts"
title='Making some parts',
)
self.assertEqual(build.reference_int, 0)
build.save()
self.assertEqual(build.reference_int, ref_int)
# After saving, the integer reference should have been updated
self.assertEqual(build.reference_int, ii)
def test_ref_validation(self):
"""Test that the reference field validation works as expected"""
# Default reference pattern = 'BO-{ref:04d}
# These patterns should fail
for ref in [
'BO-1234x',
'BO1234',
'OB-1234',
'BO--1234'
]:
with self.assertRaises(ValidationError):
Build.objects.create(
part=self.assembly,
quantity=10,
reference=ref,
title='Invalid reference',
)
for ref in [
'BO-1234',
'BO-9999',
'BO-123'
]:
Build.objects.create(
part=self.assembly,
quantity=10,
reference=ref,
title='Valid reference',
)
# Try a new validator pattern
common.models.InvenTreeSetting.set_setting('BUILDORDER_REFERENCE_PATTERN', '{ref}-BO', change_user=None)
for ref in [
'1234-BO',
'9999-BO'
]:
Build.objects.create(
part=self.assembly,
quantity=10,
reference=ref,
title='Valid reference',
)
def test_next_ref(self):
"""Test that the next reference is automatically generated"""
common.models.InvenTreeSetting.set_setting('BUILDORDER_REFERENCE_PATTERN', 'XYZ-{ref:06d}', change_user=None)
build = Build.objects.create(
part=self.assembly,
quantity=5,
reference='XYZ-987',
title='Some thing',
)
self.assertEqual(build.reference_int, 987)
# Now create one *without* specifying the reference
build = Build.objects.create(
part=self.assembly,
quantity=1,
title='Some new title',
)
self.assertEqual(build.reference, 'XYZ-000988')
self.assertEqual(build.reference_int, 988)
def test_init(self):
"""Perform some basic tests before we start the ball rolling"""
@ -404,7 +481,7 @@ class BuildTest(BuildTestBase):
"""Test that a notification is sent when a new build is created"""
Build.objects.create(
reference='IIIII',
reference='BO-9999',
title='Some new build',
part=self.assembly,
quantity=5,

View File

@ -104,3 +104,57 @@ class TestReferenceMigration(MigratorTestCase):
# Check that the build reference is properly assigned
for build in Build.objects.all():
self.assertEqual(str(build.reference), str(build.pk))
class TestReferencePatternMigration(MigratorTestCase):
"""Unit test for data migration which converts reference to new format.
Ref: https://github.com/inventree/InvenTree/pull/3267
"""
migrate_from = ('build', '0019_auto_20201019_1302')
migrate_to = ('build', helpers.getNewestMigrationFile('build'))
def prepare(self):
"""Create some initial data prior to migration"""
Setting = self.old_state.apps.get_model('common', 'inventreesetting')
# Create a custom existing prefix so we can confirm the operation is working
Setting.objects.create(
key='BUILDORDER_REFERENCE_PREFIX',
value='BuildOrder-',
)
Part = self.old_state.apps.get_model('part', 'part')
assembly = Part.objects.create(
name='Assy 1',
description='An assembly',
level=0, lft=0, rght=0, tree_id=0,
)
Build = self.old_state.apps.get_model('build', 'build')
for idx in range(1, 11):
Build.objects.create(
part=assembly,
title=f"Build {idx}",
quantity=idx,
reference=f"{idx + 100}",
level=0, lft=0, rght=0, tree_id=0,
)
def test_reference_migration(self):
"""Test that the reference fields have been correctly updated"""
Build = self.new_state.apps.get_model('build', 'build')
for build in Build.objects.all():
self.assertTrue(build.reference.startswith('BuildOrder-'))
Setting = self.new_state.apps.get_model('common', 'inventreesetting')
pattern = Setting.objects.get(key='BUILDORDER_REFERENCE_PATTERN')
self.assertEqual(pattern.value, 'BuildOrder-{ref:04d}')

View File

@ -35,7 +35,7 @@ class BuildTestSimple(InvenTreeTestCase):
self.assertEqual(b.batch, 'B2')
self.assertEqual(b.quantity, 21)
self.assertEqual(str(b), 'BO0002')
self.assertEqual(str(b), 'BO-0002')
def test_url(self):
"""Test URL lookup"""
@ -75,11 +75,6 @@ class BuildTestSimple(InvenTreeTestCase):
self.assertEqual(b1.is_active, True)
self.assertEqual(b2.is_active, False)
def test_required_parts(self):
"""Test set of required BOM items for the build"""
# TODO: Generate BOM for test part
...
def test_cancel_build(self):
"""Test build cancellation function."""
build = Build.objects.get(id=1)

View File

@ -0,0 +1,25 @@
"""Validation methods for the build app"""
def generate_next_build_reference():
"""Generate the next available BuildOrder reference"""
from build.models import Build
return Build.generate_reference()
def validate_build_order_reference_pattern(pattern):
"""Validate the BuildOrder reference 'pattern' setting"""
from build.models import Build
Build.validate_reference_pattern(pattern)
def validate_build_order_reference(value):
"""Validate that the BuildOrder reference field matches the required pattern"""
from build.models import Build
Build.validate_reference_field(value)