Re-enable StatsWidgetsStoreTests

Author: kean

WordPress/Classes/Stores/StatsWidgetsStore.swift

@@ -27,17 +27,17 @@ class StatsWidgetsStore {
         initializeStatsWidgetsIfNeeded()
 
         if let newTodayData = refreshStats(type: HomeWidgetTodayData.self) {
-            HomeWidgetTodayData.write(items: newTodayData)
+            setCachedItems(newTodayData)
             WidgetCenter.shared.reloadTodayTimelines()
         }
 
         if let newAllTimeData = refreshStats(type: HomeWidgetAllTimeData.self) {
-            HomeWidgetAllTimeData.write(items: newAllTimeData)
+            setCachedItems(newAllTimeData)
             WidgetCenter.shared.reloadAllTimeTimelines()
         }
 
         if let newThisWeekData = refreshStats(type: HomeWidgetThisWeekData.self) {
-            HomeWidgetThisWeekData.write(items: newThisWeekData)
+            setCachedItems(newThisWeekData)
             WidgetCenter.shared.reloadThisWeekTimelines()
         }
     }
@@ -51,21 +51,21 @@ class StatsWidgetsStore {
 
         var isReloadRequired = false
 
-        if !HomeWidgetTodayData.cacheDataExists() {
+        if !hasCachedItems(for: HomeWidgetTodayData.self) {
             DDLogInfo("StatsWidgets: Writing initialization data into HomeWidgetTodayData.plist")
-            HomeWidgetTodayData.write(items: initializeHomeWidgetData(type: HomeWidgetTodayData.self))
+            setCachedItems(initializeHomeWidgetData(type: HomeWidgetTodayData.self))
             isReloadRequired = true
         }
 
-        if !HomeWidgetThisWeekData.cacheDataExists() {
+        if !hasCachedItems(for: HomeWidgetThisWeekData.self) {
             DDLogInfo("StatsWidgets: Writing initialization data into HomeWidgetThisWeekData.plist")
-            HomeWidgetThisWeekData.write(items: initializeHomeWidgetData(type: HomeWidgetThisWeekData.self))
+            setCachedItems(initializeHomeWidgetData(type: HomeWidgetThisWeekData.self))
             isReloadRequired = true
         }
 
-        if !HomeWidgetAllTimeData.cacheDataExists() {
+        if !hasCachedItems(for: HomeWidgetAllTimeData.self) {
             DDLogInfo("StatsWidgets: Writing initialization data into HomeWidgetAllTimeData.plist")
-            HomeWidgetAllTimeData.write(items: initializeHomeWidgetData(type: HomeWidgetAllTimeData.self))
+            setCachedItems(initializeHomeWidgetData(type: HomeWidgetAllTimeData.self))
             isReloadRequired = true
         }
 
@@ -83,7 +83,7 @@ class StatsWidgetsStore {
             return
         }
 
-        var homeWidgetCache = T.read() ?? initializeHomeWidgetData(type: widgetType)
+        var homeWidgetCache = getCachedItems(for: T.self) ?? initializeHomeWidgetData(type: widgetType)
         guard let oldData = homeWidgetCache[siteID.intValue] else {
             DDLogError("StatsWidgets: Failed to find a matching site")
             return
@@ -93,7 +93,7 @@ class StatsWidgetsStore {
             DDLogError("StatsWidgets: the site does not exist anymore")
             // if for any reason that site does not exist anymore, remove it from the cache.
             homeWidgetCache.removeValue(forKey: siteID.intValue)
-            T.write(items: homeWidgetCache)
+            setCachedItems(homeWidgetCache)
             return
         }
 
@@ -102,37 +102,81 @@ class StatsWidgetsStore {
         if widgetType == HomeWidgetTodayData.self, let stats = stats as? TodayWidgetStats {
             widgetReload = WidgetCenter.shared.reloadTodayTimelines
 
-            homeWidgetCache[siteID.intValue] = HomeWidgetTodayData(siteID: siteID.intValue,
-                                                                   siteName: blog.title ?? oldData.siteName,
-                                                                   url: blog.url ?? oldData.url,
-                                                                   timeZone: blog.timeZone ?? TimeZone.current,
-                                                                   date: Date(),
-                                                                   stats: stats) as? T
+            homeWidgetCache[siteID.intValue] = HomeWidgetTodayData(
+                siteID: siteID.intValue,
+                siteName: blog.title ?? oldData.siteName,
+                url: blog.url ?? oldData.url,
+                timeZone: blog.timeZone ?? TimeZone.current,
+                date: Date(),
+                stats: stats
+            ) as? T
 
         } else if widgetType == HomeWidgetAllTimeData.self, let stats = stats as? AllTimeWidgetStats {
             widgetReload = WidgetCenter.shared.reloadAllTimeTimelines
 
-            homeWidgetCache[siteID.intValue] = HomeWidgetAllTimeData(siteID: siteID.intValue,
-                                                                     siteName: blog.title ?? oldData.siteName,
-                                                                     url: blog.url ?? oldData.url,
-                                                                     timeZone: blog.timeZone ?? TimeZone.current,
-                                                                     date: Date(),
-                                                                     stats: stats) as? T
+            homeWidgetCache[siteID.intValue] = HomeWidgetAllTimeData(
+                siteID: siteID.intValue,
+                siteName: blog.title ?? oldData.siteName,
+                url: blog.url ?? oldData.url,
+                timeZone: blog.timeZone ?? TimeZone.current,
+                date: Date(),
+                stats: stats
+            ) as? T
 
         } else if widgetType == HomeWidgetThisWeekData.self, let stats = stats as? ThisWeekWidgetStats {
             widgetReload = WidgetCenter.shared.reloadThisWeekTimelines
 
-            homeWidgetCache[siteID.intValue] = HomeWidgetThisWeekData(siteID: siteID.intValue,
-                                                                      siteName: blog.title ?? oldData.siteName,
-                                                                      url: blog.url ?? oldData.url,
-                                                                      timeZone: blog.timeZone ?? TimeZone.current,
-                                                                      date: Date(),
-                                                                      stats: stats) as? T
+            homeWidgetCache[siteID.intValue] = HomeWidgetThisWeekData(
+                siteID: siteID.intValue,
+                siteName: blog.title ?? oldData.siteName,
+                url: blog.url ?? oldData.url,
+                timeZone: blog.timeZone ?? TimeZone.current,
+                date: Date(),
+                stats: stats
+            ) as? T
         }
 
-        T.write(items: homeWidgetCache)
+        setCachedItems(homeWidgetCache)
         widgetReload?()
     }
+
+    // MARK: HomeWidgetCache (Helpers)
+
+    private func getCachedItems<T: HomeWidgetData>(for type: T.Type) -> [Int: T]? {
+        do {
+            return try makeCache(for: type).read()
+        } catch {
+            DDLogError("HomeWidgetCache: failed to read items: \(error)")
+            return nil
+        }
+    }
+
+    private func hasCachedItems<T: HomeWidgetData>(for type: T.Type) -> Bool {
+        guard let items = getCachedItems(for: type) else {
+            return false
+        }
+        return !items.isEmpty
+    }
+
+    private func deleteCachedItems<T: HomeWidgetData>(for type: T.Type) {
+        do {
+            try makeCache(for: T.self).delete()
+        } catch {
+            DDLogError("HomeWidgetCache: failed to delete items: \(error)")
+        }
+    }
+
+    private func setCachedItems<T: HomeWidgetData>(_ items: [Int: T]) {
+        do {
+            try makeCache(for: T.self).write(items: items)
+        } catch {
+            DDLogError("HomeWidgetCache: failed to write items: \(error)")
+        }
+    }
+
+    private func makeCache<T: HomeWidgetData>(for type: T.Type) -> HomeWidgetCache<T> {
+        HomeWidgetCache<T>(appGroup: appGroupName)
+    }
 }
 
 // MARK: - Helper methods
@@ -283,9 +327,9 @@ private extension StatsWidgetsStore {
 
         guard !isLoggedIn else { return }
 
-        HomeWidgetTodayData.delete()
-        HomeWidgetThisWeekData.delete()
-        HomeWidgetAllTimeData.delete()
+        deleteCachedItems(for: HomeWidgetTodayData.self)
+        deleteCachedItems(for: HomeWidgetThisWeekData.self)
+        deleteCachedItems(for: HomeWidgetAllTimeData.self)
 
         userDefaults?.setValue(nil, forKey: WidgetStatsConfiguration.userDefaultsSiteIdKey)
 

WordPress/JetpackStatsWidgets/Cache/HomeWidgetCache.swift

@@ -4,12 +4,27 @@ import JetpackStatsWidgetsCore
 /// Cache manager that stores `HomeWidgetData` values in a plist file, contained in the specified security application group and with the specified file name.
 /// The corresponding dictionary is always in the form `[Int: T]`, where the `Int` key is the SiteID, and the `T` value is any `HomeWidgetData` instance.
 struct HomeWidgetCache<T: HomeWidgetData> {
-
     let fileName: String
     let appGroup: String
 
+    init(fileName: String = T.filename, appGroup: String) {
+        self.fileName = fileName
+        self.appGroup = appGroup
+    }
+
     private var fileURL: URL? {
-        FileManager.default.containerURL(forSecurityApplicationGroupIdentifier: appGroup)?.appendingPathComponent(fileName)
+        if appGroup.hasPrefix(Self.testAppGroupNamePrefix) {
+            return makeTestingFileURL()
+        }
+        return FileManager.default.containerURL(forSecurityApplicationGroupIdentifier: appGroup)?.appendingPathComponent(fileName)
+    }
+
+    /// Tests are not eligible to write to shared secure groups.
+    private func makeTestingFileURL() -> URL? {
+        let directoryURL = FileManager.default.temporaryDirectory
+            .appendingPathComponent(appGroup)
+        try? FileManager.default.createDirectory(at: directoryURL, withIntermediateDirectories: true, attributes: nil)
+        return directoryURL.appendingPathComponent(fileName)
     }
 
     func read() throws -> [Int: T]? {
@@ -48,4 +63,6 @@ struct HomeWidgetCache<T: HomeWidgetData> {
         }
         try FileManager.default.removeItem(at: fileURL)
     }
+
+    static var testAppGroupNamePrefix: String { "xctest" }
 }

WordPress/JetpackStatsWidgets/Model/HomeWidgetData.swift

@@ -50,9 +50,4 @@ extension HomeWidgetData {
             DDLogError("HomeWidgetToday: Failed writing data item: \(error.localizedDescription)")
         }
     }
-
-    static func cacheDataExists() -> Bool {
-        let data = read()
-        return data != nil && data?.isEmpty == false
-    }
 }

WordPress/WordPressTest/Classes/Stores/StatsWidgetsStoreTests.swift

@@ -3,21 +3,32 @@ import JetpackStatsWidgetsCore
 
 @testable import WordPress
 
-// TODO: rewrite this system to avoid using BuildSettings.current (hardcoded all over the place)
 class StatsWidgetsStoreTests: CoreDataTestCase {
     private var sut: StatsWidgetsStore!
+    private var appGroupName: String!
+    private let appKeychainAccessGroup = "xctest_appKeychainAccessGroup"
 
     override func setUp() {
+        super.setUp()
+
+        let prefix = HomeWidgetCache<HomeWidgetTodayData>.testAppGroupNamePrefix
+        appGroupName = "\(prefix)_\(UUID().uuidString)"
         deleteHomeWidgetData()
-        sut = StatsWidgetsStore(coreDataStack: contextManager)
+        sut = StatsWidgetsStore(
+            coreDataStack: contextManager,
+            appGroupName: appGroupName,
+            appKeychainAccessGroup: appKeychainAccessGroup
+        )
     }
 
     override func tearDown() {
+        super.tearDown()
+
         deleteHomeWidgetData()
         sut = nil
     }
 
-    func xTestStatsWidgetsDataInitializedAfterSignDidFinish() {
+    func testStatsWidgetsDataInitializedAfterSignDidFinish() {
         BlogBuilder(contextManager.mainContext)
             .withAnAccount()
             .isHostedAtWPcom()
@@ -29,7 +40,7 @@ class StatsWidgetsStoreTests: CoreDataTestCase {
         XCTAssertTrue(statsWidgetsHaveData())
     }
 
-    func xTestStatsWidgetsDeletedAfterDefaultWPAccountRemoved() {
+    func testStatsWidgetsDeletedAfterDefaultWPAccountRemoved() {
         BlogBuilder(contextManager.mainContext)
             .withAnAccount()
             .isHostedAtWPcom()
@@ -41,20 +52,36 @@ class StatsWidgetsStoreTests: CoreDataTestCase {
         DispatchQueue.main.asyncAfter(deadline: .now() + .milliseconds(50)) {
             XCTAssertFalse(self.statsWidgetsHaveData())
         }
-
     }
 }
 
 private extension StatsWidgetsStoreTests {
     private func statsWidgetsHaveData() -> Bool {
-        return HomeWidgetTodayData.read() != nil
-        || HomeWidgetThisWeekData.read() != nil
-        || HomeWidgetAllTimeData.read() != nil
+        hasData(for: HomeWidgetTodayData.self) &&
+        hasData(for: HomeWidgetThisWeekData.self) &&
+        hasData(for: HomeWidgetAllTimeData.self)
     }
 
     private func deleteHomeWidgetData() {
-        HomeWidgetTodayData.delete()
-        HomeWidgetThisWeekData.delete()
-        HomeWidgetAllTimeData.delete()
+        do {
+            try makeCache(for: HomeWidgetTodayData.self).delete()
+            try makeCache(for: HomeWidgetThisWeekData.self).delete()
+            try makeCache(for: HomeWidgetAllTimeData.self).delete()
+        } catch {
+            // OK if it doesn't exist
+        }
+    }
+
+    private func hasData<T: HomeWidgetData>(for type: T.Type) -> Bool {
+        do {
+            return try makeCache(for: type).read() != nil
+        } catch {
+            XCTFail("failed to read cache: \(error)")
+            return false
+        }
+    }
+
+    private func makeCache<T: HomeWidgetData>(for type: T.Type) -> HomeWidgetCache<T> {
+        HomeWidgetCache<T>(appGroup: appGroupName)
     }
 }