* * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Symfony\Component\Finder\Tests; use Symfony\Component\Finder\Finder; class FinderTest extends Iterator\RealIteratorTestCase { public function testCreate() { $this->assertInstanceOf('Symfony\Component\Finder\Finder', Finder::create()); } public function testDirectories() { $finder = $this->buildFinder(); $this->assertSame($finder, $finder->directories()); $this->assertIterator($this->toAbsolute(['foo', 'qux', 'toto']), $finder->in(self::$tmpDir)->getIterator()); $finder = $this->buildFinder(); $finder->directories(); $finder->files(); $finder->directories(); $this->assertIterator($this->toAbsolute(['foo', 'qux', 'toto']), $finder->in(self::$tmpDir)->getIterator()); } public function testFiles() { $finder = $this->buildFinder(); $this->assertSame($finder, $finder->files()); $this->assertIterator($this->toAbsolute(['foo/bar.tmp', 'test.php', 'test.py', 'foo bar', 'qux/baz_100_1.py', 'qux/baz_1_2.py', 'qux_0_1.php', 'qux_1000_1.php', 'qux_1002_0.php', 'qux_10_2.php', 'qux_12_0.php', 'qux_2_0.php', ]), $finder->in(self::$tmpDir)->getIterator()); $finder = $this->buildFinder(); $finder->files(); $finder->directories(); $finder->files(); $this->assertIterator($this->toAbsolute(['foo/bar.tmp', 'test.php', 'test.py', 'foo bar', 'qux/baz_100_1.py', 'qux/baz_1_2.py', 'qux_0_1.php', 'qux_1000_1.php', 'qux_1002_0.php', 'qux_10_2.php', 'qux_12_0.php', 'qux_2_0.php', ]), $finder->in(self::$tmpDir)->getIterator()); } public function testRemoveTrailingSlash() { $finder = $this->buildFinder(); $expected = $this->toAbsolute([ 'foo/bar.tmp', 'test.php', 'test.py', 'foo bar', 'qux/baz_100_1.py', 'qux/baz_1_2.py', 'qux_0_1.php', 'qux_1000_1.php', 'qux_1002_0.php', 'qux_10_2.php', 'qux_12_0.php', 'qux_2_0.php', ]); $in = self::$tmpDir.'//'; $this->assertIterator($expected, $finder->in($in)->files()->getIterator()); } public function testSymlinksNotResolved() { if ('\\' === \DIRECTORY_SEPARATOR) { $this->markTestSkipped('symlinks are not supported on Windows'); } $finder = $this->buildFinder(); symlink($this->toAbsolute('foo'), $this->toAbsolute('baz')); $expected = $this->toAbsolute(['baz/bar.tmp']); $in = self::$tmpDir.'/baz/'; try { $this->assertIterator($expected, $finder->in($in)->files()->getIterator()); unlink($this->toAbsolute('baz')); } catch (\Exception $e) { unlink($this->toAbsolute('baz')); throw $e; } } public function testBackPathNotNormalized() { $finder = $this->buildFinder(); $expected = $this->toAbsolute(['foo/../foo/bar.tmp']); $in = self::$tmpDir.'/foo/../foo/'; $this->assertIterator($expected, $finder->in($in)->files()->getIterator()); } public function testDepth() { $finder = $this->buildFinder(); $this->assertSame($finder, $finder->depth('< 1')); $this->assertIterator($this->toAbsolute(['foo', 'test.php', 'test.py', 'toto', 'foo bar', 'qux', 'qux_0_1.php', 'qux_1000_1.php', 'qux_1002_0.php', 'qux_10_2.php', 'qux_12_0.php', 'qux_2_0.php', ]), $finder->in(self::$tmpDir)->getIterator()); $finder = $this->buildFinder(); $this->assertSame($finder, $finder->depth('<= 0')); $this->assertIterator($this->toAbsolute(['foo', 'test.php', 'test.py', 'toto', 'foo bar', 'qux', 'qux_0_1.php', 'qux_1000_1.php', 'qux_1002_0.php', 'qux_10_2.php', 'qux_12_0.php', 'qux_2_0.php', ]), $finder->in(self::$tmpDir)->getIterator()); $finder = $this->buildFinder(); $this->assertSame($finder, $finder->depth('>= 1')); $this->assertIterator($this->toAbsolute([ 'foo/bar.tmp', 'qux/baz_100_1.py', 'qux/baz_1_2.py', ]), $finder->in(self::$tmpDir)->getIterator()); $finder = $this->buildFinder(); $finder->depth('< 1')->depth('>= 1'); $this->assertIterator([], $finder->in(self::$tmpDir)->getIterator()); } public function testDepthWithArrayParam() { $finder = $this->buildFinder(); $finder->depth(['>= 1', '< 2']); $this->assertIterator($this->toAbsolute([ 'foo/bar.tmp', 'qux/baz_100_1.py', 'qux/baz_1_2.py', ]), $finder->in(self::$tmpDir)->getIterator()); } public function testName() { $finder = $this->buildFinder(); $this->assertSame($finder, $finder->name('*.php')); $this->assertIterator($this->toAbsolute([ 'test.php', 'qux_0_1.php', 'qux_1000_1.php', 'qux_1002_0.php', 'qux_10_2.php', 'qux_12_0.php', 'qux_2_0.php', ]), $finder->in(self::$tmpDir)->getIterator()); $finder = $this->buildFinder(); $finder->name('test.ph*'); $finder->name('test.py'); $this->assertIterator($this->toAbsolute(['test.php', 'test.py']), $finder->in(self::$tmpDir)->getIterator()); $finder = $this->buildFinder(); $finder->name('~^test~i'); $this->assertIterator($this->toAbsolute(['test.php', 'test.py']), $finder->in(self::$tmpDir)->getIterator()); $finder = $this->buildFinder(); $finder->name('~\\.php$~i'); $this->assertIterator($this->toAbsolute([ 'test.php', 'qux_0_1.php', 'qux_1000_1.php', 'qux_1002_0.php', 'qux_10_2.php', 'qux_12_0.php', 'qux_2_0.php', ]), $finder->in(self::$tmpDir)->getIterator()); $finder = $this->buildFinder(); $finder->name('test.p{hp,y}'); $this->assertIterator($this->toAbsolute(['test.php', 'test.py']), $finder->in(self::$tmpDir)->getIterator()); } public function testNameWithArrayParam() { $finder = $this->buildFinder(); $finder->name(['test.php', 'test.py']); $this->assertIterator($this->toAbsolute(['test.php', 'test.py']), $finder->in(self::$tmpDir)->getIterator()); } public function testNotName() { $finder = $this->buildFinder(); $this->assertSame($finder, $finder->notName('*.php')); $this->assertIterator($this->toAbsolute([ 'foo', 'foo/bar.tmp', 'test.py', 'toto', 'foo bar', 'qux', 'qux/baz_100_1.py', 'qux/baz_1_2.py', ]), $finder->in(self::$tmpDir)->getIterator()); $finder = $this->buildFinder(); $finder->notName('*.php'); $finder->notName('*.py'); $this->assertIterator($this->toAbsolute([ 'foo', 'foo/bar.tmp', 'toto', 'foo bar', 'qux', ]), $finder->in(self::$tmpDir)->getIterator()); $finder = $this->buildFinder(); $finder->name('test.ph*'); $finder->name('test.py'); $finder->notName('*.php'); $finder->notName('*.py'); $this->assertIterator([], $finder->in(self::$tmpDir)->getIterator()); $finder = $this->buildFinder(); $finder->name('test.ph*'); $finder->name('test.py'); $finder->notName('*.p{hp,y}'); $this->assertIterator([], $finder->in(self::$tmpDir)->getIterator()); } public function testNotNameWithArrayParam() { $finder = $this->buildFinder(); $finder->notName(['*.php', '*.py']); $this->assertIterator($this->toAbsolute([ 'foo', 'foo/bar.tmp', 'toto', 'foo bar', 'qux', ]), $finder->in(self::$tmpDir)->getIterator()); } /** * @dataProvider getRegexNameTestData */ public function testRegexName($regex) { $finder = $this->buildFinder(); $finder->name($regex); $this->assertIterator($this->toAbsolute([ 'test.py', 'test.php', ]), $finder->in(self::$tmpDir)->getIterator()); } public function testSize() { $finder = $this->buildFinder(); $this->assertSame($finder, $finder->files()->size('< 1K')->size('> 500')); $this->assertIterator($this->toAbsolute(['test.php']), $finder->in(self::$tmpDir)->getIterator()); } public function testSizeWithArrayParam() { $finder = $this->buildFinder(); $this->assertSame($finder, $finder->files()->size(['< 1K', '> 500'])); $this->assertIterator($this->toAbsolute(['test.php']), $finder->in(self::$tmpDir)->getIterator()); } public function testDate() { $finder = $this->buildFinder(); $this->assertSame($finder, $finder->files()->date('until last month')); $this->assertIterator($this->toAbsolute(['foo/bar.tmp', 'test.php']), $finder->in(self::$tmpDir)->getIterator()); } public function testDateWithArrayParam() { $finder = $this->buildFinder(); $this->assertSame($finder, $finder->files()->date(['>= 2005-10-15', 'until last month'])); $this->assertIterator($this->toAbsolute(['foo/bar.tmp', 'test.php']), $finder->in(self::$tmpDir)->getIterator()); } public function testExclude() { $finder = $this->buildFinder(); $this->assertSame($finder, $finder->exclude('foo')); $this->assertIterator($this->toAbsolute([ 'test.php', 'test.py', 'toto', 'foo bar', 'qux', 'qux/baz_100_1.py', 'qux/baz_1_2.py', 'qux_0_1.php', 'qux_1000_1.php', 'qux_1002_0.php', 'qux_10_2.php', 'qux_12_0.php', 'qux_2_0.php', ]), $finder->in(self::$tmpDir)->getIterator()); } public function testIgnoreVCS() { $finder = $this->buildFinder(); $this->assertSame($finder, $finder->ignoreVCS(false)->ignoreDotFiles(false)); $this->assertIterator($this->toAbsolute([ '.gitignore', '.git', 'foo', 'foo/bar.tmp', 'test.php', 'test.py', 'toto', 'toto/.git', '.bar', '.foo', '.foo/.bar', '.foo/bar', 'foo bar', 'qux', 'qux/baz_100_1.py', 'qux/baz_1_2.py', 'qux_0_1.php', 'qux_1000_1.php', 'qux_1002_0.php', 'qux_10_2.php', 'qux_12_0.php', 'qux_2_0.php', ]), $finder->in(self::$tmpDir)->getIterator()); $finder = $this->buildFinder(); $finder->ignoreVCS(false)->ignoreVCS(false)->ignoreDotFiles(false); $this->assertIterator($this->toAbsolute([ '.gitignore', '.git', 'foo', 'foo/bar.tmp', 'test.php', 'test.py', 'toto', 'toto/.git', '.bar', '.foo', '.foo/.bar', '.foo/bar', 'foo bar', 'qux', 'qux/baz_100_1.py', 'qux/baz_1_2.py', 'qux_0_1.php', 'qux_1000_1.php', 'qux_1002_0.php', 'qux_10_2.php', 'qux_12_0.php', 'qux_2_0.php', ]), $finder->in(self::$tmpDir)->getIterator()); $finder = $this->buildFinder(); $this->assertSame($finder, $finder->ignoreVCS(true)->ignoreDotFiles(false)); $this->assertIterator($this->toAbsolute([ '.gitignore', 'foo', 'foo/bar.tmp', 'test.php', 'test.py', 'toto', '.bar', '.foo', '.foo/.bar', '.foo/bar', 'foo bar', 'qux', 'qux/baz_100_1.py', 'qux/baz_1_2.py', 'qux_0_1.php', 'qux_1000_1.php', 'qux_1002_0.php', 'qux_10_2.php', 'qux_12_0.php', 'qux_2_0.php', ]), $finder->in(self::$tmpDir)->getIterator()); } public function testIgnoreVCSIgnored() { $finder = $this->buildFinder(); $this->assertSame( $finder, $finder ->ignoreVCS(true) ->ignoreDotFiles(true) ->ignoreVCSIgnored(true) ); $this->assertIterator($this->toAbsolute([ 'foo', 'foo/bar.tmp', 'test.py', 'toto', 'foo bar', 'qux', 'qux/baz_100_1.py', 'qux/baz_1_2.py', ]), $finder->in(self::$tmpDir)->getIterator()); } public function testIgnoreVCSCanBeDisabledAfterFirstIteration() { $finder = $this->buildFinder(); $finder->in(self::$tmpDir); $finder->ignoreDotFiles(false); $this->assertIterator($this->toAbsolute([ '.gitignore', 'foo', 'foo/bar.tmp', 'qux', 'qux/baz_100_1.py', 'qux/baz_1_2.py', 'qux_0_1.php', 'qux_1000_1.php', 'qux_1002_0.php', 'qux_10_2.php', 'qux_12_0.php', 'qux_2_0.php', 'test.php', 'test.py', 'toto', '.bar', '.foo', '.foo/.bar', '.foo/bar', 'foo bar', ]), $finder->getIterator()); $finder->ignoreVCS(false); $this->assertIterator($this->toAbsolute([ '.gitignore', '.git', 'foo', 'foo/bar.tmp', 'qux', 'qux/baz_100_1.py', 'qux/baz_1_2.py', 'qux_0_1.php', 'qux_1000_1.php', 'qux_1002_0.php', 'qux_10_2.php', 'qux_12_0.php', 'qux_2_0.php', 'test.php', 'test.py', 'toto', 'toto/.git', '.bar', '.foo', '.foo/.bar', '.foo/bar', 'foo bar', ]), $finder->getIterator()); } public function testIgnoreDotFiles() { $finder = $this->buildFinder(); $this->assertSame($finder, $finder->ignoreDotFiles(false)->ignoreVCS(false)); $this->assertIterator($this->toAbsolute([ '.gitignore', '.git', '.bar', '.foo', '.foo/.bar', '.foo/bar', 'foo', 'foo/bar.tmp', 'test.php', 'test.py', 'toto', 'toto/.git', 'foo bar', 'qux', 'qux/baz_100_1.py', 'qux/baz_1_2.py', 'qux_0_1.php', 'qux_1000_1.php', 'qux_1002_0.php', 'qux_10_2.php', 'qux_12_0.php', 'qux_2_0.php', ]), $finder->in(self::$tmpDir)->getIterator()); $finder = $this->buildFinder(); $finder->ignoreDotFiles(false)->ignoreDotFiles(false)->ignoreVCS(false); $this->assertIterator($this->toAbsolute([ '.gitignore', '.git', '.bar', '.foo', '.foo/.bar', '.foo/bar', 'foo', 'foo/bar.tmp', 'test.php', 'test.py', 'toto', 'toto/.git', 'foo bar', 'qux', 'qux/baz_100_1.py', 'qux/baz_1_2.py', 'qux_0_1.php', 'qux_1000_1.php', 'qux_1002_0.php', 'qux_10_2.php', 'qux_12_0.php', 'qux_2_0.php', ]), $finder->in(self::$tmpDir)->getIterator()); $finder = $this->buildFinder(); $this->assertSame($finder, $finder->ignoreDotFiles(true)->ignoreVCS(false)); $this->assertIterator($this->toAbsolute([ 'foo', 'foo/bar.tmp', 'test.php', 'test.py', 'toto', 'foo bar', 'qux', 'qux/baz_100_1.py', 'qux/baz_1_2.py', 'qux_0_1.php', 'qux_1000_1.php', 'qux_1002_0.php', 'qux_10_2.php', 'qux_12_0.php', 'qux_2_0.php', ]), $finder->in(self::$tmpDir)->getIterator()); } public function testIgnoreDotFilesCanBeDisabledAfterFirstIteration() { $finder = $this->buildFinder(); $finder->in(self::$tmpDir); $this->assertIterator($this->toAbsolute([ 'foo', 'foo/bar.tmp', 'qux', 'qux/baz_100_1.py', 'qux/baz_1_2.py', 'qux_0_1.php', 'qux_1000_1.php', 'qux_1002_0.php', 'qux_10_2.php', 'qux_12_0.php', 'qux_2_0.php', 'test.php', 'test.py', 'toto', 'foo bar', ]), $finder->getIterator()); $finder->ignoreDotFiles(false); $this->assertIterator($this->toAbsolute([ '.gitignore', 'foo', 'foo/bar.tmp', 'qux', 'qux/baz_100_1.py', 'qux/baz_1_2.py', 'qux_0_1.php', 'qux_1000_1.php', 'qux_1002_0.php', 'qux_10_2.php', 'qux_12_0.php', 'qux_2_0.php', 'test.php', 'test.py', 'toto', '.bar', '.foo', '.foo/.bar', '.foo/bar', 'foo bar', ]), $finder->getIterator()); } public function testSortByName() { $finder = $this->buildFinder(); $this->assertSame($finder, $finder->sortByName()); $this->assertIterator($this->toAbsolute([ 'foo', 'foo bar', 'foo/bar.tmp', 'qux', 'qux/baz_100_1.py', 'qux/baz_1_2.py', 'qux_0_1.php', 'qux_1000_1.php', 'qux_1002_0.php', 'qux_10_2.php', 'qux_12_0.php', 'qux_2_0.php', 'test.php', 'test.py', 'toto', ]), $finder->in(self::$tmpDir)->getIterator()); } public function testSortByType() { $finder = $this->buildFinder(); $this->assertSame($finder, $finder->sortByType()); $this->assertIterator($this->toAbsolute([ 'foo', 'foo bar', 'toto', 'foo/bar.tmp', 'test.php', 'test.py', 'qux', 'qux/baz_100_1.py', 'qux/baz_1_2.py', 'qux_0_1.php', 'qux_1000_1.php', 'qux_1002_0.php', 'qux_10_2.php', 'qux_12_0.php', 'qux_2_0.php', ]), $finder->in(self::$tmpDir)->getIterator()); } public function testSortByAccessedTime() { $finder = $this->buildFinder(); $this->assertSame($finder, $finder->sortByAccessedTime()); $this->assertIterator($this->toAbsolute([ 'foo/bar.tmp', 'test.php', 'toto', 'test.py', 'foo', 'foo bar', 'qux', 'qux/baz_100_1.py', 'qux/baz_1_2.py', 'qux_0_1.php', 'qux_1000_1.php', 'qux_1002_0.php', 'qux_10_2.php', 'qux_12_0.php', 'qux_2_0.php', ]), $finder->in(self::$tmpDir)->getIterator()); } public function testSortByChangedTime() { $finder = $this->buildFinder(); $this->assertSame($finder, $finder->sortByChangedTime()); $this->assertIterator($this->toAbsolute([ 'toto', 'test.py', 'test.php', 'foo/bar.tmp', 'foo', 'foo bar', 'qux', 'qux/baz_100_1.py', 'qux/baz_1_2.py', 'qux_0_1.php', 'qux_1000_1.php', 'qux_1002_0.php', 'qux_10_2.php', 'qux_12_0.php', 'qux_2_0.php', ]), $finder->in(self::$tmpDir)->getIterator()); } public function testSortByModifiedTime() { $finder = $this->buildFinder(); $this->assertSame($finder, $finder->sortByModifiedTime()); $this->assertIterator($this->toAbsolute([ 'foo/bar.tmp', 'test.php', 'toto', 'test.py', 'foo', 'foo bar', 'qux', 'qux/baz_100_1.py', 'qux/baz_1_2.py', 'qux_0_1.php', 'qux_1000_1.php', 'qux_1002_0.php', 'qux_10_2.php', 'qux_12_0.php', 'qux_2_0.php', ]), $finder->in(self::$tmpDir)->getIterator()); } public function testReverseSorting() { $finder = $this->buildFinder(); $this->assertSame($finder, $finder->sortByName()); $this->assertSame($finder, $finder->reverseSorting()); $this->assertOrderedIteratorInForeach($this->toAbsolute([ 'toto', 'test.py', 'test.php', 'qux_2_0.php', 'qux_12_0.php', 'qux_10_2.php', 'qux_1002_0.php', 'qux_1000_1.php', 'qux_0_1.php', 'qux/baz_1_2.py', 'qux/baz_100_1.py', 'qux', 'foo/bar.tmp', 'foo bar', 'foo', ]), $finder->in(self::$tmpDir)->getIterator()); } public function testSortByNameNatural() { $finder = $this->buildFinder(); $this->assertSame($finder, $finder->sortByName(true)); $this->assertIterator($this->toAbsolute([ 'foo', 'foo bar', 'foo/bar.tmp', 'qux', 'qux/baz_100_1.py', 'qux/baz_1_2.py', 'qux_0_1.php', 'qux_1000_1.php', 'qux_1002_0.php', 'qux_10_2.php', 'qux_12_0.php', 'qux_2_0.php', 'test.php', 'test.py', 'toto', ]), $finder->in(self::$tmpDir)->getIterator()); $finder = $this->buildFinder(); $this->assertSame($finder, $finder->sortByName(false)); $this->assertIterator($this->toAbsolute([ 'foo', 'foo bar', 'foo/bar.tmp', 'qux', 'qux/baz_100_1.py', 'qux/baz_1_2.py', 'qux_0_1.php', 'qux_1000_1.php', 'qux_1002_0.php', 'qux_10_2.php', 'qux_12_0.php', 'qux_2_0.php', 'test.php', 'test.py', 'toto', ]), $finder->in(self::$tmpDir)->getIterator()); } public function testSort() { $finder = $this->buildFinder(); $this->assertSame($finder, $finder->sort(function (\SplFileInfo $a, \SplFileInfo $b) { return strcmp($a->getRealPath(), $b->getRealPath()); })); $this->assertIterator($this->toAbsolute([ 'foo', 'foo bar', 'foo/bar.tmp', 'test.php', 'test.py', 'toto', 'qux', 'qux/baz_100_1.py', 'qux/baz_1_2.py', 'qux_0_1.php', 'qux_1000_1.php', 'qux_1002_0.php', 'qux_10_2.php', 'qux_12_0.php', 'qux_2_0.php', ]), $finder->in(self::$tmpDir)->getIterator()); } public function testFilter() { $finder = $this->buildFinder(); $this->assertSame($finder, $finder->filter(function (\SplFileInfo $f) { return false !== strpos($f, 'test'); })); $this->assertIterator($this->toAbsolute(['test.php', 'test.py']), $finder->in(self::$tmpDir)->getIterator()); } public function testFollowLinks() { if ('\\' == \DIRECTORY_SEPARATOR) { $this->markTestSkipped('symlinks are not supported on Windows'); } $finder = $this->buildFinder(); $this->assertSame($finder, $finder->followLinks()); $this->assertIterator($this->toAbsolute([ 'foo', 'foo/bar.tmp', 'test.php', 'test.py', 'toto', 'foo bar', 'qux', 'qux/baz_100_1.py', 'qux/baz_1_2.py', 'qux_0_1.php', 'qux_1000_1.php', 'qux_1002_0.php', 'qux_10_2.php', 'qux_12_0.php', 'qux_2_0.php', ]), $finder->in(self::$tmpDir)->getIterator()); } public function testIn() { $finder = $this->buildFinder(); $iterator = $finder->files()->name('*.php')->depth('< 1')->in([self::$tmpDir, __DIR__])->getIterator(); $expected = [ self::$tmpDir.\DIRECTORY_SEPARATOR.'test.php', __DIR__.\DIRECTORY_SEPARATOR.'GitignoreTest.php', __DIR__.\DIRECTORY_SEPARATOR.'FinderTest.php', __DIR__.\DIRECTORY_SEPARATOR.'GlobTest.php', self::$tmpDir.\DIRECTORY_SEPARATOR.'qux_0_1.php', self::$tmpDir.\DIRECTORY_SEPARATOR.'qux_1000_1.php', self::$tmpDir.\DIRECTORY_SEPARATOR.'qux_1002_0.php', self::$tmpDir.\DIRECTORY_SEPARATOR.'qux_10_2.php', self::$tmpDir.\DIRECTORY_SEPARATOR.'qux_12_0.php', self::$tmpDir.\DIRECTORY_SEPARATOR.'qux_2_0.php', ]; $this->assertIterator($expected, $iterator); } /** * @expectedException \Symfony\Component\Finder\Exception\DirectoryNotFoundException */ public function testInWithNonExistentDirectory() { $finder = new Finder(); $finder->in('foobar'); } /** * @expectedException \InvalidArgumentException */ public function testInWithNonExistentDirectoryLegacyException() { $finder = new Finder(); $finder->in('foobar'); } public function testInWithGlob() { $finder = $this->buildFinder(); $finder->in([__DIR__.'/Fixtures/*/B/C/', __DIR__.'/Fixtures/*/*/B/C/'])->getIterator(); $this->assertIterator($this->toAbsoluteFixtures(['A/B/C/abc.dat', 'copy/A/B/C/abc.dat.copy']), $finder); } /** * @expectedException \InvalidArgumentException */ public function testInWithNonDirectoryGlob() { $finder = new Finder(); $finder->in(__DIR__.'/Fixtures/A/a*'); } public function testInWithGlobBrace() { if (!\defined('GLOB_BRACE')) { $this->markTestSkipped('Glob brace is not supported on this system.'); } $finder = $this->buildFinder(); $finder->in([__DIR__.'/Fixtures/{A,copy/A}/B/C'])->getIterator(); $this->assertIterator($this->toAbsoluteFixtures(['A/B/C/abc.dat', 'copy/A/B/C/abc.dat.copy']), $finder); } /** * @expectedException \LogicException */ public function testGetIteratorWithoutIn() { $finder = Finder::create(); $finder->getIterator(); } public function testGetIterator() { $finder = $this->buildFinder(); $dirs = []; foreach ($finder->directories()->in(self::$tmpDir) as $dir) { $dirs[] = (string) $dir; } $expected = $this->toAbsolute(['foo', 'qux', 'toto']); sort($dirs); sort($expected); $this->assertEquals($expected, $dirs, 'implements the \IteratorAggregate interface'); $finder = $this->buildFinder(); $this->assertEquals(3, iterator_count($finder->directories()->in(self::$tmpDir)), 'implements the \IteratorAggregate interface'); $finder = $this->buildFinder(); $a = iterator_to_array($finder->directories()->in(self::$tmpDir)); $a = array_values(array_map('strval', $a)); sort($a); $this->assertEquals($expected, $a, 'implements the \IteratorAggregate interface'); } public function testRelativePath() { $finder = $this->buildFinder()->in(self::$tmpDir); $paths = []; foreach ($finder as $file) { $paths[] = $file->getRelativePath(); } $ref = ['', '', '', '', '', '', '', '', '', '', '', 'foo', 'qux', 'qux', '']; sort($ref); sort($paths); $this->assertEquals($ref, $paths); } public function testRelativePathname() { $finder = $this->buildFinder()->in(self::$tmpDir)->sortByName(); $paths = []; foreach ($finder as $file) { $paths[] = $file->getRelativePathname(); } $ref = [ 'test.php', 'toto', 'test.py', 'foo', 'foo'.\DIRECTORY_SEPARATOR.'bar.tmp', 'foo bar', 'qux', 'qux'.\DIRECTORY_SEPARATOR.'baz_100_1.py', 'qux'.\DIRECTORY_SEPARATOR.'baz_1_2.py', 'qux_0_1.php', 'qux_1000_1.php', 'qux_1002_0.php', 'qux_10_2.php', 'qux_12_0.php', 'qux_2_0.php', ]; sort($paths); sort($ref); $this->assertEquals($ref, $paths); } public function testGetFilenameWithoutExtension() { $finder = $this->buildFinder()->in(self::$tmpDir)->sortByName(); $fileNames = []; foreach ($finder as $file) { $fileNames[] = $file->getFilenameWithoutExtension(); } $ref = [ 'test', 'toto', 'test', 'foo', 'bar', 'foo bar', 'qux', 'baz_100_1', 'baz_1_2', 'qux_0_1', 'qux_1000_1', 'qux_1002_0', 'qux_10_2', 'qux_12_0', 'qux_2_0', ]; sort($fileNames); sort($ref); $this->assertEquals($ref, $fileNames); } public function testAppendWithAFinder() { $finder = $this->buildFinder(); $finder->files()->in(self::$tmpDir.\DIRECTORY_SEPARATOR.'foo'); $finder1 = $this->buildFinder(); $finder1->directories()->in(self::$tmpDir); $finder = $finder->append($finder1); $this->assertIterator($this->toAbsolute(['foo', 'foo/bar.tmp', 'qux', 'toto']), $finder->getIterator()); } public function testAppendWithAnArray() { $finder = $this->buildFinder(); $finder->files()->in(self::$tmpDir.\DIRECTORY_SEPARATOR.'foo'); $finder->append($this->toAbsolute(['foo', 'toto'])); $this->assertIterator($this->toAbsolute(['foo', 'foo/bar.tmp', 'toto']), $finder->getIterator()); } public function testAppendReturnsAFinder() { $this->assertInstanceOf('Symfony\\Component\\Finder\\Finder', Finder::create()->append([])); } public function testAppendDoesNotRequireIn() { $finder = $this->buildFinder(); $finder->in(self::$tmpDir.\DIRECTORY_SEPARATOR.'foo'); $finder1 = Finder::create()->append($finder); $this->assertIterator(iterator_to_array($finder->getIterator()), $finder1->getIterator()); } public function testCountDirectories() { $directory = Finder::create()->directories()->in(self::$tmpDir); $i = 0; foreach ($directory as $dir) { ++$i; } $this->assertCount($i, $directory); } public function testCountFiles() { $files = Finder::create()->files()->in(__DIR__.\DIRECTORY_SEPARATOR.'Fixtures'); $i = 0; foreach ($files as $file) { ++$i; } $this->assertCount($i, $files); } /** * @expectedException \LogicException */ public function testCountWithoutIn() { $finder = Finder::create()->files(); \count($finder); } public function testHasResults() { $finder = $this->buildFinder(); $finder->in(__DIR__); $this->assertTrue($finder->hasResults()); } public function testNoResults() { $finder = $this->buildFinder(); $finder->in(__DIR__)->name('DoesNotExist'); $this->assertFalse($finder->hasResults()); } /** * @dataProvider getContainsTestData */ public function testContains($matchPatterns, $noMatchPatterns, $expected) { $finder = $this->buildFinder(); $finder->in(__DIR__.\DIRECTORY_SEPARATOR.'Fixtures') ->name('*.txt')->sortByName() ->contains($matchPatterns) ->notContains($noMatchPatterns); $this->assertIterator($this->toAbsoluteFixtures($expected), $finder); } public function testContainsOnDirectory() { $finder = $this->buildFinder(); $finder->in(__DIR__) ->directories() ->name('Fixtures') ->contains('abc'); $this->assertIterator([], $finder); } public function testNotContainsOnDirectory() { $finder = $this->buildFinder(); $finder->in(__DIR__) ->directories() ->name('Fixtures') ->notContains('abc'); $this->assertIterator([], $finder); } /** * Searching in multiple locations involves AppendIterator which does an unnecessary rewind which leaves FilterIterator * with inner FilesystemIterator in an invalid state. * * @see https://bugs.php.net/68557 */ public function testMultipleLocations() { $locations = [ self::$tmpDir.'/', self::$tmpDir.'/toto/', ]; // it is expected that there are test.py test.php in the tmpDir $finder = new Finder(); $finder->in($locations) // the default flag IGNORE_DOT_FILES fixes the problem indirectly // so we set it to false for better isolation ->ignoreDotFiles(false) ->depth('< 1')->name('test.php'); $this->assertCount(1, $finder); } /** * Searching in multiple locations with sub directories involves * AppendIterator which does an unnecessary rewind which leaves * FilterIterator with inner FilesystemIterator in an invalid state. * * @see https://bugs.php.net/68557 */ public function testMultipleLocationsWithSubDirectories() { $locations = [ __DIR__.'/Fixtures/one', self::$tmpDir.\DIRECTORY_SEPARATOR.'toto', ]; $finder = $this->buildFinder(); $finder->in($locations)->depth('< 10')->name('*.neon'); $expected = [ __DIR__.'/Fixtures/one'.\DIRECTORY_SEPARATOR.'b'.\DIRECTORY_SEPARATOR.'c.neon', __DIR__.'/Fixtures/one'.\DIRECTORY_SEPARATOR.'b'.\DIRECTORY_SEPARATOR.'d.neon', ]; $this->assertIterator($expected, $finder); $this->assertIteratorInForeach($expected, $finder); } /** * Iterator keys must be the file pathname. */ public function testIteratorKeys() { $finder = $this->buildFinder()->in(self::$tmpDir); foreach ($finder as $key => $file) { $this->assertEquals($file->getPathname(), $key); } } public function testRegexSpecialCharsLocationWithPathRestrictionContainingStartFlag() { $finder = $this->buildFinder(); $finder->in(__DIR__.\DIRECTORY_SEPARATOR.'Fixtures'.\DIRECTORY_SEPARATOR.'r+e.gex[c]a(r)s') ->path('/^dir/'); $expected = ['r+e.gex[c]a(r)s'.\DIRECTORY_SEPARATOR.'dir', 'r+e.gex[c]a(r)s'.\DIRECTORY_SEPARATOR.'dir'.\DIRECTORY_SEPARATOR.'bar.dat']; $this->assertIterator($this->toAbsoluteFixtures($expected), $finder); } public function getContainsTestData() { return [ ['', '', []], ['foo', 'bar', []], ['', 'foobar', ['dolor.txt', 'ipsum.txt', 'lorem.txt']], ['lorem ipsum dolor sit amet', 'foobar', ['lorem.txt']], ['sit', 'bar', ['dolor.txt', 'ipsum.txt', 'lorem.txt']], ['dolor sit amet', '@^L@m', ['dolor.txt', 'ipsum.txt']], ['/^lorem ipsum dolor sit amet$/m', 'foobar', ['lorem.txt']], ['lorem', 'foobar', ['lorem.txt']], ['', 'lorem', ['dolor.txt', 'ipsum.txt']], ['ipsum dolor sit amet', '/^IPSUM/m', ['lorem.txt']], [['lorem', 'dolor'], [], ['lorem.txt', 'ipsum.txt', 'dolor.txt']], ['', ['lorem', 'ipsum'], ['dolor.txt']], ]; } public function getRegexNameTestData() { return [ ['~.*t\\.p.+~i'], ['~t.*s~i'], ]; } /** * @dataProvider getTestPathData */ public function testPath($matchPatterns, $noMatchPatterns, array $expected) { $finder = $this->buildFinder(); $finder->in(__DIR__.\DIRECTORY_SEPARATOR.'Fixtures') ->path($matchPatterns) ->notPath($noMatchPatterns); $this->assertIterator($this->toAbsoluteFixtures($expected), $finder); } public function getTestPathData() { return [ ['', '', []], ['/^A\/B\/C/', '/C$/', ['A'.\DIRECTORY_SEPARATOR.'B'.\DIRECTORY_SEPARATOR.'C'.\DIRECTORY_SEPARATOR.'abc.dat'], ], ['/^A\/B/', 'foobar', [ 'A'.\DIRECTORY_SEPARATOR.'B', 'A'.\DIRECTORY_SEPARATOR.'B'.\DIRECTORY_SEPARATOR.'C', 'A'.\DIRECTORY_SEPARATOR.'B'.\DIRECTORY_SEPARATOR.'ab.dat', 'A'.\DIRECTORY_SEPARATOR.'B'.\DIRECTORY_SEPARATOR.'C'.\DIRECTORY_SEPARATOR.'abc.dat', ], ], ['A/B/C', 'foobar', [ 'A'.\DIRECTORY_SEPARATOR.'B'.\DIRECTORY_SEPARATOR.'C', 'A'.\DIRECTORY_SEPARATOR.'B'.\DIRECTORY_SEPARATOR.'C'.\DIRECTORY_SEPARATOR.'abc.dat', 'copy'.\DIRECTORY_SEPARATOR.'A'.\DIRECTORY_SEPARATOR.'B'.\DIRECTORY_SEPARATOR.'C', 'copy'.\DIRECTORY_SEPARATOR.'A'.\DIRECTORY_SEPARATOR.'B'.\DIRECTORY_SEPARATOR.'C'.\DIRECTORY_SEPARATOR.'abc.dat.copy', ], ], ['A/B', 'foobar', [ //dirs 'A'.\DIRECTORY_SEPARATOR.'B', 'A'.\DIRECTORY_SEPARATOR.'B'.\DIRECTORY_SEPARATOR.'C', 'copy'.\DIRECTORY_SEPARATOR.'A'.\DIRECTORY_SEPARATOR.'B', 'copy'.\DIRECTORY_SEPARATOR.'A'.\DIRECTORY_SEPARATOR.'B'.\DIRECTORY_SEPARATOR.'C', //files 'A'.\DIRECTORY_SEPARATOR.'B'.\DIRECTORY_SEPARATOR.'ab.dat', 'A'.\DIRECTORY_SEPARATOR.'B'.\DIRECTORY_SEPARATOR.'C'.\DIRECTORY_SEPARATOR.'abc.dat', 'copy'.\DIRECTORY_SEPARATOR.'A'.\DIRECTORY_SEPARATOR.'B'.\DIRECTORY_SEPARATOR.'ab.dat.copy', 'copy'.\DIRECTORY_SEPARATOR.'A'.\DIRECTORY_SEPARATOR.'B'.\DIRECTORY_SEPARATOR.'C'.\DIRECTORY_SEPARATOR.'abc.dat.copy', ], ], ['/^with space\//', 'foobar', [ 'with space'.\DIRECTORY_SEPARATOR.'foo.txt', ], ], [ '/^A/', ['a.dat', 'abc.dat'], [ 'A', 'A'.\DIRECTORY_SEPARATOR.'B', 'A'.\DIRECTORY_SEPARATOR.'B'.\DIRECTORY_SEPARATOR.'C', 'A'.\DIRECTORY_SEPARATOR.'B'.\DIRECTORY_SEPARATOR.'ab.dat', ], ], [ ['/^A/', 'one'], 'foobar', [ 'A', 'A'.\DIRECTORY_SEPARATOR.'B', 'A'.\DIRECTORY_SEPARATOR.'B'.\DIRECTORY_SEPARATOR.'C', 'A'.\DIRECTORY_SEPARATOR.'a.dat', 'A'.\DIRECTORY_SEPARATOR.'B'.\DIRECTORY_SEPARATOR.'ab.dat', 'A'.\DIRECTORY_SEPARATOR.'B'.\DIRECTORY_SEPARATOR.'C'.\DIRECTORY_SEPARATOR.'abc.dat', 'one', 'one'.\DIRECTORY_SEPARATOR.'a', 'one'.\DIRECTORY_SEPARATOR.'b', 'one'.\DIRECTORY_SEPARATOR.'b'.\DIRECTORY_SEPARATOR.'c.neon', 'one'.\DIRECTORY_SEPARATOR.'b'.\DIRECTORY_SEPARATOR.'d.neon', ], ], ]; } public function testAccessDeniedException() { if ('\\' === \DIRECTORY_SEPARATOR) { $this->markTestSkipped('chmod is not supported on Windows'); } $finder = $this->buildFinder(); $finder->files()->in(self::$tmpDir); // make 'foo' directory non-readable $testDir = self::$tmpDir.\DIRECTORY_SEPARATOR.'foo'; chmod($testDir, 0333); if (false === $couldRead = is_readable($testDir)) { try { $this->assertIterator($this->toAbsolute(['foo bar', 'test.php', 'test.py']), $finder->getIterator()); $this->fail('Finder should throw an exception when opening a non-readable directory.'); } catch (\Exception $e) { $expectedExceptionClass = 'Symfony\\Component\\Finder\\Exception\\AccessDeniedException'; if ($e instanceof \PHPUnit_Framework_ExpectationFailedException) { $this->fail(sprintf("Expected exception:\n%s\nGot:\n%s\nWith comparison failure:\n%s", $expectedExceptionClass, 'PHPUnit_Framework_ExpectationFailedException', $e->getComparisonFailure()->getExpectedAsString())); } if ($e instanceof \PHPUnit\Framework\ExpectationFailedException) { $this->fail(sprintf("Expected exception:\n%s\nGot:\n%s\nWith comparison failure:\n%s", $expectedExceptionClass, '\PHPUnit\Framework\ExpectationFailedException', $e->getComparisonFailure()->getExpectedAsString())); } $this->assertInstanceOf($expectedExceptionClass, $e); } } // restore original permissions chmod($testDir, 0777); clearstatcache(true, $testDir); if ($couldRead) { $this->markTestSkipped('could read test files while test requires unreadable'); } } public function testIgnoredAccessDeniedException() { if ('\\' === \DIRECTORY_SEPARATOR) { $this->markTestSkipped('chmod is not supported on Windows'); } $finder = $this->buildFinder(); $finder->files()->ignoreUnreadableDirs()->in(self::$tmpDir); // make 'foo' directory non-readable $testDir = self::$tmpDir.\DIRECTORY_SEPARATOR.'foo'; chmod($testDir, 0333); if (false === ($couldRead = is_readable($testDir))) { $this->assertIterator($this->toAbsolute([ 'foo bar', 'test.php', 'test.py', 'qux/baz_100_1.py', 'qux/baz_1_2.py', 'qux_0_1.php', 'qux_1000_1.php', 'qux_1002_0.php', 'qux_10_2.php', 'qux_12_0.php', 'qux_2_0.php', ] ), $finder->getIterator()); } // restore original permissions chmod($testDir, 0777); clearstatcache(true, $testDir); if ($couldRead) { $this->markTestSkipped('could read test files while test requires unreadable'); } } /** * @group legacy * @expectedDeprecation The "Symfony\Component\Finder\Finder::sortByName()" method will have a new "bool $useNaturalSort = false" argument in version 5.0, not defining it is deprecated since Symfony 4.2. */ public function testInheritedClassCallSortByNameWithNoArguments() { $finderChild = new ClassThatInheritFinder(); $finderChild->sortByName(); } protected function buildFinder() { return Finder::create(); } } class ClassThatInheritFinder extends Finder { public function sortByName() { parent::sortByName(); } }