Reduce the overall warnings from tests (#274)

phausler · web-flow · commit 156bb4bf4957 · 2023-06-23T12:22:23.000-07:00
* Migrate from semaphore style testing waits to async test fulfillment

* Reduce warnings for missing hashable and comparable conformances per availability

* Reduce warnings for executor (still one known warning)
diff --git a/Sources/AsyncSequenceValidation/Clock.swift b/Sources/AsyncSequenceValidation/Clock.swift
@@ -132,3 +132,7 @@ extension AsyncSequenceValidationDiagram.Clock: TestClock { }
 
 @available(macOS 13.0, iOS 16.0, watchOS 9.0, tvOS 16.0, *)
 extension AsyncSequenceValidationDiagram.Clock: Clock { }
+
+// placeholders to avoid warnings
+extension AsyncSequenceValidationDiagram.Clock.Instant: Hashable { }
+extension AsyncSequenceValidationDiagram.Clock.Instant: Comparable { }
diff --git a/Sources/AsyncSequenceValidation/Test.swift b/Sources/AsyncSequenceValidation/Test.swift
@@ -68,6 +68,12 @@ extension AsyncSequenceValidationDiagram {
   
   struct Context {
     final class ClockExecutor: SerialExecutor {
+      @available(macOS 14.0, iOS 17.0, watchOS 10.0, tvOS 17.0, *)
+      func enqueue(_ job: __owned ExecutorJob) {
+        job.runSynchronously(on: asUnownedSerialExecutor())
+      }
+      
+      @available(*, deprecated) // known deprecation warning
       func enqueue(_ job: UnownedJob) {
         job._runSynchronously(on: asUnownedSerialExecutor())
       }
diff --git a/Tests/AsyncAlgorithmsTests/TestAdjacentPairs.swift b/Tests/AsyncAlgorithmsTests/TestAdjacentPairs.swift
@@ -88,10 +88,11 @@ final class TestAdjacentPairs: XCTestCase {
     }
     
     // ensure the other task actually starts
-    wait(for: [iterated], timeout: 1.0)
+    
+    await fulfillment(of: [iterated], timeout: 1.0)
     // cancellation should ensure the loop finishes
     // without regards to the remaining underlying sequence
     task.cancel()
-    wait(for: [finished], timeout: 1.0)
+    await fulfillment(of: [finished], timeout: 1.0)
   }
 }
diff --git a/Tests/AsyncAlgorithmsTests/TestBuffer.swift b/Tests/AsyncAlgorithmsTests/TestBuffer.swift
@@ -190,13 +190,13 @@ final class TestBuffer: XCTestCase {
       finished.fulfill()
     }
     // ensure the task actually starts
-    wait(for: [iterated], timeout: 1.0)
+    await fulfillment(of: [iterated], timeout: 1.0)
 
     // When
     task.cancel()
 
     // Then
-    wait(for: [finished], timeout: 1.0)
+    await fulfillment(of: [finished], timeout: 1.0)
   }
 
   func test_given_a_base_sequence_when_buffering_with_bounded_then_the_buffer_is_filled_in_and_suspends() async {
@@ -310,13 +310,13 @@ final class TestBuffer: XCTestCase {
       finished.fulfill()
     }
     // ensure the other task actually starts
-    wait(for: [iterated], timeout: 1.0)
+    await fulfillment(of: [iterated], timeout: 1.0)
 
     // When
     task.cancel()
 
     // Then
-    wait(for: [finished], timeout: 1.0)
+    await fulfillment(of: [finished], timeout: 1.0)
   }
 
   func test_given_a_base_sequence_when_bounded_with_limit_0_then_the_policy_is_transparent() async {
diff --git a/Tests/AsyncAlgorithmsTests/TestBufferedByteIterator.swift b/Tests/AsyncAlgorithmsTests/TestBufferedByteIterator.swift
@@ -199,10 +199,10 @@ final class TestBufferedByteIterator: XCTestCase {
         }
       }
     }
