adalal/solidtime
1
0
Fork 0
mirror of https://github.com/solidtime-io/solidtime.git synced 2026-08-08 08:12:17 +01:00
Code Issues Packages Projects Releases Wiki Activity

Added time entry api endpoints; Increased phpstan level; renamed to solidtime

Browse Source
This commit is contained in:
Constantin Graf
2024-02-26 14:27:12 +01:00
parent e60e502612
commit 9c5a238dda
36 changed files with 1716 additions and 461 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
tests/Unit/Endpoint/Api/V1/ApiEndpointTestAbstract.php Normal file
View File

@@ -0,0 +1,35 @@
<?php
declare(strict_types=1);
namespace Tests\Unit\Endpoint\Api\V1;
use App\Models\Organization;
use App\Models\User;
use Illuminate\Foundation\Testing\RefreshDatabase;
use Laravel\Jetstream\Jetstream;
use Tests\TestCase;
class ApiEndpointTestAbstract extends TestCase
{
use RefreshDatabase;
/**
* @param array<string> $permissions
* @return object{user: User, organization: Organization}
*/
protected function createUserWithPermission(array $permissions): object
{
Jetstream::role('custom-test', 'Custom Test', $permissions)->description('Role custom for testing');
$organization = Organization::factory()->create();
$user = User::factory()->create();
$organization->users()->attach($user, [
'role' => 'custom-test',
]);
return (object) [
'user' => $user,
'organization' => $organization,
];
}
}

124
tests/Unit/Endpoint/Api/V1/ProjectEndpointTest.php
View File

