Classes List

Symfony\Component\Translation\Tests\TranslatorCacheTest

 1 
 2 
 3 
 4 
 5 
 6 
 7 
 8 
 9 
 10 
 11 
 12 
 13 
 14 
 15 
 16 
 17 
 18 
 19 
 20 
 21 
 22 
 23 
 24 
 25 
 26 
 27 
 28 
 29 
 30 
 31 
 32 
 33 
 34 
 35 
 36 
 37 
 38 
 39 
 40 
 41 
 42 
 43 
 44 
 45 
 46 
 47 
 48 
 49 
 50 
 51 
 52 
 53 
 54 
 55 
 56 
 57 
 58 
 59 
 60 
 61 
 62 
 63 
 64 
 65 
 66 
 67 
 68 
 69 
 70 
 71 
 72 
 73 
 74 
 75 
 76 
 77 
 78 
 79 
 80 
 81 
 82 
 83 
 84 
 85 
 86 
 87 
 88 
 89 
 90 
 91 
 92 
 93 
 94 
 95 
 96 
 97 
 98 
 99 
 100 
 101 
 102 
 103 
 104 
 105 
 106 
 107 
 108 
 109 
 110 
 111 
 112 
 113 
 114 
 115 
 116 
 117 
 118 
 119 
 120 
 121 
 122 
 123 
 124 
 125 
 126 
 127 
 128 
 129 
 130 
 131 
 132 
 133 
 134 
 135 
 136 
 137 
 138 
 139 
 140 
 141 
 142 
 143 
 144 
 145 
 146 
 147 
 148 
 149 
 150 
 151 
 152 
 153 
 154 
 155 
 156 
 157 
 158 
 159 
 160 
 161 
 162 
 163 
 164 
 165 
 166 
 167 
 168 
 169 
 170 
 171 
 172 
 173 
 174 
 175 
 176 
 177 
 178 
 179 
 180 
 181 
 182 
 183 
 184 
 185 
 186 
 187 
 188 
 189 
 190 
 191 
 192 
 193 
 194 
 195 
 196 
 197 
 198 
 199 
 200 
 201 
 202 
 203 
 204 
 205 
 206 
 207 
 208 
 209 
 210 
 211 
 212 
 213 
 214 
 215 
 216 
 217 
 218 
 219 
 220 
 221 
 222 
 223 
 224 
 225 
 226 
 227 
 228 
 229 
 230 
 231 
 232 
 233 
 234 
 235 
 236 
 237 
 238 
 239 
 240 
 241 
 242 
 243 
 244 
 245 
 246 
 247 
 248 
 249 
 250 
 251 
 252 
 253 
 254 
 255 
 256 
 257 
 258 
 259 
 260 
 261 
 262 
 263 
 264 
 265 
 266 
 267 
 268 
 269 
 270 
 271 
 272 
 273 
 274 
 275 
 276 
 277 
 278 
 279 
 280 
 281 
 282 
 283 
 284 
 285 
 286 
 287 
 288 
 289 
 290 
 291 
 292 
 293 
 294 
 295 
 296 
 297 
 298 
 299 
 300 
 301 
 302 
 303 
 304 
 305 
 306 
 307 
 308 
 309 
 310 
 311 
 312 
<?php

/* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */


namespace Symfony\Component\Translation\Tests;

use PHPUnit\Framework\TestCase;
use Symfony\Component\Config\Resource\SelfCheckingResourceInterface;
use Symfony\Component\Translation\Loader\ArrayLoader;
use Symfony\Component\Translation\Loader\LoaderInterface;
use Symfony\Component\Translation\Translator;
use Symfony\Component\Translation\MessageCatalogue;

class TranslatorCacheTest extends TestCase
{
    protected $tmpDir;

    protected function setUp()
    {
        $this->tmpDir = sys_get_temp_dir().'/sf2_translation';
        $this->deleteTmpDir();
    }

    protected function tearDown()
    {
        $this->deleteTmpDir();
    }

    protected function deleteTmpDir()
    {
        if (!file_exists($dir = $this->tmpDir)) {
            return;
        }

        $iterator = new \RecursiveIteratorIterator(new \RecursiveDirectoryIterator($this->tmpDir), \RecursiveIteratorIterator::CHILD_FIRST);
        foreach ($iterator as $path) {
            if (preg_match('#[/\\\\]\.\.?$#'$path->__toString())) {
                continue;
            }
            if ($path->isDir()) {
                rmdir($path->__toString());
            } else {
                unlink($path->__toString());
            }
        }
        rmdir($this->tmpDir);
    }

