AgreementMethodTest::testMarshallingElementOrdering() - Code Metrics - Inspection of "Implement missing xenc elements" - simplesamlphp/xml-security - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#57)

by Tim

created 2024-11-27 19:41 UTC

testMarshallingElementOrdering() A

↳ Parent: AgreementMethodTest

Complexity

Conditions	1
Paths	1

Size

Total Lines	70
Code Lines	40

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	40
c	1
b	0
f	0
nc	1
nop	0
dl	0
loc	70
rs	9.28

How to fix Long Method

<?php

declare(strict_types=1);

namespace SimpleSAML\XMLSecurity\Test\XML\xenc;

use PHPUnit\Framework\Attributes\CoversClass;
filter:
    dependency_paths: ["lib/*"]
use PHPUnit\Framework\TestCase;
use SimpleSAML\XML\Chunk;
use SimpleSAML\XML\DOMDocumentFactory;
use SimpleSAML\XML\TestUtils\SerializableElementTestTrait;
use SimpleSAML\XMLSecurity\Constants as C;
use SimpleSAML\XMLSecurity\TestUtils\PEMCertificatesMock;
use SimpleSAML\XMLSecurity\Utils\XPath;
use SimpleSAML\XMLSecurity\XML\ds\{KeyName, X509Certificate, X509Data, X509SubjectName};
use SimpleSAML\XMLSecurity\XML\xenc\{AbstractAgreementMethodType, AbstractXencElement};
use SimpleSAML\XMLSecurity\XML\xenc\{AgreementMethod, KANonce, OriginatorKeyInfo, RecipientKeyInfo};

use function dirname;
use function openssl_x509_parse;
use function str_replace;
use function strval;

/**
 * Class \SimpleSAML\XMLSecurity\Test\XML\xenc\AgreementMethodTest
 *
 * @package simplesamlphp/xml-security
 */
#[CoversClass(AbstractXencElement::class)]
#[CoversClass(AbstractAgreementMethodType::class)]
#[CoversClass(AgreementMethod::class)]
final class AgreementMethodTest extends TestCase
{
    use SerializableElementTestTrait;


    /** @var string */
    private static string $certificate;

    /** @var string[] */
    private static array $certData;


    /**
     */
    public function setUp(): void
    {
        self::$testedClass = AgreementMethod::class;

        self::$xmlRepresentation = DOMDocumentFactory::fromFile(
            dirname(__FILE__, 3) . '/resources/xml/xenc_AgreementMethod.xml',
        );

        self::$certificate = str_replace(
            [
                '-----BEGIN CERTIFICATE-----',
                '-----END CERTIFICATE-----',
                '-----BEGIN RSA PUBLIC KEY-----',
                '-----END RSA PUBLIC KEY-----',
                "\r\n",
                "\n",
            ],
            [
                '',
                '',
                '',
                '',
                "\n",
                '',
            ],
            PEMCertificatesMock::getPlainCertificate(PEMCertificatesMock::SELFSIGNED_CERTIFICATE),
        );

        self::$certData = openssl_x509_parse(
            PEMCertificatesMock::getPlainCertificate(PEMCertificatesMock::SELFSIGNED_CERTIFICATE),
        );
    }


