Skip to content

An open-source, self-hostable PaaS alternative to Vercel, Heroku & Netlify that lets you easily deploy static sites, databases, full-stack applications and 360+ one-click services on your own servers.

5.8 KB
Raw Blame
<?php

use App\Models\AuditEvent;
use App\Models\InstanceSettings;
use App\Models\Team;
use App\Models\User;
use Illuminate\Foundation\Testing\RefreshDatabase;

uses(RefreshDatabase::class);

beforeEach(function () {
    config()->set('app.maintenance.driver', 'file');
    config()->set('cache.default', 'array');

    InstanceSettings::unguarded(fn () => InstanceSettings::updateOrCreate(['id' => 0], ['is_api_enabled' => true]));

    $this->team = Team::factory()->create(['name' => 'Token Team']);
    $this->user = User::factory()->create();
    $this->team->members()->attach($this->user->id, ['role' => 'owner']);
    session(['currentTeam' => $this->team]);

    $this->bearerToken = $this->user->createToken('team-token-api-test', ['*'])->plainTextToken;
});

function teamTokenApiHeaders(string $bearerToken): array
{
    return [
        'Authorization' => 'Bearer '.$bearerToken,
        'Accept' => 'application/json',
    ];
}

describe('token team endpoints', function () {
    test('legacy team endpoints are restricted to the token team', function () {
        $otherTeam = Team::factory()->create(['name' => 'Other Team']);
        $otherMember = User::factory()->create();
        $otherTeam->members()->attach($this->user->id, ['role' => 'owner']);
        $otherTeam->members()->attach($otherMember->id, ['role' => 'member']);

        $this->withHeaders(teamTokenApiHeaders($this->bearerToken))
            ->getJson('/api/v1/teams')
            ->assertOk()
            ->assertJsonCount(1)
            ->assertJsonPath('0.id', $this->team->id);

        $this->withHeaders(teamTokenApiHeaders($this->bearerToken))
            ->getJson("/api/v1/teams/{$otherTeam->id}")
            ->assertNotFound();

        $this->withHeaders(teamTokenApiHeaders($this->bearerToken))
            ->getJson("/api/v1/teams/{$otherTeam->id}/members")
            ->assertNotFound();
    });

    test('GET /team returns the token team', function () {
        $this->withHeaders(teamTokenApiHeaders($this->bearerToken))
            ->getJson('/api/v1/team')
            ->assertOk()
            ->assertJsonPath('id', $this->team->id)
            ->assertJsonPath('name', 'Token Team')
            ->assertJsonPath('is_build_server_fallback_enabled', true);
    });

    test('PATCH /team updates the build server fallback policy', function () {
        $this->withHeaders(teamTokenApiHeaders($this->bearerToken))
            ->patchJson('/api/v1/team', [
                'is_build_server_fallback_enabled' => false,
            ])
            ->assertOk()
            ->assertJsonPath('is_build_server_fallback_enabled', false);

        expect($this->team->fresh()->is_build_server_fallback_enabled)->toBeFalse();
    });

    test('PATCH /team records an audit event', function () {
        $this->withHeaders(teamTokenApiHeaders($this->bearerToken))
            ->patchJson('/api/v1/team', [
                'is_build_server_fallback_enabled' => false,
            ])
            ->assertOk();

        $event = AuditEvent::query()->where('event', 'api.team.updated')->sole();
        expect($event->team_id)->toBe($this->team->id)
            ->and(data_get($event->metadata, 'changed_fields'))->toBe(['is_build_server_fallback_enabled']);
    });

    test('PATCH /team validates the build server fallback policy', function () {
        $this->withHeaders(teamTokenApiHeaders($this->bearerToken))
            ->patchJson('/api/v1/team', [
                'is_build_server_fallback_enabled' => 'invalid',
            ])
            ->assertUnprocessable()
            ->assertJsonValidationErrors('is_build_server_fallback_enabled');

        expect($this->team->fresh()->is_build_server_fallback_enabled)->toBeTrue();
    });

    test('team members cannot update the build server fallback policy', function () {
        $this->team->members()->updateExistingPivot($this->user->id, ['role' => 'member']);

        $this->withHeaders(teamTokenApiHeaders($this->bearerToken))
            ->patchJson('/api/v1/team', [
                'is_build_server_fallback_enabled' => false,
            ])
            ->assertForbidden();

        expect($this->team->fresh()->is_build_server_fallback_enabled)->toBeTrue();
    });

    test('read-only tokens cannot update the build server fallback policy', function () {
        $readOnlyToken = $this->user->createToken('read-only-team-token', ['read'])->plainTextToken;

        $this->withHeaders(teamTokenApiHeaders($readOnlyToken))
            ->patchJson('/api/v1/team', [
                'is_build_server_fallback_enabled' => false,
            ])
            ->assertForbidden();

        expect($this->team->fresh()->is_build_server_fallback_enabled)->toBeTrue();
    });

    test('GET /team/members returns members of the token team', function () {
        $this->withHeaders(teamTokenApiHeaders($this->bearerToken))
            ->getJson('/api/v1/team/members')
            ->assertOk()
            ->assertJsonFragment(['id' => $this->user->id]);
    });

    test('deprecated GET /teams/current aliases GET /team', function () {
        $preferred = $this->withHeaders(teamTokenApiHeaders($this->bearerToken))
            ->getJson('/api/v1/team')
            ->assertOk()
            ->json();

        $alias = $this->withHeaders(teamTokenApiHeaders($this->bearerToken))
            ->getJson('/api/v1/teams/current')
            ->assertOk()
            ->json();

        expect($alias)->toBe($preferred);
    });

    test('deprecated GET /teams/current/members aliases GET /team/members', function () {
        $preferred = $this->withHeaders(teamTokenApiHeaders($this->bearerToken))
            ->getJson('/api/v1/team/members')
            ->assertOk()
            ->json();

        $alias = $this->withHeaders(teamTokenApiHeaders($this->bearerToken))
            ->getJson('/api/v1/teams/current/members')
            ->assertOk()
            ->json();

        expect($alias)->toBe($preferred);
    });
});