DeprecatedIniDirectivesSniffTest

Complexity

Total Complexity

20

Size/Duplication

Total Lines	269
Duplicated Lines	20.82 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

<?php
class DeprecatedIniDirectivesSniffTest extends BaseSniffTest
{

    const TEST_FILE = 'sniff-examples/deprecated_ini_directives.php';

    /**
     * Test valid directive
     *
     * @group IniDirectives
     *
     * @return void
     */
    public function testValidDirective()
    {
        $file = $this->sniffFile(self::TEST_FILE);
        $this->assertNoViolation($file, 57);
        $this->assertNoViolation($file, 58);
        $this->assertNoViolation($file, 133);
    }

    /**
     * testDeprecatedForbiddenDirectives
     *
     * @group IniDirectives
     *
     * @dataProvider dataDeprecatedForbiddenDirectives
     *
     * @param string $iniName           Name of the ini directive.
     * @param string $deprecatedIn      The PHP version in which the ini directive was deprecated.
     * @param string $forbiddenIn       The PHP version in which the ini directive was forbidden.
     * @param array  $lines             The line numbers in the test file which apply to this ini directive.
     * @param string $okVersion         A PHP version in which the ini directive was still valid.
     * @param string $deprecatedVersion Optional PHP version to test deprecation message with -
     *                                  if different from the $deprecatedIn version.
     * @param string $forbiddenVersion  Optional PHP version to test forbidden message with -
     *                                  if different from the $forbiddenIn version.
     *
     * @return void
     */
    public function testDeprecatedForbiddenDirectives($iniName, $deprecatedIn, $forbiddenIn, $lines, $okVersion, $deprecatedVersion = null, $forbiddenVersion = null)
    {
        $file = $this->sniffFile(self::TEST_FILE, $okVersion);
        foreach($lines as $line) {
            $this->assertNoViolation($file, $line);
        }

        if (isset($deprecatedVersion)){
            $file = $this->sniffFile(self::TEST_FILE, $deprecatedVersion);
        }
        else {
            $file = $this->sniffFile(self::TEST_FILE, $deprecatedIn);
        }
        foreach($lines as $line) {
            $this->assertWarning($file, $line, "INI directive '{$iniName}' is deprecated from PHP {$deprecatedIn}.");
        }

        if (isset($forbiddenVersion)){
            $file = $this->sniffFile(self::TEST_FILE, $forbiddenVersion);
        }
        else {
            $file = $this->sniffFile(self::TEST_FILE, $forbiddenIn);
        }
        $this->assertError($file, $lines[0], "INI directive '{$iniName}' is deprecated from PHP {$deprecatedIn} and forbidden from PHP {$forbiddenIn}");
        $this->assertWarning($file, $lines[1], "INI directive '{$iniName}' is deprecated from PHP {$deprecatedIn} and forbidden from PHP {$forbiddenIn}");
    }

    /**
     * Data provider.
     *
     * @see testDeprecatedForbiddenDirectives()
     *
     * @return array
     */
    public function dataDeprecatedForbiddenDirectives()
    {
        return array(
            array('define_syslog_variables', '5.3', '5.4', array(3, 4), '5.2'),
            array('register_globals', '5.3', '5.4', array(6, 7), '5.2'),
            array('register_long_arrays', '5.3', '5.4', array(9, 10), '5.2'),
            array('magic_quotes_gpc', '5.3', '5.4', array(12, 13), '5.2'),
            array('magic_quotes_runtime', '5.3', '5.4', array(15, 16), '5.2'),
            array('magic_quotes_sybase', '5.3', '5.4', array(18, 19), '5.2'),
            array('allow_call_time_pass_reference', '5.3', '5.4', array(21, 22), '5.2'),
            array('highlight.bg', '5.3', '5.4', array(24, 25), '5.2'),
            array('session.bug_compat_42', '5.3', '5.4', array(27, 28), '5.2'),
            array('session.bug_compat_warn', '5.3', '5.4', array(30, 31), '5.2'),
            array('y2k_compliance', '5.3', '5.4', array(33, 34), '5.2'),
            array('safe_mode', '5.3', '5.4', array(39, 40), '5.2'),
            array('safe_mode_gid', '5.3', '5.4', array(42, 43), '5.2'),
            array('safe_mode_include_dir', '5.3', '5.4', array(45, 46), '5.2'),
            array('safe_mode_exec_dir', '5.3', '5.4', array(48, 49), '5.2'),
            array('safe_mode_allowed_env_vars', '5.3', '5.4', array(51, 52), '5.2'),
            array('safe_mode_protected_env_vars', '5.3', '5.4', array(54, 55), '5.2'),

            array('always_populate_raw_post_data', '5.6', '7.0', array(80, 81), '5.5'),
        );
    }


