feuerwerk/tests/php/accounts.test.php

<?php
declare(strict_types=1);

// A command-line script: under a web server it does nothing (#427).
if (PHP_SAPI !== 'cli') {
    exit(1);
}

/**
 * Accounts, roles and who may touch which project (#180, #179), without a web server: the stores
 * work on a scratch directory. Plain PHP, no framework – CI runs it with `php tests/php/accounts.test.php`
 * and reads the last line, as it does for the other suites.
 */

require __DIR__ . '/../../api/lib/AccountRules.php';
require __DIR__ . '/../../api/lib/AtomicFile.php';
require __DIR__ . '/../../api/lib/Store.php';
require __DIR__ . '/../../api/lib/UserStore.php';

$failed = 0;
$passed = 0;

function check(string $name, bool $ok, mixed $got = null): void
{
    global $failed, $passed;
    if ($ok) {
        $passed++;
        echo "PASS  {$name}\n";
        return;
    }
    $failed++;
    echo "FAIL  {$name}", $got === null ? '' : ' — got ' . json_encode($got), "\n";
}

function throws(callable $work, string $class = InvalidArgumentException::class): bool
{
    try {
        $work();
    } catch (Throwable $e) {
        if ($e instanceof $class) {
            return true;
        }
        throw $e;
    }
    return false;
}

$dir = sys_get_temp_dir() . '/feuerwerk-php-test-' . bin2hex(random_bytes(4));
mkdir($dir);
$file = "{$dir}/users.json";

// --- UserStore ---------------------------------------------------------------------------------

file_put_contents($file, json_encode(['users' => [
    ['username' => 'old', 'password' => password_hash('secret12', PASSWORD_DEFAULT)],
    ['username' => 'odd', 'password' => password_hash('secret12', PASSWORD_DEFAULT), 'role' => 'root'],
]]));
$users = new UserStore($file);
check('an account without a role is a user', $users->role('old') === 'user', $users->role('old'));
check('an unknown role counts as user', $users->role('odd') === 'user', $users->role('odd'));
check('an account that is not there is a user', $users->role('nobody') === 'user');
check('the old accounts have no creation date', $users->accounts()[1]['createdAt'] === '', $users->accounts());

$users->put('boss', 'secret12', 'admin');
check('a role given on creation is kept', $users->role('boss') === 'admin');
check('a new account gets a creation date', $users->accounts()[0]['createdAt'] !== '', $users->accounts()[0]);
$created = $users->accounts()[0]['createdAt'];
$users->put('boss', 'another12');
check('a new password without a role leaves the role alone', $users->role('boss') === 'admin');
check('a new password leaves the creation date alone', $users->accounts()[0]['createdAt'] === $created);
check('the new password is the one that works', $users->verify('boss', 'another12') === 'boss');
$users->put('fresh', 'secret12');
check('a new account without a role is a user', $users->role('fresh') === 'user');
check('the role is written to the file', str_contains((string) file_get_contents($file), '"role": "admin"'));
check('an unknown role is refused', throws(fn() => $users->put('x1', 'secret12', 'root')));
check(
    'the accounts carry no hash',
    !str_contains(json_encode($users->accounts()), 'password') && !str_contains(json_encode($users->accounts()), '$2y$'),
);
check('one administrator counted', $users->adminCount() === 1, $users->adminCount());
$users->setRole('fresh', 'admin');
check('setRole makes an administrator', $users->role('fresh') === 'admin' && $users->adminCount() === 2);
check('setRole on nobody answers false', $users->setRole('nobody', 'user') === false);

check('rename moves the account', $users->rename('fresh', 'renamed') && $users->exists('renamed') && !$users->exists('fresh'));
check('rename keeps password and role', $users->verify('renamed', 'secret12') === 'renamed' && $users->role('renamed') === 'admin');
check('rename onto a taken name is refused', throws(fn() => $users->rename('renamed', 'OLD')));
check('the refused rename changed nothing', $users->exists('renamed') && $users->role('old') === 'user');
check('rename to an invalid name is refused', throws(fn() => $users->rename('renamed', 'a b')));
check('a change of case is the same account', $users->rename('renamed', 'Renamed') && $users->accounts()[0]['username'] === 'Renamed', $users->accounts());
check('rename of nobody answers false', $users->rename('nobody', 'somebody') === false);
check('remove takes the account away', $users->remove('renamed') && !$users->exists('renamed'));
check('remove of nobody answers false', $users->remove('renamed') === false);

// --- Store: who reaches a project --------------------------------------------------------------

$projects = "{$dir}/projects";
$mine = new Store($projects, 'anna');
$doc = $mine->create('Anna\'s game');
$id = $doc['id'];
$stranger = new Store($projects, 'bert');
$admin = new Store($projects, 'boss', true);

