Increase test coverage

Author: cweinberger

Tests/GatekeeperTests/GatekeeperTests.swift

@@ -11,11 +11,11 @@ class GatekeeperTests: XCTestCase {
             peerName: "::1"
         )
 
-        let gateKeeper = try request.make(Gatekeeper.self)
+        let gatekeeperMiddleware = try request.make(GatekeeperMiddleware.self)
 
         for i in 1...11 {
             do {
-                _ = try gateKeeper.accessEndpoint(on: request).wait()
+                _ = try gatekeeperMiddleware.respond(to: request, chainingTo: TestResponder()).wait()
                 XCTAssertTrue(i <= 10, "ran \(i) times.")
             } catch let error as Abort {
                 switch error.status {
@@ -39,10 +39,10 @@ class GatekeeperTests: XCTestCase {
             peerName: nil
         )
 
-        let gateKeeper = try request.make(Gatekeeper.self)
+        let gatekeeperMiddleware = try request.make(GatekeeperMiddleware.self)
 
         do {
-            _ = try gateKeeper.accessEndpoint(on: request).wait()
+            _ = try gatekeeperMiddleware.respond(to: request, chainingTo: TestResponder()).wait()
             XCTAssertTrue(false, "Gatekeeper should throw")
         } catch let error as Abort {
             switch error.status {
@@ -64,11 +64,11 @@ class GatekeeperTests: XCTestCase {
             peerName: "192.168.1.2"
         )
 
-        let gateKeeper = try request.make(Gatekeeper.self)
+        let gatekeeperMiddleware = try request.make(GatekeeperMiddleware.self)
 
         for _ in 0..<50 {
             do {
-                _ = try gateKeeper.accessEndpoint(on: request).wait()
+                _ = try gatekeeperMiddleware.respond(to: request, chainingTo: TestResponder()).wait()
             } catch {
                 XCTFail("Rate limiter failed: \(error)")
                 break
@@ -81,7 +81,7 @@ class GatekeeperTests: XCTestCase {
 
         Thread.sleep(forTimeInterval: 1)
         do {
-            _ = try gateKeeper.accessEndpoint(on: request).wait()
+            _ = try gatekeeperMiddleware.respond(to: request, chainingTo: TestResponder()).wait()
         } catch {
             XCTFail("Rate limiter failed: \(error)")
         }
@@ -90,6 +90,35 @@ class GatekeeperTests: XCTestCase {
         XCTAssertEqual(entry!.requestsLeft, 99, "Requests left should've reset")
     }
 
+    func testGateKeeperWithCacheFactory() throws {
+
+        let request = try Request.test(
+            gatekeeperConfig: GatekeeperConfig(maxRequests: 10, per: .minute),
+            peerName: "::1",
+            cacheFactory: { try $0.make(KeyedCache.self) }
+        )
+
+        let gatekeeperMiddleware = try request.make(GatekeeperMiddleware.self)
+
+        for i in 1...11 {
+            do {
+                _ = try gatekeeperMiddleware.respond(to: request, chainingTo: TestResponder()).wait()
+                XCTAssertTrue(i <= 10, "ran \(i) times.")
+            } catch let error as Abort {
+                switch error.status {
+                case .tooManyRequests:
+                    //success
+                    XCTAssertEqual(i, 11, "Should've failed after the 11th attempt.")
+                    break
+                default:
+                    XCTFail("Expected too many request: \(error)")
+                }
+            } catch {
+                XCTFail("Caught wrong error: \(error)")
+            }
+        }
+    }
+
     func testRefreshIntervalValues() {
         let expected: [(GatekeeperConfig.Interval, Double)] = [
             (.second, 1),

Tests/GatekeeperTests/Utilities/Request+test.swift

@@ -6,7 +6,8 @@ extension Request {
     static func test(
         gatekeeperConfig: GatekeeperConfig,
         url: URLRepresentable = "http://localhost:8080/test",
-        peerName: String? = "::1"
+        peerName: String? = "::1",
+        cacheFactory: ((Container) throws -> KeyedCache)? = nil
     ) throws -> Request {
         let config = Config()
 
@@ -15,7 +16,22 @@ extension Request {
             return MemoryKeyedCache()
         }
 
-        try services.register(GatekeeperProvider(config: gatekeeperConfig))
+        if let cacheFactory = cacheFactory {
+            try services.register(
+                GatekeeperProvider(
+                    config: gatekeeperConfig,
+                    cacheFactory: cacheFactory
+                )
+            )
+        } else {
+            try services.register(
+                GatekeeperProvider(
+                    config: gatekeeperConfig
+                )
+            )
+        }
+
+        services.register(GatekeeperMiddleware.self)
 
         let sharedThreadPool = BlockingIOThreadPool(numberOfThreads: 2)
         sharedThreadPool.start()

Tests/GatekeeperTests/Utilities/TestResponder.swift

@@ -0,0 +1,7 @@
+import Vapor
+
+public struct TestResponder: Responder {
+    public func respond(to req: Request) throws -> EventLoopFuture<Response> {
+        return req.future(req.response())
+    }
+}