From e444388517c43d14a331ff1a8660c97746b68c25 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jan=20B=C3=B6hmer?= <mail@jan-boehmer.de>
Date: Thu, 16 Mar 2023 23:32:12 +0100
Subject: [PATCH] Added tests for PCBnew BOM type

---
 src/Controller/ProjectController.php          |   4 +
 .../ImportExportSystem/BOMImporter.php        |   2 +-
 .../ImportExportSystem/BOMImporterTest.php    | 123 ++++++++++++++++++
 .../ImportExportSystem/EntityImporterTest.php |   2 +-
 4 files changed, 129 insertions(+), 2 deletions(-)
 create mode 100644 tests/Services/ImportExportSystem/BOMImporterTest.php

diff --git a/src/Controller/ProjectController.php b/src/Controller/ProjectController.php
index c1c77f9b..9097c8dd 100644
--- a/src/Controller/ProjectController.php
+++ b/src/Controller/ProjectController.php
@@ -32,6 +32,8 @@ use App\Services\ImportExportSystem\BOMImporter;
 use App\Services\ProjectSystem\ProjectBuildHelper;
 use Doctrine\Common\Collections\ArrayCollection;
 use Doctrine\ORM\EntityManagerInterface;
+use League\Csv\Exception;
+use League\Csv\SyntaxError;
 use Omines\DataTablesBundle\DataTableFactory;
 use Sensio\Bundle\FrameworkExtraBundle\Configuration\ParamConverter;
 use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
@@ -190,6 +192,8 @@ class ProjectController extends AbstractController
                 }
             } catch (\UnexpectedValueException $e) {
                 $this->addFlash('error', t('project.bom_import.flash.invalid_file', ['%message%' => $e->getMessage()]));
+            } catch (SyntaxError $e) {
+                $this->addFlash('error', t('project.bom_import.flash.invalid_file', ['%message%' => $e->getMessage()]));
             }
         }
 
diff --git a/src/Services/ImportExportSystem/BOMImporter.php b/src/Services/ImportExportSystem/BOMImporter.php
index b846e4f8..4d9c26b0 100644
--- a/src/Services/ImportExportSystem/BOMImporter.php
+++ b/src/Services/ImportExportSystem/BOMImporter.php
@@ -45,7 +45,7 @@ class BOMImporter
     {
     }
 
