You are here

Home » API reference » Auth0 Single Sign On 8.2 » GrantsMockedTest.php

class GrantsTestMocked in Auth0 Single Sign On 8.2

Class GrantsTestMocked.

@package Auth0\Tests\API\Management

Hierarchy

Expanded class hierarchy of GrantsTestMocked

File

vendor/auth0/auth0-php/tests/API/Management/GrantsMockedTest.php, line 17

Namespace

Auth0\Tests\API\Management
View source 
class GrantsTestMocked extends \PHPUnit_Framework_TestCase {
  use ErrorHelpers;

  /**
   * Expected telemetry value.
   *
   * @var string
   */
  protected static $telemetry;

  /**
   * Runs before test suite starts.
   */
  public static function setUpBeforeClass() {
    $infoHeadersData = new InformationHeaders();
    $infoHeadersData
      ->setCorePackage();
    self::$telemetry = $infoHeadersData
      ->build();
  }
  public function testThatMethodAndPropertyReturnSameClass() {
    $api = new Management(uniqid(), uniqid());
    $this
      ->assertInstanceOf(Management\Grants::class, $api->grants);
    $this
      ->assertInstanceOf(Management\Grants::class, $api
      ->grants());
    $api->grants = null;
    $this
      ->assertInstanceOf(Management\Grants::class, $api
      ->grants());
  }

  /**
   * Test that getAll requests properly.
   *
   * @return void
   *
   * @throws \Exception Unsuccessful HTTP call.
   */
  public function testGrantsGetAll() {
    $api = new MockManagementApi([
      new Response(200),
    ]);
    $api
      ->call()
      ->grants()
      ->getAll();
    $this
      ->assertEquals('GET', $api
      ->getHistoryMethod());
    $this
      ->assertEquals('https://api.test.local/api/v2/grants', $api
      ->getHistoryUrl());
    $this
      ->assertEmpty($api
      ->getHistoryQuery());
    $headers = $api
      ->getHistoryHeaders();
    $this
      ->assertEquals('Bearer __api_token__', $headers['Authorization'][0]);
    $this
      ->assertEquals(self::$telemetry, $headers['Auth0-Client'][0]);
  }

  /**
   * Test that getAll sends pagination parameters with the request.
   *
   * @return void
   *
   * @throws \Exception Unsuccessful HTTP call.
   */
  public function testThatGrantsGetAllPaginates() {
    $api = new MockManagementApi([
      new Response(200),
      new Response(200),
      new Response(200),
    ]);
    $page = 1;
    $per_page = 5;
    $api
      ->call()
      ->grants()
      ->getAll($page, $per_page);
    $this
      ->assertEquals('GET', $api
      ->getHistoryMethod());
    $this
      ->assertStringStartsWith('https://api.test.local/api/v2/grants', $api
      ->getHistoryUrl());
    $this
      ->assertContains('page=1', $api
      ->getHistoryQuery());
    $this
      ->assertContains('per_page=5', $api
      ->getHistoryQuery());
    $page = 2;
    $per_page = null;
    $api
      ->call()
      ->grants()
      ->getAll($page, $per_page);
    $this
      ->assertContains('page=2', $api
      ->getHistoryQuery());
    $this
      ->assertNotContains('per_page=', $api
      ->getHistoryQuery());
    $page = false;
    $per_page = false;
    $api
      ->call()
      ->grants()
      ->getAll($page, $per_page);
    $this
      ->assertNull($api
      ->getHistoryQuery());
  }

  /**
   * Test that getAll sends additional parameters with the request.
   *
   * @return void
   *
   * @throws \Exception Unsuccessful HTTP call.
   */
  public function testThatGrantsGetAllAddsExtraParams() {
    $api = new MockManagementApi([
      new Response(200),
    ]);
    $add_params = [
      'param1' => 'value1',
      'param2' => 'value2',
    ];
    $api
      ->call()
      ->grants()
      ->getAll(null, null, $add_params);
    $this
      ->assertEquals('GET', $api
      ->getHistoryMethod());
    $this
      ->assertStringStartsWith('https://api.test.local/api/v2/grants', $api
      ->getHistoryUrl());
    $this
      ->assertContains('param1=value1', $api
      ->getHistoryQuery());
    $this
      ->assertContains('param2=value2', $api
      ->getHistoryQuery());
  }

  /**
   * Test that getByClientId adds a client_id to the request.
   *
   * @return void
   *
   * @throws \Exception Unsuccessful HTTP call.
   */
  public function testThatGrantsGetByClientId() {
    $api = new MockManagementApi([
      new Response(200),
    ]);
    $api
      ->call()
      ->grants()
      ->getByClientId('__test_client_id__');
    $this
      ->assertStringStartsWith('https://api.test.local/api/v2/grants', $api
      ->getHistoryUrl());
    $this
      ->assertEquals('client_id=__test_client_id__', $api
      ->getHistoryQuery());
  }

