Use ContextManager directly in ContextManagerTests (#18630)

Author: mokagio

WordPress/Classes/Utility/ContextManager.h

@@ -3,6 +3,13 @@
 
 NS_ASSUME_NONNULL_BEGIN
 
+/**
+ A constant representing the current version of the data model.
+
+ @see -[ContextManager initWithModelName:storeURL:]
+ */
+FOUNDATION_EXTERN NSString * const ContextManagerModelNameCurrent;
+
 @protocol CoreDataStack
 @property (nonatomic, readonly, strong) NSManagedObjectContext *mainContext;
 - (NSManagedObjectContext *const)newDerivedContext;
@@ -34,6 +41,18 @@ NS_ASSUME_NONNULL_BEGIN
 */
 + (instancetype)internalSharedInstance;
 
+/**
+ Create a ContextManager instance with given model name and database location.
+
+ Note: This initialiser is only used for testing purpose at the moment.
+
+ @param modelName Model name in Core Data data model file.
+                  Use ContextManagerModelNameCurrent for current version, or
+                  "WordPress <version>" for specific version.
+ @param storeURL Database location.
+ */
+- (instancetype)initWithModelName:(NSString *)modelName storeURL:(NSURL *)storeURL NS_DESIGNATED_INITIALIZER;
+
 
 ///--------------------------
 ///@name Contexts

WordPress/Classes/Utility/ContextManager.m

@@ -5,6 +5,8 @@
 
 #define SentryStartupEventAddError(event, error) [event addError:error file:__FILE__ function:__FUNCTION__ line:__LINE__]
 
+NSString * const ContextManagerModelNameCurrent = @"$CURRENT";
+
 // MARK: - Static Variables
 //
 static ContextManager *_instance;
@@ -22,6 +24,8 @@ @interface ContextManager ()
 @property (nonatomic, strong) NSManagedObjectContext *mainContext;
 @property (nonatomic, strong) NSManagedObjectContext *writerContext;
 @property (nonatomic, assign) BOOL migrationFailed;
+@property (nonatomic, strong) NSString *modelName;
+@property (nonatomic, strong) NSURL *storeURL;
 
 @end
 
@@ -31,9 +35,25 @@ @interface ContextManager ()
 @implementation ContextManager
 
 - (instancetype)init
+{
+    NSString *documentsDirectory = [NSSearchPathForDirectoriesInDomains(NSDocumentDirectory,
+                                                                        NSUserDomainMask,
+                                                                        YES) lastObject];
+    NSURL *storeURL = [NSURL fileURLWithPath:[documentsDirectory stringByAppendingPathComponent:@"WordPress.sqlite"]];
+
+    return [self initWithModelName:ContextManagerModelNameCurrent storeURL:storeURL];
+}
+
+- (instancetype)initWithModelName:(NSString *)modelName storeURL:(NSURL *)storeURL
 {
     self = [super init];
     if (self) {
+        NSParameterAssert([modelName isEqualToString:ContextManagerModelNameCurrent] || [modelName hasPrefix:@"WordPress "]);
+        NSParameterAssert([storeURL isFileURL]);
+
+        self.modelName = modelName;
+        self.storeURL = storeURL;
+
         [NSValueTransformer registerCustomTransformers];
         // Create `mainContext` and `writerContext` during initialisation to
         // ensure they are only created once.
@@ -236,7 +256,16 @@ - (NSManagedObjectModel *)managedObjectModel
     }
     NSString *modelPath = [self modelPath];
     NSURL *modelURL = [NSURL fileURLWithPath:modelPath];
-    _managedObjectModel = [[NSManagedObjectModel alloc] initWithContentsOfURL:modelURL];
+    if ([self.modelName isEqualToString:ContextManagerModelNameCurrent]) {
+        // Use the current version defined in data model.
+        _managedObjectModel = [[NSManagedObjectModel alloc] initWithContentsOfURL:modelURL];
+    } else {
+        // Find the specific version defined in data model.
+        NSURL *versionedModelURL = [[modelURL URLByAppendingPathComponent:self.modelName] URLByAppendingPathExtension:@"mom"];
+        NSAssert([NSFileManager.defaultManager fileExistsAtPath:versionedModelURL.path],
+                 @"Can't find model '%@' at %@", self.modelName, modelPath);
+        _managedObjectModel = [[NSManagedObjectModel alloc] initWithContentsOfURL:versionedModelURL];
+    }
     return _managedObjectModel;
 }
 
@@ -324,15 +353,6 @@ - (NSArray *)sortedModelNames
     return modelNames;
 }
 
