PLAT-4021 allow to set logger (#28)

* Allow to set logger on clients
* Use common TestBase for all tests
* Retrieve request ID from query string
* Bump version and sort packages
* Use composer scripts, remove ant

Author: Grzegorz Rajchman

.gitignore

@@ -3,6 +3,7 @@ composer.lock
 composer.phar
 .idea
 build
+coverage
 vendor
 docker-compose.override.yml
 .env

.travis.yml

@@ -1,9 +1,5 @@
 language: php
 dist: trusty
-sudo: false
-addons:
-  apt:
-    packages: ant
 php:
   - 7.3
   - 7.2
@@ -14,10 +10,9 @@ php:
 install:
   - composer self-update
   - composer install
-script: |
-  set -xe
-  ant lint
-  ant test
+script:
+  - composer run lint
+  - composer run test
 env:
   global:
     - PERSONA_TEST_HOST: https://staging-users.talis.com

Dockerfile

@@ -15,7 +15,6 @@ RUN apt-get update \
         php5-curl \
         php5-json \
         php-pear \
-        ant \
         git \
         unzip \
     && rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*

build.xml

@@ -1,7 +1,7 @@
 {
   "name": "talis/talis-php",
   "description": "This is a php client library for talis APIs",
-  "version": "0.6.2",
+  "version": "0.6.3",
   "keywords": [
     "persona",
     "echo",
@@ -14,14 +14,17 @@
   "homepage": "https://github.com/talis/talis-php",
   "type": "library",
   "license": "MIT",
+  "config": {
+    "sort-packages": true
+  },
   "require": {
     "php": ">=5.5.9",
-    "monolog/monolog": ">=1.13.1",
-    "psr/log": ">=1.0.0",
-    "firebase/php-jwt": "^3.0",
     "doctrine/common": "^2.5",
-    "predis/predis"  : ">=0.8.5",
-    "guzzlehttp/guzzle": "^6.0"
+    "firebase/php-jwt": "^3.0",
+    "guzzlehttp/guzzle": "^6.0",
+    "monolog/monolog": ">=1.13.1",
+    "predis/predis": ">=0.8.5",
+    "psr/log": ">=1.0.0"
   },
   "require-dev": {
     "phpunit/phpunit": "4.8.36",
@@ -42,5 +45,28 @@
     "psr-4": {
       "test\\": "test/"
     }
+  },
+  "scripts": {
+    "code-check": "phpmd src text codesize,unusedcode,naming",
+    "lint": [
+      "@phplint",
+      "phpcs"
+    ],
+    "phplint": "phplint --exclude=vendor --no-cache .",
+    "test": "phpunit",
+    "clean-build": "rm -rf build; mkdir build",
+    "clean-coverage": "rm -rf coverage; mkdir coverage",
+    "coverage": [
+      "@clean-coverage",
+      "phpunit --coverage-text --coverage-html coverage"
+    ],
+    "unittest": [
+      "@clean-build",
+      "phpunit test/unit --log-junit build/unittest-report.xml"
+    ],
+    "integrationtest": [
+      "@clean-build",
+      "phpunit test/integration --log-junit build/integrationtest-report.xml"
+    ]
   }
 }

composer.json

@@ -16,35 +16,35 @@ x-common-values: &common-values
 services:
   init:
     <<: *common-values
-    command: "ant init"
+    command: "bash -c 'test -f composer.phar || (curl -sS https://getcomposer.org/installer | php); php composer.phar install'"
 
   lint:
     <<: *common-values
-    command: "ant lint"
+    command: "php composer.phar lint"
 
   code-check:
     <<: *common-values
-    command: "ant code-check"
+    command: "php composer.phar code-check"
 
   test:
     <<: *common-values
-    command: "ant test"
+    command: "php composer.phar test"
 
   unittest:
     <<: *common-values
-    command: "ant unittest"
+    command: "php composer.phar unittest"
 
   integrationtest:
     <<: *common-values
-    command: "ant integrationtest"
+    command: "php composer.phar integrationtest"
 
   local-dev:
     <<: *common-values
     command: "/bin/bash"
 
   coverage:
     <<: *common-values
-    command: "ant coverage"
+    command: "php composer.phar coverage"
 
   analyse:
     image: phpstan/phpstan:0.12.40

docker-compose.yml

@@ -1,4 +1,4 @@
-<phpunit bootstrap="test/bootstrap.php">
+<phpunit bootstrap="test/bootstrap.php" colors = "true">
     <php>
         <ini name="memory_limit" value="512M"/>
     </php>

phpunit.xml

@@ -4,6 +4,7 @@
 
 use Monolog\Handler\StreamHandler;
 use Monolog\Logger;
+use Psr\Log\LoggerAwareInterface;
 
 /**
  * Babel client.
@@ -12,7 +13,7 @@
  *
  * @package Talis\Babel
  */
-class Client
+class Client implements LoggerAwareInterface
 {
     /**
      * @var string

src/Talis/Babel/Client.php

@@ -14,7 +14,7 @@ abstract class Base
     /**
      * Get the current Logger instance.
      *
-     * @return \Monolog\Logger
+     * @return \Psr\Log\LoggerInterface
      */
     protected function getLogger()
     {
@@ -36,9 +36,9 @@ protected function getLogger()
     /**
      * Allow the calling project to use its own instance of a MonoLog Logger class.
      *
-     * @param \Monolog\Logger $logger logger
+     * @param \Psr\Log\LoggerInterface $logger logger
      */
-    public static function setLogger(Logger $logger)
+    public static function setLogger(\Psr\Log\LoggerInterface $logger)
     {
         self::$logger = $logger;
     }

src/Talis/EchoClient/Base.php

@@ -3,10 +3,10 @@
 namespace Talis\Persona\Client;
 
 use Monolog\Logger;
-use Predis\Response\ResponseInterface;
+use Psr\Log\LoggerAwareInterface;
 use Talis\Persona\Client\ClientVersionCache;
 
-abstract class Base
+abstract class Base implements LoggerAwareInterface
 {
     use ClientVersionCache;
 
@@ -100,6 +100,11 @@ protected function checkConfig(array $config)
         }
     }
 
+    public function setLogger(\Psr\Log\LoggerInterface $logger)
+    {
+        $this->logger = $logger;
+    }
+
     /**
      * @return \Psr\Log\LoggerInterface
      */
@@ -114,8 +119,6 @@ protected function getLogger()
 
     /**
      * Returns a unique id for tracing this request.
-     * If there is already a value set as a header it uses that, otherwise it
-     * generates a new one and sets that on $_SERVER
      * @return string
      */
     protected function getRequestId()
@@ -124,6 +127,9 @@ protected function getRequestId()
         if (array_key_exists('HTTP_X_REQUEST_ID', $_SERVER)) {
             $requestId = $_SERVER['HTTP_X_REQUEST_ID'];
         }
+        if ($requestId === null && array_key_exists('xid', $_GET)) {
+            $requestId = $_GET['xid'];
+        }
 
         return empty($requestId) ? uniqid() : $requestId;
     }

src/Talis/Persona/Client/Base.php

@@ -43,15 +43,22 @@ protected function getPersonaConfig()
         ];
     }
 