-    wait(for: [iterated], timeout: 1.0)
+    await fulfillment(of: [iterated], timeout: 1.0)
     // cancellation should ensure the loop finishes
     // without regards to the remaining underlying sequence
     task.cancel()
-    wait(for: [finished], timeout: 1.0)
+    await fulfillment(of: [finished], timeout: 1.0)
   }
 }
diff --git a/Tests/AsyncAlgorithmsTests/TestChain.swift b/Tests/AsyncAlgorithmsTests/TestChain.swift
@@ -87,13 +87,13 @@ final class TestChain2: XCTestCase {
     }
 
     // ensure the other task actually starts
-    wait(for: [iterated], timeout: 1.0)
+    await fulfillment(of: [iterated], timeout: 1.0)
 
     // cancellation should ensure the loop finishes
     // without regards to the remaining underlying sequence
     task.cancel()
 
-    wait(for: [finished], timeout: 1.0)
+    await fulfillment(of: [finished], timeout: 1.0)
   }
 }
 
@@ -192,12 +192,12 @@ final class TestChain3: XCTestCase {
     }
 
     // ensure the other task actually starts
-    wait(for: [iterated], timeout: 1.0)
+    await fulfillment(of: [iterated], timeout: 1.0)
 
     // cancellation should ensure the loop finishes
     // without regards to the remaining underlying sequence
     task.cancel()
 
-    wait(for: [finished], timeout: 1.0)
+    await fulfillment(of: [finished], timeout: 1.0)
   }
 }
