improve permission checks for timesheets with activated lockdown (#2271)

2021-01-17 17:50:37 +01:00
parent 8d72d114c7
commit 67d5cba09f
24 changed files with 595 additions and 111 deletions
--- a/tests/Timesheet/LockdownServiceTest.php
+++ b/tests/Timesheet/LockdownServiceTest.php
@@ -0,0 +1,151 @@
+<?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\Timesheet;
+
+use App\Configuration\ConfigLoaderInterface;
+use App\Configuration\SystemConfiguration;
+use App\Entity\Timesheet;
+use App\Timesheet\LockdownService;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * @covers \App\Timesheet\LockdownService
+ */
+class LockdownServiceTest extends TestCase
+{
+    protected function createService(?string $start, ?string $end, ?string $grace)
+    {
+        $loader = $this->createMock(ConfigLoaderInterface::class);
+        $config = new SystemConfiguration($loader, [
+            'timesheet' => [
+                'rules' => [
+                    'lockdown_period_start' => $start,
+                    'lockdown_period_end' => $end,
+                    'lockdown_grace_period' => $grace,
+                ],
+            ]
+        ]);
+
+        return new LockdownService($config);
+    }
+
+    public function testValidatorWithoutNowConstraint()
+    {
+        $sut = $this->createService('first day of last month', 'last day of last month', '+10 days');
+
+        $begin = new \DateTime('first day of last month');
+        $begin->modify('-5 days');
+        $timesheet = new Timesheet();
+        $timesheet->setBegin($begin);
+
+        self::assertFalse($sut->isEditable($timesheet, new \DateTime(), false));
+    }
+
+    public function testValidatorWithEmptyTimesheet()
+    {
+        $sut = $this->createService('first day of last month', 'last day of last month', '+10 days');
+
+        self::assertTrue($sut->isEditable(new Timesheet(), new \DateTime(), false));
+    }
+
+    public function testValidatorWithoutNowStringConstraint()
+    {
+        $sut = $this->createService('first day of last month', 'last day of last month', '+10 days');
+
+        $begin = new \DateTime('first day of last month');
+        $begin->modify('+5 days');
+        $timesheet = new Timesheet();
+        $timesheet->setBegin($begin);
+
+        self::assertTrue($sut->isEditable($timesheet, new \DateTime('first day of this month'), false));
+    }
+
+    public function testValidatorWithEndBeforeStartPeriod()
+    {
+        $sut = $this->createService('first day of this month', 'last day of last month', '+10 days');
+
+        $begin = new \DateTime('first day of last month');
+        $begin->modify('+5 days');
+        $timesheet = new Timesheet();
+        $timesheet->setBegin($begin);
+
+        self::assertTrue($sut->isEditable($timesheet, new \DateTime('first day of this month'), false));
+    }
+
+    /**
+     * @dataProvider getTestData
+     */
+    public function testLockdown(bool $allowOverwriteGrace, string $beginModifier, string $nowModifier, bool $isViolation)
+    {
+        $sut = $this->createService('first day of last month', 'last day of last month', '+10 days');
+
+        $begin = new \DateTime('first day of last month');
+        $begin->modify($beginModifier);
+        $timesheet = new Timesheet();
+        $timesheet->setBegin($begin);
+
+        $now = new \DateTime('first day of this month');
+        $now->modify($nowModifier);
+
+        $result = $sut->isEditable($timesheet, $now, $allowOverwriteGrace);
+        if ($isViolation) {
+            self::assertFalse($result);
+        } else {
+            self::assertTrue($result);
+        }
+    }
+
+    public function getTestData()
+    {
+        // changing before last dockdown period is not allowed
+        yield [false, '-5 days', '+5 days', true];
+        // changing before last dockdown period is not allowed with grace permission
+        yield [true, '-5 days', '+5 days', true];
+        // changing a value in the last lockdown period is allowed during grace period
+        yield [false, '+5 days', '+5 days', false];
+        // changing outside grace period is not allowed
+        yield [false, '+5 days', '+11 days', true];
+        // changing outside grace period is allowed with grace and full permission
+        yield [true, '+5 days', '+11 days', false];
+    }
+
+    /**
+     * @dataProvider getConfigTestData
+     */
+    public function testLockdownConfig(bool $allowOverwriteGrace, ?string $lockdownBegin, ?string $lockdownEnd, ?string $grace, bool $isViolation)
+    {
+        $sut = $this->createService($lockdownBegin, $lockdownEnd, $grace);
+
+        $begin = new \DateTime('first day of last month');
+        $begin->modify('+5 days');
+        $timesheet = new Timesheet();
+        $timesheet->setBegin($begin);
+
+        $now = new \DateTime('first day of this month');
+
+        $result = $sut->isEditable($timesheet, $now, $allowOverwriteGrace);
+
+        if ($isViolation) {
+            self::assertFalse($result);
+        } else {
+            self::assertTrue($result);
+        }
+    }
+
+    public function getConfigTestData()
+    {
+        yield [false, null, null, null, false];
+        yield [false, '+5 days', null, null, false];
+        yield [false, null, '+5 days', null, false];
+
+        yield [true, 'öööö', '+11 days', null, false];
+        yield [true, '+5 days', '+5 of !!!!', null, false];
+    }
+}