trait MigratePhoneNumberTestTrait in SMS Framework 8

trait MigratePhoneNumberTestTrait {

  /**
   * Tests migration of phone number settings based on legacy configuration.
   */
  public function testPhoneSettingsMigration() {
    $settings = PhoneNumberSettings::loadMultiple();
    $this
      ->assertEquals([], $settings);

    // Execute the phone number settings migration and confirm.
    $this
      ->executeMigration('phone_number_settings');

    // Confirm new phone number settings is created.
    $settings = PhoneNumberSettings::loadMultiple();
    $this
      ->assertEquals(1, count($settings));

    /** @var \Drupal\sms\Entity\PhoneNumberSettingsInterface $setting */
    $setting = reset($settings);
    $this
      ->assertEquals(PhoneNumberSettingsPlugin::DEFAULT_VERIFICATION_MESSAGE, $setting
      ->getVerificationMessage());
    $this
      ->assertEquals('phone_number', $setting
      ->getFieldName('phone_number'));
    $this
      ->assertEquals(TRUE, $setting
      ->getPurgeVerificationPhoneNumber());
    $this
      ->assertEquals('user', $setting
      ->getPhoneNumberBundle());
    $this
      ->assertEquals('user', $setting
      ->getPhoneNumberEntityTypeId());
    $this
      ->assertEquals(600, $setting
      ->getVerificationCodeLifetime());

    // Confirm that a new phone number field is created.
    $field_storage = FieldStorageConfig::load('user.phone_number');
    $this
      ->assertEquals('user.phone_number', $field_storage
      ->id());
    $this
      ->assertEquals('phone_number', $field_storage
      ->getName());
    $this
      ->assertEquals('user', $field_storage
      ->getTargetEntityTypeId());
    $this
      ->assertEquals('telephone', $field_storage
      ->getType());
    $field_config = FieldConfig::load('user.user.phone_number');
    $this
      ->assertEquals('user', $field_config
      ->getTargetEntityTypeId());
    $this
      ->assertEquals('user', $field_config
      ->getTargetBundle());
  }

  /**
   * Tests phone number migration with custom phone number verification message.
   */
  public function testPhoneSettingsMigrationWithCustomVerificationMessage() {
    $this
      ->loadFixture($this
      ->confirmationMessageFixturePath());

    // Execute the phone number settings migration and confirm.
    $this
      ->executeMigration('phone_number_settings');
    $settings = PhoneNumberSettings::loadMultiple();
    $this
      ->assertEquals(1, count($settings));

    /** @var \Drupal\sms\Entity\PhoneNumberSettingsInterface $setting */
    $setting = reset($settings);
    $expected_message = 'This is a custom confirmation message from [site:name]. Confirmation code: [sms-message:verification-code]';
    $this
      ->assertEquals($expected_message, $setting
      ->getVerificationMessage());
  }

  /**
   * Tests that the users' phone numbers verification status is migrated.
   */
  public function testPhoneNumberMigration() {
    $this
      ->loadFixture($this
      ->smsUserFixtureFilePath());

    // Set up phone number verifications.
    $this
      ->installEntitySchema('sms');
    $this
      ->installEntitySchema('sms_phone_number_verification');
    $this
      ->executeMigrations($this
      ->getMigrationsToTest());
    $user = User::load(40);
    $this
      ->assertEquals('1234567890', $user
      ->get('phone_number')->value);
    $this
      ->assertVerifiedPhoneNumber($user, '1234567890');
    $user = User::load(41);
    $this
      ->assertEquals('87654321190', $user
      ->get('phone_number')->value);
    $this
      ->assertUnVerifiedPhoneNumber($user, '87654321190');
    $this
      ->assertVerificationCode('87654321190', '8002');

    // No phone number for user 15.
    $user = User::load(42);
    $this
      ->assertEquals('', $user
      ->get('phone_number')->value);
    $this
      ->assertNoVerifiedPhoneNumber($user);
  }