    /** * @dataProvider runForDebugAndProduction */
    public function testThatACacheIsUsed($debug)
    {
        $locale = 'any_locale';
        $format = 'some_format';
        $msgid = 'test';

        // Prime the cache
        $translator = new Translator($localenull$this->tmpDir$debug);
        $translator->addLoader($formatnew ArrayLoader());
        $translator->addResource($formatarray($msgid => 'OK'), $locale);
        $translator->trans($msgid);

        // Try again and see we get a valid result whilst no loader can be used
        $translator = new Translator($localenull$this->tmpDir$debug);
        $translator->addLoader($format$this->createFailingLoader());
        $translator->addResource($formatarray($msgid => 'OK'), $locale);
        $this->assertEquals('OK'$translator->trans($msgid), '-> caching does not work in '.($debug ? 'debug' : 'production'));
    }

    public function testCatalogueIsReloadedWhenResourcesAreNoLongerFresh()
    {
        /* * The testThatACacheIsUsed() test showed that we don't need the loader as long as the cache * is fresh. * * Now we add a Resource that is never fresh and make sure that the * cache is discarded (the loader is called twice). * * We need to run this for debug=true only because in production the cache * will never be revalidated. */


        $locale = 'any_locale';
        $format = 'some_format';
        $msgid = 'test';

        $catalogue = new MessageCatalogue($localearray());
        $catalogue->addResource(new StaleResource()); // better use a helper class than a mock, because it gets serialized in the cache and re-loaded

        /** @var LoaderInterface|\PHPUnit_Framework_MockObject_MockObject $loader */
        $loader = $this->getMockBuilder('Symfony\Component\Translation\Loader\LoaderInterface')->getMock();
        $loader
            ->expects($this->exactly(2))
            ->method('load')
            ->will($this->returnValue($catalogue))
        ;

        // 1st pass
        $translator = new Translator($localenull$this->tmpDirtrue);
        $translator->addLoader($format$loader);
        $translator->addResource($formatnull$locale);
        $translator->trans($msgid);

        // 2nd pass
        $translator = new Translator($localenull$this->tmpDirtrue);
        $translator->addLoader($format$loader);
        $translator->addResource($formatnull$locale);
        $translator->trans($msgid);
    }

    /** * @dataProvider runForDebugAndProduction */
    public function testDifferentTranslatorsForSameLocaleDoNotOverwriteEachOthersCache($debug)
    {
        /* * Similar to the previous test. After we used the second translator, make * sure there's still a useable cache for the first one. */


        $locale = 'any_locale';
        $format = 'some_format';
        $msgid = 'test';

        // Create a Translator and prime its cache
        $translator = new Translator($localenull$this->tmpDir$debug);
        $translator->addLoader($formatnew ArrayLoader());
        $translator->addResource($formatarray($msgid => 'OK'), $locale);
        $translator->trans($msgid);

        // Create another Translator with a different catalogue for the same locale
        $translator = new Translator($localenull$this->tmpDir$debug);
        $translator->addLoader($formatnew ArrayLoader());
        $translator->addResource($formatarray($msgid => 'FAIL'), $locale);
        $translator->trans($msgid);

        // Now the first translator must still have a useable cache.
        $translator = new Translator($localenull$this->tmpDir$debug);
        $translator->addLoader($format$this->createFailingLoader());
        $translator->addResource($formatarray($msgid => 'OK'), $locale);
        $this->assertEquals('OK'$translator->trans($msgid), '-> the cache was overwritten by another translator instance in '.($debug ? 'debug' : 'production'));
    }

    public function testGeneratedCacheFilesAreOnlyBelongRequestedLocales()
    {
        $translator = new Translator('a'null$this->tmpDir);
        $translator->setFallbackLocales(array('b'));
        $translator->trans('bar');

        $cachedFiles = glob($this->tmpDir.'/*.php');

        $this->assertCount(1$cachedFiles);
    }

