Unit tests added for more downloading and setting the installPath.

Bugfix: setting install path would not change in certain situations.
Simplified download package method of CCPackageManager, doesn't return success anymore. Adjusted documentation header.
CCPackageCocos2dEnabler using CCPackage private header.

Author: NickyWeber

UnitTests/CCPackageManagerTests.m

@@ -13,6 +13,10 @@
 #import "CCPackage_private.h"
 #import "CCPackageConstants.h"
 #import "CCPackageManagerDelegate.h"
+#import "CCUnitTestAssertions.h"
+#import "CCDirector.h"
+#import "AppDelegate.h"
+
 
 static NSString *const PACKAGE_BASE_URL = @"http://manager.test";
 
@@ -73,6 +77,7 @@ @interface CCPackageManagerTests : XCTestCase <CCPackageManagerDelegate>
 @property (nonatomic) BOOL managerReturnedFailed;
 @property (nonatomic, copy) NSString *customFolderName;
 @property (nonatomic, strong) NSError *managerReturnedWithError;
+@property (nonatomic, strong) NSMutableSet *cleanPathsArrayOnTearDown;
 
 @end
 
@@ -82,9 +87,27 @@ @implementation CCPackageManagerTests
 - (void)setUp
 {
     [super setUp];
+
+    [(AppController *)[UIApplication sharedApplication].delegate configureCocos2d];
+    [[CCDirector sharedDirector] stopAnimation];
+
     self.packageManager = [[CCPackageManager alloc] init];
+    _packageManager.delegate = self;
+
     self.managerReturnedSuccessfully = NO;
     self.managerReturnedFailed = NO;
+    self.managerReturnedWithError = nil;
+    self.customFolderName = nil;
+
+    // A set of paths to be removed on tear down
+    self.cleanPathsArrayOnTearDown = [NSMutableSet set];
+    [_cleanPathsArrayOnTearDown addObject:[NSTemporaryDirectory() stringByAppendingPathComponent:PACKAGE_REL_UNZIP_FOLDER]];
+    [_cleanPathsArrayOnTearDown addObject:[NSTemporaryDirectory() stringByAppendingPathComponent:PACKAGE_REL_DOWNLOAD_FOLDER]];
+    [_cleanPathsArrayOnTearDown addObject:_packageManager.installedPackagesPath];
+
+    // Important for the standard identifier of packages which most often determined internally instead
+    // of provided by the user. In this case resolution will default to phonehd.
+    [CCFileUtils sharedFileUtils].searchResolutionsOrder = [@[CCFileUtilsSuffixiPhoneHD] mutableCopy];
 
     [[NSUserDefaults standardUserDefaults] setObject:nil forKey:PACKAGE_STORAGE_USERDEFAULTS_KEY];
 
@@ -95,11 +118,11 @@ - (void)tearDown
 {
     [NSURLProtocol unregisterClass:[CCPackageManagerTestURLProtocol class]];
 
-    // Delete all relevant folders: Download, unzip, install
     NSFileManager *fileManager = [NSFileManager defaultManager];
-    [fileManager removeItemAtPath:[NSTemporaryDirectory() stringByAppendingPathComponent:PACKAGE_REL_UNZIP_FOLDER] error:nil];
-    [fileManager removeItemAtPath:[NSTemporaryDirectory() stringByAppendingPathComponent:PACKAGE_REL_DOWNLOAD_FOLDER] error:nil];
-    [fileManager removeItemAtPath:_packageManager.installedPackagesPath error:nil];
+    for (NSString *path in _cleanPathsArrayOnTearDown)
+    {
+        [fileManager removeItemAtPath:path error:nil];
+    }
 
     [super tearDown];
 }
@@ -151,23 +174,20 @@ - (void)testSavePackages
     // Note: Persistency of CCPackage is tested in CCPackageTests
 }
 
-- (void)testLoadPackages
+- (void)testDownloadWithNameAndBaseURLAndUnzipOnCustomQueue
 {
-    XCTFail(@"Not implemented yet.");
-}
-
-- (void)testDownloadWithNameAndBaseURL
-{
-    [CCFileUtils sharedFileUtils].searchResolutionsOrder = [@[CCFileUtilsSuffixiPhoneHD] mutableCopy];
-
     _packageManager.baseURL = [NSURL URLWithString:PACKAGE_BASE_URL];
-    _packageManager.delegate = self;
+
     CCPackage *package = [_packageManager downloadPackageWithName:@"testpackage" enableAfterDownload:YES];
 
+    dispatch_queue_t queue = dispatch_queue_create("testqueue", DISPATCH_QUEUE_CONCURRENT);
+    _packageManager.unzippingQueue = queue;
+
     [self waitForDelegateToReturn];
 
     XCTAssertNotNil(package);
     XCTAssertTrue(_managerReturnedSuccessfully);
+    XCTAssertEqual(package.status, CCPackageStatusInstalledEnabled);
 }
 
 - (void)testDownloadWithCustomFolderNameInPackage
