NetNewsWire/Frameworks/Account/AccountTests/Feedly/FeedlySyncAllOperationTests.swift

//
//  FeedlySyncAllOperationTests.swift
//  AccountTests
//
//  Created by Kiel Gillard on 30/10/19.
//  Copyright © 2019 Ranchero Software, LLC. All rights reserved.
//

import XCTest
@testable import Account
import RSWeb

class FeedlySyncAllOperationTests: XCTestCase {
	
	private var account: Account!
	private let support = FeedlyTestSupport()
	
	override func setUp() {
		super.setUp()
		account = support.makeTestAccount()
	}
	
	override func tearDown() {
		if let account = account {
			support.destroy(account)
		}
		super.tearDown()
	}
	
	func testCancel() {
		let markArticlesService = TestMarkArticlesService()
		markArticlesService.didMarkExpectation = expectation(description: "Set Article Statuses")
		markArticlesService.didMarkExpectation?.isInverted = true
		
		let getStreamIdsService = TestGetStreamIdsService()
		getStreamIdsService.getStreamIdsExpectation = expectation(description: "Get Unread Article Identifiers")
		getStreamIdsService.getStreamIdsExpectation?.isInverted = true
		
		let getCollectionsService = TestGetCollectionsService()
		getCollectionsService.getCollectionsExpectation = expectation(description: "Get User's Collections")
		getCollectionsService.getCollectionsExpectation?.isInverted = true
		
		let getGlobalStreamContents = TestGetStreamContentsService()
		getGlobalStreamContents.getStreamContentsExpectation = expectation(description: "Get Contents of global.all")
		getGlobalStreamContents.getStreamContentsExpectation?.isInverted = true
		
		let getStarredContents = TestGetStreamContentsService()
		getStarredContents.getStreamContentsExpectation = expectation(description: "Get Contents of global.saved")
		getStarredContents.getStreamContentsExpectation?.isInverted = true
		
		let container = support.makeTestDatabaseContainer()
		let syncAll = FeedlySyncAllOperation(account: account,
											 credentials: support.accessToken,
											 lastSuccessfulFetchStartDate: nil,
											 markArticlesService: markArticlesService,
											 getUnreadService: getStreamIdsService,
											 getCollectionsService: getCollectionsService,
											 getStreamContentsService: getGlobalStreamContents,
											 getStarredArticlesService: getStarredContents,
											 database: container.database,
											 log: support.log)
		
		// If this expectation is not fulfilled, the operation is not calling `didFinish`.
		let completionExpectation = expectation(description: "Did Finish")
		syncAll.completionBlock = {
			completionExpectation.fulfill()
		}
		
		let syncCompletionExpectation = expectation(description: "Did Finish Sync")
		syncCompletionExpectation.isInverted = true
		syncAll.syncCompletionHandler = { result in
			switch result {
			case .success:
				XCTFail("Sync operation was cancelled, not successful.")
			case .failure:
				XCTFail("Sync operation should cancel silently.")
				break
			}
			syncCompletionExpectation.fulfill()
		}
		
		OperationQueue.main.addOperation(syncAll)
		
		syncAll.cancel()
		
		waitForExpectations(timeout: 2)
		
		XCTAssertNil(syncAll.syncCompletionHandler, "Expected completion handler to be destroyed after completion.")
	}
	
	private var transport = TestTransport()
	lazy var caller: FeedlyAPICaller = {
		let caller = FeedlyAPICaller(transport: transport, api: .sandbox)
		caller.credentials = support.accessToken
		return caller
	}()
	
	func testSyncing() {
		performInitialSync()
		verifyInitialSync()
		
		performChangeStatuses()
		verifyChangeStatuses()
		
		performChangeStatusesAgain()
		verifyChangeStatusesAgain()
		
		performAddFeedsAndFolders()
		verifyAddFeedsAndFolders()
	}
	
	// MARK: 1 - Initial Sync
	
