Enhance test-suite (#31)

Modernize testsuite

Author: tvdijen

.travis.yml

@@ -1,27 +1,124 @@
 language: php
 
+stages:
+  - pre-conditions
+  - test
+  - quality
+
+################
+#  Test stage  #
+################
+
 php:
-    - '7.2'
+  - 7.2
+  - 7.3
+  - 7.4
 
-sudo: false
+env:
+  - COMMAND="composer install"
+  - COMMAND="composer update"
 
-cache:
-    directories:
-        - $HOME/.composer/cache
+before_script:
+  - ${COMMAND}
 
+script:
+  - php vendor/bin/phpunit --no-coverage
 
-before_install:
-    - composer self-update
+jobs:
+  fast_finish: true
 
-install:
-    - composer install --dev --no-progress --no-suggest --ansi
+  allow_failures:
+    - php: 7.3
+      env: Security check (composer install)
+    - php: 7.3
+      env: Security check (composer update)
+    - php: 7.3
+      env: Psalm
+    - php: 7.3
+      env: PHP Codesniffer
 
-script:
-    - mkdir -p build/logs
-    - mkdir -p build/cov
-    - ./vendor/bin/phpspec run --no-interaction -f dot
-    - ./vendor/bin/phpunit
-    - ./vendor/bin/phpcov merge --clover build/logs/clover.xml build/cov
-
-after_success:
-    - travis_retry php vendor/bin/php-coveralls
+  include:
+
+    ##########################
+    #  Pre-conditions stage  #
+    ##########################
+
+    - stage: pre-conditions
+      env: Syntax check PHP
+      php: 7.2
+      before_script:
+        - composer install
+      script:
+        - vendor/bin/check-syntax-php.sh
+
+    - stage: pre-conditions
+      env: Syntax check PHP
+      php: 7.3
+      before_script:
+        - composer install
+      script:
+        - vendor/bin/check-syntax-php.sh
+
+    - stage: pre-conditions
+      env: Syntax check PHP
+      php: 7.4
+      before_script:
+        - composer install
+      script:
+        - vendor/bin/check-syntax-php.sh
+
+    - stage: pre-conditions
+      env: Syntax check YAML / XML / JSON
+      before_script:
+        - composer require simplesamlphp/simplesamlphp-test-framework --dev
+      script:
+        - vendor/simplesamlphp/simplesamlphp-test-framework/bin/check-syntax-json.sh
+        - vendor/simplesamlphp/simplesamlphp-test-framework/bin/check-syntax-xml.sh
+        - vendor/simplesamlphp/simplesamlphp-test-framework/bin/check-syntax-yaml.sh
+
+    ###################
+    #  Quality stage  #
+    ###################
+
+    - stage: quality
+      php: 7.3
+      env: Security check (composer install)
+      before_script:
+        - composer install
+      script:
+        - vendor/bin/security-checker security:check
+
+    - stage: quality
+      php: 7.3
+      env: Security check (composer update)
+      before_script:
+        - composer update
+      script:
+        - vendor/bin/security-checker security:check
+
+    - stage: quality
+      php: 7.3
+      env: Coveralls
+      before_script:
+        - composer update
+        - php vendor/bin/phpunit
+      script:
+        - php vendor/bin/php-coveralls
+#        - bash <(curl -s https://codecov.io/bash)
+
+    - stage: quality
+      php: 7.3
+      env: Psalm
+      before_script:
+        - composer update
+      script:
+        - vendor/bin/psalm
+        - vendor/bin/psalter --issues=UnnecessaryVarAnnotation --dry-run
+
+    - stage: quality
+      php: 7.3
+      env: PHP Codesniffer
+      before_script:
+        - composer update
+      script:
+        - vendor/bin/phpcs

README.md

@@ -5,7 +5,7 @@ This module adds support for the OpenID Connect protocol through a SimpleSAMLphp
 
 [![Build Status](https://travis-ci.org/rediris-es/simplesamlphp-module-oidc.svg?branch=master)](https://travis-ci.org/rediris-es/simplesamlphp-module-oidc) 
 [![Coverage Status](https://coveralls.io/repos/github/rediris-es/simplesamlphp-module-oidc/badge.svg?branch=master)](https://coveralls.io/github/rediris-es/simplesamlphp-module-oidc?branch=master)
-[![SimpleSAMLphp](https://img.shields.io/badge/simplesamlphp-1.15-red.svg)](https://simplesamlphp.org/)
+[![SimpleSAMLphp](https://img.shields.io/badge/simplesamlphp-1.18-red.svg)](https://simplesamlphp.org/)
 
 ![Main screen capture](docs/oidc.png)
 

composer.json

@@ -31,11 +31,12 @@
         "friendsofphp/php-cs-fixer": "^2.10",
         "friends-of-phpspec/phpspec-code-coverage": "^4.3",
         "php-coveralls/php-coveralls": "^2.0",
-        "phpspec/phpspec": "^4.3",
+        "phpspec/phpspec": "^6.1",
         "phpunit/php-code-coverage": "^6.0",
         "phpunit/phpcov": "^5.0",
         "phpunit/phpunit": "^7.0",
-        "simplesamlphp/simplesamlphp": "^1.18"
+        "simplesamlphp/simplesamlphp": "^1.18",
+        "simplesamlphp/simplesamlphp-test-framework": "^0.1.0"
     },
     "config": {
         "preferred-install": {

config-template/module_oidc.php renamed to config-templates/module_oidc.php

@@ -12,6 +12,11 @@
  * file that was distributed with this source code.
  */
 
+
+/**
+ * @param array &$croninfo
+ * @return void
+ */
 function oidc_hook_cron(&$croninfo)
 {
     assert('is_array($croninfo)');

hooks/hook_cron.php

@@ -12,6 +12,10 @@
  * file that was distributed with this source code.
  */
 
+/**
+ * @param array &$links
+ * @return void
+ */
 function oidc_hook_frontpage(&$links)
 {
     assert('is_array($links)');

hooks/hook_frontpage.php

@@ -94,7 +94,7 @@ class ClaimTranslatorExtractor extends ClaimExtractor
      *
      * @throws \OpenIDConnectServer\Exception\InvalidArgumentException
      */
-    public function __construct($claimSets = [], $translationTable = [])
+    public function __construct(array $claimSets = [], array $translationTable = [])
     {
         $this->translationTable = array_merge($this->translationTable, $translationTable);
 
@@ -133,7 +133,7 @@ private function translateSamlAttributesToClaims($samlAttributes): array
      * @param array $samlAttributes
      * @return array
      */
-    public function extract(array $scopes, array $samlAttributes)
+    public function extract(array $scopes, array $samlAttributes): array
     {
         $claims = $this->translateSamlAttributesToClaims($samlAttributes);
 

lib/ClaimTranslatorExtractor.php

@@ -46,7 +46,7 @@ public function __construct(ClientRepository $clientRepository, TemplateFactory
      * @param \Zend\Diactoros\ServerRequest $request
      * @return \SimpleSAML\XHTML\Template
      */
-    public function __invoke(ServerRequest $request)
+    public function __invoke(ServerRequest $request): \SimpleSAML\XHTML\Template
     {
         $clients = $this->clientRepository->findAll();
 

lib/Controller/ClientIndexController.php

@@ -48,7 +48,7 @@ public function __construct(ClientRepository $clientRepository, SessionMessagesS
      * @param \Zend\Diactoros\ServerRequest $request
      * @return \Zend\Diactoros\Response\RedirectResponse
      */
-    public function __invoke(ServerRequest $request)
+    public function __invoke(ServerRequest $request): RedirectResponse
     {
         $client = $this->getClientFromRequest($request);
         $body = $request->getParsedBody();

lib/Controller/ClientResetSecretController.php

@@ -44,7 +44,7 @@ public function __construct(ClientRepository $clientRepository, TemplateFactory
      * @param \Zend\Diactoros\ServerRequest $request
      * @return \SimpleSAML\XHTML\Template
      */
-    public function __invoke(ServerRequest $request)
+    public function __invoke(ServerRequest $request): \SimpleSAML\XHTML\Template
     {
         $client = $this->getClientFromRequest($request);