[PHP-Config] Update main configuration

[loic425]

Related to #184
I've tested my examples with that PHPUnit file.

<?php

declare(strict_types=1);

namespace Behat\Tests\Config;

use Behat\Config\Config;
use Behat\Config\Extension;
use Behat\Config\Filter\TagFilter;
use Behat\Config\Formatter\PrettyFormatter;
use Behat\Config\Profile;
use Behat\Config\Suite;
use PHPUnit\Framework\TestCase;

final class ExamplesTest extends TestCase
{
    public function testExample1(): void
    {
        $config = (new Config())
            ->withProfile(
                new Profile('default')
            );

        $this->assertEquals([
            'default' => [],
        ], $config->toArray());
    }

    public function testExample2(): void
    {
        $defaultSuite = (new Suite('default'))
            ->withFilter(new TagFilter('@runthisonlyondefault'))
        ;

        $config = (new Config())
            ->withProfile(
                (new Profile('default'))
                    ->withSuite($defaultSuite)
            )
        ;

        $this->assertEquals([
            'default' => [
                'suites' => [
                    'default' => [
                        'filters' => [
                            'tags' => '@runthisonlyondefault'
                        ],
                    ],
                ],
            ],
        ], $config->toArray());
    }

    public function testExample3(): void
    {
        $defaultSuite = (new Suite('default'))
            ->withFilter(new TagFilter('@runthisonlyondefault'))
        ;

        $profile1DefaultSuite = (new Suite('default'))
            ->withFilter(new TagFilter('@runthisonlyonprofile1'))
        ;

        $config = (new Config())
            ->withProfile(
                (new Profile('default'))
                    ->withSuite($defaultSuite)
            )
            ->withProfile(
                (new Profile('profile1'))
                    ->withSuite($profile1DefaultSuite)
            )
        ;

        $this->assertEquals([
            'default' => [
                'suites' => [
                    'default' => [
                        'filters' => [
                            'tags' => '@runthisonlyondefault'
                        ],
                    ],
                ],
            ],
            'profile1' => [
                'suites' => [
                    'default' => [
                        'filters' => [
                            'tags' => '@runthisonlyonprofile1'
                        ],
                    ],
                ],
            ],
        ], $config->toArray());
    }

    public function testExample4(): void
    {
        $defaultSuite = (new Suite('default'))
            ->withFilter(new TagFilter('@runthisonlyondefault'))
        ;

        $profile1DefaultSuite = new Suite('default', ['filters' => null]);

        $config = (new Config())
            ->withProfile(
                (new Profile('default'))
                    ->withSuite($defaultSuite)
            )
            ->withProfile(
                (new Profile('profile1'))
                    ->withSuite($profile1DefaultSuite)
            )
        ;

        $this->assertEquals([
            'default' => [
                'suites' => [
                    'default' => [
                        'filters' => [
                            'tags' => '@runthisonlyondefault'
                        ],
                    ],
                ],
            ],
            'profile1' => [
                'suites' => [
                    'default' => [
                        'filters' => null,
                    ],
                ],
            ],
        ], $config->toArray());
    }

    public function testImportingConfig(): void
    {
        $config = (new Config())
            ->import([
                'config/base.behat.php',
                'config/ci.behat.php',
            ])
        ;

        $this->assertEquals([
            'imports' => [
                'config/base.behat.php',
                'config/ci.behat.php',
            ],
        ], $config->toArray());
    }

    public function testGlobalConfigurationExample1(): void
    {
        $config = (new Config())
            ->withProfile(
                new Profile('default', [
                    'testers' => [
                        'stop_on_failure' => false,
                        'strict' => false,
                    ],
                ])
            )
        ;

        $this->assertEquals([
            'default' => [
                'testers' => [
                    'stop_on_failure' => false,
                    'strict' => false,
                ],
            ],
        ], $config->toArray());
    }

    public function testGlobalConfigurationExample2(): void
    {
        $config = (new Config())
            ->withProfile(
                new Profile('default', [
                    'testers' => [
                        'stop_on_failure' => true,
                        'strict' => false,
                    ],
                ])
            )
            ->withProfile(
                new Profile('ci', [
                    'testers' => [
                        'stop_on_failure' => false,
                        'strict' => true,
                    ],
                ])
            )
        ;

        $this->assertEquals([
            'default' => [
                'testers' => [
                    'stop_on_failure' => true,
                    'strict' => false,
                ],
            ],
            'ci' => [
                'testers' => [
                    'stop_on_failure' => false,
                    'strict' => true,
                ],
            ],
        ], $config->toArray());
    }