  /**
   * Test that getByClientId adds pagination parameters to the request.
   *
   * @return void
   *
   * @throws \Exception Unsuccessful HTTP call.
   */
  public function testThatGrantsGetByClientIdPaginates() {
    $api = new MockManagementApi([
      new Response(200),
    ]);
    $api
      ->call()
      ->grants()
      ->getByClientId('__test_client_id__', 1, 2);
    $this
      ->assertContains('page=1', $api
      ->getHistoryQuery());
    $this
      ->assertContains('per_page=2', $api
      ->getHistoryQuery());
  }

  /**
   * Test that getByClientId throws an exception with an empty parameter.
   *
   * @return void
   *
   * @throws \Exception Unsuccessful HTTP call.
   */
  public function testThatGrantsGetByClientIdThrowsException() {
    $api = new Management('__test_api_token__', '__test_domain__');
    try {
      $caught_exception = false;
      $api
        ->grants()
        ->getByClientId('');
    } catch (CoreException $e) {
      $caught_exception = $this
        ->errorHasString($e, 'Empty or invalid "client_id" parameter');
    }
    $this
      ->assertTrue($caught_exception);
    try {
      $caught_exception = false;
      $api
        ->grants()
        ->getByClientId([
        '__not_empty__',
      ]);
    } catch (CoreException $e) {
      $caught_exception = $this
        ->errorHasString($e, 'Empty or invalid "client_id" parameter');
    }
    $this
      ->assertTrue($caught_exception);
  }

  /**
   * Test that getByAudience adds an audience to the request.
   *
   * @return void
   *
   * @throws \Exception Unsuccessful HTTP call.
   */
  public function testThatGrantsGetByAudience() {
    $api = new MockManagementApi([
      new Response(200),
    ]);
    $api
      ->call()
      ->grants()
      ->getByAudience('__test_audience__');
    $this
      ->assertStringStartsWith('https://api.test.local/api/v2/grants', $api
      ->getHistoryUrl());
    $this
      ->assertEquals('audience=__test_audience__', $api
      ->getHistoryQuery());
  }

  /**
   * Test that getByAudience adds pagination parameters to the request.
   *
   * @return void
   *
   * @throws \Exception Unsuccessful HTTP call.
   */
  public function testThatGrantsGetByAudiencePaginates() {
    $api = new MockManagementApi([
      new Response(200),
    ]);
    $api
      ->call()
      ->grants()
      ->getByAudience('__test_audience__', 1, 2);
    $this
      ->assertContains('page=1', $api
      ->getHistoryQuery());
    $this
      ->assertContains('per_page=2', $api
      ->getHistoryQuery());
  }

  /**
   * Test that getByAudience throws an exception with an empty parameter.
   *
   * @return void
   *
   * @throws \Exception Unsuccessful HTTP call.
   */
  public function testThatGrantsGetByAudienceThrowsException() {
    $api = new Management('__test_api_token__', '__test_domain__');
    try {
      $caught_exception = false;
      $api
        ->grants()
        ->getByAudience('');
    } catch (CoreException $e) {
      $caught_exception = $this
        ->errorHasString($e, 'Empty or invalid "audience" parameter');
    }
    $this
      ->assertTrue($caught_exception);
    try {
      $caught_exception = false;
      $api
        ->grants()
        ->getByAudience([
        '__not_empty__',
      ]);
    } catch (CoreException $e) {
      $caught_exception = $this
        ->errorHasString($e, 'Empty or invalid "audience" parameter');
    }
    $this
      ->assertTrue($caught_exception);
  }

  /**
   * Test that getByUserId adds an audience to the request.
   *
   * @return void
   *
   * @throws \Exception Unsuccessful HTTP call.
   */
  public function testThatGrantsGetByUserId() {
    $api = new MockManagementApi([
      new Response(200),
    ]);
    $api
      ->call()
      ->grants()
      ->getByUserId('__test_user_id__');
    $this
      ->assertStringStartsWith('https://api.test.local/api/v2/grants', $api
      ->getHistoryUrl());
    $this
      ->assertEquals('user_id=__test_user_id__', $api
      ->getHistoryQuery());
  }

  /**
   * Test that getByUserId adds pagination parameters to the request.
   *
   * @return void
   *
   * @throws \Exception Unsuccessful HTTP call.
   */
  public function testThatGrantsGetByUserIdPaginates() {
    $api = new MockManagementApi([
      new Response(200),
    ]);
    $api
      ->call()
      ->grants()
      ->getByUserId('__test_user_id__', 1, 2);
    $this
      ->assertContains('page=1', $api
      ->getHistoryQuery());
    $this
      ->assertContains('per_page=2', $api
      ->getHistoryQuery());
  }