    public function testDifferentCacheFilesAreUsedForDifferentSetsOfFallbackLocales()
    {
        /* * Because the cache file contains a catalogue including all of its fallback * catalogues, we must take the set of fallback locales into consideration when * loading a catalogue from the cache. */

        $translator = new Translator('a'null$this->tmpDir);
        $translator->setFallbackLocales(array('b'));

        $translator->addLoader('array'new ArrayLoader());
        $translator->addResource('array'array('foo' => 'foo (a)'), 'a');
        $translator->addResource('array'array('bar' => 'bar (b)'), 'b');

        $this->assertEquals('bar (b)'$translator->trans('bar'));

        // Remove fallback locale
        $translator->setFallbackLocales(array());
        $this->assertEquals('bar'$translator->trans('bar'));

        // Use a fresh translator with no fallback locales, result should be the same
        $translator = new Translator('a'null$this->tmpDir);

        $translator->addLoader('array'new ArrayLoader());
        $translator->addResource('array'array('foo' => 'foo (a)'), 'a');
        $translator->addResource('array'array('bar' => 'bar (b)'), 'b');

        $this->assertEquals('bar'$translator->trans('bar'));
    }

    public function testPrimaryAndFallbackCataloguesContainTheSameMessagesRegardlessOfCaching()
    {
        /* * As a safeguard against potential BC breaks, make sure that primary and fallback * catalogues (reachable via getFallbackCatalogue()) always contain the full set of * messages provided by the loader. This must also be the case when these catalogues * are (internally) read from a cache. * * Optimizations inside the translator must not change this behaviour. */


        /* * Create a translator that loads two catalogues for two different locales. * The catalogues contain distinct sets of messages. */

        $translator = new Translator('a'null$this->tmpDir);
        $translator->setFallbackLocales(array('b'));

        $translator->addLoader('array'new ArrayLoader());
        $translator->addResource('array'array('foo' => 'foo (a)'), 'a');
        $translator->addResource('array'array('foo' => 'foo (b)'), 'b');
        $translator->addResource('array'array('bar' => 'bar (b)'), 'b');

        $catalogue = $translator->getCatalogue('a');
        $this->assertFalse($catalogue->defines('bar')); // Sure, the "a" catalogue does not contain that message.

        $fallback = $catalogue->getFallbackCatalogue();
        $this->assertTrue($fallback->defines('foo')); // "foo" is present in "a" and "b"

        /* * Now, repeat the same test. * Behind the scenes, the cache is used. But that should not matter, right? */

        $translator = new Translator('a'null$this->tmpDir);
        $translator->setFallbackLocales(array('b'));

        $translator->addLoader('array'new ArrayLoader());
        $translator->addResource('array'array('foo' => 'foo (a)'), 'a');
        $translator->addResource('array'array('foo' => 'foo (b)'), 'b');
        $translator->addResource('array'array('bar' => 'bar (b)'), 'b');

        $catalogue = $translator->getCatalogue('a');
        $this->assertFalse($catalogue->defines('bar'));

        $fallback = $catalogue->getFallbackCatalogue();
        $this->assertTrue($fallback->defines('foo'));
    }

    public function testRefreshCacheWhenResourcesAreNoLongerFresh()
    {
        $resource = $this->getMockBuilder('Symfony\Component\Config\Resource\SelfCheckingResourceInterface')->getMock();
        $loader = $this->getMockBuilder('Symfony\Component\Translation\Loader\LoaderInterface')->getMock();
        $resource->method('isFresh')->will($this->returnValue(false));
        $loader
            ->expects($this->exactly(2))
            ->method('load')
            ->will($this->returnValue($this->getCatalogue('fr'array(), array($resource))));

        // prime the cache
        $translator = new Translator('fr'null$this->tmpDirtrue);
        $translator->addLoader('loader'$loader);
        $translator->addResource('loader''foo''fr');
        $translator->trans('foo');

        // prime the cache second time
        $translator = new Translator('fr'null$this->tmpDirtrue);
        $translator->addLoader('loader'$loader);
        $translator->addResource('loader''foo''fr');
        $translator->trans('foo');
    }

    protected function getCatalogue($locale$messages$resources = array())
    {
        $catalogue = new MessageCatalogue($locale);
        foreach ($messages as $key => $translation) {
            $catalogue->set($key$translation);
        }
        foreach ($resources as $resource) {
            $catalogue->addResource($resource);
        }

        return $catalogue;
    }

    public function runForDebugAndProduction()
    {
        return array(array(true), array(false));
    }

    /** * @return LoaderInterface */
    private function createFailingLoader()
    {
        $loader = $this->getMockBuilder('Symfony\Component\Translation\Loader\LoaderInterface')->getMock();
        $loader
            ->expects($this->never())
            ->method('load');

        return $loader;
    }
}

class StaleResource implements SelfCheckingResourceInterface
{
    public function isFresh($timestamp)
    {
        return false;
    }

    public function getResource()
    {
    }

    public function __toString()
    {
        return '';
    }
}