InvenTree/InvenTree/part/test_bom_export.py

"""Unit testing for BOM export functionality."""

import csv

from django.urls import reverse

import part.models
from InvenTree.settings import BASE_DIR
from InvenTree.unit_test import InvenTreeTestCase


class BomExportTest(InvenTreeTestCase):
    """Class for performing unit testing of BOM export functionality."""

    fixtures = ['category', 'part', 'location', 'bom']

    roles = 'all'

    def setUp(self):
        """Perform test setup functions."""
        super().setUp()

        part.models.Part.objects.rebuild()

        self.url = reverse('api-bom-download', kwargs={'pk': 100})

    def test_bom_template(self):
        """Test that the BOM template can be downloaded from the server."""
        url = reverse('api-bom-upload-template')

        # Download an XLS template
        response = self.client.get(url, data={'format': 'xls'})
        self.assertEqual(response.status_code, 200)
        self.assertEqual(
            response.headers['Content-Disposition'],
            'attachment; filename="InvenTree_BOM_Template.xls"',
        )

        # Return a simple CSV template
        response = self.client.get(url, data={'format': 'csv'})
        self.assertEqual(response.status_code, 200)
        self.assertEqual(
            response.headers['Content-Disposition'],
            'attachment; filename="InvenTree_BOM_Template.csv"',
        )

        filename = BASE_DIR / '_testfolder' / '_tmp.csv'

        with open(filename, 'wb') as f:
            f.write(response.getvalue())

        with open(filename, 'r') as f:
            reader = csv.reader(f, delimiter=',')

            for line in reader:
                headers = line
                break

            expected = [
                'Part ID',
                'Part IPN',
                'Quantity',
                'Reference',
                'Note',
                'optional',
                'overage',
                'inherited',
                'allow_variants',
            ]

            # Ensure all the expected headers are in the provided file
            for header in expected:
                self.assertIn(header, headers)

    def test_export_csv(self):
        """Test BOM download in CSV format."""
        params = {
            'format': 'csv',
            'cascade': True,
            'parameter_data': True,
            'stock_data': True,
            'supplier_data': True,
            'manufacturer_data': True,
        }

        response = self.client.get(self.url, data=params)

        self.assertEqual(response.status_code, 200)

        content = response.headers['Content-Disposition']
        self.assertEqual(content, 'attachment; filename="BOB | Bob | A2_BOM.csv"')

        filename = BASE_DIR / '_testfolder' / '_tmp.csv'

        with open(filename, 'wb') as f:
            f.write(response.getvalue())

        # Read the file
        with open(filename, 'r') as f:
            reader = csv.reader(f, delimiter=',')

            for line in reader:
                headers = line
                break

            expected = [
                'BOM Level',
                'BOM Item ID',
                'Parent ID',
                'Parent IPN',
                'Parent Name',
                'Part ID',
                'Part IPN',
                'Part Name',
                'Description',
                'Assembly',
                'Quantity',
                'optional',
                'consumable',
                'overage',
                'Reference',
                'Note',
                'inherited',
                'allow_variants',
                'Default Location',
                'Total Stock',
                'Available Stock',
                'On Order',
            ]

            for header in expected:
                self.assertIn(header, headers)

            for header in headers:
                self.assertIn(header, expected)

    def test_export_xls(self):
        """Test BOM download in XLS format."""
        params = {
            'format': 'xls',
            'cascade': True,
            'parameter_data': True,
            'stock_data': True,
            'supplier_data': True,
            'manufacturer_data': True,
        }

        response = self.client.get(self.url, data=params)

        self.assertEqual(response.status_code, 200)

        content = response.headers['Content-Disposition']
        self.assertEqual(content, 'attachment; filename="BOB | Bob | A2_BOM.xls"')

    def test_export_xlsx(self):
        """Test BOM download in XLSX format."""
        params = {
            'format': 'xlsx',
            'cascade': True,
            'parameter_data': True,
            'stock_data': True,
            'supplier_data': True,
            'manufacturer_data': True,
        }

        response = self.client.get(self.url, data=params)

        self.assertEqual(response.status_code, 200)

    def test_export_json(self):
        """Test BOM download in JSON format."""
        params = {
            'format': 'json',
            'cascade': True,
            'parameter_data': True,
            'stock_data': True,
            'supplier_data': True,
            'manufacturer_data': True,
        }

        response = self.client.get(self.url, data=params)

        self.assertEqual(response.status_code, 200)

        content = response.headers['Content-Disposition']
        self.assertEqual(content, 'attachment; filename="BOB | Bob | A2_BOM.json"')