  /**
   * Test that getByUserId throws an exception with an empty parameter.
   *
   * @return void
   *
   * @throws \Exception Unsuccessful HTTP call.
   */
  public function testThatGrantsGetByUserIdThrowsException() {
    $api = new Management('__test_api_token__', '__test_domain__');
    try {
      $caught_exception = false;
      $api
        ->grants()
        ->getByUserId('');
    } catch (CoreException $e) {
      $caught_exception = $this
        ->errorHasString($e, 'Empty or invalid "user_id" parameter');
    }
    $this
      ->assertTrue($caught_exception);
    try {
      $caught_exception = false;
      $api
        ->grants()
        ->getByUserId([
        '__not_empty__',
      ]);
    } catch (CoreException $e) {
      $caught_exception = $this
        ->errorHasString($e, 'Empty or invalid "user_id" parameter');
    }
    $this
      ->assertTrue($caught_exception);
  }

  /**
   * Test that delete requests properly.
   *
   * @return void
   *
   * @throws \Exception Unsuccessful HTTP call.
   */
  public function testGrantsDelete() {
    $api = new MockManagementApi([
      new Response(204),
    ]);
    $id = uniqid();
    $api
      ->call()
      ->grants()
      ->delete($id);
    $this
      ->assertEquals('DELETE', $api
      ->getHistoryMethod());
    $this
      ->assertEquals('https://api.test.local/api/v2/grants/' . $id, $api
      ->getHistoryUrl());
    $this
      ->assertEmpty($api
      ->getHistoryQuery());
    $headers = $api
      ->getHistoryHeaders();
    $this
      ->assertEquals('Bearer __api_token__', $headers['Authorization'][0]);
    $this
      ->assertEquals(self::$telemetry, $headers['Auth0-Client'][0]);
  }

  /**
   * Test that a delete request throws an exception with an empty parameter.
   *
   * @return void
   *
   * @throws \Exception Unsuccessful HTTP call.
   */
  public function testGrantsDeleteThrowsException() {
    $api = new Management('__test_api_token__', '__test_domain__');
    try {
      $caught_exception = false;
      $api
        ->grants()
        ->delete('');
    } catch (CoreException $e) {
      $caught_exception = $this
        ->errorHasString($e, 'Empty or invalid "id" parameter');
    }
    $this
      ->assertTrue($caught_exception);
    try {
      $caught_exception = false;
      $api
        ->grants()
        ->delete([
        '__not_empty__',
      ]);
    } catch (CoreException $e) {
      $caught_exception = $this
        ->errorHasString($e, 'Empty or invalid "id" parameter');
    }
    $this
      ->assertTrue($caught_exception);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ErrorHelpers::errorHasString protected function Does an error message contain a specific string?
GrantsTestMocked::$telemetry protected static property Expected telemetry value.
GrantsTestMocked::setUpBeforeClass public static function Runs before test suite starts.
GrantsTestMocked::testGrantsDelete public function Test that delete requests properly.
GrantsTestMocked::testGrantsDeleteThrowsException public function Test that a delete request throws an exception with an empty parameter.
GrantsTestMocked::testGrantsGetAll public function Test that getAll requests properly.
GrantsTestMocked::testThatGrantsGetAllAddsExtraParams public function Test that getAll sends additional parameters with the request.
GrantsTestMocked::testThatGrantsGetAllPaginates public function Test that getAll sends pagination parameters with the request.
GrantsTestMocked::testThatGrantsGetByAudience public function Test that getByAudience adds an audience to the request.
GrantsTestMocked::testThatGrantsGetByAudiencePaginates public function Test that getByAudience adds pagination parameters to the request.
GrantsTestMocked::testThatGrantsGetByAudienceThrowsException public function Test that getByAudience throws an exception with an empty parameter.
GrantsTestMocked::testThatGrantsGetByClientId public function Test that getByClientId adds a client_id to the request.
GrantsTestMocked::testThatGrantsGetByClientIdPaginates public function Test that getByClientId adds pagination parameters to the request.
GrantsTestMocked::testThatGrantsGetByClientIdThrowsException public function Test that getByClientId throws an exception with an empty parameter.
GrantsTestMocked::testThatGrantsGetByUserId public function Test that getByUserId adds an audience to the request.
GrantsTestMocked::testThatGrantsGetByUserIdPaginates public function Test that getByUserId adds pagination parameters to the request.
GrantsTestMocked::testThatGrantsGetByUserIdThrowsException public function Test that getByUserId throws an exception with an empty parameter.
GrantsTestMocked::testThatMethodAndPropertyReturnSameClass public function