fix(): added remove functions to remote image cache; test(): implemented remote image service tests

Christian Elies · Christian Elies · commit 64af9c6944d6 · 2019-12-15T11:59:49.000+01:00
diff --git a/Sources/RemoteImage/private/Extensions/URLSession+RemoteImageURLDataPublisher.swift b/Sources/RemoteImage/private/Extensions/URLSession+RemoteImageURLDataPublisher.swift
@@ -0,0 +1,15 @@
+//
+//  URLSession+RemoteImageURLDataPublisher.swift
+//  RemoteImage
+//
+//  Created by Christian Elies on 15.12.19.
+//
+
+import Combine
+import Foundation
+
+extension URLSession: RemoteImageURLDataPublisher {
+    func dataPublisher(for request: URLRequest) -> AnyPublisher<(data: Data, response: URLResponse), URLError> {
+        dataTaskPublisher(for: request).eraseToAnyPublisher()
+    }
+}
diff --git a/Sources/RemoteImage/private/Protocols/RemoteImageURLDataPublisher.swift b/Sources/RemoteImage/private/Protocols/RemoteImageURLDataPublisher.swift
@@ -0,0 +1,13 @@
+//
+//  RemoteImageURLDataPublisher.swift
+//  RemoteImage
+//
+//  Created by Christian Elies on 15.12.19.
+//
+
+import Combine
+import Foundation
+
+protocol RemoteImageURLDataPublisher {
+    func dataPublisher(for request: URLRequest) -> AnyPublisher<(data: Data, response: URLResponse), URLError>
+}
diff --git a/Sources/RemoteImage/private/Protocols/RemoteImageURLDataPublisherProvider.swift b/Sources/RemoteImage/private/Protocols/RemoteImageURLDataPublisherProvider.swift
@@ -0,0 +1,10 @@
+//
+//  RemoteImageURLDataPublisherProvider.swift
+//  RemoteImage
+//
+//  Created by Christian Elies on 15.12.19.
+//
+
+protocol RemoteImageURLDataPublisherProvider {
+    var remoteImageURLDataPublisher: RemoteImageURLDataPublisher { get }
+}
diff --git a/Sources/RemoteImage/private/Services/DefaultRemoteImageCache.swift b/Sources/RemoteImage/private/Services/DefaultRemoteImageCache.swift
@@ -15,4 +15,8 @@ extension DefaultRemoteImageCache: RemoteImageCache {
     func object(forKey key: AnyObject) -> PlatformSpecificImageType? { cache.object(forKey: key) }
 
     func setObject(_ object: PlatformSpecificImageType, forKey key: AnyObject) { cache.setObject(object, forKey: key) }
+
+    func removeObject(forKey key: AnyObject) { cache.removeObject(forKey: key) }
+
+    func removeAllObjects() { cache.removeAllObjects() }
 }
diff --git a/Sources/RemoteImage/private/Services/RemoteImageServiceDependencies.swift b/Sources/RemoteImage/private/Services/RemoteImageServiceDependencies.swift
@@ -7,14 +7,16 @@
 
 import Foundation
 