diff --git a/Tests/AsyncAlgorithmsTests/TestChannel.swift b/Tests/AsyncAlgorithmsTests/TestChannel.swift
@@ -133,7 +133,7 @@ final class TestChannel: XCTestCase {
     task1.cancel()
 
     // Then: the first sending operation is resumed
-    wait(for: [send1IsResumed], timeout: 1.0)
+    await fulfillment(of: [send1IsResumed], timeout: 1.0)
 
     // When: collecting elements
     var iterator = sut.makeAsyncIterator()
diff --git a/Tests/AsyncAlgorithmsTests/TestCombineLatest.swift b/Tests/AsyncAlgorithmsTests/TestCombineLatest.swift
@@ -84,7 +84,7 @@ final class TestCombineLatest2: XCTestCase {
     value = await validator.validate()
     XCTAssertEqual(value, [(1, "a"), (2, "a"), (2, "b"), (3, "b"), (3, "c")])
     
-    wait(for: [finished], timeout: 1.0)
+    await fulfillment(of: [finished], timeout: 1.0)
     value = validator.current
     XCTAssertEqual(value, [(1, "a"), (2, "a"), (2, "b"), (3, "b"), (3, "c")])
   }
@@ -126,7 +126,7 @@ final class TestCombineLatest2: XCTestCase {
     value = await validator.validate()
     XCTAssertEqual(value, [(1, "a"), (1, "b"), (2, "b"), (2, "c"), (3, "c")])
     
-    wait(for: [finished], timeout: 1.0)
+    await fulfillment(of: [finished], timeout: 1.0)
     value = validator.current
     XCTAssertEqual(value, [(1, "a"), (1, "b"), (2, "b"), (2, "c"), (3, "c")])
   }
@@ -168,7 +168,7 @@ final class TestCombineLatest2: XCTestCase {
     value = await validator.validate()
     XCTAssertEqual(value, [(1, "a"), (2, "a"), (3, "a"), (3, "b"), (3, "c")])
     
-    wait(for: [finished], timeout: 1.0)
+    await fulfillment(of: [finished], timeout: 1.0)
     value = validator.current
     XCTAssertEqual(value, [(1, "a"), (2, "a"), (3, "a"), (3, "b"), (3, "c")])
   }
@@ -210,7 +210,7 @@ final class TestCombineLatest2: XCTestCase {
     value = await validator.validate()
     XCTAssertEqual(value, [(1, "a"), (1, "b"), (1, "c"), (2, "c"), (3, "c")])
     
-    wait(for: [finished], timeout: 1.0)
+    await fulfillment(of: [finished], timeout: 1.0)
     value = validator.current
     XCTAssertEqual(value, [(1, "a"), (1, "b"), (1, "c"), (2, "c"), (3, "c")])
   }
@@ -250,7 +250,7 @@ final class TestCombineLatest2: XCTestCase {
     
     XCTAssertEqual(validator.failure as? Failure, Failure())
     
-    wait(for: [finished], timeout: 1.0)
+    await fulfillment(of: [finished], timeout: 1.0)
     value = validator.current
     XCTAssertEqual(value, [(1, "a"), (1, "b")])
   }
@@ -290,7 +290,7 @@ final class TestCombineLatest2: XCTestCase {
     
     XCTAssertEqual(validator.failure as? Failure, Failure())
     
-    wait(for: [finished], timeout: 1.0)
+    await fulfillment(of: [finished], timeout: 1.0)
     value = validator.current
     XCTAssertEqual(value, [(1, "a"), (2, "a")])
   }
@@ -312,11 +312,11 @@ final class TestCombineLatest2: XCTestCase {
       finished.fulfill()
     }
     // ensure the other task actually starts
-    wait(for: [iterated], timeout: 1.0)
+    await fulfillment(of: [iterated], timeout: 1.0)
     // cancellation should ensure the loop finishes
     // without regards to the remaining underlying sequence
     task.cancel()
-    wait(for: [finished], timeout: 1.0)
+    await fulfillment(of: [finished], timeout: 1.0)
   }
 
     func test_combineLatest_when_cancelled() async {
@@ -389,7 +389,7 @@ final class TestCombineLatest3: XCTestCase {
     value = await validator.validate()
     XCTAssertEqual(value, [(1, "a", 4), (2, "a", 4), (2, "b", 4), (2, "b", 5), (3, "b", 5), (3, "c", 5), (3, "c", 6)])
 
-    wait(for: [finished], timeout: 1.0)
+    await fulfillment(of: [finished], timeout: 1.0)
     value = validator.current
     XCTAssertEqual(value, [(1, "a", 4), (2, "a", 4), (2, "b", 4), (2, "b", 5), (3, "b", 5), (3, "c", 5), (3, "c", 6)])
   }
diff --git a/Tests/AsyncAlgorithmsTests/TestCompacted.swift b/Tests/AsyncAlgorithmsTests/TestCompacted.swift
@@ -83,10 +83,10 @@ final class TestCompacted: XCTestCase {
       finished.fulfill()
     }
     // ensure the other task actually starts
-    wait(for: [iterated], timeout: 1.0)
+    await fulfillment(of: [iterated], timeout: 1.0)
     // cancellation should ensure the loop finishes
     // without regards to the remaining underlying sequence
     task.cancel()
-    wait(for: [finished], timeout: 1.0)
+    await fulfillment(of: [finished], timeout: 1.0)
   }
 }
diff --git a/Tests/AsyncAlgorithmsTests/TestJoin.swift b/Tests/AsyncAlgorithmsTests/TestJoin.swift
@@ -122,11 +122,11 @@ final class TestJoinedBySeparator: XCTestCase {
       finished.fulfill()
     }
     // ensure the other task actually starts
-    wait(for: [iterated], timeout: 1.0)
+    await fulfillment(of: [iterated], timeout: 1.0)
     // cancellation should ensure the loop finishes
     // without regards to the remaining underlying sequence
     task.cancel()
-    wait(for: [finished], timeout: 1.0)
+    await fulfillment(of: [finished], timeout: 1.0)
   }
 }
 
