Updated Tests & SDK for Open Source Parse Server (#280)

-Updates test cases to work with open source parse-sever and to generally increase coverage overall. Coverage bumped to 95% and slight changes to internal classes to help with testing.
-Updated tests to address $this->expectException not being present in older versions of phpunit, particularly that which comes with composer.
-Updated CONTRIBUTING with new method for running tests.

Author: Benjamin Wilson Friedman

.gitignore

@@ -1,3 +1,6 @@
 .idea
 composer.lock
 vendor
+
+# ignore test results
+phpunit-test-results

CONTRIBUTING.md

@@ -11,23 +11,64 @@ into a single commit. Please provide ample explanation in the commit message.
 Installation
 ------------
 
-Testing the Parse PHP SDK involves some set-up. You'll need to create a Parse
-App just for testing, and deploy some cloud code to it.
+Testing the Parse PHP SDK requires having a working Parse Server instance to run against. 
+Additionally you'll need to add some cloud code to it.
+
+To get started:
 
 * [Get Composer], the PHP package manager.
 * Run "composer install" to download dependencies.
-* Create a new app here: [Create Parse App]
-* Use the Parse CLI to create a Cloud Code folder for the new app.
-* Copy tests/cloudcode/cloud/main.js into the newly created cloud/ folder.
-* Run "parse deploy" in your cloud folder.
-* Paste your App ID, REST API Key, and Master Key in tests/Parse/Helper.php
 
-You should now be able to execute, from project root folder:
+From here you have to setup an instance of parse server.
+
+To get started quickly you can clone and run this [parse server test] project.
+It's setup with the appropriate configuration to run the php sdk test suite. 
+Additionally it handles setting up mongodb for the server.
+
+Alternately you can configure a compatible test server as follows:
+
+* [Setup a local Parse Server instance]
+* Add main.js in tests/cloudcode/cloud/ to your Parse Server configuration as a cloud code file
+* Ensure your App ID, REST API Key, and Master Key match those contained in tests/Parse/Helper.php
+* Add a mock push configuration, for example:
+```json
+{
+    "android":
+    {
+        "senderId": "blank-sender-id",
+        "apiKey": "not-a-real-api-key"
+    }
+}
+```
+* Add a mock email adapter configuration, for example:
+```json
+{
+    "module": "parse-server-simple-mailgun-adapter",
+    "options": {
+        "apiKey": "not-a-real-api-key",
+        "domain": "example.com",
+        "fromAddress": "[email protected]"
+    }
+}
+```
+* Ensure the public url is correct. For a locally hosted instance this is probably ```http://localhost:1337/parse```
+
+
+You should now be able to execute the tests, from project root folder:
+
+    ./vendor/bin/phpunit
+
+The test suite is setup for code coverage if you have [XDebug] installed and setup.
+Coverage is outputted as text and as html in the phpunit-test-results/ directory within the project root.
 
-    ./vendor/bin/phpunit --stderr .
+If you do not have XDebug tests will still run, just without coverage.
 
-At present the full suite of tests takes around 20 minutes.
+Please make sure that any new functionality (or issues) you are working on are covered by tests when possible.
+If you have XDebug setup and can view code coverage please ensure that you do your best to completely cover any new code you are adding.
 
 [Get Composer]: https://getcomposer.org/download/
 [Contributor License Agreement]: https://developers.facebook.com/opensource/cla
 [Create Parse App]: https://parse.com/apps/new
+[XDebug]: https://xdebug.org/
+[parse server test]: https://github.com/montymxb/parse-server-test
+[Setup a local Parse Server instance]: https://github.com/ParsePlatform/parse-server#user-content-locally

phpunit.xml

@@ -20,4 +20,13 @@
             <directory suffix="Test.php">./tests</directory>
         </testsuite>
     </testsuites>
+    <filter>
+        <whitelist processUncoveredFilesFromWhitelist="true">
+            <directory suffix=".php">./src/Parse</directory>
+        </whitelist>
+    </filter>
+    <logging>
+        <log type="coverage-text" target="php://stdout" showUncoveredFiles="true"/>
+        <log type="coverage-html" target="phpunit-test-results/" showUncoveredFiles="true"/>
+    </logging>
 </phpunit>

src/Parse/Internal/AddUniqueOperation.php

@@ -4,6 +4,7 @@
 
 use Parse\ParseClient;
 use Parse\ParseException;
+use Parse\ParseObject;
 
 /**
  * Class AddUniqueOperation - Operation to add unique objects to an array key.

src/Parse/Internal/ParseRelationOperation.php

@@ -63,6 +63,11 @@ public function __construct($objectsToAdd, $objectsToRemove)
      */
     private function checkAndAssignClassName($objects)
     {
+        if(!is_array($objects)) {
+            $objects = [$objects];
+
+        }
+
         foreach ($objects as $object) {
             if ($this->targetClassName === null) {
                 $this->targetClassName = $object->getClassName();

src/Parse/Internal/RemoveOperation.php

@@ -105,6 +105,12 @@ public function _apply($oldValue, $obj, $key)
         if (empty($oldValue)) {
             return [];
         }
+
+        if(!is_array($oldValue)) {
+            $oldValue = [$oldValue];
+
+        }
+
         $newValue = [];
         foreach ($oldValue as $oldObject) {
             foreach ($this->objects as $newObject) {

src/Parse/ParseACL.php

@@ -548,7 +548,7 @@ public static function _getDefaultACL()
                 return self::$defaultACL;
             }
             if ($last != ParseUser::getCurrentUser()) {
-                self::$defaultACLWithCurrentUser = clone self::$defaultAC;
+                self::$defaultACLWithCurrentUser = clone self::$defaultACL;
                 self::$defaultACLWithCurrentUser->_setShared(true);
                 self::$defaultACLWithCurrentUser->setUserReadAccess(ParseUser::getCurrentUser(), true);
                 self::$defaultACLWithCurrentUser->setUserWriteAccess(ParseUser::getCurrentUser(), true);

src/Parse/ParseApp.php

@@ -24,7 +24,7 @@ public static function fetchApps()
             'apps',
             null,
             null,
-            false,
+            true,
             true
         );
 
@@ -47,7 +47,7 @@ public static function fetchApp($application_id)
             'apps/'.$application_id,
             null,
             null,
-            false,
+            true,
             true
         );
 
@@ -70,7 +70,7 @@ public static function createApp(array $data)
             'apps',
             null,
             json_encode($data),
-            false,
+            true,
             true
         );
 
@@ -94,7 +94,7 @@ public static function updateApp($application_id, array $data)
             'apps/'.$application_id,
             null,
             json_encode($data),
-            false,
+            true,
             true
         );
 

src/Parse/ParseClient.php

@@ -323,8 +323,10 @@ public static function _request(
             $data = '{}';
         }
         if ($appRequest) {
+            // 'app' requests are not available in open source parse-server
             self::assertAppInitialized();
             $headers = self::_getAppRequestHeaders();
+
         } else {
             self::assertParseInitialized();
             $headers = self::_getRequestHeaders($sessionToken, $useMasterKey);

src/Parse/ParseConfig.php

@@ -38,4 +38,10 @@ protected function setConfig($config)
     {
         $this->currentConfig = $config;
     }
+
+    public function getConfig()
+    {
+        return $this->currentConfig;
+
+    }
 }