InvenTree/InvenTree/company/test_migrations.py

"""Tests for the company model database migrations."""

from django_test_migrations.contrib.unittest_case import MigratorTestCase

from InvenTree import unit_test


class TestForwardMigrations(MigratorTestCase):
    """Unit testing class for testing 'company' app migrations."""

    migrate_from = ('company', unit_test.getOldestMigrationFile('company'))
    migrate_to = ('company', unit_test.getNewestMigrationFile('company'))

    def prepare(self):
        """Create some simple Company data, and ensure that it migrates OK."""
        Company = self.old_state.apps.get_model('company', 'company')

        Company.objects.create(
            name='MSPC', description='Michael Scotts Paper Company', is_supplier=True
        )

    def test_migrations(self):
        """Test the database state after applying all migrations."""
        Company = self.new_state.apps.get_model('company', 'company')

        self.assertEqual(Company.objects.count(), 1)


class TestManufacturerField(MigratorTestCase):
    """Tests for migration 0019 which migrates from old 'manufacturer_name' field to new 'manufacturer' field."""

    migrate_from = ('company', '0018_supplierpart_manufacturer')
    migrate_to = ('company', '0019_auto_20200413_0642')

    def prepare(self):
        """Prepare the database by adding some test data 'before' the change.

        Changes:
        - Part object
        - Company object (supplier)
        - SupplierPart object
        """
        Part = self.old_state.apps.get_model('part', 'part')
        Company = self.old_state.apps.get_model('company', 'company')
        SupplierPart = self.old_state.apps.get_model('company', 'supplierpart')

        # Create an initial part
        part = Part.objects.create(
            name='Screw',
            description='A single screw',
            level=0,
            tree_id=0,
            lft=0,
            rght=0,
        )

        # Create a company to act as the supplier
        supplier = Company.objects.create(
            name='Supplier',
            description='A supplier of parts',
            is_supplier=True,
            is_customer=False,
        )

        # Add some SupplierPart objects
        SupplierPart.objects.create(
            part=part, supplier=supplier, SKU='SCREW.001', manufacturer_name='ACME'
        )

        SupplierPart.objects.create(
            part=part, supplier=supplier, SKU='SCREW.002', manufacturer_name='Zero Corp'
        )

        self.assertEqual(Company.objects.count(), 1)

    def test_company_objects(self):
        """Test that the new companies have been created successfully."""
        # Two additional company objects should have been created
        Company = self.new_state.apps.get_model('company', 'company')
        self.assertEqual(Company.objects.count(), 3)

        # The new company/ies must be marked as "manufacturers"
        acme = Company.objects.get(name='ACME')
        self.assertTrue(acme.is_manufacturer)

        SupplierPart = self.new_state.apps.get_model('company', 'supplierpart')
        parts = SupplierPart.objects.filter(manufacturer=acme)
        self.assertEqual(parts.count(), 1)
        part = parts.first()

        # Checks on the SupplierPart object
        self.assertEqual(part.manufacturer_name, 'ACME')
        self.assertEqual(part.manufacturer.name, 'ACME')