	private func loadMockData(inSubdirectoryNamed subdirectory: String) {
		let provider = FeedlyMockResponseProvider(findingMocksIn: subdirectory)
		transport.mockResponseFileUrlProvider = provider
		
		// lastSuccessfulFetchStartDate does not matter for the test, content will always be the same.
		// It is tested in `FeedlyGetStreamContentsOperationTests`.
		let syncAll = FeedlySyncAllOperation(account: account,
											 credentials: support.accessToken,
											 caller: caller,
											 database: databaseContainer.database,
											 lastSuccessfulFetchStartDate: nil,
											 log: support.log)
		
		// If this expectation is not fulfilled, the operation is not calling `didFinish`.
		let completionExpectation = expectation(description: "Did Finish")
		syncAll.completionBlock = {
			completionExpectation.fulfill()
		}
				
		OperationQueue.main.addOperation(syncAll)
		
		waitForExpectations(timeout: 5)
	}
	
	func performInitialSync() {
		loadMockData(inSubdirectoryNamed: "feedly-1-initial")
	}
	
	func verifyInitialSync() {
		let subdirectory = "feedly-1-initial"
		support.checkFoldersAndFeeds(in: account, againstCollectionsAndFeedsInJSONNamed: "collections", subdirectory: subdirectory)
		support.checkArticles(in: account, againstItemsInStreamInJSONNamed: "global.all", subdirectory: subdirectory)
		support.checkArticles(in: account, againstItemsInStreamInJSONNamed: "global.all@MTZkOTdkZWQ1NzM6NTE2OjUzYjgyNmEy", subdirectory: subdirectory)
		support.checkUnreadStatuses(in: account, againstIdsInStreamInJSONNamed: "unreadIds", subdirectory: subdirectory)
		support.checkUnreadStatuses(in: account, againstIdsInStreamInJSONNamed: "unreadIds@MTZkOTRhOTNhZTQ6MzExOjUzYjgyNmEy", subdirectory: subdirectory)
		support.checkStarredStatuses(in: account, againstItemsInStreamInJSONNamed: "starred", subdirectory: subdirectory)
		support.checkArticles(in: account, againstItemsInStreamInJSONNamed: "starred", subdirectory: subdirectory)
	}
	
	// MARK: 2 - Change Statuses
	
	func performChangeStatuses() {
		loadMockData(inSubdirectoryNamed: "feedly-2-changestatuses")
	}
	
	func verifyChangeStatuses() {
		let subdirectory = "feedly-2-changestatuses"
		support.checkFoldersAndFeeds(in: account, againstCollectionsAndFeedsInJSONNamed: "collections", subdirectory: subdirectory)
		support.checkArticles(in: account, againstItemsInStreamInJSONNamed: "global.all", subdirectory: subdirectory)
		support.checkUnreadStatuses(in: account, againstIdsInStreamInJSONNamed: "unreadIds", subdirectory: subdirectory)
		support.checkUnreadStatuses(in: account, againstIdsInStreamInJSONNamed: "unreadIds@MTZkOTJkNjIwM2Q6MTEzYjpkNDUwNjA3MQ==", subdirectory: subdirectory)
		support.checkStarredStatuses(in: account, againstItemsInStreamInJSONNamed: "starred", subdirectory: subdirectory)
		support.checkArticles(in: account, againstItemsInStreamInJSONNamed: "starred", subdirectory: subdirectory)
	}
	
	// MARK: 3 - Change Statuses Again
	
	func performChangeStatusesAgain() {
		loadMockData(inSubdirectoryNamed: "feedly-3-changestatusesagain")
	}
	
	func verifyChangeStatusesAgain() {
		let subdirectory = "feedly-3-changestatusesagain"
		support.checkFoldersAndFeeds(in: account, againstCollectionsAndFeedsInJSONNamed: "collections", subdirectory: subdirectory)
		support.checkArticles(in: account, againstItemsInStreamInJSONNamed: "global.all", subdirectory: subdirectory)
		support.checkUnreadStatuses(in: account, againstIdsInStreamInJSONNamed: "unreadIds", subdirectory: subdirectory)
		support.checkUnreadStatuses(in: account, againstIdsInStreamInJSONNamed: "unreadIds@MTZkOGRlMjVmM2M6M2YyOmQ0NTA2MDcx", subdirectory: subdirectory)
		support.checkStarredStatuses(in: account, againstItemsInStreamInJSONNamed: "starred", subdirectory: subdirectory)
		support.checkArticles(in: account, againstItemsInStreamInJSONNamed: "starred", subdirectory: subdirectory)
	}
	
	// MARK: 4 - Add Feeds and Folders
	
	func performAddFeedsAndFolders() {
		loadMockData(inSubdirectoryNamed: "feedly-4-addfeedsandfolders")
	}
	