  /**
   * Tests that conditions are reverted after rollback.
   */
  public function testRollBack() {
    $this
      ->loadFixture($this
      ->smsUserFixtureFilePath());
    $this
      ->installEntitySchema('sms');
    $this
      ->installEntitySchema('sms_phone_number_verification');

    // Create an entity form display.
    EntityFormDisplay::create([
      'targetEntityType' => 'user',
      'bundle' => 'user',
      'mode' => 'default',
    ])
      ->setStatus(TRUE)
      ->save();
    $this
      ->executeMigrations($this
      ->getMigrationsToTest());
    $this
      ->assertVerifiedPhoneNumber(User::load(40), '1234567890');

    // Test that the default entity form display has the field added.
    $entity_form_display = EntityFormDisplay::load('user.user.default');
    $this
      ->assertNotNull($entity_form_display
      ->getComponent('phone_number'));

    // Rollback migration and check that verifications, phone number settings
    // and phone number fields are removed.
    $this
      ->rollBackMigrations($this
      ->getMigrationsToRollBack());

    // Assert no phone number verifications, phone number settings or phone
    // number fields exist.
    $this
      ->assertEquals([], PhoneNumberVerification::loadMultiple());
    $this
      ->assertEquals([], PhoneNumberSettings::loadMultiple());
    $this
      ->assertNull(FieldConfig::loadByName('user', 'user', 'phone_number'));
    $this
      ->assertNull(FieldStorageConfig::loadByName('user', 'phone_number'));

    // Test that the display field is removed.
    $entity_form_display = EntityFormDisplay::load('user.user.default');
    $this
      ->assertNull($entity_form_display
      ->getComponent('phone_number'));
  }

  /**
   * Asserts that the specified user has a verified phone number.
   */
  protected function assertVerifiedPhoneNumber(UserInterface $user, $number) {
    $phone_numbers = $this->container
      ->get('sms.phone_number')
      ->getPhoneNumbers($user, TRUE);
    $phone_number = reset($phone_numbers);
    return $this
      ->assertEquals($number, $phone_number, "Phone number '{$number}' is verified.");
  }

  /**
   * Asserts that the specified user has an unverified phone number.
   */
  protected function assertUnVerifiedPhoneNumber(UserInterface $user, $number) {
    $phone_numbers = $this->container
      ->get('sms.phone_number')
      ->getPhoneNumbers($user, FALSE);
    $phone_number = reset($phone_numbers);
    return $this
      ->assertEquals($number, $phone_number, "Phone number '{$number}' is unverified.");
  }

  /**
   * Asserts that the specified user has no phone number verified or unverified.
   */
  protected function assertNoVerifiedPhoneNumber(UserInterface $user) {
    $phone_numbers = $this->container
      ->get('sms.phone_number')
      ->getPhoneNumbers($user);
    return $this
      ->assertEquals([], $phone_numbers, "No phone numbers for user {$user->id()}.");
  }

  /**
   * Asserts that the specified number has a pending verification code.
   */
  protected function assertVerificationCode($number, $code) {
    $verification = $this->container
      ->get('sms.phone_number.verification')
      ->getPhoneVerificationByPhoneNumber($number, FALSE);
    $verification = reset($verification);
    return $this
      ->assertEquals($code, $verification
      ->getCode());
  }

  /**
   * Rolls back a specified migration.
   */
  protected function rollBackMigrations(array $ids) {
    foreach ($ids as $id) {
      $this->migration = $this
        ->getMigration($id);
      $this
        ->prepareMigration($this->migration);
      (new MigrateExecutable($this->migration, $this))
        ->rollback();
    }
  }

  /**
   * Provides the relative path to the fixture that sets up the database.
   */
  protected abstract function smsUserFixtureFilePath();

  /**
   * Provides the relative path to the fixture that adds confirmation message.
   */
  protected abstract function confirmationMessageFixturePath();

  /**
   * Returns the list of D6 or D7 sms_user phone number migrations to test.
   */
  protected abstract function getMigrationsToTest();

  /**
   * Returns the list of migrations to rollback for the rollback test.
   */
  protected abstract function getMigrationsToRollback();

}