@@ -6,35 +6,10 @@ namespace Tests\Unit\Endpoint\Api\V1;
use App\Models\Organization;
use App\Models\Project;
use App\Models\User;
use Illuminate\Foundation\Testing\RefreshDatabase;
use Laravel\Jetstream\Jetstream;
use Laravel\Passport\Passport;
use Tests\TestCase;
class ProjectEndpointTest extends TestCase
class ProjectEndpointTest extends ApiEndpointTestAbstract
{
use RefreshDatabase;
/**
* @param array<string> $permissions
* @return object{user: User, organization: Organization}
*/
private function createUserWithPermission(array $permissions): object
{
Jetstream::role('custom-test', 'Custom Test', $permissions)->description('Role custom for testing');
$organization = Organization::factory()->create();
$user = User::factory()->create();
$organization->users()->attach($user, [
'role' => 'custom-test',
]);
return (object) [
'user' => $user,
'organization' => $organization,
];
}
public function test_index_endpoint_fails_if_user_has_no_permission_to_view_projects(): void
{
// Arrange
@@ -67,16 +42,68 @@ class ProjectEndpointTest extends TestCase
$response->assertJsonCount(4, 'data');
}
public function test_show_endpoint_fails_if_user_is_not_part_of_project_organization(): void
{
// Arrange
$data = $this->createUserWithPermission([
'projects:view',
]);
$otherOrganization = Organization::factory()->create();
$project = Project::factory()->forOrganization($otherOrganization)->create();
Passport::actingAs($data->user);
// Act
$response = $this->getJson(route('api.v1.projects.show', [$data->organization->getKey(), $project->getKey()]));
// Assert
$response->assertStatus(403);
}
public function test_show_endpoint_fails_if_user_has_no_permission_to_view_projects(): void
{
// Arrange
$data = $this->createUserWithPermission([
]);
$project = Project::factory()->forOrganization($data->organization)->create();
Passport::actingAs($data->user);
// Act
$response = $this->getJson(route('api.v1.projects.show', [$data->organization->getKey(), $project->getKey()]));
// Assert
$response->assertStatus(403);
}
public function test_show_endpoint_returns_project(): void
{
// Arrange
$data = $this->createUserWithPermission([
'projects:view',
]);
$project = Project::factory()->forOrganization($data->organization)->create();
Passport::actingAs($data->user);
// Act
$response = $this->getJson(route('api.v1.projects.show', [$data->organization->getKey(), $project->getKey()]));
// Assert
$response->assertStatus(200);
$response->assertJsonPath('data.id', $project->getKey());
}
public function test_store_endpoint_fails_if_user_has_no_permission_to_create_projects(): void
{
// Arrange
$data = $this->createUserWithPermission([
]);
$project = Project::factory()->forOrganization($data->organization)->make();
$projectFake = Project::factory()->forOrganization($data->organization)->make();
Passport::actingAs($data->user);
// Act
$response = $this->postJson(route('api.v1.projects.store', [$data->organization->getKey()]), $project->toArray());
$response = $this->postJson(route('api.v1.projects.store', [$data->organization->getKey()]), [
'name' => $projectFake->name,
'color' => $projectFake->color,
]);
// Assert
$response->assertStatus(403);
@@ -95,7 +122,6 @@ class ProjectEndpointTest extends TestCase
$response = $this->postJson(route('api.v1.projects.store', [$data->organization->getKey()]), [
'name' => $project->name,
'color' => $project->color,
'organization_id' => $project->organization_id,
]);
// Assert
@@ -107,6 +133,27 @@ class ProjectEndpointTest extends TestCase
]);
}
public function test_update_endpoint_fails_if_user_is_not_part_of_project_organization(): void
{
// Arrange
$data = $this->createUserWithPermission([
'projects:update',
]);
$otherOrganization = Organization::factory()->create();
$project = Project::factory()->forOrganization($otherOrganization)->create();
$projectFake = Project::factory()->make();
Passport::actingAs($data->user);
// Act
$response = $this->putJson(route('api.v1.projects.update', [$data->organization->getKey(), $project->getKey()]), [
'name' => $projectFake->name,
'color' => $projectFake->color,
]);
// Assert
$response->assertStatus(403);
}
public function test_update_endpoint_fails_if_user_has_no_permission_to_update_projects(): void
{
// Arrange
@@ -150,6 +197,23 @@ class ProjectEndpointTest extends TestCase
]);
}
public function test_destroy_endpoint_fails_if_user_is_not_part_of_project_organization(): void
{
// Arrange
$data = $this->createUserWithPermission([
'projects:delete',
]);
$otherOrganization = Organization::factory()->create();
$project = Project::factory()->forOrganization($otherOrganization)->create();
Passport::actingAs($data->user);
// Act
$response = $this->deleteJson(route('api.v1.projects.destroy', [$data->organization->getKey(), $project->getKey()]));
// Assert
$response->assertStatus(403);
}
public function test_destroy_endpoint_fails_if_user_has_no_permission_to_delete_projects(): void
{
// Arrange
@@ -178,7 +242,7 @@ class ProjectEndpointTest extends TestCase
$response = $this->deleteJson(route('api.v1.projects.destroy', [$data->organization->getKey(), $project->getKey()]));
// Assert
$response->assertStatus(200);
$response->assertStatus(204);
$this->assertDatabaseMissing(Project::class, [
'id' => $project->getKey(),
]);

478
tests/Unit/Endpoint/Api/V1/TimeEntryEndpointTest.php Normal file
View File

@@ -0,0 +1,478 @@
<?php
declare(strict_types=1);
namespace Tests\Unit\Endpoint\Api\V1;
use App\Models\TimeEntry;
use App\Models\User;
use Illuminate\Support\Str;
use Laravel\Passport\Passport;
class TimeEntryEndpointTest extends ApiEndpointTestAbstract
{
public function test_index_endpoint_fails_if_user_has_no_permission_to_view_time_entries(): void
{
// Arrange
$data = $this->createUserWithPermission([
]);
Passport::actingAs($data->user);
// Act
$response = $this->getJson(route('api.v1.time-entries.index', [$data->organization->getKey()]));
// Assert
$response->assertStatus(403);
}
public function test_index_endpoint_fails_if_user_has_no_permission_to_view_time_entries_for_others_but_wants_all_entries(): void
{
// Arrange
$data = $this->createUserWithPermission([
'time-entries:view:own',
]);
Passport::actingAs($data->user);
// Act
$response = $this->getJson(route('api.v1.time-entries.index', [$data->organization->getKey()]));
// Assert
$response->assertStatus(403);
}
public function test_index_endpoint_returns_time_entries_for_current_user(): void
{
// Arrange
$data = $this->createUserWithPermission([
'time-entries:view:own',
]);
$timeEntry = TimeEntry::factory()->forOrganization($data->organization)->forUser($data->user)->create();
Passport::actingAs($data->user);
// Act
$response = $this->getJson(route('api.v1.time-entries.index', [$data->organization->getKey(), 'user_id' => $data->user->getKey()]));
// Assert
$response->assertStatus(200);
$response->assertJsonPath('data.0.id', $timeEntry->getKey());
}
public function test_index_endpoint_fails_if_user_filter_is_from_different_organization(): void
{
// Arrange
$data = $this->createUserWithPermission([
'time-entries:view:all',
]);
$user = User::factory()->withPersonalOrganization()->create();
Passport::actingAs($data->user);
// Act
$response = $this->getJson(route('api.v1.time-entries.index', [$data->organization->getKey(), 'user_id' => $user->getKey()]));
// Assert
$response->assertStatus(422);
$response->assertJsonValidationErrorFor('user_id');
}
public function test_index_endpoint_returns_time_entries_for_other_user_in_organization(): void
{
// Arrange
$data = $this->createUserWithPermission([
'time-entries:view:all',
]);
$user = User::factory()->create();
$data->organization->users()->attach($user, [
'role' => 'employee',
]);
$timeEntry = TimeEntry::factory()->forOrganization($data->organization)->forUser($user)->create();
Passport::actingAs($data->user);
// Act
$response = $this->getJson(route('api.v1.time-entries.index', [$data->organization->getKey(), 'user_id' => $user->getKey()]));
// Assert
$response->assertStatus(200);
$response->assertJsonPath('data.0.id', $timeEntry->getKey());
}
public function test_index_endpoint_returns_time_entries_for_all_users_in_organization(): void
{
// Arrange
$data = $this->createUserWithPermission([
'time-entries:view:all',
]);
$user = User::factory()->create();
$data->organization->users()->attach($user, [
'role' => 'employee',
]);
$timeEntry = TimeEntry::factory()->forOrganization($data->organization)->forUser($user)->create();
Passport::actingAs($data->user);
// Act
$response = $this->getJson(route('api.v1.time-entries.index', [$data->organization->getKey()]));
// Assert
$response->assertStatus(200);
$response->assertJsonPath('data.0.id', $timeEntry->getKey());
}
public function test_store_endpoint_fails_if_user_has_no_permission_to_create_time_entries(): void
{
// Arrange
$data = $this->createUserWithPermission([
]);
$timeEntryFake = TimeEntry::factory()->forOrganization($data->organization)->withTags($data->organization)->make();
Passport::actingAs($data->user);
// Act
$response = $this->postJson(route('api.v1.time-entries.store', [$data->organization->getKey()]), [
'description' => $timeEntryFake->description,
'start' => $timeEntryFake->start->toIso8601String(),
'end' => $timeEntryFake->end->toIso8601String(),
'tags' => $timeEntryFake->tags,
'user_id' => $data->user->getKey(),
'task_id' => $timeEntryFake->task_id,
]);
// Assert
$response->assertStatus(403);
}
public function test_store_endpoint_creates_new_time_entry_for_current_user(): void
{
// Arrange
$data = $this->createUserWithPermission([
'time-entries:create:own',
]);
$timeEntryFake = TimeEntry::factory()->forOrganization($data->organization)->make();
Passport::actingAs($data->user);
// Act
$response = $this->postJson(route('api.v1.time-entries.store', [$data->organization->getKey()]), [
'description' => $timeEntryFake->description,
'start' => $timeEntryFake->start->toIso8601String(),
'end' => $timeEntryFake->end->toIso8601String(),
'tags' => $timeEntryFake->tags,
'user_id' => $data->user->getKey(),
'task_id' => $timeEntryFake->task_id,
]);
// Assert
$response->assertStatus(201);
$this->assertDatabaseHas(TimeEntry::class, [
'id' => $response->json('data.id'),
'user_id' => $data->user->getKey(),
'task_id' => $timeEntryFake->task_id,
]);
}
public function test_store_endpoint_fails_if_user_has_no_permission_to_create_time_entries_for_others(): void
{
// Arrange
$data = $this->createUserWithPermission([
'time-entries:create:own',
]);
$otherUser = User::factory()->create();
$data->organization->users()->attach($otherUser, [
'role' => 'employee',
]);
$timeEntryFake = TimeEntry::factory()->forOrganization($data->organization)->make();
Passport::actingAs($data->user);
// Act
$response = $this->postJson(route('api.v1.time-entries.store', [$data->organization->getKey()]), [
'description' => $timeEntryFake->description,
'start' => $timeEntryFake->start->toIso8601String(),
'end' => $timeEntryFake->end->toIso8601String(),
'tags' => $timeEntryFake->tags,
'user_id' => $otherUser->getKey(),
'task_id' => $timeEntryFake->task_id,
]);
// Assert
$response->assertStatus(403);
}
public function test_store_endpoint_creates_new_time_entry_for_other_user_in_organization(): void
{
// Arrange
$data = $this->createUserWithPermission([
'time-entries:create:all',
]);
$otherUser = User::factory()->create();
$data->organization->users()->attach($otherUser, [
'role' => 'employee',
]);
$timeEntryFake = TimeEntry::factory()->forOrganization($data->organization)->make();
Passport::actingAs($data->user);
// Act
$response = $this->postJson(route('api.v1.time-entries.store', [$data->organization->getKey()]), [
'description' => $timeEntryFake->description,
'start' => $timeEntryFake->start->toIso8601String(),
'end' => $timeEntryFake->end->toIso8601String(),
'tags' => $timeEntryFake->tags,
'user_id' => $otherUser->getKey(),
'task_id' => $timeEntryFake->task_id,
]);
// Assert
$response->assertStatus(201);
$this->assertDatabaseHas(TimeEntry::class, [
'id' => $response->json('data.id'),
'user_id' => $otherUser->getKey(),
'task_id' => $timeEntryFake->task_id,
]);
}
public function test_update_endpoint_fails_if_user_has_no_permission_to_update_own_time_entries(): void
{
// Arrange
$data = $this->createUserWithPermission([
]);
$timeEntry = TimeEntry::factory()->forOrganization($data->organization)->forUser($data->user)->create();
$timeEntryFake = TimeEntry::factory()->forOrganization($data->organization)->make();
Passport::actingAs($data->user);
// Act
$response = $this->putJson(route('api.v1.time-entries.update', [$data->organization->getKey(), $timeEntry->getKey()]), [
'description' => $timeEntryFake->description,
'start' => $timeEntryFake->start->toIso8601String(),
'end' => $timeEntryFake->end->toIso8601String(),
'tags' => $timeEntryFake->tags,
'user_id' => $data->user->getKey(),
'task_id' => $timeEntryFake->task_id,
]);
// Assert
$response->assertStatus(403);
}
public function test_update_endpoint_fails_if_user_is_not_part_of_time_entry_organization(): void
{
// Arrange
$data = $this->createUserWithPermission([
'time-entries:update:own',
]);
$otherUser = $this->createUserWithPermission([
'time-entries:update:own',
]);
$timeEntry = TimeEntry::factory()->forOrganization($otherUser->organization)->forUser($otherUser->user)->create();
$timeEntryFake = TimeEntry::factory()->forOrganization($data->organization)->make();
Passport::actingAs($data->user);
// Act
$response = $this->putJson(route('api.v1.time-entries.update', [$data->organization->getKey(), $timeEntry->getKey()]), [
'description' => $timeEntryFake->description,
'start' => $timeEntryFake->start->toIso8601String(),
'end' => $timeEntryFake->end->toIso8601String(),
'tags' => $timeEntryFake->tags,
'user_id' => $data->user->getKey(),
'task_id' => $timeEntryFake->task_id,
]);
// Assert
$response->assertStatus(403);
}
public function test_update_endpoint_fails_if_user_has_no_permission_to_update_time_entries_for_other_users_in_organization(): void
{
// Arrange
$data = $this->createUserWithPermission([
'time-entries:update:own',
]);
$user = User::factory()->create();
$data->organization->users()->attach($user, [
'role' => 'employee',
]);
$timeEntry = TimeEntry::factory()->forOrganization($data->organization)->forUser($user)->create();
$timeEntryFake = TimeEntry::factory()->forOrganization($data->organization)->make();
Passport::actingAs($data->user);
// Act
$response = $this->putJson(route('api.v1.time-entries.update', [$data->organization->getKey(), $timeEntry->getKey()]), [
'description' => $timeEntryFake->description,
'start' => $timeEntryFake->start->toIso8601String(),
'end' => $timeEntryFake->end->toIso8601String(),
'tags' => $timeEntryFake->tags,
'user_id' => $user->getKey(),
'task_id' => $timeEntryFake->task_id,
]);
// Assert
$response->assertStatus(403);
}
public function test_update_endpoint_updates_time_entry_for_current_user(): void
{
// Arrange
$data = $this->createUserWithPermission([
'time-entries:update:own',
]);
$timeEntry = TimeEntry::factory()->forOrganization($data->organization)->forUser($data->user)->create();
$timeEntryFake = TimeEntry::factory()->forOrganization($data->organization)->make();
Passport::actingAs($data->user);
// Act
$response = $this->putJson(route('api.v1.time-entries.update', [$data->organization->getKey(), $timeEntry->getKey()]), [
'description' => $timeEntryFake->description,
'start' => $timeEntryFake->start->toIso8601String(),
'end' => $timeEntryFake->end->toIso8601String(),
'tags' => $timeEntryFake->tags,
'user_id' => $data->user->getKey(),
'task_id' => $timeEntryFake->task_id,
]);
// Assert
$response->assertStatus(200);
$this->assertDatabaseHas(TimeEntry::class, [
'id' => $timeEntry->getKey(),
'user_id' => $data->user->getKey(),
'task_id' => $timeEntryFake->task_id,
]);
}
public function test_update_endpoint_updates_time_entry_of_other_user_in_organization(): void
{
// Arrange
$data = $this->createUserWithPermission([
'time-entries:update:all',
]);
$user = User::factory()->create();
$data->organization->users()->attach($user, [
'role' => 'employee',
]);
$timeEntry = TimeEntry::factory()->forOrganization($data->organization)->forUser($user)->create();
$timeEntryFake = TimeEntry::factory()->forOrganization($data->organization)->make();
Passport::actingAs($data->user);
// Act
$response = $this->putJson(route('api.v1.time-entries.update', [$data->organization->getKey(), $timeEntry->getKey()]), [
'description' => $timeEntryFake->description,
'start' => $timeEntryFake->start->toIso8601String(),
'end' => $timeEntryFake->end->toIso8601String(),
'tags' => $timeEntryFake->tags,
'user_id' => $user->getKey(),
'task_id' => $timeEntryFake->task_id,
]);
// Assert
$response->assertStatus(200);
$this->assertDatabaseHas(TimeEntry::class, [
'id' => $timeEntry->getKey(),
'user_id' => $user->getKey(),
'task_id' => $timeEntryFake->task_id,
]);
}
public function test_destroy_endpoint_fails_if_user_tries_to_delete_time_entry_in_organization_that_they_does_belong_to(): void
{
// Arrange
$data = $this->createUserWithPermission([
'time-entries:delete:all',
]);
$otherUser = $this->createUserWithPermission([
'time-entries:delete:all',
]);
$timeEntry = TimeEntry::factory()->forOrganization($otherUser->organization)->forUser($otherUser->user)->create();
Passport::actingAs($data->user);
// Act
$response = $this->deleteJson(route('api.v1.time-entries.destroy', [$data->organization->getKey(), $timeEntry->getKey()]));
// Assert
$response->assertStatus(403);
}
public function test_destroy_endpoint_fails_if_user_tries_to_delete_non_existing_time_entry(): void
{
// Arrange
$data = $this->createUserWithPermission([
'time-entries:delete:own',
]);
Passport::actingAs($data->user);
// Act
$response = $this->deleteJson(route('api.v1.time-entries.destroy', [$data->organization->getKey(), Str::uuid()]));
// Assert
$response->assertStatus(404);
}
public function test_destroy_endpoint_fails_if_user_has_no_permission_to_delete_own_time_entries(): void
{
// Arrange
$data = $this->createUserWithPermission([
]);
$timeEntry = TimeEntry::factory()->forOrganization($data->organization)->forUser($data->user)->create();
Passport::actingAs($data->user);
// Act
$response = $this->deleteJson(route('api.v1.time-entries.destroy', [$data->organization->getKey(), $timeEntry->getKey()]));
// Assert
$response->assertStatus(403);
}
public function test_destroy_endpoint_fails_if_user_has_no_permission_to_delete_time_entries_for_other_users_in_organization(): void
{
// Arrange
$data = $this->createUserWithPermission([
'time-entries:delete:own',
]);
$user = User::factory()->create();
$data->organization->users()->attach($user, [
'role' => 'employee',
]);
$timeEntry = TimeEntry::factory()->forOrganization($data->organization)->forUser($user)->create();
Passport::actingAs($data->user);
// Act
$response = $this->deleteJson(route('api.v1.time-entries.destroy', [$data->organization->getKey(), $timeEntry->getKey()]));
// Assert
$response->assertStatus(403);
}
public function test_destroy_endpoint_deletes_own_time_entry(): void
{
// Arrange
$data = $this->createUserWithPermission([
'time-entries:delete:own',
]);
$timeEntry = TimeEntry::factory()->forOrganization($data->organization)->forUser($data->user)->create();
Passport::actingAs($data->user);
// Act
$response = $this->deleteJson(route('api.v1.time-entries.destroy', [$data->organization->getKey(), $timeEntry->getKey()]));
// Assert
$response->assertStatus(204);
$this->assertDatabaseMissing(TimeEntry::class, [
'id' => $timeEntry->getKey(),
]);
}
public function test_destroy_endpoint_deletes_time_entry_of_other_user_in_organization(): void
{
// Arrange
$data = $this->createUserWithPermission([
'time-entries:delete:all',
]);
$user = User::factory()->create();
$data->organization->users()->attach($user, [
'role' => 'employee',
]);
$timeEntry = TimeEntry::factory()->forOrganization($data->organization)->forUser($user)->create();
Passport::actingAs($data->user);
// Act
$response = $this->deleteJson(route('api.v1.time-entries.destroy', [$data->organization->getKey(), $timeEntry->getKey()]));
// Assert
$response->assertStatus(204);
$this->assertDatabaseMissing(TimeEntry::class, [
'id' => $timeEntry->getKey(),
]);
}
}