check('a stranger does not see the project', $stranger->load($id) === null);
check('a stranger cannot save it', $stranger->save($id, 1, ['name' => 'x']) === null);
check('a stranger cannot delete it', $stranger->delete($id) === false);
check('an administrator loads it', $admin->load($id)['name'] === "Anna's game");
$saved = $admin->save($id, 1, ['name' => 'Edited by boss']);
check('an administrator saves it', $saved !== null && $saved['revision'] === 2, $saved);
check('the save keeps the owner', $mine->load($id)['owner'] === 'anna', $mine->load($id)['owner'] ?? null);
check('the owner sees the edit', $mine->load($id)['name'] === 'Edited by boss');
check('the administrator\'s own list stays their own', $admin->list() === []);
check('listOf lists somebody else\'s projects', array_column($admin->listOf('anna'), 'id') === [$id]);

check('transfer moves the project to the new name', $admin->transfer('anna', 'annabel') === 1);
$moved = (new Store($projects, 'annabel'))->load($id);
check('the new name owns it', $moved !== null && $moved['owner'] === 'annabel');
check('the old name does not', $mine->load($id) === null);
check('transfer keeps the revision', $moved['revision'] === 2, $moved['revision'] ?? null);

$carl = new Store($projects, 'carl');
$other = $carl->create('Carl\'s game');
check('an administrator may not delete somebody else\'s project', throws(fn() => $admin->delete($other['id']), NotOwnerException::class));
check('the refused delete leaves the project', $carl->load($other['id']) !== null);
check('its owner deletes it', $carl->delete($other['id']) && $admin->listOf('carl') === []);
$ownerless = "{$projects}/nobody01.json";
file_put_contents($ownerless, json_encode(['id' => 'nobody01', 'revision' => 1, 'project' => []]));
check('an administrator may not delete a project without an owner', throws(fn() => $admin->delete('nobody01'), NotOwnerException::class) && is_file($ownerless));
$own = $admin->create('Boss\'s game');
check('an administrator deletes their own project', $admin->delete($own['id']) && $admin->list() === []);

// The web server serves `data/` as static files, so a readable project would skip the sign-in.
check('a project file is not readable for the web server', (fileperms("{$projects}/{$id}.json") & 0o007) === 0);

// --- Store: saves at the same time -------------------------------------------------------------

// Every worker saves with the revision it just read and tries again when it was beaten to it, so
// no save may be lost: each one that succeeded has to show in the revision.
if (!function_exists('pcntl_fork')) {
    echo "SKIP  saves at the same time (this PHP has no pcntl)\n";
} else {
    $raceDir = "{$dir}/race";
    $raceId = (new Store($raceDir, 'anna'))->create('Race')['id'];
    $workers = 8;
    $rounds = 40;
    $children = [];
    for ($w = 0; $w < $workers; $w++) {
        $pid = pcntl_fork();
        if ($pid === 0) {
            $store = new Store($raceDir, 'anna');
            for ($won = 0; $won < $rounds;) {
                try {
                    $store->save($raceId, $store->load($raceId)['revision'], ['name' => 'Race', 'by' => $w]);
                    $won++;
                } catch (StaleRevisionException) {
                }
            }
            exit(0);
        }
        $children[] = $pid;
    }
    foreach ($children as $pid) {
        pcntl_waitpid($pid, $status);
    }
    $final = (new Store($raceDir, 'anna'))->load($raceId)['revision'];
    check("{$workers} tabs saving at once lose none of the saves", $final === 1 + $workers * $rounds, $final);
}

// --- AccountRules ------------------------------------------------------------------------------

check('renaming yourself is refused', AccountRules::renameRefusal('boss', 'BOSS') !== null);
check('renaming somebody else is fine', AccountRules::renameRefusal('boss', 'anna') === null);
check('changing your own role is refused', AccountRules::roleRefusal('boss', 'boss', 'admin', 'user', 2) !== null);
check('setting your own role to what it is is fine', AccountRules::roleRefusal('boss', 'boss', 'admin', 'admin', 1) === null);
check('the last administrator cannot be demoted', AccountRules::roleRefusal('x', 'boss', 'admin', 'user', 1) !== null);
check('an administrator among two can be demoted', AccountRules::roleRefusal('x', 'boss', 'admin', 'user', 2) === null);
check('deleting yourself is refused', AccountRules::deleteRefusal('boss', 'boss', 'admin', 2) !== null);
check('the last administrator cannot be deleted', AccountRules::deleteRefusal('x', 'boss', 'admin', 1) !== null);
check('a user can be deleted', AccountRules::deleteRefusal('boss', 'anna', 'user', 1) === null);
check('an account with projects is not deleted', AccountRules::ownerRefusal('anna', 2) === 'anna still owns 2 projects');
check('one project is said as one', AccountRules::ownerRefusal('anna', 1) === 'anna still owns 1 project');
check('an account without projects may go', AccountRules::ownerRefusal('anna', 0) === null);

exec('rm -rf ' . escapeshellarg($dir));

echo $failed === 0 ? "ALL PASSED – {$passed} checks\n" : "{$failed} FAILED, {$passed} passed\n";
exit($failed === 0 ? 0 : 1);