Merge pull request #15 from cyon/mock-tests

Mock tests

Author: pierre

.travis.yml

@@ -1,8 +1,9 @@
 language: php
 php:
-  - 5.3
-  - 5.4
-
+  - 5.5
+  - 5.6
+  - 7.0
+  - 7.1
 notifications:
   email:
     - kill-bill-commits@googlegroups.com

README.md

@@ -66,6 +66,12 @@ If you want to use the client but are not using [Composer](https://getcomposer.o
 - You can now use the client like above described.
 - If you don't want to have an additional build step, just check the `vendor/` folder into your repository.
 
+Testing
+-------
+
+The Killbill PHP client uses [phpunit](https://phpunit.de/) as testing framework. Tests can either be run locally using `composer test` or against
+a live Killbill instance that is running on `127.0.0.1:8080` using `composer test-integration`.
+
 Requirements
 ------------
 

composer.json

@@ -3,17 +3,19 @@
   "description": "Official PHP client to the Killbill HTTP API",
   "type": "library",
   "autoload": {
-    "psr-4": {
-      "Killbill\\Client\\": "src/"
-    }
+      "psr-4": {
+          "Killbill\\Client\\": "src/"
+      }
   },
   "autoload-dev": {
-    "psr-4": {
-      "Killbill\\Client\\": "test/"
-    }
+      "psr-4": {
+          "Killbill\\Client\\": "test/"
+      }
   },
   "scripts": {
-    "test": "phpunit"
+      "test": "ENV=local phpunit",
+      "test-integration": "phpunit",
+      "record-mocks": "composer run test-integration && RECORD_REQUESTS=1 phpunit"
   },
   "license": "Apache",
   "require": {},

src/Client.php

@@ -18,6 +18,9 @@
 namespace Killbill\Client;
 
 class Client {
+    public static $mockManager = null;
+    public static $useMockData = false;
+    public static $recordMocks = false;
 
     public static $serverUrl = 'http://127.0.0.1:8080';
     public static $apiVersion = '1.0';
@@ -51,16 +54,21 @@ public function request($method, $uri, $data = null, $user = null, $reason = nul
 
     private function _sendRequest($method, $uri, $data = null, $user = null, $reason = null, $comment = null, $additional_headers = null) {
 
+        if (self::$useMockData && isset(self::$mockManager)) {
+            return $this->getMockResponse($method . ' ' . $uri . ' ' . $data);
+        }
+
         if (function_exists('mb_internal_encoding')) {
             mb_internal_encoding(self::DEFAULT_ENCODING);
         }
 
+        $effectiveUri = $uri;
         if (substr($uri, 0, 4) != 'http') {
-            $uri = self::__apiUrl() . $uri;
+            $effectiveUri = self::__apiUrl() . $uri;
         }
 
         $ch = curl_init();
-        curl_setopt($ch, CURLOPT_URL, $uri);
+        curl_setopt($ch, CURLOPT_URL, $effectiveUri);
         // Don't follow the Location header
         curl_setopt($ch, CURLOPT_FOLLOWLOCATION, FALSE);
         // Include the header in the output
@@ -128,12 +136,29 @@ private function _sendRequest($method, $uri, $data = null, $user = null, $reason
         $header_size = curl_getinfo($ch, CURLINFO_HEADER_SIZE);
         curl_close($ch);
 
+
         $header = substr($response, 0, $header_size);
         $headers = $this->_getHeaders($header);
 
         $body = substr($response, $header_size);
 
-        return new Response($statusCode, $headers, $body);
+        $response = new Response($statusCode, $headers, $body);
+        if (self::$recordMocks && isset(self::$mockManager)) {
+            $this->saveResponseMock($method . ' ' . $uri . ' ' . $data, $response);
+        }
+
+        return $response;
+    }
+
+    private function getMockResponse($mockName) {
+        $rawMockFileContents = self::$mockManager->getMock($mockName);
+        $mockData = json_decode($rawMockFileContents, true);
+        return new Response($mockData['statusCode'], $mockData['headers'], $mockData['body']);
+    }
+
+    private function saveResponseMock($mockName, $response) {
+        $mockContents = json_encode($response);
+        self::$mockManager->saveMock($mockName, $mockContents);
     }
 
     private static function __apiUrl() {

src/Resource.php

@@ -195,11 +195,7 @@ private function fromJsonObject($class, $json) {
      * @return json encoded resource
      */
     public function jsonSerialize() {
-
-        $keys = get_object_vars($this);
-
         $x = $this->prepareForSerialization();
-
         return json_encode($x);
     }
 
@@ -220,10 +216,16 @@ public function prepareForSerialization() {
                 }
             }
         }
-        return $keys;
-    }
+        $sortedArray = array();
+        $arrayKeys = array_keys($keys);
+        asort($arrayKeys, SORT_STRING | SORT_NATURAL);
 
+        foreach ($arrayKeys as $arrayKey) {
+            $sortedArray[$arrayKey] = $keys[$arrayKey];
+        }
 
+        return $sortedArray;
+    }
 
     private function initClientIfNeeded() {
         if (is_null($this->_client)) {

test/KillbillTest.php

@@ -32,8 +32,21 @@ class KillbillTest extends \PHPUnit_Framework_TestCase
 
     public function setUp()
     {
+        $externalKey = uniqid();
+        if (getenv('ENV') === 'local' || getenv('RECORD_REQUESTS') == '1') {
+            Client::$mockManager = new MockManager();
+            $externalKey = md5(static::class . ':' . $this->getName());
+
+            if (getenv('RECORD_REQUESTS') == '1') {
+                Client::$recordMocks = true;
+            } else {
+                Client::$useMockData = true;
+            }
+        }
+
+
         $tenant = new Tenant();
-        $tenant->setExternalKey(uniqid());
+        $tenant->setExternalKey($externalKey);
         $tenant->setApiKey('test-php-api-key-' . $tenant->getExternalKey());
         $tenant->setApiSecret('test-php-api-secret-' . $tenant->getExternalKey());
         $this->tenant = $tenant->create($this->user, $this->reason, $this->comment);
@@ -52,6 +65,9 @@ public function setUp()
         $this->clock->setClock(null, $this->tenant->getTenantHeaders());
 
         $this->externalAccountId = uniqid();
+        if (getenv('ENV') === 'local' || getenv('RECORD_REQUESTS') == '1') {
+            $this->externalAccountId = md5('externalAccount' . static::class . ':' . $this->getName());
+        }
         $this->accountData = new Account();
         $this->accountData->setName("Killbill php test");
         $this->accountData->setExternalKey($this->externalAccountId);

test/MockManager.php

@@ -0,0 +1,50 @@
+<?php
+/*
+ * Copyright 2011-2017 Ning, Inc.
+ *
+ * Ning licenses this file to you under the Apache License, version 2.0
+ * (the "License"); you may not use this file except in compliance with the
+ * License.  You may obtain a copy of the License at:
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
+ * License for the specific language governing permissions and limitations
+ * under the License.
+ */
+
+namespace Killbill\Client;
+
+class MockManager
+{
+    protected $stubs = null;
+
+    public function __construct() {
+        $this->stubs = array();
+    }
+
+    public function saveMock($identifier, $response) {
+        $filename = $this->getIteratedIdentifier($identifier);
+        file_put_contents(__DIR__ . '/resources/mocks/' . $filename, $response);
+    }
+
+    public function getMock($identifier) {
+        $filename = $this->getIteratedIdentifier($identifier);
+        return file_get_contents(__DIR__ . '/resources/mocks/' . $filename);
+    }
+
+    private function getIteratedIdentifier($identifier) {
+        $iteration = 0;
+        $identifier = md5($identifier);
+        if (in_array($identifier, array_keys($this->stubs))) {
+            $iteration = $this->stubs[$identifier];
+            $this->stubs[$identifier] = ++$iteration;
+        } else {
+            $this->stubs[$identifier] = 0;
+        }
+
+        return md5($identifier . '_' . $iteration);
+    }
+}

test/ServerAccountTest.php

@@ -81,12 +81,18 @@ function testTags()
         */
         $tag1 = new TagDefinition();
         $tag1->setName(uniqid());
-        $tag1->setDescription("This is tag1");
+        if (getenv('ENV') === 'local' || getenv('RECORD_REQUESTS') == '1') {
+            $tag1->setName(md5('tag1' . static::class . ':' . $this->getName()));
+        }
+        $tag1->setDescription('This is tag1');
         $tag1 = $tag1->create($this->user, $this->reason, $this->comment, $this->tenant->getTenantHeaders());
 
         $tag2 = new TagDefinition();
         $tag2->setName(uniqid());
-        $tag2->setDescription("This is tag2");
+        if (getenv('ENV') === 'local' || getenv('RECORD_REQUESTS') == '1') {
+            $tag2->setName(md5('tag2' . static::class . ':' . $this->getName()));
+        }
+        $tag2->setDescription('This is tag2');
         $tag2 = $tag2->create($this->user, $this->reason, $this->comment, $this->tenant->getTenantHeaders());
 
         /*

test/ServerInvoiceTest.php

@@ -29,6 +29,9 @@ function setUp()
     {
         parent::setUp();
         $this->externalBundleId = uniqid();
+        if (getenv('ENV') === 'local' || getenv('RECORD_REQUESTS') == '1') {
+            $this->externalBundleId = md5('serverInvoiceTest' . static::class . ':' . $this->getName());
+        }
         $this->account = $this->accountData->create($this->user, $this->reason, $this->comment, $this->tenant->getTenantHeaders());
 
         $paymentMethod = new PaymentMethod();

test/ServerPaymentMethodsTest.php

@@ -28,6 +28,9 @@ function setUp()
     {
         parent::setUp();
         $this->externalBundleId = uniqid();
+        if (getenv('ENV') === 'local' || getenv('RECORD_REQUESTS') == '1') {
+            $this->externalBundleId = md5('serverPaymentMethodTest' . static::class . ':' . $this->getName());
+        }
         $this->account = $this->accountData->create($this->user, $this->reason, $this->comment, $this->tenant->getTenantHeaders());
     }