From 5376c5b022ce07352f465c6f399b1f2124a241be Mon Sep 17 00:00:00 2001 From: Oliver Date: Tue, 8 Feb 2022 23:38:18 +1100 Subject: [PATCH 01/14] Allow POST of files for unit testing --- InvenTree/InvenTree/api_tester.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/InvenTree/InvenTree/api_tester.py b/InvenTree/InvenTree/api_tester.py index 3d8481f84e..fe2057b453 100644 --- a/InvenTree/InvenTree/api_tester.py +++ b/InvenTree/InvenTree/api_tester.py @@ -106,12 +106,12 @@ class InvenTreeAPITestCase(APITestCase): return response - def post(self, url, data, expected_code=None): + def post(self, url, data, expected_code=None, format='json'): """ Issue a POST request """ - response = self.client.post(url, data=data, format='json') + response = self.client.post(url, data=data, format=format) if expected_code is not None: self.assertEqual(response.status_code, expected_code) @@ -130,12 +130,12 @@ class InvenTreeAPITestCase(APITestCase): return response - def patch(self, url, data, files=None, expected_code=None): + def patch(self, url, data, expected_code=None, format='json'): """ Issue a PATCH request """ - response = self.client.patch(url, data=data, files=files, format='json') + response = self.client.patch(url, data=data, format=format) if expected_code is not None: self.assertEqual(response.status_code, expected_code) From 8fc2695873c8252aa4f9dc2d9e8fd03412b9763d Mon Sep 17 00:00:00 2001 From: Oliver Date: Wed, 9 Feb 2022 08:31:08 +1100 Subject: [PATCH 02/14] Catch potential file processing errors --- InvenTree/part/serializers.py | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/InvenTree/part/serializers.py b/InvenTree/part/serializers.py index 351348c6bc..32a93f5452 100644 --- a/InvenTree/part/serializers.py +++ b/InvenTree/part/serializers.py @@ -818,13 +818,22 @@ class BomExtractSerializer(serializers.Serializer): raise serializers.ValidationError(_("File is too large")) # Read file data into memory (bytes object) - data = bom_file.read() + try: + data = bom_file.read() + except Exception as e: + raise serializers.ValidationError(str(e)) if ext in ['csv', 'tsv', 'xml']: - data = data.decode() + try: + data = data.decode() + except Exception as e: + raise serializers.ValidationError(str(e)) # Convert to a tablib dataset (we expect headers) - self.dataset = tablib.Dataset().load(data, ext, headers=True) + try: + self.dataset = tablib.Dataset().load(data, ext, headers=True) + except Exception as e: + raise serializers.ValidationError(str(e)) for header in self.REQUIRED_COLUMNS: From 692039f712a2c05526c06a60c007b26c4ea7bbb3 Mon Sep 17 00:00:00 2001 From: Oliver Date: Wed, 9 Feb 2022 08:38:28 +1100 Subject: [PATCH 03/14] Add unit testing for uploading invalid BOM files --- InvenTree/part/test_bom_import.py | 145 ++++++++++++++++++++++++++++++ 1 file changed, 145 insertions(+) create mode 100644 InvenTree/part/test_bom_import.py diff --git a/InvenTree/part/test_bom_import.py b/InvenTree/part/test_bom_import.py new file mode 100644 index 0000000000..1438c3ee1c --- /dev/null +++ b/InvenTree/part/test_bom_import.py @@ -0,0 +1,145 @@ +""" +Unit testing for BOM upload / import functionality +""" + +import tablib + +from django.core.files.uploadedfile import SimpleUploadedFile +from django.urls import reverse + +from InvenTree.api_tester import InvenTreeAPITestCase + +from part.models import Part + + +class BomUploadTest(InvenTreeAPITestCase): + """ + Test BOM file upload API endpoint + """ + + roles = [ + 'part.add', + 'part.change', + ] + + def setUp(self): + super().setUp() + + self.part = Part.objects.create( + name='Assembly', + description='An assembled part', + assembly=True, + ) + + self.url = reverse('api-bom-extract') + + def post_bom(self, filename, file_data, part=None, clear_existing=None, expected_code=None, content_type='text/plain'): + + bom_file = SimpleUploadedFile( + filename, + file_data, + content_type=content_type, + ) + + if part is None: + part = self.part.pk + + if clear_existing is None: + clear_existing = False + + response = self.post( + self.url, + data={ + 'bom_file': bom_file, + 'part': part, + 'clear_existing': clear_existing, + }, + expected_code=expected_code, + format='multipart', + ) + + return response + + def test_missing_file(self): + """ + POST without a file + """ + + response = self.post( + self.url, + data={}, + expected_code=400 + ) + + self.assertIn('No file was submitted', str(response.data['bom_file'])) + self.assertIn('This field is required', str(response.data['part'])) + self.assertIn('This field is required', str(response.data['clear_existing'])) + + def test_unsupported_file(self): + """ + POST with an unsupported file type + """ + + response = self.post_bom( + 'sample.txt', + b'hello world', + expected_code=400, + ) + + self.assertIn('Unsupported file type', str(response.data['bom_file'])) + + def test_broken_file(self): + """ + Test upload with broken (corrupted) files + """ + + response = self.post_bom( + 'sample.csv', + b'', + expected_code=400, + ) + + self.assertIn('The submitted file is empty', str(response.data['bom_file'])) + + response = self.post_bom( + 'test.xls', + b'hello world', + expected_code=400, + content_type='application/xls', + ) + + self.assertIn('Unsupported format, or corrupt file', str(response.data['bom_file'])) + + def test_invalid_upload(self): + """ + Test upload of an invalid file + """ + + dataset = tablib.Dataset() + + dataset.headers = [ + 'apple', + 'banana', + ] + + dataset.append(['test', 'test']) + dataset.append(['hello', 'world']) + + response = self.post_bom( + 'test.csv', + bytes(dataset.csv, 'utf8'), + expected_code=400, + content_type='text/csv', + ) + + self.assertIn("Missing required column: 'quantity'", str(response.data)) + + # Try again, with an .xlsx file + response = self.post_bom( + 'bom.xlsx', + dataset.xlsx, + content_type='application/xlsx', + expected_code=400, + ) + + self.assertIn("Missing required column: 'quantity'", str(response.data)) From 29c3064ae76766bca0d3a93b71daa086bfd48464 Mon Sep 17 00:00:00 2001 From: Oliver Date: Wed, 9 Feb 2022 11:27:51 +1100 Subject: [PATCH 04/14] Raise error if imported dataset contains no data rows --- InvenTree/part/serializers.py | 8 ++++++++ InvenTree/part/test_bom_import.py | 29 +++++++++++++++++++++++++---- 2 files changed, 33 insertions(+), 4 deletions(-) diff --git a/InvenTree/part/serializers.py b/InvenTree/part/serializers.py index 32a93f5452..490237eb34 100644 --- a/InvenTree/part/serializers.py +++ b/InvenTree/part/serializers.py @@ -857,6 +857,9 @@ class BomExtractSerializer(serializers.Serializer): if not part_match: raise serializers.ValidationError(_("No part column found")) + if len(self.dataset) == 0: + raise serializers.ValidationError(_("No data rows found")) + return bom_file def extract_data(self): @@ -931,6 +934,11 @@ class BomExtractSerializer(serializers.Serializer): row['part'] = part.pk if part is not None else None + # For each "optional" column, ensure the column names are allocated correctly + for field_name in self.OPTIONAL_COLUMNS: + if field_name not in row: + row[field_name] = self.find_matching_data(row, field_name, self.dataset.headers) + rows.append(row) return { diff --git a/InvenTree/part/test_bom_import.py b/InvenTree/part/test_bom_import.py index 1438c3ee1c..6bc5019c59 100644 --- a/InvenTree/part/test_bom_import.py +++ b/InvenTree/part/test_bom_import.py @@ -122,14 +122,11 @@ class BomUploadTest(InvenTreeAPITestCase): 'banana', ] - dataset.append(['test', 'test']) - dataset.append(['hello', 'world']) - response = self.post_bom( 'test.csv', bytes(dataset.csv, 'utf8'), - expected_code=400, content_type='text/csv', + expected_code=400, ) self.assertIn("Missing required column: 'quantity'", str(response.data)) @@ -143,3 +140,27 @@ class BomUploadTest(InvenTreeAPITestCase): ) self.assertIn("Missing required column: 'quantity'", str(response.data)) + + # Add the quantity field (or close enough) + dataset.headers.append('quAntiTy ') + + response = self.post_bom( + 'test.csv', + bytes(dataset.csv, 'utf8'), + content_type='text/csv', + expected_code=400, + ) + + self.assertIn('No part column found', str(response.data)) + + dataset.headers.append('part_id') + dataset.headers.append('part_name') + + response = self.post_bom( + 'test.csv', + bytes(dataset.csv, 'utf8'), + content_type='text/csv', + expected_code=400, + ) + + self.assertIn('No data rows found', str(response.data)) From a9e1357ffb6c1afefaad21945432b2eb88d4ef21 Mon Sep 17 00:00:00 2001 From: Oliver Date: Wed, 9 Feb 2022 11:30:58 +1100 Subject: [PATCH 05/14] Return per-row error messages when extracting data --- InvenTree/part/serializers.py | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/InvenTree/part/serializers.py b/InvenTree/part/serializers.py index 490237eb34..38a2bd443f 100644 --- a/InvenTree/part/serializers.py +++ b/InvenTree/part/serializers.py @@ -868,6 +868,7 @@ class BomExtractSerializer(serializers.Serializer): """ rows = [] + errors = [] headers = self.dataset.headers @@ -875,6 +876,8 @@ class BomExtractSerializer(serializers.Serializer): for row in self.dataset.dict: + error = {} + """ If the "level" column is specified, and this is not a top-level BOM item, ignore the row! """ @@ -929,8 +932,15 @@ class BomExtractSerializer(serializers.Serializer): queryset = queryset.filter(IPN=part_ipn) # Only if we have a single direct match - if queryset.exists() and queryset.count() == 1: - part = queryset.first() + if queryset.exists(): + if queryset.count() == 1: + part = queryset.first() + else: + # Multiple matches! + error['part'] = _('Multiple matching parts found') + + if part is None and 'part' not in error: + error['part'] = _('No matching part found') row['part'] = part.pk if part is not None else None @@ -940,9 +950,11 @@ class BomExtractSerializer(serializers.Serializer): row[field_name] = self.find_matching_data(row, field_name, self.dataset.headers) rows.append(row) + errors.append(error) return { 'rows': rows, + 'errors': errors, 'headers': headers, 'filename': self.filename, } From 67a9c0aeec4f732c78e2ae87ae390d45020684bc Mon Sep 17 00:00:00 2001 From: Oliver Date: Wed, 9 Feb 2022 11:31:36 +1100 Subject: [PATCH 06/14] PEP fixes --- InvenTree/part/serializers.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/InvenTree/part/serializers.py b/InvenTree/part/serializers.py index 38a2bd443f..308641085a 100644 --- a/InvenTree/part/serializers.py +++ b/InvenTree/part/serializers.py @@ -938,7 +938,7 @@ class BomExtractSerializer(serializers.Serializer): else: # Multiple matches! error['part'] = _('Multiple matching parts found') - + if part is None and 'part' not in error: error['part'] = _('No matching part found') @@ -948,7 +948,7 @@ class BomExtractSerializer(serializers.Serializer): for field_name in self.OPTIONAL_COLUMNS: if field_name not in row: row[field_name] = self.find_matching_data(row, field_name, self.dataset.headers) - + rows.append(row) errors.append(error) From 2af617e92bd005b650fd8a4efccce41434cec69f Mon Sep 17 00:00:00 2001 From: Oliver Date: Wed, 9 Feb 2022 11:34:25 +1100 Subject: [PATCH 07/14] Adds check for duplicate parts when importing --- InvenTree/part/serializers.py | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/InvenTree/part/serializers.py b/InvenTree/part/serializers.py index 308641085a..aef0c1ee0f 100644 --- a/InvenTree/part/serializers.py +++ b/InvenTree/part/serializers.py @@ -870,6 +870,8 @@ class BomExtractSerializer(serializers.Serializer): rows = [] errors = [] + found_parts = set() + headers = self.dataset.headers level_column = self.find_matching_column('level', headers) @@ -939,8 +941,14 @@ class BomExtractSerializer(serializers.Serializer): # Multiple matches! error['part'] = _('Multiple matching parts found') - if part is None and 'part' not in error: - error['part'] = _('No matching part found') + if part is None: + if 'part' not in error: + error['part'] = _('No matching part found') + else: + if part.pk in found_parts: + error['part'] = _('Duplicate part selected') + else: + found_parts.add(part.pk) row['part'] = part.pk if part is not None else None From 001437e083c6f7fe544777e1bf4a3edee8f3f2fb Mon Sep 17 00:00:00 2001 From: Oliver Date: Wed, 9 Feb 2022 23:02:09 +1100 Subject: [PATCH 08/14] Increased error checking when uploading BOM data --- InvenTree/part/serializers.py | 35 +++++++++++++++++----- InvenTree/part/test_bom_import.py | 49 +++++++++++++++++++++++++++++++ 2 files changed, 76 insertions(+), 8 deletions(-) diff --git a/InvenTree/part/serializers.py b/InvenTree/part/serializers.py index aef0c1ee0f..2ec2c43707 100644 --- a/InvenTree/part/serializers.py +++ b/InvenTree/part/serializers.py @@ -878,7 +878,7 @@ class BomExtractSerializer(serializers.Serializer): for row in self.dataset.dict: - error = {} + row_error = {} """ If the "level" column is specified, and this is not a top-level BOM item, ignore the row! @@ -939,26 +939,45 @@ class BomExtractSerializer(serializers.Serializer): part = queryset.first() else: # Multiple matches! - error['part'] = _('Multiple matching parts found') + row_error['part'] = _('Multiple matching parts found') if part is None: - if 'part' not in error: - error['part'] = _('No matching part found') + if 'part' not in row_error: + row_error['part'] = _('No matching part found') else: if part.pk in found_parts: - error['part'] = _('Duplicate part selected') - else: - found_parts.add(part.pk) + row_error['part'] = _("Duplicate part selected") + + elif not part.component: + row_error['part'] = _('Part is not designated as a component') + + found_parts.add(part.pk) row['part'] = part.pk if part is not None else None + """ + Read out the 'quantity' column - check that it is valid + """ + quantity = self.find_matching_data(row, 'quantity', self.dataset.headers) + + if quantity is None: + row_error['quantity'] = _('Quantity not provided') + else: + try: + quantity = Decimal(quantity) + + if quantity <= 0: + row_error['quantity'] = _('Quantity must be greater than zero') + except: + row_error['quantity'] = _('Invalid quantity') + # For each "optional" column, ensure the column names are allocated correctly for field_name in self.OPTIONAL_COLUMNS: if field_name not in row: row[field_name] = self.find_matching_data(row, field_name, self.dataset.headers) rows.append(row) - errors.append(error) + errors.append(row_error) return { 'rows': rows, diff --git a/InvenTree/part/test_bom_import.py b/InvenTree/part/test_bom_import.py index 6bc5019c59..70ab3be5eb 100644 --- a/InvenTree/part/test_bom_import.py +++ b/InvenTree/part/test_bom_import.py @@ -29,8 +29,17 @@ class BomUploadTest(InvenTreeAPITestCase): name='Assembly', description='An assembled part', assembly=True, + component=False, ) + for i in range(10): + Part.objects.create( + name=f"Component {i}", + description="A subcomponent that can be used in a BOM", + component=True, + assembly=False, + ) + self.url = reverse('api-bom-extract') def post_bom(self, filename, file_data, part=None, clear_existing=None, expected_code=None, content_type='text/plain'): @@ -164,3 +173,43 @@ class BomUploadTest(InvenTreeAPITestCase): ) self.assertIn('No data rows found', str(response.data)) + + def test_invalid_data(self): + """ + Upload data which contains errors + """ + + dataset = tablib.Dataset() + + # Only these headers are strictly necessary + dataset.headers = ['part_id', 'quantity'] + + components = Part.objects.filter(component=True) + + for idx, cmp in enumerate(components): + + if idx == 5: + cmp.component = False + cmp.save() + + dataset.append([cmp.pk, idx]) + + # Add a duplicate part too + dataset.append([components.first().pk, 'invalid']) + + response = self.post_bom( + 'test.csv', + bytes(dataset.csv, 'utf8'), + content_type='text/csv', + expected_code=201 + ) + + errors = response.data['errors'] + + self.assertIn('Quantity must be greater than zero', str(errors[0])) + self.assertIn('Part is not designated as a component', str(errors[5])) + self.assertIn('Duplicate part selected', str(errors[-1])) + self.assertIn('Invalid quantity', str(errors[-1])) + + for idx, row in enumerate(response.data['rows'][:-1]): + self.assertEqual(str(row['part']), str(components[idx].pk)) From c0e940a898aa4809c48f1fdadbab30a7f96f0774 Mon Sep 17 00:00:00 2001 From: Oliver Date: Wed, 9 Feb 2022 23:26:00 +1100 Subject: [PATCH 09/14] Catch potential error when posting invalid numbers via REST API --- InvenTree/InvenTree/serializers.py | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/InvenTree/InvenTree/serializers.py b/InvenTree/InvenTree/serializers.py index 59ba0295cb..ffc84a5f71 100644 --- a/InvenTree/InvenTree/serializers.py +++ b/InvenTree/InvenTree/serializers.py @@ -328,4 +328,7 @@ class InvenTreeDecimalField(serializers.FloatField): def to_internal_value(self, data): # Convert the value to a string, and then a decimal - return Decimal(str(data)) + try: + return Decimal(str(data)) + except: + raise serializers.ValidationError(_("Invalid value")) From aa962aac83b16b9710bfadce6178976cd8598d7c Mon Sep 17 00:00:00 2001 From: Oliver Date: Wed, 9 Feb 2022 23:26:13 +1100 Subject: [PATCH 10/14] Improve part "guess" algorithm --- InvenTree/part/serializers.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/InvenTree/part/serializers.py b/InvenTree/part/serializers.py index 2ec2c43707..c5f5216f38 100644 --- a/InvenTree/part/serializers.py +++ b/InvenTree/part/serializers.py @@ -924,13 +924,13 @@ class BomExtractSerializer(serializers.Serializer): if part is None: - if part_name is not None or part_ipn is not None: + if part_name or part_ipn: queryset = Part.objects.all() - if part_name is not None: + if part_name: queryset = queryset.filter(name=part_name) - if part_ipn is not None: + if part_ipn: queryset = queryset.filter(IPN=part_ipn) # Only if we have a single direct match From 383835aa8974df639c9f75944d9adc7d80f9a232 Mon Sep 17 00:00:00 2001 From: Oliver Date: Wed, 9 Feb 2022 23:26:32 +1100 Subject: [PATCH 11/14] Display initial errors when importing data --- InvenTree/part/templates/part/upload_bom.html | 2 +- InvenTree/templates/js/translated/bom.js | 15 +++++++++++++++ InvenTree/templates/js/translated/forms.js | 6 +++--- 3 files changed, 19 insertions(+), 4 deletions(-) diff --git a/InvenTree/part/templates/part/upload_bom.html b/InvenTree/part/templates/part/upload_bom.html index 27f681acae..07213069a6 100644 --- a/InvenTree/part/templates/part/upload_bom.html +++ b/InvenTree/part/templates/part/upload_bom.html @@ -43,7 +43,7 @@ - +
diff --git a/InvenTree/templates/js/translated/bom.js b/InvenTree/templates/js/translated/bom.js index fd23e70ad0..aeaa1d933d 100644 --- a/InvenTree/templates/js/translated/bom.js +++ b/InvenTree/templates/js/translated/bom.js @@ -40,6 +40,12 @@ function constructBomUploadTable(data, options={}) { function constructRow(row, idx, fields) { // Construct an individual row from the provided data + var errors = {}; + + if (data.errors && data.errors.length > idx) { + errors = data.errors[idx]; + } + var field_options = { hideLabels: true, hideClearButton: true, @@ -92,6 +98,15 @@ function constructBomUploadTable(data, options={}) { $('#bom-import-table tbody').append(html); + // Handle any errors raised by initial data import + if (errors.part) { + addFieldErrorMessage(`items_sub_part_${idx}`, errors.part); + } + + if (errors.quantity) { + addFieldErrorMessage(`items_quantity_${idx}`, errors.quantity); + } + // Initialize the "part" selector for this row initializeRelatedField( { diff --git a/InvenTree/templates/js/translated/forms.js b/InvenTree/templates/js/translated/forms.js index fe912b3358..394c18a568 100644 --- a/InvenTree/templates/js/translated/forms.js +++ b/InvenTree/templates/js/translated/forms.js @@ -1196,13 +1196,13 @@ function handleFormErrors(errors, fields={}, options={}) { /* * Add a rendered error message to the provided field */ -function addFieldErrorMessage(name, error_text, error_idx, options={}) { +function addFieldErrorMessage(name, error_text, error_idx=0, options={}) { field_name = getFieldName(name, options); var field_dom = null; - if (options.modal) { + if (options && options.modal) { $(options.modal).find(`#div_id_${field_name}`).addClass('form-field-error'); field_dom = $(options.modal).find(`#errors-${field_name}`); } else { @@ -1210,7 +1210,7 @@ function addFieldErrorMessage(name, error_text, error_idx, options={}) { field_dom = $(`#errors-${field_name}`); } - if (field_dom) { + if (field_dom.exists()) { var error_html = ` From d38a8adf4c1f44ec364f0733996e02f1546ea682 Mon Sep 17 00:00:00 2001 From: Oliver Date: Wed, 9 Feb 2022 23:49:26 +1100 Subject: [PATCH 12/14] Add button to display original row data --- InvenTree/templates/js/translated/bom.js | 25 +++++++++++++++++++++- InvenTree/templates/js/translated/forms.js | 8 ++++++- 2 files changed, 31 insertions(+), 2 deletions(-) diff --git a/InvenTree/templates/js/translated/bom.js b/InvenTree/templates/js/translated/bom.js index aeaa1d933d..f1c749320f 100644 --- a/InvenTree/templates/js/translated/bom.js +++ b/InvenTree/templates/js/translated/bom.js @@ -78,7 +78,7 @@ function constructBomUploadTable(data, options={}) { var buttons = `
`; - // buttons += makeIconButton('fa-file-alt', 'button-row-data', idx, '{% trans "Display row data" %}'); + buttons += makeIconButton('fa-info-circle', 'button-row-data', idx, '{% trans "Display row data" %}'); buttons += makeIconButton('fa-times icon-red', 'button-row-remove', idx, '{% trans "Remove row" %}'); buttons += `
`; @@ -129,6 +129,29 @@ function constructBomUploadTable(data, options={}) { $(`#button-row-remove-${idx}`).click(function() { $(`#items_${idx}`).remove(); }); + + // Add callback for "show data" button + $(`#button-row-data-${idx}`).click(function() { + + var modal = createNewModal({ + title: '{% trans "Row Data" %}', + cancelText: '{% trans "Close" %}', + hideSubmitButton: true + }); + + // Prettify the original import data + var pretty = JSON.stringify(row, undefined, 4); + + var html = ` +
+ 
${pretty}
+
`; + + modalSetContent(modal, html); + + $(modal).modal('show'); + + }); } // Request API endpoint options diff --git a/InvenTree/templates/js/translated/forms.js b/InvenTree/templates/js/translated/forms.js index 394c18a568..a93ceb42c7 100644 --- a/InvenTree/templates/js/translated/forms.js +++ b/InvenTree/templates/js/translated/forms.js @@ -1953,7 +1953,13 @@ function constructField(name, parameters, options) { html += parameters.before; } - html += `
`; + var hover_title = ''; + + if (parameters.help_text) { + hover_title = ` title='${parameters.help_text}'`; + } + + html += `
`; // Add a label if (!options.hideLabels) { From ffb319e1360d27d2ac4e1bfa66d2f4d9c4861462 Mon Sep 17 00:00:00 2001 From: Oliver Date: Thu, 10 Feb 2022 00:00:23 +1100 Subject: [PATCH 13/14] Disable "submit" button to prevent multiple simultaneous uploads --- InvenTree/part/templates/part/upload_bom.html | 5 ++++- InvenTree/templates/js/translated/bom.js | 8 ++++++++ 2 files changed, 12 insertions(+), 1 deletion(-) diff --git a/InvenTree/part/templates/part/upload_bom.html b/InvenTree/part/templates/part/upload_bom.html index 07213069a6..57c7014197 100644 --- a/InvenTree/part/templates/part/upload_bom.html +++ b/InvenTree/part/templates/part/upload_bom.html @@ -22,8 +22,11 @@ + {% endblock %} diff --git a/InvenTree/templates/js/translated/bom.js b/InvenTree/templates/js/translated/bom.js index f1c749320f..0c70bd3d86 100644 --- a/InvenTree/templates/js/translated/bom.js +++ b/InvenTree/templates/js/translated/bom.js @@ -210,6 +210,10 @@ function submitBomTable(part_id, options={}) { getApiEndpointOptions(url, function(response) { var fields = response.actions.POST; + // Disable the "Submit BOM" button + $('#bom-submit').prop('disabled', true); + $('#bom-submit-icon').show(); + inventreePut(url, data, { method: 'POST', success: function(response) { @@ -224,6 +228,10 @@ function submitBomTable(part_id, options={}) { showApiError(xhr, url); break; } + + // Re-enable the submit button + $('#bom-submit').prop('disabled', false); + $('#bom-submit-icon').hide(); } }); }); From f460b14014203bcb51b1f97dd30c7091b60e687a Mon Sep 17 00:00:00 2001 From: Oliver Date: Thu, 10 Feb 2022 00:13:37 +1100 Subject: [PATCH 14/14] Add more unit testing for BOM file upload - Test "levels" functionality - Test part guessing / introspection --- InvenTree/part/test_bom_import.py | 83 +++++++++++++++++++++++++++++++ 1 file changed, 83 insertions(+) diff --git a/InvenTree/part/test_bom_import.py b/InvenTree/part/test_bom_import.py index 70ab3be5eb..ce622ed991 100644 --- a/InvenTree/part/test_bom_import.py +++ b/InvenTree/part/test_bom_import.py @@ -35,6 +35,7 @@ class BomUploadTest(InvenTreeAPITestCase): for i in range(10): Part.objects.create( name=f"Component {i}", + IPN=f"CMP_{i}", description="A subcomponent that can be used in a BOM", component=True, assembly=False, @@ -213,3 +214,85 @@ class BomUploadTest(InvenTreeAPITestCase): for idx, row in enumerate(response.data['rows'][:-1]): self.assertEqual(str(row['part']), str(components[idx].pk)) + + def test_part_guess(self): + """ + Test part 'guessing' when PK values are not supplied + """ + + dataset = tablib.Dataset() + + # Should be able to 'guess' the part from the name + dataset.headers = ['part_name', 'quantity'] + + components = Part.objects.filter(component=True) + + for idx, cmp in enumerate(components): + dataset.append([ + f"Component {idx}", + 10, + ]) + + response = self.post_bom( + 'test.csv', + bytes(dataset.csv, 'utf8'), + expected_code=201, + ) + + rows = response.data['rows'] + + self.assertEqual(len(rows), 10) + + for idx in range(10): + self.assertEqual(rows[idx]['part'], components[idx].pk) + + # Should also be able to 'guess' part by the IPN value + dataset = tablib.Dataset() + + dataset.headers = ['part_ipn', 'quantity'] + + for idx, cmp in enumerate(components): + dataset.append([ + f"CMP_{idx}", + 10, + ]) + + response = self.post_bom( + 'test.csv', + bytes(dataset.csv, 'utf8'), + expected_code=201, + ) + + rows = response.data['rows'] + + self.assertEqual(len(rows), 10) + + for idx in range(10): + self.assertEqual(rows[idx]['part'], components[idx].pk) + + def test_levels(self): + """ + Test that multi-level BOMs are correctly handled during upload + """ + + dataset = tablib.Dataset() + + dataset.headers = ['level', 'part', 'quantity'] + + components = Part.objects.filter(component=True) + + for idx, cmp in enumerate(components): + dataset.append([ + idx % 3, + cmp.pk, + 2, + ]) + + response = self.post_bom( + 'test.csv', + bytes(dataset.csv, 'utf8'), + expected_code=201, + ) + + # Only parts at index 1, 4, 7 should have been returned + self.assertEqual(len(response.data['rows']), 3)
{% trans "Part" %}