Merge from safire-ac-za/simplesamlphp-module-fticks

Author: ghalse

.coveralls.yml

@@ -0,0 +1,3 @@
+coverage_clover: build/logs/clover.xml
+json_path: build/logs/coveralls-upload.json
+service_name: travis-ci

.travis.yml

@@ -1,20 +1,28 @@
+sudo: required
+
 language: php
 
 php:
   - 5.6
   - 7.0
   - 7.1
   - 7.2
-  - hhvm
+  - 7.3
 
-matrix:
-  allow_failures:
-  - php: 7.2
-  - php: hhvm
+env:
+  - SIMPLESAMLPHP_VERSION=1.17.*
 
 before_script:
-  - composer update
-  - if [[ "$TRAVIS_PHP_VERSION" == "7.2" ]]; then echo 'error_reporting = E_ALL & ~E_DEPRECATED & ~E_STRICT' >> ~/.phpenv/versions/$(phpenv version-name)/etc/conf.d/travis.ini; fi
+  - composer require "simplesamlphp/simplesamlphp:${SIMPLESAMLPHP_VERSION}" --no-update
+  - composer update --no-interaction
+  - if [[ "$TRAVIS_PHP_VERSION" == "5.6" ]]; then composer require --dev php-coveralls/php-coveralls; fi
+  - if [[ "$TRAVIS_PHP_VERSION" == "7.3" ]]; then composer require --dev vimeo/psalm:1.1.9; fi
+
+script:
+  - bin/check-syntax.sh
+  - if [[ "$TRAVIS_PHP_VERSION" == "5.6" ]]; then php vendor/phpunit/phpunit/phpunit; else php vendor/phpunit/phpunit/phpunit --no-coverage; fi
+  - if [[ "$TRAVIS_PHP_VERSION" == "7.3" ]]; then vendor/bin/psalm; fi
 
-script: php vendor/phpunit/phpunit/phpunit
+after_success:
+  - if [[ "$TRAVIS_PHP_VERSION" == "5.6" ]]; then php vendor/bin/php-coveralls -v; fi
 

bin/check-syntax.sh

@@ -0,0 +1,15 @@
+#!/usr/bin/env bash
+
+PHP='/usr/bin/env php'
+RETURN=0
+
+# check PHP files
+for FILE in `find config-templates hooks lib templates tests www -name "*.php"`; do
+    $PHP -l $FILE > /dev/null 2>&1
+    if [ $? -ne 0 ]; then
+        echo "Syntax check failed for ${FILE}"
+        RETURN=`expr ${RETURN} + 1`
+    fi
+done
+
+exit $RETURN

composer.json

@@ -10,13 +10,20 @@
 			"homepage": "http://orcid.org/0000-0002-9388-8592"
         }
     ],
+    "abandoned": "simplesamlphp/simplesamlphp-module-fticks",
+    "config": {
+        "preferred-install": {
+            "simplesamlphp/simplesamlphp": "source",
+            "*": "dist"
+        }
+    },
     "require": {
         "php": ">=5.6",
         "simplesamlphp/composer-module-installer": "~1.1"
     },
     "require-dev": {
         "simplesamlphp/simplesamlphp": ">=1.17",
-        "phpunit/phpunit": "~4.8"
+        "phpunit/phpunit": "~5.7"
     },
     "autoload": {
         "psr-4": {
@@ -33,4 +40,3 @@
         "source": "https://github.com/simplesamlphp/simplesamlphp-module-fticks"
     }
 }
-

lib/Auth/Process/Fticks.php

@@ -54,16 +54,16 @@ private function log($msg)
             /* local syslog call, avoiding SimpleSAMLphp's wrapping */
             case 'local':
             case 'syslog':
-                assert('array_key_exists("processname", $this->logconfig)');
-                assert('array_key_exists("facility", $this->logconfig)');
+                assert(array_key_exists("processname", $this->logconfig));
+                assert(array_key_exists("facility", $this->logconfig));
                 openlog($this->logconfig['processname'], LOG_PID, $this->logconfig['facility']);
                 syslog(array_key_exists('priority', $this->logconfig) ? $this->logconfig['priority'] : LOG_INFO, $msg);
                 break;
 
             /* remote syslog call via UDP */
             case 'remote':
