TranslationCompletenessTest.php

<?php

/**
 * PHPMailer - language file tests.
 *
 * PHP version 5.5.
 *
 * @author    Marcus Bointon <phpmailer@synchromedia.co.uk>
 * @author    Andy Prevost
 * @copyright 2010 - 2020 Marcus Bointon
 * @copyright 2004 - 2009 Andy Prevost
 * @license   https://www.gnu.org/licenses/old-licenses/lgpl-2.1.html GNU Lesser General Public License
 */

namespace PHPMailer\Test\Language;

use PHPMailer\PHPMailer\PHPMailer;
use Yoast\PHPUnitPolyfills\TestCases\TestCase;

/**
 * Check language files for missing or excess translations.
 *
 * @group languages
 *
 * @coversNothing
 */
final class TranslationCompletenessTest extends TestCase
{
    /**
     * Holds a PHPMailer instance.
     *
     * @var PHPMailer
     */
    private $Mail;

    /**
     * Run before each test is started.
     */
    protected function set_up()
    {
        $this->Mail = new PHPMailer();
    }

    /**
     * Test language files for missing and excess translations.
     * All languages are compared with English, which is built-in.
     */
    public function testTranslations()
    {
        $this->Mail->setLanguage('en');
        $definedStrings = $this->Mail->getTranslations();
        $err = '';
        foreach (new \DirectoryIterator(__DIR__ . '/../../language') as $fileInfo) {
            if ($fileInfo->isDot()) {
                continue;
            }

            $matches = [];
            // Only look at language files, ignore anything else in there.
            if (preg_match('/^phpmailer\.lang-([a-z_]{2,})\.php$/', $fileInfo->getFilename(), $matches)) {
                $lang = $matches[1]; // Extract language code.
                $PHPMAILER_LANG = []; // Language strings get put in here.
                $lines = file($fileInfo->getPathname());
                foreach ($lines as $line) {
                    // Translation file lines look like this:
                    // `$PHPMAILER_LANG['authenticate'] = 'SMTP-Fehler: Authentifizierung fehlgeschlagen.';`
                    // These files are parsed as text and not PHP so as to avoid the possibility of code injection.
                    $matches = [];
                    if (
                        preg_match(
                            '/^\$PHPMAILER_LANG\[\'([a-z\d_]+)\'\]\s*=\s*(["\'])(.+)*?\2;/',
                            $line,
                            $matches
                        )
                    ) {
                        // Overwrite language-specific strings so we'll never have missing translation keys.
                        $PHPMAILER_LANG[$matches[1]] = (string)$matches[3];
                    }
                }
            }

            include $fileInfo->getPathname(); // Get language strings.

            $missing = array_diff(array_keys($definedStrings), array_keys($PHPMAILER_LANG));
            $extra = array_diff(array_keys($PHPMAILER_LANG), array_keys($definedStrings));
            if (!empty($missing)) {
                $err .= "\nMissing translations in $lang: " . implode(', ', $missing);
            }
            if (!empty($extra)) {
                $err .= "\nExtra translations in $lang: " . implode(', ', $extra);
            }
        }

        // If we have no extra and no missing translations, $err will be empty.
        self::assertEmpty($err, $err);
    }
}