Add test barcode scanner setup step

joshheald · joshheald · commit 6f9cd77fbca3 · 2025-07-10T12:23:47.000+01:00
diff --git a/WooCommerce/Classes/POS/Presentation/Barcode Scanner Setup/PointOfSaleBarcodeScannerSetupFlow.swift b/WooCommerce/Classes/POS/Presentation/Barcode Scanner Setup/PointOfSaleBarcodeScannerSetupFlow.swift
@@ -94,6 +94,19 @@ class PointOfSaleBarcodeScannerSetupFlow {
                 PointOfSaleBarcodeScannerSetupStep(content: {
                     PointOfSaleBarcodeScannerPairingView(scanner: scannerType)
                 }),
+                PointOfSaleBarcodeScannerSetupStep(
+                    content: {
+                        PointOfSaleBarcodeScannerTestBarcodeView(
+                            scanTester: PointOfSaleBarcodeScannerSetupScanTester(
+                                onTestPass: { [weak self] in
+                                    self?.nextStep()
+                                },
+                                onTestFailure: {},
+                                barcodeDefinition: .ean13)
+                        )
+                    },
+                    buttonCustomization: PointOfSaleBarcodeScannerBackOnlyButtonCustomization()
+                )
                 // TODO: Add more steps for Star BSH-20B WOOMOB-696
             ]
         case .tbcScanner:
@@ -120,6 +133,27 @@ class PointOfSaleBarcodeScannerSetupFlow {
     }
 }
 
+@available(iOS 17.0, *)
+struct PointOfSaleBarcodeScannerBackOnlyButtonCustomization: PointOfSaleBarcodeScannerButtonCustomization {
+    func customizeButtons(for flow: PointOfSaleBarcodeScannerSetupFlow) -> PointOfSaleFlowButtonConfiguration {
+        return PointOfSaleFlowButtonConfiguration(
+            primaryButton: nil,
+            secondaryButton: PointOfSaleFlowButtonConfiguration.ButtonConfig(
+                title: Localization.backButtonTitle,
+                action: { flow.previousStep() }
+            )
+        )
+    }
+
+    private enum Localization {
+        static let backButtonTitle = NSLocalizedString(
+            "pos.barcodeScannerSetup.back.button.title",
+            value: "Back",
+            comment: "Title for the back button in barcode scanner setup navigation"
+        )
+    }
+}
+
 // MARK: - Private Localization Extension
 @available(iOS 17.0, *)
 private extension PointOfSaleBarcodeScannerSetupFlow {
diff --git a/WooCommerce/Classes/POS/Presentation/Barcode Scanner Setup/PointOfSaleBarcodeScannerSetupModels.swift b/WooCommerce/Classes/POS/Presentation/Barcode Scanner Setup/PointOfSaleBarcodeScannerSetupModels.swift
@@ -67,3 +67,22 @@ struct PointOfSaleBarcodeScannerSetupStep {
         self.buttonCustomization = buttonCustomization
     }
 }
