Merge pull request #20 from monkeyiq/2025/sep/soap-update

update test suite to using SOAP messages

Author: monkeyiq

composer.json

@@ -46,6 +46,7 @@
     },
     "require-dev": {
         "beste/clock": "~3.0.0",
+        "mockery/mockery": "~1.6.12",
         "simplesamlphp/simplesamlphp-test-framework": "~1.9.3"
     },
     "support": {

src/Controller/AttributeServer.php

@@ -5,11 +5,10 @@
 namespace SimpleSAML\Module\exampleattributeserver\Controller;
 
 use DateInterval;
-use Nyholm\Psr7\Factory\Psr17Factory;
+use Nyholm\Psr7\ServerRequest;
 use SimpleSAML\{Configuration, Error, Logger};
 use SimpleSAML\HTTP\RunnableResponse;
 use SimpleSAML\Metadata\MetaDataStorageHandler;
-use SimpleSAML\SAML2\Binding;
 use SimpleSAML\SAML2\Binding\{SynchronousBindingInterface, SOAP};
 use SimpleSAML\SAML2\Constants as C;
 use SimpleSAML\SAML2\Utils as SAML2_Utils;
@@ -34,7 +33,6 @@
 use SimpleSAML\XMLSecurity\XML\ds\{KeyInfo, X509Certificate, X509Data};
 use SimpleSAML\XMLSecurity\XML\SignableElementInterface;
 use Symfony\Bridge\PsrHttpMessage\Factory\{HttpFoundationFactory, PsrHttpFactory};
-use Symfony\Component\HttpFoundation\Request;
 
 use function array_filter;
 
@@ -77,27 +75,14 @@ public function setMetadataStorageHandler(MetaDataStorageHandler $handler): void
 
 
     /**
-     * @param \Symfony\Component\HttpFoundation\Request $request The current request.
+     * @param \Nyholm\Psr7\ServerRequest $request The current request.
      *
      * @return \SimpleSAML\HTTP\RunnableResponse
      * @throws \SimpleSAML\Error\BadRequest
      */
-    public function main(/** @scrutinizer ignore-unused */ Request $request): RunnableResponse
+    public function main(/** @scrutinizer ignore-unused */ SOAP $soap, ServerRequest $request): RunnableResponse
     {
-        $psr17Factory = new Psr17Factory();
-        $psrHttpFactory = new PsrHttpFactory($psr17Factory, $psr17Factory, $psr17Factory, $psr17Factory);
-        $psrRequest = $psrHttpFactory->createRequest($request);
-
-        $binding = Binding::getCurrentBinding($psrRequest);
-        if (!($binding instanceof SynchronousBindingInterface)) {
-            throw new Error\BadRequest('Invalid binding; MUST use a synchronous binding.');
-        }
-
-        $message = $binding->receive($psrRequest);
-        if (!($message instanceof AttributeQuery)) {
-            throw new Error\BadRequest('Invalid message received to AttributeQuery endpoint.');
-        }
-
+        $message = $soap->receive($request);
         $idpEntityId = $this->metadataHandler->getMetaDataCurrentEntityID('saml20-idp-hosted');
 
         $issuer = $message->getIssuer();

tests/src/Controller/AttributeServerTest.php

@@ -4,22 +4,23 @@
 
 namespace SimpleSAML\Test\Module\exampleattributeserver\Controller;
 
+use Mockery\Adapter\Phpunit\MockeryTestCase;
+use Nyholm\Psr7\ServerRequest;
 use PHPUnit\Framework\Attributes\CoversClass;
-use PHPUnit\Framework\TestCase;
 use SimpleSAML\Configuration;
 use SimpleSAML\HTTP\RunnableResponse;
 use SimpleSAML\Metadata\MetaDataStorageHandler;
 use SimpleSAML\Module\exampleattributeserver\Controller\AttributeServer;
+use SimpleSAML\SAML2\Binding\SOAP;
 use SimpleSAML\XMLSecurity\TestUtils\PEMCertificatesMock;
-use Symfony\Component\HttpFoundation\Request;
 
 /**
  * Set of tests for the controllers in the "exampleattributeserver" module.
  *
  * @package simplesamlphp/simplesamlphp-module-exampleattributeserver
  */
 #[CoversClass(AttributeServer::class)]
-class ExampleAttributeServerTest extends TestCase
+class ExampleAttributeServerTest extends MockeryTestCase
 {
     /** @var \SimpleSAML\Configuration */
     protected static Configuration $config;
@@ -52,9 +53,22 @@ public static function setUpBeforeClass(): void
      */
     public function testMain(): void
     {
-        $_SERVER['REQUEST_URI'] = '/module.php/exampleattributeserver/attributeserver';
-        $_SERVER['HTTP_HOST'] = 'example.org';
-        $request = Request::createFromGlobals();
+        $soap = $this->getStubWithInput(<<<SOAP
+<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
+  <SOAP-ENV:Body>
+          <samlp:AttributeQuery xmlns:samlp="urn:oasis:names:tc:SAML:2.0:protocol" xmlns:saml="urn:oasis:names:tc:SAML:2.0:assertion" ID="aaf23196-1773-2113-474a-fe114412ab72" Version="2.0" IssueInstant="2017-09-06T11:49:27Z">
+            <saml:Issuer Format="urn:oasis:names:tc:SAML:2.0:nameid-format:entity">https://example.org/</saml:Issuer>
+            <saml:Subject>
+              <saml:NameID Format="urn:oasis:names:tc:SAML:2.0:nameid-format:unspecified">urn:example:subject</saml:NameID>
+            </saml:Subject>
+            <saml:Attribute Name="urn:oid:1.3.6.1.4.1.5923.1.1.1.7" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:uri" FriendlyName="entitlements"/>
+            <saml:Attribute Name="urn:oid:2.5.4.4" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:uri" FriendlyName="sn"/>
+            <saml:Attribute Name="urn:oid:2.16.840.1.113730.3.1.39" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:uri" FriendlyName="preferredLanguage"/>
+          </samlp:AttributeQuery>
+  </SOAP-ENV:Body>
+</SOAP-ENV:Envelope>
+SOAP);
+
 
         $mdh = $this->createMock(MetaDataStorageHandler::class);
         $mdh->method('getMetaDataCurrentEntityID')->willReturn('https://example.org/');
@@ -67,9 +81,23 @@ public function testMain(): void
 
         $c = new AttributeServer(self::$config);
         $c->setMetadataStorageHandler($mdh);
-        $response = $c->main($request);
+
+        $request = new ServerRequest('', '');
+        $response = $c->main($soap, $request);
 
         $this->assertInstanceOf(RunnableResponse::class, $response);
         $this->assertTrue($response->isSuccessful());
     }
+
+    /**
+     * @return \SimpleSAML\SAML2\Binding\SOAP
+     */
+    private function getStubWithInput($input): SOAP
+    {
+        $stub = $this->getMockBuilder(SOAP::class)->onlyMethods(['getInputStream'])->getMock();
+        $stub->expects($this->once())
+             ->method('getInputStream')
+             ->willReturn($input);
+        return $stub;
+    }
 }