TokenRequestTest.php

Go to the documentation of this file.

<?php
/*
 SPDX-FileCopyrightText: © 2025 Harshit Gandhi <gandhiharshit716@gmail.com>
 
 SPDX-License-Identifier: GPL-2.0-only
*/
 
namespace Fossology\UI\Api\Test\Models;
 
use Fossology\UI\Api\Models\TokenRequest;
use Fossology\UI\Api\Exceptions\HttpBadRequestException;
use PHPUnit\Framework\TestCase;
use DateTime;
 
class TokenRequestTest extends TestCase
{
  private $sampleData;
 
  protected function setUp(): void
  {
    $this->sampleData = [
      'tokenName' => 'TestToken',
      'tokenScope' => 'read',
      'tokenExpire' => '2025-12-31',
      'username' => 'testUser',
      'password' => 'testPassword'
    ];
  }
 
 
  public function testConstructor()
  {
    $tokenRequest = new TokenRequest(...array_values($this->sampleData));
    $this->assertInstanceOf(TokenRequest::class, $tokenRequest);
  }
 
 
  public function testGetTokenName()
  {
    $tokenRequest = new TokenRequest(...array_values($this->sampleData));
    $this->assertEquals($this->sampleData['tokenName'], $tokenRequest->getTokenName());
  }
 
  public function testGetTokenScope()
  {
    $tokenRequest = new TokenRequest(...array_values($this->sampleData));
    $this->assertEquals('r', $tokenRequest->getTokenScope());
  }
 
  public function testGetTokenExpire()
  {
    $tokenRequest = new TokenRequest(...array_values($this->sampleData));
    $this->assertEquals($this->sampleData['tokenExpire'], $tokenRequest->getTokenExpire());
  }
 
  public function testGetUsername()
  {
    $tokenRequest = new TokenRequest(...array_values($this->sampleData));
    $this->assertEquals($this->sampleData['username'], $tokenRequest->getUsername());
  }
 
  public function testGetPassword()
  {
    $tokenRequest = new TokenRequest(...array_values($this->sampleData));
    $this->assertEquals($this->sampleData['password'], $tokenRequest->getPassword());
  }
 
 
  public function testSetTokenName()
  {
    $tokenRequest = new TokenRequest(...array_values($this->sampleData));
    $tokenRequest->setTokenName('NewToken');
    $this->assertEquals('NewToken', $tokenRequest->getTokenName());
  }
 
  public function testSetTokenScope()
  {
    $tokenRequest = new TokenRequest(...array_values($this->sampleData));
    $tokenRequest->setTokenScope('write');
    $this->assertEquals('w', $tokenRequest->getTokenScope());
  }
 
  public function testSetTokenExpire()
  {
    $tokenRequest = new TokenRequest(...array_values($this->sampleData));
    $tokenRequest->setTokenExpire('2026-01-01');
    $this->assertEquals('2026-01-01', $tokenRequest->getTokenExpire());
  }
 
  public function testSetUsername()
  {
    $tokenRequest = new TokenRequest(...array_values($this->sampleData));
    $tokenRequest->setUsername('testUser');
    $this->assertEquals('testUser', $tokenRequest->getUsername());
  }
 
  public function testSetPassword()
  {
    $tokenRequest = new TokenRequest(...array_values($this->sampleData));
    $tokenRequest->setPassword('testPassword');
    $this->assertEquals('testPassword', $tokenRequest->getPassword());
  }
 
 
  public function testFromArrayVersion1()
  {
    $input = [
      'username' => 'testUser',
      'password' => 'testPassword',
      'token_name' => 'TestToken',
      'token_scope' => 'read',
      'token_expire' => '2025-12-31'
    ];
    
    $tokenRequest = TokenRequest::fromArray($input, 1);
    $this->assertInstanceOf(TokenRequest::class, $tokenRequest);
  }
 
  public function testFromArrayVersion2()
  {
    $input = [
      'username' => 'testUser',
      'password' => 'testPassword',
      'tokenName' => 'TestToken',
      'tokenScope' => 'read',
      'tokenExpire' => '2025-12-31'
    ];
    
    $tokenRequest = TokenRequest::fromArray($input, 2);
    $this->assertInstanceOf(TokenRequest::class, $tokenRequest);
  }
 
  public function testFromArrayMissingKeys()
  {
    $this->expectException(HttpBadRequestException::class);
    $input = ['username' => 'testUser'];
    TokenRequest::fromArray($input, 1);
  }
 
  public function testFromArrayInvalidTokenExpire(string $expiry, int $version)
  {
    $keys = $version === 1 ? TokenRequest::VERSION_1_KEYS : TokenRequest::VERSION_2_KEYS;
    $input = array_combine($keys, ['testUser', 'testPassword', 'TestToken', 'read', $expiry]);
 
    $this->expectException(HttpBadRequestException::class);
    $this->expectExceptionMessage('Invalid date format provided');
    TokenRequest::fromArray($input, $version);
  }
 
  public function invalidTokenExpireProvider(): array
  {
    $cases = [];
    foreach ([1, 2] as $version) {
      foreach (['2026-10-32', '2026-11-31', '2026-02-29', '1900-02-29',
        '2026-13-01', '2026-00-01', '2026-01-00', '2026-1-01',
        '2026-01-1', '2026-01-01 ', 'not-a-date', ''] as $expiry) {
        $cases[] = [$expiry, $version];
      }
    }
    return $cases;
  }
 
  public function testFromArrayValidTokenExpire(string $expiry, int $version)
  {
    $keys = $version === 1 ? TokenRequest::VERSION_1_KEYS : TokenRequest::VERSION_2_KEYS;
    $input = array_combine($keys, ['testUser', 'testPassword', 'TestToken', 'read', $expiry]);
 
    $tokenRequest = TokenRequest::fromArray($input, $version);
    $this->assertSame($expiry, $tokenRequest->getTokenExpire());
  }
 
  public function validTokenExpireProvider(): array
  {
    return [
      ['2026-11-01', 1],
      ['2026-11-01', 2],
      ['2028-02-29', 1],
      ['2028-02-29', 2],
      ['2000-02-29', 1],
      ['2000-02-29', 2]
    ];
  }
 
  public function testInvalidTokenExpirePreservesPreviousValue()
  {
    $tokenRequest = new TokenRequest(...array_values($this->sampleData));
    try {
      $tokenRequest->setTokenExpire('2026-10-32');
      $this->fail('Expected an invalid date to be rejected');
    } catch (HttpBadRequestException $exception) {
      $this->assertSame($this->sampleData['tokenExpire'], $tokenRequest->getTokenExpire());
    }
  }
}