chore: Use conventional commits

* prepare CI
* fix ECS bugs

Author: vyskocilpavel

.github/workflows/build_and_check.yml

@@ -0,0 +1,51 @@
+# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+
+name: CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        php-version: [7.4, 8.0]
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Cache Composer dependencies
+        uses: actions/cache@v2
+        with:
+          path: /tmp/composer-cache
+          key: ${{ runner.os }}-${{ hashFiles('**/composer.lock') }}
+      - name: Install dependencies
+        uses: php-actions/composer@v5
+        with:
+          php_version: ${{ matrix.php-version }}
+          version: 2
+          php_extensions: json
+      - name: Run easy coding standard
+        run: vendor/bin/ecs check
+  release:
+    name: Release
+    needs: [build]
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - name: Setup Node.js
+        uses: actions/setup-node@v1
+        with:
+          node-version: 14
+      - name: Release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: npm install && npx semantic-release

.releaserc

@@ -0,0 +1,13 @@
+{
+  "branches": ["master"],
+  "plugins": [
+    "@semantic-release/commit-analyzer",
+    "@semantic-release/release-notes-generator",
+    "@semantic-release/changelog",
+    "@semantic-release/github",
+    ["@semantic-release/git", {
+      "assets": ["CHANGELOG.md"],
+      "message": "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
+    }]
+  ]
+}

README.md