class TestManufacturerPart(MigratorTestCase):
    """Tests for migration 0034-0037 which added and transitioned to the ManufacturerPart model."""

    migrate_from = ('company', '0033_auto_20210410_1528')
    migrate_to = ('company', '0037_supplierpart_update_3')

    def prepare(self):
        """Prepare the database by adding some test data 'before' the change.

        Changes:
        - Part object
        - Company object (supplier)
        - SupplierPart object
        """
        Part = self.old_state.apps.get_model('part', 'part')
        Company = self.old_state.apps.get_model('company', 'company')
        SupplierPart = self.old_state.apps.get_model('company', 'supplierpart')

        # Create an initial part
        part = Part.objects.create(
            name='CAP CER 0.1UF 10V X5R 0402',
            description='CAP CER 0.1UF 10V X5R 0402',
            purchaseable=True,
            level=0,
            tree_id=0,
            lft=0,
            rght=0,
        )

        # Create a manufacturer
        manufacturer = Company.objects.create(
            name='Murata',
            description='Makes capacitors',
            is_manufacturer=True,
            is_supplier=False,
            is_customer=False,
        )

        # Create suppliers
        supplier_1 = Company.objects.create(
            name='Digi-Key',
            description='A supplier of components',
            is_manufacturer=False,
            is_supplier=True,
            is_customer=False,
        )

        supplier_2 = Company.objects.create(
            name='Mouser',
            description='We sell components',
            is_manufacturer=False,
            is_supplier=True,
            is_customer=False,
        )

        # Add some SupplierPart objects
        SupplierPart.objects.create(
            part=part,
            supplier=supplier_1,
            SKU='DK-MUR-CAP-123456-ND',
            manufacturer=manufacturer,
            MPN='MUR-CAP-123456',
        )

        SupplierPart.objects.create(
            part=part,
            supplier=supplier_1,
            SKU='DK-MUR-CAP-987654-ND',
            manufacturer=manufacturer,
            MPN='MUR-CAP-987654',
        )

        SupplierPart.objects.create(
            part=part,
            supplier=supplier_2,
            SKU='CAP-CER-01UF',
            manufacturer=manufacturer,
            MPN='MUR-CAP-123456',
        )

        # No MPN
        SupplierPart.objects.create(
            part=part,
            supplier=supplier_2,
            SKU='CAP-CER-01UF-1',
            manufacturer=manufacturer,
        )

        # No Manufacturer
        SupplierPart.objects.create(
            part=part, supplier=supplier_2, SKU='CAP-CER-01UF-2', MPN='MUR-CAP-123456'
        )

        # No Manufacturer data
        SupplierPart.objects.create(
            part=part, supplier=supplier_2, SKU='CAP-CER-01UF-3'
        )

    def test_manufacturer_part_objects(self):
        """Test that the new companies have been created successfully."""
        # Check on the SupplierPart objects
        SupplierPart = self.new_state.apps.get_model('company', 'supplierpart')

        supplier_parts = SupplierPart.objects.all()
        self.assertEqual(supplier_parts.count(), 6)

        supplier_parts = SupplierPart.objects.filter(supplier__name='Mouser')
        self.assertEqual(supplier_parts.count(), 4)

        # Check on the ManufacturerPart objects
        ManufacturerPart = self.new_state.apps.get_model('company', 'manufacturerpart')

        manufacturer_parts = ManufacturerPart.objects.all()
        self.assertEqual(manufacturer_parts.count(), 4)

        manufacturer_part = manufacturer_parts.first()
        self.assertEqual(manufacturer_part.MPN, 'MUR-CAP-123456')


class TestCurrencyMigration(MigratorTestCase):
    """Tests for upgrade from basic currency support to django-money."""

    migrate_from = ('company', '0025_auto_20201110_1001')
    migrate_to = ('company', '0026_auto_20201110_1011')

    def prepare(self):
        """Prepare some data.

        Changes:
        - A part to buy
        - A supplier to buy from
        - A supplier part
        - Multiple currency objects
        - Multiple supplier price breaks
        """
        Part = self.old_state.apps.get_model('part', 'part')

        part = Part.objects.create(
            name='PART',
            description='A purchaseable part',
            purchaseable=True,
            level=0,
            tree_id=0,
            lft=0,
            rght=0,
        )

        Company = self.old_state.apps.get_model('company', 'company')

        supplier = Company.objects.create(
            name='Supplier', description='A supplier', is_supplier=True
        )

        SupplierPart = self.old_state.apps.get_model('company', 'supplierpart')

        sp = SupplierPart.objects.create(part=part, supplier=supplier, SKU='12345')

        Currency = self.old_state.apps.get_model('common', 'currency')

        aud = Currency.objects.create(
            symbol='$', suffix='AUD', description='Australian Dollars', value=1.0
        )
        usd = Currency.objects.create(
            symbol='$', suffix='USD', description='US Dollars', value=1.0
        )

        PB = self.old_state.apps.get_model('company', 'supplierpricebreak')

        PB.objects.create(part=sp, quantity=10, cost=5, currency=aud)
        PB.objects.create(part=sp, quantity=20, cost=3, currency=aud)
        PB.objects.create(part=sp, quantity=30, cost=2, currency=aud)

        PB.objects.create(part=sp, quantity=40, cost=2, currency=usd)
        PB.objects.create(part=sp, quantity=50, cost=2, currency=usd)

        for pb in PB.objects.all():
            self.assertIsNone(pb.price)

    def test_currency_migration(self):
        """Test database state after applying migrations."""
        PB = self.new_state.apps.get_model('company', 'supplierpricebreak')

        for pb in PB.objects.all():
            # Test that a price has been assigned
            self.assertIsNotNone(pb.price)


