Skip to content

A free open source IT asset/license management system

20.1 KB
Raw Blame
<?php

namespace Tests\Feature\LicenseSeats\Api;

use App\Models\Asset;
use App\Models\Company;
use App\Models\License;
use App\Models\LicenseSeat;
use App\Models\User;
use Tests\TestCase;

class LicenseSeatUpdateTest extends TestCase
{
    public function test_requires_permission()
    {
        $licenseSeat = LicenseSeat::factory()->create();

        $this->actingAsForApi(User::factory()->create())
            ->patchJson($this->route($licenseSeat), [])
            ->assertForbidden();
    }

    /**************************************************************************
     * Validation
     **************************************************************************/

    /**
     * @link [rb-20713]
     */
    public function test_assigned_to_cannot_be_array()
    {
        $licenseSeat = LicenseSeat::factory()->create(['assigned_to' => null]);

        $targets = User::factory()->count(2)->create();

        $this->actingAsForApi(User::factory()->checkoutLicenses()->create())
            ->patchJson($this->route($licenseSeat), [
                'assigned_to' => [
                    $targets[0]->id,
                    $targets[1]->id,
                ],
                'notes' => '',
            ])
            ->assertStatus(200)
            ->assertStatusMessageIs('error')
            ->assertMessagesContains('assigned_to');
    }

    public function test_assigned_to_must_be_valid_user()
    {
        $licenseSeat = LicenseSeat::factory()->create(['assigned_to' => null]);

        $softDeletedUser = User::factory()->trashed()->create();

        $this->actingAsForApi(User::factory()->checkoutLicenses()->create())
            ->patchJson($this->route($licenseSeat), [
                'assigned_to' => $softDeletedUser->id,
                'notes' => '',
            ])
            ->assertStatus(200)
            ->assertStatusMessageIs('error')
            ->assertMessagesContains('assigned_to');
    }

    public function test_asset_id_must_be_a_valid_asset()
    {
        $licenseSeat = LicenseSeat::factory()->create(['assigned_to' => null]);

        $softDeletedAsset = Asset::factory()->trashed()->create();

        $this->actingAsForApi(User::factory()->checkoutLicenses()->create())
            ->patchJson($this->route($licenseSeat), [
                'asset_id' => $softDeletedAsset->id,
                'notes' => '',
            ])
            ->assertStatus(200)
            ->assertStatusMessageIs('error')
            ->assertMessagesContains('asset_id');
    }

    public function test_assigned_to_and_asset_id_cannot_be_provided_together()
    {
        $licenseSeat = LicenseSeat::factory()->create(['assigned_to' => null]);

        $this->actingAsForApi(User::factory()->checkoutLicenses()->create())
            ->patchJson($this->route($licenseSeat), [
                'assigned_to' => User::factory()->create()->id,
                'asset_id' => Asset::factory()->create()->id,
                'notes' => '',
            ])
            ->assertStatus(200)
            ->assertStatusMessageIs('error')
            ->assertMessagesContains('assigned_to')
            ->assertMessagesContains('asset_id');
    }

    public function test_assigned_to_and_asset_id_can_be_provided_together_if_they_are_both_null()
    {
        $asset = Asset::factory()->create();
        $licenseSeat = LicenseSeat::factory()->assignedToAsset($asset)->create();

        $this->actingAsForApi(User::factory()->checkoutLicenses()->checkinLicenses()->create())
            ->patchJson($this->route($licenseSeat), [
                'assigned_to' => null,
                'asset_id' => null,
                'notes' => '',
            ])
            ->assertStatus(200)
            ->assertStatusMessageIs('success');

        $licenseSeat->refresh();
        $this->assertNull($licenseSeat->assigned_to);
        $this->assertNull($licenseSeat->asset_id);

        $this->assertDatabaseHas('action_logs', [
            'action_type' => 'checkin from',
            'target_id' => $asset->id,
            'target_type' => Asset::class,
            'note' => null,
            'item_type' => License::class,
            'item_id' => $licenseSeat->license_id,
            'quantity' => 1,
        ]);
    }

    public function test_parent_license_cannot_be_updated()
    {
        $licenseSeat = LicenseSeat::factory()->create();
        $licenseId = $licenseSeat->license_id;

        $this->actingAsForApi(User::factory()->checkoutLicenses()->create())
            ->patchJson($this->route($licenseSeat), [
                'notes' => '',
                'license_id' => License::factory()->create()->id,
            ])
            ->assertStatus(200)
            ->assertStatusMessageIs('success');

        $licenseSeat->refresh();
        $this->assertEquals($licenseId, $licenseSeat->license_id);
    }

