class EmailTemplatesTest in Auth0 Single Sign On 8.2

Class EmailTemplatesTest

@package Auth0\Tests\API\Management

Hierarchy

• class \Auth0\Tests\API\ApiTests extends \Auth0\Tests\API\PHPUnit_Framework_TestCase uses ErrorHelpers
  • class \Auth0\Tests\API\Management\EmailTemplatesTest

File

vendor/auth0/auth0-php/tests/API/Management/EmailTemplatesTest.php, line 15

Namespace

Auth0\Tests\API\Management

class EmailTemplatesTest extends ApiTests {

  /**
   * Email template to test
   *
   * @var string
   */
  const EMAIL_TEMPLATE_NAME = EmailTemplates::TEMPLATE_ENROLLMENT_EMAIL;

  /**
   * Management API token with scopes:
   *  - read:email_templates
   *  - create:email_templates
   *  - update:email_templates
   *  - read:email_provider
   *
   * @var string
   */
  protected static $token;

  /**
   * Valid tenant domain set in project .env file as `DOMAIN`
   *
   * @var string
   */
  protected static $domain;

  /**
   * Auth0 v2 Management API accessor
   *
   * @var Management
   */
  protected static $api;

  /**
   * Email template retrieved during class setup, tested later
   *
   * @var array
   */
  protected static $gotEmail = [];

  /**
   * If the email template was not found, this is the error code
   *
   * @var boolean
   */
  protected static $setUpEmailError;

  /**
   * Can this email template be created?
   *
   * @var boolean
   */
  protected static $mustCreate = false;

  /**
   * Test fixture for class
   *
   * @throws \Exception
   */
  public static function setUpBeforeClass() {
    $env = self::getEnv();
    self::$domain = $env['DOMAIN'];
    self::$token = self::getToken($env, [
      'email_templates' => [
        'actions' => [
          'create',
          'read',
          'update',
        ],
      ],
      'email_provider' => [
        'actions' => [
          'read',
        ],
      ],
    ]);
    self::$api = new Management(self::$token, self::$domain);
    try {

      // Try to get the email template specified.
      self::$gotEmail = self::$api->emailTemplates
        ->get(self::EMAIL_TEMPLATE_NAME);
    } catch (ClientException $e) {
      self::$setUpEmailError = $e
        ->getCode();
      if (404 === self::$setUpEmailError) {

        // Could not find the email template so it can/must be created
        self::$mustCreate = true;
      }
    }
  }

  /**
   * Test fixture for each method
   */
  protected function assertPreConditions() {

    // Need to have an email provider setup for the tenant to perform this test.
    try {
      self::$api->emails
        ->getEmailProvider();
    } catch (\Exception $e) {
      $this
        ->markTestSkipped('Need to specify an email provider in the dashboard > Emails > Provider');
    }

    // If we don't have an email template and can't create, something sent wrong in self::setUpBeforeClass().
    if (!self::$mustCreate && empty(self::$gotEmail)) {
      $this
        ->markTestSkipped('Email template ' . self::EMAIL_TEMPLATE_NAME . ' not found with error ' . self::$setUpEmailError);
    }
  }

  /**
   * Test if we got an email template, test create if we didn't
   *
   * @throws \Exception
   */
  public function testGotAnEmail() {
    if (self::$mustCreate) {
      $from_email = 'test@' . self::$domain;
      self::$gotEmail = self::$api->emailTemplates
        ->create(self::EMAIL_TEMPLATE_NAME, $from_email);
      $this
        ->assertEquals($from_email, self::$gotEmail['from']);
    }
    $this
      ->assertEquals(self::EMAIL_TEMPLATE_NAME, self::$gotEmail['template']);
  }

  /**
   * Test updating the email template
   *
   * @throws \Exception
   */
  public function testPatch() {
    $new_subject = 'Email subject ' . time();
    self::$gotEmail = self::$api->emailTemplates
      ->patch(self::EMAIL_TEMPLATE_NAME, [
      'subject' => $new_subject,
    ]);
    $this
      ->assertEquals($new_subject, self::$gotEmail['subject']);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ApiTests::$env	protected static	property	Environment variables.
ApiTests::getEnv	protected static	function	Get all test suite environment variables.
EmailTemplatesTest::$api	protected static	property	Auth0 v2 Management API accessor
EmailTemplatesTest::$domain	protected static	property	Valid tenant domain set in project .env file as `DOMAIN`
EmailTemplatesTest::$gotEmail	protected static	property	Email template retrieved during class setup, tested later
EmailTemplatesTest::$mustCreate	protected static	property	Can this email template be created?
EmailTemplatesTest::$setUpEmailError	protected static	property	If the email template was not found, this is the error code
EmailTemplatesTest::$token	protected static	property	Management API token with scopes:
EmailTemplatesTest::assertPreConditions	protected	function	Test fixture for each method
EmailTemplatesTest::EMAIL_TEMPLATE_NAME		constant	Email template to test
EmailTemplatesTest::setUpBeforeClass	public static	function	Test fixture for class
EmailTemplatesTest::testGotAnEmail	public	function	Test if we got an email template, test create if we didn't
EmailTemplatesTest::testPatch	public	function	Test updating the email template
ErrorHelpers::errorHasString	protected	function	Does an error message contain a specific string?