@@ -1,14 +1,39 @@
 # perun-simplesamlphp-module
 [![Latest Stable Version](https://poser.pugx.org/cesnet/simplesamlphp-module-perun/v/stable)](https://packagist.org/packages/cesnet/simplesamlphp-module-perun)
 [![Latest Unstable Version](https://poser.pugx.org/cesnet/simplesamlphp-module-perun/v/unstable)](https://packagist.org/packages/cesnet/simplesamlphp-module-perun)
-[![CodeFactor](https://www.codefactor.io/repository/github/cesnet/perun-simplesamlphp-module/badge)](https://www.codefactor.io/repository/github/cesnet/perun-simplesamlphp-module)
+[![Build and CI](https://github.com/cesnet/simplesamlphp-module-perun/actions/workflows/build_and_test.yml/badge.svg)](https://github.com/cesnet/simplesamlphp-module-perun/actions/workflows/build_and_check.yml)
 [![License](https://poser.pugx.org/cesnet/simplesamlphp-module-perun/license)](https://packagist.org/packages/cesnet/simplesamlphp-module-perun)
 
 Module which allows simpleSAMLphp to get data from Perun.
 
+## Contribution
+
+This repository uses [Conventional Commits](https://www.npmjs.com/package/@commitlint/config-conventional).
+
+Any change that significantly changes behavior in a backward-incompatible way or requires a configuration change must be marked as BREAKING CHANGE.
+
+### Available scopes:
+* theme
+* Auth Process filters:
+    * ensurevomember
+    * forceaup
+    * idpattribute
+    * logininfo
+    * perunattributes
+    * entitlement
+    * perunidentity
+    * targetedid
+    * proxyfilter
+    * removeallattributes
+    * idpentityid
+    * stringifytargetedid
+    * updateues
+    * warningtestsp
+* ...
 
-Once you have installed SimpleSAMLphp, installing this module is very simple. First of all, you will need to download Composer if you haven't already. After installing Composer, just execute the following command in the root of your SimpleSAMLphp installation:
 
 ## Instalation
 
+Once you have installed SimpleSAMLphp, installing this module is very simple. First, you will need to download Composer if you haven't already. After installing Composer, just execute the following command in the root of your SimpleSAMLphp installation:
+
 `php composer.phar require cesnet/simplesamlphp-module-perun:dev-master`

composer.json

@@ -25,7 +25,6 @@
     "require": {
         "simplesamlphp/simplesamlphp": "~1.17",
         "simplesamlphp/composer-module-installer": "~1.0",
-        "cesnet/simplesamlphp-module-perunauthorize": "~2.0",
         "cesnet/simplesamlphp-module-chartjs": "~2.8.0",
         "symfony/var-exporter": "^5.0",
         "phpseclib/phpseclib": "~3.0",
@@ -37,5 +36,8 @@
         "web-token/jwt-signature": "^2.2",
         "web-token/jwt-signature-algorithm-rsa": "^2.2",
         "web-token/jwt-checker": "^2.2"
+    },
+    "require-dev": {
+        "symplify/easy-coding-standard": "^9.2"
     }
 }

config-templates/challenges_config.php

@@ -1,6 +1,8 @@
 <?php
 
-$config = array(
+declare(strict_types=1);
+
+$config = [
     /**
      * Path to public key
      */
@@ -25,4 +27,4 @@
      * Challenge length
      */
     'challengeLength' => 64,
-);
+];

config-templates/module_discopower.php

@@ -1,10 +1,12 @@
 <?php
+
+declare(strict_types=1);
+
 /**
  * Configuration for the DiscoPower module.
  */
 
 $config = [
-
     // Which tab should be set as default. 0 is the first tab
     'defaulttab' => 0,
 
@@ -41,5 +43,4 @@
      * Example: 'cdc.lifetime' => 180*24*60*60, // 180 days
      */
     'cdc.lifetime' => null,
-
 ];

config-templates/module_perun.php

@@ -1,14 +1,14 @@
 <?php
 
+declare(strict_types=1);
+
 /**
- * This is example configuration of SimpleSAMLphp Perun interface and additional features.
- * Copy this file to default config directory and edit the properties.
+ * This is example configuration of SimpleSAMLphp Perun interface and additional features. Copy this file to default
+ * config directory and edit the properties.
  *
- * copy command (from SimpleSAML base dir)
- * cp modules/perun/module_perun.php config/
+ * copy command (from SimpleSAML base dir) cp modules/perun/module_perun.php config/
  */
 $config = [
-
     /**
      * base url to rpc with slash at the end.
      */
@@ -39,38 +39,33 @@
     //'ldap.password' => 'password'
 
     /**
-     * Whether to use startTLS on port 389. Defaults to false.
-     * SSL/TLS is always used for ldaps: regardless of this setting.
+     * Whether to use startTLS on port 389. Defaults to false. SSL/TLS is always used for ldaps: regardless of this
+     * setting.
      */
     //'ldap.enable_tls' => true,
 
     /**
      * Perun group name to eduPersonEntitlement mapping. Mapping is according to the spec in
-     *      https://aarc-project.eu/wp-content/uploads/2017/11/AARC-JRA1.4A-201710.pdf
-     * groupNameAARC - enable group naming according to AARC spec globally,
-     *      every SP can overide it with groupMapping option
-     * entitlementPrefix - prefix put in front of the Perun entitlement, do not forget to add ':' at the end
-     * entitlementAuthority - name of the authority issuing the entitlement
+     * https://aarc-project.eu/wp-content/uploads/2017/11/AARC-JRA1.4A-201710.pdf groupNameAARC - enable group naming
+     * according to AARC spec globally, every SP can overide it with groupMapping option entitlementPrefix - prefix put
+     * in front of the Perun entitlement, do not forget to add ':' at the end entitlementAuthority - name of the
+     * authority issuing the entitlement
      */
-    'groupNameAARC' => true/false,
+    'groupNameAARC' => true / false,
     'entitlementPrefix' => 'prefix',
     'entitlementAuthority' => 'authority',
 
     /**
-     * specify which type of IdPListService will be used
-     * Expected values: csv, db
+     * specify which type of IdPListService will be used Expected values: csv, db
      */
     'idpListServiceType' => '',
 
     /**
-     *****************************************
      * Part of configuration for status page *
-     *****************************************
      */
 
     /**
-     * Specify the used interface to get the status data
-     * Only NAGIOS type is now allowed
+     * Specify the used interface to get the status data Only NAGIOS type is now allowed
      */
     'status.type' => 'NAGIOS',
 
@@ -99,28 +94,24 @@
     /**
      * Specify, if the peer verification is enabled,
      *
-     * OPTIONAL
-     * Default: false
+     * OPTIONAL Default: false
      */
     'status.nagios.peer_verification' => false,
 
     /**
      * Specify the list of services, which will be shown
      *
-     * OPTIONAL
-     * Default: show all received services
+     * OPTIONAL Default: show all received services
      */
     'status.shown_services' => [
         'serviceIdentifier' => [
             'name' => 'serviceName',
-            'description' => 'serviceDescription'
+            'description' => 'serviceDescription',
         ],
     ],
 
     /**
-     ****************************************
      * Part of configuration for listOfSps  *
-     ****************************************
      */
 
     /**
@@ -171,21 +162,16 @@
     /**
      * Specify list of facility attributes, which will be shown
      */
-    'listOfSps.attributesDefinitions' => [
-        ''
-    ],
+    'listOfSps.attributesDefinitions' => [''],
 
     /**
-     * Specify list of facility attributes which have translations.
-     * If an attribute is not included in listOfSps.attributesDefinitions, it will be added.
-     * Defaults to an empty array.
+     * Specify list of facility attributes which have translations. If an attribute is not included in
+     * listOfSps.attributesDefinitions, it will be added. Defaults to an empty array.
      */
     //'listOfSps.multilingualAttributes' => [],
 
     /**
-     ********************************************
      * Part of configuration for DS  *
-     ********************************************
      */
 
     'wayf_config' => [
@@ -199,8 +185,8 @@
          */
         'translate_module' => 'disco',
         /**
-         * Specify prefix for filtering AuthnContextClassRef
-         * All AuthnContextClassRef values starts with this prefix will be removed before the request will be send to IdP
+         * Specify prefix for filtering AuthnContextClassRef All AuthnContextClassRef values starts with this prefix
+         * will be removed before the request will be send to IdP
          */
         'remove_authn_context_class_ref_prefixes' => ['urn:cesnet:proxyidp:'],
         /**
@@ -211,31 +197,30 @@
             'email' => '[email protected]',
         ],
         /**
-         * Warning configuration
-         * The configuration can be loaded from file, url or directly from this config. All possibilities has to follow
-         * the structure under the "config" key.
+         * Warning configuration The configuration can be loaded from file, url or directly from this config. All
+         * possibilities has to follow the structure under the "config" key.
          */
         'warning_config' => [
             # IF SOURCE === FILE
-#            'file' => '/etc/perun/simplesamlphp/elixir/config/warning.php',
+            #            'file' => '/etc/perun/simplesamlphp/elixir/config/warning.php',
             # IF SOURCE === URL
-#            'url' => 'https://test.com',
+            #            'url' => 'https://test.com',
             # IF SOURCE === CONFIG
             'config' => [
-                'enabled' => FALSE,
+                'enabled' => false,
                 'type' => 'INFO',
                 'title' => [
                     'en' => 'Sample text',
-                    'cs' => 'ukázkový text'
+                    'cs' => 'ukázkový text',
                 ],
                 'text' => [
                     'en' => 'Sample warning text',
                     'cs' => 'ukázkový text',
-                ]
+                ],
             ],
         ],
         // enable box shaodw around the wrap element
-        'boxed' => TRUE,
+        'boxed' => true,
         // block of IDPs
         'idp_blocks_config' => [
             [
@@ -244,7 +229,7 @@
                 // name that will be used in some classes and translation keys
                 'name' => 'eduGAIN',
                 //enable displaying of the texts
-                'text_enabled' => TRUE,
+                'text_enabled' => true,
                 /* Translation for the hint above the entry. Leave out option to disable it if text_enabled is true
                 'hint_translation' => [
                     'en' => 'You can log in using your institutional account or another account you have on the web (e.g. Apple).',
@@ -264,7 +249,7 @@
             [
                 'type' => 'tagged',
                 'name' => 'social_idps',
-                'text_enabled' => FALSE,
+                'text_enabled' => false,
                 //tags to include in the list
                 'tags' => ['social'],
                 // specific IDP entity IDs to include in the list
@@ -276,7 +261,7 @@
     'warning_test_sp_config' => [
         'header' => [
             'en' => '<h3>Warning - service in test environment</h3>',
-            'cs' => '<h3>Varování - testovací služba</h3>'
+            'cs' => '<h3>Varování - testovací služba</h3>',
         ],
         'text' => [
             'en' => '<p>Service is in the test environment.<br class="spacer"/>Hit the continue button.</p>',