    public function test_cannot_reassign_unreassignable_license_seat()
    {
        $user = User::factory()->create();

        $licenseSeat = LicenseSeat::factory()->assignedToUser($user)->create(['unreassignable_seat' => true]);

        $this->actingAsForApi(User::factory()->checkoutLicenses()->create())
            ->patchJson($this->route($licenseSeat), [
                'asset_id' => Asset::factory()->create()->id,
                'notes' => 'Attempting to reassign an unreassignable seat',
            ])
            ->assertStatus(200)
            ->assertStatusMessageIs('error')
            ->assertJsonFragment([
                'messages' => trans('admin/licenses/message.checkout.unavailable'),
            ]);

        $licenseSeat->refresh();
        $this->assertEquals($user->id, $licenseSeat->assigned_to);
    }

    /**************************************************************************
     * Happy Path
     **************************************************************************/
    public function test_license_seat_can_be_updated()
    {
        $licenseSeat = LicenseSeat::factory()->create();

        $this->actingAsForApi(User::factory()->checkoutLicenses()->create())
            ->patchJson($this->route($licenseSeat), [
                'notes' => 'A new note is here',
            ])
            ->assertStatus(200)
            ->assertStatusMessageIs('success');

        $licenseSeat->refresh();

        $this->assertEquals('A new note is here', $licenseSeat->notes);
    }

    public function test_reassignableness_is_not_updated()
    {
        $licenseSeat = LicenseSeat::factory()->reassignable()->create(['unreassignable_seat' => false]);

        $this->actingAsForApi(User::factory()->checkoutLicenses()->create())
            ->patchJson($this->route($licenseSeat), [
                'notes' => '',
                'unreassignable_seat' => true,
            ])
            ->assertStatus(200)
            ->assertStatusMessageIs('success');

        $licenseSeat->refresh();
        $this->assertFalse($licenseSeat->unreassignable_seat);
    }

    public function test_created_by_and_timestamps_are_not_updated()
    {
        $licenseSeat = LicenseSeat::factory()->create();

        $createdBy = $licenseSeat->created_by;
        $createdAt = $licenseSeat->created_at;
        $deleteAt = $licenseSeat->deleted_at;

        $this->actingAsForApi(User::factory()->checkoutLicenses()->create())
            ->patchJson($this->route($licenseSeat), [
                'notes' => '',
                'created_by' => User::factory()->create()->id,
                'created_at' => now()->subDays(5)->toDateTimeString(),
                'deleted_at' => now()->toDateTimeString(),
            ])
            ->assertStatus(200)
            ->assertStatusMessageIs('success');

        $licenseSeat->refresh();

        $this->assertEquals($createdBy, $licenseSeat->created_by);
        $this->assertEquals($createdAt, $licenseSeat->created_at);
        $this->assertEquals($deleteAt, $licenseSeat->deleted_at);
    }

    /**************************************************************************
     * Checkout/Checkin
     **************************************************************************/
    public function test_license_seat_can_be_checked_out_to_user_when_updating()
    {
        $licenseSeat = LicenseSeat::factory()->create(['assigned_to' => null]);
        $targetUser = User::factory()->create();

        $this->actingAsForApi(User::factory()->checkoutLicenses()->create())
            ->patchJson($this->route($licenseSeat), [
                'assigned_to' => $targetUser->id,
                'notes' => 'Checking out the seat to a user',
            ])
            ->assertStatus(200)
            ->assertStatusMessageIs('success');

        $licenseSeat->refresh();

        $this->assertEquals($targetUser->id, $licenseSeat->assigned_to);
        $this->assertEquals('Checking out the seat to a user', $licenseSeat->notes);
        $this->assertHasTheseActionLogs($licenseSeat->license, ['add seats', 'create', 'checkout']); // FIXME - backwards
    }

    public function test_license_seat_can_be_checked_out_to_asset_when_updating()
    {
        $licenseSeat = LicenseSeat::factory()->create(['assigned_to' => null]);
        $targetAsset = Asset::factory()->create();

        $this->actingAsForApi(User::factory()->checkoutLicenses()->create())
            ->patchJson($this->route($licenseSeat), [
                'asset_id' => $targetAsset->id,
                'notes' => 'Checking out the seat to an asset',
            ])
            ->assertStatus(200)
            ->assertStatusMessageIs('success');

        $licenseSeat->refresh();
        $this->assertEquals($targetAsset->id, $licenseSeat->asset_id);
        $this->assertEquals('Checking out the seat to an asset', $licenseSeat->notes);
        $this->assertHasTheseActionLogs($licenseSeat->license, ['add seats', 'create', 'checkout']); // FIXME - backwards
    }

