groove/Part-DB-server
1
0
Fork 0
mirror of https://github.com/Part-DB/Part-DB-server.git synced 2026-05-05 20:59:37 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

Add custom KiCad autocomplete list settings (#1342)

Browse source 
* Add admin editor for KiCad autocomplete lists

* Add custom KiCad autocomplete list settings

* Ignore the footprints_custom.txt and symbols_custom.txt in git and create them on the fly if needed

Otherwise it breaks the update mechanism

* Added comments

* Include kicad custom files in config backup command

---------

Co-authored-by: Jan Böhmer <mail@jan-boehmer.de>
This commit is contained in:
DanTrackpaw 2026-04-15 00:01:00 +02:00 • committed by GitHub
parent 35dcb298e7
commit 58a34e3628
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
14 changed files with 665 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

162
tests/Controller/KicadListEditorControllerTest.php Normal file
View file

@ -0,0 +1,162 @@
<?php
/*
* This file is part of Part-DB (https://github.com/Part-DB/Part-DB-symfony).
*
* Copyright (C) 2019 - 2024 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\Controller;
use App\Entity\UserSystem\User;
use App\Settings\MiscSettings\KiCadEDASettings;
use Jbtronics\SettingsBundle\Manager\SettingsManagerInterface;
use PHPUnit\Framework\Attributes\Group;
use Symfony\Bundle\FrameworkBundle\Test\WebTestCase;
#[Group('slow')]
#[Group('DB')]
final class KicadListEditorControllerTest extends WebTestCase
{
private string $footprintsPath;
private string $symbolsPath;
private string $customFootprintsPath;
private string $customSymbolsPath;
private string $originalFootprints;
private string $originalSymbols;
private string $originalCustomFootprints;
private string $originalCustomSymbols;
private bool $originalUseCustomList;
protected function setUp(): void
{
parent::setUp();
$projectDir = dirname(__DIR__, 2);
$this->footprintsPath = $projectDir . '/public/kicad/footprints.txt';
$this->symbolsPath = $projectDir . '/public/kicad/symbols.txt';
$this->customFootprintsPath = $projectDir . '/public/kicad/footprints_custom.txt';
$this->customSymbolsPath = $projectDir . '/public/kicad/symbols_custom.txt';
$this->originalFootprints = (string) file_get_contents($this->footprintsPath);
$this->originalSymbols = (string) file_get_contents($this->symbolsPath);
$this->originalCustomFootprints = is_file($this->customFootprintsPath) ? (string) file_get_contents($this->customFootprintsPath) : '';
$this->originalCustomSymbols = is_file($this->customSymbolsPath) ? (string) file_get_contents($this->customSymbolsPath) : '';
static::bootKernel();
/** @var SettingsManagerInterface $settingsManager */
$settingsManager = static::getContainer()->get(SettingsManagerInterface::class);
/** @var KiCadEDASettings $settings */
$settings = $settingsManager->get(KiCadEDASettings::class);
$this->originalUseCustomList = $settings->useCustomList;
static::ensureKernelShutdown();
}
protected function tearDown(): void
{
file_put_contents($this->footprintsPath, $this->originalFootprints);
file_put_contents($this->symbolsPath, $this->originalSymbols);
file_put_contents($this->customFootprintsPath, $this->originalCustomFootprints);
file_put_contents($this->customSymbolsPath, $this->originalCustomSymbols);
static::bootKernel();
/** @var SettingsManagerInterface $settingsManager */
$settingsManager = static::getContainer()->get(SettingsManagerInterface::class);
/** @var KiCadEDASettings $settings */
$settings = $settingsManager->get(KiCadEDASettings::class);
$settings->useCustomList = $this->originalUseCustomList;
$settingsManager->save($settings);
static::ensureKernelShutdown();
parent::tearDown();
}
public function testEditorRequiresAuthentication(): void
{
$client = static::createClient();
$client->request('GET', '/en/settings/misc/kicad-lists');
$this->assertResponseStatusCodeSame(401);
}
public function testEditorAccessibleByAdmin(): void
{
$client = static::createClient();
$this->loginAsUser($client, 'admin');
$client->request('GET', '/en/settings/misc/kicad-lists');
$this->assertResponseIsSuccessful();
$this->assertSelectorExists('form[name="kicad_list_editor"]');
}
public function testEditorShowsDefaultAndCustomFiles(): void
{
$client = static::createClient();
$this->loginAsUser($client, 'admin');
file_put_contents($this->footprintsPath, "DefaultFootprint\n");
file_put_contents($this->symbolsPath, "DefaultSymbol\n");
file_put_contents($this->customFootprintsPath, "CustomFootprint\n");
file_put_contents($this->customSymbolsPath, "CustomSymbol\n");
$crawler = $client->request('GET', '/en/settings/misc/kicad-lists');
$this->assertSame("CustomFootprint\n", $crawler->filter('#kicad_list_editor_customFootprints')->getNode(0)->nodeValue);
$this->assertSame("CustomSymbol\n", $crawler->filter('#kicad_list_editor_customSymbols')->getNode(0)->nodeValue);
$this->assertSame("DefaultFootprint\n", $crawler->filter('#kicad_list_editor_defaultFootprints')->getNode(0)->nodeValue);
$this->assertSame("DefaultSymbol\n", $crawler->filter('#kicad_list_editor_defaultSymbols')->getNode(0)->nodeValue);
}
public function testEditorSavesCustomFilesAndSetting(): void
{
$client = static::createClient();
$this->loginAsUser($client, 'admin');
$crawler = $client->request('GET', '/en/settings/misc/kicad-lists');
$form = $crawler->filter('form[name="kicad_list_editor"]')->form();
$form['kicad_list_editor[customFootprints]'] = "Package_DIP:DIP-8_W7.62mm\n";
$form['kicad_list_editor[customSymbols]'] = "Device:R\n";
$form['kicad_list_editor[useCustomList]']->tick();
$client->submit($form);
$this->assertResponseRedirects('/en/settings/misc/kicad-lists');
$this->assertSame("Package_DIP:DIP-8_W7.62mm\n", (string) file_get_contents($this->customFootprintsPath));
$this->assertSame("Device:R\n", (string) file_get_contents($this->customSymbolsPath));
$this->assertSame($this->originalFootprints, (string) file_get_contents($this->footprintsPath));
$this->assertSame($this->originalSymbols, (string) file_get_contents($this->symbolsPath));
/** @var SettingsManagerInterface $settingsManager */
$settingsManager = $client->getContainer()->get(SettingsManagerInterface::class);
/** @var KiCadEDASettings $settings */
$settings = $settingsManager->reload(KiCadEDASettings::class);
$this->assertTrue($settings->useCustomList);
}
private function loginAsUser($client, string $username): void
{
$entityManager = $client->getContainer()->get('doctrine')->getManager();
$userRepository = $entityManager->getRepository(User::class);
$user = $userRepository->findOneBy(['name' => $username]);
if (!$user) {
$this->markTestSkipped(sprintf('User "%s" not found in fixtures', $username));
}
$client->loginUser($user);
}
}