@@ -206,10 +206,10 @@ final class TestJoined: XCTestCase {
       finished.fulfill()
     }
     // ensure the other task actually starts
-    wait(for: [iterated], timeout: 1.0)
+    await fulfillment(of: [iterated], timeout: 1.0)
     // cancellation should ensure the loop finishes
     // without regards to the remaining underlying sequence
     task.cancel()
-    wait(for: [finished], timeout: 1.0)
+    await fulfillment(of: [finished], timeout: 1.0)
   }
 }
diff --git a/Tests/AsyncAlgorithmsTests/TestLazy.swift b/Tests/AsyncAlgorithmsTests/TestLazy.swift
@@ -121,12 +121,12 @@ final class TestLazy: XCTestCase {
     }
 
     // ensure the other task actually starts
-    wait(for: [iterated], timeout: 1.0)
+    await fulfillment(of: [iterated], timeout: 1.0)
 
     // cancellation should ensure the loop finishes
     // without regards to the remaining underlying sequence
     task.cancel()
 
-    wait(for: [finished], timeout: 1.0)
+    await fulfillment(of: [finished], timeout: 1.0)
   }
 }
diff --git a/Tests/AsyncAlgorithmsTests/TestManualClock.swift b/Tests/AsyncAlgorithmsTests/TestManualClock.swift
@@ -29,7 +29,7 @@ final class TestManualClock: XCTestCase {
     clock.advance()
     XCTAssertFalse(state.withCriticalRegion { $0 })
     clock.advance()
-    wait(for: [afterSleep], timeout: 1.0)
+    await fulfillment(of: [afterSleep], timeout: 1.0)
     XCTAssertTrue(state.withCriticalRegion { $0 })
   }
   
@@ -51,7 +51,7 @@ final class TestManualClock: XCTestCase {
     XCTAssertFalse(state.withCriticalRegion { $0 })
     clock.advance()
     task.cancel()
-    wait(for: [afterSleep], timeout: 1.0)
+    await fulfillment(of: [afterSleep], timeout: 1.0)
     XCTAssertTrue(state.withCriticalRegion { $0 })
     XCTAssertTrue(failure.withCriticalRegion { $0 is CancellationError })
   }
@@ -73,7 +73,7 @@ final class TestManualClock: XCTestCase {
     }
     XCTAssertFalse(state.withCriticalRegion { $0 })
     task.cancel()
-    wait(for: [afterSleep], timeout: 1.0)
+    await fulfillment(of: [afterSleep], timeout: 1.0)
     XCTAssertTrue(state.withCriticalRegion { $0 })
     XCTAssertTrue(failure.withCriticalRegion { $0 is CancellationError })
   }
diff --git a/Tests/AsyncAlgorithmsTests/TestMerge.swift b/Tests/AsyncAlgorithmsTests/TestMerge.swift
@@ -185,11 +185,11 @@ final class TestMerge2: XCTestCase {
       finished.fulfill()
     }
     // ensure the other task actually starts
-    wait(for: [iterated], timeout: 1.0)
+    await fulfillment(of: [iterated], timeout: 1.0)
     // cancellation should ensure the loop finishes
     // without regards to the remaining underlying sequence
     task.cancel()
-    wait(for: [finished], timeout: 1.0)
+    await fulfillment(of: [finished], timeout: 1.0)
   }
 
     func test_merge_when_cancelled() async {
@@ -509,11 +509,11 @@ final class TestMerge3: XCTestCase {
       finished.fulfill()
     }
     // ensure the other task actually starts
-    wait(for: [iterated], timeout: 1.0)
+    await fulfillment(of: [iterated], timeout: 1.0)
     // cancellation should ensure the loop finishes
     // without regards to the remaining underlying sequence
     task.cancel()
-    wait(for: [finished], timeout: 1.0)
+    await fulfillment(of: [finished], timeout: 1.0)
   }
 
     // MARK: - IteratorInitialized
