Merge pull request #1890 from MasterOdin/deprecated_notice

trigger deprecation notice when using default_database
cakephp · Sep 30, 2020 · efb0d4d · efb0d4d
2 parents 59f18de + 2b47af4
commit efb0d4d
Show file tree

Hide file tree

Showing 5 changed files with 37 additions and 4 deletions.
diff --git a/src/Phinx/Config/Config.php b/src/Phinx/Config/Config.php
@@ -214,6 +214,7 @@ public function getDefaultEnvironment()
 
         // deprecated: to be removed 0.13
         if (isset($this->values['environments']['default_database'])) {
+            trigger_error('default_database in the config has been deprecated since 0.12, use default_environment instead.', E_USER_DEPRECATED);
             $this->values['environments']['default_environment'] = $this->values['environments']['default_database'];
         }
 

diff --git a/tests/Phinx/Config/ConfigTest.php b/tests/Phinx/Config/ConfigTest.php
@@ -97,11 +97,43 @@ public function testReturnsEmptyArrayWithEmptyDataDomain()
     public function testGetDefaultEnvironmentUsingDatabaseKey()
     {
         $configArray = $this->getConfigArray();
-        $configArray['environments']['default_database'] = 'production';
+        $configArray['environments']['default_environment'] = 'production';
         $config = new Config($configArray);
         $this->assertEquals('production', $config->getDefaultEnvironment());
     }
 
+    /**
+     * @covers \Phinx\Config\Config::getDefaultEnvironment
+     */
+    public function testGetDefaultEnvironmentUsingDefaultDatabase()
+    {
+        $configArray = $this->getConfigArray();
+        $configArray['environments']['default_database'] = 'production';
+        $config = new Config($configArray);
+
+        $errorReporting = error_reporting();
+        try {
+            error_reporting(E_ALL ^ E_USER_DEPRECATED);
+            $this->assertEquals('production', $config->getDefaultEnvironment());
+        } finally {
+            error_reporting($errorReporting);
+        }
+    }
+
+    /**
+     * @covers \Phinx\Config\Config::getDefaultEnvironment
+     */
+    public function testDefaultDatabaseThrowsDeprecatedNotice()
+    {
+        $configArray = $this->getConfigArray();
+        $configArray['environments']['default_database'] = 'production';
+        $config = new Config($configArray);
+
+        $this->expectDeprecation();
+        $this->expectExceptionMessage('default_database in the config has been deprecated since 0.12, use default_environment instead.');
+        $config->getDefaultEnvironment();
+    }
+
     /**
      * @covers \Phinx\Config\Config::offsetGet
      * @covers \Phinx\Config\Config::offsetSet

diff --git a/tests/Phinx/Console/Command/MigrateTest.php b/tests/Phinx/Console/Command/MigrateTest.php
@@ -98,7 +98,7 @@ public function testExecuteWithDsn()
             ],
             'environments' => [
                 'default_migration_table' => 'phinxlog',
-                'default_database' => 'development',
+                'default_environment' => 'development',
                 'development' => [
                     'dsn' => 'mysql://fakehost:3006/development',
                 ],

diff --git a/tests/Phinx/Console/Command/SeedRunTest.php b/tests/Phinx/Console/Command/SeedRunTest.php
@@ -97,7 +97,7 @@ public function testExecuteWithDsn()
             ],
             'environments' => [
                 'default_migration_table' => 'phinxlog',
-                'default_database' => 'development',
+                'default_environment' => 'development',
                 'development' => [
                     'dsn' => 'mysql://fakehost:3006/development',
                 ],

diff --git a/tests/Phinx/Console/Command/StatusTest.php b/tests/Phinx/Console/Command/StatusTest.php
@@ -111,7 +111,7 @@ public function testExecuteWithDsn()
             ],
             'environments' => [
                 'default_migration_table' => 'phinxlog',
-                'default_database' => 'development',
+                'default_environment' => 'development',
                 'development' => [
                     'dsn' => 'pgsql://fakehost:5433/development',
                 ],