You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
406 lines
15 KiB
406 lines
15 KiB
<?php |
|
namespace yiiunit\framework\console\controllers; |
|
|
|
use Yii; |
|
use yii\helpers\FileHelper; |
|
use yii\helpers\VarDumper; |
|
use yiiunit\TestCase; |
|
use yii\console\controllers\MessageController; |
|
|
|
/** |
|
* Base for [[\yii\console\controllers\MessageController]] unit tests. |
|
* @see MessageController |
|
*/ |
|
abstract class BaseMessageControllerTest extends TestCase |
|
{ |
|
protected $sourcePath = ''; |
|
protected $configFileName = ''; |
|
protected $language = 'en'; |
|
|
|
public function setUp() |
|
{ |
|
$this->mockApplication(); |
|
$this->sourcePath = Yii::getAlias('@yiiunit/runtime/test_source'); |
|
FileHelper::createDirectory($this->sourcePath, 0777); |
|
if (!file_exists($this->sourcePath)) { |
|
$this->markTestIncomplete('Unit tests runtime directory should have writable permissions!'); |
|
} |
|
$this->configFileName = Yii::getAlias('@yiiunit/runtime') . DIRECTORY_SEPARATOR . 'message_controller_test_config.php'; |
|
} |
|
|
|
public function tearDown() |
|
{ |
|
FileHelper::removeDirectory($this->sourcePath); |
|
if (file_exists($this->configFileName)) { |
|
unlink($this->configFileName); |
|
} |
|
} |
|
|
|
/** |
|
* Creates test message controller instance. |
|
* @return MessageControllerMock message command instance. |
|
*/ |
|
protected function createMessageController() |
|
{ |
|
$module = $this->getMock('yii\\base\\Module', ['fake'], ['console']); |
|
$messageController = new MessageControllerMock('message', $module); |
|
$messageController->interactive = false; |
|
|
|
return $messageController; |
|
} |
|
|
|
/** |
|
* Emulates running of the message controller action. |
|
* @param string $actionID id of action to be run. |
|
* @param array $args action arguments. |
|
* @return string command output. |
|
*/ |
|
protected function runMessageControllerAction($actionID, array $args = []) |
|
{ |
|
$controller = $this->createMessageController(); |
|
$controller->run($actionID, $args); |
|
return $controller->flushStdOutBuffer(); |
|
} |
|
|
|
/** |
|
* Creates message command config file named as [[configFileName]]. |
|
* @param array $config message command config. |
|
*/ |
|
protected function saveConfigFile(array $config) |
|
{ |
|
if (file_exists($this->configFileName)) { |
|
unlink($this->configFileName); |
|
} |
|
$fileContent = '<?php return ' . VarDumper::export($config) . ';'; |
|
file_put_contents($this->configFileName, $fileContent); |
|
} |
|
|
|
/** |
|
* Creates source file with given content |
|
* @param string $content file content |
|
* @return string path to source file |
|
*/ |
|
protected function createSourceFile($content) |
|
{ |
|
$fileName = $this->sourcePath . DIRECTORY_SEPARATOR . md5(uniqid()) . '.php'; |
|
file_put_contents($fileName, "<?php\n" . $content); |
|
return $fileName; |
|
} |
|
|
|
/** |
|
* Saves messages |
|
* |
|
* @param array $messages |
|
* @param string $category |
|
*/ |
|
abstract protected function saveMessages($messages, $category); |
|
|
|
/** |
|
* Loads messages |
|
* |
|
* @param string $category |
|
* @return array |
|
*/ |
|
abstract protected function loadMessages($category); |
|
|
|
/** |
|
* @return array default config |
|
*/ |
|
abstract protected function getDefaultConfig(); |
|
|
|
/** |
|
* Returns config |
|
* |
|
* @param array $additionalConfig |
|
* @return array |
|
*/ |
|
protected function getConfig($additionalConfig = []) |
|
{ |
|
return array_merge($this->getDefaultConfig(), $additionalConfig); |
|
} |
|
|
|
// Tests: |
|
|
|
public function testActionConfig() |
|
{ |
|
$configFileName = $this->configFileName; |
|
$out = $this->runMessageControllerAction('config', [$configFileName]); |
|
$this->assertTrue(file_exists($configFileName), "Unable to create config file from template. Command output:\n\n" . $out); |
|
} |
|
|
|
public function testConfigFileNotExist() |
|
{ |
|
$this->setExpectedException('yii\\console\\Exception'); |
|
$this->runMessageControllerAction('extract', ['not_existing_file.php']); |
|
} |
|
|
|
public function testCreateTranslation() |
|
{ |
|
$category = 'test.category1'; |
|
$message = 'test message'; |
|
$sourceFileContent = "Yii::t('{$category}', '{$message}');"; |
|
$this->createSourceFile($sourceFileContent); |
|
|
|
$this->saveConfigFile($this->getConfig()); |
|
$out = $this->runMessageControllerAction('extract', [$this->configFileName]); |
|
|
|
$messages = $this->loadMessages($category); |
|
$this->assertArrayHasKey($message, $messages, "\"$message\" is missing in translation file. Command output:\n\n" . $out); |
|
} |
|
|
|
/** |
|
* @depends testCreateTranslation |
|
*/ |
|
public function testNothingToSave() |
|
{ |
|
$category = 'test_category2'; |
|
$message = 'test message'; |
|
$sourceFileContent = "Yii::t('{$category}', '{$message}')"; |
|
$this->createSourceFile($sourceFileContent); |
|
|
|
$this->saveConfigFile($this->getConfig()); |
|
$out = $this->runMessageControllerAction('extract', [$this->configFileName]); |
|
$out .= $this->runMessageControllerAction('extract', [$this->configFileName]); |
|
|
|
$this->assertTrue(strpos($out, 'Nothing to save') !== false, "Controller should respond with \"Nothing to save\" if there's nothing to update. Command output:\n\n" . $out); |
|
} |
|
|
|
/** |
|
* @depends testCreateTranslation |
|
*/ |
|
public function testMerge() |
|
{ |
|
$category = 'test_category3'; |
|
|
|
$existingMessage = 'test existing message'; |
|
$existingMessageTranslation = 'test existing message translation'; |
|
$this->saveMessages( |
|
[$existingMessage => $existingMessageTranslation], |
|
$category |
|
); |
|
|
|
$newMessage = 'test new message'; |
|
$sourceFileContent = "Yii::t('{$category}', '{$existingMessage}');"; |
|
$sourceFileContent .= "Yii::t('{$category}', '{$newMessage}');"; |
|
$this->createSourceFile($sourceFileContent); |
|
|
|
$this->saveConfigFile($this->getConfig()); |
|
$out = $this->runMessageControllerAction('extract', [$this->configFileName]); |
|
|
|
$messages = $this->loadMessages($category); |
|
$this->assertArrayHasKey($newMessage, $messages, "Unable to add new message: \"$newMessage\". Command output:\n\n" . $out); |
|
$this->assertArrayHasKey($existingMessage, $messages, "Unable to keep existing message: \"$existingMessage\". Command output:\n\n" . $out); |
|
$this->assertEquals('', $messages[$newMessage], "Wrong new message content. Command output:\n\n" . $out); |
|
$this->assertEquals($existingMessageTranslation, $messages[$existingMessage], "Unable to keep existing message content. Command output:\n\n" . $out); |
|
} |
|
|
|
/** |
|
* @depends testMerge |
|
*/ |
|
public function testMarkObsoleteMessages() |
|
{ |
|
$category = 'category'; |
|
|
|
$obsoleteMessage = 'obsolete message'; |
|
$obsoleteTranslation = 'obsolete translation'; |
|
$this->saveMessages([$obsoleteMessage => $obsoleteTranslation], $category); |
|
|
|
$sourceFileContent = "Yii::t('{$category}', 'any new message');"; |
|
$this->createSourceFile($sourceFileContent); |
|
|
|
$this->saveConfigFile($this->getConfig(['removeUnused' => false])); |
|
$out = $this->runMessageControllerAction('extract', [$this->configFileName]); |
|
|
|
$messages = $this->loadMessages($category); |
|
|
|
$this->assertArrayHasKey($obsoleteMessage, $messages, "Obsolete message should not be removed. Command output:\n\n" . $out); |
|
$this->assertEquals('@@' . $obsoleteTranslation . '@@', $messages[$obsoleteMessage], "Obsolete message was not marked properly. Command output:\n\n" . $out); |
|
} |
|
|
|
/** |
|
* @depends testMerge |
|
*/ |
|
public function removeObsoleteMessages() |
|
{ |
|
$category = 'category'; |
|
|
|
$obsoleteMessage = 'obsolete message'; |
|
$obsoleteTranslation = 'obsolete translation'; |
|
$this->saveMessages([$obsoleteMessage => $obsoleteTranslation], $category); |
|
|
|
$sourceFileContent = "Yii::t('{$category}', 'any new message');"; |
|
$this->createSourceFile($sourceFileContent); |
|
|
|
$this->saveConfigFile($this->getConfig(['removeUnused' => true])); |
|
$out = $this->runMessageControllerAction('extract', [$this->configFileName]); |
|
|
|
$messages = $this->loadMessages($category); |
|
|
|
$this->assertArrayHasKey($obsoleteMessage, $messages, "Obsolete message should be removed. Command output:\n\n" . $out); |
|
} |
|
|
|
/** |
|
* @depends testMerge |
|
*/ |
|
public function testMergeWithContentZero() |
|
{ |
|
$category = 'test_category5'; |
|
|
|
$zeroMessage = 'test zero message'; |
|
$zeroMessageContent = '0'; |
|
$falseMessage = 'test false message'; |
|
$falseMessageContent = 'false'; |
|
$this->saveMessages([ |
|
$zeroMessage => $zeroMessageContent, |
|
$falseMessage => $falseMessageContent, |
|
], $category); |
|
|
|
$newMessage = 'test new message'; |
|
$sourceFileContent = "Yii::t('{$category}', '{$zeroMessage}')"; |
|
$sourceFileContent .= "Yii::t('{$category}', '{$falseMessage}')"; |
|
$sourceFileContent .= "Yii::t('{$category}', '{$newMessage}')"; |
|
$this->createSourceFile($sourceFileContent); |
|
|
|
$this->saveConfigFile($this->getConfig()); |
|
$out = $this->runMessageControllerAction('extract', [$this->configFileName]); |
|
|
|
$messages = $this->loadMessages($category); |
|
$this->assertTrue($zeroMessageContent === $messages[$zeroMessage], "Message content \"0\" is lost. Command output:\n\n" . $out); |
|
$this->assertTrue($falseMessageContent === $messages[$falseMessage], "Message content \"false\" is lost. Command output:\n\n" . $out); |
|
} |
|
|
|
/** |
|
* @depends testCreateTranslation |
|
*/ |
|
public function testMultipleTranslators() |
|
{ |
|
$category = 'test_category6'; |
|
|
|
$translators = [ |
|
'Yii::t', |
|
'Custom::translate', |
|
]; |
|
|
|
$sourceMessages = [ |
|
'first message', |
|
'second message', |
|
]; |
|
$sourceFileContent = ''; |
|
foreach ($sourceMessages as $key => $message) { |
|
$sourceFileContent .= $translators[$key] . "('{$category}', '{$message}');\n"; |
|
} |
|
$this->createSourceFile($sourceFileContent); |
|
|
|
$this->saveConfigFile($this->getConfig(['translator' => $translators])); |
|
$this->runMessageControllerAction('extract', [$this->configFileName]); |
|
|
|
$messages = $this->loadMessages($category); |
|
|
|
foreach ($sourceMessages as $sourceMessage) { |
|
$this->assertArrayHasKey($sourceMessage, $messages); |
|
} |
|
} |
|
|
|
/** |
|
* @depends testCreateTranslation |
|
*/ |
|
public function testMultipleCategories() |
|
{ |
|
$category1 = 'category1'; |
|
$category2 = 'category2'; |
|
|
|
$message1 = 'message1'; |
|
$message2 = 'message2'; |
|
$message3 = 'message3'; |
|
|
|
$this->saveConfigFile($this->getConfig(['removeUnused' => true])); |
|
|
|
// Generate initial translation |
|
$sourceFileContent = "Yii::t('{$category1}', '{$message1}'); Yii::t('{$category2}', '{$message2}');"; |
|
$source = $this->createSourceFile($sourceFileContent); |
|
$out = $this->runMessageControllerAction('extract', [$this->configFileName]); |
|
unlink($source); |
|
|
|
$messages1 = $this->loadMessages($category1); |
|
$messages2 = $this->loadMessages($category2); |
|
|
|
$this->assertArrayHasKey($message1, $messages1, "message1 not found in category1. Command output:\n\n" . $out); |
|
$this->assertArrayHasKey($message2, $messages2, "message2 not found in category2. Command output:\n\n" . $out); |
|
$this->assertArrayNotHasKey($message3, $messages2, "message3 found in category2. Command output:\n\n" . $out); |
|
|
|
// Change source code, run translation again |
|
$sourceFileContent = "Yii::t('{$category1}', '{$message1}'); Yii::t('{$category2}', '{$message3}');"; |
|
$source = $this->createSourceFile($sourceFileContent); |
|
$out .= "\n" . $this->runMessageControllerAction('extract', [$this->configFileName]); |
|
unlink($source); |
|
|
|
$messages1 = $this->loadMessages($category1); |
|
$messages2 = $this->loadMessages($category2); |
|
$this->assertArrayHasKey($message1, $messages1, "message1 not found in category1. Command output:\n\n" . $out); |
|
$this->assertArrayHasKey($message3, $messages2, "message3 not found in category2. Command output:\n\n" . $out); |
|
$this->assertArrayNotHasKey($message2, $messages2, "message2 found in category2. Command output:\n\n" . $out); |
|
} |
|
|
|
public function testIgnoreCategories() |
|
{ |
|
$category1 = 'category1'; |
|
$category2 = 'category2'; |
|
|
|
$message1 = 'message1'; |
|
$message2 = 'message2'; |
|
$message3 = 'message3'; |
|
|
|
$this->saveConfigFile($this->getConfig(['ignoreCategories' => ['category2']])); |
|
|
|
// Generate initial translation |
|
$sourceFileContent = "Yii::t('{$category1}', '{$message1}'); Yii::t('{$category2}', '{$message2}');"; |
|
$source = $this->createSourceFile($sourceFileContent); |
|
$out = $this->runMessageControllerAction('extract', [$this->configFileName]); |
|
unlink($source); |
|
|
|
$messages1 = $this->loadMessages($category1); |
|
$messages2 = $this->loadMessages($category2, false); |
|
|
|
$this->assertArrayHasKey($message1, $messages1, "message1 not found in category1. Command output:\n\n" . $out); |
|
$this->assertArrayNotHasKey($message2, $messages2, "message2 found in category2. Command output:\n\n" . $out); |
|
$this->assertArrayNotHasKey($message3, $messages2, "message3 found in category2. Command output:\n\n" . $out); |
|
|
|
// Change source code, run translation again |
|
$sourceFileContent = "Yii::t('{$category1}', '{$message1}'); Yii::t('{$category2}', '{$message3}');"; |
|
$source = $this->createSourceFile($sourceFileContent); |
|
$out .= "\n" . $this->runMessageControllerAction('extract', [$this->configFileName]); |
|
unlink($source); |
|
|
|
$messages1 = $this->loadMessages($category1); |
|
$messages2 = $this->loadMessages($category2, false); |
|
$this->assertArrayHasKey($message1, $messages1, "message1 not found in category1. Command output:\n\n" . $out); |
|
$this->assertArrayNotHasKey($message3, $messages2, "message3 not found in category2. Command output:\n\n" . $out); |
|
$this->assertArrayNotHasKey($message2, $messages2, "message2 found in category2. Command output:\n\n" . $out); |
|
} |
|
|
|
/** |
|
* @depends testCreateTranslation |
|
* |
|
* @see https://github.com/yiisoft/yii2/issues/8286 |
|
*/ |
|
public function testCreateTranslationFromNested() |
|
{ |
|
$category = 'test.category1'; |
|
$mainMessage = 'main message'; |
|
$nestedMessage = 'nested message'; |
|
$sourceFileContent = "Yii::t('{$category}', '{$mainMessage}', ['param' => Yii::t('{$category}', '{$nestedMessage}')]);"; |
|
$this->createSourceFile($sourceFileContent); |
|
|
|
$this->saveConfigFile($this->getConfig()); |
|
$out = $this->runMessageControllerAction('extract', [$this->configFileName]); |
|
|
|
$messages = $this->loadMessages($category); |
|
$this->assertArrayHasKey($mainMessage, $messages, "\"$mainMessage\" is missing in translation file. Command output:\n\n" . $out); |
|
$this->assertArrayHasKey($nestedMessage, $messages, "\"$nestedMessage\" is missing in translation file. Command output:\n\n" . $out); |
|
} |
|
} |
|
|
|
class MessageControllerMock extends MessageController |
|
{ |
|
use StdOutBufferControllerTrait; |
|
}
|