mirror of
https://github.com/Part-DB/Part-DB-server.git
synced 2025-06-21 01:25:55 +02:00
164 lines
7.6 KiB
PHP
164 lines
7.6 KiB
PHP
<?php
|
|
/**
|
|
* This file is part of Part-DB (https://github.com/Part-DB/Part-DB-symfony).
|
|
*
|
|
* Copyright (C) 2019 - 2020 Jan Böhmer (https://github.com/jbtronics)
|
|
*
|
|
* This program is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Affero General Public License as published
|
|
* by the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU Affero General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Affero General Public License
|
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
declare(strict_types=1);
|
|
|
|
namespace App\Tests\Services\Attachments;
|
|
|
|
use App\Services\Formatters\AmountFormatter;
|
|
use App\Services\Attachments\AttachmentPathResolver;
|
|
use const DIRECTORY_SEPARATOR;
|
|
use Symfony\Bundle\FrameworkBundle\Test\WebTestCase;
|
|
|
|
class AttachmentPathResolverTest extends WebTestCase
|
|
{
|
|
protected string $media_path;
|
|
protected string $footprint_path;
|
|
protected $projectDir_orig;
|
|
protected $projectDir;
|
|
/**
|
|
* @var AmountFormatter
|
|
*/
|
|
protected $service;
|
|
|
|
public function setUp(): void
|
|
{
|
|
//Get a service instance.
|
|
self::bootKernel();
|
|
|
|
$this->projectDir_orig = realpath(self::$kernel->getProjectDir());
|
|
$this->projectDir = str_replace('\\', '/', $this->projectDir_orig);
|
|
$this->media_path = $this->projectDir.'/public/media';
|
|
$this->footprint_path = $this->projectDir.'/public/img/footprints';
|
|
|
|
$this->service = self::getContainer()->get(AttachmentPathResolver::class);
|
|
}
|
|
|
|
public function testParameterToAbsolutePath(): void
|
|
{
|
|
//If null is passed, null must be returned
|
|
$this->assertNull($this->service->parameterToAbsolutePath(null));
|
|
|
|
//Absolute path should be returned like they are (we use projectDir here, because we know that this dir exists)
|
|
$this->assertSame($this->projectDir_orig, $this->service->parameterToAbsolutePath($this->projectDir));
|
|
|
|
//Relative pathes should be resolved
|
|
$expected = str_replace('\\', '/', $this->projectDir_orig.DIRECTORY_SEPARATOR.'src');
|
|
$this->assertSame($expected, $this->service->parameterToAbsolutePath('src'));
|
|
$this->assertSame($expected, $this->service->parameterToAbsolutePath('./src'));
|
|
|
|
//Invalid pathes should return null
|
|
$this->assertNull($this->service->parameterToAbsolutePath('/this/path/does/not/exist'));
|
|
$this->assertNull($this->service->parameterToAbsolutePath('/./this/one/too'));
|
|
}
|
|
|
|
public function placeholderDataProvider(): \Iterator
|
|
{
|
|
//We need to do initialization (again), as dataprovider is called before setUp()
|
|
self::bootKernel();
|
|
$this->projectDir_orig = realpath(self::$kernel->getProjectDir());
|
|
$this->projectDir = str_replace('\\', '/', $this->projectDir_orig);
|
|
$this->media_path = $this->projectDir.'/public/media';
|
|
$this->footprint_path = $this->projectDir.'/public/img/footprints';
|
|
yield ['%FOOTPRINTS%/test/test.jpg', $this->footprint_path.'/test/test.jpg'];
|
|
yield ['%FOOTPRINTS%/test/', $this->footprint_path.'/test/'];
|
|
yield ['%MEDIA%/test', $this->media_path.'/test'];
|
|
yield ['%MEDIA%', $this->media_path];
|
|
yield ['%FOOTPRINTS%', $this->footprint_path];
|
|
//Footprints 3D are disabled
|
|
yield ['%FOOTPRINTS_3D%', null];
|
|
//Check that invalid pathes return null
|
|
yield ['/no/placeholder', null];
|
|
yield ['%INVALID_PLACEHOLDER%', null];
|
|
yield ['%FOOTPRINTS/test/', null];
|
|
//Malformed placeholder
|
|
yield ['/wrong/%FOOTRPINTS%/', null];
|
|
//Placeholder not at beginning
|
|
yield ['%FOOTPRINTS%/%MEDIA%', null];
|
|
//No more than one placholder
|
|
yield ['%FOOTPRINTS%/%FOOTPRINTS%', null];
|
|
yield ['%FOOTPRINTS%/../../etc/passwd', null];
|
|
yield ['%FOOTPRINTS%/0\..\test', null];
|
|
}
|
|
|
|
public function realPathDataProvider(): \Iterator
|
|
{
|
|
//We need to do initialization (again), as dataprovider is called before setUp()
|
|
self::bootKernel();
|
|
$this->projectDir_orig = realpath(self::$kernel->getProjectDir());
|
|
$this->projectDir = str_replace('\\', '/', $this->projectDir_orig);
|
|
$this->media_path = $this->projectDir.'/public/media';
|
|
$this->footprint_path = $this->projectDir.'/public/img/footprints';
|
|
yield [$this->media_path.'/test/img.jpg', '%MEDIA%/test/img.jpg'];
|
|
yield [$this->media_path.'/test/img.jpg', '%BASE%/data/media/test/img.jpg', true];
|
|
yield [$this->footprint_path.'/foo.jpg', '%FOOTPRINTS%/foo.jpg'];
|
|
yield [$this->footprint_path.'/foo.jpg', '%FOOTPRINTS%/foo.jpg', true];
|
|
//Every kind of absolute path, that is not based with our placeholder dirs must be invald
|
|
yield ['/etc/passwd', null];
|
|
yield ['C:\\not\\existing.txt', null];
|
|
//More than one placeholder is not allowed
|
|
yield [$this->footprint_path.'/test/'.$this->footprint_path, null];
|
|
//Path must begin with path
|
|
yield ['/not/root'.$this->footprint_path, null];
|
|
}
|
|
|
|
/**
|
|
* @dataProvider placeholderDataProvider
|
|
*/
|
|
public function testPlaceholderToRealPath($param, $expected): void
|
|
{
|
|
$this->assertSame($expected, $this->service->placeholderToRealPath($param));
|
|
}
|
|
|
|
/**
|
|
* @dataProvider realPathDataProvider
|
|
*/
|
|
public function testRealPathToPlaceholder($param, $expected, $old_method = false): void
|
|
{
|
|
$this->assertSame($expected, $this->service->realPathToPlaceholder($param, $old_method));
|
|
}
|
|
|
|
public function germanFootprintPathdDataProvider(): ?\Generator
|
|
{
|
|
self::bootKernel();
|
|
$this->projectDir_orig = realpath(self::$kernel->getProjectDir());
|
|
$this->projectDir = str_replace('\\', '/', $this->projectDir_orig);
|
|
$this->footprint_path = $this->projectDir.'/public/img/footprints';
|
|
|
|
yield [$this->footprint_path. '/Active/Diodes/THT/DIODE_P600.png', '%FOOTPRINTS%/Aktiv/Dioden/Bedrahtet/DIODE_P600.png'];
|
|
yield [$this->footprint_path . '/Passive/Resistors/THT/Carbon/RESISTOR-CARBON_0207.png', '%FOOTPRINTS%/Passiv/Widerstaende/Bedrahtet/Kohleschicht/WIDERSTAND-KOHLE_0207.png'];
|
|
yield [$this->footprint_path . '/Optics/LEDs/THT/LED-GREEN_3MM.png', '%FOOTPRINTS%/Optik/LEDs/Bedrahtet/LED-GRUEN_3MM.png'];
|
|
yield [$this->footprint_path . '/Passive/Capacitors/TrimmerCapacitors/TRIMMER_CAPACITOR-RED_TZ03F.png', '%FOOTPRINTS%/Passiv/Kondensatoren/Trimmkondensatoren/TRIMMKONDENSATOR-ROT_TZ03F.png'];
|
|
yield [$this->footprint_path . '/Active/ICs/TO/IC_TO126.png', '%FOOTPRINTS%/Aktiv/ICs/TO/IC_TO126.png'];
|
|
yield [$this->footprint_path . '/Electromechanics/Switches_Buttons/RotarySwitches/ROTARY_SWITCH_DIP10.png', '%FOOTPRINTS%/Elektromechanik/Schalter_Taster/Drehschalter/DREHSCHALTER_DIP10.png'];
|
|
yield [$this->footprint_path . '/Electromechanics/Connectors/DINConnectors/SOCKET_DIN_MAB_4.png', '%FOOTPRINTS%/Elektromechanik/Verbinder/Rundsteckverbinder/BUCHSE_DIN_MAB_4.png'];
|
|
|
|
//Leave english pathes untouched
|
|
yield [$this->footprint_path . '/Passive/Capacitors/CAPACITOR_CTS_A_15MM.png', '%FOOTPRINTS%/Passive/Capacitors/CAPACITOR_CTS_A_15MM.png'];
|
|
}
|
|
|
|
/**
|
|
* @dataProvider germanFootprintPathdDataProvider
|
|
*/
|
|
public function testConversionOfGermanFootprintPaths(string $expected, string $input): void
|
|
{
|
|
$this->assertSame($expected, $this->service->placeholderToRealPath($input));
|
|
}
|
|
}
|