|
| 1 | +<?php |
| 2 | +/** |
| 3 | + * Copyright 2025 Adobe |
| 4 | + * All Rights Reserved. |
| 5 | + */ |
| 6 | +declare(strict_types=1); |
| 7 | + |
| 8 | +namespace Magento\Csp\Test\Unit\Plugin; |
| 9 | + |
| 10 | +use Magento\Csp\Plugin\GenerateAssetIntegrity; |
| 11 | +use Magento\Csp\Model\SubresourceIntegrityFactory; |
| 12 | +use Magento\Csp\Model\SubresourceIntegrityCollector; |
| 13 | +use Magento\Csp\Model\SubresourceIntegrity\HashGenerator; |
| 14 | +use Magento\Csp\Model\SubresourceIntegrity; |
| 15 | +use Magento\Framework\View\Asset\File; |
| 16 | +use Magento\RequireJs\Model\FileManager; |
| 17 | +use PHPUnit\Framework\TestCase; |
| 18 | +use PHPUnit\Framework\MockObject\MockObject; |
| 19 | + |
| 20 | +/** |
| 21 | + * Unit test for GenerateAssetIntegrity plugin. |
| 22 | + */ |
| 23 | +class GenerateAssetIntegrityTest extends TestCase |
| 24 | +{ |
| 25 | + /** |
| 26 | + * @var GenerateAssetIntegrity |
| 27 | + */ |
| 28 | + private $plugin; |
| 29 | + |
| 30 | + /** |
| 31 | + * @var HashGenerator|MockObject |
| 32 | + */ |
| 33 | + private $hashGenerator; |
| 34 | + |
| 35 | + /** |
| 36 | + * @var SubresourceIntegrityFactory|MockObject |
| 37 | + */ |
| 38 | + private $integrityFactory; |
| 39 | + |
| 40 | + /** |
| 41 | + * @var SubresourceIntegrityCollector|MockObject |
| 42 | + */ |
| 43 | + private $integrityCollector; |
| 44 | + |
| 45 | + /** |
| 46 | + * @var FileManager|MockObject |
| 47 | + */ |
| 48 | + private $fileManager; |
| 49 | + |
| 50 | + /** |
| 51 | + * @var File|MockObject |
| 52 | + */ |
| 53 | + private $assetFile; |
| 54 | + |
| 55 | + /** |
| 56 | + * @var SubresourceIntegrity|MockObject |
| 57 | + */ |
| 58 | + private $integrity; |
| 59 | + |
| 60 | + /** |
| 61 | + * @inheritDoc |
| 62 | + */ |
| 63 | + protected function setUp(): void |
| 64 | + { |
| 65 | + $this->hashGenerator = $this->createMock(HashGenerator::class); |
| 66 | + $this->integrityFactory = $this->createMock(SubresourceIntegrityFactory::class); |
| 67 | + $this->integrityCollector = $this->createMock(SubresourceIntegrityCollector::class); |
| 68 | + $this->fileManager = $this->createMock(FileManager::class); |
| 69 | + $this->assetFile = $this->createMock(File::class); |
| 70 | + $this->integrity = $this->createMock(SubresourceIntegrity::class); |
| 71 | + |
| 72 | + $this->plugin = new GenerateAssetIntegrity( |
| 73 | + $this->hashGenerator, |
| 74 | + $this->integrityFactory, |
| 75 | + $this->integrityCollector |
| 76 | + ); |
| 77 | + } |
| 78 | + |
| 79 | + /** |
| 80 | + * Test afterCreateRequireJsConfigAsset with JS content type. |
| 81 | + */ |
| 82 | + public function testAfterCreateRequireJsConfigAssetWithJsContent(): void |
| 83 | + { |
| 84 | + $this->mockJsAssetFile(); |
| 85 | + $this->mockIntegrityCreation('test-hash', 'test/path.js'); |
| 86 | + |
| 87 | + $result = $this->plugin->afterCreateRequireJsConfigAsset($this->fileManager, $this->assetFile); |
| 88 | + |
| 89 | + $this->assertSame($this->assetFile, $result); |
| 90 | + |
| 91 | + $this->integrityCollector->expects($this->any())->method('collect'); |
| 92 | + } |
| 93 | + |
| 94 | + /** |
| 95 | + * Test afterCreateRequireJsMixinsAsset with JS content type. |
| 96 | + */ |
| 97 | + public function testAfterCreateRequireJsMixinsAssetWithJsContent(): void |
| 98 | + { |
| 99 | + $this->mockJsAssetFile(); |
| 100 | + $this->mockIntegrityCreation('test-hash', 'test/path.js'); |
| 101 | + |
| 102 | + $result = $this->plugin->afterCreateRequireJsMixinsAsset($this->fileManager, $this->assetFile); |
| 103 | + |
| 104 | + $this->assertSame($this->assetFile, $result); |
| 105 | + $this->integrityCollector->expects($this->any())->method('collect'); |
| 106 | + } |
| 107 | + |
| 108 | + /** |
| 109 | + * Test afterCreateRequireJsMixinsAsset with null content. |
| 110 | + */ |
| 111 | + public function testAfterCreateRequireJsMixinsAssetWithNullContent(): void |
| 112 | + { |
| 113 | + $this->mockJsAssetFileWithNullContent(); |
| 114 | + |
| 115 | + $result = $this->plugin->afterCreateRequireJsMixinsAsset($this->fileManager, $this->assetFile); |
| 116 | + |
| 117 | + $this->assertSame($this->assetFile, $result); |
| 118 | + $this->integrityCollector->expects($this->any())->method('collect'); |
| 119 | + } |
| 120 | + |
| 121 | + /** |
| 122 | + * Test afterCreateStaticJsAsset with JS content type. |
| 123 | + */ |
| 124 | + public function testAfterCreateStaticJsAssetWithJsContent(): void |
| 125 | + { |
| 126 | + $this->mockJsAssetFile(); |
| 127 | + $this->mockIntegrityCreation('test-hash', 'test/path.js'); |
| 128 | + |
| 129 | + $result = $this->plugin->afterCreateStaticJsAsset($this->fileManager, $this->assetFile); |
| 130 | + |
| 131 | + $this->assertSame($this->assetFile, $result); |
| 132 | + |
| 133 | + $this->integrityCollector->expects($this->any())->method('collect'); |
| 134 | + } |
| 135 | + |
| 136 | + /** |
| 137 | + * Test afterCreateStaticJsAsset with null content. |
| 138 | + */ |
| 139 | + public function testAfterCreateStaticJsAssetWithNullContent(): void |
| 140 | + { |
| 141 | + $this->mockJsAssetFileWithNullContent(); |
| 142 | + |
| 143 | + $result = $this->plugin->afterCreateStaticJsAsset($this->fileManager, $this->assetFile); |
| 144 | + |
| 145 | + $this->assertSame($this->assetFile, $result); |
| 146 | + $this->integrityCollector->expects($this->never())->method('collect'); |
| 147 | + } |
| 148 | + |
| 149 | + /** |
| 150 | + * Test that the plugin correctly handles null content. |
| 151 | + */ |
| 152 | + public function testPluginLogicWithNullContent(): void |
| 153 | + { |
| 154 | + $this->mockJsAssetFileWithNullContent(); |
| 155 | + |
| 156 | + $result = $this->plugin->afterCreateRequireJsMixinsAsset($this->fileManager, $this->assetFile); |
| 157 | + |
| 158 | + $this->assertSame($this->assetFile, $result); |
| 159 | + $this->integrityCollector->expects($this->never())->method('collect'); |
| 160 | + } |
| 161 | + |
| 162 | + /** |
| 163 | + * Mock JS asset file with valid content. |
| 164 | + */ |
| 165 | + private function mockJsAssetFile(): void |
| 166 | + { |
| 167 | + $this->assetFile->method('getContentType')->willReturn('js'); |
| 168 | + $this->assetFile->method('getContent')->willReturn('console.log("test");'); |
| 169 | + $this->assetFile->method('getPath')->willReturn('test/path.js'); |
| 170 | + } |
| 171 | + |
| 172 | + /** |
| 173 | + * Mock JS asset file with null content. |
| 174 | + */ |
| 175 | + private function mockJsAssetFileWithNullContent(): void |
| 176 | + { |
| 177 | + $this->assetFile->method('getContentType')->willReturn('js'); |
| 178 | + $this->assetFile->method('getContent')->willReturn(null); |
| 179 | + $this->assetFile->method('getPath')->willReturn('test/path.js'); |
| 180 | + } |
| 181 | + |
| 182 | + /** |
| 183 | + * Mock integrity creation. |
| 184 | + */ |
| 185 | + private function mockIntegrityCreation(string $hash, string $path): void |
| 186 | + { |
| 187 | + $this->hashGenerator->method('generate')->willReturn($hash); |
| 188 | + |
| 189 | + $this->integrityFactory->method('create') |
| 190 | + ->willReturn($this->integrity); |
| 191 | + |
| 192 | + $this->integrity->method('getHash')->willReturn($hash); |
| 193 | + $this->integrity->method('getPath')->willReturn($path); |
| 194 | + } |
| 195 | +} |
0 commit comments