feat(POM-222): add integration tests infra (#129)

Add infrastructure for integration tests as well as cards service tests

.github/actions/bootstrap-project/action.yml

@@ -1,8 +1,8 @@
 name: Bootstrap Project
 description: Pulls needed dependencies and bootstraps project
 inputs:
-  example-constants:
-    description: 'Content of example project constants file'
+  test-project-constants:
+    description: 'Content of test project constants file'
     type: string
     required: false
 runs:
@@ -12,23 +12,23 @@ runs:
       with:
         ruby-version: '3.1.2'
         bundler-cache: true
-    - name: Install Mint
-      run: brew update && brew install mint
-      shell: bash
     - name: Cache Mint Packages
       uses: actions/cache@v3
       with:
         path: ~/.mint/packages
         key: ${{ runner.os }}-mint-${{ hashFiles('**/Mintfile') }}
         restore-keys: |
           ${{ runner.os }}-mint-
+    - name: Write Constants
+      run: |
+        CONSTANTS=$'${{ inputs.test-project-constants }}'
+        echo "$CONSTANTS" > Tests/ProcessOutTests/Resources/Constants.yml
+        echo "$CONSTANTS" > Example/Example/Resources/Constants.yml
+      shell: bash
     - name: Bootstrap Project
       run: ./Scripts/BootstrapProject.sh --skip-bundle-instal
       shell: bash
-    - name: Bootstrap Example Project
-      if: ${{ inputs.example-constants != '' }}
-      run: |
-        cd Example
-        echo "${{ inputs.example-constants }}" > Example/Resources/Constants.yml
-        source Scripts/BootstrapProject.sh --skip-mint-bootstrap
-      shell: bash
+    # - name: Bootstrap Example Project
+    #   if: ${{ inputs.test-project-constants != '' }}
+    #   run: cd Example && ./Scripts/BootstrapProject.sh --skip-mint-bootstrap
+    #   shell: bash

.github/workflows/test.yml

@@ -14,6 +14,6 @@ jobs:
       - name: Bootstrap Project
         uses: ./.github/actions/bootstrap-project
         with:
-          example-constants: ${{ secrets.EXAMPLE_PROJECT_CONSTANTS }}
+          test-project-constants: ${{ secrets.TEST_PROJECT_CONSTANTS }}
       - name: Run Unit Tests
         run: source Scripts/Test.sh

.gitignore

@@ -1,11 +1,4 @@
-### fastlane ###
-fastlane/report.xml
-fastlane/Preview.html
-fastlane/screenshots/**/*.png
-fastlane/screenshots/screenshots.html
-fastlane/test_output
-
-### macOS ###
+## macOS
 .DS_Store
 .AppleDouble
 .LSOverride
@@ -16,3 +9,8 @@ fastlane/test_output
 Packages
 *.xcodeproj
 xcuserdata/
+Tests/ProcessOutTests/Sources/Generated/*.swift
+Tests/ProcessOutTests/Resources/Constants.yml
+
+## Brew
+Brewfile.lock.json

.swiftlint.yml

@@ -5,6 +5,7 @@ included:
 excluded:
   - Sources/ProcessOut/Sources/Legacy
   - Sources/ProcessOut/Sources/Generated
+  - Tests/ProcessOutTests/Sources/Generated
 
 function_parameter_count:
   warning: 5

Brewfile

@@ -0,0 +1 @@
+brew "mint"

Example/Brewfile

@@ -0,0 +1 @@
+../Brewfile

Example/README.md

@@ -6,7 +6,7 @@ Project demonstrates multiple flows that ProcessOut framework is capable of.
 
 - A recent version of macOS (tested with 13.3.1)
 - A recent version of Xcode (tested with 14.3.1)
-- [Mint](https://github.com/yonaskolb/Mint) package manager
+- [Homebrew](https://https://brew.sh/) package manager
 
 ### Installation
 

Example/Scripts/BootstrapProject.sh

@@ -2,6 +2,9 @@
 
 set -e
 
+# Installs brew dependencies
+brew bundle
+
 # Installs mint dependencies if needed
 if ! [[ "$@" =~ '--skip-mint-bootstrap' ]]; then
     mint bootstrap

Package.swift

@@ -17,9 +17,7 @@ let package = Package(
             dependencies: [
                 .target(name: "cmark")
             ],
-            // Having DocC in sources may cause build failures so excluded until issue is resolved by Apple. See
-            // https://forums.swift.org/t/xcode-and-swift-package-manager/44704 for details.
-            exclude: ["ProcessOut.docc"],
+            exclude: ["ProcessOut.docc", "swiftgen.yml"],
             resources: [
                 .process("Resources")
             ]

README.md

@@ -21,13 +21,24 @@ We welcome contributions of any kind including new features, bug fixes, and gene
 
 - A recent version of macOS (tested with 13.3.1)
 - A recent version of Xcode (tested with 14.3.1)
-- [Mint](https://github.com/yonaskolb/Mint) package manager
+- [Homebrew](https://https://brew.sh/) package manager
 - [Ruby](https://www.ruby-lang.org) (tested with 3.1.2) with [bundler](https://bundler.io) installed
 
 ### Installation
 
 Before going further please make sure that you have installed all dependencies specified in [requirements](#development-requirements) section. Then in order to install remaining dependencies and prepare a project run `./Scripts/BootstrapProject.sh` script from repository's root directory. It will create `ProcessOut.xcodeproj` project that should be used for development.
 
+> **Note**
+> 
+> If you plan to run tests ensure that `Tests/ProcessOutTests/Resources/Constants.yml` file with test project credentials exists before generating project. E.g.
+>
+> ```yml
+> projectId: test-proj_K3Ur9LQzcKtm4zttWJ7oAKHgqdiwboAw
+> projectPrivateKey: key_test_RE14RLcNikkP5ZXMn84BFYApwotD05Kc
+> apiBaseUrl: https://api.processout.com
+> checkoutBaseUrl: https://checkout.processout.com
+> ```
+
 ### Running tests
 
 To run tests locally use `./Scripts/Test.sh` script. It is also possible to run them directly in Xcode from the ProcessOut target in `ProcessOut.xcodeproj`.

Scripts/BootstrapProject.sh

@@ -5,6 +5,9 @@ set -e
 # Exports version as environment variable
 export CURRENT_VERSION="$(cat Version.resolved)"
 
+# Installs brew dependencies
+brew bundle
+
 # Installs mint dependencies
 mint bootstrap
 

Scripts/SwiftGen.sh

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+mint run swiftgen config run --config "${TARGET_ROOT}/swiftgen.yml"

Scripts/Test.sh

@@ -1,9 +1,9 @@
 #!/bin/bash
 
-set -e
+set -euo pipefail
 
 SDK='iphonesimulator'
-DESTINATION='platform=iOS Simulator,name=iPhone 14 Pro,OS=16.2'
+DESTINATION='platform=iOS Simulator,name=iPhone 14 Pro,OS=latest'
 
 xcodebuild clean test \
     -project ProcessOut.xcodeproj \

swiftgen.yml → Sources/ProcessOut/swiftgen.yml

@@ -1,6 +1,5 @@
-##   Every input/output paths in the rest of the config will then be expressed relative to these.
-input_dir: ${PROJECT_DIR}/Sources/${TARGET_NAME}/Resources/
-output_dir: ${PROJECT_DIR}/Sources/${TARGET_NAME}/Sources/Generated/
+input_dir: ${TARGET_ROOT}/Resources/
+output_dir: ${TARGET_ROOT}/Sources/Generated/
 
 ## Constants for Assets Catalogs.
 xcassets:
@@ -14,7 +13,7 @@ xcassets:
         forceProvidesNamespaces: true
         bundle: BundleLocator.bundle
       output: Assets+Generated.swift
-      
+
 ## Constants for Localized Strings.
 strings:
   inputs:

Tests/ProcessOutTests/Sources/Integration/CardsServiceTests.swift

@@ -0,0 +1,66 @@
+//
+//  CardsServiceTests.swift
+//  ProcessOutTests
+//
+//  Created by Andrii Vysotskyi on 27.06.2023.
+//
+
+import Foundation
+import XCTest
+@_spi(PO) import ProcessOut
+
+final class CardsServiceTests: XCTestCase {
+
+    override func setUp() {
+        super.setUp()
+        let configuration = ProcessOutConfiguration.test(
+            projectId: Constants.projectId,
+            privateKey: Constants.projectPrivateKey,
+            apiBaseUrl: URL(string: Constants.apiBaseUrl)!,
+            checkoutBaseUrl: URL(string: Constants.checkoutBaseUrl)!
+        )
+        ProcessOut.configure(configuration: configuration)
+        sut = ProcessOut.shared.cards
+    }
+
+    func test_issuerInformation() async throws {
+        // When
+        let information = try await sut.issuerInformation(iin: "400012")
+
+        // Then
+        XCTAssertEqual(information.bankName, "UNITED CITIZENS BANK OF SOUTHERN KENTUCKY")
+        XCTAssertEqual(information.brand, "visa business")
+        XCTAssertEqual(information.category, "business")
+        XCTAssertEqual(information.scheme, "visa")
+        XCTAssertEqual(information.type, "debit")
+    }
+
+    func test_issuerInformation_whenIinIsTooShort_throws() async {
+        do {
+            // When
+            _ = try await sut.issuerInformation(iin: "4")
+        } catch {
+            return
+        }
+
+        // Then
+        XCTFail("IIN with length less than 6 symbols should be invalid")
+    }
+
+    func test_tokenizeRequest_returnsCard() async throws {
+        // Given
+        let request = POCardTokenizationRequest(number: "4242424242424242", expMonth: 12, expYear: 40, cvc: "737")
+
+        // When
+        let card = try await sut.tokenize(request: request)
+
+        // Then
+        XCTAssertEqual(card.last4Digits, "4242")
+        XCTAssertEqual(card.expMonth, 12)
+        XCTAssertEqual(card.expYear, 2040)
+    }
+
+    // MARK: - Tests
+
+    private var sut: POCardsService!
+}

Tests/ProcessOutTests/swiftgen.yml

@@ -0,0 +1,12 @@
+input_dir: ${TARGET_ROOT}/Resources/
+output_dir: ${TARGET_ROOT}/Sources/Generated/
+
+## Application Constants
+yaml:
+  inputs:
+    - Constants.yml
+  outputs:
+    - templateName: inline-swift5
+      params:
+        enumName: Constants
+      output: Constants+Generated.swift

project.yml

@@ -22,29 +22,41 @@ targets:
       SKIP_INSTALL: NO
       BUILD_LIBRARY_FOR_DISTRIBUTION: YES
       OTHER_SWIFT_FLAGS: "-Xfrontend -module-interface-preserve-types-as-written"
+      TARGET_ROOT: $(PROJECT_DIR)/Sources/ProcessOut
     preBuildScripts:
       - path: Scripts/Lint.sh
         name: Swiftlint
         basedOnDependencyAnalysis: false
-      - path: Scripts/SwiftGen/SwiftGen.sh
+      - path: Scripts/SwiftGen.sh
         name: SwiftGen
-        inputFileLists:
-          - $(PROJECT_DIR)/Scripts/SwiftGen/Input.xcfilelist
-        outputFileLists:
-          - $(PROJECT_DIR)/Scripts/SwiftGen/Output.xcfilelist
+        basedOnDependencyAnalysis: false
       - path: Scripts/Sourcery.sh
         name: Sourcery
         basedOnDependencyAnalysis: false
-    sources: Sources/ProcessOut
+    sources:
+      - path: Sources/ProcessOut
+        excludes:
+          - swiftgen.yml
     dependencies:
       - framework: Vendor/cmark.xcframework
   ProcessOutTests:
     type: bundle.unit-test
     platform: iOS
     deploymentTarget: "16.0"
+    settings:
+      TARGET_ROOT: $(PROJECT_DIR)/Tests/ProcessOutTests
+    preBuildScripts:
+      - path: Scripts/SwiftGen.sh
+        name: SwiftGen
+        outputFiles:
+          - $(TARGET_ROOT)/Sources/Generated/Constants+Generated.swift
+        basedOnDependencyAnalysis: false
     dependencies:
       - target: ProcessOut
-    sources: Tests/ProcessOutTests
+    sources:
+      - path: Tests/ProcessOutTests
+      - path: Tests/ProcessOutTests/Sources/Generated/Constants+Generated.swift
+        optional: true
   ProcessOutCheckout3DS:
     type: framework
     platform: iOS
@@ -53,6 +65,7 @@ targets:
       PRODUCT_BUNDLE_IDENTIFIER: com.processout.checkout-3ds-ios
       SKIP_INSTALL: NO
       BUILD_LIBRARY_FOR_DISTRIBUTION: YES
+      TARGET_ROOT: $(PROJECT_DIR)/Sources/ProcessOutCheckout3DS
     preBuildScripts:
       - path: Scripts/Lint.sh
         name: Swiftlint