    public function test_license_seat_checked_out_to_asset_can_be_checked_in_when_updating()
    {
        $asset = Asset::factory()->create();
        $licenseSeat = LicenseSeat::factory()->unreassignable()->assignedToAsset($asset)->create([
            // this will be updated to true upon checkin...
            'unreassignable_seat' => false,
        ]);

        $this->actingAsForApi(User::factory()->checkoutLicenses()->checkinLicenses()->create())
            ->patchJson($this->route($licenseSeat), [
                'asset_id' => null,
                'notes' => 'Checking in the seat',
            ])
            ->assertStatus(200)
            ->assertStatusMessageIs('success');

        $licenseSeat->refresh();

        $this->assertNull($licenseSeat->asset_id);
        $this->assertTrue($licenseSeat->unreassignable_seat);

        $this->assertDatabaseHas('action_logs', [
            'action_type' => 'checkin from',
            'target_id' => $asset->id,
            'target_type' => Asset::class,
            'note' => 'Checking in the seat',
            'item_type' => License::class,
            'item_id' => $licenseSeat->license_id,
            'quantity' => 1,
        ]);
    }

    public function test_license_seat_checked_out_to_user_can_be_checked_in_when_updating()
    {
        $user = User::factory()->create();
        $licenseSeat = LicenseSeat::factory()->unreassignable()->assignedToUser($user)->create([
            // this will be updated to true upon checkin...
            'unreassignable_seat' => false,
        ]);

        $this->actingAsForApi(User::factory()->checkoutLicenses()->checkinLicenses()->create())
            ->patchJson($this->route($licenseSeat), [
                'assigned_to' => null,
                'notes' => 'Checking in the seat',
            ])
            ->assertStatus(200)
            ->assertStatusMessageIs('success');

        $licenseSeat->refresh();

        $this->assertNull($licenseSeat->assigned_to);
        $this->assertTrue($licenseSeat->unreassignable_seat);
        $this->assertDatabaseHas('action_logs', [
            'action_type' => 'checkin from',
            'target_id' => $user->id,
            'target_type' => User::class,
            'note' => 'Checking in the seat',
            'item_type' => License::class,
            'item_id' => $licenseSeat->license_id,
            'quantity' => 1,
        ]);
    }

    public function test_license_seat_checked_out_to_purged_asset_can_be_checked_in_when_updating()
    {
        $licenseSeat = LicenseSeat::factory()->create(['asset_id' => 100000]);

        $this->actingAsForApi(User::factory()->checkoutLicenses()->checkinLicenses()->create())
            ->patchJson($this->route($licenseSeat), [
                'asset_id' => null,
                'assigned_to' => null,
                'notes' => 'Checking in the seat',
            ])
            ->assertStatus(200)
            ->assertStatusMessageIs('success');

        $licenseSeat->refresh();

        $this->assertNull($licenseSeat->asset_id);

        $this->assertDatabaseHas('action_logs', [
            'action_type' => 'checkin from',
            // this will be null and not 100000
            // because the asset is not in the system
            'target_id' => null,
            'target_type' => null,
            'note' => 'Checking in the seat',
            'item_type' => License::class,
            'item_id' => $licenseSeat->license_id,
            'quantity' => 1,
        ]);
    }

    public function test_license_seat_checked_out_to_purged_user_can_be_checked_in_when_updating()
    {
        $licenseSeat = LicenseSeat::factory()->unreassignable()->create(['assigned_to' => 100000]);

        $this->actingAsForApi(User::factory()->checkoutLicenses()->checkinLicenses()->create())
            ->patchJson($this->route($licenseSeat), [
                // purposefully leaving asset_id off here
                // because it is a realistic scenario.
                'assigned_to' => null,
                'notes' => 'Checking in the seat',
            ])
            ->assertStatus(200)
            ->assertStatusMessageIs('success');

        $licenseSeat->refresh();

        $this->assertNull($licenseSeat->assigned_to);

        $this->assertDatabaseHas('action_logs', [
            'action_type' => 'checkin from',
            // this will be null and not 100000
            // because the user is not in the system
            'target_id' => null,
            'target_type' => null,
            'note' => 'Checking in the seat',
            'item_type' => License::class,
            'item_id' => $licenseSeat->license_id,
            'quantity' => 1,
        ]);
    }

    public function test_license_seat_checked_out_to_soft_deleted_asset_can_be_checked_in_when_updating()
    {
        $asset = Asset::factory()->create();
        $licenseSeat = LicenseSeat::factory()->assignedToAsset($asset)->create();
        $licenseSeat->asset->delete();

        $this->actingAsForApi(User::factory()->checkoutLicenses()->checkinLicenses()->create())
            ->patchJson($this->route($licenseSeat), [
                'asset_id' => null,
                'notes' => 'Checking in the seat',
            ])
            ->assertStatus(200)
            ->assertStatusMessageIs('success');

        $licenseSeat->refresh();

        $this->assertNull($licenseSeat->asset_id);

        $this->assertDatabaseHas('action_logs', [
            'action_type' => 'checkin from',
            'target_id' => $asset->id,
            'target_type' => Asset::class,
            'note' => 'Checking in the seat',
            'item_type' => License::class,
            'item_id' => $licenseSeat->license_id,
            'quantity' => 1,
        ]);
    }

