data_pipelines-1.x-dev/tests/src/Kernel/DatasetSource/CsvDelimiterTest.php

<?php

declare(strict_types=1);

namespace Drupal\Tests\data_pipelines\Kernel\DatasetSource;

use Drupal\Tests\data_pipelines\Kernel\DatasetKernelTestBase;
use Drupal\data_pipelines\DatasetData;
use Drupal\data_pipelines\Entity\Dataset;
use Drupal\data_pipelines\Source\DatasetSourceInterface;
use Drupal\data_pipelines\Source\DatasetSourcePluginManager;

/**
 * Defines a test for the CsvFile dataset source with difference delimiters.
 *
 * @group data_pipelines
 *
 * @covers \Drupal\data_pipelines\Plugin\DatasetSource\CsvSource
 * @covers \Drupal\data_pipelines\Source\Resource\File
 * @covers \Drupal\data_pipelines\Source\DatasetSourcePluginManager
 */
class CsvDelimiterTest extends DatasetKernelTestBase {

  /**
   * Tests extracting data from CSV files with difference delimiters.
   *
   * @dataProvider extractDataFromDataSetProvider
   */
  public function testExtractDataFromDataSet(string $csv_file, string $delimiter) {
    $file = $this->getTestFile(dirname(__DIR__, 2) . '/fixtures/' . $csv_file);
    $manager = \Drupal::service('plugin.manager.data_pipelines_source');
    assert($manager instanceof DatasetSourcePluginManager);
    $instance = $manager->createInstance('csv:file');
    assert($instance instanceof DatasetSourceInterface);
    $dataset = Dataset::create([
      'source' => 'csv:file',
      'pipeline' => 'test_pipeline_1',
      'name' => $this->randomMachineName(),
      'machine_name' => mb_strtolower($this->randomMachineName()),
      'csv_file' => $file,
      'csv_delimiter' => $delimiter,
    ]);
    $data = iterator_to_array($instance->extractDataFromDataSet($dataset));
    $this->assertEquals([
      new DatasetData([
        'should_we' => 'Y',
        'firstname' => 'joe',
        'lastname' => 'bloggs',
      ]),
      new DatasetData([
        'should_we' => 'N',
        'firstname' => 'betty',
        'lastname' => 'bloggs',
      ]),
    ], $data);
  }

  /**
   * A method that acts as a data provider.
   *
   * @return array[]
   *   The data provider.
   */
  public static function extractDataFromDataSetProvider() {
    return [
      'comma' => [
        'file' => 'test-pipeline-delimiter-comma.csv',
        'delimiter' => 'comma',
      ],
      'semicolon' => [
        'file' => 'test-pipeline-delimiter-semicolon.csv',
        'delimiter' => 'semicolon',
      ],
      'tab' => [
        'file' => 'test-pipeline-delimiter-tab.csv',
        'delimiter' => 'tab',
      ],
      'pipe' => [
        'file' => 'test-pipeline-delimiter-pipe.csv',
        'delimiter' => 'pipe',
      ],
      'colon' => [
        'file' => 'test-pipeline-delimiter-colon.csv',
        'delimiter' => 'colon',
      ],
    ];
  }

}