EnvironmentCommandTest.php

<?php

declare(strict_types=1);

/**
 * This file is part of CodeIgniter 4 framework.
 *
 * (c) CodeIgniter Foundation <admin@codeigniter.com>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace CodeIgniter\Commands;

use CodeIgniter\Test\CIUnitTestCase;
use CodeIgniter\Test\StreamFilterTrait;
use PHPUnit\Framework\Attributes\Group;

/**
 * @internal
 */
#[Group('Others')]
final class EnvironmentCommandTest extends CIUnitTestCase
{
    use StreamFilterTrait;

    private string $envPath       = ROOTPATH . '.env';
    private string $backupEnvPath = ROOTPATH . '.env.backup';

    protected function setUp(): void
    {
        parent::setUp();

        if (is_file($this->envPath)) {
            rename($this->envPath, $this->backupEnvPath);
        }
    }

    protected function tearDown(): void
    {
        parent::tearDown();

        if (is_file($this->envPath)) {
            unlink($this->envPath);
        }

        if (is_file($this->backupEnvPath)) {
            rename($this->backupEnvPath, $this->envPath);
        }

        $_SERVER['CI_ENVIRONMENT'] = $_ENV['CI_ENVIRONMENT'] = ENVIRONMENT;
    }

    public function testUsingCommandWithNoArgumentsGivesCurrentEnvironment(): void
    {
        command('env');
        $this->assertStringContainsString('testing', $this->getStreamFilterBuffer());
        $this->assertStringContainsString(ENVIRONMENT, $this->getStreamFilterBuffer());
    }

    public function testProvidingTestingAsEnvGivesErrorMessage(): void
    {
        command('env testing');
        $this->assertStringContainsString(
            'The "testing" environment is reserved for PHPUnit testing.',
            $this->getStreamFilterBuffer(),
        );
    }

    public function testProvidingUnknownEnvGivesErrorMessage(): void
    {
        command('env foobar');
        $this->assertStringContainsString('Invalid environment type "foobar".', $this->getStreamFilterBuffer());
    }

    public function testDefaultShippedEnvIsMissing(): void
    {
        rename(ROOTPATH . 'env', ROOTPATH . 'lostenv');
        command('env development');
        rename(ROOTPATH . 'lostenv', ROOTPATH . 'env');

        $this->assertStringContainsString('Both default shipped', $this->getStreamFilterBuffer());
        $this->assertStringContainsString(
            'It is impossible to write the new environment type.',
            $this->getStreamFilterBuffer(),
        );
    }

    public function testSettingNewEnvIsSuccess(): void
    {
        // default env file has `production` env in it
        $_SERVER['CI_ENVIRONMENT'] = 'production';
        command('env development');

        $this->assertStringContainsString('Environment is successfully changed to', $this->getStreamFilterBuffer());
        $this->assertStringContainsString('CI_ENVIRONMENT = development', (string) file_get_contents($this->envPath));
    }
}