-protocol RemoteImageServiceDependenciesProtocol: PhotoKitServiceProvider {
+protocol RemoteImageServiceDependenciesProtocol: PhotoKitServiceProvider, RemoteImageURLDataPublisherProvider {
     
 }
 
 struct RemoteImageServiceDependencies: RemoteImageServiceDependenciesProtocol {
     let photoKitService: PhotoKitServiceProtocol
+    let remoteImageURLDataPublisher: RemoteImageURLDataPublisher
     
     init() {
         photoKitService = PhotoKitService()
+        remoteImageURLDataPublisher = URLSession.shared
     }
 }
diff --git a/Sources/RemoteImage/public/Protocols/RemoteImageCache.swift b/Sources/RemoteImage/public/Protocols/RemoteImageCache.swift
@@ -10,4 +10,6 @@ import Foundation
 public protocol RemoteImageCache {
     func object(forKey key: AnyObject) -> PlatformSpecificImageType?
     func setObject(_ object: PlatformSpecificImageType, forKey key: AnyObject)
+    func removeObject(forKey key: AnyObject)
+    func removeAllObjects()
 }
diff --git a/Sources/RemoteImage/public/Services/RemoteImageService.swift b/Sources/RemoteImage/public/Services/RemoteImageService.swift
@@ -49,10 +49,9 @@ extension RemoteImageService {
             return
         }
 
-        let urlSession = URLSession.shared
         let urlRequest = URLRequest(url: url)
 
-        cancellable = urlSession.dataTaskPublisher(for: urlRequest)
+        cancellable = dependencies.remoteImageURLDataPublisher.dataPublisher(for: urlRequest)
             .map { PlatformSpecificImageType(data: $0.data) }
             .receive(on: RunLoop.main)
             .sink(receiveCompletion: { completion in
diff --git a/Tests/RemoteImageTests/Mocks/MockPhotoKitService.swift b/Tests/RemoteImageTests/Mocks/MockPhotoKitService.swift
@@ -0,0 +1,17 @@
+//
+//  MockPhotoKitService.swift
+//  RemoteImageTests
+//
+//  Created by Christian Elies on 15.12.19.
+//
+
+import Foundation
+@testable import RemoteImage
+
+final class MockPhotoKitService: PhotoKitServiceProtocol {
+    var resultToReturn: Result<Data, Error> = .success(Data())
+
+    func getPhotoData(localIdentifier: String, _ completion: @escaping (Result<Data, Error>) -> Void) {
+        completion(resultToReturn)
+    }
+}
diff --git a/Tests/RemoteImageTests/Mocks/MockRemoteImageServiceDependencies.swift b/Tests/RemoteImageTests/Mocks/MockRemoteImageServiceDependencies.swift
@@ -0,0 +1,18 @@
+//
+//  MockRemoteImageServiceDependencies.swift
+//  RemoteImageTests
+//
+//  Created by Christian Elies on 15.12.19.
+//
+
+@testable import RemoteImage
+
+struct MockRemoteImageServiceDependencies: RemoteImageServiceDependenciesProtocol {
+    let photoKitService: PhotoKitServiceProtocol
+    let remoteImageURLDataPublisher: RemoteImageURLDataPublisher
+
+    init() {
+        photoKitService = MockPhotoKitService()
+        remoteImageURLDataPublisher = MockRemoteImageURLDataPublisher()
+    }
+}
diff --git a/Tests/RemoteImageTests/Mocks/MockRemoteImageURLDataPublisher.swift b/Tests/RemoteImageTests/Mocks/MockRemoteImageURLDataPublisher.swift
@@ -0,0 +1,18 @@
+//
+//  MockRemoteImageURLDataPublisher.swift
+//  RemoteImageTests
+//
+//  Created by Christian Elies on 15.12.19.
+//
+
+import Combine
+import Foundation
+@testable import RemoteImage
+
+final class MockRemoteImageURLDataPublisher: RemoteImageURLDataPublisher {
+    var publisher = PassthroughSubject<(data: Data, response: URLResponse), URLError>()
+
+    func dataPublisher(for request: URLRequest) -> AnyPublisher<(data: Data, response: URLResponse), URLError> {
+        publisher.eraseToAnyPublisher()
+    }
+}
diff --git a/Tests/RemoteImageTests/Services/RemoteImageServiceTests.swift b/Tests/RemoteImageTests/Services/RemoteImageServiceTests.swift
@@ -0,0 +1,224 @@
+//
+//  RemoteImageServiceTests.swift
+//  RemoteImageTests
+//
+//  Created by Christian Elies on 15.12.19.
+//
+
+import Combine
+@testable import RemoteImage
+import XCTest
+
+final class RemoteImageServiceTests: XCTestCase {
+    private var cancellable: AnyCancellable?
+
+    let dependencies = MockRemoteImageServiceDependencies()
+    lazy var photoKitService = dependencies.photoKitService as? MockPhotoKitService
+    lazy var remoteImageURLDataPublisher = dependencies.remoteImageURLDataPublisher as? MockRemoteImageURLDataPublisher
+    lazy var service = RemoteImageService(dependencies: dependencies)
+
+    override func setUp() {
+        RemoteImageService.cache.removeAllObjects()
+        photoKitService?.resultToReturn = .success(Data())
+    }
+
+    func testFetchImageURLSuccess() {
+        guard let url = URL(string: "https://www.google.de") else {
+            XCTFail("Could not create mock URL")
+            return
+        }
+
+        guard let data = UIImage(systemName: "paperplane.fill")?.jpegData(compressionQuality: 1) else {
+            XCTFail("Could not create mock data")
+            return
+        }
+
+        let expectation = self.expectation(description: "FetchImageURL")
+        let response = URLResponse()
+        let remoteImageType: RemoteImageType = .url(url)
+        service.fetchImage(ofType: remoteImageType)
+
+        // publish mock data
+        remoteImageURLDataPublisher?.publisher.send((data: data, response: response))
+
+        var state: RemoteImageState?
+        cancellable = service.$state.sink { st in
+            guard case RemoteImageState.image = st else {
+                return
+            }
+            state = st
+            expectation.fulfill()
+        }
+
+        waitForExpectations(timeout: 1)
+
+        switch state {
+        case .image(let image):
+            XCTAssertNotNil(image.imageAsset)
+        default:
+            XCTFail("Invalid fetch image URL result")
+        }
+    }
+
+    func testFetchImageURLFailure() {
+        guard let url = URL(string: "https://www.google.de") else {
+            XCTFail("Could not create mock URL")
+            return
+        }
+
+        let data = Data()
+
+        let expectation = self.expectation(description: "FetchImageURL")
+        let response = URLResponse()
+        let remoteImageType: RemoteImageType = .url(url)
+        service.fetchImage(ofType: remoteImageType)
+
+        // publish mock data
+        remoteImageURLDataPublisher?.publisher.send((data: data, response: response))
+
+        var state: RemoteImageState?
+        cancellable = service.$state.sink { st in
+            guard case RemoteImageState.error = st else {
+                return
+            }
+            state = st
+            expectation.fulfill()
+        }
+
+        waitForExpectations(timeout: 1)
+
+        switch state {
+        case .error(let error):
+            XCTAssertEqual(error as? RemoteImageServiceError, .couldNotCreateImage)
+        default:
+            XCTFail("Invalid fetch image URL result")
+        }
+    }
+
+    func testFetchImageURLCached() {
+        guard let url = URL(string: "https://www.google.de") else {
+            XCTFail("Could not create mock URL")
+            return
+        }
+
+        guard let image = PlatformSpecificImageType(systemName: "paperplane.fill") else {
+            XCTFail("Could not create mock image")
+            return
+        }
+
+        let cacheKey = url as NSURL
+        RemoteImageService.cache.setObject(image, forKey: cacheKey)
+
+        let expectation = self.expectation(description: "FetchImageURLCached")
+        let remoteImageType: RemoteImageType = .url(url)
+        service.fetchImage(ofType: remoteImageType)
+
+        var state: RemoteImageState?
+        cancellable = service.$state.sink { st in
+            guard case RemoteImageState.image = st else {
+                return
+            }
+            state = st
+            expectation.fulfill()
+        }
+
+        waitForExpectations(timeout: 1)
+
+        switch state {
+        case .image(let image):
+            XCTAssertNotNil(image.imageAsset)
+        default:
+            XCTFail("Invalid fetch image URL cached result")
+        }
+    }
+
+    func testFetchPHAssetSuccess() {
+        guard let data = UIImage(systemName: "paperplane.fill")?.jpegData(compressionQuality: 1) else {
+            XCTFail("Could not create mock data")
+            return
+        }
+
+        let expectation = self.expectation(description: "FetchPHAsset")
+        photoKitService?.resultToReturn = .success(data)
+        let localIdentifier = "TestIdentifier"
+        let remoteImageType: RemoteImageType = .phAsset(localIdentifier: localIdentifier)
+        service.fetchImage(ofType: remoteImageType)
+
+        var state: RemoteImageState?
+        cancellable = service.$state.sink { st in
+            guard case RemoteImageState.image = st else {
+                return
+            }
+            state = st
+            expectation.fulfill()
+        }
+
+        waitForExpectations(timeout: 1)
+
+        switch state {
+        case .image(let image):
+            XCTAssertNotNil(image.imageAsset)
+        default:
+            XCTFail("Invalid fetch ph asset result")
+        }
+    }
+
+    func testFetchPHAccessFailure() {
+        let expectation = self.expectation(description: "FetchPHAsset")
+        photoKitService?.resultToReturn = .success(Data())
+        let localIdentifier = "TestIdentifier"
+        let remoteImageType: RemoteImageType = .phAsset(localIdentifier: localIdentifier)
+        service.fetchImage(ofType: remoteImageType)
+
+        var state: RemoteImageState?
+        cancellable = service.$state.sink { st in
+            guard case RemoteImageState.error = st else {
+                return
+            }
+            state = st
+            expectation.fulfill()
+        }
+
+        waitForExpectations(timeout: 1)
+
+        switch state {
+        case .error(let error):
+            XCTAssertEqual(error as? RemoteImageServiceError, .couldNotCreateImage)
+        default:
+            XCTFail("Invalid fetch ph asset result")
+        }
+    }
+
+    func testFetchPHAssetCached() {
+        guard let image = PlatformSpecificImageType(systemName: "paperplane.fill") else {
+            XCTFail("Could not create mock image")
+            return
+        }
+
+        let localIdentifier = "TestIdentifier"
+        let cacheKey = localIdentifier as NSString
+        RemoteImageService.cache.setObject(image, forKey: cacheKey)
+
+        let expectation = self.expectation(description: "FetchPHAssetCached")
+        let remoteImageType: RemoteImageType = .phAsset(localIdentifier: localIdentifier)
+        service.fetchImage(ofType: remoteImageType)
+
+        var state: RemoteImageState?
+        cancellable = service.$state.sink { st in
+            guard case RemoteImageState.image = st else {
+                return
+            }
+            state = st
+            expectation.fulfill()
+        }
+
+        waitForExpectations(timeout: 1)
+
+        switch state {
+        case .image(let image):
+            XCTAssertNotNil(image.imageAsset)
+        default:
+            XCTFail("Invalid fetch ph asset cached result")
+        }
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -15,4 +15,8 @@ extension DefaultRemoteImageCache: RemoteImageCache {`
`15`	`15`	`func object(forKey key: AnyObject) -> PlatformSpecificImageType? { cache.object(forKey: key) }`
`16`	`16`
`17`	`17`	`func setObject(_ object: PlatformSpecificImageType, forKey key: AnyObject) { cache.setObject(object, forKey: key) }`
	`18`	`+`
	`19`	`+ func removeObject(forKey key: AnyObject) { cache.removeObject(forKey: key) }`
	`20`	`+`
	`21`	`+ func removeAllObjects() { cache.removeAllObjects() }`
`18`	`22`	`}`
Original file line number	Diff line number	Diff line change
`@@ -7,14 +7,16 @@`
`7`	`7`
`8`	`8`	`import Foundation`
`9`	`9`
`10`		`-protocol RemoteImageServiceDependenciesProtocol: PhotoKitServiceProvider {`
	`10`	`+protocol RemoteImageServiceDependenciesProtocol: PhotoKitServiceProvider, RemoteImageURLDataPublisherProvider {`
`11`	`11`
`12`	`12`	`}`
`13`	`13`
`14`	`14`	`struct RemoteImageServiceDependencies: RemoteImageServiceDependenciesProtocol {`
`15`	`15`	`let photoKitService: PhotoKitServiceProtocol`
	`16`	`+ let remoteImageURLDataPublisher: RemoteImageURLDataPublisher`
`16`	`17`
`17`	`18`	`init() {`
`18`	`19`	`photoKitService = PhotoKitService()`
	`20`	`+ remoteImageURLDataPublisher = URLSession.shared`
`19`	`21`	`}`
`20`	`22`	`}`
Original file line number	Diff line number	Diff line change
`@@ -10,4 +10,6 @@ import Foundation`
`10`	`10`	`public protocol RemoteImageCache {`
`11`	`11`	`func object(forKey key: AnyObject) -> PlatformSpecificImageType?`
`12`	`12`	`func setObject(_ object: PlatformSpecificImageType, forKey key: AnyObject)`
	`13`	`+ func removeObject(forKey key: AnyObject)`
	`14`	`+ func removeAllObjects()`
`13`	`15`	`}`