@@ -179,7 +199,6 @@ - (void)testDownloadWithCustomFolderNameInPackage
     [CCFileUtils sharedFileUtils].searchResolutionsOrder = [@[CCFileUtilsSuffixiPhoneHD] mutableCopy];
 
     _packageManager.baseURL = [NSURL URLWithString:PACKAGE_BASE_URL];
-    _packageManager.delegate = self;
 
     self.customFolderName = @"testpackage-iOS-phonehd";
 
@@ -196,7 +215,6 @@ - (void)testCannotDetermineFolderNameWhenUnzipping
     // Like in testDownloadWithCustomFolderNameInPackage but this time we expect an error and a failing delegate method
 
     _packageManager.baseURL = [NSURL URLWithString:PACKAGE_BASE_URL];
-    _packageManager.delegate = self;
 
     CCPackage *package = [_packageManager downloadPackageWithName:@"Foo" enableAfterDownload:YES];
 
@@ -209,7 +227,6 @@ - (void)testCannotDetermineFolderNameWhenUnzipping
 
 - (void)testDownloadWithoutBaseURLShouldFail
 {
-    _packageManager.delegate = self;
     CCPackage *package = [_packageManager downloadPackageWithName:@"testpackage" enableAfterDownload:YES];
 
     [self waitForDelegateToReturn];
@@ -219,17 +236,59 @@ - (void)testDownloadWithoutBaseURLShouldFail
     XCTAssertEqual(_managerReturnedWithError.code, PACKAGE_ERROR_MANAGER_NO_BASE_URL_SET);
 }
 