    /**
     */
    public function testMarshalling(): void
    {
        $kaNonce = new KANonce('/CTj03d1DB5e2t7CTo9BEzCf5S9NRzwnBgZRlm32REI=');

        $someChunk = new Chunk(DOMDocumentFactory::fromString(
            '<ssp:Chunk xmlns:ssp="urn:x-simplesamlphp:namespace">some</ssp:Chunk>',
        )->documentElement);

        $originatorKeyInfo = new OriginatorKeyInfo(
            [
                new KeyName('testkey'),
                new X509Data(
                    [
                        new X509Certificate(self::$certificate),
                        new X509SubjectName(self::$certData['name']),
                    ],
                ),
                new Chunk(DOMDocumentFactory::fromString(
                    '<ssp:Chunk xmlns:ssp="urn:x-simplesamlphp:namespace">originator</ssp:Chunk>',
                )->documentElement),
            ],
            'fed123',
        );

        $recipientKeyInfo = new RecipientKeyInfo(
            [
                new KeyName('testkey'),
                new X509Data(
                    [
                        new X509Certificate(self::$certificate),
                        new X509SubjectName(self::$certData['name']),
                    ],
                ),
                new Chunk(DOMDocumentFactory::fromString(
                    '<ssp:Chunk xmlns:ssp="urn:x-simplesamlphp:namespace">recipient</ssp:Chunk>',
                )->documentElement),
            ],
            'fed654',
        );

        $agreementMethod = new AgreementMethod(
            C::XMLENC11_ECDH_ES,
            $kaNonce,
            $originatorKeyInfo,
            $recipientKeyInfo,
            [$someChunk],
        );

        $this->assertEquals(
            self::$xmlRepresentation->saveXML(self::$xmlRepresentation->documentElement),
            strval($agreementMethod),
        );
    }