-                assert('array_key_exists("processname", $this->logconfig)');
-                assert('array_key_exists("facility", $this->logconfig)');
+                assert(array_key_exists("processname", $this->logconfig));
+                assert(array_key_exists("facility", $this->logconfig));
                 /* assemble a syslog message per RFC 5424 */
                 $rfc5424_message = sprintf(
                     '<%d>',
@@ -118,7 +118,7 @@ private function generatePNhash(&$state)
     {
         /* get a user id */
         if ($this->userId !== false) {
-            assert('array_key_exists("Attributes", $state)');
+            assert(array_key_exists("Attributes", $state));
             if (array_key_exists($this->userId, $state['Attributes'])) {
                 if (is_array($state['Attributes'][$this->userId])) {
                     $uid = $state['Attributes'][$this->userId][0];
@@ -169,7 +169,7 @@ private function escapeFticks($value)
      */
     public function __construct($config, $reserved)
     {
-        assert('is_array($config)');
+        assert(is_array($config));
         parent::__construct($config, $reserved);
 
         if (array_key_exists('federation', $config)) {
@@ -271,11 +271,11 @@ public function __construct($config, $reserved)
      */
     public function process(&$state)
     {
-        assert('is_array($state)');
-        assert('array_key_exists("Destination", $state)');
-        assert('array_key_exists("entityid", $state["Destination"])');
-        assert('array_key_exists("Source", $state)');
-        assert('array_key_exists("entityid", $state["Source"])');
+        assert(is_array($state));
+        assert(array_key_exists("Destination", $state));
+        assert(array_key_exists("entityid", $state["Destination"]));
+        assert(array_key_exists("Source", $state));
+        assert(array_key_exists("entityid", $state["Source"]));
 
         $fticks = [];
 
@@ -319,7 +319,7 @@ public function process(&$state)
 
         /* realm */
         if ($this->realm !== false) {
-            assert('array_key_exists("Attributes", $state)');
+            assert(array_key_exists("Attributes", $state));
             if (array_key_exists($this->realm, $state['Attributes'])) {
                 if (is_array($state['Attributes'][$this->realm])) {
                     $fticks['REALM'] = $state['Attributes'][$this->realm][0];

phpunit.xml

@@ -1,13 +1,25 @@
 <?xml version="1.0" encoding="utf-8" ?>
-<phpunit bootstrap="tests/bootstrap.php" colors="true">
+<phpunit backupGlobals="false"
+         backupStaticAttributes="false"
+         colors="true"
+         convertErrorsToExceptions="true"
+         convertNoticesToExceptions="true"
+         convertWarningsToExceptions="true"
+         processIsolation="false"
+         stopOnFailure="false"
+         bootstrap="./tests/bootstrap.php">
     <testsuites>
-        <testsuite name="The project's test suite">
-            <directory>tests/</directory>
+        <testsuite name="Unit Tests">
+            <directory>./tests/</directory>
         </testsuite>
     </testsuites>
     <filter>
         <whitelist processUncoveredFilesFromWhitelist="true">
             <directory suffix=".php">./lib</directory>
+            <exclude>
+                <directory>./vendor/</directory>
+                <directory>./tests/</directory>
+            </exclude>
         </whitelist>
     </filter>
     <logging>

psalm.xml

@@ -0,0 +1,33 @@
+<?xml version="1.0"?>
+<psalm
+    name="SimpleSAMLphp module"
+    useDocblockTypes="true"
+    totallyTyped="false"
+>
+    <projectFiles>
+        <directory name="lib" />
+        <ignoreFiles>
+            <directory name="vendor" />
+        </ignoreFiles>
+    </projectFiles>
+
+    <issueHandlers>
+        <LessSpecificReturnType errorLevel="info" />
+
+        <!-- level 3 issues - slightly lazy code writing, but probably low false-negatives -->
+        <DeprecatedMethod errorLevel="info" />
+
+        <MissingClosureReturnType errorLevel="info" />
+        <MissingReturnType errorLevel="info" />
+        <MissingPropertyType errorLevel="info" />
+        <InvalidDocblock errorLevel="info" />
+        <MisplacedRequiredParam errorLevel="info" />
+
+        <PropertyNotSetInConstructor errorLevel="info" />
+        <MissingConstructor errorLevel="info" />
+        <MissingClosureParamType errorLevel="info" />
+        <MissingParamType errorLevel="info" />
+        <UnusedClass errorLevel="info" />
+        <PossiblyUnusedMethod errorLevel="info" />
+    </issueHandlers>
+</psalm>

tests/bootstrap.php

@@ -3,7 +3,7 @@
 require_once($projectRoot.'/vendor/autoload.php');
 
 // Symlink module into ssp vendor lib so that templates and urls can resolve correctly
-$linkPath = $projectRoot.'/vendor/simplesamlphp/simplesamlphp/modules/consent';
+$linkPath = $projectRoot.'/vendor/simplesamlphp/simplesamlphp/modules/fticks';
 if (file_exists($linkPath) === false) {
     echo "Linking '$linkPath' to '$projectRoot'\n";
     symlink($projectRoot, $linkPath);

tests/lib/Auth/Process/FticksTest.php

@@ -2,9 +2,6 @@
 
 namespace SimpleSAML\Test\Module\fticks\Auth\Process;
 
-/**
- * Test for the core:CardinalitySingle filter.
- */
 class FticksTest extends \PHPUnit_Framework_TestCase
 {
     /** @var array minimal request */