inventree-app/test/barcode_test.dart

/*
 * Unit testing for barcode scanning functionality.
 *
 * As the unit testing framework cannot really "scan" barcode data,
 * we will mock the scanned data by passing raw "barcode" data to the scanning framework.
 */

import "package:flutter_test/flutter_test.dart";

import "package:inventree/api.dart";
import "package:inventree/helpers.dart";

import "package:inventree/barcode/barcode.dart";
import "package:inventree/barcode/stock.dart";

import "package:inventree/inventree/part.dart";
import "package:inventree/inventree/stock.dart";

import "setup.dart";


void main() {
  setupTestEnv();

  // Connect to the server
  setUpAll(() async {
    await connectToTestServer();
  });

  setUp(() async {
    // Clear the debug log
    clearDebugMessage();
  });

  group("Test BarcodeScanHandler:", () {
    // Tests for scanning a "generic" barcode

    var handler = BarcodeScanHandler();

    test("Empty Barcode", () async {
      // Handle an 'empty' barcode
      await handler.processBarcode("");

      debugContains("Scanned barcode data: ''");
      debugContains("showSnackIcon: 'Barcode scan error'");

      assert(debugMessageCount() == 2);
    });

    test("Junk Data", () async {
      // test scanning 'junk' data

      await handler.processBarcode("abcdefg");

      debugContains("Scanned barcode data: 'abcdefg'");
      debugContains("showSnackIcon: 'No match for barcode'");
    });

    test("Invalid StockLocation", () async {
      // Scan an invalid stock location
      await handler.processBarcode('{"stocklocation": 999999}');

      debugContains("Scanned barcode data: '{\"stocklocation\": 999999}'");
      debugContains("showSnackIcon: 'No match for barcode'");
      assert(debugMessageCount() == 3);
    });

  });

  group("Test StockItemScanIntoLocationHandler:", () {
    // Tests for scanning a stock item into a location

    test("Scan Into Location", () async {

      final item = await InvenTreeStockItem().get(1) as InvenTreeStockItem?;
      assert(item != null);

      assert(item!.pk == 1);

      var handler = StockItemScanIntoLocationHandler(item!);

      await handler.processBarcode('{"stocklocation": 7}');
      // Check the location has been updated
      await item.reload();
      assert(item.locationId == 7);

      debugContains("Scanned stock location 7");

      // Scan into a new location
      await handler.processBarcode('{"stocklocation": 1}');
      await item.reload();
      assert(item.locationId == 1);

    });
  });

  group("Test StockLocationScanInItemsHandler:", () {
    // Tests for scanning items into a stock location

    test("Scan In Items", () async {
      final location = await InvenTreeStockLocation().get(1) as InvenTreeStockLocation?;

      assert(location != null);
      assert(location!.pk == 1);

      var handler = StockLocationScanInItemsHandler(location!);

      // Scan multiple items into this location
      for (int id in [1, 2, 11]) {
        await handler.processBarcode('{"stockitem": ${id}}');

        var item = await InvenTreeStockItem().get(id) as InvenTreeStockItem?;

        assert(item != null);
        assert(item!.pk == id);
        assert(item!.locationId == 1);
      }

    });
  });

  group("Test ScanParentLocationHandler:", () {
    // Tests for scanning a location into a parent location

    test("Scan Parent", () async {
      final location = await InvenTreeStockLocation().get(7) as InvenTreeStockLocation?;

      assert(location != null);
      assert(location!.pk == 7);
      assert(location!.parentId == 4);

      var handler = ScanParentLocationHandler(location!);

      // Scan into new parent location
      await handler.processBarcode('{"stocklocation": 1}');
      await location.reload();
      assert(location.parentId == 1);

      // Scan back into old parent location
      await handler.processBarcode('{"stocklocation": 4}');
      await location.reload();
      assert(location.parentId == 4);

      debugContains("showSnackIcon: 'Scanned into location'");
    });
  });

  group("Test PartBarcodes:", () {

    // Assign a custom barcode to a Part instance
    test("Assign Barcode", () async {

      // Unlink barcode first
      await InvenTreeAPI().unlinkBarcode({
        "part": "2"
      });

      final part = await InvenTreePart().get(2) as InvenTreePart?;

      assert(part != null);
      assert(part!.pk == 2);

      // Should have a "null" barcode
      assert(part!.customBarcode.isEmpty);

      // Assign custom barcode data to the part
      await InvenTreeAPI().linkBarcode({
        "part": "2",
        "barcode": "xyz-123"
      });

      await part!.reload();
      assert(part.customBarcode.isNotEmpty);

      // Check we can de-register a barcode also
      // Unlink barcode first
      await InvenTreeAPI().unlinkBarcode({
        "part": "2"
      });

      await part.reload();
      assert(part.customBarcode.isEmpty);
    });
  });
}