    public function test_license_seat_checked_out_to_soft_deleted_user_can_be_checked_in_when_updating()
    {
        $user = User::factory()->create();
        $licenseSeat = LicenseSeat::factory()->unreassignable()->assignedToUser($user)->create();
        $licenseSeat->user->delete();

        $this->actingAsForApi(User::factory()->checkoutLicenses()->checkinLicenses()->create())
            ->patchJson($this->route($licenseSeat), [
                'assigned_to' => null,
                'notes' => 'Checking in the seat',
            ])
            ->assertStatus(200)
            ->assertStatusMessageIs('success');

        $licenseSeat->refresh();

        $this->assertNull($licenseSeat->assigned_to);

        $this->assertDatabaseHas('action_logs', [
            'action_type' => 'checkin from',
            'target_id' => $user->id,
            'target_type' => User::class,
            'note' => 'Checking in the seat',
            'item_type' => License::class,
            'item_id' => $licenseSeat->license_id,
            'quantity' => 1,
        ]);
    }

    public function test_superuser_cannot_assign_a_license_seat_to_a_target_in_another_company_when_full_company_support_is_enabled()
    {
        $this->settings->enableMultipleFullCompanySupport();

        [$companyA, $companyB] = Company::factory()->count(2)->create();

        $superuser = User::factory()->superuser()->withoutCompany()->create();
        $licenseInCompanyA = License::factory()->for($companyA)->create();
        $seatForCompanyA = LicenseSeat::factory()->create([
            'license_id' => $licenseInCompanyA->id,
            'assigned_to' => null,
            'asset_id' => null,
            'notes' => null,
        ]);
        $userInCompanyB = User::factory()->forCompany($companyB)->create();

        $this->actingAsForApi($superuser)
            ->patchJson($this->route($seatForCompanyA), [
                'assigned_to' => $userInCompanyB->id,
                'notes' => 'cross-company assignment attempt',
            ])
            ->assertStatus(200)
            ->assertStatusMessageIs('error')
            ->assertMessagesAre(trans('general.error_user_company'));

        $seatForCompanyA->refresh();
        $this->assertNull($seatForCompanyA->assigned_to);
        $this->assertNull($seatForCompanyA->asset_id);

        $this->assertDatabaseMissing('action_logs', [
            'created_by' => $superuser->id,
            'action_type' => 'checkout',
            'target_type' => User::class,
            'target_id' => $userInCompanyB->id,
            'item_type' => License::class,
            'item_id' => $licenseInCompanyA->id,
            'note' => 'cross-company assignment attempt',
        ]);
    }

    public function test_user_in_same_company_can_be_assigned_license_seat_when_full_company_support_is_enabled()
    {
        $this->settings->enableMultipleFullCompanySupport();

        $company = Company::factory()->create();
        $license = License::factory()->for($company)->create();
        $seat = LicenseSeat::factory()->create(['license_id' => $license->id, 'assigned_to' => null, 'asset_id' => null]);
        $target = $company->users()->save(User::factory()->make());
        $actor = User::factory()->superuser()->create();

        $this->actingAsForApi($actor)
            ->patchJson($this->route($seat), ['assigned_to' => $target->id])
            ->assertOk()
            ->assertStatusMessageIs('success');

        $this->assertEquals($target->id, $seat->fresh()->assigned_to);
    }

    public function test_user_in_multiple_companies_can_be_assigned_license_from_any_of_their_companies_when_full_company_support_is_enabled()
    {
        $this->settings->enableMultipleFullCompanySupport();

        [$companyA, $companyB] = Company::factory()->count(2)->create();
        $target = User::factory()->create();
        $target->companies()->sync([$companyA->id, $companyB->id]);
        $actor = User::factory()->superuser()->create();

        $licenseInA = License::factory()->for($companyA)->create();
        $seatInA = LicenseSeat::factory()->create(['license_id' => $licenseInA->id, 'assigned_to' => null, 'asset_id' => null]);

        $licenseInB = License::factory()->for($companyB)->create();
        $seatInB = LicenseSeat::factory()->create(['license_id' => $licenseInB->id, 'assigned_to' => null, 'asset_id' => null]);

        $this->actingAsForApi($actor)
            ->patchJson($this->route($seatInA), ['assigned_to' => $target->id])
            ->assertOk()
            ->assertStatusMessageIs('success');

        $this->actingAsForApi($actor)
            ->patchJson($this->route($seatInB), ['assigned_to' => $target->id])
            ->assertOk()
            ->assertStatusMessageIs('success');
    }

    private function route(LicenseSeat $licenseSeat)
    {
        return route('api.licenses.seats.update', [$licenseSeat->license->id, $licenseSeat->id]);
    }
}