Merge branch '3.3.x'

2025-08-12 03:34:04 +02:00 · 2020-11-22 22:03:06 +01:00
parent 54611c94aa 5a55891d06
commit c11f9bbe0d
2 changed files with 141 additions and 5 deletions
--- a/tests/di/container_cache_directory_test.php
+++ b/tests/di/container_cache_directory_test.php
@@ -0,0 +1,125 @@
+<?php
+/**
+*
+* This file is part of the phpBB Forum Software package.
+*
+* @copyright (c) phpBB Limited <https://www.phpbb.com>
+* @license GNU General Public License, version 2 (GPL-2.0)
+*
+* For full copyright and license information, please see
+* the docs/CREDITS.txt file.
+*
+*/
+
+namespace
+{
+	class container_cache_directory_test extends \phpbb_test_case //phpbb_di_container_test
+	{
+		protected $config_php;
+
+		/**
+		* @var \phpbb\di\container_builder
+		*/
+		protected $builder;
+		protected $phpbb_root_path;
+		protected $filename;
+
+		public function setUp(): void
+		{
+			$this->phpbb_root_path = dirname(__FILE__) . '/';
+			$this->config_php = new \phpbb\config_php_file($this->phpbb_root_path . 'fixtures/', 'php');
+
+			$this->filename = $this->phpbb_root_path . '../tmp/container.php';
+			if (is_file($this->filename))
+			{
+				unlink($this->filename);
+			}
+
+			parent::setUp();
+		}
+
+		public function test_cache_directory_can_be_overridden()
+		{
+			$new_cache_directory = $this->phpbb_root_path . 'fixtures/overwrite-cache-directory/test/';
+
+			// This is how one overrides the cache directory.
+			// The file cache driver will now write to a new directory.
+			$_SERVER['PHPBB____core__cache_dir'] = $new_cache_directory;
+
+			$this->builder = new phpbb_mock_phpbb_di_container_builder($this->phpbb_root_path . 'fixtures/', 'php');
+			$this->builder->with_config($this->config_php);
+			$container = $this->builder->get_container();
+
+			$this->assertEquals($container->getParameter('core.cache_dir'), $new_cache_directory);
+		}
+
+		/**
+		 * By default autoload_xxx.php and container_xxx.php files
+		 * will also be written to the default cache directory.
+		 * This test demonstrates the default behavior.
+		 */
+		public function test_container_and_autoload_cache()
+		{
+			$default_cache_directory = $this->phpbb_root_path . 'fixtures/cache/test/';
+
+			// Make sure our test directory will be empty.
+			if (is_dir($default_cache_directory))
+			{
+				array_map('unlink', glob($default_cache_directory . '/*'));
+			}
+			else
+			{
+				mkdir($default_cache_directory, 0777, true);
+			}
+
+			// Use the normal container_builder
+			$builder = new \phpbb\di\container_builder($this->phpbb_root_path . 'fixtures/', 'php');
+			$builder->with_config($this->config_php);
+
+			$container = $builder->get_container();
+
+			$files_written_to_cache = array_map('basename', glob($default_cache_directory . '/*'));
+
+			$this->assertNotEmpty(preg_grep('/autoload_.+.php/', $files_written_to_cache), 'There should be an autoload file in the cache directory.');
+			$this->assertNotEmpty(preg_grep('/container_.+.php/', $files_written_to_cache), 'There should be an container file in the cache directory.');
+
+			// Cleanup the cache directory to prevent class redeclaration errors.
+			array_map('unlink', glob($default_cache_directory . '/*'));
+		}
+
+		/**
+		 * The desired behavior: When we have a custom cache directory
+		 * the autoload and container cache files are also written to the custom cache directory.
+		 */
+		public function test_autoload_and_container_cache_are_written_to_overriden_cache_directory()
+		{
+			$new_cache_directory = $this->phpbb_root_path . 'fixtures/overwrite-cache-directory/test/';
+
+			$_SERVER['PHPBB____core__cache_dir'] = $new_cache_directory;
+
+			// Make sure our test directory will be empty.
+			if (is_dir($new_cache_directory))
+			{
+				array_map('unlink', glob($new_cache_directory . '/*'));
+			}
+			else
+			{
+				mkdir($new_cache_directory, 0777, true);
+			}
+
+			// Use the normal container_builder
+			$builder = new \phpbb\di\container_builder($this->phpbb_root_path . 'fixtures/', 'php');
+			$builder->with_config($this->config_php);
+
+			$container = $builder->get_container();
+
+			$files_written_to_cache = array_map('basename', glob($new_cache_directory."/*"));
+
+			$this->assertNotEmpty(preg_grep('/autoload_.+.php/', $files_written_to_cache), 'There should be an autoload file in the cache directory.');
+			$this->assertNotEmpty(preg_grep('/container_.+.php/', $files_written_to_cache), 'There should be an container file in the cache directory.');
+
+			array_map('unlink', glob($new_cache_directory . '/*'));
+
+		}
+	}
+}