1
0
mirror of https://github.com/invoiceninja/invoiceninja.git synced 2024-09-21 00:41:34 +02:00
invoiceninja/tests/Feature/Import/ImportCompanyTest.php
2021-05-30 06:50:55 +10:00

915 lines
28 KiB
PHP

<?php
/**
* Invoice Ninja (https://invoiceninja.com).
*
* @link https://github.com/invoiceninja/invoiceninja source repository
*
* @copyright Copyright (c) 2021. Invoice Ninja LLC (https://invoiceninja.com)
*
* @license https://opensource.org/licenses/AAL
*/
namespace Tests\Feature\Import;
use App\Jobs\Import\CSVImport;
use App\Models\Account;
use App\Models\Client;
use App\Models\ClientContact;
use App\Models\ClientGatewayToken;
use App\Models\Company;
use App\Models\CompanyGateway;
use App\Models\CompanyToken;
use App\Models\CompanyUser;
use App\Models\Credit;
use App\Models\CreditInvitation;
use App\Models\Expense;
use App\Models\ExpenseCategory;
use App\Models\GroupSetting;
use App\Models\Invoice;
use App\Models\InvoiceInvitation;
use App\Models\Payment;
use App\Models\PaymentTerm;
use App\Models\Paymentable;
use App\Models\Product;
use App\Models\Project;
use App\Models\Quote;
use App\Models\QuoteInvitation;
use App\Models\RecurringInvoice;
use App\Models\RecurringInvoiceInvitation;
use App\Models\Subscription;
use App\Models\Task;
use App\Models\TaskStatus;
use App\Models\TaxRate;
use App\Models\User;
use App\Models\Vendor;
use App\Models\VendorContact;
use App\Utils\Traits\MakesHash;
use Illuminate\Routing\Middleware\ThrottleRequests;
use Illuminate\Support\Facades\Cache;
use Illuminate\Support\Str;
use League\Csv\Reader;
use League\Csv\Statement;
use Tests\MockAccountData;
use Tests\TestCase;
/**
* @test
*
*/
class ImportCompanyTest extends TestCase
{
use MakesHash;
public $account;
public $company;
public $backup_json_object;
public $ids;
public function setUp() :void
{
parent::setUp();
$this->withoutMiddleware(
ThrottleRequests::class
);
$this->withoutExceptionHandling();
Account::all()->each(function ($account){
$account->delete();
});
$this->account = Account::factory()->create();
$this->company = Company::factory()->create(['account_id' => $this->account->id]);
$backup_json_file_zip = base_path().'/tests/Feature/Import/backup.zip';
$zip = new \ZipArchive;
$res = $zip->open($backup_json_file_zip);
if ($res === TRUE) {
$zip->extractTo(sys_get_temp_dir());
$zip->close();
}
$backup_json_file = sys_get_temp_dir() . "/backup/backup.json";
$this->backup_json_object = json_decode(file_get_contents($backup_json_file));
}
public function testBackupJsonRead()
{
$backup_json_file_zip = base_path().'/tests/Feature/Import/backup.zip';
$zip = new \ZipArchive;
$res = $zip->open($backup_json_file_zip);
if ($res === TRUE) {
$zip->extractTo(sys_get_temp_dir());
$zip->close();
}
$backup_json_file = sys_get_temp_dir() . "/backup/backup.json";
$this->assertTrue(is_array(json_decode(file_get_contents($backup_json_file),1)));
unlink($backup_json_file);
}
public function testAppVersion()
{
$this->assertEquals("5.1.65", $this->backup_json_object->app_version);
}
public function testImportUsers()
{
$this->assertTrue(property_exists($this->backup_json_object, 'app_version'));
/***************************** Users *****************************/
$this->assertTrue(property_exists($this->backup_json_object, 'users'));
User::all()->each(function ($user){
$user->forceDelete();
});
User::unguard();
$this->assertEquals(2, count($this->backup_json_object->users));
foreach ($this->backup_json_object->users as $user)
{
$user_array = (array)$user;
unset($user_array['laravel_through_key']);
unset($user_array['hashed_id']);
$new_user = User::firstOrNew(
['email' => $user->email],
array_merge($user_array, ['account_id' => $this->account->id]),
);
$new_user->save(['timestamps' => false]);
$this->ids['users']["{$user->hashed_id}"] = $new_user->id;
}
User::reguard();
$this->assertEquals(2, User::count());
/***************************** Users *****************************/
/***************************** Company Users *****************************/
$this->assertEquals(2, count($this->backup_json_object->company_users));
CompanyUser::unguard();
foreach($this->backup_json_object->company_users as $cu)
{
$user_id = $this->transformId('users', $cu->user_id);
$cu_array = (array)$cu;
unset($cu_array['user_id']);
unset($cu_array['company_id']);
unset($cu_array['account_id']);
unset($cu_array['hashed_id']);
unset($cu_array['id']);
$new_cu = CompanyUser::firstOrNew(
['user_id' => $user_id, 'company_id' => $this->company->id],
$cu_array,
);
$new_cu->account_id = $this->account->id;
$new_cu->save(['timestamps' => false]);
}
CompanyUser::reguard();
$this->assertEquals(2, CompanyUser::count());
/***************************** Company Users *****************************/
/***************************** Company Tokens *****************************/
$this->assertEquals(2, count($this->backup_json_object->company_tokens));
CompanyToken::unguard();
foreach($this->backup_json_object->company_tokens as $ct)
{
$user_id = $this->transformId('users', $ct->user_id);
$ct_array = (array)$ct;
unset($ct_array['user_id']);
unset($ct_array['company_id']);
unset($ct_array['account_id']);
unset($ct_array['hashed_id']);
unset($ct_array['id']);
$new_ct = CompanyToken::firstOrNew(
['user_id' => $user_id, 'company_id' => $this->company->id],
$ct_array,
);
$new_ct->account_id = $this->account->id;
$new_ct->save(['timestamps' => false]);
}
CompanyToken::reguard();
$this->assertEquals(2, CompanyToken::count());
/***************************** Company Tokens *****************************/
/***************************** Payment Terms *****************************/
PaymentTerm::unguard();
$this->assertEquals(8, count($this->backup_json_object->payment_terms));
foreach($this->backup_json_object->payment_terms as $obj)
{
$user_id = $this->transformId('users', $obj->user_id);
$obj_array = (array)$obj;
unset($obj_array['user_id']);
unset($obj_array['company_id']);
unset($obj_array['account_id']);
unset($obj_array['hashed_id']);
unset($obj_array['id']);
$new_obj = PaymentTerm::firstOrNew(
['num_days' => $obj->num_days, 'company_id' => $this->company->id],
$obj_array,
);
$new_obj->save(['timestamps' => false]);
}
PaymentTerm::reguard();
$this->assertEquals(8, PaymentTerm::count());
/***************************** Payment Terms *****************************/
/***************************** Tax Rates *****************************/
TaxRate::unguard();
$this->assertEquals(2, count($this->backup_json_object->tax_rates));
foreach($this->backup_json_object->tax_rates as $obj)
{
$user_id = $this->transformId('users', $obj->user_id);
$obj_array = (array)$obj;
unset($obj_array['user_id']);
unset($obj_array['company_id']);
unset($obj_array['account_id']);
unset($obj_array['hashed_id']);
unset($obj_array['id']);
unset($obj_array['tax_rate_id']);
$new_obj = TaxRate::firstOrNew(
['name' => $obj->name, 'company_id' => $this->company->id, 'rate' => $obj->rate],
$obj_array,
);
$new_obj->save(['timestamps' => false]);
}
TaxRate::reguard();
$this->assertEquals(2, TaxRate::count());
/***************************** Tax Rates *****************************/
/***************************** Expense Category *****************************/
ExpenseCategory::unguard();
$this->assertEquals(2, count($this->backup_json_object->expense_categories));
foreach($this->backup_json_object->expense_categories as $obj)
{
$user_id = $this->transformId('users', $obj->user_id);
$obj_array = (array)$obj;
unset($obj_array['user_id']);
unset($obj_array['company_id']);
unset($obj_array['account_id']);
unset($obj_array['hashed_id']);
unset($obj_array['id']);
unset($obj_array['tax_rate_id']);
$new_obj = ExpenseCategory::firstOrNew(
['name' => $obj->name, 'company_id' => $this->company->id],
$obj_array,
);
$new_obj->save(['timestamps' => false]);
}
ExpenseCategory::reguard();
$this->assertEquals(2, ExpenseCategory::count());
/***************************** Expense Category *****************************/
/***************************** Task Statuses *****************************/
TaskStatus::unguard();
$this->assertEquals(4, count($this->backup_json_object->task_statuses));
foreach($this->backup_json_object->task_statuses as $obj)
{
$user_id = $this->transformId('users', $obj->user_id);
$obj_array = (array)$obj;
unset($obj_array['user_id']);
unset($obj_array['company_id']);
unset($obj_array['account_id']);
unset($obj_array['hashed_id']);
unset($obj_array['id']);
unset($obj_array['tax_rate_id']);
$new_obj = TaskStatus::firstOrNew(
['name' => $obj->name, 'company_id' => $this->company->id],
$obj_array,
);
$new_obj->save(['timestamps' => false]);
}
TaskStatus::reguard();
$this->assertEquals(4, TaskStatus::count());
/***************************** Task Statuses *****************************/
/***************************** Clients *****************************/
Client::unguard();
$this->assertEquals(1, count($this->backup_json_object->clients));
foreach($this->backup_json_object->clients as $obj)
{
$user_id = $this->transformId('users', $obj->user_id);
$assigned_user_id = $this->transformId('users', $obj->assigned_user_id);
$obj_array = (array)$obj;
unset($obj_array['user_id']);
unset($obj_array['company_id']);
unset($obj_array['account_id']);
unset($obj_array['hashed_id']);
unset($obj_array['id']);
unset($obj_array['gateway_tokens']);
unset($obj_array['contacts']);
unset($obj_array['documents']);
$new_obj = Client::firstOrNew(
['number' => $obj->number, 'company_id' => $this->company->id],
$obj_array,
);
$new_obj->save(['timestamps' => false]);
$this->ids['clients']["{$obj->hashed_id}"] = $new_obj->id;
}
Client::reguard();
$this->assertEquals(1, Client::count());
/***************************** Clients *****************************/
/***************************** Client Contacts *****************************/
ClientContact::unguard();
$this->assertEquals(1, count($this->backup_json_object->client_contacts));
foreach($this->backup_json_object->client_contacts as $obj)
{
$user_id = $this->transformId('users', $obj->user_id);
$client_id = $this->transformId('clients', $obj->client_id);
$obj_array = (array)$obj;
unset($obj_array['user_id']);
unset($obj_array['company_id']);
unset($obj_array['account_id']);
unset($obj_array['hashed_id']);
unset($obj_array['id']);
unset($obj_array['gateway_tokens']);
unset($obj_array['contacts']);
unset($obj_array['documents']);
$obj_array['client_id'] = $client_id;
$new_obj = ClientContact::firstOrNew(
['email' => $obj->email, 'company_id' => $this->company->id],
$obj_array,
);
$new_obj->save(['timestamps' => false]);
$this->ids['client_contacts']["{$obj->hashed_id}"] = $new_obj->id;
}
ClientContact::reguard();
$this->assertEquals(1, ClientContact::count());
/***************************** Client Contacts *****************************/
//vendors!
/* Generic */
$this->assertEquals(1, count($this->backup_json_object->vendors));
$this->genericImport(Vendor::class,
['user_id', 'assigned_user_id', 'company_id', 'id', 'hashed_id'],
[['users' => 'user_id'], ['users' =>'assigned_user_id']],
'vendors',
'number');
$this->assertEquals(1, Vendor::count());
/* Generic */
$this->assertEquals(1, count($this->backup_json_object->projects));
//$class, $unset, $transforms, $object_property, $match_key
$this->genericImport(Project::class,
['user_id', 'assigned_user_id', 'company_id', 'id', 'hashed_id','client_id'],
[['users' => 'user_id'], ['users' =>'assigned_user_id'], ['clients' => 'client_id']],
'projects',
'number');
$this->assertEquals(1, Project::count());
//projects!
//products!
$this->assertEquals(1, count($this->backup_json_object->products));
$this->genericNewClassImport(Product::class,
['user_id', 'company_id', 'hashed_id', 'id'],
[['users' => 'user_id'], ['users' =>'assigned_user_id'], ['vendors' => 'vendor_id'], ['projects' => 'project_id']],
'products'
);
$this->assertEquals(1, Product::count());
//company gateways
$this->assertEquals(1, count($this->backup_json_object->company_gateways));
$this->genericNewClassImport(CompanyGateway::class,
['user_id', 'company_id', 'hashed_id', 'id'],
[['users' => 'user_id']],
'company_gateways'
);
$this->assertEquals(1, CompanyGateway::count());
//company gateways
//client gateway tokens
$this->genericNewClassImport(ClientGatewayToken::class,
['company_id', 'id', 'hashed_id','client_id'],
[['clients' => 'client_id']],
'client_gateway_tokens');
//client gateway tokens
//Group Settings
$this->genericImport(GroupSetting::class,
['user_id', 'company_id', 'id', 'hashed_id',],
[['users' => 'user_id']],
'group_settings',
'name');
//Group Settings
//Subscriptions
$this->assertEquals(1, count($this->backup_json_object->subscriptions));
$this->genericImport(Subscription::class,
['user_id', 'assigned_user_id', 'company_id', 'id', 'hashed_id',],
[['group_settings' => 'group_id'], ['users' => 'user_id'], ['users' => 'assigned_user_id']],
'subscriptions',
'name');
$this->assertEquals(1, Subscription::count());
//Subscriptions
// Recurring Invoices
$this->assertEquals(2, count($this->backup_json_object->recurring_invoices));
$this->genericImport(RecurringInvoice::class,
['user_id', 'assigned_user_id', 'company_id', 'id', 'hashed_id', 'client_id','subscription_id','project_id','vendor_id','status'],
[
['subscriptions' => 'subscription_id'],
['users' => 'user_id'],
['users' => 'assigned_user_id'],
['clients' => 'client_id'],
['projects' => 'project_id'],
['vendors' => 'vendor_id'],
['clients' => 'client_id'],
],
'recurring_invoices',
'number');
$this->assertEquals(2, RecurringInvoice::count());
// Recurring Invoices
// Recurring Invoice Invitations
$this->assertEquals(2, count($this->backup_json_object->recurring_invoice_invitations));
$this->genericImport(RecurringInvoiceInvitation::class,
['user_id', 'client_contact_id', 'company_id', 'id', 'hashed_id', 'recurring_invoice_id'],
[
['users' => 'user_id'],
['recurring_invoices' => 'recurring_invoice_id'],
['client_contacts' => 'client_contact_id'],
],
'recurring_invoice_invitations',
'key');
$this->assertEquals(2, RecurringInvoiceInvitation::count());
// Recurring Invoice Invitations
// Invoices
$this->assertEquals(2, count($this->backup_json_object->invoices));
$this->genericImport(Invoice::class,
['user_id', 'client_id', 'company_id', 'id', 'hashed_id', 'recurring_id','status'],
[
['users' => 'user_id'],
['users' => 'assigned_user_id'],
['recurring_invoices' => 'recurring_id'],
['clients' => 'client_id'],
['subscriptions' => 'subscription_id'],
['projects' => 'project_id'],
['vendors' => 'vendor_id'],
],
'invoices',
'number');
$this->assertEquals(2, Invoice::count());
// Invoices
// Invoice Invitations
$this->assertEquals(2, count($this->backup_json_object->invoice_invitations));
$this->genericImport(InvoiceInvitation::class,
['user_id', 'client_contact_id', 'company_id', 'id', 'hashed_id', 'invoice_id'],
[
['users' => 'user_id'],
['invoices' => 'invoice_id'],
['client_contacts' => 'client_contact_id'],
],
'invoice_invitations',
'key');
$this->assertEquals(2, InvoiceInvitation::count());
// Invoice Invitations
// Quotes
$this->assertEquals(2, count($this->backup_json_object->quotes));
$this->genericImport(Quote::class,
['user_id', 'client_id', 'company_id', 'id', 'hashed_id', 'recurring_id','status'],
[
['users' => 'user_id'],
['users' => 'assigned_user_id'],
['recurring_invoices' => 'recurring_id'],
['clients' => 'client_id'],
['subscriptions' => 'subscription_id'],
['projects' => 'project_id'],
['vendors' => 'vendor_id'],
],
'quotes',
'number');
$this->assertEquals(2, Quote::count());
// Quotes
// Quotes Invitations
$this->assertEquals(2, count($this->backup_json_object->quote_invitations));
$this->genericImport(QuoteInvitation::class,
['user_id', 'client_contact_id', 'company_id', 'id', 'hashed_id', 'quote_id'],
[
['users' => 'user_id'],
['quotes' => 'quote_id'],
['client_contacts' => 'client_contact_id'],
],
'quote_invitations',
'key');
$this->assertEquals(2, QuoteInvitation::count());
// Quotes Invitations
// Credits
$this->assertEquals(2, count($this->backup_json_object->credits));
$this->genericImport(Credit::class,
['user_id', 'client_id', 'company_id', 'id', 'hashed_id', 'recurring_id','status'],
[
['users' => 'user_id'],
['users' => 'assigned_user_id'],
['recurring_invoices' => 'recurring_id'],
['clients' => 'client_id'],
['subscriptions' => 'subscription_id'],
['projects' => 'project_id'],
['vendors' => 'vendor_id'],
],
'quotes',
'number');
$this->assertEquals(2, Credit::count());
// Credits
// Credits Invitations
$this->assertEquals(2, count($this->backup_json_object->credit_invitations));
$this->genericImport(CreditInvitation::class,
['user_id', 'client_contact_id', 'company_id', 'id', 'hashed_id', 'credit_id'],
[
['users' => 'user_id'],
['quotes' => 'credit_id'],
['client_contacts' => 'client_contact_id'],
],
'credit_invitations',
'key');
$this->assertEquals(2, CreditInvitation::count());
// Credits Invitations
// Expenses
$this->assertEquals(2, count($this->backup_json_object->expenses));
$this->genericImport(Expense::class,
['assigned_user_id', 'user_id', 'client_id', 'company_id', 'id', 'hashed_id', 'project_id','vendor_id'],
[
['users' => 'user_id'],
['users' => 'assigned_user_id'],
['clients' => 'client_id'],
['projects' => 'project_id'],
['vendors' => 'vendor_id'],
],
'expenses',
'number');
$this->assertEquals(2, Expense::count());
// Expenses
// Tasks
$this->assertEquals(3, count($this->backup_json_object->tasks));
$this->genericImport(Task::class,
['assigned_user_id', 'user_id', 'client_id', 'company_id', 'id', 'hashed_id', 'invoice_id','project_id'],
[
['users' => 'user_id'],
['users' => 'assigned_user_id'],
['clients' => 'client_id'],
['projects' => 'project_id'],
['invoices' => 'invoice_id'],
],
'tasks',
'number');
$this->assertEquals(3, Task::count());
// Tasks
// Payments
$this->assertEquals(2, count($this->backup_json_object->payments));
$this->genericImport(Payment::class,
['assigned_user_id', 'user_id', 'client_id', 'company_id', 'id', 'hashed_id', 'client_contact_id','invitation_id','vendor_id','paymentables'],
[
['users' => 'user_id'],
['users' => 'assigned_user_id'],
['clients' => 'client_id'],
['client_contacts' => 'client_contact_id'],
['vendors' => 'vendor_id'],
['invoice_invitations' => 'invitation_id'],
['company_gateways' => 'company_gateway_id'],
],
'payments',
'number');
$this->assertEquals(2, Payment::count());
// Payments
// Paymentables
// $this->assertEquals(2, count($this->backup_json_object->paymentables));
// $this->paymentablesImport();
// $this->assertEquals(2, Paymentable::count());
// Paymentables
}
private function paymentablesImport()
{
foreach($this->backup_json_object->paymentables as $paymentable)
{
$paymentable = new Paymentable();
$paymentable->payment_id = $this->transformId('payments', $paymentable->payment_id);
$paymentable->paymentable_type = $paymentable->paymentable_type;
$paymentable->amount = $paymentable->amount;
$paymentable->refunded = $paymentable->refunded;
$paymentable->created_at = $paymentable->created_at;
$paymentable->deleted_at = $paymentable->deleted_at;
$paymentable->updated_at = $paymentable->updated_at;
$paymentable->paymentable_id = $this->convertPaymentableId($paymentable->paymentable_type, $paymentable->paymentable_id);
$paymentable->paymentable_type = $paymentable->paymentable_type;
$paymentable->save(['timestamps' => false]);
}
}
private function convertPaymentableId($type, $id)
{
switch ($type) {
case 'invoices':
return $this->transformId('invoices', $id);
break;
case Credit::class:
return $this->transformId('credits', $id);
break;
default:
# code...
break;
}
}
private function genericNewClassImport($class, $unset, $transforms, $object_property)
{
$class::unguard();
foreach($this->backup_json_object->{$object_property} as $obj)
{
/* Remove unwanted keys*/
$obj_array = (array)$obj;
foreach($unset as $un){
unset($obj_array[$un]);
}
/* Transform old keys to new keys */
foreach($transforms as $transform)
{
foreach($transform as $key => $value)
{
$obj_array["{$value}"] = $this->transformId($key, $obj->{$value});
}
}
if($class instanceof CompanyGateway) {
$obj_array['config'] = encrypt($obj_array['config']);
}
$new_obj = new $class();
$new_obj->company_id = $this->company->id;
$new_obj->fill($obj_array);
$new_obj->save(['timestamps' => false]);
$this->ids["{$object_property}"]["{$obj->hashed_id}"] = $new_obj->id;
}
$class::reguard();
}
private function genericImport($class, $unset, $transforms, $object_property, $match_key)
{
$class::unguard();
foreach($this->backup_json_object->{$object_property} as $obj)
{
/* Remove unwanted keys*/
$obj_array = (array)$obj;
foreach($unset as $un){
unset($obj_array[$un]);
}
/* Transform old keys to new keys */
foreach($transforms as $transform)
{
foreach($transform as $key => $value)
{
$obj_array["{$value}"] = $this->transformId($key, $obj->{$value});
}
}
/* New to convert product ids from old hashes to new hashes*/
if($class instanceof Subscription){
$obj_array['product_ids'] = $this->recordProductIds($obj_array['product_ids']);
$obj_array['recurring_product_ids'] = $this->recordProductIds($obj_array['recurring_product_ids']);
}
$new_obj = $class::firstOrNew(
[$match_key => $obj->{$match_key}, 'company_id' => $this->company->id],
$obj_array,
);
$new_obj->save(['timestamps' => false]);
$this->ids["{$object_property}"]["{$obj->hashed_id}"] = $new_obj->id;
}
$class::reguard();
}
private function recordProductIds($ids)
{
$id_array = explode(",", $ids);
$tmp_arr = [];
foreach($id_array as $id) {
$tmp_arr[] = $this->encodePrimaryKey($this->transformId('products', $id));
}
return implode(",", $tmp_arr);
}
private function transformId(string $resource, ?string $old): ?int
{
if(empty($old))
return null;
if (! array_key_exists($resource, $this->ids)) {
throw new \Exception("Resource {$resource} not available.");
}
if (! array_key_exists("{$old}", $this->ids[$resource])) {
throw new \Exception("Missing resource key: {$old}");
}
return $this->ids[$resource]["{$old}"];
}
public function tearDown() :void
{
$backup_json_file = sys_get_temp_dir() . "/backup/backup.json";
// unlink($backup_json_file);
}
}