+
+// MARK: - Test Barcodes
+enum PointOfSaleBarcodeScannerTestBarcode {
+    case ean13
+
+    var barcodeAsset: PointOfSaleAssets {
+        switch self {
+        case .ean13:
+            return .testEan13Barcode
+        }
+    }
+
+    var expectedValue: String {
+        switch self {
+        case .ean13:
+            return "1234567890128"
+        }
+    }
+}
diff --git a/WooCommerce/Classes/POS/Presentation/Barcode Scanner Setup/PointOfSaleBarcodeScannerSetupScanTester.swift b/WooCommerce/Classes/POS/Presentation/Barcode Scanner Setup/PointOfSaleBarcodeScannerSetupScanTester.swift
@@ -0,0 +1,26 @@
+import Foundation
+
+struct PointOfSaleBarcodeScannerSetupScanTester {
+    private let onTestPass: () -> Void
+    private let onTestFailure: () -> Void
+    private let barcodeDefinition: PointOfSaleBarcodeScannerTestBarcode
+
+    init(onTestPass: @escaping () -> Void, onTestFailure: @escaping () -> Void, barcodeDefinition: PointOfSaleBarcodeScannerTestBarcode) {
+        self.onTestPass = onTestPass
+        self.onTestFailure = onTestFailure
+        self.barcodeDefinition = barcodeDefinition
+    }
+
+    var barcode: PointOfSaleAssets {
+        barcodeDefinition.barcodeAsset
+    }
+
+    func handleScan(_ scanResult: Result<String, Error>) {
+        switch scanResult {
+        case .success(barcodeDefinition.expectedValue):
+            onTestPass()
+        case .success, .failure:
+            onTestFailure()
+        }
+    }
+}
diff --git a/WooCommerce/Classes/POS/Presentation/Barcode Scanner Setup/PointOfSaleBarcodeScannerSetupStepViews.swift b/WooCommerce/Classes/POS/Presentation/Barcode Scanner Setup/PointOfSaleBarcodeScannerSetupStepViews.swift
@@ -90,6 +90,27 @@ private extension PointOfSaleBarcodeScannerPairingView {
     }
 }
 
+@available(iOS 17.0, *)
+struct PointOfSaleBarcodeScannerTestBarcodeView: View {
+    let scanTester: PointOfSaleBarcodeScannerSetupScanTester
+
+    var body: some View {
+        PointOfSaleBarcodeScannerBarcodeView(title: Localization.title,
+                                             instruction: Localization.instruction,
+                                             barcode: scanTester.barcode)
+        .barcodeScanning { result in
+            scanTester.handleScan(result)
+        }
+    }
+}
+
+@available(iOS 17.0, *)
+private extension PointOfSaleBarcodeScannerTestBarcodeView {
+    enum Localization {
+        static let title = "Test your scanner"
+        static let instruction = "Scan the barcode to test your scanner"
+    }
+}
 
 // MARK: - Button Customizations
 @available(iOS 17.0, *)
diff --git a/WooCommerce/Classes/POS/Presentation/PointOfSaleAssets.swift b/WooCommerce/Classes/POS/Presentation/PointOfSaleAssets.swift
@@ -14,7 +14,9 @@ enum PointOfSaleAssets: CaseIterable {
     case shoppingBags
     case successCheck
     case coupons
+    //TODO: WOOMOB-793 Update the imagesets for these barcodes to vector/dark mode friendly images
     case starBsh20SetupBarcode
+    case testEan13Barcode
 
     var imageName: String {
         switch self {
@@ -46,6 +48,8 @@ enum PointOfSaleAssets: CaseIterable {
             "coupons"
         case .starBsh20SetupBarcode:
             "star-bsh20-setup-barcode"
+        case .testEan13Barcode:
+            "test-ean13-barcode"
         }
     }
 }
diff --git a/WooCommerce/Resources/Images.xcassets/POS/test-ean13-barcode.imageset/Contents.json b/WooCommerce/Resources/Images.xcassets/POS/test-ean13-barcode.imageset/Contents.json
@@ -0,0 +1,12 @@
+{
+  "images" : [
+    {
+      "filename" : "barcode-1-2.png",
+      "idiom" : "universal"
+    }
+  ],
+  "info" : {
+    "author" : "xcode",
+    "version" : 1
+  }
+}
diff --git a/WooCommerce/Resources/Images.xcassets/POS/test-ean13-barcode.imageset/barcode-1-2.png b/WooCommerce/Resources/Images.xcassets/POS/test-ean13-barcode.imageset/barcode-1-2.png
diff --git a/WooCommerce/WooCommerce.xcodeproj/project.pbxproj b/WooCommerce/WooCommerce.xcodeproj/project.pbxproj
@@ -871,6 +871,8 @@
 		207823E32C5D18CE00025A59 /* PointOfSaleCardPresentPaymentConnectionSuccessAlertViewModel.swift in Sources */ = {isa = PBXBuildFile; fileRef = 207823E22C5D18CE00025A59 /* PointOfSaleCardPresentPaymentConnectionSuccessAlertViewModel.swift */; };
 		207823E52C5D1B2F00025A59 /* PointOfSaleCardPresentPaymentConnectionSuccessAlertView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 207823E42C5D1B2F00025A59 /* PointOfSaleCardPresentPaymentConnectionSuccessAlertView.swift */; };
 		207823E92C5D3A1700025A59 /* POSErrorExclamationMark.swift in Sources */ = {isa = PBXBuildFile; fileRef = 207823E82C5D3A1700025A59 /* POSErrorExclamationMark.swift */; };
