FilterDateTest.php

<?php

namespace Drupal\Tests\views\Functional\Handler;

use Drupal\field\Entity\FieldConfig;
use Drupal\field\Entity\FieldStorageConfig;
use Drupal\node\Entity\NodeType;
use Drupal\Tests\SchemaCheckTestTrait;
use Drupal\Tests\views\Functional\ViewTestBase;
use Drupal\views\Views;

/**
 * Tests the core Drupal\views\Plugin\views\filter\Date handler.
 *
 * @group views
 */
class FilterDateTest extends ViewTestBase {
    use SchemaCheckTestTrait;
    
    /**
     * Views used by this test.
     *
     * @var array
     */
    public static $testViews = [
        'test_filter_date_between',
    ];
    
    /**
     * Modules to enable.
     *
     * @var array
     */
    protected static $modules = [
        'node',
        'views_ui',
        'datetime',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'starterkit_theme';
    
    /**
     * The date formatter.
     *
     * @var \Drupal\Core\Datetime\DateFormatterInterface
     */
    public $dateFormatter;
    
    /**
     * @var array
     */
    protected $nodes;
    
    /**
     * @var array
     */
    protected $map;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp($import_test_views = TRUE, $modules = [
        'views_test_config',
    ]) : void {
        parent::setUp($import_test_views, $modules);
        $this->dateFormatter = $this->container
            ->get('date.formatter');
        // Add a date field so we can test datetime handling.
        NodeType::create([
            'type' => 'page',
            'name' => 'Page',
        ])->save();
        // Setup a field storage and field, but also change the views data for the
        // entity_test entity type.
        $field_storage = FieldStorageConfig::create([
            'field_name' => 'field_date',
            'type' => 'datetime',
            'entity_type' => 'node',
        ]);
        $field_storage->save();
        $field = FieldConfig::create([
            'field_name' => 'field_date',
            'entity_type' => 'node',
            'bundle' => 'page',
        ]);
        $field->save();
        // Add some basic test nodes.
        $this->nodes = [];
        $this->nodes[] = $this->drupalCreateNode([
            'created' => 100000,
            'field_date' => 10000,
        ]);
        $this->nodes[] = $this->drupalCreateNode([
            'created' => 200000,
            'field_date' => 20000,
        ]);
        $this->nodes[] = $this->drupalCreateNode([
            'created' => 300000,
            'field_date' => 30000,
        ]);
        $this->nodes[] = $this->drupalCreateNode([
            'created' => time() + 86400,
            'field_date' => time() + 86400,
        ]);
        $this->map = [
            'nid' => 'nid',
        ];
    }
    
    /**
     * Runs other test methods.
     */
    public function testDateFilter() {
        $this->_testOffset();
        $this->_testBetween();
        $this->_testUiValidation();
        $this->_testFilterDateUI();
        $this->_testFilterDatetimeUI();
    }
    
    /**
     * Tests the general offset functionality.
     */
    protected function _testOffset() {
        $view = Views::getView('test_filter_date_between');
        // Test offset for simple operator.
        $view->initHandlers();
        $view->filter['created']->operator = '>';
        $view->filter['created']->value['type'] = 'offset';
        $view->filter['created']->value['value'] = '+1 hour';
        $view->executeDisplay('default');
        $expected_result = [
            [
                'nid' => $this->nodes[3]
                    ->id(),
            ],
        ];
        $this->assertIdenticalResultset($view, $expected_result, $this->map);
        $view->destroy();
        // Test offset for between operator.
        $view->initHandlers();
        $view->filter['created']->operator = 'between';
        $view->filter['created']->value['type'] = 'offset';
        $view->filter['created']->value['max'] = '+2 days';
        $view->filter['created']->value['min'] = '+1 hour';
        $view->executeDisplay('default');
        $expected_result = [
            [
                'nid' => $this->nodes[3]
                    ->id(),
            ],
        ];
        $this->assertIdenticalResultset($view, $expected_result, $this->map);
    }
    
    /**
     * Tests the filter operator between/not between.
     */
    protected function _testBetween() {
        $view = Views::getView('test_filter_date_between');
        // Test between with min and max.
        $view->initHandlers();
        $view->filter['created']->operator = 'between';
        $view->filter['created']->value['min'] = $this->dateFormatter
            ->format(150000, 'custom', 'Y-m-d H:i:s');
        $view->filter['created']->value['max'] = $this->dateFormatter
            ->format(200000, 'custom', 'Y-m-d H:i:s');
        $view->executeDisplay('default');
        $expected_result = [
            [
                'nid' => $this->nodes[1]
                    ->id(),
            ],
        ];
        $this->assertIdenticalResultset($view, $expected_result, $this->map);
        $view->destroy();
        // Test between with just max.
        $view->initHandlers();
        $view->filter['created']->operator = 'between';
        $view->filter['created']->value['max'] = $this->dateFormatter
            ->format(200000, 'custom', 'Y-m-d H:i:s');
        $view->executeDisplay('default');
        $expected_result = [
            [
                'nid' => $this->nodes[0]
                    ->id(),
            ],
            [
                'nid' => $this->nodes[1]
                    ->id(),
            ],
        ];
        $this->assertIdenticalResultset($view, $expected_result, $this->map);
        $view->destroy();
        // Test not between with min and max.
        $view->initHandlers();
        $view->filter['created']->operator = 'not between';
        $view->filter['created']->value['min'] = $this->dateFormatter
            ->format(100000, 'custom', 'Y-m-d H:i:s');
        $view->filter['created']->value['max'] = $this->dateFormatter
            ->format(200000, 'custom', 'Y-m-d H:i:s');
        $view->executeDisplay('default');
        $expected_result = [
            [
                'nid' => $this->nodes[2]
                    ->id(),
            ],
            [
                'nid' => $this->nodes[3]
                    ->id(),
            ],
        ];
        $this->assertIdenticalResultset($view, $expected_result, $this->map);
        $view->destroy();
        // Test not between with just max.
        $view->initHandlers();
        $view->filter['created']->operator = 'not between';
        $view->filter['created']->value['max'] = $this->dateFormatter
            ->format(200000, 'custom', 'Y-m-d H:i:s');
        $view->executeDisplay('default');
        $expected_result = [
            [
                'nid' => $this->nodes[2]
                    ->id(),
            ],
            [
                'nid' => $this->nodes[3]
                    ->id(),
            ],
        ];
        $this->assertIdenticalResultset($view, $expected_result, $this->map);
    }
    
    /**
     * Make sure the validation callbacks works.
     */
    protected function _testUiValidation() {
        $this->drupalLogin($this->drupalCreateUser([
            'administer views',
            'administer site configuration',
        ]));
        $this->drupalGet('admin/structure/views/view/test_filter_date_between/edit');
        $this->drupalGet('admin/structure/views/nojs/handler/test_filter_date_between/default/filter/created');
        $edit = [];
        // Generate a definitive wrong value, which should be checked by validation.
        $edit['options[value][value]'] = $this->randomString() . '-------';
        $this->submitForm($edit, 'Apply');
        $this->assertSession()
            ->pageTextContains('Invalid date format.');
    }
    
    /**
     * Tests date filter UI.
     */
    protected function _testFilterDateUI() {
        $this->drupalLogin($this->drupalCreateUser([
            'administer views',
        ]));
        $this->drupalGet('admin/structure/views/nojs/handler/test_filter_date_between/default/filter/created');
        $this->submitForm([], 'Expose filter');
        $this->submitForm([], 'Grouped filters');
        $edit = [];
        $edit['options[group_info][group_items][1][title]'] = 'simple-offset';
        $edit['options[group_info][group_items][1][operator]'] = '>';
        $edit['options[group_info][group_items][1][value][type]'] = 'offset';
        $edit['options[group_info][group_items][1][value][value]'] = '+1 hour';
        $edit['options[group_info][group_items][2][title]'] = 'between-offset';
        $edit['options[group_info][group_items][2][operator]'] = 'between';
        $edit['options[group_info][group_items][2][value][type]'] = 'offset';
        $edit['options[group_info][group_items][2][value][min]'] = '+1 hour';
        $edit['options[group_info][group_items][2][value][max]'] = '+2 days';
        $edit['options[group_info][group_items][3][title]'] = 'between-date';
        $edit['options[group_info][group_items][3][operator]'] = 'between';
        $edit['options[group_info][group_items][3][value][min]'] = $this->dateFormatter
            ->format(150000, 'custom', 'Y-m-d H:i:s');
        $edit['options[group_info][group_items][3][value][max]'] = $this->dateFormatter
            ->format(250000, 'custom', 'Y-m-d H:i:s');
        $this->submitForm($edit, 'Apply');
        $this->drupalGet('admin/structure/views/nojs/handler/test_filter_date_between/default/filter/created');
        foreach ($edit as $name => $value) {
            $this->assertSession()
                ->fieldValueEquals($name, $value);
            if (strpos($name, '[value][type]')) {
                $radio = $this->cssSelect('input[name="' . $name . '"][checked="checked"][type="radio"]');
                $this->assertEquals($value, $radio[0]->getAttribute('value'));
            }
        }
        $this->drupalGet('admin/structure/views/view/test_filter_date_between');
        $this->submitForm([], 'Save');
        $this->assertConfigSchemaByName('views.view.test_filter_date_between');
        // Test that the exposed filter works as expected.
        $path = 'test_filter_date_between-path';
        $this->drupalGet('admin/structure/views/view/test_filter_date_between/edit');
        $this->submitForm([], 'Add Page');
        $this->drupalGet('admin/structure/views/nojs/display/test_filter_date_between/page_1/path');
        $this->submitForm([
            'path' => $path,
        ], 'Apply');
        $this->submitForm([], 'Save');
        $this->drupalGet($path);
        $this->submitForm([], 'Apply');
        $results = $this->cssSelect('.view-content .field-content');
        $this->assertCount(4, $results);
        $this->submitForm([
            'created' => '1',
        ], 'Apply');
        $results = $this->cssSelect('.view-content .field-content');
        $this->assertCount(1, $results);
        $this->assertEquals($this->nodes[3]
            ->id(), $results[0]->getText());
        $this->submitForm([
            'created' => '2',
        ], 'Apply');
        $results = $this->cssSelect('.view-content .field-content');
        $this->assertCount(1, $results);
        $this->assertEquals($this->nodes[3]
            ->id(), $results[0]->getText());
        $this->submitForm([
            'created' => '3',
        ], 'Apply');
        $results = $this->cssSelect('.view-content .field-content');
        $this->assertCount(1, $results);
        $this->assertEquals($this->nodes[1]
            ->id(), $results[0]->getText());
        // Change the filter to a single filter to test the schema when the operator
        // is not exposed.
        $this->drupalGet('admin/structure/views/nojs/handler/test_filter_date_between/default/filter/created');
        $this->submitForm([], 'Single filter');
        $edit = [];
        $edit['options[operator]'] = '>';
        $edit['options[value][type]'] = 'date';
        $edit['options[value][value]'] = $this->dateFormatter
            ->format(350000, 'custom', 'Y-m-d H:i:s');
        $this->submitForm($edit, 'Apply');
        $this->drupalGet('admin/structure/views/view/test_filter_date_between');
        $this->submitForm([], 'Save');
        $this->assertConfigSchemaByName('views.view.test_filter_date_between');
        // Test that the filter works as expected.
        $this->drupalGet($path);
        $results = $this->cssSelect('.view-content .field-content');
        $this->assertCount(1, $results);
        $this->assertEquals($this->nodes[3]
            ->id(), $results[0]->getText());
        $this->submitForm([
            'created' => $this->dateFormatter
                ->format(250000, 'custom', 'Y-m-d H:i:s'),
        ], 'Apply');
        $results = $this->cssSelect('.view-content .field-content');
        $this->assertCount(2, $results);
        $this->assertEquals($this->nodes[2]
            ->id(), $results[0]->getText());
        $this->assertEquals($this->nodes[3]
            ->id(), $results[1]->getText());
    }
    
    /**
     * Tests datetime grouped filter UI.
     */
    protected function _testFilterDatetimeUI() {
        $this->drupalLogin($this->drupalCreateUser([
            'administer views',
        ]));
        $this->drupalGet('admin/structure/views/nojs/add-handler/test_filter_date_between/default/filter');
        $this->submitForm([
            'name[node__field_date.field_date_value]' => 'node__field_date.field_date_value',
        ], 'Add and configure filter criteria');
        $this->submitForm([], 'Expose filter');
        $this->submitForm([], 'Grouped filters');
        $edit = [];
        $edit['options[group_info][group_items][1][title]'] = 'simple-offset';
        $edit['options[group_info][group_items][1][operator]'] = '>';
        $edit['options[group_info][group_items][1][value][type]'] = 'offset';
        $edit['options[group_info][group_items][1][value][value]'] = '+1 hour';
        $edit['options[group_info][group_items][2][title]'] = 'between-offset';
        $edit['options[group_info][group_items][2][operator]'] = 'between';
        $edit['options[group_info][group_items][2][value][type]'] = 'offset';
        $edit['options[group_info][group_items][2][value][min]'] = '+1 hour';
        $edit['options[group_info][group_items][2][value][max]'] = '+2 days';
        $edit['options[group_info][group_items][3][title]'] = 'between-date';
        $edit['options[group_info][group_items][3][operator]'] = 'between';
        $edit['options[group_info][group_items][3][value][min]'] = $this->dateFormatter
            ->format(150000, 'custom', 'Y-m-d H:i:s');
        $edit['options[group_info][group_items][3][value][max]'] = $this->dateFormatter
            ->format(250000, 'custom', 'Y-m-d H:i:s');
        $this->submitForm($edit, 'Apply');
        $this->drupalGet('admin/structure/views/view/test_filter_date_between');
        $this->submitForm([], 'Save');
        $this->assertConfigSchemaByName('views.view.test_filter_date_between');
    }
    
    /**
     * Tests that the exposed date filter is displayed without errors.
     */
    public function testExposedFilter() {
        $this->drupalLogin($this->drupalCreateUser([
            'administer views',
        ]));
        $this->drupalGet('admin/structure/views/nojs/handler/test_filter_date_between/default/filter/created');
        $this->submitForm([], 'Expose filter');
        $this->drupalGet('admin/structure/views/view/test_filter_date_between/edit');
        $this->submitForm([], 'Add Page');
        $edit = [
            'path' => 'exposed-date-filter',
        ];
        $this->drupalGet('admin/structure/views/nojs/display/test_filter_date_between/page_1/path');
        $this->submitForm($edit, 'Apply');
        $this->submitForm([], 'Save');
        $this->drupalGet('exposed-date-filter');
        $this->assertSession()
            ->fieldExists('created');
    }

}