-    public function configureOptions(OptionsResolver $resolver): OptionsResolver
+    protected function configureOptions(OptionsResolver $resolver): OptionsResolver
     {
         $resolver->setRequired('type');
         $resolver->setAllowedValues('type', ['kicad_pcbnew']);
diff --git a/tests/Services/ImportExportSystem/BOMImporterTest.php b/tests/Services/ImportExportSystem/BOMImporterTest.php
new file mode 100644
index 00000000..674f1616
--- /dev/null
+++ b/tests/Services/ImportExportSystem/BOMImporterTest.php
@@ -0,0 +1,123 @@
+<?php
+/*
+ * This file is part of Part-DB (https://github.com/Part-DB/Part-DB-symfony).
+ *
+ *  Copyright (C) 2019 - 2023 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/>.
+ */
+
+namespace App\Tests\Services\ImportExportSystem;
+
+use App\Entity\ProjectSystem\Project;
+use App\Entity\ProjectSystem\ProjectBOMEntry;
+use App\Services\ImportExportSystem\BOMImporter;
+use PHPUnit\Framework\TestCase;
+use Symfony\Bundle\FrameworkBundle\Test\WebTestCase;
+use Symfony\Component\HttpFoundation\File\File;
+
+class BOMImporterTest extends WebTestCase
+{
+
+    /**
+     * @var BOMImporter
+     */
+    protected $service;
+
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        //Get an service instance.
+        self::bootKernel();
+        $this->service = self::getContainer()->get(BOMImporter::class);
+    }
+
+    public function testImportFileIntoProject(): void
+    {
+        $inpute = $input = <<<CSV
+        "ID";"Bezeichner";"Footprint";"Stückzahl";"Bezeichnung";"Anbieter und Referenz";
+        1;"R19,R17";"R_0805_2012Metric_Pad1.20x1.40mm_HandSolder";2;"4.7k";Test;;
+        2;"D1";"D_DO-41_SOD81_P10.16mm_Horizontal";1;"1N5059";;;
+        3;"J3,J5";"JST_XH_B5B-XH-AM_1x05_P2.50mm_Vertical";2;"DISPLAY";;;
+        4;"C6";"CP_Radial_D6.3mm_P2.50mm";1;"47uF";;;
+        CSV;
+
+        $file = $this->createMock(File::class);
+        $file->method('getContent')->willReturn($input);
+
+        $project = new Project();
+        $this->assertCount(0, $project->getBOMEntries());
+
+        $bom_entries = $this->service->importFileIntoProject($file, $project, ['type' => 'kicad_pcbnew']);
+        $this->assertContainsOnlyInstancesOf(ProjectBOMEntry::class, $bom_entries);
+        $this->assertCount(4, $bom_entries);
+
+        //Check that the BOM entries are added to the project
+        $this->assertCount(4, $project->getBOMEntries());
+    }
+
+    public function testStringToBOMEntriesKiCADPCB(): void
+    {
+        //Test for german input
+        $input = <<<CSV
+        "ID";"Bezeichner";"Footprint";"Stückzahl";"Bezeichnung";"Anbieter und Referenz";
+        1;"R19,R17";"R_0805_2012Metric_Pad1.20x1.40mm_HandSolder";2;"4.7k";Test;;
+        2;"D1";"D_DO-41_SOD81_P10.16mm_Horizontal";1;"1N5059";;;
+        3;"J3,J5";"JST_XH_B5B-XH-AM_1x05_P2.50mm_Vertical";2;"DISPLAY";;;
+        4;"C6";"CP_Radial_D6.3mm_P2.50mm";1;"47uF";;;
+        CSV;
+
+        $bom = $this->service->stringToBOMEntries($input, ['type' => 'kicad_pcbnew']);
+
+        $this->assertContainsOnlyInstancesOf(ProjectBOMEntry::class, $bom);
+        $this->assertCount(4, $bom);
+
+        $this->assertEquals('R19,R17', $bom[0]->getMountnames());
+        $this->assertEquals(2.0, $bom[0]->getQuantity());
+        $this->assertSame('4.7k (R_0805_2012Metric_Pad1.20x1.40mm_HandSolder)', $bom[0]->getName());
+        $this->assertSame('Test', $bom[0]->getComment());
+
+        //Test for english input
+        $input = <<<CSV
+        "Id";"Designator";"Package";"Quantity";"Designation";"Supplier and ref";
+        1;"R19,R17";"R_0805_2012Metric_Pad1.20x1.40mm_HandSolder";2;"4.7k";Test;;
+        2;"D1";"D_DO-41_SOD81_P10.16mm_Horizontal";1;"1N5059";;;
+        3;"J3,J5";"JST_XH_B5B-XH-AM_1x05_P2.50mm_Vertical";2;"DISPLAY";;;
+        4;"C6";"CP_Radial_D6.3mm_P2.50mm";1;"47uF";;;
+        CSV;
+
+        $bom = $this->service->stringToBOMEntries($input, ['type' => 'kicad_pcbnew']);
+
+        $this->assertContainsOnlyInstancesOf(ProjectBOMEntry::class, $bom);
+        $this->assertCount(4, $bom);
+
+        $this->assertEquals('R19,R17', $bom[0]->getMountnames());
+        $this->assertEquals(2.0, $bom[0]->getQuantity());
+        $this->assertSame('4.7k (R_0805_2012Metric_Pad1.20x1.40mm_HandSolder)', $bom[0]->getName());
+        $this->assertSame('Test', $bom[0]->getComment());
+    }
+
+    public function testStringToBOMEntriesKiCADPCBError(): void
+    {
+        $input = <<<CSV
+        "ID";"Test";
+        1;"R19,R17";"R_0805_2012Metric_Pad1.20x1.40mm_HandSolder";2;"4.7k";Test;;
+        CSV;
+
+        $this->expectException(\UnexpectedValueException::class);
+
+        $this->service->stringToBOMEntries($input, ['type' => 'kicad_pcbnew']);
+    }
+}
diff --git a/tests/Services/ImportExportSystem/EntityImporterTest.php b/tests/Services/ImportExportSystem/EntityImporterTest.php
index 7f386e6b..4c13b77e 100644
--- a/tests/Services/ImportExportSystem/EntityImporterTest.php
+++ b/tests/Services/ImportExportSystem/EntityImporterTest.php
@@ -37,7 +37,7 @@ use Symfony\Component\Validator\ConstraintViolation;
 class EntityImporterTest extends WebTestCase
 {
     /**
-     * @var AmountFormatter
+     * @var EntityImporter
      */
     protected $service;