    /**
     * testDeprecatedDirectives
     *
     * @group IniDirectives
     *
     * @dataProvider dataDeprecatedDirectives
     *
     * @param string $iniName           Name of the ini directive.
     * @param string $deprecatedIn      The PHP version in which the ini directive was deprecated.
     * @param array  $lines             The line numbers in the test file which apply to this ini directive.
     * @param string $okVersion         A PHP version in which the ini directive was still valid.
     * @param string $deprecatedVersion Optional PHP version to test deprecation message with -
     *                                  if different from the $deprecatedIn version.
     *
     * @return void
     */
    public function testDeprecatedDirectives($iniName, $deprecatedIn, $lines, $okVersion, $deprecatedVersion = null)
    {
        $file = $this->sniffFile(self::TEST_FILE, $okVersion);
        foreach($lines as $line) {
            $this->assertNoViolation($file, $line);
        }

        if (isset($deprecatedVersion)){
            $file = $this->sniffFile(self::TEST_FILE, $deprecatedVersion);
        }
        else {
            $file = $this->sniffFile(self::TEST_FILE, $deprecatedIn);
        }
        foreach($lines as $line) {
            $this->assertWarning($file, $line, "INI directive '{$iniName}' is deprecated from PHP {$deprecatedIn}.");
        }
    }

    /**
     * Data provider.
     *
     * @see testDeprecatedDirectives()
     *
     * @return array
     */
    public function dataDeprecatedDirectives()
    {
        return array(
            array('safe_mode_protected_env_vars', '5.3', array(54, 55), '5.2'),

            array('iconv.input_encoding', '5.6', array(62, 63), '5.5'),
            array('iconv.output_encoding', '5.6', array(65, 66), '5.5'),
            array('iconv.internal_encoding', '5.6', array(68, 69), '5.5'),
            array('mbstring.http_input', '5.6', array(71, 72), '5.5'),
            array('mbstring.http_output', '5.6', array(74, 75), '5.5'),
            array('mbstring.internal_encoding', '5.6', array(77, 78), '5.5'),
        );
    }



    /**
     * testForbiddenWithAlternative
     *
     * @group IniDirectives
     *
     * @dataProvider dataForbiddenWithAlternative
     *
     * @param string $iniName           Name of the ini directive.
     * @param string $forbiddenIn       The PHP version in which the ini directive was forbidden.
     * @param string $alternative       An alternative ini directive for the forbidden directive.
     * @param array  $lines             The line numbers in the test file which apply to this ini directive.
     * @param string $okVersion         A PHP version in which the ini directive was still valid.
     * @param string $forbiddenVersion  Optional PHP version to test forbidden message with -
     *                                  if different from the $forbiddenIn version.
     *
     * @return void
     */
    public function testForbiddenWithAlternative($iniName, $forbiddenIn, $alternative, $lines, $okVersion, $forbiddenVersion = null)
    {
        $file = $this->sniffFile(self::TEST_FILE, $okVersion);
        foreach($lines as $line) {
            $this->assertNoViolation($file, $line);
        }

        if (isset($forbiddenVersion)){
            $file = $this->sniffFile(self::TEST_FILE, $forbiddenVersion);
        }
        else {
            $file = $this->sniffFile(self::TEST_FILE, $forbiddenIn);
        }
        $this->assertError($file, $lines[0], "INI directive '{$iniName}' is forbidden from PHP {$forbiddenIn}. Use '{$alternative}' instead.");
        $this->assertWarning($file, $lines[1], "INI directive '{$iniName}' is forbidden from PHP {$forbiddenIn}. Use '{$alternative}' instead.");
    }