	func verifyAddFeedsAndFolders() {
		let subdirectory = "feedly-4-addfeedsandfolders"
		support.checkFoldersAndFeeds(in: account, againstCollectionsAndFeedsInJSONNamed: "collections", subdirectory: subdirectory)
		support.checkArticles(in: account, againstItemsInStreamInJSONNamed: "global.all", subdirectory: subdirectory)
		support.checkUnreadStatuses(in: account, againstIdsInStreamInJSONNamed: "unreadIds", subdirectory: subdirectory)
		support.checkUnreadStatuses(in: account, againstIdsInStreamInJSONNamed: "unreadIds@MTZkOTE3YTRlMzQ6YWZjOmQ0NTA2MDcx", subdirectory: subdirectory)
		support.checkStarredStatuses(in: account, againstItemsInStreamInJSONNamed: "starred", subdirectory: subdirectory)
		support.checkArticles(in: account, againstItemsInStreamInJSONNamed: "starred", subdirectory: subdirectory)
	}
	
	// MARK: 5 - Remove Feeds and Folders
	
	func performRemoveFeedsAndFolders() {
		loadMockData(inSubdirectoryNamed: "feedly-5-removefeedsandfolders")
	}
	
	func verifyRemoveFeedsAndFolders() {
		let subdirectory = "feedly-5-removefeedsandfolders"
		support.checkFoldersAndFeeds(in: account, againstCollectionsAndFeedsInJSONNamed: "collections", subdirectory: subdirectory)
		support.checkArticles(in: account, againstItemsInStreamInJSONNamed: "global.all", subdirectory: subdirectory)
		support.checkUnreadStatuses(in: account, againstIdsInStreamInJSONNamed: "unreadIds", subdirectory: subdirectory)
		support.checkUnreadStatuses(in: account, againstIdsInStreamInJSONNamed: "unreadIds@MTZkOGRlMjVmM2M6M2YxOmQ0NTA2MDcx", subdirectory: subdirectory)
		support.checkStarredStatuses(in: account, againstItemsInStreamInJSONNamed: "starred", subdirectory: subdirectory)
		support.checkArticles(in: account, againstItemsInStreamInJSONNamed: "starred", subdirectory: subdirectory)
	}
	
	// MARK: Downloading Test Data
	
	var lastSuccessfulFetchStartDate: Date?
	lazy var databaseContainer: FeedlyTestSupport.TestDatabaseContainer = {
		return support.makeTestDatabaseContainer()
	}()
	
	func downloadTestData() {
		let caller = FeedlyAPICaller(transport: URLSession.webserviceTransport(), api: .sandbox)
		let credentials = Credentials(type: .oauthAccessToken, username: "<#USERNAME#>", secret: "<#SECRET#>")
		caller.credentials = credentials
				
		let syncAll = FeedlySyncAllOperation(account: account, credentials: credentials, caller: caller, database: databaseContainer.database, lastSuccessfulFetchStartDate: lastSuccessfulFetchStartDate, log: support.log)
		
		// If this expectation is not fulfilled, the operation is not calling `didFinish`.
		let completionExpectation = expectation(description: "Did Finish")
		syncAll.completionBlock = {
			completionExpectation.fulfill()
		}
		
		lastSuccessfulFetchStartDate = Date()
		
		OperationQueue.main.addOperation(syncAll)
		
		waitForExpectations(timeout: 60)
	}
	
	// Prefix with "test" to manually run this particular function, e.g.: func test_getTestData()
	func getTestData() {
		// Add a breakpoint on the `print` statements and start a proxy server on your Mac.
		// 1. In Feedly sandbox, perform the actions implied by the string in the print statement.
		// 2. In the proxy server app, such as Charles, clear requests and responses and filter by "sandbox".
		// 3. In Xcode, hit continue in the Debugger so the test requests the data.
		// 4. Save the responses captured by the proxy.
		print("Prepare for initial sync.")
		downloadTestData()
		
		assert(lastSuccessfulFetchStartDate != nil)
		
		print("Read/unread, star and unstar some articles.")
		downloadTestData()
		
		print("Read/unread, star and unstar some articles again.")
		downloadTestData()
		
		print("Add Feeds and Folders.")
		downloadTestData()
		
		print("Rename and Remove Feeds and Folders.")
		downloadTestData()
	}
}