class TestAddressMigration(MigratorTestCase):
    """Test moving address data into Address model."""

    migrate_from = ('company', '0063_auto_20230502_1956')
    migrate_to = ('company', '0064_move_address_field_to_address_model')

    # Setting up string values for reuse
    short_l1 = 'Less than 50 characters long address'
    long_l1 = 'More than 50 characters long address testing line '
    l2 = 'splitting functionality'

    def prepare(self):
        """Set up some companies with addresses."""
        Company = self.old_state.apps.get_model('company', 'company')

        Company.objects.create(name='Company 1', address=self.short_l1)
        Company.objects.create(name='Company 2', address=self.long_l1 + self.l2)

    def test_address_migration(self):
        """Test database state after applying the migration."""
        Address = self.new_state.apps.get_model('company', 'address')
        Company = self.new_state.apps.get_model('company', 'company')

        c1 = Company.objects.filter(name='Company 1').first()
        c2 = Company.objects.filter(name='Company 2').first()

        self.assertEqual(len(Address.objects.all()), 2)

        a1 = Address.objects.filter(company=c1.pk).first()
        a2 = Address.objects.filter(company=c2.pk).first()

        self.assertEqual(a1.line1, self.short_l1)
        self.assertEqual(a1.line2, '')
        self.assertEqual(a2.line1, self.long_l1)
        self.assertEqual(a2.line2, self.l2)
        self.assertEqual(c1.address, '')
        self.assertEqual(c2.address, '')


class TestSupplierPartQuantity(MigratorTestCase):
    """Test that the supplier part quantity is correctly migrated."""

    migrate_from = ('company', '0058_auto_20230515_0004')
    migrate_to = ('company', unit_test.getNewestMigrationFile('company'))

    def prepare(self):
        """Prepare a number of SupplierPart objects."""
        Part = self.old_state.apps.get_model('part', 'part')
        Company = self.old_state.apps.get_model('company', 'company')
        SupplierPart = self.old_state.apps.get_model('company', 'supplierpart')

        self.part = Part.objects.create(
            name='PART',
            description='A purchaseable part',
            purchaseable=True,
            level=0,
            tree_id=0,
            lft=0,
            rght=0,
        )

        self.supplier = Company.objects.create(
            name='Supplier', description='A supplier', is_supplier=True
        )

        self.supplier_parts = []

        for i in range(10):
            self.supplier_parts.append(
                SupplierPart.objects.create(
                    part=self.part,
                    supplier=self.supplier,
                    SKU=f'SKU-{i}',
                    pack_size=i + 1,
                )
            )

    def test_supplier_part_quantity(self):
        """Test that the supplier part quantity is correctly migrated."""
        SupplierPart = self.new_state.apps.get_model('company', 'supplierpart')

        for i, sp in enumerate(SupplierPart.objects.all()):
            self.assertEqual(sp.pack_quantity, str(i + 1))
            self.assertEqual(sp.pack_quantity_native, i + 1)

            # And the 'pack_size' attribute has been removed
            with self.assertRaises(AttributeError):
                sp.pack_size