-- (NSURL *)storeURL
-{
-    NSString *documentsDirectory = [NSSearchPathForDirectoriesInDomains(NSDocumentDirectory,
-                                                                        NSUserDomainMask,
-                                                                        YES) lastObject];
-    
-    return [NSURL fileURLWithPath:[documentsDirectory stringByAppendingPathComponent:@"WordPress.sqlite"]];
-}
-
 - (NSString *)modelPath
 {
     return [[NSBundle mainBundle] pathForResource:@"WordPress" ofType:@"momd"];

WordPress/WordPressTest/ContextManagerMock.h

@@ -4,21 +4,13 @@
 
 NS_ASSUME_NONNULL_BEGIN
 
-@protocol ManagerMock
-@property (nonatomic, readwrite, strong) NSManagedObjectContext         *mainContext;
-@property (nonatomic, readwrite, strong) NSManagedObjectModel           *managedObjectModel;
-@property (nonatomic, readwrite, strong) NSPersistentStoreCoordinator   *persistentStoreCoordinator;
-@property (nonatomic, readonly,  strong) NSPersistentStoreCoordinator   *standardPSC;
-@property (nonatomic, readonly,  strong) NSURL                          *storeURL;
-@end
-
 /**
  *  @class      ContextManagerMock
  *  @brief      This class overrides standard ContextManager functionality, for testing purposes.
  *  @details    The SQLite-Backed PSC is replaced by an InMemory store. This allows us to easily reset
  *              the contents of the database, without even hitting the filesystem.
  */
-@interface ContextManagerMock : ContextManager <ManagerMock, CoreDataStack>
+@interface ContextManagerMock : ContextManager
 
 - (void)setUpAsSharedInstance;
 - (void)tearDown;

WordPress/WordPressTest/ContextManagerMock.m

@@ -1,61 +1,10 @@
 #import "ContextManagerMock.h"
 
-// This deserves a little bit of explanation – this was previously part of the public interface for `ContextManager`, which shouldn't make this API
-// public to the hosting app. Rather than rework the `CoreDataMigrationTests` right away (which will be done later as part of adopting Woo's
-// updated and well-tested migrator), we can use this hack for now to preserve the behaviour for those tests and come back to them later.
-@interface ContextManager(DeprecatedAccessors)
-    - (NSPersistentStoreCoordinator *) persistentStoreCoordinator;
-    - (NSManagedObjectModel *) managedObjectModel;
-@end
-
 @implementation ContextManagerMock
 
-@synthesize persistentStoreCoordinator = _persistentStoreCoordinator;
-@synthesize mainContext = _mainContext;
-@synthesize managedObjectModel = _managedObjectModel;
-
-- (NSManagedObjectModel *)managedObjectModel
-{
-    return _managedObjectModel ?: [super managedObjectModel];
-}
-
-- (NSPersistentStoreCoordinator *)persistentStoreCoordinator
-{
-    if (_persistentStoreCoordinator) {
-        return _persistentStoreCoordinator;
-    }
-
-    // This is important for automatic version migration. Leave it here!
-    NSDictionary *options = @{
-        NSInferMappingModelAutomaticallyOption          : @(YES),
-        NSMigratePersistentStoresAutomaticallyOption    : @(YES)
-    };
-
-    NSError *error = nil;
-    _persistentStoreCoordinator = [[NSPersistentStoreCoordinator alloc]
-                                   initWithManagedObjectModel:self.managedObjectModel];
-
-    if (![_persistentStoreCoordinator addPersistentStoreWithType:NSInMemoryStoreType
-                                                   configuration:nil
-                                                             URL:nil
-                                                         options:options
-                                                           error:&error]) {
-        NSLog(@"Unresolved error %@, %@", error, [error userInfo]);
-        abort();
-    }
-
-    return _persistentStoreCoordinator;
-}
-
-- (NSPersistentStoreCoordinator *)standardPSC
+- (instancetype)init
 {
-    return [super persistentStoreCoordinator];
-}
-
-- (void)createMainContext
-{
-    self.mainContext = [[NSManagedObjectContext alloc] initWithConcurrencyType:NSMainQueueConcurrencyType];
-    self.mainContext.persistentStoreCoordinator = self.persistentStoreCoordinator;
+    return [super initWithModelName:ContextManagerModelNameCurrent storeURL:[NSURL fileURLWithPath:@"/dev/null"]];
 }
 
 - (void)saveContextAndWait:(NSManagedObjectContext *)context
@@ -67,15 +16,6 @@ - (void)saveContextAndWait:(NSManagedObjectContext *)context
     NSLog(@"Context save completed");
 }
 
-- (NSURL *)storeURL
-{
-    NSString *documentsDirectory = [NSSearchPathForDirectoriesInDomains(NSDocumentDirectory,
-                                                                        NSUserDomainMask,
-                                                                        YES) lastObject];
-
-    return [NSURL fileURLWithPath:[documentsDirectory stringByAppendingPathComponent:@"WordPressTest.sqlite"]];
-}
-
 - (void)setUpAsSharedInstance
 {
     [ContextManager internalSharedInstance];