diff --git a/Tests/AsyncAlgorithmsTests/TestReductions.swift b/Tests/AsyncAlgorithmsTests/TestReductions.swift
@@ -217,10 +217,10 @@ final class TestReductions: XCTestCase {
       finished.fulfill()
     }
     // ensure the other task actually starts
-    wait(for: [iterated], timeout: 1.0)
+    await fulfillment(of: [iterated], timeout: 1.0)
     // cancellation should ensure the loop finishes
     // without regards to the remaining underlying sequence
     task.cancel()
-    wait(for: [finished], timeout: 1.0)
+    await fulfillment(of: [finished], timeout: 1.0)
   }
 }
diff --git a/Tests/AsyncAlgorithmsTests/TestRemoveDuplicates.swift b/Tests/AsyncAlgorithmsTests/TestRemoveDuplicates.swift
@@ -95,10 +95,10 @@ final class TestRemoveDuplicates: XCTestCase {
       finished.fulfill()
     }
     // ensure the other task actually starts
-    wait(for: [iterated], timeout: 1.0)
+    await fulfillment(of: [iterated], timeout: 1.0)
     // cancellation should ensure the loop finishes
     // without regards to the remaining underlying sequence
     task.cancel()
-    wait(for: [finished], timeout: 1.0)
+    await fulfillment(of: [finished], timeout: 1.0)
   }
 }