-- (void)testDownloadWithNameAndWithoutBaseURLUnzipOnACustomQueue
+- (void)testSetInstallPath
 {
-    // Use a custom queue for unzipping
-    XCTFail(@"Not implemented yet.");
+    // Test: set a non existing path
+    NSFileManager *fileManager = [NSFileManager defaultManager];
+
+    NSString *customInstallPath = [NSTemporaryDirectory() stringByAppendingPathComponent:@"FooBar"];
+    [_cleanPathsArrayOnTearDown addObject:customInstallPath];
+
+    _packageManager.installedPackagesPath = customInstallPath;
+
+    XCTAssertTrue([fileManager fileExistsAtPath:customInstallPath]);
+    CCAssertEqualStrings(customInstallPath, _packageManager.installedPackagesPath);
+
+
+    // Test2: set an existing path
+    NSString *customInstallPath2 = [NSTemporaryDirectory() stringByAppendingPathComponent:@"FooBar2"];
+    [_cleanPathsArrayOnTearDown addObject:customInstallPath2];
+
+    [fileManager createDirectoryAtPath:customInstallPath2 withIntermediateDirectories:YES attributes:nil error:nil];
+
+    _packageManager.installedPackagesPath = customInstallPath2;
+    XCTAssertTrue([fileManager fileExistsAtPath:customInstallPath]);
+    CCAssertEqualStrings(customInstallPath2, _packageManager.installedPackagesPath);
 }
 
 - (void)testDownloadOfPackageWithDifferentInstallPath
 {
-    // add CCPackage and download:package
-    // use different installPath
+    NSString *customInstallPath = [NSTemporaryDirectory() stringByAppendingPathComponent:@"PackagesInstall"];
+
+    NSFileManager *fileManager = [NSFileManager defaultManager];
+    [fileManager removeItemAtPath:customInstallPath error:nil];
+    [_cleanPathsArrayOnTearDown addObject:customInstallPath];
 
+    _packageManager.installedPackagesPath = customInstallPath;
+
+    CCPackage *package = [[CCPackage alloc] initWithName:@"testpackage"
+                                              resolution:@"phonehd"
+                                                      os:@"iOS"
+                                               remoteURL:[[NSURL URLWithString:PACKAGE_BASE_URL]
+                                                                 URLByAppendingPathComponent:@"testpackage-iOS-phonehd.zip"]];
+
+    [_packageManager downloadPackage:package enableAfterDownload:NO];
+
+    [self waitForDelegateToReturn];
+
+    XCTAssertNotNil(package);
+    XCTAssertTrue(_managerReturnedSuccessfully);
+    XCTAssertEqual(package.status, CCPackageStatusInstalledDisabled);
+}
+
+/*
+- (void)testLoadPackages
+{
     XCTFail(@"Not implemented yet.");
 }
 
@@ -252,6 +311,7 @@ - (void)testCancelDownload
 {
     XCTFail(@"Not implemented yet.");
 }
+*/
 
 - (void)testAllOtherDownloadRelatedMethods
 {

cocos2d/CCPackageCocos2dEnabler.m

@@ -3,6 +3,7 @@
 #import "CCPackage.h"
 #import "CCFileUtils.h"
 #import "CCSpriteFrameCache.h"
+#import "CCPackage_private.h"
 
 
 @implementation CCPackageCocos2dEnabler
@@ -46,7 +47,7 @@ - (BOOL)addPackagestoSearchPath:(NSArray *)packages
 
         if (![newSearchPath containsObject:newPackagePath])
         {
-            [aPackage setValue:@(CCPackageStatusInstalledEnabled) forKey:NSStringFromSelector(@selector(status))];
+            aPackage.status = CCPackageStatusInstalledEnabled;
 
             [newSearchPath insertObject:newPackagePath atIndex:0];
             [CCFileUtils sharedFileUtils].searchPath = newSearchPath;

cocos2d/CCPackageManager.h

@@ -126,15 +126,14 @@
                    enableAfterDownload:(BOOL)enableAfterDownload;
 
 /**
- * Downloads a package. This is supposed to work in conjunction with addPackage where a package is created without the package manager
- * and should become managed.
+ * Downloads a package. If the package was not managed before it will be added to the managed packages.
  * A download will only start if the status is CCPackageStatusInitial, CCPackageStatusDownloadFailed.
  * A package with status CCPackageStatusDownloadPaused will be resumed if possible.
  *
  * @param name The package to be manager by the package manager
  * @param enableAfterDownload If the package should be enabled in cocos2d after download. You can enable it with the enablePackage: method later on.
  */
-- (BOOL)downloadPackage:(CCPackage *)package enableAfterDownload:(BOOL)enableAfterDownload;
+- (void)downloadPackage:(CCPackage *)package enableAfterDownload:(BOOL)enableAfterDownload;
 
 /**
  * Disables a package. Only packages with state CCPackageStatusInstalledEnabled can be disabled.

cocos2d/CCPackageManager.m

@@ -176,7 +176,7 @@ - (void)setInstalledPackagesPath:(NSString *)installedPackagesPath
     }
 
     NSFileManager *fileManager = [NSFileManager defaultManager];
-    if (![fileManager fileExistsAtPath:_installedPackagesPath])
+    if (![fileManager fileExistsAtPath:installedPackagesPath])
     {
         NSError *error;
         if (![fileManager createDirectoryAtPath:installedPackagesPath
@@ -239,35 +239,23 @@ - (CCPackage *)downloadPackageWithName:(NSString *)name resolution:(NSString *)r
     return [self downloadPackageWithName:name resolution:resolution remoteURL:remoteURL enableAfterDownload:enableAfterDownload];
 }
 
-- (BOOL)downloadPackage:(CCPackage *)package enableAfterDownload:(BOOL)enableAfterDownload
+- (void)downloadPackage:(CCPackage *)package enableAfterDownload:(BOOL)enableAfterDownload
 {
-    if (![_packages containsObject:package])
-    {
-        return NO;
-    }
-
     NSAssert(package, @"package must not be nil");
     NSAssert(package.name, @"package.name must not be nil");
     NSAssert(package.resolution, @"package.resolution must not be nil");
+    NSAssert(package.remoteURL, @"package.remoteURL must not be nil");
 
-    if (!package.remoteURL && !_baseURL)
-    {
-        return NO;
-    }
-    else if (!package.remoteURL)
+    if (![_packages containsObject:package])
     {
-        NSString *packageName = [NSString stringWithFormat:@"%@-%@-%@.zip", package.name, package.os, package.resolution];
-        NSURL *remoteURL = [_baseURL URLByAppendingPathComponent:packageName];
-        [package setValue:remoteURL forKey:@"remoteURL"];
+        [self addPackage:package];
     }
 
     package.enableOnDownload = enableAfterDownload;
 
     CCLOGINFO(@"[PACKAGE][INFO]: adding package to download queue: %@", package);
 
     [_downloadManager enqueuePackageForDownload:package];
-
-    return YES;
 }
 
 - (CCPackage *)downloadPackageWithName:(NSString *)name remoteURL:(NSURL *)remoteURL enableAfterDownload:(BOOL)enableAfterDownload