+		207CEA852E1FD59B0023EC35 /* PointOfSaleBarcodeScannerSetupScanTester.swift in Sources */ = {isa = PBXBuildFile; fileRef = 207CEA842E1FD59B0023EC35 /* PointOfSaleBarcodeScannerSetupScanTester.swift */; };
+		207CEA882E1FD6F80023EC35 /* PointOfSaleBarcodeScannerSetupScanTesterTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 207CEA872E1FD6F80023EC35 /* PointOfSaleBarcodeScannerSetupScanTesterTests.swift */; };
 		207D2D232CFDCCBF00F79204 /* MockPOSOrderableItem.swift in Sources */ = {isa = PBXBuildFile; fileRef = 207D2D222CFDCCBF00F79204 /* MockPOSOrderableItem.swift */; };
 		207E71CB2C60F765008540FC /* MockPOSOrderService.swift in Sources */ = {isa = PBXBuildFile; fileRef = 207E71CA2C60F765008540FC /* MockPOSOrderService.swift */; };
 		2084B7A22C77693600EFBD2E /* CardPresentPaymentsModalButtonViewModelTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2084B7A12C77693600EFBD2E /* CardPresentPaymentsModalButtonViewModelTests.swift */; };
@@ -4043,6 +4045,8 @@
 		207823E22C5D18CE00025A59 /* PointOfSaleCardPresentPaymentConnectionSuccessAlertViewModel.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = PointOfSaleCardPresentPaymentConnectionSuccessAlertViewModel.swift; sourceTree = "<group>"; };
 		207823E42C5D1B2F00025A59 /* PointOfSaleCardPresentPaymentConnectionSuccessAlertView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = PointOfSaleCardPresentPaymentConnectionSuccessAlertView.swift; sourceTree = "<group>"; };
 		207823E82C5D3A1700025A59 /* POSErrorExclamationMark.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = POSErrorExclamationMark.swift; sourceTree = "<group>"; };
+		207CEA842E1FD59B0023EC35 /* PointOfSaleBarcodeScannerSetupScanTester.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = PointOfSaleBarcodeScannerSetupScanTester.swift; sourceTree = "<group>"; };
+		207CEA872E1FD6F80023EC35 /* PointOfSaleBarcodeScannerSetupScanTesterTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = PointOfSaleBarcodeScannerSetupScanTesterTests.swift; sourceTree = "<group>"; };
 		207D2D222CFDCCBF00F79204 /* MockPOSOrderableItem.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; name = MockPOSOrderableItem.swift; path = ../Modules/Tests/YosemiteTests/Mocks/MockPOSOrderableItem.swift; sourceTree = SOURCE_ROOT; };
 		207E71CA2C60F765008540FC /* MockPOSOrderService.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = MockPOSOrderService.swift; sourceTree = "<group>"; };
 		2084B7A12C77693600EFBD2E /* CardPresentPaymentsModalButtonViewModelTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = CardPresentPaymentsModalButtonViewModelTests.swift; sourceTree = "<group>"; };
@@ -7229,6 +7233,7 @@
 		026A502D2D2F8087002C42C2 /* Presentation */ = {
 			isa = PBXGroup;
 			children = (
+				207CEA862E1FD6D80023EC35 /* Barcode Scanner Setup */,
 				20D5575E2DFAE3D500D9EC8B /* Barcode Scanning */,
 				01AB2D132DDC7CD000AA67FD /* POSItemActionHandlerFactoryTests.swift */,
 				01AB2D112DDC7AD100AA67FD /* PointOfSaleItemListAnalyticsTrackerTests.swift */,
@@ -8234,6 +8239,14 @@
 			path = "Reader Messages";
 			sourceTree = "<group>";
 		};
+		207CEA862E1FD6D80023EC35 /* Barcode Scanner Setup */ = {
+			isa = PBXGroup;
+			children = (
+				207CEA872E1FD6F80023EC35 /* PointOfSaleBarcodeScannerSetupScanTesterTests.swift */,
+			);
+			path = "Barcode Scanner Setup";
+			sourceTree = "<group>";
+		};
 		2084B7A02C7768E200EFBD2E /* Connection Alerts */ = {
 			isa = PBXGroup;
 			children = (
@@ -8313,6 +8326,7 @@
 				20C3DB202E1E69CF00CF7D3B /* PointOfSaleBarcodeScannerSetupModels.swift */,
 				20C3DB212E1E69CF00CF7D3B /* PointOfSaleBarcodeScannerSetupViews.swift */,
 				208C0F092E1FAC1900FE619E /* PointOfSaleBarcodeScannerSetupStepViews.swift */,
+				207CEA842E1FD59B0023EC35 /* PointOfSaleBarcodeScannerSetupScanTester.swift */,
 				20C3DB282E1E6FBA00CF7D3B /* PointOfSaleFlowButtonsView.swift */,
 			);
 			path = "Barcode Scanner Setup";
@@ -15457,6 +15471,7 @@
 				CE22E3F72170E23C005A6BEF /* PrivacySettingsViewController.swift in Sources */,
 				02222BD02D5AFE4F00FB97D2 /* POSButtonProgressViewStyle.swift in Sources */,
 				021125482577CC650075AD2A /* ShippingLabelDetailsViewModel.swift in Sources */,
+				207CEA852E1FD59B0023EC35 /* PointOfSaleBarcodeScannerSetupScanTester.swift in Sources */,
 				2004E2D82C08E56300D62521 /* CardPresentPaymentOnboardingPresentationEvent.swift in Sources */,
 				68D1BEDD2900E4180074A29E /* CustomerSearchUICommand.swift in Sources */,
 				316837DA25CCA90C00E36B2F /* OrderStatusListDataSource.swift in Sources */,
@@ -17598,6 +17613,7 @@
 				B9CB14E02A42E246005912C2 /* BarcodeScannerErrorNoticeFactoryTests.swift in Sources */,
 				6856D49DB7DCF4D87745C0B1 /* MockPushNotificationsManager.swift in Sources */,
 				4569D3C925DC065B00CDC3E2 /* SiteAddressTests.swift in Sources */,
+				207CEA882E1FD6F80023EC35 /* PointOfSaleBarcodeScannerSetupScanTesterTests.swift in Sources */,
 				EE289AFE2C9D9CF0004AB1A6 /* ProductCreationAIEligibilityCheckerTests.swift in Sources */,
 				CC4D1E7925EE415D00B6E4E7 /* RenameAttributesViewModelTests.swift in Sources */,
 				458BAC702C57E38F009440EA /* ProductPasswordEligibilityUseCaseTests.swift in Sources */,
diff --git a/WooCommerce/WooCommerceTests/POS/Presentation/Barcode Scanner Setup/PointOfSaleBarcodeScannerSetupScanTesterTests.swift b/WooCommerce/WooCommerceTests/POS/Presentation/Barcode Scanner Setup/PointOfSaleBarcodeScannerSetupScanTesterTests.swift
@@ -0,0 +1,80 @@
+import Testing
+@testable import WooCommerce
+
+struct PointOfSaleBarcodeScannerSetupScanTesterTests {
+
+    @Test func test_scanTester_calls_onTestPass_when_scan_received_for_expected_barcode() {
+        // Given a test EAN13 barcode
+        let expectedBarcode = PointOfSaleBarcodeScannerTestBarcode.ean13
+        var onTestPassCalled = false
+        var onTestFailureCalled = false
+
+        let sut = PointOfSaleBarcodeScannerSetupScanTester(
+            onTestPass: { onTestPassCalled = true },
+            onTestFailure: { onTestFailureCalled = true },
+            barcodeDefinition: expectedBarcode)
+
+        // When the barcode is scanned
+        sut.handleScan(.success(expectedBarcode.expectedValue))
+
+        // Then it calls the pass closure
+        #expect(onTestPassCalled == true)
+        #expect(onTestFailureCalled == false)
+    }
+
+    @Test func test_scanTester_calls_onTestFailure_when_scan_received_for_unexpected_barcode() {
+        // Given a test EAN13 barcode
+        let expectedBarcode = PointOfSaleBarcodeScannerTestBarcode.ean13
+        var onTestPassCalled = false
+        var onTestFailureCalled = false
+
+        let sut = PointOfSaleBarcodeScannerSetupScanTester(
+            onTestPass: { onTestPassCalled = true },
+            onTestFailure: { onTestFailureCalled = true },
+            barcodeDefinition: expectedBarcode)
+
+        // When an unexpected barcode is scanned
+        sut.handleScan(.success("9999999999999"))
+
+        // Then it calls the failure closure
+        #expect(onTestPassCalled == false)
+        #expect(onTestFailureCalled == true)
+    }
+
+        @Test func test_scanTester_calls_onTestFailure_when_scan_fails() {
+        // Given a test EAN13 barcode
+        let expectedBarcode = PointOfSaleBarcodeScannerTestBarcode.ean13
+        var onTestPassCalled = false
+        var onTestFailureCalled = false
+
+        let sut = PointOfSaleBarcodeScannerSetupScanTester(
+            onTestPass: { onTestPassCalled = true },
+            onTestFailure: { onTestFailureCalled = true },
+            barcodeDefinition: expectedBarcode)
+
+        // When the scan fails
+        sut.handleScan(.failure(TestError.scanFailed))
+
+        // Then it calls the failure closure
+        #expect(onTestPassCalled == false)
+        #expect(onTestFailureCalled == true)
+    }
+
+    private enum TestError: Error {
+        case scanFailed
+    }
+
+    @Test func test_scanTester_provides_correct_barcode_asset() {
+        // Given a test EAN13 barcode
+        let expectedBarcode = PointOfSaleBarcodeScannerTestBarcode.ean13
+
+        let sut = PointOfSaleBarcodeScannerSetupScanTester(
+            onTestPass: {},
+            onTestFailure: {},
+            barcodeDefinition: expectedBarcode)
+
+        // Then it provides the correct barcode asset
+        #expect(sut.barcode == .testEan13Barcode)
+    }
+
+}

Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,9 @@ enum PointOfSaleAssets: CaseIterable {`
`14`	`14`	`case shoppingBags`
`15`	`15`	`case successCheck`
`16`	`16`	`case coupons`
	`17`	`+ //TODO: WOOMOB-793 Update the imagesets for these barcodes to vector/dark mode friendly images`
`17`	`18`	`case starBsh20SetupBarcode`
	`19`	`+ case testEan13Barcode`
`18`	`20`
`19`	`21`	`var imageName: String {`
`20`	`22`	`switch self {`
`@@ -46,6 +48,8 @@ enum PointOfSaleAssets: CaseIterable {`
`46`	`48`	`"coupons"`
`47`	`49`	`case .starBsh20SetupBarcode:`
`48`	`50`	`"star-bsh20-setup-barcode"`
	`51`	`+ case .testEan13Barcode:`
	`52`	`+ "test-ean13-barcode"`
`49`	`53`	`}`
`50`	`54`	`}`
`51`	`55`	`}`