test: fix + refactor

Signed-off-by: Allain Magyar <[email protected]>

Author: amagyar-iohk

E2E/.gitignore

@@ -0,0 +1,4 @@
+Target
+properties.plist
+.build
+.vscode

E2E/Package.swift

@@ -7,25 +7,38 @@ let package = Package(
     name: "e2e",
     platforms: [.iOS(.v15), .macOS(.v12)],
     products: [
+        .library(
+            name: "TestFramework",
+            targets: ["TestFramework"]),
     ],
     dependencies: [
-        .package(url: "https://github.com/apple/swift-openapi-generator", .upToNextMinor(from: "1.2.1")),
-        .package(url: "https://github.com/apple/swift-openapi-runtime", .upToNextMinor(from: "1.3.2")),
-        .package(url: "https://github.com/apple/swift-openapi-urlsession", .upToNextMinor(from: "1.0.1")),
-        .package(url: "https://github.com/nschum/SwiftHamcrest", .upToNextMajor(from: "2.2.1")),
-        .package(path: "../")
+        .package(url: "https://github.com/apple/swift-openapi-generator", .upToNextMinor(from: "1.7.0")),
+        .package(url: "https://github.com/apple/swift-openapi-runtime", .upToNextMinor(from: "1.8.0")),
+        .package(url: "https://github.com/apple/swift-openapi-urlsession", .upToNextMinor(from: "1.0.2")),
+        .package(url: "https://github.com/nschum/SwiftHamcrest", exact: "2.2.1"),
+        .package(name: "edge-agent", path: "../")
     ],
     targets: [
+        .target(
+            name: "TestFramework",
+            dependencies: [
+                .product(name: "SwiftHamcrest", package: "SwiftHamcrest")
+            ],
+            path: "TestFramework",
+            resources: [
+                .copy("Resources")
+            ]
+        ),
         .testTarget(
-            name: "e2e",
+            name: "e2e-tests",
             dependencies: [
-                .product(name: "EdgeAgent", package: "atala-prism-wallet-sdk-swift"),
-                .product(name: "Domain", package: "atala-prism-wallet-sdk-swift"),
+                .target(name: "TestFramework"),
+                .product(name: "EdgeAgent", package: "edge-agent"),
+                .product(name: "Domain", package: "edge-agent"),
                 .product(name: "OpenAPIRuntime", package: "swift-openapi-runtime"),
                 .product(name: "OpenAPIURLSession", package: "swift-openapi-urlsession"),
-                .product(name: "SwiftHamcrest", package: "SwiftHamcrest")
             ],
-            path: "e2eTests",
+            path: "Tests",
             resources: [
                 .copy("Resources")
             ],

E2E/e2eTests/TestFramework/Assertion/AssertionError.swift renamed to E2E/TestFramework/Assertion/AssertionError.swift

@@ -0,0 +1,64 @@
+import Foundation
+import XCTest
+import SwiftHamcrest
+
+open class Feature: XCTestCase {
+    let id: String = UUID().uuidString
+    open var currentScenario: Scenario? = nil
+    
+    open func title() -> String {
+        fatalError("Set feature title")
+    }
+
+    open func description() -> String {
+        return ""
+    }
+    
+    /// our lifecycle starts after xctest is ending
+    public override func tearDown() async throws {
+        try await run()
+        self.currentScenario = nil
+        try await super.tearDown()
+    }
+
+    public override class func tearDown() {
+        if (TestConfiguration.started) {
+            let semaphore = DispatchSemaphore(value: 0)
+            Task.detached {
+                try await TestConfiguration.shared().endCurrentFeature()
+                semaphore.signal()
+            }
+            semaphore.wait()
+        }
+        super.tearDown()
+    }
+
+    func run() async throws {
+        // check if we have the scenario
+        if (currentScenario == nil) {
+            throw XCTSkip("""
+            To run the feature you have to setup the scenario for each test case.
+            Usage:
+            func testMyScenario() async throws {
+                scenario = Scenario("description")
+                    .given // ...
+            }
+            """)
+        }
+        
+        if (currentScenario!.disabled) {
+            throw XCTSkip("Scenario [\(currentScenario!.title)] is disabled")
+        }
+        
+        try await TestConfiguration.setUpInstance()
+        
+        if (currentScenario! is ParameterizedScenario) {
+            let parameterizedScenario = currentScenario! as! ParameterizedScenario
+            for scenario in parameterizedScenario.build() {
+                try await TestConfiguration.shared().run(self, scenario)
+            }
+        } else {
+            try await TestConfiguration.shared().run(self, currentScenario!)
+        }
+    }
+}

E2E/TestFramework/BDD/Feature.swift

@@ -0,0 +1,36 @@
+import Foundation
+import XCTest
+
+public class ParameterizedScenario: Scenario {
+    public var parameters: [[String: String]] = [[:]]
+
+    public func parameters(_ parameters: [[String: String]]) -> Scenario {
+        self.parameters = parameters
+        return self
+    }
+    
+    public func build() -> [Scenario] {
+        var scenarios: [Scenario] = []
+        
+        parameters.forEach { parameters in
+            let scenario = Scenario(replace(line: self.title, parameters: parameters))
+            scenario.steps = self.steps.map { step in
+                let newStep = ConcreteStep()
+                newStep.context = step.context
+                newStep.action = replace(line: step.action, parameters: parameters)
+                return newStep
+            }
+            scenarios.append(scenario)
+        }
+        
+        return scenarios
+    }
+    
+    private func replace(line: String, parameters: [String: String]) -> String {
+        var line = line
+        for (placeholder, value) in parameters {
+            line = line.replacingOccurrences(of: "<\(placeholder)>", with: value)
+        }
+        return line
+    }
+}

E2E/TestFramework/BDD/ParameterizedScenario.swift

@@ -1,20 +1,21 @@
 import Foundation
 import XCTest
 
-class Scenario {
+public class Scenario {
     let id = UUID().uuidString
     var title: String
     var steps: [ConcreteStep] = []
     var pass: Bool = false
     var error: Error? = nil
+    var disabled: Bool = false
 
     private var lastContext: String = ""
 
-    init(_ title: String) {
+    public init(_ title: String) {
         self.title = title
     }
 
-    func fail(file: StaticString?, line: UInt?, message: String) {
+    public func fail(file: StaticString?, line: UInt?, message: String) {
         if (file != nil) {
             XCTFail(message, file: file!, line: line!)
         } else {
@@ -29,35 +30,40 @@ class Scenario {
         steps.append(stepInstance)
     }
 
-    func given(_ step: String) -> Scenario {
+    public func given(_ step: String) -> Scenario {
         lastContext = "Given"
         addStep(step)
         return self
     }
 
-    func when(_ step: String) -> Scenario {
+    public func when(_ step: String) -> Scenario {
         lastContext = "When"
         addStep(step)
         return self
     }
 
-    func then(_ step: String) -> Scenario {
+    public func then(_ step: String) -> Scenario {
         lastContext = "Then"
         addStep(step)
         return self
     }
 
-    func but(_ step: String) -> Scenario {
+    public func but(_ step: String) -> Scenario {
         lastContext = "But"
         addStep(step)
         return self
     }
 
-    func and(_ step: String) -> Scenario {
+    public func and(_ step: String) -> Scenario {
         if (lastContext.isEmpty) {
             fatalError("Trying to add an [and] step without previous context.")
         }
         addStep(step)
         return self
     }
+    
+    public func disable() -> Scenario {
+        self.disabled = true
+        return self
+    }
 }

E2E/e2eTests/TestFramework/BDD/Scenario.swift renamed to E2E/TestFramework/BDD/Scenario.swift

@@ -2,13 +2,13 @@
 import Foundation
 
 @propertyWrapper
-class Step<T> {
+public class Step<T> {
     let file: StaticString
     let line: UInt
     var definition: String
-    var wrappedValue: (T) async throws -> ()
+    public var wrappedValue: (T) async throws -> ()
 
-    init(wrappedValue: @escaping (T) async throws -> (), _ definition: String, file: StaticString = #file, line: UInt = #line) {
+    public init(wrappedValue: @escaping (T) async throws -> (), _ definition: String, file: StaticString = #file, line: UInt = #line) {
         self.file = file
         self.line = line
         self.wrappedValue = wrappedValue

E2E/e2eTests/TestFramework/BDD/Step.swift renamed to E2E/TestFramework/BDD/Step.swift

@@ -1,6 +1,6 @@
 import Foundation
 
-protocol ITestConfiguration {
+public protocol ITestConfiguration {
     static var shared: () -> ITestConfiguration {get}
     static func createInstance() -> ITestConfiguration
 

E2E/e2eTests/TestFramework/Configuration/ClassLocator.swift renamed to E2E/TestFramework/Configuration/ClassLocator.swift

@@ -1,6 +1,6 @@
 import Foundation
 
-enum Phase {
+public enum Phase {
     case AFTER_FEATURES
     case BEFORE_FEATURE
     case AFTER_FEATURE