diff --git a/Tests/AsyncAlgorithmsTests/TestThrowingChannel.swift b/Tests/AsyncAlgorithmsTests/TestThrowingChannel.swift
@@ -270,7 +270,7 @@ final class TestThrowingChannel: XCTestCase {
     task1.cancel()
 
     // Then: the first sending operation is resumed
-    wait(for: [send1IsResumed], timeout: 1.0)
+    await fulfillment(of: [send1IsResumed], timeout: 1.0)
 
     // When: collecting elements
     var iterator = sut.makeAsyncIterator()
diff --git a/Tests/AsyncAlgorithmsTests/TestValidator.swift b/Tests/AsyncAlgorithmsTests/TestValidator.swift
diff --git a/Tests/AsyncAlgorithmsTests/TestZip.swift b/Tests/AsyncAlgorithmsTests/TestZip.swift

Original file line number	Diff line number	Diff line change
`@@ -88,10 +88,11 @@ final class TestAdjacentPairs: XCTestCase {`
`88`	`88`	`}`
`89`	`89`
`90`	`90`	`// ensure the other task actually starts`
`91`		`- wait(for: [iterated], timeout: 1.0)`
	`91`	`+`
	`92`	`+ await fulfillment(of: [iterated], timeout: 1.0)`
`92`	`93`	`// cancellation should ensure the loop finishes`
`93`	`94`	`// without regards to the remaining underlying sequence`
`94`	`95`	`task.cancel()`
`95`		`- wait(for: [finished], timeout: 1.0)`
	`96`	`+ await fulfillment(of: [finished], timeout: 1.0)`
`96`	`97`	`}`
`97`	`98`	`}`
Original file line number	Diff line number	Diff line change
`@@ -199,10 +199,10 @@ final class TestBufferedByteIterator: XCTestCase {`
`199`	`199`	`}`
`200`	`200`	`}`
`201`	`201`	`}`
`202`		`- wait(for: [iterated], timeout: 1.0)`
	`202`	`+ await fulfillment(of: [iterated], timeout: 1.0)`
`203`	`203`	`// cancellation should ensure the loop finishes`
`204`	`204`	`// without regards to the remaining underlying sequence`
`205`	`205`	`task.cancel()`
`206`		`- wait(for: [finished], timeout: 1.0)`
	`206`	`+ await fulfillment(of: [finished], timeout: 1.0)`
`207`	`207`	`}`
`208`	`208`	`}`
Original file line number	Diff line number	Diff line change
`@@ -87,13 +87,13 @@ final class TestChain2: XCTestCase {`
`87`	`87`	`}`
`88`	`88`
`89`	`89`	`// ensure the other task actually starts`
`90`		`- wait(for: [iterated], timeout: 1.0)`
	`90`	`+ await fulfillment(of: [iterated], timeout: 1.0)`
`91`	`91`
`92`	`92`	`// cancellation should ensure the loop finishes`
`93`	`93`	`// without regards to the remaining underlying sequence`
`94`	`94`	`task.cancel()`
`95`	`95`
`96`		`- wait(for: [finished], timeout: 1.0)`
	`96`	`+ await fulfillment(of: [finished], timeout: 1.0)`
`97`	`97`	`}`
`98`	`98`	`}`
`99`	`99`
`@@ -192,12 +192,12 @@ final class TestChain3: XCTestCase {`
`192`	`192`	`}`
`193`	`193`
`194`	`194`	`// ensure the other task actually starts`
`195`		`- wait(for: [iterated], timeout: 1.0)`
	`195`	`+ await fulfillment(of: [iterated], timeout: 1.0)`
`196`	`196`
`197`	`197`	`// cancellation should ensure the loop finishes`
`198`	`198`	`// without regards to the remaining underlying sequence`
`199`	`199`	`task.cancel()`
`200`	`200`
`201`		`- wait(for: [finished], timeout: 1.0)`
	`201`	`+ await fulfillment(of: [finished], timeout: 1.0)`
`202`	`202`	`}`
`203`	`203`	`}`
Original file line number	Diff line number	Diff line change
`@@ -83,10 +83,10 @@ final class TestCompacted: XCTestCase {`
`83`	`83`	`finished.fulfill()`
`84`	`84`	`}`
`85`	`85`	`// ensure the other task actually starts`
`86`		`- wait(for: [iterated], timeout: 1.0)`
	`86`	`+ await fulfillment(of: [iterated], timeout: 1.0)`
`87`	`87`	`// cancellation should ensure the loop finishes`
`88`	`88`	`// without regards to the remaining underlying sequence`
`89`	`89`	`task.cancel()`
`90`		`- wait(for: [finished], timeout: 1.0)`
	`90`	`+ await fulfillment(of: [finished], timeout: 1.0)`
`91`	`91`	`}`
`92`	`92`	`}`
Original file line number	Diff line number	Diff line change
`@@ -122,11 +122,11 @@ final class TestJoinedBySeparator: XCTestCase {`
`122`	`122`	`finished.fulfill()`
`123`	`123`	`}`
`124`	`124`	`// ensure the other task actually starts`
`125`		`- wait(for: [iterated], timeout: 1.0)`
	`125`	`+ await fulfillment(of: [iterated], timeout: 1.0)`
`126`	`126`	`// cancellation should ensure the loop finishes`
`127`	`127`	`// without regards to the remaining underlying sequence`
`128`	`128`	`task.cancel()`
`129`		`- wait(for: [finished], timeout: 1.0)`
	`129`	`+ await fulfillment(of: [finished], timeout: 1.0)`
`130`	`130`	`}`
`131`	`131`	`}`
`132`	`132`
`@@ -206,10 +206,10 @@ final class TestJoined: XCTestCase {`
`206`	`206`	`finished.fulfill()`
`207`	`207`	`}`
`208`	`208`	`// ensure the other task actually starts`
`209`		`- wait(for: [iterated], timeout: 1.0)`
	`209`	`+ await fulfillment(of: [iterated], timeout: 1.0)`
`210`	`210`	`// cancellation should ensure the loop finishes`
`211`	`211`	`// without regards to the remaining underlying sequence`
`212`	`212`	`task.cancel()`
`213`		`- wait(for: [finished], timeout: 1.0)`
	`213`	`+ await fulfillment(of: [finished], timeout: 1.0)`
`214`	`214`	`}`
`215`	`215`	`}`