test: adds e2e support for tag (#219)

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

Author: amagyar-iohk

.github/workflows/build.yml

@@ -27,7 +27,7 @@ jobs:
 
       - uses: maxim-lobanov/setup-xcode@v1
         with:
-          xcode-version: '26.0.0'
+          xcode-version: '26'
 
 #      - name: Install lcov
 #        run: brew install [email protected] && brew link --overwrite --force [email protected]

E2E/TestFramework/BDD/Feature.swift

@@ -4,15 +4,11 @@ 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 ""
-    }
+    public var currentScenario: Scenario? = nil
+    
+    open var tags: [String] { return [] }
+    open var title: String { fatalError("Set feature title") }
+    open var narrative: String { return "" }
 
     /// our lifecycle starts after xctest is ending
     public override func tearDown() async throws {
@@ -38,18 +34,18 @@ open class Feature: XCTestCase {
     public override class func tearDown() {
         if (TestConfiguration.started) {
             let semaphore = DispatchSemaphore(value: 0)
-            Task.detached {
+            Task.detached(priority: .userInitiated) {
                 try await TestConfiguration.shared().endCurrentFeature()
                 semaphore.signal()
             }
             semaphore.wait()
         }
-        super.tearDown()
+        XCTestCase.tearDown()
     }
 
     func run() async throws {
         let currentTestMethodName = self.name
-        if currentScenario == nil {
+        guard let scenario = currentScenario else {
             let rawMethodName = currentTestMethodName.split(separator: " ").last?.dropLast() ?? "yourTestMethod"
 
             let errorMessage = """
@@ -66,9 +62,10 @@ open class Feature: XCTestCase {
             """
             throw ConfigurationError.missingScenario(errorMessage)
         }
-        if currentScenario!.disabled {
-            throw XCTSkip("Scenario '\(currentScenario!.name)' in test method \(currentTestMethodName) is disabled.")
+        if scenario.disabled {
+            throw XCTSkip("Scenario '\(scenario.name)' in test method \(currentTestMethodName) is disabled.")
         }
+        
         try await TestConfiguration.setUpInstance()
 
         if let parameterizedScenario = currentScenario as? ParameterizedScenario {

E2E/TestFramework/BDD/Scenario.swift

@@ -8,7 +8,8 @@ public class Scenario {
     var disabled: Bool = false
     var feature: Feature?
     var parameters: [String: String]?
-
+    var tags: [String] = []
+    
     private var lastContext: String = ""
 
     public init(_ title: String, parameters: [String: String] = [:]) {
@@ -31,6 +32,11 @@ public class Scenario {
         steps.append(stepInstance)
     }
 
+    public func tags(_ tags: String...) -> Scenario {
+        self.tags.append(contentsOf: tags)
+        return self
+    }
+    
     public func given(_ step: String) -> Scenario {
         lastContext = "Given"
         addStep(step)
@@ -54,7 +60,7 @@ public class Scenario {
         addStep(step)
         return self
     }
-    
+
     public func and(_ step: String) -> Scenario {
         if (lastContext.isEmpty) {
             fatalError("Trying to add an [and] step without previous context.")

E2E/TestFramework/Configuration/TagFilter.swift

@@ -0,0 +1,62 @@
+import Foundation
+
+struct TagFilter {
+    private let expression: String
+
+    /// Initializes the filter with the raw tag expression string from the environment.
+    init(from expression: String?) {
+        self.expression = expression?.trimmingCharacters(in: .whitespacesAndNewlines) ?? ""
+    }
+
+    /// Determines if a scenario with the given tags should be executed based on the expression.
+    func shouldRun(scenarioTags: [String]) -> Bool {
+        // If there's no expression, run everything.
+        if expression.isEmpty {
+            return true
+        }
+        
+        let scenarioTagSet = Set(scenarioTags)
+        
+        // Split by "or" to handle the lowest precedence operator first.
+        // If any of these OR clauses are true, the whole expression is true.
+        let orClauses = expression.components(separatedBy: " or ")
+        
+        for orClause in orClauses {
+            // Check if this "AND" group is satisfied.
+            if evaluateAndClause(clause: orClause, scenarioTags: scenarioTagSet) {
+                return true
+            }
+        }
+        
+        // If none of the OR clauses were satisfied, the expression is false.
+        return false
+    }
+
+    /// Evaluates a sub-expression containing only "and" and "not" conditions.
+    /// This clause is true only if ALL of its conditions are met.
+    private func evaluateAndClause(clause: String, scenarioTags: Set<String>) -> Bool {
+        let andConditions = clause.components(separatedBy: " and ")
+        
+        for condition in andConditions {
+            if !evaluateCondition(condition: condition, scenarioTags: scenarioTags) {
+                return false // If any condition is false, the whole AND clause is false.
+            }
+        }
+        
+        // If all conditions passed, the AND clause is true.
+        return true
+    }
+    
+    /// Evaluates a single tag condition (e.g., "smoke" or "not wip").
+    private func evaluateCondition(condition: String, scenarioTags: Set<String>) -> Bool {
+        let trimmedCondition = condition.trimmingCharacters(in: .whitespacesAndNewlines)
+
+        if trimmedCondition.hasPrefix("not ") {
+            let tag = String(trimmedCondition.dropFirst(4))
+            return !scenarioTags.contains(tag)
+        } else {
+            let tag = trimmedCondition
+            return scenarioTags.contains(tag)
+        }
+    }
+}

E2E/TestFramework/Configuration/TestConfiguration.swift

@@ -100,10 +100,19 @@ open class TestConfiguration: ITestConfiguration {
     }
 
     func runSteps(_ scenario: Scenario) async throws -> ScenarioOutcome {
+        let tagString = TestConfiguration.shared().environment["TAGS"]
+        let tagFilter = TagFilter(from: tagString)
+        let scenarioTags = scenario.feature!.tags + scenario.tags
+        if !tagFilter.shouldRun(scenarioTags: scenarioTags) {
+            scenario.disabled = true
+        }
         if scenario.disabled {
-            return ScenarioOutcome(scenario)
+            let outcome = ScenarioOutcome(scenario)
+            outcome.status = .skipped
+            return outcome
         }
 
+        
         let scenarioOutcome = ScenarioOutcome(scenario)
         scenarioOutcome.start()
 
@@ -222,6 +231,9 @@ open class TestConfiguration: ITestConfiguration {
         currentFeatureOut.scenarioOutcomes.append(scenarioOutcome)
         try await report(.AFTER_SCENARIO, scenarioOutcome)
         try await tearDownActors()
+        if (scenarioOutcome.status == .skipped) {
+            throw XCTSkip()
+        }
     }
 
     public func afterFeature(_ featureOutcome: FeatureOutcome) async throws {
@@ -252,7 +264,7 @@ open class TestConfiguration: ITestConfiguration {
     /// signals the suite has ended
     public func end() {
         let semaphore = DispatchSemaphore(value: 0)
-        Task.detached {
+        Task.detached(priority: .userInitiated) {
             self.suiteOutcome.end()
             try await self.afterFeatures(self.suiteOutcome.featureOutcomes)
             try await self.tearDownInstance()
@@ -335,13 +347,14 @@ open class TestConfiguration: ITestConfiguration {
         instance.suiteOutcome.start()
         self.instance = instance
 
-        do {
-            try await instance.setUp()
-            try await instance.setUpReporters()
-            try await instance.setUpSteps()
-        } catch {
-            throw ConfigurationError.setup(message: error.localizedDescription)
-        }
+        print("Setting up configuration instance")
+        try await instance.setUp()
+        
+        print("Setting up reporters")
+        try await instance.setUpReporters()
+        
+        print("Setting up steps")
+        try await instance.setUpSteps()
 
         /// setup hamcrest to update variable if failed
         HamcrestReportFunction = { message, file, line in

E2E/TestFramework/Errors/ConfigurationError.swift

@@ -1,10 +1,4 @@
 open class ConfigurationError {
-    public final class setup: BaseError {
-        public init(message: String, file: StaticString = #file, line: UInt = #line) {
-            super.init(message: message, error: "Configuration error", file: file, line: line)
-        }
-    }
-    
     public final class missingScenario: Error, CustomStringConvertible {
         public var errorDescription: String
         public var failureReason: String = "Missing scenario"

E2E/TestFramework/Outcome/FeatureOutcome.swift

@@ -67,7 +67,7 @@ public class FeatureOutcome {
         } else {
             // This case should ideally not be reached if the above logic is complete.
             // Could default to .broken if there's an unexpected mix.
-            print("Warning: FeatureOutcome for '\(feature.title())' has an undetermined status mix.")
+//            print("Warning: FeatureOutcome for '\(feature.title())' has an undetermined status mix.")
             self.status = .broken // Default for unexpected mixed states
         }
     }

E2E/TestFramework/Report/AllureReporter.swift

@@ -266,14 +266,14 @@ public class AllureReporter: Reporter {
             testCaseId: calculatedTestCaseId,
             name: scenario.name,
             fullName: scenarioUniqueName,
-            description: scenario.feature?.description(),
+            description: scenario.feature?.narrative,
             labels: [
                 AllureLabel(name: "host", value: ProcessInfo.processInfo.hostName),
                 AllureLabel(name: "thread", value: getCurrentPid()),
                 AllureLabel(name: "package", value: generatePackageName(fromFeatureType: type(of: scenario.feature!))),
                 AllureLabel(name: "language", value: "swift"),
                 AllureLabel(name: "framework", value: "identus-e2e-framework"),
-                AllureLabel(name: "feature", value: scenario.feature!.title()),
+                AllureLabel(name: "feature", value: scenario.feature!.title),
                 //AllureLabel(name: "suite", value: "suite"), // FIXME: property? config?
                 //AllureLabel(name: "epic", value: "suite"), // FIXME: property? config?
                 //AllureLabel(name: "story", value: scenario.name)
@@ -386,7 +386,7 @@ public class AllureReporter: Reporter {
         container.stop = millisecondsSince1970(from: featureOutcome.endTime)
         if (featureOutcome.status == .broken || featureOutcome.status == .failed),
            let featureErr = featureOutcome.error { // From your FeatureOutcome model
-            let fixtureName = "Feature Level Issue: \(featureOutcome.feature.title())"
+            let fixtureName = "Feature Level Issue: \(featureOutcome.feature.title)"
             let problemFixture = AllureFixtureResult(
                 name: fixtureName,
                 status: mapFrameworkStatusToAllureStatus(featureOutcome.status),

E2E/TestFramework/Report/ConsoleReporter.swift

@@ -12,7 +12,7 @@ public class ConsoleReporter: Reporter {
     public func beforeFeature(_ feature: Feature) async throws {
         print()
         print("---")
-        print("Feature:", feature.title())
+        print("Feature:", feature.title)
     }
 
     public func beforeScenario(_ scenario: Scenario) async throws {

E2E/TestFramework/Report/DebugReporter.swift

@@ -7,7 +7,7 @@ public class DebugReporter: Reporter {
     public required init() {}
 
     public func beforeFeature(_ feature: Feature) async throws {
-        if debug { print("Before Feature:", feature.title()) }
+        if debug { print("Before Feature:", feature.title) }
     }
 
     public func beforeScenario(_ scenario: Scenario) async throws {
@@ -35,7 +35,7 @@ public class DebugReporter: Reporter {
     }
 
     public func afterFeature(_ featureOutcome: FeatureOutcome) async throws {
-        print("After Feature", featureOutcome.feature.title())
+        print("After Feature", featureOutcome.feature.title)
     }
 
     public func afterFeatures(_ featuresOutcome: [FeatureOutcome]) async throws {