diff --git a/app/Models/Asset.php b/app/Models/Asset.php index 730106571..ce8b870eb 100644 --- a/app/Models/Asset.php +++ b/app/Models/Asset.php @@ -43,16 +43,16 @@ class Asset extends Depreciable /** * Run after the checkout acceptance was declined by the user - * + * * @param User $acceptedBy * @param string $signature - */ + */ public function declinedCheckout(User $declinedBy, $signature) { $this->assigned_to = null; $this->assigned_type = null; - $this->accepted = null; - $this->save(); + $this->accepted = null; + $this->save(); } /** @@ -368,7 +368,7 @@ class Asset extends Depreciable if ($this->save()) { if (is_int($admin)) { $checkedOutBy = User::findOrFail($admin); - } elseif (get_class($admin) === \App\Models\User::class) { + } elseif ($admin && get_class($admin) === \App\Models\User::class) { $checkedOutBy = $admin; } else { $checkedOutBy = auth()->user(); @@ -1705,7 +1705,7 @@ class Asset extends Depreciable }); }); } - + /** * THIS CLUNKY BIT IS VERY IMPORTANT @@ -1726,7 +1726,7 @@ class Asset extends Depreciable * assets.location would fail, as that field doesn't exist -- plus we're already searching * against those relationships earlier in this method. * - * - snipe + * - snipe * */ diff --git a/app/Models/Import.php b/app/Models/Import.php index 81728c8a5..052612a19 100644 --- a/app/Models/Import.php +++ b/app/Models/Import.php @@ -2,10 +2,13 @@ namespace App\Models; +use Illuminate\Database\Eloquent\Factories\HasFactory; use Illuminate\Database\Eloquent\Model; class Import extends Model { + use HasFactory; + protected $casts = [ 'header_row' => 'array', 'first_row' => 'array', diff --git a/database/factories/ImportFactory.php b/database/factories/ImportFactory.php new file mode 100644 index 000000000..0b0f79aa4 --- /dev/null +++ b/database/factories/ImportFactory.php @@ -0,0 +1,146 @@ + + */ +class ImportFactory extends Factory +{ + /** + * @inheritdoc + */ + protected $model = Import::class; + + /** + * @inheritdoc + */ + public function definition() + { + return [ + 'name' => $this->faker->company, + 'file_path' => Str::random().'.csv', + 'filesize' => $this->faker->randomDigitNotNull(), + 'field_map' => null, + ]; + } + + /** + * Create an accessory import type. + * + * @return static + */ + public function accessory() + { + return $this->state(function (array $attributes) { + $fileBuilder = Importing\AccessoriesImportFileBuilder::new(); + + $attributes['name'] = "{$attributes['name']} Accessories"; + $attributes['import_type'] = 'accessory'; + $attributes['header_row'] = $fileBuilder->toCsv()[0]; + $attributes['first_row'] = $fileBuilder->firstRow(); + + return $attributes; + }); + } + + /** + * Create an asset import type. + * + * @return static + */ + public function asset() + { + return $this->state(function (array $attributes) { + $fileBuilder = Importing\AssetsImportFileBuilder::new(); + + $attributes['name'] = "{$attributes['name']} Assets"; + $attributes['import_type'] = 'asset'; + $attributes['header_row'] = $fileBuilder->toCsv()[0]; + $attributes['first_row'] = $fileBuilder->firstRow(); + + return $attributes; + }); + } + + /** + * Create a component import type. + * + * @return static + */ + public function component() + { + return $this->state(function (array $attributes) { + $fileBuilder = Importing\ComponentsImportFileBuilder::new(); + + $attributes['name'] = "{$attributes['name']} Components"; + $attributes['import_type'] = 'component'; + $attributes['header_row'] = $fileBuilder->toCsv()[0]; + $attributes['first_row'] = $fileBuilder->firstRow(); + + return $attributes; + }); + } + + /** + * Create a consumable import type. + * + * @return static + */ + public function consumable() + { + return $this->state(function (array $attributes) { + $fileBuilder = Importing\ConsumablesImportFileBuilder::new(); + + $attributes['name'] = "{$attributes['name']} Consumables"; + $attributes['import_type'] = 'consumable'; + $attributes['header_row'] = $fileBuilder->toCsv()[0]; + $attributes['first_row'] = $fileBuilder->firstRow(); + + return $attributes; + }); + } + + /** + * Create a license import type. + * + * @return static + */ + public function license() + { + return $this->state(function (array $attributes) { + $fileBuilder = Importing\LicensesImportFileBuilder::new(); + + $attributes['name'] = "{$attributes['name']} Licenses"; + $attributes['import_type'] = 'license'; + $attributes['header_row'] = $fileBuilder->toCsv()[0]; + $attributes['first_row'] = $fileBuilder->firstRow(); + + return $attributes; + }); + } + + /** + * Create a users import type. + * + * @return static + */ + public function users() + { + return $this->state(function (array $attributes) { + $fileBuilder = Importing\UsersImportFileBuilder::new(); + + $attributes['name'] = "{$attributes['name']} Employees"; + $attributes['import_type'] = 'user'; + $attributes['header_row'] = $fileBuilder->toCsv()[0]; + $attributes['first_row'] = $fileBuilder->firstRow(); + + return $attributes; + }); + } +} diff --git a/database/factories/UserFactory.php b/database/factories/UserFactory.php index 1b469941b..4b752b736 100644 --- a/database/factories/UserFactory.php +++ b/database/factories/UserFactory.php @@ -7,6 +7,9 @@ use App\Models\User; use Illuminate\Database\Eloquent\Factories\Factory; use \Auth; +/** + * @extends Factory + */ class UserFactory extends Factory { /** diff --git a/tests/Feature/Importing/Api/GeneralImportTest.php b/tests/Feature/Importing/Api/GeneralImportTest.php new file mode 100644 index 000000000..5c38dab7f --- /dev/null +++ b/tests/Feature/Importing/Api/GeneralImportTest.php @@ -0,0 +1,16 @@ +actingAsForApi(User::factory()->canImport()->create()); + + $this->importFileResponse(['import' => 9999, 'import-type' => 'accessory']) + ->assertStatusMessageIs('import-errors'); + } +} diff --git a/tests/Feature/Importing/Api/ImportAccessoriesTest.php b/tests/Feature/Importing/Api/ImportAccessoriesTest.php new file mode 100644 index 000000000..aac9dabb1 --- /dev/null +++ b/tests/Feature/Importing/Api/ImportAccessoriesTest.php @@ -0,0 +1,420 @@ +actingAsForApi(User::factory()->create()); + + $this->importFileResponse(['import' => 44])->assertForbidden(); + } + + #[Test] + public function userWithImportAccessoryPermissionCanImportAccessories(): void + { + $this->actingAsForApi(User::factory()->canImport()->create()); + + $import = Import::factory()->accessory()->create(); + + $this->importFileResponse(['import' => $import->id])->assertOk(); + } + + #[Test] + public function importAccessory(): void + { + $importFileBuilder = ImportFileBuilder::new(); + $row = $importFileBuilder->firstRow(); + $import = Import::factory()->accessory()->create(['file_path' => $importFileBuilder->saveToImportsDirectory()]); + + $this->actingAsForApi(User::factory()->superuser()->create()); + $this->importFileResponse(['import' => $import->id]) + ->assertOk() + ->assertExactJson([ + 'payload' => null, + 'status' => 'success', + 'messages' => [ + 'redirect_url' => route('accessories.index') + ] + ]); + + $newAccessory = Accessory::query() + ->with(['location', 'category', 'manufacturer', 'supplier', 'company']) + ->where('name', $row['itemName']) + ->sole(); + + $activityLog = Actionlog::query() + ->where('item_type', Accessory::class) + ->where('item_id', $newAccessory->id) + ->sole(); + + $this->assertEquals('create', $activityLog->action_type); + $this->assertEquals('importer', $activityLog->action_source); + $this->assertEquals($newAccessory->company->id, $activityLog->company_id); + + $this->assertEquals($row['itemName'], $newAccessory->name); + $this->assertEquals($row['quantity'], $newAccessory->qty); + $this->assertEquals($row['purchaseDate'], $newAccessory->purchase_date->toDateString()); + $this->assertEquals($row['purchaseCost'], $newAccessory->purchase_cost); + $this->assertEquals($row['orderNumber'], $newAccessory->order_number); + $this->assertEquals($row['notes'], $newAccessory->notes); + $this->assertEquals($row['category'], $newAccessory->category->name); + $this->assertEquals('accessory', $newAccessory->category->category_type); + $this->assertEquals($row['manufacturerName'], $newAccessory->manufacturer->name); + $this->assertEquals($row['supplierName'], $newAccessory->supplier->name); + $this->assertEquals($row['location'], $newAccessory->location->name); + $this->assertEquals($row['companyName'], $newAccessory->company->name); + $this->assertEquals($row['modelNumber'], $newAccessory->model_number); + $this->assertFalse($newAccessory->requestable); + $this->assertNull($newAccessory->min_amt); + $this->assertNull($newAccessory->user_id); + } + + #[Test] + public function whenImportFileContainsUnknownColumns(): void + { + $row = ImportFileBuilder::new()->definition(); + $row['unknownColumn'] = $this->faker->word; + + $importFileBuilder = new ImportFileBuilder([$row]); + + $this->actingAsForApi(User::factory()->superuser()->create()); + + $import = Import::factory()->accessory()->create(['file_path' => $importFileBuilder->saveToImportsDirectory()]); + + $this->importFileResponse(['import' => $import->id])->assertOk(); + } + + #[Test] + public function willFormatDate(): void + { + $importFileBuilder = ImportFileBuilder::new(['purchaseDate' => '2022/10/10']); + $import = Import::factory()->accessory()->create(['file_path' => $importFileBuilder->saveToImportsDirectory()]); + + $this->actingAsForApi(User::factory()->superuser()->create()); + $this->importFileResponse(['import' => $import->id])->assertOk(); + + $accessory = Accessory::query() + ->where('name', $importFileBuilder->firstRow()['itemName']) + ->sole(['purchase_date']); + + $this->assertEquals('2022-10-10', $accessory->purchase_date->toDateString()); + } + + #[Test] + public function willNotCreateNewCategoryWhenCategoryExists(): void + { + $importFileBuilder = ImportFileBuilder::times(4)->replace(['category' => Str::random()]); + $import = Import::factory()->accessory()->create(['file_path' => $importFileBuilder->saveToImportsDirectory()]); + + $this->actingAsForApi(User::factory()->superuser()->create()); + $this->importFileResponse(['import' => $import->id])->assertOk(); + + $newAccessories = Accessory::query() + ->whereIn('name', $importFileBuilder->pluck('itemName')) + ->get(); + + $this->assertCount(1, $newAccessories->pluck('category_id')->unique()->all()); + } + + #[Test] + public function willNotCreateNewAccessoryWhenAccessoryWithNameExists(): void + { + $accessory = Accessory::factory()->create(['name' => Str::random()]); + $importFileBuilder = ImportFileBuilder::times(2)->replace(['itemName' => $accessory->name]); + $import = Import::factory()->accessory()->create(['file_path' => $importFileBuilder->saveToImportsDirectory()]); + + $this->actingAsForApi(User::factory()->superuser()->create()); + $this->importFileResponse(['import' => $import->id])->assertOk(); + + $probablyNewAccessories = Accessory::query() + ->where('name', $importFileBuilder->pluck('itemName')) + ->get(['name']); + + $this->assertCount(1, $probablyNewAccessories); + $this->assertEquals($accessory->name, $probablyNewAccessories->first()->name); + } + + #[Test] + public function willNotCreateNewCompanyWhenCompanyAlreadyExists(): void + { + $importFileBuilder = ImportFileBuilder::times(4)->replace(['companyName' => Str::random()]); + $import = Import::factory()->accessory()->create(['file_path' => $importFileBuilder->saveToImportsDirectory()]); + + $this->actingAsForApi(User::factory()->superuser()->create()); + $this->importFileResponse(['import' => $import->id])->assertOk(); + + $newAccessories = Accessory::query() + ->where('name', $importFileBuilder->pluck('itemName')) + ->get(['company_id']); + + $this->assertCount(1, $newAccessories->pluck('company_id')->unique()->all()); + } + + #[Test] + public function willNotCreateNewLocationWhenLocationAlreadyExists(): void + { + $importFileBuilder = ImportFileBuilder::times(4)->replace(['location' => Str::random()]); + $import = Import::factory()->accessory()->create(['file_path' => $importFileBuilder->saveToImportsDirectory()]); + + $this->actingAsForApi(User::factory()->superuser()->create()); + $this->importFileResponse(['import' => $import->id])->assertOk(); + + $newAccessories = Accessory::query() + ->where('name', $importFileBuilder->pluck('itemName')) + ->get(['location_id']); + + $this->assertCount(1, $newAccessories->pluck('location_id')->unique()->all()); + } + + #[Test] + public function willNotCreateNewManufacturerWhenManufacturerAlreadyExists(): void + { + $importFileBuilder = ImportFileBuilder::times(4)->replace(['manufacturerName' => $this->faker->company]); + $import = Import::factory()->accessory()->create(['file_path' => $importFileBuilder->saveToImportsDirectory()]); + + $this->actingAsForApi(User::factory()->superuser()->create()); + $this->importFileResponse(['import' => $import->id])->assertOk(); + + $newAccessories = Accessory::query() + ->where('name', $importFileBuilder->pluck('itemName')) + ->get(['manufacturer_id']); + + $this->assertCount(1, $newAccessories->pluck('manufacturer_id')->unique()->all()); + } + + #[Test] + public function willNotCreateNewSupplierWhenSupplierAlreadyExists(): void + { + $importFileBuilder = ImportFileBuilder::times(4)->replace(['supplierName' => $this->faker->company]); + $import = Import::factory()->accessory()->create(['file_path' => $importFileBuilder->saveToImportsDirectory()]); + + $this->actingAsForApi(User::factory()->superuser()->create()); + $this->importFileResponse(['import' => $import->id])->assertOk(); + + $newAccessories = Accessory::query() + ->where('name', $importFileBuilder->pluck('itemName')) + ->get(['supplier_id']); + + $this->assertCount(1, $newAccessories->pluck('supplier_id')->unique()->all()); + } + + #[Test] + public function whenColumnsAreMissingInImportFile(): void + { + $importFileBuilder = ImportFileBuilder::new()->forget(['minimumAmount', 'purchaseCost', 'purchaseDate']); + $import = Import::factory()->accessory()->create(['file_path' => $importFileBuilder->saveToImportsDirectory()]); + + $this->actingAsForApi(User::factory()->superuser()->create()); + $this->importFileResponse(['import' => $import->id])->assertOk(); + + $newAccessory = Accessory::query() + ->where('name', $importFileBuilder->firstRow()['itemName']) + ->sole(); + + $this->assertNull($newAccessory->min_amt); + $this->assertNull($newAccessory->purchase_date); + $this->assertNull($newAccessory->purchase_cost); + } + + #[Test] + public function whenRequiredColumnsAreMissingInImportFile(): void + { + $importFileBuilder = ImportFileBuilder::new()->forget(['itemName', 'quantity', 'category']); + $import = Import::factory()->accessory()->create(['file_path' => $importFileBuilder->saveToImportsDirectory()]); + + $this->actingAsForApi(User::factory()->superuser()->create()); + $this->importFileResponse(['import' => $import->id]) + ->assertInternalServerError() + ->assertExactJson([ + 'status' => 'import-errors', + 'payload' => null, + 'messages' => [ + '' => [ + 'Accessory' => [ + 'name' => ['The name field is required.'], + 'qty' => ['The qty field must be at least 1.'], + 'category_id' => ['The category id field is required.'] + ] + ] + ] + ]); + } + + #[Test] + public function updateAccessoryFromImport(): void + { + $accessory = Accessory::factory()->create(['name' => Str::random()])->refresh(); + $importFileBuilder = ImportFileBuilder::new(['itemName' => $accessory->name]); + $row = $importFileBuilder->firstRow(); + $import = Import::factory()->accessory()->create(['file_path' => $importFileBuilder->saveToImportsDirectory()]); + + $this->actingAsForApi(User::factory()->superuser()->create()); + $this->importFileResponse(['import' => $import->id, 'import-update' => true])->assertOk(); + + $updatedAccessory = Accessory::query()->find($accessory->id); + $updatedAttributes = [ + 'name', 'company_id', 'qty', 'purchase_date', 'purchase_cost', + 'order_number', 'notes', 'category_id', 'manufacturer_id', 'supplier_id', + 'location_id', 'model_number', 'updated_at' + ]; + + $this->assertEquals($row['itemName'], $updatedAccessory->name); + $this->assertEquals($row['companyName'], $updatedAccessory->company->name); + $this->assertEquals($row['quantity'], $updatedAccessory->qty); + $this->assertEquals($row['purchaseDate'], $updatedAccessory->purchase_date->toDateString()); + $this->assertEquals($row['purchaseCost'], $updatedAccessory->purchase_cost); + $this->assertEquals($row['orderNumber'], $updatedAccessory->order_number); + $this->assertEquals($row['notes'], $updatedAccessory->notes); + $this->assertEquals($row['category'], $updatedAccessory->category->name); + $this->assertEquals('accessory', $updatedAccessory->category->category_type); + $this->assertEquals($row['manufacturerName'], $updatedAccessory->manufacturer->name); + $this->assertEquals($row['supplierName'], $updatedAccessory->supplier->name); + $this->assertEquals($row['location'], $updatedAccessory->location->name); + $this->assertEquals($row['modelNumber'], $updatedAccessory->model_number); + + $this->assertEquals( + Arr::except($accessory->attributesToArray(), $updatedAttributes), + Arr::except($updatedAccessory->attributesToArray(), $updatedAttributes), + ); + } + + #[Test] + public function whenImportFileContainsEmptyValues(): void + { + $accessory = Accessory::factory()->create(['name' => Str::random()]); + $accessory->refresh(); + + $importFileBuilder = ImportFileBuilder::new([ + 'companyName' => ' ', + 'purchaseDate' => ' ', + 'purchaseCost' => '', + 'location' => '', + 'companyName' => '', + 'orderNumber' => '', + 'category' => '', + 'quantity' => '', + 'manufacturerName' => '', + 'supplierName' => '', + 'notes' => '', + 'requestAble' => '', + 'minimumAmount' => '', + 'modelNumber' => '' + ]); + + $import = Import::factory()->accessory()->create(['file_path' => $importFileBuilder->saveToImportsDirectory()]); + + $this->actingAsForApi(User::factory()->superuser()->create()); + $this->importFileResponse(['import' => $import->id]) + ->assertInternalServerError() + ->assertExactJson([ + 'status' => 'import-errors', + 'payload' => null, + 'messages' => [ + $importFileBuilder->firstRow()['itemName'] => [ + 'Accessory' => [ + 'qty' => ['The qty field must be at least 1.'], + 'category_id' => ['The category id field is required.'] + ] + ] + ] + ]); + + $importFileBuilder->replace(['itemName' => $accessory->name]); + + $import = Import::factory()->accessory()->create(['file_path' => $importFileBuilder->saveToImportsDirectory()]); + + $this->importFileResponse(['import' => $import->id, 'import-update' => true])->assertOk(); + + $updatedAccessory = clone $accessory; + $updatedAccessory->refresh(); + + $this->assertEquals($accessory->toArray(), $updatedAccessory->toArray()); + } + + #[Test] + public function customColumnMapping(): void + { + $faker = ImportFileBuilder::new()->definition(); + $row = [ + 'itemName' => $faker['modelNumber'], + 'purchaseDate' => $faker['notes'], + 'purchaseCost' => $faker['location'], + 'location' => $faker['purchaseCost'], + 'companyName' => $faker['orderNumber'], + 'orderNumber' => $faker['companyName'], + 'category' => $faker['manufacturerName'], + 'manufacturerName' => $faker['category'], + 'notes' => $faker['purchaseDate'], + 'minimumAmount' => $faker['supplierName'], + 'modelNumber' => $faker['itemName'], + 'quantity' => $faker['quantity'] + ]; + + $importFileBuilder = new ImportFileBuilder([$row]); + $import = Import::factory()->accessory()->create(['file_path' => $importFileBuilder->saveToImportsDirectory()]); + + $this->actingAsForApi(User::factory()->superuser()->create()); + $this->importFileResponse([ + 'import' => $import->id, + 'column-mappings' => [ + 'Item Name' => 'model_number', + 'Purchase Date' => 'notes', + 'Purchase Cost' => 'location', + 'Location' => 'purchase_cost', + 'Company' => 'order_number', + 'Order Number' => 'company', + 'Category' => 'manufacturer', + 'Manufacturer' => 'category', + 'Supplier' => 'min_amt', + 'Notes' => 'purchase_date', + 'Min QTY' => 'supplier', + 'Model Number' => 'item_name', + 'Quantity' => 'quantity' + ] + ])->assertOk(); + + $newAccessory = Accessory::query() + ->with(['location', 'category', 'manufacturer', 'supplier']) + ->where('name', $row['modelNumber']) + ->sole(); + + $this->assertEquals($row['modelNumber'], $newAccessory->name); + $this->assertEquals($row['itemName'], $newAccessory->model_number); + $this->assertEquals($row['quantity'], $newAccessory->qty); + $this->assertEquals($row['notes'], $newAccessory->purchase_date->toDateString()); + $this->assertEquals($row['location'], $newAccessory->purchase_cost); + $this->assertEquals($row['companyName'], $newAccessory->order_number); + $this->assertEquals($row['purchaseDate'], $newAccessory->notes); + $this->assertEquals($row['manufacturerName'], $newAccessory->category->name); + $this->assertEquals($row['category'], $newAccessory->manufacturer->name); + $this->assertEquals($row['purchaseCost'], $newAccessory->location->name); + } +} diff --git a/tests/Feature/Importing/Api/ImportAssetsTest.php b/tests/Feature/Importing/Api/ImportAssetsTest.php new file mode 100644 index 000000000..e001add38 --- /dev/null +++ b/tests/Feature/Importing/Api/ImportAssetsTest.php @@ -0,0 +1,595 @@ +actingAsForApi(User::factory()->create()); + + $this->importFileResponse(['import' => 44])->assertForbidden(); + } + + #[Test] + public function userWithImportAssetsPermissionCanImportAssets(): void + { + $this->actingAsForApi(User::factory()->canImport()->create()); + + $import = Import::factory()->asset()->create(); + + $this->importFileResponse(['import' => $import->id])->assertOk(); + } + + #[Test] + public function importAsset(): void + { + Notification::fake(); + + $importFileBuilder = ImportFileBuilder::new(); + $row = $importFileBuilder->firstRow(); + $import = Import::factory()->asset()->create(['file_path' => $importFileBuilder->saveToImportsDirectory()]); + + $this->actingAsForApi(User::factory()->superuser()->create()); + $this->importFileResponse(['import' => $import->id]) + ->assertOk() + ->assertExactJson([ + 'payload' => null, + 'status' => 'success', + 'messages' => ['redirect_url' => route('hardware.index')] + ]); + + $newAsset = Asset::query() + ->with(['location', 'supplier', 'company', 'assignedAssets', 'defaultLoc', 'assetStatus', 'model.category', 'model.manufacturer']) + ->where('serial', $row['serialNumber']) + ->sole(); + + $assignee = User::query()->find($newAsset->assigned_to, ['id', 'first_name', 'last_name', 'email', 'username']); + + $activityLogs = ActionLog::query() + ->where('item_type', Asset::class) + ->where('item_id', $newAsset->id) + ->get(); + + $this->assertCount(2, $activityLogs); + + $this->assertEquals('checkout', $activityLogs[0]->action_type); + $this->assertEquals(Asset::class, $activityLogs[0]->item_type); + $this->assertEquals($assignee->id, $activityLogs[0]->target_id); + $this->assertEquals(User::class, $activityLogs[0]->target_type); + $this->assertEquals('Checkout from CSV Importer', $activityLogs[0]->note); + + $this->assertEquals('create', $activityLogs[1]->action_type); + $this->assertNull($activityLogs[1]->target_id); + $this->assertEquals(Asset::class, $activityLogs[1]->item_type); + $this->assertNull($activityLogs[1]->note); + $this->assertNull($activityLogs[1]->target_type); + + $this->assertEquals($row['assigneeFullName'], "{$assignee->first_name} {$assignee->last_name}"); + $this->assertEquals($row['assigneeEmail'], $assignee->email); + $this->assertEquals($row['assigneeUsername'], $assignee->username); + + $this->assertEquals($row['category'], $newAsset->model->category->name); + $this->assertEquals($row['manufacturerName'], $newAsset->model->manufacturer->name); + $this->assertEquals($row['itemName'], $newAsset->name); + $this->assertEquals($row['tag'], $newAsset->asset_tag); + $this->assertEquals($row['model'], $newAsset->model->name); + $this->assertEquals($row['modelNumber'], $newAsset->model->model_number); + $this->assertEquals($row['purchaseDate'], $newAsset->purchase_date->toDateString()); + $this->assertNull($newAsset->asset_eol_date); + $this->assertEquals(0, $newAsset->eol_explicit); + $this->assertEquals($newAsset->location_id, $newAsset->rtd_location_id); + $this->assertEquals($row['purchaseCost'], $newAsset->purchase_cost); + $this->assertNull($newAsset->order_number); + $this->assertEquals('', $newAsset->image); + $this->assertNull($newAsset->user_id); + $this->assertEquals(1, $newAsset->physical); + $this->assertEquals($row['status'], $newAsset->assetStatus->name); + $this->assertEquals(0, $newAsset->archived); + $this->assertEquals($row['warrantyInMonths'], $newAsset->warranty_months); + $this->assertNull($newAsset->deprecate); + $this->assertEquals($row['supplierName'], $newAsset->supplier->name); + $this->assertEquals(0, $newAsset->requestable); + $this->assertEquals($row['location'], $newAsset->defaultLoc->name); + $this->assertEquals(null, $newAsset->accepted); + $this->assertEquals(now()->toDateString(), Carbon::parse($newAsset->last_checkout)->toDateString()); + $this->assertEquals(0, $newAsset->last_checkin); + $this->assertEquals(0, $newAsset->expected_checkin); + $this->assertEquals($row['companyName'], $newAsset->company->name); + $this->assertEquals(User::class, $newAsset->assigned_type); + $this->assertNull($newAsset->last_audit_date); + $this->assertNull($newAsset->next_audit_date); + $this->assertEquals($row['location'], $newAsset->location->name); + $this->assertEquals(0, $newAsset->checkin_counter); + $this->assertEquals(1, $newAsset->checkout_counter); + $this->assertEquals(0, $newAsset->requests_counter); + $this->assertEquals(0, $newAsset->byod); + + //Notes is never read. + // $this->assertEquals($row['notes'], $newAsset->notes); + + Notification::assertSentTo($assignee, CheckoutAssetNotification::class); + } + + #[Test] + public function willIgnoreUnknownColumnsWhenFileContainsUnknownColumns(): void + { + $row = ImportFileBuilder::new()->definition(); + $row['unknownColumnInCsvFile'] = 'foo'; + + $importFileBuilder = new ImportFileBuilder([$row]); + + $this->actingAsForApi(User::factory()->superuser()->create()); + + $import = Import::factory()->asset()->create(['file_path' => $importFileBuilder->saveToImportsDirectory()]); + + $this->importFileResponse(['import' => $import->id])->assertOk(); + } + + #[Test] + public function willNotCreateNewAssetWhenAssetWithSameTagAlreadyExists(): void + { + $asset = Asset::factory()->create(['asset_tag' => $this->faker->uuid]); + $importFileBuilder = ImportFileBuilder::times(4)->replace(['tag' => $asset->asset_tag]); + $import = Import::factory()->asset()->create(['file_path' => $importFileBuilder->saveToImportsDirectory()]); + + $this->actingAsForApi(User::factory()->superuser()->create()); + $this->importFileResponse(['import' => $import->id]) + ->assertInternalServerError() + ->assertExactJson([ + 'status' => 'import-errors', + 'payload' => null, + 'messages' => [ + '' => [ + 'asset_tag' => [ + 'asset_tag' => [ + "An asset with the asset tag {$asset->asset_tag} already exists and an update was not requested. No change was made." + ] + ] + ] + ] + ]); + + $assetsWithSameTag = Asset::query()->where('asset_tag', $asset->asset_tag)->get(); + + $this->assertCount(1, $assetsWithSameTag); + } + + #[Test] + public function willNotCreateNewCompanyWhenCompanyExists(): void + { + $importFileBuilder = ImportFileBuilder::times(4)->replace(['companyName' => Str::random()]); + $import = Import::factory()->asset()->create(['file_path' => $importFileBuilder->saveToImportsDirectory()]); + + $this->actingAsForApi(User::factory()->superuser()->create()); + $this->importFileResponse(['import' => $import->id])->assertOk(); + + $newAssets = Asset::query() + ->whereIn('serial', $importFileBuilder->pluck('serialNumber')) + ->get(); + + $this->assertCount(1, $newAssets->pluck('company_id')->unique()->all()); + } + + #[Test] + public function willNotCreateNewLocationWhenLocationExists(): void + { + $importFileBuilder = ImportFileBuilder::times(4)->replace(['location' => Str::random()]); + $import = Import::factory()->asset()->create(['file_path' => $importFileBuilder->saveToImportsDirectory()]); + + $this->actingAsForApi(User::factory()->superuser()->create()); + $this->importFileResponse(['import' => $import->id])->assertOk(); + + $newAssets = Asset::query() + ->whereIn('serial', $importFileBuilder->pluck('serialNumber')) + ->get(); + + $this->assertCount(1, $newAssets->pluck('location_id')->unique()->all()); + } + + #[Test] + public function willNotCreateNewSupplierWhenSupplierExists(): void + { + $importFileBuilder = ImportFileBuilder::times(4)->replace(['supplierName' => $this->faker->company]); + $import = Import::factory()->asset()->create(['file_path' => $importFileBuilder->saveToImportsDirectory()]); + + $this->actingAsForApi(User::factory()->superuser()->create()); + $this->importFileResponse(['import' => $import->id])->assertOk(); + + $newAssets = Asset::query() + ->whereIn('serial', $importFileBuilder->pluck('serialNumber')) + ->get(['supplier_id']); + + $this->assertCount(1, $newAssets->pluck('supplier_id')->unique()->all()); + } + + #[Test] + public function willNotCreateNewManufacturerWhenManufacturerExists(): void + { + $importFileBuilder = ImportFileBuilder::times(4)->replace(['manufacturerName' => $this->faker->company]); + $import = Import::factory()->asset()->create(['file_path' => $importFileBuilder->saveToImportsDirectory()]); + + $this->actingAsForApi(User::factory()->superuser()->create()); + $this->importFileResponse(['import' => $import->id])->assertOk(); + + $newAssets = Asset::query() + ->with('model.manufacturer') + ->whereIn('serial', $importFileBuilder->pluck('serialNumber')) + ->get(); + + $this->assertCount(1, $newAssets->pluck('model.manufacturer_id')->unique()->all()); + } + + #[Test] + public function willNotCreateCategoryWhenCategoryExists(): void + { + $importFileBuilder = ImportFileBuilder::times(4)->replace(['category' => $this->faker->company]); + $import = Import::factory()->asset()->create(['file_path' => $importFileBuilder->saveToImportsDirectory()]); + + $this->actingAsForApi(User::factory()->superuser()->create()); + $this->importFileResponse(['import' => $import->id])->assertOk(); + + $newAssets = Asset::query() + ->with('model.category') + ->whereIn('serial', $importFileBuilder->pluck('serialNumber')) + ->get(); + + $this->assertCount(1, $newAssets->pluck('model.category_id')->unique()->all()); + } + + #[Test] + public function willNotCreateNewAssetModelWhenAssetModelExists(): void + { + $importFileBuilder = ImportFileBuilder::times(4)->replace(['model' => Str::random()]); + $import = Import::factory()->asset()->create(['file_path' => $importFileBuilder->saveToImportsDirectory()]); + + $this->actingAsForApi(User::factory()->superuser()->create()); + $this->importFileResponse(['import' => $import->id])->assertOk(); + + $newAssets = Asset::query() + ->with('model') + ->whereIn('serial', $importFileBuilder->pluck('serialNumber')) + ->get(); + + $this->assertCount(1, $newAssets->pluck('model.name')->unique()->all()); + } + + #[Test] + public function whenColumnsAreMissingInImportFile(): void + { + $importFileBuilder = ImportFileBuilder::times()->forget([ + 'purchaseCost', + 'purchaseDate', + 'status' + ]); + + $import = Import::factory()->asset()->create(['file_path' => $importFileBuilder->saveToImportsDirectory()]); + + $this->actingAsForApi(User::factory()->superuser()->create()); + $this->importFileResponse(['import' => $import->id])->assertOk(); + + $newAsset = Asset::query() + ->with(['assetStatus']) + ->where('serial', $importFileBuilder->firstRow()['serialNumber']) + ->sole(); + + $this->assertEquals('Ready to Deploy', $newAsset->assetStatus->name); + $this->assertNull($newAsset->purchase_date); + $this->assertNull($newAsset->purchase_cost); + } + + #[Test] + public function willFormatValues(): void + { + $importFileBuilder = ImportFileBuilder::new([ + 'warrantyInMonths' => '3 months', + 'purchaseDate' => '2022/10/10' + ]); + + $import = Import::factory()->asset()->create(['file_path' => $importFileBuilder->saveToImportsDirectory()]); + + $this->actingAsForApi(User::factory()->superuser()->create()); + $this->importFileResponse(['import' => $import->id])->assertOk(); + + $newAsset = Asset::query() + ->where('serial', $importFileBuilder->firstRow()['serialNumber']) + ->sole(); + + $this->assertEquals(3, $newAsset->warranty_months); + $this->assertEquals('2022-10-10', $newAsset->purchase_date->toDateString()); + } + + #[Test] + public function whenRequiredColumnsAreMissingInImportFile(): void + { + $importFileBuilder = ImportFileBuilder::times(2) + ->forget(['tag']) + ->replace(['model' => '']); + + $rows = $importFileBuilder->all(); + $import = Import::factory()->asset()->create(['file_path' => $importFileBuilder->saveToImportsDirectory()]); + + $this->actingAsForApi(User::factory()->superuser()->create()); + $this->importFileResponse(['import' => $import->id]) + ->assertInternalServerError() + ->assertJson([ + 'status' => 'import-errors', + 'payload' => null, + 'messages' => [ + $rows[0]['itemName'] => [ + "Asset \"{$rows[0]['itemName']}\"" => [ + 'asset_tag' => [ + 'The asset tag field must be at least 1 characters.', + ], + 'model_id' => [ + 'The model id field is required.' + ] + ] + ], + $rows[1]['itemName'] => [ + "Asset \"{$rows[1]['itemName']}\"" => [ + 'asset_tag' => [ + 'The asset tag field must be at least 1 characters.', + ], + 'model_id' => [ + 'The model id field is required.' + ] + ] + ] + ] + ]); + + $newAssets = Asset::query() + ->whereIn('serial', Arr::pluck($rows, 'serialNumber')) + ->get(); + + $this->assertCount(0, $newAssets); + } + + #[Test] + public function updateAssetFromImport(): void + { + $asset = Asset::factory()->create()->refresh(); + $importFileBuilder = ImportFileBuilder::times(1)->replace(['tag' => $asset->asset_tag]); + $row = $importFileBuilder->firstRow(); + $import = Import::factory()->asset()->create(['file_path' => $importFileBuilder->saveToImportsDirectory()]); + + $this->actingAsForApi(User::factory()->superuser()->create()); + $this->importFileResponse(['import' => $import->id, 'import-update' => true])->assertOk(); + + $updatedAsset = Asset::query() + ->with(['location', 'supplier', 'company', 'defaultLoc', 'assetStatus', 'model.category', 'model.manufacturer']) + ->find($asset->id); + + $assignee = User::query()->find($updatedAsset->assigned_to, ['id', 'first_name', 'last_name', 'email', 'username']); + + $updatedAttributes = [ + 'category', 'manufacturer_id', 'name', 'tag', 'model_id', + 'model_number', 'purchase_date', 'purchase_cost', 'warranty_months', 'supplier_id', + 'location_id', 'company_id', 'serial', 'assigned_to', 'status_id', 'rtd_location_id', + 'last_checkout', 'requestable', 'updated_at', 'checkout_counter', 'assigned_type' + ]; + + $this->assertEquals($row['assigneeFullName'], "{$assignee->first_name} {$assignee->last_name}"); + $this->assertEquals($row['assigneeEmail'], $assignee->email); + $this->assertEquals($row['assigneeUsername'], $assignee->username); + + $this->assertEquals($row['category'], $updatedAsset->model->category->name); + $this->assertEquals($row['manufacturerName'], $updatedAsset->model->manufacturer->name); + $this->assertEquals($row['itemName'], $updatedAsset->name); + $this->assertEquals($row['tag'], $updatedAsset->asset_tag); + $this->assertEquals($row['model'], $updatedAsset->model->name); + $this->assertEquals($row['modelNumber'], $updatedAsset->model->model_number); + $this->assertEquals($row['purchaseDate'], $updatedAsset->purchase_date->toDateString()); + $this->assertEquals($row['purchaseCost'], $updatedAsset->purchase_cost); + $this->assertEquals($row['status'], $updatedAsset->assetStatus->name); + $this->assertEquals($row['warrantyInMonths'], $updatedAsset->warranty_months); + $this->assertEquals($row['supplierName'], $updatedAsset->supplier->name); + $this->assertEquals($row['location'], $updatedAsset->defaultLoc->name); + $this->assertEquals($row['companyName'], $updatedAsset->company->name); + $this->assertEquals($row['location'], $updatedAsset->location->name); + $this->assertEquals(1, $updatedAsset->checkout_counter); + $this->assertEquals(user::class, $updatedAsset->assigned_type); + + //RequestAble is always updated regardless of initial value. + // $this->assertEquals($asset->requestable, $updatedAsset->requestable); + + $this->assertEquals( + Arr::except($asset->attributesToArray(), $updatedAttributes), + Arr::except($updatedAsset->attributesToArray(), $updatedAttributes), + ); + } + + #[Test] + public function customColumnMapping(): void + { + $faker = ImportFileBuilder::new()->definition(); + $row = [ + 'assigneeFullName' => $faker['supplierName'], + 'assigneeEmail' => $faker['manufacturerName'], + 'assigneeUsername' => $faker['serialNumber'], + 'category' => $faker['location'], + 'companyName' => $faker['purchaseCost'], + 'itemName' => $faker['modelNumber'], + 'location' => $faker['assigneeUsername'], + 'manufacturerName' => $faker['status'], + 'model' => $faker['itemName'], + 'modelNumber' => $faker['category'], + 'notes' => $faker['notes'], + 'purchaseCost' => $faker['model'], + 'purchaseDate' => $faker['companyName'], + 'serialNumber' => $faker['tag'], + 'supplierName' => $faker['purchaseDate'], + 'status' => $faker['warrantyInMonths'], + 'tag' => $faker['assigneeEmail'], + 'warrantyInMonths' => $faker['assigneeFullName'], + ]; + + $importFileBuilder = new ImportFileBuilder([$row]); + $import = Import::factory()->asset()->create(['file_path' => $importFileBuilder->saveToImportsDirectory()]); + + $this->actingAsForApi(User::factory()->superuser()->create()); + + $this->importFileResponse([ + 'import' => $import->id, + 'column-mappings' => [ + 'Asset Tag' => 'email', + 'Category' => 'location', + 'Company' => 'purchase_cost', + 'Email' => 'manufacturer', + 'Full Name' => 'supplier', + 'Item Name' => 'model_number', + 'Location' => 'username', + 'Manufacturer' => 'status', + 'Model name' => 'item_name', + 'Model Number' => 'category', + 'Notes' => 'asset_notes', + 'Purchase Cost' => 'asset_model', + 'Purchase Date' => 'company', + 'Serial number' => 'asset_tag', + 'Status' => 'warranty_months', + 'Supplier' => 'purchase_date', + 'Username' => 'serial', + 'Warranty' => 'full_name', + ] + ])->assertOk(); + + $asset = Asset::query() + ->with(['location', 'supplier', 'company', 'assignedAssets', 'defaultLoc', 'assetStatus', 'model.category', 'model.manufacturer']) + ->where('serial', $row['assigneeUsername']) + ->sole(); + + $assignee = User::query()->find($asset->assigned_to, ['id', 'first_name', 'last_name', 'email', 'username']); + + $this->assertEquals($row['warrantyInMonths'], "{$assignee->first_name} {$assignee->last_name}"); + $this->assertEquals($row['tag'], $assignee->email); + $this->assertEquals($row['location'], $assignee->username); + + $this->assertEquals($row['modelNumber'], $asset->model->category->name); + $this->assertEquals($row['assigneeEmail'], $asset->model->manufacturer->name); + $this->assertEquals($row['model'], $asset->name); + $this->assertEquals($row['serialNumber'], $asset->asset_tag); + $this->assertEquals($row['purchaseCost'], $asset->model->name); + $this->assertEquals($row['itemName'], $asset->model->model_number); + $this->assertEquals($row['supplierName'], $asset->purchase_date->toDateString()); + $this->assertEquals($row['companyName'], $asset->purchase_cost); + $this->assertEquals($row['manufacturerName'], $asset->assetStatus->name); + $this->assertEquals($row['status'], $asset->warranty_months); + $this->assertEquals($row['assigneeFullName'], $asset->supplier->name); + $this->assertEquals($row['category'], $asset->defaultLoc->name); + $this->assertEquals($row['purchaseDate'], $asset->company->name); + $this->assertEquals($row['category'], $asset->location->name); + $this->assertEquals($row['notes'], $asset->notes); + $this->assertNull($asset->asset_eol_date); + $this->assertEquals(0, $asset->eol_explicit); + $this->assertNull($asset->order_number); + $this->assertEquals('', $asset->image); + $this->assertNull($asset->user_id); + $this->assertEquals(1, $asset->physical); + $this->assertEquals(0, $asset->archived); + $this->assertNull($asset->deprecate); + $this->assertEquals(0, $asset->requestable); + $this->assertEquals(null, $asset->accepted); + $this->assertEquals(now()->toDateString(), Carbon::parse($asset->last_checkout)->toDateString()); + $this->assertEquals(0, $asset->last_checkin); + $this->assertEquals(0, $asset->expected_checkin); + $this->assertEquals(User::class, $asset->assigned_type); + $this->assertNull($asset->last_audit_date); + $this->assertNull($asset->next_audit_date); + $this->assertEquals(0, $asset->checkin_counter); + $this->assertEquals(1, $asset->checkout_counter); + $this->assertEquals(0, $asset->requests_counter); + $this->assertEquals(0, $asset->byod); + } + + #[Test] + public function customFields(): void + { + $macAddress = $this->faker->macAddress; + + $row = ImportFileBuilder::new()->definition(); + $row['Mac Address'] = $macAddress; + + $importFileBuilder = new ImportFileBuilder([$row]); + $customField = CustomField::query()->where('name', 'Mac Address')->firstOrNew(); + + if (!$customField->exists) { + $customField = CustomField::factory()->macAddress()->create(['db_column' => '_snipeit_mac_address_1']); + } + + if ($customField->field_encrypted) { + $customField->field_encrypted = 0; + $customField->save(); + } + + $import = Import::factory()->asset()->create(['file_path' => $importFileBuilder->saveToImportsDirectory()]); + + $this->actingAsForApi(User::factory()->superuser()->create()); + $this->importFileResponse(['import' => $import->id])->assertOk(); + + $newAsset = Asset::query()->where('serial', $importFileBuilder->firstRow()['serialNumber'])->sole(); + + $this->assertEquals($macAddress, $newAsset->getAttribute($customField->db_column)); + } + + #[Test] + public function willEncryptCustomFields(): void + { + $macAddress = $this->faker->macAddress; + $row = ImportFileBuilder::new()->definition(); + + $row['Mac Address'] = $macAddress; + + $importFileBuilder = new ImportFileBuilder([$row]); + $customField = CustomField::query()->where('name', 'Mac Address')->firstOrNew(); + + if (!$customField->exists) { + $customField = CustomField::factory()->macAddress()->create(); + } + + if (!$customField->field_encrypted) { + $customField->field_encrypted = 1; + $customField->save(); + } + + $import = Import::factory()->asset()->create(['file_path' => $importFileBuilder->saveToImportsDirectory()]); + + $this->actingAsForApi(User::factory()->superuser()->create()); + $this->importFileResponse(['import' => $import->id])->assertOk(); + + $asset = Asset::query()->where('serial', $importFileBuilder->firstRow()['serialNumber'])->sole(); + $encryptedMacAddress = $asset->getAttribute($customField->db_column); + + $this->assertNotEquals($encryptedMacAddress, $macAddress); + } +} diff --git a/tests/Feature/Importing/Api/ImportComponentsTest.php b/tests/Feature/Importing/Api/ImportComponentsTest.php new file mode 100644 index 000000000..376b5b32e --- /dev/null +++ b/tests/Feature/Importing/Api/ImportComponentsTest.php @@ -0,0 +1,305 @@ +actingAsForApi(User::factory()->create()); + + $this->importFileResponse(['import' => 44])->assertForbidden(); + } + + #[Test] + public function userWithImportAssetsPermissionCanImportComponents(): void + { + $this->actingAsForApi(User::factory()->canImport()->create()); + + $import = Import::factory()->component()->create(); + + $this->importFileResponse(['import' => $import->id])->assertOk(); + } + + #[Test] + public function importComponents(): void + { + Notification::fake(); + + $importFileBuilder = ImportFileBuilder::new(); + $row = $importFileBuilder->firstRow(); + $import = Import::factory()->component()->create(['file_path' => $importFileBuilder->saveToImportsDirectory()]); + + $this->actingAsForApi(User::factory()->superuser()->create()); + $this->importFileResponse(['import' => $import->id]) + ->assertOk() + ->assertExactJson([ + 'payload' => null, + 'status' => 'success', + 'messages' => ['redirect_url' => route('components.index')] + ]); + + $newComponent = Component::query() + ->with(['location', 'category', 'company']) + ->where('name', $row['itemName']) + ->sole(); + + $activityLog = ActionLog::query() + ->where('item_type', Component::class) + ->where('item_id', $newComponent->id) + ->sole(); + + $this->assertEquals('create', $activityLog->action_type); + $this->assertEquals('importer', $activityLog->action_source); + $this->assertEquals($newComponent->company->id, $activityLog->company_id); + + $this->assertEquals($row['itemName'], $newComponent->name); + $this->assertEquals($row['companyName'], $newComponent->company->name); + $this->assertEquals($row['category'], $newComponent->category->name); + $this->assertEquals($row['location'], $newComponent->location->name); + $this->assertNull($newComponent->supplier_id); + $this->assertEquals($row['quantity'], $newComponent->qty); + $this->assertEquals($row['orderNumber'], $newComponent->order_number); + $this->assertEquals($row['purchaseDate'], $newComponent->purchase_date->toDateString()); + $this->assertEquals($row['purchaseCost'], $newComponent->purchase_cost); + $this->assertNull($newComponent->min_amt); + $this->assertEquals($row['serialNumber'], $newComponent->serial); + $this->assertNull($newComponent->image); + $this->assertNull($newComponent->notes); + } + + #[Test] + public function willIgnoreUnknownColumnsWhenFileContainsUnknownColumns(): void + { + $row = ImportFileBuilder::new()->firstRow(); + $row['unknownColumnInCsvFile'] = 'foo'; + + $importFileBuilder = new ImportFileBuilder([$row]); + + $this->actingAsForApi(User::factory()->superuser()->create()); + + $import = Import::factory()->component()->create(['file_path' => $importFileBuilder->saveToImportsDirectory()]); + + $this->importFileResponse(['import' => $import->id])->assertOk(); + } + + #[Test] + public function willNotCreateNewComponentWhenComponentWithNameAndSerialNumberExists(): void + { + $component = Component::factory()->create(); + + $importFileBuilder = ImportFileBuilder::times(4)->replace([ + 'itemName' => $component->name, + 'serialNumber' => $component->serial + ]); + + $import = Import::factory()->component()->create(['file_path' => $importFileBuilder->saveToImportsDirectory()]); + + $this->actingAsForApi(User::factory()->superuser()->create()); + $this->importFileResponse(['import' => $import->id])->assertOk(); + + $probablyNewComponents = Component::query() + ->where('name', $component->name) + ->where('serial', $component->serial) + ->get(['id']); + + $this->assertCount(1, $probablyNewComponents); + $this->assertEquals($component->id, $probablyNewComponents->sole()->id); + } + + #[Test] + public function willNotCreateNewCompanyWhenCompanyExists(): void + { + $importFileBuilder = ImportFileBuilder::times(4)->replace(['companyName' => Str::random()]); + $import = Import::factory()->component()->create(['file_path' => $importFileBuilder->saveToImportsDirectory()]); + + $this->actingAsForApi(User::factory()->superuser()->create()); + $this->importFileResponse(['import' => $import->id])->assertOk(); + + $newComponents = Component::query() + ->whereIn('serial', $importFileBuilder->pluck('serialNumber')) + ->get(['company_id']); + + $this->assertCount(1, $newComponents->pluck('company_id')->unique()->all()); + } + + #[Test] + public function willNotCreateNewLocationWhenLocationExists(): void + { + $importFileBuilder = ImportFileBuilder::times(4)->replace(['location' => Str::random()]); + $import = Import::factory()->component()->create(['file_path' => $importFileBuilder->saveToImportsDirectory()]); + + $this->actingAsForApi(User::factory()->superuser()->create()); + $this->importFileResponse(['import' => $import->id])->assertOk(); + + $newComponents = Component::query() + ->whereIn('serial', $importFileBuilder->pluck('serialNumber')) + ->get(['location_id']); + + $this->assertCount(1, $newComponents->pluck('location_id')->unique()->all()); + } + + #[Test] + public function willNotCreateNewCategoryWhenCategoryExists(): void + { + $importFileBuilder = ImportFileBuilder::times(4)->replace(['category' => $this->faker->company]); + $import = Import::factory()->component()->create(['file_path' => $importFileBuilder->saveToImportsDirectory()]); + + $this->actingAsForApi(User::factory()->superuser()->create()); + $this->importFileResponse(['import' => $import->id])->assertOk(); + + $newComponents = Component::query() + ->whereIn('serial', $importFileBuilder->pluck('serialNumber')) + ->get(['category_id']); + + $this->assertCount(1, $newComponents->pluck('category_id')->unique()->all()); + } + + #[Test] + public function whenRequiredColumnsAreMissingInImportFile(): void + { + $importFileBuilder = ImportFileBuilder::new() + ->replace(['category' => '']) + ->forget(['quantity']); + + $row = $importFileBuilder->firstRow(); + $import = Import::factory()->component()->create(['file_path' => $importFileBuilder->saveToImportsDirectory()]); + + $this->actingAsForApi(User::factory()->superuser()->create()); + + $this->importFileResponse(['import' => $import->id]) + ->assertInternalServerError() + ->assertExactJson([ + 'status' => 'import-errors', + 'payload' => null, + 'messages' => [ + $row['itemName'] => [ + 'Component' => [ + 'qty' => ['The qty field must be at least 1.'], + 'category_id' => ['The category id field is required.'] + ] + ] + ] + ]); + + $newComponents = Component::query() + ->whereIn('serial', $importFileBuilder->pluck('serialNumber')) + ->get(); + + $this->assertCount(0, $newComponents); + } + + #[Test] + public function updateComponentFromImport(): void + { + $component = Component::factory()->create(); + $importFileBuilder = ImportFileBuilder::new([ + 'itemName' => $component->name, + 'serialNumber' => $component->serial + ]); + + $row = $importFileBuilder->firstRow(); + $import = Import::factory()->component()->create(['file_path' => $importFileBuilder->saveToImportsDirectory()]); + + $this->actingAsForApi(User::factory()->superuser()->create()); + $this->importFileResponse(['import' => $import->id, 'import-update' => true])->assertOk(); + + $updatedComponent = Component::query() + ->with(['location', 'category']) + ->where('serial', $row['serialNumber']) + ->sole(); + + $this->assertEquals($row['itemName'], $updatedComponent->name); + $this->assertEquals($row['category'], $updatedComponent->category->name); + $this->assertEquals($row['location'], $updatedComponent->location->name); + $this->assertEquals($component->supplier_id, $updatedComponent->supplier_id); + $this->assertEquals($row['quantity'], $updatedComponent->qty); + $this->assertEquals($row['orderNumber'], $updatedComponent->order_number); + $this->assertEquals($row['purchaseDate'], $updatedComponent->purchase_date->toDateString()); + $this->assertEquals($row['purchaseCost'], $updatedComponent->purchase_cost); + $this->assertEquals($component->min_amt, $updatedComponent->min_amt); + $this->assertEquals($row['serialNumber'], $updatedComponent->serial); + $this->assertEquals($component->image, $updatedComponent->image); + $this->assertEquals($component->notes, $updatedComponent->notes); + } + + #[Test] + public function customColumnMapping(): void + { + $faker = ImportFileBuilder::new()->definition(); + $row = [ + 'category' => $faker['serialNumber'], + 'companyName' => $faker['quantity'], + 'itemName' => $faker['purchaseDate'], + 'location' => $faker['purchaseCost'], + 'orderNumber' => $faker['orderNumber'], + 'purchaseCost' => $faker['category'], + 'purchaseDate' => $faker['companyName'], + 'quantity' => $faker['itemName'], + 'serialNumber' => $faker['location'] + ]; + + $importFileBuilder = new ImportFileBuilder([$row]); + $import = Import::factory()->component()->create(['file_path' => $importFileBuilder->saveToImportsDirectory()]); + + $this->actingAsForApi(User::factory()->superuser()->create()); + + $this->importFileResponse([ + 'import' => $import->id, + 'column-mappings' => [ + 'Category' => 'serial', + 'Company' => 'quantity', + 'item Name' => 'purchase_date', + 'Location' => 'purchase_cost', + 'Order Number' => 'order_number', + 'Purchase Cost' => 'category', + 'Purchase Date' => 'company', + 'Quantity' => 'item_name', + 'Serial number' => 'location', + ] + ])->assertOk(); + + $newComponent = Component::query() + ->with(['location', 'category']) + ->where('serial', $importFileBuilder->firstRow()['category']) + ->sole(); + + $this->assertEquals($row['quantity'], $newComponent->name); + $this->assertEquals($row['purchaseCost'], $newComponent->category->name); + $this->assertEquals($row['serialNumber'], $newComponent->location->name); + $this->assertNull($newComponent->supplier_id); + $this->assertEquals($row['companyName'], $newComponent->qty); + $this->assertEquals($row['orderNumber'], $newComponent->order_number); + $this->assertEquals($row['itemName'], $newComponent->purchase_date->toDateString()); + $this->assertEquals($row['location'], $newComponent->purchase_cost); + $this->assertNull($newComponent->min_amt); + $this->assertNull($newComponent->image); + $this->assertNull($newComponent->notes); + } +} diff --git a/tests/Feature/Importing/Api/ImportConsumablesTest.php b/tests/Feature/Importing/Api/ImportConsumablesTest.php new file mode 100644 index 000000000..81bfdf4bf --- /dev/null +++ b/tests/Feature/Importing/Api/ImportConsumablesTest.php @@ -0,0 +1,305 @@ +actingAsForApi(User::factory()->create()); + + $this->importFileResponse(['import' => 44])->assertForbidden(); + } + + #[Test] + public function userWithImportAssetsPermissionCanImportConsumables(): void + { + $this->actingAsForApi(User::factory()->canImport()->create()); + + $import = Import::factory()->consumable()->create(); + + $this->importFileResponse(['import' => $import->id])->assertOk(); + } + + #[Test] + public function importConsumables(): void + { + Notification::fake(); + + $importFileBuilder = ImportFileBuilder::new(); + $row = $importFileBuilder->firstRow(); + $import = Import::factory()->consumable()->create(['file_path' => $importFileBuilder->saveToImportsDirectory()]); + + $this->actingAsForApi(User::factory()->superuser()->create()); + $this->importFileResponse(['import' => $import->id]) + ->assertOk() + ->assertExactJson([ + 'payload' => null, + 'status' => 'success', + 'messages' => ['redirect_url' => route('consumables.index')] + ]); + + $newConsumable = Consumable::query() + ->with(['location', 'category', 'company']) + ->where('name', $row['itemName']) + ->sole(); + + $activityLog = ActivityLog::query() + ->where('item_type', Consumable::class) + ->where('item_id', $newConsumable->id) + ->sole(); + + $this->assertEquals('create', $activityLog->action_type); + $this->assertEquals('importer', $activityLog->action_source); + $this->assertEquals($newConsumable->company->id, $activityLog->company_id); + + $this->assertEquals($row['itemName'], $newConsumable->name); + $this->assertEquals($row['category'], $newConsumable->category->name); + $this->assertEquals($row['location'], $newConsumable->location->name); + $this->assertEquals($row['companyName'], $newConsumable->company->name); + $this->assertNull($newConsumable->supplier_id); + $this->assertFalse($newConsumable->requestable); + $this->assertNull($newConsumable->image); + $this->assertEquals($row['orderNumber'], $newConsumable->order_number); + $this->assertEquals($row['purchaseDate'], $newConsumable->purchase_date->toDateString()); + $this->assertEquals($row['purchaseCost'], $newConsumable->purchase_cost); + $this->assertNull($newConsumable->min_amt); + $this->assertEquals('', $newConsumable->model_number); + $this->assertNull($newConsumable->item_number); + $this->assertNull($newConsumable->manufacturer_id); + $this->assertNull($newConsumable->notes); + } + + #[Test] + public function willIgnoreUnknownColumnsWhenFileContainsUnknownColumns(): void + { + $row = ImportFileBuilder::new()->definition(); + $row['unknownColumnInCsvFile'] = 'foo'; + + $importFileBuilder = new ImportFileBuilder([$row]); + + $this->actingAsForApi(User::factory()->superuser()->create()); + + $import = Import::factory()->consumable()->create(['file_path' => $importFileBuilder->saveToImportsDirectory()]); + + $this->importFileResponse(['import' => $import->id])->assertOk(); + } + + #[Test] + public function willNotCreateNewConsumableWhenConsumableNameAlreadyExist(): void + { + $consumable = Consumable::factory()->create(['name' => Str::random()]); + $importFileBuilder = ImportFileBuilder::new(['itemName' => $consumable->name]); + $import = Import::factory()->consumable()->create(['file_path' => $importFileBuilder->saveToImportsDirectory()]); + + $this->actingAsForApi(User::factory()->superuser()->create()); + $this->importFileResponse(['import' => $import->id])->assertOk(); + + $probablyNewConsumables = Consumable::query() + ->where('name', $consumable->name) + ->get(); + + $this->assertCount(1, $probablyNewConsumables); + $this->assertEquals($consumable->id, $probablyNewConsumables->sole()->id); + } + + #[Test] + public function willNotCreateNewCompanyWhenCompanyExists(): void + { + $importFileBuilder = ImportFileBuilder::times(4)->replace(['companyName' => Str::random()]); + $import = Import::factory()->consumable()->create(['file_path' => $importFileBuilder->saveToImportsDirectory()]); + + $this->actingAsForApi(User::factory()->superuser()->create()); + $this->importFileResponse(['import' => $import->id])->assertOk(); + + $newConsumables = Consumable::query() + ->whereIn('name', $importFileBuilder->pluck('itemName')) + ->get(['company_id']); + + $this->assertCount(1, $newConsumables->pluck('company_id')->unique()->all()); + } + + #[Test] + public function willNotCreateNewLocationWhenLocationExists(): void + { + $importFileBuilder = ImportFileBuilder::times(4)->replace(['location' => Str::random()]); + $import = Import::factory()->consumable()->create(['file_path' => $importFileBuilder->saveToImportsDirectory()]); + + $this->actingAsForApi(User::factory()->superuser()->create()); + $this->importFileResponse(['import' => $import->id])->assertOk(); + + $newConsumables = Consumable::query() + ->whereIn('name', $importFileBuilder->pluck('itemName')) + ->get(['location_id']); + + $this->assertCount(1, $newConsumables->pluck('location_id')->unique()->all()); + } + + #[Test] + public function willNotCreateNewCategoryWhenCategoryExists(): void + { + $importFileBuilder = ImportFileBuilder::times(4)->replace(['category' => Str::random()]); + $import = Import::factory()->consumable()->create(['file_path' => $importFileBuilder->saveToImportsDirectory()]); + + $this->actingAsForApi(User::factory()->superuser()->create()); + $this->importFileResponse(['import' => $import->id])->assertOk(); + + $newConsumables = Consumable::query() + ->whereIn('name', $importFileBuilder->pluck('itemName')) + ->get(['category_id']); + + $this->assertCount(1, $newConsumables->pluck('category_id')->unique()->all()); + } + + #[Test] + public function whenRequiredColumnsAreMissingInImportFile(): void + { + $importFileBuilder = ImportFileBuilder::new(['category' => ''])->forget(['quantity', 'name']); + + $row = $importFileBuilder->firstRow(); + $import = Import::factory()->consumable()->create(['file_path' => $importFileBuilder->saveToImportsDirectory()]); + + $this->actingAsForApi(User::factory()->superuser()->create()); + + $this->importFileResponse(['import' => $import->id]) + ->assertInternalServerError() + ->assertExactJson([ + 'status' => 'import-errors', + 'payload' => null, + 'messages' => [ + $row['itemName'] => [ + 'Consumable' => [ + 'category_id' => ['The category id field is required.'] + ] + ] + ] + ]); + + $newConsumables = Consumable::query() + ->whereIn('name', $importFileBuilder->pluck('itemName')) + ->get(['id']); + + $this->assertCount(0, $newConsumables); + } + + #[Test] + public function updateConsumableFromImport(): void + { + $consumable = Consumable::factory()->create(['name' => Str::random()]); + $importFileBuilder = ImportFileBuilder::new(['itemName' => $consumable->name]); + + $row = $importFileBuilder->firstRow(); + $import = Import::factory()->consumable()->create(['file_path' => $importFileBuilder->saveToImportsDirectory()]); + + $this->actingAsForApi(User::factory()->superuser()->create()); + $this->importFileResponse(['import' => $import->id, 'import-update' => true])->assertOk(); + + $updatedConsumable = Consumable::query() + ->with(['location', 'category', 'company']) + ->where('name', $importFileBuilder->firstRow()['itemName']) + ->sole(); + + $this->assertEquals($row['itemName'], $updatedConsumable->name); + $this->assertEquals($row['category'], $updatedConsumable->category->name); + $this->assertEquals($row['location'], $updatedConsumable->location->name); + $this->assertEquals($row['companyName'], $updatedConsumable->company->name); + $this->assertEquals($row['orderNumber'], $updatedConsumable->order_number); + $this->assertEquals($row['purchaseDate'], $updatedConsumable->purchase_date->toDateString()); + $this->assertEquals($row['purchaseCost'], $updatedConsumable->purchase_cost); + + $this->assertEquals($consumable->supplier_id, $updatedConsumable->supplier_id); + $this->assertEquals($consumable->requestable, $updatedConsumable->requestable); + $this->assertEquals($consumable->min_amt, $updatedConsumable->min_amt); + $this->assertEquals($consumable->model_number, $updatedConsumable->model_number); + $this->assertEquals($consumable->item_number, $updatedConsumable->item_number); + $this->assertEquals($consumable->manufacturer_id, $updatedConsumable->manufacturer_id); + $this->assertEquals($consumable->notes, $updatedConsumable->notes); + $this->assertEquals($consumable->item_number, $updatedConsumable->item_number); + } + + #[Test] + public function customColumnMapping(): void + { + $faker = ImportFileBuilder::new()->definition(); + $row = [ + 'category' => $faker['supplier'], + 'companyName' => $faker['quantity'], + 'itemName' => $faker['purchaseDate'], + 'location' => $faker['purchaseCost'], + 'orderNumber' => $faker['orderNumber'], + 'purchaseCost' => $faker['location'], + 'purchaseDate' => $faker['companyName'], + 'quantity' => $faker['itemName'], + 'supplier' => $faker['category'] + ]; + + $importFileBuilder = new ImportFileBuilder([$row]); + + $import = Import::factory()->consumable()->create(['file_path' => $importFileBuilder->saveToImportsDirectory()]); + + $this->actingAsForApi(User::factory()->superuser()->create()); + + $this->importFileResponse([ + 'import' => $import->id, + 'column-mappings' => [ + 'Category' => 'supplier', + 'Company' => 'quantity', + 'item Name' => 'purchase_date', + 'Location' => 'purchase_cost', + 'Order Number' => 'order_number', + 'Purchase Cost' => 'location', + 'Purchase Date' => 'company', + 'Quantity' => 'item_name', + 'Supplier' => 'category', + ] + ])->assertOk(); + + $newConsumable = Consumable::query() + ->with(['location', 'category', 'company']) + ->where('name', $importFileBuilder->firstRow()['quantity']) + ->sole(); + + $this->assertEquals($row['supplier'], $newConsumable->category->name); + $this->assertEquals($row['purchaseCost'], $newConsumable->location->name); + $this->assertEquals($row['purchaseDate'], $newConsumable->company->name); + $this->assertEquals($row['companyName'], $newConsumable->qty); + $this->assertEquals($row['quantity'], $newConsumable->name); + $this->assertNull($newConsumable->supplier_id); + $this->assertFalse($newConsumable->requestable); + $this->assertNull($newConsumable->image); + $this->assertEquals($row['orderNumber'], $newConsumable->order_number); + $this->assertEquals($row['itemName'], $newConsumable->purchase_date->toDateString()); + $this->assertEquals($row['location'], $newConsumable->purchase_cost); + $this->assertNull($newConsumable->min_amt); + $this->assertEquals('', $newConsumable->model_number); + $this->assertNull($newConsumable->item_number); + $this->assertNull($newConsumable->manufacturer_id); + $this->assertNull($newConsumable->notes); + } +} diff --git a/tests/Feature/Importing/Api/ImportDataTestCase.php b/tests/Feature/Importing/Api/ImportDataTestCase.php new file mode 100644 index 000000000..eaa2a8f03 --- /dev/null +++ b/tests/Feature/Importing/Api/ImportDataTestCase.php @@ -0,0 +1,14 @@ +postJson(route('api.imports.importFile', $parameters), $parameters); + } +} diff --git a/tests/Feature/Importing/Api/ImportLicenseTest.php b/tests/Feature/Importing/Api/ImportLicenseTest.php new file mode 100644 index 000000000..0cd5fe447 --- /dev/null +++ b/tests/Feature/Importing/Api/ImportLicenseTest.php @@ -0,0 +1,356 @@ +actingAsForApi(User::factory()->create()); + + $this->importFileResponse(['import' => 44])->assertForbidden(); + } + + #[Test] + public function userWithImportAssetsPermissionCanImportLicenses(): void + { + $this->actingAsForApi(User::factory()->canImport()->create()); + + $import = Import::factory()->license()->create(); + + $this->importFileResponse(['import' => $import->id])->assertOk(); + } + + #[Test] + public function importLicenses(): void + { + $importFileBuilder = ImportFileBuilder::new(); + $row = $importFileBuilder->firstRow(); + $import = Import::factory()->license()->create(['file_path' => $importFileBuilder->saveToImportsDirectory()]); + + $this->actingAsForApi(User::factory()->superuser()->create()); + $this->importFileResponse(['import' => $import->id]) + ->assertOk() + ->assertExactJson([ + 'payload' => null, + 'status' => 'success', + 'messages' => ['redirect_url' => route('licenses.index')] + ]); + + $newLicense = License::query() + ->withCasts(['reassignable' => 'bool']) + ->with(['category', 'company', 'manufacturer', 'supplier']) + ->where('serial', $row['serialNumber']) + ->sole(); + + $activityLogs = ActivityLog::query() + ->where('item_type', License::class) + ->where('item_id', $newLicense->id) + ->get(); + + $this->assertCount(2, $activityLogs); + + $this->assertEquals($row['licenseName'], $newLicense->name); + $this->assertEquals($row['serialNumber'], $newLicense->serial); + $this->assertEquals($row['purchaseDate'], $newLicense->purchase_date->toDateString()); + $this->assertEquals($row['purchaseCost'], $newLicense->purchase_cost); + $this->assertEquals($row['orderNumber'], $newLicense->order_number); + $this->assertEquals($row['seats'], $newLicense->seats); + $this->assertEquals($row['notes'], $newLicense->notes); + $this->assertEquals($row['licensedToName'], $newLicense->license_name); + $this->assertEquals($row['licensedToEmail'], $newLicense->license_email); + $this->assertEquals($row['supplierName'], $newLicense->supplier->name); + $this->assertEquals($row['companyName'], $newLicense->company->name); + $this->assertEquals($row['category'], $newLicense->category->name); + $this->assertEquals($row['expirationDate'], $newLicense->expiration_date->toDateString()); + $this->assertEquals($row['isMaintained'] === 'TRUE', $newLicense->maintained); + $this->assertEquals($row['isReassignAble'] === 'TRUE', $newLicense->reassignable); + $this->assertEquals('', $newLicense->purchase_order); + $this->assertNull($newLicense->depreciation_id); + $this->assertNull($newLicense->termination_date); + $this->assertNull($newLicense->deprecate); + $this->assertNull($newLicense->min_amt); + } + + #[Test] + public function willIgnoreUnknownColumnsWhenFileContainsUnknownColumns(): void + { + $row = ImportFileBuilder::new()->definition(); + $row['unknownColumnInCsvFile'] = 'foo'; + + $importFileBuilder = new ImportFileBuilder([$row]); + + $this->actingAsForApi(User::factory()->superuser()->create()); + + $import = Import::factory()->license()->create(['file_path' => $importFileBuilder->saveToImportsDirectory()]); + + $this->importFileResponse(['import' => $import->id])->assertOk(); + } + + #[Test] + public function willNotCreateNewLicenseWhenNameAndSerialNumberAlreadyExist(): void + { + $license = License::factory()->create(); + + $importFileBuilder = ImportFileBuilder::times(4)->replace([ + 'itemName' => $license->name, + 'serialNumber' => $license->serial + ]); + + $import = Import::factory()->license()->create(['file_path' => $importFileBuilder->saveToImportsDirectory()]); + + $this->actingAsForApi(User::factory()->superuser()->create()); + $this->importFileResponse(['import' => $import->id])->assertOk(); + + $probablyNewLicenses = License::query() + ->where('name', $license->name) + ->where('serial', $license->serial) + ->get(); + + $this->assertCount(1, $probablyNewLicenses); + } + + #[Test] + public function formatAttributes(): void + { + $importFileBuilder = ImportFileBuilder::new([ + 'expirationDate' => '2022/10/10' + ]); + + $import = Import::factory()->license()->create(['file_path' => $importFileBuilder->saveToImportsDirectory()]); + + $this->actingAsForApi(User::factory()->superuser()->create()); + $this->importFileResponse(['import' => $import->id])->assertOk(); + + $newLicense = License::query() + ->where('serial', $importFileBuilder->firstRow()['serialNumber']) + ->sole(); + + $this->assertEquals('2022-10-10', $newLicense->expiration_date->toDateString()); + } + + #[Test] + public function willNotCreateNewCompanyWhenCompanyExists(): void + { + $importFileBuilder = ImportFileBuilder::times(4)->replace(['companyName' => Str::random()]); + $import = Import::factory()->license()->create(['file_path' => $importFileBuilder->saveToImportsDirectory()]); + + $this->actingAsForApi(User::factory()->superuser()->create()); + $this->importFileResponse(['import' => $import->id])->assertOk(); + + $newLicenses = License::query() + ->whereIn('serial', $importFileBuilder->pluck('serialNumber')) + ->get(['company_id']); + + $this->assertCount(1, $newLicenses->pluck('company_id')->unique()->all()); + } + + #[Test] + public function willNotCreateNewManufacturerWhenManufacturerExists(): void + { + $importFileBuilder = ImportFileBuilder::times(4)->replace(['manufacturerName' => Str::random()]); + $import = Import::factory()->license()->create(['file_path' => $importFileBuilder->saveToImportsDirectory()]); + + $this->actingAsForApi(User::factory()->superuser()->create()); + $this->importFileResponse(['import' => $import->id])->assertOk(); + + $newLicenses = License::query() + ->whereIn('serial', $importFileBuilder->pluck('serialNumber')) + ->get(['manufacturer_id']); + + $this->assertCount(1, $newLicenses->pluck('manufacturer_id')->unique()->all()); + } + + #[Test] + public function willNotCreateNewCategoryWhenCategoryExists(): void + { + $importFileBuilder = ImportFileBuilder::times(4)->replace(['category' => $this->faker->company]); + $import = Import::factory()->license()->create(['file_path' => $importFileBuilder->saveToImportsDirectory()]); + + $this->actingAsForApi(User::factory()->superuser()->create()); + $this->importFileResponse(['import' => $import->id])->assertOk(); + + $newLicenses = License::query() + ->whereIn('serial', $importFileBuilder->pluck('serialNumber')) + ->get(['category_id']); + + $this->assertCount(1, $newLicenses->pluck('category_id')->unique()->all()); + } + + #[Test] + public function whenRequiredColumnsAreMissingInImportFile(): void + { + $importFileBuilder = ImportFileBuilder::times() + ->replace(['name' => '']) + ->forget(['seats']); + + $row = $importFileBuilder->firstRow(); + $import = Import::factory()->license()->create(['file_path' => $importFileBuilder->saveToImportsDirectory()]); + + $this->actingAsForApi(User::factory()->superuser()->create()); + + $this->importFileResponse(['import' => $import->id]) + ->assertInternalServerError() + ->assertExactJson([ + 'status' => 'import-errors', + 'payload' => null, + 'messages' => [ + $row['licenseName'] => [ + "License \"{$row['licenseName']}\"" => [ + 'seats' => ['The seats field is required.'], + ] + ] + ] + ]); + + $newLicenses = License::query() + ->where('serial', $row['serialNumber']) + ->get(); + + $this->assertCount(0, $newLicenses); + } + + #[Test] + public function updateLicenseFromImport(): void + { + $license = License::factory()->create(); + $importFileBuilder = ImportFileBuilder::new([ + 'licenseName' => $license->name, + 'serialNumber' => $license->serial + ]); + + $row = $importFileBuilder->firstRow(); + $import = Import::factory()->license()->create(['file_path' => $importFileBuilder->saveToImportsDirectory()]); + + $this->actingAsForApi(User::factory()->superuser()->create()); + $this->importFileResponse(['import' => $import->id, 'import-update' => true])->assertOk(); + + $updatedLicense = License::query() + ->with(['manufacturer', 'category', 'supplier']) + ->where('serial', $row['serialNumber']) + ->sole(); + + $this->assertEquals($row['licenseName'], $updatedLicense->name); + $this->assertEquals($row['serialNumber'], $updatedLicense->serial); + $this->assertEquals($row['purchaseDate'], $updatedLicense->purchase_date->toDateString()); + $this->assertEquals($row['purchaseCost'], $updatedLicense->purchase_cost); + $this->assertEquals($row['orderNumber'], $updatedLicense->order_number); + $this->assertEquals($row['seats'], $updatedLicense->seats); + $this->assertEquals($row['notes'], $updatedLicense->notes); + $this->assertEquals($row['licensedToName'], $updatedLicense->license_name); + $this->assertEquals($row['licensedToEmail'], $updatedLicense->license_email); + $this->assertEquals($row['supplierName'], $updatedLicense->supplier->name); + $this->assertEquals($row['companyName'], $updatedLicense->company->name); + $this->assertEquals($row['category'], $updatedLicense->category->name); + $this->assertEquals($row['expirationDate'], $updatedLicense->expiration_date->toDateString()); + $this->assertEquals($row['isMaintained'] === 'TRUE', $updatedLicense->maintained); + $this->assertEquals($row['isReassignAble'] === 'TRUE', $updatedLicense->reassignable); + $this->assertEquals($license->purchase_order, $updatedLicense->purchase_order); + $this->assertEquals($license->depreciation_id, $updatedLicense->depreciation_id); + $this->assertEquals($license->termination_date, $updatedLicense->termination_date); + $this->assertEquals($license->deprecate, $updatedLicense->deprecate); + $this->assertEquals($license->min_amt, $updatedLicense->min_amt); + } + + #[Test] + public function customColumnMapping(): void + { + $faker = ImportFileBuilder::times()->definition(); + $row = [ + 'category' => $faker['supplierName'], + 'companyName' => $faker['serialNumber'], + 'expirationDate' => $faker['seats'], + 'isMaintained' => $faker['purchaseDate'], + 'isReassignAble' => $faker['purchaseCost'], + 'licensedToName' => $faker['orderNumber'], + 'licensedToEmail' => $faker['notes'], + 'licenseName' => $faker['licenseName'], + 'manufacturerName' => $faker['category'], + 'notes' => $faker['companyName'], + 'orderNumber' => $faker['expirationDate'], + 'purchaseCost' => $faker['isMaintained'], + 'purchaseDate' => $faker['isReassignAble'], + 'seats' => $faker['licensedToName'], + 'serialNumber' => $faker['licensedToEmail'], + 'supplierName' => $faker['manufacturerName'] + ]; + + $importFileBuilder = new ImportFileBuilder([$row]); + $import = Import::factory()->license()->create(['file_path' => $importFileBuilder->saveToImportsDirectory()]); + + $this->actingAsForApi(User::factory()->superuser()->create()); + + $this->importFileResponse([ + 'import' => $import->id, + 'column-mappings' => [ + 'Category' => 'supplier', + 'Company' => 'serial', + 'expiration date' => 'seats', + 'maintained' => 'purchase_date', + 'reassignable' => 'purchase_cost', + 'Licensed To Name' => 'order_number', + 'Licensed To Email' => 'notes', + 'licenseName' => 'name', + 'manufacturer' => 'category', + 'Notes' => 'company', + 'Serial number' => 'license_email', + 'Order Number' => 'expiration_date', + 'purchase Cost' => 'maintained', + 'purchase Date' => 'reassignable', + 'seats' => 'license_name', + 'supplier' => 'manufacturer' + ] + ])->assertOk(); + + $newLicense = License::query() + ->with(['category', 'company', 'manufacturer', 'supplier']) + ->where('serial', $row['companyName']) + ->sole(); + + $this->assertEquals($row['licenseName'], $newLicense->name); + $this->assertEquals($row['companyName'], $newLicense->serial); + $this->assertEquals($row['isMaintained'], $newLicense->purchase_date->toDateString()); + $this->assertEquals($row['isReassignAble'], $newLicense->purchase_cost); + $this->assertEquals($row['licensedToName'], $newLicense->order_number); + $this->assertEquals($row['expirationDate'], $newLicense->seats); + $this->assertEquals($row['licensedToEmail'], $newLicense->notes); + $this->assertEquals($row['seats'], $newLicense->license_name); + $this->assertEquals($row['serialNumber'], $newLicense->license_email); + $this->assertEquals($row['category'], $newLicense->supplier->name); + $this->assertEquals($row['notes'], $newLicense->company->name); + $this->assertEquals($row['manufacturerName'], $newLicense->category->name); + $this->assertEquals($row['orderNumber'], $newLicense->expiration_date->toDateString()); + $this->assertEquals($row['purchaseCost'] === 'TRUE', $newLicense->maintained); + $this->assertEquals($row['purchaseDate'] === 'TRUE', $newLicense->reassignable); + $this->assertEquals('', $newLicense->purchase_order); + $this->assertNull($newLicense->depreciation_id); + $this->assertNull($newLicense->termination_date); + $this->assertNull($newLicense->deprecate); + $this->assertNull($newLicense->min_amt); + } +} diff --git a/tests/Feature/Importing/Api/ImportUsersTest.php b/tests/Feature/Importing/Api/ImportUsersTest.php new file mode 100644 index 000000000..f8c0b7c74 --- /dev/null +++ b/tests/Feature/Importing/Api/ImportUsersTest.php @@ -0,0 +1,336 @@ +actingAsForApi(User::factory()->create()); + + $this->importFileResponse(['import' => 44])->assertForbidden(); + } + + #[Test] + public function userWithImportAssetsPermissionCanImportUsers(): void + { + $this->actingAsForApi(User::factory()->canImport()->create()); + + $import = Import::factory()->users()->create(); + + $this->importFileResponse(['import' => $import->id])->assertOk(); + } + + #[Test] + public function importUsers(): void + { + Notification::fake(); + + $importFileBuilder = ImportFileBuilder::new(); + $row = $importFileBuilder->firstRow(); + $import = Import::factory()->users()->create(['file_path' => $importFileBuilder->saveToImportsDirectory()]); + + $this->actingAsForApi(User::factory()->superuser()->create()); + $this->importFileResponse(['import' => $import->id, 'send-welcome' => 1]) + ->assertOk() + ->assertExactJson([ + 'payload' => null, + 'status' => 'success', + 'messages' => ['redirect_url' => route('users.index')] + ]); + + $newUser = User::query() + ->with(['company', 'location']) + ->where('username', $row['username']) + ->sole(); + + Notification::assertNothingSent(); + + $this->assertEquals($row['email'], $newUser->email); + $this->assertEquals($row['firstName'], $newUser->first_name); + $this->assertEquals($row['lastName'], $newUser->last_name); + $this->assertEquals($row['employeeNumber'], $newUser->employee_num); + $this->assertEquals($row['companyName'], $newUser->company->name); + $this->assertEquals($row['location'], $newUser->location->name); + $this->assertEquals($row['phoneNumber'], $newUser->phone); + $this->assertEquals($row['position'], $newUser->jobtitle); + $this->assertTrue(Hash::isHashed($newUser->password)); + $this->assertEquals('', $newUser->website); + $this->assertEquals('', $newUser->country); + $this->assertEquals('', $newUser->address); + $this->assertEquals('', $newUser->city); + $this->assertEquals('', $newUser->state); + $this->assertEquals('', $newUser->zip); + $this->assertNull($newUser->permissions); + $this->assertNull($newUser->avatar); + $this->assertNull($newUser->notes); + $this->assertNull($newUser->skin); + $this->assertNull($newUser->department_id); + $this->assertNull($newUser->two_factor_secret); + $this->assertNull($newUser->idap_import); + $this->assertEquals('en-US', $newUser->locale); + $this->assertEquals(1, $newUser->show_in_list); + $this->assertEquals(0, $newUser->two_factor_enrolled); + $this->assertEquals(0, $newUser->two_factor_optin); + $this->assertEquals(0, $newUser->remote); + $this->assertEquals(0, $newUser->autoassign_licenses); + $this->assertEquals(0, $newUser->vip); + $this->assertEquals(0, $newUser->enable_sounds); + $this->assertEquals(0, $newUser->enable_confetti); + $this->assertNull($newUser->created_by); + $this->assertNull($newUser->start_date); + $this->assertNull($newUser->end_date); + $this->assertNull($newUser->scim_externalid); + $this->assertNull($newUser->manager_id); + $this->assertNull($newUser->activation_code); + $this->assertNull($newUser->last_login); + $this->assertNull($newUser->persist_code); + $this->assertNull($newUser->reset_password_code); + $this->assertEquals(0, $newUser->activated); + } + + #[Test] + public function willIgnoreUnknownColumnsWhenFileContainsUnknownColumns(): void + { + $row = ImportFileBuilder::new()->definition(); + $row['unknownColumnInCsvFile'] = 'foo'; + + $importFileBuilder = new ImportFileBuilder([$row]); + + $this->actingAsForApi(User::factory()->superuser()->create()); + + $import = Import::factory()->users()->create(['file_path' => $importFileBuilder->saveToImportsDirectory()]); + + $this->importFileResponse(['import' => $import->id])->assertOk(); + } + + #[Test] + public function willNotCreateNewUserWhenUserWithUserNameAlreadyExist(): void + { + $user = User::factory()->create(['username' => Str::random()]); + $importFileBuilder = ImportFileBuilder::times(4)->replace(['username' => $user->username]); + $import = Import::factory()->users()->create(['file_path' => $importFileBuilder->saveToImportsDirectory()]); + + $this->actingAsForApi(User::factory()->superuser()->create()); + $this->importFileResponse(['import' => $import->id])->assertOk(); + + $probablyNewUsers = User::query() + ->where('username', $user->username) + ->get(); + + $this->assertCount(1, $probablyNewUsers); + } + + #[Test] + public function willGenerateUsernameWhenUsernameFieldIsMissing(): void + { + $importFileBuilder = ImportFileBuilder::new()->forget('username'); + $row = $importFileBuilder->firstRow(); + $import = Import::factory()->users()->create(['file_path' => $importFileBuilder->saveToImportsDirectory()]); + + $this->actingAsForApi(User::factory()->superuser()->create()); + $this->importFileResponse(['import' => $import->id])->assertOk(); + + $newUser = User::query() + ->where('email', $row['email']) + ->sole(); + + $generatedUsername = User::generateFormattedNameFromFullName("{$row['firstName']} {$row['lastName']}")['username']; + + $this->assertEquals($generatedUsername, $newUser->username); + } + + #[Test] + public function willUpdateLocationOfAllAssetsAssignedToUser(): void + { + $user = User::factory()->create(['username' => Str::random()]); + $assetsAssignedToUser = Asset::factory()->create(['assigned_to' => $user->id, 'assigned_type' => User::class]); + $importFileBuilder = ImportFileBuilder::new(['username' => $user->username]); + $import = Import::factory()->users()->create(['file_path' => $importFileBuilder->saveToImportsDirectory()]); + + $this->actingAsForApi(User::factory()->superuser()->create()); + $this->importFileResponse(['import' => $import->id, 'import-update' => true])->assertOk(); + + $userLocation = Location::query()->where('name', $importFileBuilder->firstRow()['location'])->sole(['id']); + + $this->assertEquals( + $userLocation->id, + $assetsAssignedToUser->refresh()->location_id + ); + } + + #[Test] + public function whenRequiredColumnsAreMissingInImportFile(): void + { + $importFileBuilder = ImportFileBuilder::new(['firstName' => ''])->forget(['username']); + $import = Import::factory()->users()->create(['file_path' => $importFileBuilder->saveToImportsDirectory()]); + + $this->actingAsForApi(User::factory()->superuser()->create()); + + $this->importFileResponse(['import' => $import->id]) + ->assertInternalServerError() + ->assertExactJson([ + 'status' => 'import-errors', + 'payload' => null, + 'messages' => [ + '' => [ + 'User' => [ + 'first_name' => ['The first name field is required.'], + ] + ] + ] + ]); + + $newUsers = User::query() + ->where('email', $importFileBuilder->firstRow()['email']) + ->get(); + + $this->assertCount(0, $newUsers); + } + + #[Test] + public function updateUserFromImport(): void + { + $user = User::factory()->create(['username' => Str::random()])->refresh(); + $importFileBuilder = ImportFileBuilder::new(['username' => $user->username]); + + $row = $importFileBuilder->firstRow(); + $import = Import::factory()->users()->create(['file_path' => $importFileBuilder->saveToImportsDirectory()]); + + $this->actingAsForApi(User::factory()->superuser()->create()); + $this->importFileResponse(['import' => $import->id, 'import-update' => true])->assertOk(); + + $updatedUser = User::query()->with(['company', 'location'])->find($user->id); + $updatedAttributes = [ + 'first_name', 'email', 'last_name', 'employee_num', 'company', + 'location_id', 'company_id', 'updated_at', 'phone', 'jobtitle' + ]; + + $this->assertEquals($row['email'], $updatedUser->email); + $this->assertEquals($row['firstName'], $updatedUser->first_name); + $this->assertEquals($row['lastName'], $updatedUser->last_name); + $this->assertEquals($row['employeeNumber'], $updatedUser->employee_num); + $this->assertEquals($row['companyName'], $updatedUser->company->name); + $this->assertEquals($row['location'], $updatedUser->location->name); + $this->assertEquals($row['phoneNumber'], $updatedUser->phone); + $this->assertEquals($row['position'], $updatedUser->jobtitle); + $this->assertTrue(Hash::isHashed($updatedUser->password)); + + $this->assertEquals( + Arr::except($user->attributesToArray(), $updatedAttributes), + Arr::except($updatedUser->attributesToArray(), $updatedAttributes), + ); + } + + #[Test] + public function customColumnMapping(): void + { + $faker = ImportFileBuilder::new()->definition(); + $row = [ + 'companyName' => $faker['username'], + 'email' => $faker['position'], + 'employeeNumber' => $faker['phoneNumber'], + 'firstName' => $faker['location'], + 'lastName' => $faker['lastName'], + 'location' => $faker['firstName'], + 'phoneNumber' => $faker['employeeNumber'], + 'position' => $faker['email'], + 'username' => $faker['companyName'], + ]; + + $importFileBuilder = new ImportFileBuilder([$row]); + $import = Import::factory()->users()->create(['file_path' => $importFileBuilder->saveToImportsDirectory()]); + + $this->actingAsForApi(User::factory()->superuser()->create()); + + $this->importFileResponse([ + 'import' => $import->id, + 'column-mappings' => [ + 'Company' => 'username', + 'email' => 'jobtitle', + 'Employee Number' => 'phone_number', + 'First Name' => 'location', + 'Last Name' => 'last_name', + 'Location' => 'first_name', + 'Phone Number' => 'employee_num', + 'Job Title' => 'email', + 'Username' => 'company', + ] + ])->assertOk(); + + $newUser = User::query() + ->with(['company', 'location']) + ->where('username', $row['companyName']) + ->sole(); + + $this->assertEquals($row['position'], $newUser->email); + $this->assertEquals($row['location'], $newUser->first_name); + $this->assertEquals($row['lastName'], $newUser->last_name); + $this->assertEquals($row['email'], $newUser->jobtitle); + $this->assertEquals($row['phoneNumber'], $newUser->employee_num); + $this->assertEquals($row['username'], $newUser->company->name); + $this->assertEquals($row['firstName'], $newUser->location->name); + $this->assertEquals($row['employeeNumber'], $newUser->phone); + $this->assertTrue(Hash::isHashed($newUser->password)); + $this->assertEquals('', $newUser->website); + $this->assertEquals('', $newUser->country); + $this->assertEquals('', $newUser->address); + $this->assertEquals('', $newUser->city); + $this->assertEquals('', $newUser->state); + $this->assertEquals('', $newUser->zip); + $this->assertNull($newUser->permissions); + $this->assertNull($newUser->avatar); + $this->assertNull($newUser->notes); + $this->assertNull($newUser->skin); + $this->assertNull($newUser->department_id); + $this->assertNull($newUser->two_factor_secret); + $this->assertNull($newUser->idap_import); + $this->assertEquals('en-US', $newUser->locale); + $this->assertEquals(1, $newUser->show_in_list); + $this->assertEquals(0, $newUser->two_factor_enrolled); + $this->assertEquals(0, $newUser->two_factor_optin); + $this->assertEquals(0, $newUser->remote); + $this->assertEquals(0, $newUser->autoassign_licenses); + $this->assertEquals(0, $newUser->vip); + $this->assertEquals(0, $newUser->enable_sounds); + $this->assertEquals(0, $newUser->enable_confetti); + $this->assertNull($newUser->created_by); + $this->assertNull($newUser->start_date); + $this->assertNull($newUser->end_date); + $this->assertNull($newUser->scim_externalid); + $this->assertNull($newUser->manager_id); + $this->assertNull($newUser->activation_code); + $this->assertNull($newUser->last_login); + $this->assertNull($newUser->persist_code); + $this->assertNull($newUser->reset_password_code); + $this->assertEquals(0, $newUser->activated); + } +} diff --git a/tests/Support/Importing/AccessoriesImportFileBuilder.php b/tests/Support/Importing/AccessoriesImportFileBuilder.php new file mode 100644 index 000000000..488c91fdc --- /dev/null +++ b/tests/Support/Importing/AccessoriesImportFileBuilder.php @@ -0,0 +1,74 @@ + + */ +class AccessoriesImportFileBuilder extends FileBuilder +{ + /** + * @inheritdoc + */ + protected function getDictionary(): array + { + return [ + 'category' => 'Category', + 'companyName' => 'Company', + 'itemName' => 'Item Name', + 'location' => 'Location', + 'manufacturerName' => 'Manufacturer', + 'modelNumber' => 'Model Number', + 'notes' => 'Notes', + 'orderNumber' => 'Order Number', + 'purchaseCost' => 'Purchase Cost', + 'purchaseDate' => 'Purchase Date', + 'quantity' => 'Quantity', + 'supplierName' => 'Supplier', + ]; + } + + /** + * @inheritdoc + */ + public function definition(): array + { + $faker = fake(); + + return [ + 'category' => Str::random(), + 'companyName' => Str::random(), + 'itemName' => Str::random(), + 'location' => "{$faker->city}, {$faker->country}", + 'manufacturerName' => $faker->company, + 'modelNumber' => Str::random(), + 'notes' => $faker->sentence, + 'orderNumber' => Str::random(), + 'purchaseDate' => $faker->date(), + 'purchaseCost' => rand(1, 100), + 'quantity' => rand(1, 100), + 'supplierName' => $faker->company, + ]; + } +} diff --git a/tests/Support/Importing/AssetsImportFileBuilder.php b/tests/Support/Importing/AssetsImportFileBuilder.php new file mode 100644 index 000000000..df573536c --- /dev/null +++ b/tests/Support/Importing/AssetsImportFileBuilder.php @@ -0,0 +1,92 @@ + + */ +class AssetsImportFileBuilder extends FileBuilder +{ + /** + * @inheritdoc + */ + protected function getDictionary(): array + { + return [ + 'assigneeFullName' => 'Full Name', + 'assigneeEmail' => 'Email', + 'assigneeUsername' => 'Username', + 'category' => 'Category', + 'companyName' => 'Company', + 'itemName' => 'item Name', + 'location' => 'Location', + 'manufacturerName' => 'Manufacturer', + 'model' => 'Model name', + 'modelNumber' => 'Model Number', + 'notes' => 'Notes', + 'purchaseCost' => 'Purchase Cost', + 'purchaseDate' => 'Purchase Date', + 'serialNumber' => 'Serial number', + 'supplierName' => 'Supplier', + 'status' => 'Status', + 'tag' => 'Asset Tag', + 'warrantyInMonths' => 'Warranty', + ]; + } + + /** + * @inheritdoc + */ + public function definition(): array + { + $faker = fake(); + + return [ + 'assigneeFullName' => $faker->name, + 'assigneeEmail' => $faker->email, + 'assigneeUsername' => $faker->userName, + 'category' => Str::random(), + 'companyName' => Str::random() . " {$faker->companySuffix}", + 'itemName' => Str::random(), + 'location' => "{$faker->country},{$faker->city}", + 'manufacturerName' => $faker->company, + 'model' => Str::random(), + 'modelNumber' => Str::random(), + 'notes' => $faker->sentence(5), + 'purchaseCost' => rand(1, 100_000), + 'purchaseDate' => $faker->date, + 'serialNumber' => $faker->uuid, + 'supplierName' => $faker->company, + 'status' => $faker->randomElement(['Ready to Deploy', 'Archived', 'Pending']), + 'tag' => Str::random(), + 'warrantyInMonths' => rand(1, 12), + ]; + } +} diff --git a/tests/Support/Importing/CleansUpImportFiles.php b/tests/Support/Importing/CleansUpImportFiles.php new file mode 100644 index 000000000..8e0cbc310 --- /dev/null +++ b/tests/Support/Importing/CleansUpImportFiles.php @@ -0,0 +1,20 @@ +beforeApplicationDestroyed(function () use ($import) { + Storage::delete('private_uploads/imports/' . $import->file_path); + }); + }); + } +} diff --git a/tests/Support/Importing/ComponentsImportFileBuilder.php b/tests/Support/Importing/ComponentsImportFileBuilder.php new file mode 100644 index 000000000..6d0b16341 --- /dev/null +++ b/tests/Support/Importing/ComponentsImportFileBuilder.php @@ -0,0 +1,65 @@ + + */ +class ComponentsImportFileBuilder extends FileBuilder +{ + /** + * @inheritdoc + */ + protected function getDictionary(): array + { + return [ + 'category' => 'Category', + 'companyName' => 'Company', + 'itemName' => 'item Name', + 'location' => 'Location', + 'orderNumber' => 'Order Number', + 'purchaseCost' => 'Purchase Cost', + 'purchaseDate' => 'Purchase Date', + 'quantity' => 'Quantity', + 'serialNumber' => 'Serial number', + ]; + } + + /** + * @inheritdoc + */ + public function definition(): array + { + $faker = fake(); + + return [ + 'category' => Str::random(), + 'companyName' => Str::random() . " {$faker->companySuffix}", + 'itemName' => Str::random(), + 'location' => "{$faker->city}, {$faker->country}", + 'orderNumber' => "ON:COM:{$faker->uuid}", + 'purchaseCost' => rand(1, 100_000), + 'purchaseDate' => $faker->date, + 'quantity' => rand(1, 100_000), + 'serialNumber' => 'SN:COM:' . Str::random(), + ]; + } +} diff --git a/tests/Support/Importing/ConsumablesImportFileBuilder.php b/tests/Support/Importing/ConsumablesImportFileBuilder.php new file mode 100644 index 000000000..16722a2f0 --- /dev/null +++ b/tests/Support/Importing/ConsumablesImportFileBuilder.php @@ -0,0 +1,65 @@ + + */ +class ConsumablesImportFileBuilder extends FileBuilder +{ + /** + * @inheritdoc + */ + protected function getDictionary(): array + { + return [ + 'category' => 'Category', + 'companyName' => 'Company', + 'itemName' => 'item Name', + 'location' => 'Location', + 'orderNumber' => 'Order Number', + 'purchaseCost' => 'Purchase Cost', + 'purchaseDate' => 'Purchase Date', + 'quantity' => 'Quantity', + 'supplier' => 'Supplier', + ]; + } + + /** + * @inheritdoc + */ + public function definition(): array + { + $faker = fake(); + + return [ + 'category' => Str::random(), + 'companyName' => Str::random() . " {$faker->companySuffix}", + 'itemName' => Str::random(), + 'location' => "{$faker->city}, {$faker->country}", + 'orderNumber' => "ON:CON:{$faker->uuid}", + 'purchaseCost' => rand(1, 100_000), + 'purchaseDate' => $faker->date, + 'quantity' => rand(1, 100_000), + 'supplier' => Str::random() . " {$faker->companySuffix}", + ]; + } +} diff --git a/tests/Support/Importing/FileBuilder.php b/tests/Support/Importing/FileBuilder.php new file mode 100644 index 000000000..fad40054b --- /dev/null +++ b/tests/Support/Importing/FileBuilder.php @@ -0,0 +1,249 @@ + + */ + protected Collection $rows; + + /** + * Define the builders default row. + * + * @return Row + */ + abstract public function definition(); + + /** + * @param array $rows + */ + public function __construct(array $rows = []) + { + $this->rows = new Collection($rows); + } + + /** + * Get a new file builder instance. + * + * @param Row $attributes + * + * @return static + */ + public static function new(array $attributes = []) + { + $instance = new static; + + return $instance->push($instance->definition())->replace($attributes); + } + + /** + * Get a new file builder instance from an import file. + * + * @return static + */ + public static function fromFile(string $filepath) + { + $instance = new static; + + $reader = Reader::createFromPath($filepath); + $importFileHeaders = $reader->first(); + $dictionary = array_flip($instance->getDictionary()); + + foreach ($reader->getRecords() as $key => $record) { + $row = []; + + //Skip header. + if ($key === 0) { + continue; + } + + foreach ($record as $index => $value) { + $columnNameInImportFile = $importFileHeaders[$index]; + + //Try to map the value to a dictionary or use the file's + //column if the key is not defined in the dictionary. + $row[$dictionary[$columnNameInImportFile] ?? $columnNameInImportFile] = $value; + } + + $instance->push($row); + } + + return $instance; + } + + /** + * Get a new builder instance for the given number of rows. + * + * @return static + */ + public static function times(int $amountOfRows = 1) + { + $instance = new static; + + for ($i = 1; $i <= $amountOfRows; $i++) { + $instance->push($instance->definition()); + } + + return $instance; + } + + /** + * The the dictionary for mapping row keys to the corresponding import file headers. + * + * @return array + */ + protected function getDictionary(): array + { + return []; + } + + /** + * Add a new row. + * + * @param Row $row + * + * @return $this + */ + public function push(array $row) + { + if (!empty($row)) { + $this->rows->push($row); + } + + return $this; + } + + /** + * Pluck an array of values from the rows. + */ + public function pluck(string $key): array + { + return $this->rows->pluck($key)->all(); + } + + /** + * Replace the keys in each row with the values of the given replacement if they exist. + * + * @param array $replacement + * + * @return $this + */ + public function replace(array $replacement) + { + $this->rows = $this->rows->map(function (array $row) use ($replacement) { + foreach ($replacement as $key => $value) { + if (!array_key_exists($key, $row)) { + continue; + } + + $row[$key] = $value; + } + + return $row; + }); + + return $this; + } + + /** + * Remove the the given keys from all rows. + * + * @param string|array $keys + * + * @return $this + */ + public function forget(array|string $keys) + { + $keys = (array) $keys; + + $this->rows = $this->rows->map(function (array $row) use ($keys) { + foreach ($keys as $key) { + unset($row[$key]); + } + + return $row; + }); + + return $this; + } + + public function toCsv(): array + { + if ($this->rows->isEmpty()) { + return []; + } + + $headers = []; + $rows = $this->rows; + $dictionary = $this->getDictionary(); + + foreach (array_keys($rows->first()) as $key) { + $headers[] = $dictionary[$key] ?? $key; + } + + return $rows + ->map(fn (array $row) => array_values(array_combine($headers, $row))) + ->prepend($headers) + ->all(); + } + + /** + * Save the rows to the imports folder as a csv file. + * + * @return string The filename. + */ + public function saveToImportsDirectory(?string $filename = null): string + { + $filename ??= Str::random(40) . '.csv'; + + try { + $stream = fopen(config('app.private_uploads') . "/imports/{$filename}", 'w'); + + foreach ($this->toCsv() as $row) { + fputcsv($stream, $row); + } + + return $filename; + } finally { + if (is_resource($stream)) { + fclose($stream); + } + } + } + + /** + * Get the first row of the import file. + * + * @throws OutOfBoundsException + * + * @return Row + */ + public function firstRow(): array + { + return $this->rows->first(null, fn () => throw new OutOfBoundsException('Could not retrieve row from collection.')); + } + + /** + * Get the all the rows of the import file. + * + * @return array + */ + public function all(): array + { + return $this->rows->all(); + } +} diff --git a/tests/Support/Importing/LicensesImportFileBuilder.php b/tests/Support/Importing/LicensesImportFileBuilder.php new file mode 100644 index 000000000..2b5e5c01e --- /dev/null +++ b/tests/Support/Importing/LicensesImportFileBuilder.php @@ -0,0 +1,86 @@ + + */ +class LicensesImportFileBuilder extends FileBuilder +{ + /** + * @inheritdoc + */ + protected function getDictionary(): array + { + return [ + 'category' => 'Category', + 'companyName' => 'Company', + 'expirationDate' => 'expiration date', + 'isMaintained' => 'maintained', + 'isReassignAble' => 'reassignable', + 'licensedToName' => 'Licensed To Name', + 'licensedToEmail' => 'Licensed to Email', + 'licenseName' => 'Item name', + 'manufacturerName' => 'manufacturer', + 'notes' => 'notes', + 'orderNumber' => 'Order Number', + 'purchaseCost' => 'Purchase Cost', + 'purchaseDate' => 'Purchase Date', + 'seats' => 'seats', + 'serialNumber' => 'Serial number', + 'supplierName' => 'supplier', + ]; + } + + /** + * @inheritdoc + */ + public function definition(): array + { + $faker = fake(); + + return [ + 'category' => Str::random(), + 'companyName' => Str::random() . " {$faker->companySuffix}", + 'expirationDate' => $faker->date, + 'isMaintained' => $faker->randomElement(['TRUE', 'FALSE']), + 'isReassignAble' => $faker->randomElement(['TRUE', 'FALSE']), + 'licensedToName' => $faker->name, + 'licensedToEmail' => $faker->email, + 'licenseName' => $faker->company, + 'manufacturerName' => $faker->company, + 'notes' => $faker->sentence, + 'orderNumber' => "ON:LIC:{$faker->uuid}", + 'purchaseCost' => rand(1, 100_000), + 'purchaseDate' => $faker->date, + 'seats' => rand(1, 10), + 'serialNumber' => 'SN:LIC:' . Str::random(), + 'supplierName' => $faker->company, + ]; + } +} diff --git a/tests/Support/Importing/UsersImportFileBuilder.php b/tests/Support/Importing/UsersImportFileBuilder.php new file mode 100644 index 000000000..0a00c995c --- /dev/null +++ b/tests/Support/Importing/UsersImportFileBuilder.php @@ -0,0 +1,65 @@ + + */ +class UsersImportFileBuilder extends FileBuilder +{ + /** + * @inheritdoc + */ + protected function getDictionary(): array + { + return [ + 'companyName' => 'Company', + 'email' => 'email', + 'employeeNumber' => 'Employee Number', + 'firstName' => 'First Name', + 'lastName' => 'Last Name', + 'location' => 'Location', + 'phoneNumber' => 'Phone Number', + 'position' => 'Job Title', + 'username' => 'Username', + ]; + } + + /** + * @inheritdoc + */ + public function definition(): array + { + $faker = fake(); + + return [ + 'companyName' => $faker->company, + 'email' => Str::random(32) . "@{$faker->freeEmailDomain}", + 'employeeNumber' => $faker->uuid, + 'firstName' => $faker->firstName, + 'lastName' => $faker->lastName, + 'location' => "{$faker->city}, {$faker->country}", + 'phoneNumber' => $faker->phoneNumber, + 'position' => $faker->jobTitle, + 'username' => Str::random(), + ]; + } +}