    public function testMarshallingElementOrdering(): void
    {
        $kaNonce = new KANonce('/CTj03d1DB5e2t7CTo9BEzCf5S9NRzwnBgZRlm32REI=');

        $someChunk = new Chunk(DOMDocumentFactory::fromString(
            '<ssp:Chunk xmlns:ssp="urn:x-simplesamlphp:namespace">some</ssp:Chunk>',
        )->documentElement);

        $originatorKeyInfo = new OriginatorKeyInfo(
            [
                new KeyName('testkey'),
                new X509Data(
                    [
                        new X509Certificate(self::$certificate),
                        new X509SubjectName(self::$certData['name']),
                    ],
                ),
                new Chunk(DOMDocumentFactory::fromString(
                    '<ssp:Chunk xmlns:ssp="urn:x-simplesamlphp:namespace">originator</ssp:Chunk>',
                )->documentElement),
            ],
            'fed321',
        );

        $recipientKeyInfo = new RecipientKeyInfo(
            [
                new KeyName('testkey'),
                new X509Data(
                    [
                        new X509Certificate(self::$certificate),
                        new X509SubjectName(self::$certData['name']),
                    ],
                ),
                new Chunk(DOMDocumentFactory::fromString(
                    '<ssp:Chunk xmlns:ssp="urn:x-simplesamlphp:namespace">recipient</ssp:Chunk>',
                )->documentElement),
            ],
            'fed654',
        );

        $agreementMethod = new AgreementMethod(
            C::XMLENC11_ECDH_ES,
            $kaNonce,
            $originatorKeyInfo,
            $recipientKeyInfo,
            [$someChunk],
        );

        // Marshall it to a \DOMElement
        $agreementMethodElement = $agreementMethod->toXML();

        $xpCache = XPath::getXPath($agreementMethodElement);

        // Test for an KA-Nonce
        /** @var \DOMElement[] $kaNonceElements */
        $kaNonceElements = XPath::xpQuery($agreementMethodElement, './xenc:KA-Nonce', $xpCache);
        $this->assertCount(1, $kaNonceElements);

        // Test ordering of AgreementMethod contents
        /** @var \DOMElement[] $agreementMethodElements */
        $agreementMethodElements = XPath::xpQuery(
            $agreementMethodElement,
            './xenc:KA-Nonce/following-sibling::*',
            $xpCache,
        );

        $this->assertCount(3, $agreementMethodElements);
        $this->assertEquals('ssp:Chunk', $agreementMethodElements[0]->tagName);
        $this->assertEquals('xenc:OriginatorKeyInfo', $agreementMethodElements[1]->tagName);
        $this->assertEquals('xenc:RecipientKeyInfo', $agreementMethodElements[2]->tagName);
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace SimpleSAML\XMLSecurity\Test\XML\xenc;
6
7			use PHPUnit\Framework\Attributes\CoversClass;
			1 ignored issue – show Bug introduced 2024-11-26 23:30 UTC by Report Bug Copy Issue Report The type `PHPUnit\Framework\Attributes\CoversClass` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
8			use PHPUnit\Framework\TestCase;
9			use SimpleSAML\XML\Chunk;
10			use SimpleSAML\XML\DOMDocumentFactory;
11			use SimpleSAML\XML\TestUtils\SerializableElementTestTrait;
12			use SimpleSAML\XMLSecurity\Constants as C;
13			use SimpleSAML\XMLSecurity\TestUtils\PEMCertificatesMock;
14			use SimpleSAML\XMLSecurity\Utils\XPath;
15			use SimpleSAML\XMLSecurity\XML\ds\{KeyName, X509Certificate, X509Data, X509SubjectName};
16			use SimpleSAML\XMLSecurity\XML\xenc\{AbstractAgreementMethodType, AbstractXencElement};
17			use SimpleSAML\XMLSecurity\XML\xenc\{AgreementMethod, KANonce, OriginatorKeyInfo, RecipientKeyInfo};
18
19			use function dirname;
20			use function openssl_x509_parse;
21			use function str_replace;
22			use function strval;
23
24			/**
25			* Class \SimpleSAML\XMLSecurity\Test\XML\xenc\AgreementMethodTest
26			*
27			* @package simplesamlphp/xml-security
28			*/
29			#[CoversClass(AbstractXencElement::class)]
30			#[CoversClass(AbstractAgreementMethodType::class)]
31			#[CoversClass(AgreementMethod::class)]
32			final class AgreementMethodTest extends TestCase
33			{
34			use SerializableElementTestTrait;
			0 ignored issues – show Bug introduced 2024-11-27 19:43 UTC by Report Bug Copy Issue Report The trait `SimpleSAML\XML\TestUtils...lizableElementTestTrait` requires the property `$documentElement` which is not provided by `SimpleSAML\XMLSecurity\T...enc\AgreementMethodTest`. Loading history...
35
36			/** @var string */
37			private static string $certificate;
38
39			/** @var string[] */
40			private static array $certData;
41
42
43			/**
44			*/
45			public function setUp(): void
46			{
47			self::$testedClass = AgreementMethod::class;
48
49			self::$xmlRepresentation = DOMDocumentFactory::fromFile(
50			dirname(__FILE__, 3) . '/resources/xml/xenc_AgreementMethod.xml',
51			);
52
53			self::$certificate = str_replace(
54			[
55			'-----BEGIN CERTIFICATE-----',
56			'-----END CERTIFICATE-----',
57			'-----BEGIN RSA PUBLIC KEY-----',
58			'-----END RSA PUBLIC KEY-----',
59			"\r\n",
60			"\n",
61			],
62			[
63			'',
64			'',
65			'',
66			'',
67			"\n",
68			'',
69			],
70			PEMCertificatesMock::getPlainCertificate(PEMCertificatesMock::SELFSIGNED_CERTIFICATE),
71			);
72
73			self::$certData = openssl_x509_parse(
74			PEMCertificatesMock::getPlainCertificate(PEMCertificatesMock::SELFSIGNED_CERTIFICATE),
75			);
76			}
77
78
79			/**
80			*/
81			public function testMarshalling(): void
82			{
83			$kaNonce = new KANonce('/CTj03d1DB5e2t7CTo9BEzCf5S9NRzwnBgZRlm32REI=');
84
85			$someChunk = new Chunk(DOMDocumentFactory::fromString(
86			'<ssp:Chunk xmlns:ssp="urn:x-simplesamlphp:namespace">some</ssp:Chunk>',
87			)->documentElement);
88
89			$originatorKeyInfo = new OriginatorKeyInfo(
90			[
91			new KeyName('testkey'),
92			new X509Data(
93			[
94			new X509Certificate(self::$certificate),
95			new X509SubjectName(self::$certData['name']),
96			],
97			),
98			new Chunk(DOMDocumentFactory::fromString(
99			'<ssp:Chunk xmlns:ssp="urn:x-simplesamlphp:namespace">originator</ssp:Chunk>',
100			)->documentElement),
101			],
102			'fed123',
103			);
104
105			$recipientKeyInfo = new RecipientKeyInfo(
106			[
107			new KeyName('testkey'),
108			new X509Data(
109			[
110			new X509Certificate(self::$certificate),
111			new X509SubjectName(self::$certData['name']),
112			],
113			),
114			new Chunk(DOMDocumentFactory::fromString(
115			'<ssp:Chunk xmlns:ssp="urn:x-simplesamlphp:namespace">recipient</ssp:Chunk>',
116			)->documentElement),
117			],
118			'fed654',
119			);
120
121			$agreementMethod = new AgreementMethod(
122			C::XMLENC11_ECDH_ES,
123			$kaNonce,
124			$originatorKeyInfo,
125			$recipientKeyInfo,
126			[$someChunk],
127			);
128
129			$this->assertEquals(
130			self::$xmlRepresentation->saveXML(self::$xmlRepresentation->documentElement),
131			strval($agreementMethod),
132			);
133			}
134
135
136			public function testMarshallingElementOrdering(): void
137			{
138			$kaNonce = new KANonce('/CTj03d1DB5e2t7CTo9BEzCf5S9NRzwnBgZRlm32REI=');
139
140			$someChunk = new Chunk(DOMDocumentFactory::fromString(
141			'<ssp:Chunk xmlns:ssp="urn:x-simplesamlphp:namespace">some</ssp:Chunk>',
142			)->documentElement);
143
144			$originatorKeyInfo = new OriginatorKeyInfo(
145			[
146			new KeyName('testkey'),
147			new X509Data(
148			[
149			new X509Certificate(self::$certificate),
150			new X509SubjectName(self::$certData['name']),
151			],
152			),
153			new Chunk(DOMDocumentFactory::fromString(
154			'<ssp:Chunk xmlns:ssp="urn:x-simplesamlphp:namespace">originator</ssp:Chunk>',
155			)->documentElement),
156			],
157			'fed321',
158			);
159
160			$recipientKeyInfo = new RecipientKeyInfo(
161			[
162			new KeyName('testkey'),
163			new X509Data(
164			[
165			new X509Certificate(self::$certificate),
166			new X509SubjectName(self::$certData['name']),
167			],
168			),
169			new Chunk(DOMDocumentFactory::fromString(
170			'<ssp:Chunk xmlns:ssp="urn:x-simplesamlphp:namespace">recipient</ssp:Chunk>',
171			)->documentElement),
172			],
173			'fed654',
174			);
175
176			$agreementMethod = new AgreementMethod(
177			C::XMLENC11_ECDH_ES,
178			$kaNonce,
179			$originatorKeyInfo,
180			$recipientKeyInfo,
181			[$someChunk],
182			);
183
184			// Marshall it to a \DOMElement
185			$agreementMethodElement = $agreementMethod->toXML();
186
187			$xpCache = XPath::getXPath($agreementMethodElement);
188
189			// Test for an KA-Nonce
190			/** @var \DOMElement[] $kaNonceElements */
191			$kaNonceElements = XPath::xpQuery($agreementMethodElement, './xenc:KA-Nonce', $xpCache);
192			$this->assertCount(1, $kaNonceElements);
193
194			// Test ordering of AgreementMethod contents
195			/** @var \DOMElement[] $agreementMethodElements */
196			$agreementMethodElements = XPath::xpQuery(
197			$agreementMethodElement,
198			'./xenc:KA-Nonce/following-sibling::*',
199			$xpCache,
200			);
201
202			$this->assertCount(3, $agreementMethodElements);
203			$this->assertEquals('ssp:Chunk', $agreementMethodElements[0]->tagName);
204			$this->assertEquals('xenc:OriginatorKeyInfo', $agreementMethodElements[1]->tagName);
205			$this->assertEquals('xenc:RecipientKeyInfo', $agreementMethodElements[2]->tagName);
206			}
207			}
208

simplesamlphp / xml-security

Pull Request — master (#57)

testMarshallingElementOrdering() A

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like