SSP-2066_add_routes_and_controllers

README.md

@@ -88,18 +88,20 @@ To explore the module using docker run the below command. This will run an SSP i
 of the `casserver` module mounted in the container, along with some configuration files. Any code changes you make to your git checkout are
 "live" in the container, allowing you to test and iterate different things.
 
+Sometimes when working with a dev version of the module you will need a newer version of a dependency than what SSP is
+locked to. In that case you can add an additional dependency to the `COMPOSER_REQUIRE` line (e.g ="simplesamlphp/assert:1.8 ")
+
 ```bash
-# Note: this currently errors on this module requiring a newer version of `simplesamlphp/xml-common` than what is in the base image
 docker run --name ssp-casserver-dev \
    --mount type=bind,source="$(pwd)",target=/var/simplesamlphp/staging-modules/casserver,readonly \
   -e STAGINGCOMPOSERREPOS=casserver \
-  -e COMPOSER_REQUIRE="simplesamlphp/simplesamlphp-module-casserver:@dev simplesamlphp/simplesamlphp-module-preprodwarning"
+  -e COMPOSER_REQUIRE="simplesamlphp/simplesamlphp-module-casserver:@dev simplesamlphp/simplesamlphp-module-preprodwarning" \
   -e SSP_ADMIN_PASSWORD=secret1 \
   --mount type=bind,source="$(pwd)/docker/ssp/module_casserver.php",target=/var/simplesamlphp/config/module_casserver.php,readonly \
   --mount type=bind,source="$(pwd)/docker/ssp/authsources.php",target=/var/simplesamlphp/config/authsources.php,readonly \
   --mount type=bind,source="$(pwd)/docker/ssp/config-override.php",target=/var/simplesamlphp/config/config-override.php,readonly \
   --mount type=bind,source="$(pwd)/docker/apache-override.cf",target=/etc/apache2/sites-enabled/ssp-override.cf,readonly \
-   -p 443:443 cirrusid/simplesamlphp:v2.3.2
+   -p 443:443 cirrusid/simplesamlphp:v2.3.5
 ```
 
 Visit [https://localhost/simplesaml/](https://localhost/simplesaml/) and confirm you get the default page.

composer.json

@@ -30,38 +30,48 @@
     },
     "require": {
         "php": "^8.1",
-        "ext-ctype": "*",
         "ext-dom": "*",
         "ext-filter": "*",
         "ext-libxml": "*",
         "ext-SimpleXML": "*",
+        "ext-session": "*",
+
         "simplesamlphp/assert": "^1.1",
         "simplesamlphp/composer-module-installer": "^1.3",
-        "simplesamlphp/simplesamlphp": "^2.2",
-        "simplesamlphp/xml-cas": "^v1.3",
-        "simplesamlphp/xml-common": "^v1.17",
-        "simplesamlphp/xml-soap": "^v1.5"
+        "simplesamlphp/simplesamlphp": "^2.3",
+        "simplesamlphp/xml-cas": "^1.3",
+        "simplesamlphp/xml-common": "^1.17",
+        "simplesamlphp/xml-soap": "^1.5",
+        "symfony/http-foundation": "^6.4",
+        "symfony/http-kernel": "^6.4",
+        "simplesamlphp/saml11": "~1.2.4"
     },
     "require-dev": {
         "simplesamlphp/simplesamlphp-test-framework": "^1.7",
         "phpunit/phpunit": "^10",
         "psalm/plugin-phpunit": "^0.19.0",
-        "squizlabs/php_codesniffer": "^3.7"
+        "squizlabs/php_codesniffer": "^3.7",
+        "maglnet/composer-require-checker": "4.7.1",
+        "vimeo/psalm": "^5",
+        "icanhazstring/composer-unused": "^0.8.11"
     },
     "support": {
         "issues": "https://github.com/simplesamlphp/simplesamlphp-module-casserver/issues",
         "source": "https://github.com/simplesamlphp/simplesamlphp-module-casserver"
     },
-    "suggest": {
-        "ext-pdo": "*"
-    },
     "scripts": {
         "validate": [
             "vendor/bin/phpunit --no-coverage --testdox",
-            "vendor/bin/phpcs -p"
+            "vendor/bin/phpcs -p",
+            "vendor/bin/composer-require-checker check --config-file=tools/composer-require-checker.json composer.json",
+            "vendor/bin/psalm -c psalm-dev.xml",
+            "vendor/bin/composer-unused"
         ],
         "tests": [
             "vendor/bin/phpunit --no-coverage"
+        ],
+        "propose-fix": [
+            "vendor/bin/phpcs --report=diff"
         ]
     }
 }

config/module_casserver.php.dist

@@ -26,10 +26,13 @@ $config = [
         'https://host2.domain:5678/path2/path3',
         // So is regex
         '|^https://.*\.domain.com/|',
-        // Some configuration options can be overridden
+        // ONLY the FOLLOWING configuration options can be overridden. See OverrideConfigPropertiesEnum.
         'https://override.example.com' => [
             'attrname' => 'uid',
             'attributes_to_transfer' => ['cn'],
+            //'attributes' => false,
+            //'authproc' => [],
+            //'service_ticket_expire_time' => 5,
         ],
     ],
 

phpunit.xml

@@ -4,6 +4,7 @@
          bootstrap="tests/bootstrap.php"
          xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.5/phpunit.xsd"
          backupGlobals="false"
+         displayDetailsOnTestsThatTriggerWarnings="true"
          cacheDirectory=".phpunit.cache">
   <coverage>
     <report>

psalm-dev.xml

@@ -3,6 +3,10 @@
     name="SimpleSAMLphp testsuite"
     useDocblockTypes="true"
     errorLevel="4"
+    resolveFromConfigFile="true"
+    autoloader="vendor/autoload.php"
+    findUnusedCode="false"
+    findUnusedBaselineEntry="true"
     reportMixedIssues="false"
     hideExternalErrors="true"
     allowStringToStandInForClass="true"

psalm.xml

@@ -4,10 +4,15 @@
     useDocblockTypes="true"
     errorLevel="2"
     reportMixedIssues="false"
+    resolveFromConfigFile="true"
+    autoloader="vendor/autoload.php"
+    findUnusedCode="false"
+    findUnusedBaselineEntry="true"
+    hideExternalErrors="true"
+    allowStringToStandInForClass="true"
 >
     <projectFiles>
         <directory name="config" />
-        <directory name="public" />
         <directory name="src" />
     </projectFiles>