    public function testGlobalFilters(): void
    {
        $config = (new Config())
            ->withProfile(
                (new Profile('default'))
                    ->withFilter(new TagFilter('~@wip'))
            )
        ;

        $this->assertEquals([
            'default' => [
                'gherkin' => [
                    'filters' => [
                        'tags' => '~@wip',
                    ],
                ],
            ],
        ], $config->toArray());
    }

    public function testCustomAutoloadingExample1(): void
    {
        $config = (new Config())
            ->withProfile(
                (new Profile('default', [
                    'autoload' => [
                        '' => '%paths.base%/app/features/bootstrap',
                    ],
                ]))
            )
        ;

        $this->assertEquals([
            'default' => [
                'autoload' => [
                    '' => '%paths.base%/app/features/bootstrap',
                ],
            ],
        ], $config->toArray());
    }

    public function testCustomAutoloadingExample2(): void
    {
        $defaultProfile = new Profile('default', [
            'autoload' => [
                '' => '%paths.base%/app/features/bootstrap',
            ],
        ]);

        $defaultProfile->withSuite(
            (new Suite('default'))
                ->withContexts('My\Application\Namespace\Bootstrap\FeatureContext')
        );

        $config = (new Config())
            ->withProfile($defaultProfile)
        ;

        $this->assertEquals([
            'default' => [
                'autoload' => [
                    '' => '%paths.base%/app/features/bootstrap',
                ],
                'suites' => [
                    'default' => [
                        'contexts' => ['My\Application\Namespace\Bootstrap\FeatureContext'],
                    ],
                ],
            ],
        ], $config->toArray());
    }

    public function testCustomAutoloadingExample3(): void
    {
        $defaultProfile = (new Profile('default'))
            ->withSuite(
                (new Suite('default'))
                    ->withContexts('My\Application\Namespace\Bootstrap\FeatureContext')
            )
        ;

        $config = (new Config())
            ->withProfile($defaultProfile)
        ;

        $this->assertEquals([
            'default' => [
                'suites' => [
                    'default' => [
                        'contexts' => ['My\Application\Namespace\Bootstrap\FeatureContext'],
                    ],
                ],
            ],
        ], $config->toArray());
    }

    public function testFormatters(): void
    {
        $config = (new Config())
            ->withProfile(
                (new Profile('default'))
                    ->withFormatter(
                        new PrettyFormatter()
                    )
            )
        ;

        $this->assertEquals([
            'default' => [
                'formatters' => [
                    'pretty' => [
                        'timer' => true,
                        'expand' => false,
                        'paths' => true,
                        'multiline' => true,
                    ],
                ],
            ],
        ], $config->toArray());
    }

    public function testExtensions(): void
    {
        $config = (new Config())
            ->withProfile(
                (new Profile('default'))
                    ->withExtension(
                        new Extension('Behat\MinkExtension', [
                            'base_url' => 'http://www.example.com',
                            'selenium2' => '~',
                        ])
                    )
            )
        ;

        $this->assertEquals([
            'default' => [
                'extensions' => [
                    'Behat\MinkExtension' => [
                        'base_url' => 'http://www.example.com',
                        'selenium2' => '~',
                    ],
                ],
            ],
        ], $config->toArray());
    }
}

[loic425]

@acoulton @carlos-granados I'm wondering if it would be interesting to add this PHPUnit file in the Behat codebase. WDYT?

[carlos-granados]

Looking good, just a small comment

[carlos-granados]

In the previous example there was a line with #... indicating where you would add additional configuration, maybe we could do the same here with a //... line after the new Profile line

[loic425]

done :)

[acoulton]

Great, thanks @loic425

[acoulton]

Actually, shouldn't this be null rather than the '~' string?

[stof]

it should. An unquoted ~ in Yaml is a null value.

[loic425]

Yes, I think so too. I'm gonna change that.

[loic425]

done

[acoulton]

Just need to review the selenium ~/ null setting

[acoulton]

@acoulton @carlos-granados I'm wondering if it would be interesting to add this PHPUnit file in the Behat codebase. WDYT?

It wouldn't hurt to add more unit test coverage for the php config, but this looks like it overlaps a bit with some of the tests that are already there at https://github.com/Behat/Behat/tree/master/tests/Behat/Tests/Config ? Unless I'm misunderstanding?

[acoulton]

Thanks @loic425