    /**
     * Data provider.
     *
     * @see testForbiddenWithAlternative()
     *
     * @return array
     */
    public function dataForbiddenWithAlternative()
    {
        return array(
            array('fbsql.batchSize', '5.1', 'fbsql.batchsize', array(89, 90), '5.0'),
            array('detect_unicode', '5.4', 'zend.detect_unicode', array(125, 126), '5.3'),
            array('mbstring.script_encoding', '5.4', 'zend.script_encoding', array(128, 129), '5.3'),
        );
    }

    /**
     * testForbiddenDirectives
     *
     * @group IniDirectives
     *
     * @dataProvider dataForbiddenDirectives
     *
     * @param string $iniName           Name of the ini directive.
     * @param string $forbiddenIn       The PHP version in which the ini directive was forbidden.
     * @param array  $lines             The line numbers in the test file which apply to this ini directive.
     * @param string $okVersion         A PHP version in which the ini directive was still valid.
     * @param string $forbiddenVersion  Optional PHP version to test forbidden message with -
     *                                  if different from the $forbiddenIn version.
     *
     * @return void
     */
    public function testForbiddenDirectives($iniName, $forbiddenIn, $lines, $okVersion, $forbiddenVersion = null)
    {
        $file = $this->sniffFile(self::TEST_FILE, $okVersion);
        foreach($lines as $line) {
            $this->assertNoViolation($file, $line);
        }

        if (isset($forbiddenVersion)){
            $file = $this->sniffFile(self::TEST_FILE, $forbiddenVersion);
        }
        else {
            $file = $this->sniffFile(self::TEST_FILE, $forbiddenIn);
        }
        $this->assertError($file, $lines[0], "INI directive '{$iniName}' is forbidden from PHP {$forbiddenIn}.");
        $this->assertWarning($file, $lines[1], "INI directive '{$iniName}' is forbidden from PHP {$forbiddenIn}.");
    }

    /**
     * Data provider.
     *
     * @see testForbiddenDirectives()
     *
     * @return array
     */
    public function dataForbiddenDirectives()
    {
        return array(
            array('ifx.allow_persistent', '5.2.1', array(92, 93), '5.1', '5.3'),
            array('ifx.blobinfile', '5.2.1', array(95, 96), '5.1', '5.3'),
            array('ifx.byteasvarchar', '5.2.1', array(98, 99), '5.1', '5.3'),
            array('ifx.charasvarchar', '5.2.1', array(101, 102), '5.1', '5.3'),
            array('ifx.default_host', '5.2.1', array(104, 105), '5.1', '5.3'),
            array('ifx.default_password', '5.2.1', array(107, 108), '5.1', '5.3'),
            array('ifx.default_user', '5.2.1', array(110, 111), '5.1', '5.3'),
            array('ifx.max_links', '5.2.1', array(113, 114), '5.1', '5.3'),
            array('ifx.max_persistent', '5.2.1', array(116, 117), '5.1', '5.3'),
            array('ifx.nullformat', '5.2.1', array(119, 120), '5.1', '5.3'),
            array('ifx.textasvarchar', '5.2.1', array(122, 123), '5.1', '5.3'),

            array('zend.ze1_compatibility_mode', '5.3', array(36, 37), '5.2'),

            array('asp_tags', '7.0', array(83, 84), '5.6'),
            array('xsl.security_prefs', '7.0', array(86, 87), '5.6'),
        );
    }

}