jjsm01/kimai2
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

Added API endpoints to fetch invoices (#5070)

Browse Source 
* added serializer attributes for API usage
* new setters to fill invoice data from fixture
* re-usable fixture helper methods
* added API endpoints to fetch invoices
* adjust tests
This commit is contained in:
Kevin Papst
2024-09-22 16:17:45 +02:00
committed by GitHub
parent 1965c35b43
commit 8de54e1fa7
20 changed files with 532 additions and 155 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
tests/API/APIControllerBaseTest.php
View File

@@ -107,10 +107,10 @@ abstract class APIControllerBaseTest extends ControllerBaseTest
return $client->request($method, $this->createUrl($url), $parameters, [], $server, $content);
}
protected function assertEntityNotFound(string $role, string $url, string $method = 'GET', ?string $message = null): void
protected function assertEntityNotFound(string $role, string $url): void
{
$client = $this->getClientForAuthenticatedUser($role);
$this->request($client, $url, $method);
$this->request($client, $url);
$this->assertApiException($client->getResponse(), [
'code' => Response::HTTP_NOT_FOUND,
'message' => 'Not Found'
@@ -272,6 +272,25 @@ abstract class APIControllerBaseTest extends ControllerBaseTest
protected static function getExpectedResponseStructure(string $type): array
{
switch ($type) {
case 'Invoice':
case 'InvoiceCollection':
return [
'id' => 'int',
'comment' => '@string',
'createdAt' => 'datetime',
'currency' => 'string',
'customer' => ['result' => 'object', 'type' => '@Customer'],
'user' => ['result' => 'object', 'type' => '@User'],
'dueDays' => 'int',
'invoiceNumber' => 'string',
'metaFields' => 'array',
'paymentDate' => '@datetime',
'status' => 'string',
'tax' => 'float',
'total' => 'float',
'vat' => 'float',
];
case 'PageActionItem':
return [
'id' => 'string',

2
tests/API/ActivityControllerTest.php
View File

@@ -245,7 +245,7 @@ class ActivityControllerTest extends APIControllerBaseTest
public function testNotFound(): void
{
$this->assertEntityNotFound(User::ROLE_USER, '/api/activities/' . PHP_INT_MAX, 'GET', 'App\\Entity\\Activity object not found by the @ParamConverter annotation.');
$this->assertEntityNotFound(User::ROLE_USER, '/api/activities/' . PHP_INT_MAX);
}
public function testPostAction(): void

4
tests/API/ApiDocControllerTest.php
View File

@@ -38,7 +38,7 @@ class ApiDocControllerTest extends ControllerBaseTest
}
}
$expectedKeys = ['Actions', 'Activity', 'Default', 'Customer', 'Project', 'Tag', 'Team', 'Timesheet', 'User'];
$expectedKeys = ['Actions', 'Activity', 'Default', 'Customer', 'Project', 'Tag', 'Team', 'Timesheet', 'User', 'Invoice'];
$actual = array_keys($tags);
sort($actual);
@@ -70,6 +70,8 @@ class ApiDocControllerTest extends ControllerBaseTest
'/api/customers/{id}/meta',
'/api/customers/{id}/rates',
'/api/customers/{id}/rates/{rateId}',
'/api/invoices',
'/api/invoices/{id}',
'/api/projects',
'/api/projects/{id}',
'/api/projects/{id}/meta',

2
tests/API/CustomerControllerTest.php
View File

@@ -190,7 +190,7 @@ class CustomerControllerTest extends APIControllerBaseTest
public function testNotFound(): void
{
$this->assertEntityNotFound(User::ROLE_USER, '/api/customers/' . PHP_INT_MAX, 'GET', 'App\\Entity\\Customer object not found by the @ParamConverter annotation.');
$this->assertEntityNotFound(User::ROLE_USER, '/api/customers/' . PHP_INT_MAX);
}
public function testPostAction(): void

106
tests/API/InvoiceControllerTest.php Normal file
View File

@@ -0,0 +1,106 @@
<?php
/*
* This file is part of the Kimai time-tracking app.
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace API;
use App\Entity\Invoice;
use App\Entity\User;
use App\Tests\API\APIControllerBaseTest;
use App\Tests\DataFixtures\InvoiceFixtures;
/**
* @group integration
*/
class InvoiceControllerTest extends APIControllerBaseTest
{
/**
* @return Invoice[]
*/
protected function importInvoiceFixtures(int $amount, ?array $status = null): array
{
$fixture = new InvoiceFixtures();
$fixture->setAmount($amount);
if (\is_array($status)) {
$fixture->setStatus($status);
}
return $this->importFixture($fixture);
}
public function testIsSecure(): void
{
$this->assertUrlIsSecured('/api/invoices');
}
public function testGetCollection(): void
{
$client = $this->getClientForAuthenticatedUser(User::ROLE_TEAMLEAD);
$this->importInvoiceFixtures(10);
$this->assertAccessIsGranted($client, '/api/invoices');
$content = $client->getResponse()->getContent();
$this->assertIsString($content);
$result = json_decode($content, true);
$this->assertIsArray($result);
$this->assertNotEmpty($result);
$this->assertEquals(10, \count($result));
self::assertApiResponseTypeStructure('InvoiceCollection', $result[0]);
}
public function testGetCollectionWithQuery(): void
{
$client = $this->getClientForAuthenticatedUser(User::ROLE_TEAMLEAD);
$this->importInvoiceFixtures(5, [Invoice::STATUS_PENDING]);
$this->importInvoiceFixtures(2, [Invoice::STATUS_NEW]);
$this->importInvoiceFixtures(7, [Invoice::STATUS_PAID]);
$this->importInvoiceFixtures(1, [Invoice::STATUS_CANCELED]);
$query = ['order' => 'ASC', 'orderBy' => 'name', 'status' => [Invoice::STATUS_PAID]];
$this->assertAccessIsGranted($client, '/api/invoices', 'GET', $query);
$content = $client->getResponse()->getContent();
$this->assertIsString($content);
$result = json_decode($content, true);
$this->assertIsArray($result);
$this->assertNotEmpty($result);
$this->assertEquals(7, \count($result));
self::assertApiResponseTypeStructure('InvoiceCollection', $result[0]);
}
public function testGetEntityIsSecure(): void
{
$client = $this->getClientForAuthenticatedUser();
$invoices = $this->importInvoiceFixtures(1);
$this->assertApiAccessDenied($client, '/api/invoices/' . $invoices[0]->getId());
}
public function testGetEntity(): void
{
$client = $this->getClientForAuthenticatedUser(User::ROLE_ADMIN);
$invoices = $this->importInvoiceFixtures(1);
$this->assertAccessIsGranted($client, '/api/invoices/' . $invoices[0]->getId());
$content = $client->getResponse()->getContent();
$this->assertIsString($content);
$result = json_decode($content, true);
$this->assertIsArray($result);
self::assertApiResponseTypeStructure('Invoice', $result);
}
public function testNotFound(): void
{
$this->assertEntityNotFound(User::ROLE_USER, '/api/invoices/' . PHP_INT_MAX);
}
}

2
tests/API/ProjectControllerTest.php
View File

@@ -326,7 +326,7 @@ class ProjectControllerTest extends APIControllerBaseTest
public function testNotFound(): void
{
$this->assertEntityNotFound(User::ROLE_USER, '/api/projects/' . PHP_INT_MAX, 'GET', 'App\\Entity\\Project object not found by the @ParamConverter annotation.');
$this->assertEntityNotFound(User::ROLE_USER, '/api/projects/' . PHP_INT_MAX);
}
public function testPostAction(): void

2
tests/API/TeamControllerTest.php
View File

@@ -83,7 +83,7 @@ class TeamControllerTest extends APIControllerBaseTest
public function testNotFound(): void
{
$this->assertEntityNotFound(User::ROLE_USER, '/api/teams/' . PHP_INT_MAX, 'GET', 'App\\Entity\\Team object not found by the @ParamConverter annotation.');
$this->assertEntityNotFound(User::ROLE_USER, '/api/teams/' . PHP_INT_MAX);
}
public function testDeleteActionWithUnknownTeam(): void

2
tests/API/TimesheetControllerTest.php
View File

@@ -448,7 +448,7 @@ class TimesheetControllerTest extends APIControllerBaseTest
public function testGetEntityNotFound(): void
{
$this->assertEntityNotFound(User::ROLE_USER, '/api/timesheets/' . PHP_INT_MAX, 'GET', 'App\\Entity\\Timesheet object not found by the @ParamConverter annotation.');
$this->assertEntityNotFound(User::ROLE_USER, '/api/timesheets/' . PHP_INT_MAX);
}
public function testPostAction(): void

18
tests/DataFixtures/ActivityFixtures.php
View File

@@ -19,6 +19,8 @@ use Faker\Factory;
*/
final class ActivityFixtures implements TestFixture
{
use FixturesTrait;
private int $amount = 0;
private bool $isGlobal = false;
private ?bool $isVisible = null;
@@ -127,20 +129,4 @@ final class ActivityFixtures implements TestFixture
return $created;
}
/**
* @param ObjectManager $manager
* @return array<int|string, Project>
*/
private function getAllProjects(ObjectManager $manager): array
{
$all = [];
/** @var Project[] $entries */
$entries = $manager->getRepository(Project::class)->findAll();
foreach ($entries as $temp) {
$all[$temp->getId()] = $temp;
}
return $all;
}
}

2
tests/DataFixtures/CustomerFixtures.php
View File

@@ -34,7 +34,6 @@ final class CustomerFixtures implements TestFixture
* Will be called prior to persisting the object.
*
* @param callable $callback
* @return CustomerFixtures
*/
public function setCallback(callable $callback): CustomerFixtures
{
@@ -63,7 +62,6 @@ final class CustomerFixtures implements TestFixture
}
/**
* @param ObjectManager $manager
* @return Customer[]
*/
public function load(ObjectManager $manager): array

91
tests/DataFixtures/FixturesTrait.php Normal file
View File

@@ -0,0 +1,91 @@
<?php
/*
* This file is part of the Kimai time-tracking app.
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace App\Tests\DataFixtures;
use App\Entity\Activity;
use App\Entity\Customer;
use App\Entity\Project;
use App\Entity\User;
use Doctrine\Persistence\ObjectManager;
trait FixturesTrait
{
/**
* @return array<int, User>
*/
private function getAllUsers(ObjectManager $manager): array
{
$all = [];
/** @var User[] $entries */
$entries = $manager->getRepository(User::class)->findAll();
foreach ($entries as $temp) {
if ($temp->getId() === null) {
continue;
}
$all[$temp->getId()] = $temp;
}
return $all;
}
/**
* @return array<int, Customer>
*/
private function getAllCustomers(ObjectManager $manager): array
{
$all = [];
/** @var Customer[] $entries */
$entries = $manager->getRepository(Customer::class)->findAll();
foreach ($entries as $temp) {
if ($temp->getId() === null) {
continue;
}
$all[$temp->getId()] = $temp;
}
return $all;
}
/**
* @return array<int, Project>
*/
private function getAllProjects(ObjectManager $manager): array
{
$all = [];
/** @var Project[] $entries */
$entries = $manager->getRepository(Project::class)->findAll();
foreach ($entries as $temp) {
if ($temp->getId() === null) {
continue;
}
$all[$temp->getId()] = $temp;
}
return $all;
}
/**
* @return array<int, Activity>
*/
private function getAllActivities(ObjectManager $manager): array
{
$all = [];
/** @var Activity[] $entries */
$entries = $manager->getRepository(Activity::class)->findAll();
foreach ($entries as $temp) {
if ($temp->getId() === null) {
continue;
}
$all[$temp->getId()] = $temp;
}
return $all;
}
}

76
tests/DataFixtures/InvoiceFixtures.php Normal file
View File

@@ -0,0 +1,76 @@
<?php
/*
* This file is part of the Kimai time-tracking app.
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace App\Tests\DataFixtures;
use App\Entity\Invoice;
use Doctrine\Persistence\ObjectManager;
use Faker\Factory;
/**
* Defines the sample data to load in during controller tests.
*/
class InvoiceFixtures implements TestFixture
{
use FixturesTrait;
private int $amount = 50;
private array $status = [Invoice::STATUS_CANCELED, Invoice::STATUS_NEW, Invoice::STATUS_PAID, Invoice::STATUS_PENDING];
public function setAmount(int $amount = 50): void
{
$this->amount = $amount;
}
public function setStatus(array $status): void
{
$this->status = $status;
}
/**
* @return Invoice[]
*/
public function load(ObjectManager $manager): array
{
$created = [];
$faker = Factory::create();
$customers = $this->getAllCustomers($manager);
$users = $this->getAllUsers($manager);
for ($i = 0; $i < $this->amount; $i++) {
$total = $faker->randomFloat(2, 50, 5000);
$vat = $faker->randomFloat(2, 0, 23) / 10;
$tax = $total * $vat;
$invoice = new Invoice();
$invoice->setStatus($this->status[array_rand($this->status)]);
$invoice->setTotal($total);
$invoice->setVat($vat);
$invoice->setTax($tax);
$invoice->setCustomer($customers[array_rand($customers)]);
$invoice->setInvoiceNumber($i . '_ ' . $faker->text(10));
$invoice->setCreatedAt($faker->dateTimeBetween('-1 year', 'now'));
$invoice->setUser($users[array_rand($users)]);
$invoice->setDueDays($faker->randomNumber(2));
$invoice->setFilename($faker->text(30));
$invoice->setComment($faker->text(300));
$invoice->setCurrency($faker->currencyCode());
$manager->persist($invoice);
$created[] = $invoice;
}
$manager->flush();
return $created;
}
}

1
tests/DataFixtures/InvoiceTemplateFixtures.php
View File

@@ -19,7 +19,6 @@ use Faker\Factory;
class InvoiceTemplateFixtures implements TestFixture
{
/**
* @param ObjectManager $manager
* @return InvoiceTemplate[]
*/
public function load(ObjectManager $manager): array

18
tests/DataFixtures/ProjectFixtures.php
View File

@@ -19,6 +19,8 @@ use Faker\Factory;
*/
final class ProjectFixtures implements TestFixture
{
use FixturesTrait;
private int $amount = 0;
private ?bool $isVisible = null;
/**
@@ -114,20 +116,4 @@ final class ProjectFixtures implements TestFixture
return $created;
}
/**
* @param ObjectManager $manager
* @return array<int|string, Customer>
*/
private function getAllCustomers(ObjectManager $manager): array
{
$all = [];
/** @var Customer[] $entries */
$entries = $manager->getRepository(Customer::class)->findAll();
foreach ($entries as $temp) {
$all[$temp->getId()] = $temp;
}
return $all;
}
}

54
tests/DataFixtures/TeamFixtures.php
View File

@@ -9,7 +9,6 @@
namespace App\Tests\DataFixtures;
use App\Entity\Customer;
use App\Entity\Team;
use App\Entity\User;
use Doctrine\Persistence\ObjectManager;
@@ -19,22 +18,15 @@ use Doctrine\Persistence\ObjectManager;
*/
final class TeamFixtures implements TestFixture
{
/**
* @var int
*/
private $amount = 0;
/**
* @var bool
*/
private $addCustomer = true;
use FixturesTrait;
private int $amount = 0;
private bool $addCustomer = true;
/**
* @var User[]
*/
private $skipUser = [];
/**
* @var bool
*/
private $addUser = true;
private array $skipUser = [];
private bool $addUser = true;
/**
* @var callable
*/
@@ -44,7 +36,6 @@ final class TeamFixtures implements TestFixture
* Will be called prior to persisting the object.
*
* @param callable $callback
* @return TeamFixtures
*/
public function setCallback(callable $callback): TeamFixtures
{
@@ -87,7 +78,6 @@ final class TeamFixtures implements TestFixture
}
/**
* @param ObjectManager $manager
* @return Team[]
*/
public function load(ObjectManager $manager): array
@@ -135,36 +125,4 @@ final class TeamFixtures implements TestFixture
return $created;
}
/**
* @param ObjectManager $manager
* @return array<int|string, Customer>
*/
private function getAllCustomers(ObjectManager $manager)
{
$all = [];
/** @var Customer[] $entries */
$entries = $manager->getRepository(Customer::class)->findAll();
foreach ($entries as $temp) {
$all[$temp->getId()] = $temp;
}
return $all;
}
/**
* @param ObjectManager $manager
* @return array<int|string, User>
*/
private function getAllUsers(ObjectManager $manager): array
{
$all = [];
/** @var User[] $entries */
$entries = $manager->getRepository(User::class)->findAll();
foreach ($entries as $temp) {
$all[$temp->getId()] = $temp;
}
return $all;
}
}

50
tests/DataFixtures/TimesheetFixtures.php
View File

@@ -24,6 +24,8 @@ use Faker\Factory;
*/
final class TimesheetFixtures implements TestFixture
{
use FixturesTrait;
private int $running = 0;
/**
* @var Activity[]
@@ -307,54 +309,6 @@ final class TimesheetFixtures implements TestFixture
return $start;
}
/**
* @param ObjectManager $manager
* @return array<int|string, Activity>
*/
private function getAllActivities(ObjectManager $manager): array
{
$all = [];
/** @var Activity[] $entries */
$entries = $manager->getRepository(Activity::class)->findAll();
foreach ($entries as $temp) {
$all[$temp->getId()] = $temp;
}
return $all;
}
/**
* @param ObjectManager $manager
* @return array<int|string, Project>
*/
private function getAllProjects(ObjectManager $manager): array
{
$all = [];
/** @var Project[] $entries */
$entries = $manager->getRepository(Project::class)->findAll();
foreach ($entries as $temp) {
$all[$temp->getId()] = $temp;
}
return $all;
}
/**
* @param ObjectManager $manager
* @return array<int|string, User>
*/
private function getAllUsers(ObjectManager $manager): array
{
$all = [];
/** @var User[] $entries */
$entries = $manager->getRepository(User::class)->findAll();
foreach ($entries as $temp) {
$all[$temp->getId()] = $temp;
}
return $all;
}
/**
* @param \DateTime $start
* @param array<Tag> $tagArray