+    /**
+     * @before
+     */
+    protected function printName()
+    {
+        $className = get_class($this);
+        $testName = $this->getName();
+        echo " Test: {$className}->{$testName}\n";
+    }
+
     protected function setUp()
     {
         $this->removeCacheFolder();
         $this->cacheBackend = new FilesystemCache(
             sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'personaCache'
         );
-        $className = get_class($this);
-        $testName = $this->getName();
-        echo " Test: {$className}->{$testName}\n";
     }
 
     /**

test/TestBase.php

@@ -31,6 +31,7 @@ public function setUp()
                 'cacheBackend' => $this->personaCache,
             ]
         );
+        $this->personaClient->setLogger(new \Psr\Log\NullLogger());
     }
 
     public function testObtainNewToken()

test/integration/Persona/TokensIntegrationTest.php

@@ -34,6 +34,7 @@ public function setUp()
                 'cacheBackend' => $this->cacheBackend,
             ]
         );
+        $this->personaClientUser->setLogger(new \Psr\Log\NullLogger());
 
         $this->personaClientTokens = new Tokens(
             [
@@ -42,6 +43,7 @@ public function setUp()
                 'cacheBackend' => $this->cacheBackend,
             ]
         );
+        $this->personaClientTokens->setLogger(new \Psr\Log\NullLogger());
     }
 
     public function testCreateUserThenGetUserByGupid()

test/integration/Persona/UsersIntegrationTest.php test/integration/Persona/UsersIntegerationTest.php

@@ -2,13 +2,15 @@
 
 namespace test\unit\Babel;
 
+use test\TestBase;
+
 /**
  * Travis-CI runs against the unit tests but can only test certain things.
  *
  * You should run the integration tests locally, with a running local Babel server setup, as the
  * integration tests actually prove that this client library can read/write to Babel correctly.
  */
-class ClientTest extends \PHPUnit_Framework_TestCase
+class ClientTest extends TestBase
 {
     private $babelClient;
     private $baseCreateAnnotationData;