BulkTextExportTest.php

<?php
/*
 SPDX-FileCopyrightText: © 2026 Siemens AG
 
 SPDX-License-Identifier: GPL-2.0-only
*/
 
namespace Fossology\Lib\Application;
 
use Fossology\Lib\Db\DbManager;
use Mockery as M;
 
class BulkTextExportTest extends \PHPUnit\Framework\TestCase
{
  private $assertCountBefore;
 
  protected function setUp() : void
  {
    $this->assertCountBefore = \Hamcrest\MatcherAssert::getCount();
  }
 
  protected function tearDown() : void
  {
    $this->addToAssertionCount(\Hamcrest\MatcherAssert::getCount() - $this->assertCountBefore);
    M::close();
  }
 
  public function testExportBulkTextCsvEscapesDelimiterAndNewlineInText()
  {
    $dbManager = M::mock(DbManager::class);
    $dbManager->shouldReceive('getRows')->once()->withAnyArgs()->andReturn(array(
      array(
        'rf_text' => "hello, world\nsecond line",
        'rf_shortname' => 'MIT',
        'removing' => 'f',
        'comment' => null,
        'reportinfo' => null,
        'acknowledgement' => null,
        'rf_active' => 't'
      )
    ));
 
    $bulkTextExport = new BulkTextExport($dbManager);
    $csv = $bulkTextExport->exportBulkText();
 
    $handle = fopen('php://temp', 'r+');
    fwrite($handle, $csv);
    rewind($handle);
 
    $rows = array();
    while (($row = fgetcsv($handle, 0, ',', '"')) !== false) {
      $rows[] = $row;
    }
    fclose($handle);
 
    $this->assertCount(2, $rows);
    $this->assertSame("\xEF\xBB\xBFText", $rows[0][0]);
    $this->assertSame('hello, world\\nsecond line', $rows[1][0]);
    $this->assertSame('MIT', $rows[1][2]);
    $this->assertSame(2, substr_count($csv, "\n"));
  }
 
  public function testSetDelimiterRejectsEmptyValue()
  {
    $dbManager = M::mock(DbManager::class);
    $bulkTextExport = new BulkTextExport($dbManager);
 
    $this->expectException(\InvalidArgumentException::class);
    $bulkTextExport->setDelimiter('');
  }
 
  public function testSetEnclosureRejectsSameValueAsDelimiter()
  {
    $dbManager = M::mock(DbManager::class);
    $bulkTextExport = new BulkTextExport($dbManager);
 
    $this->expectException(\InvalidArgumentException::class);
    $bulkTextExport->setEnclosure(',');
  }
 
  public function testExportBulkTextCsvIncludesLicenseText()
  {
    $dbManager = M::mock(DbManager::class);
    $dbManager->shouldReceive('getRows')->once()->withAnyArgs()->andReturn(array(
      array(
        'rf_text' => "some bulk text",
        'rf_shortname' => 'MIT',
        'removing' => 'f',
        'comment' => null,
        'reportinfo' => null,
        'acknowledgement' => null,
        'rf_active' => 't',
        'license_text' => 'Permission is hereby granted, free of charge...'
      ),
      array(
        'rf_text' => "some bulk text",
        'rf_shortname' => 'Apache-2.0',
        'removing' => 't',
        'comment' => null,
        'reportinfo' => null,
        'acknowledgement' => null,
        'rf_active' => 't',
        'license_text' => 'Apache License Version 2.0...'
      )
    ));
 
    $bulkTextExport = new BulkTextExport($dbManager);
    $csv = $bulkTextExport->exportBulkText(0, 0, false, true);
 
    $handle = fopen('php://temp', 'r+');
    fwrite($handle, $csv);
    rewind($handle);
 
    $rows = array();
    while (($row = fgetcsv($handle, 0, ',', '"')) !== false) {
      $rows[] = $row;
    }
    fclose($handle);
 
    // header + one row per license sharing "some bulk text": MIT, then Apache-2.0
    $this->assertCount(3, $rows);
    $this->assertSame('license_ref_text', $rows[0][7]);
    $this->assertSame('MIT', $rows[1][2]);
    $this->assertSame('Apache-2.0', $rows[2][2]);
    $this->assertStringContainsString('Permission is hereby granted', $rows[1][7]);
    $this->assertStringNotContainsString('Apache License', $rows[1][7]);
    $this->assertStringContainsString('Apache License', $rows[2][7]);
  }
 
  public function testExportBulkTextCsvExcludesLicenseTextByDefault()
  {
    $dbManager = M::mock(DbManager::class);
    $dbManager->shouldReceive('getRows')->once()->withAnyArgs()->andReturn(array(
      array(
        'rf_text' => "some text",
        'rf_shortname' => 'MIT',
        'removing' => 'f',
        'comment' => null,
        'reportinfo' => null,
        'acknowledgement' => null,
        'rf_active' => 't'
      )
    ));
 
    $bulkTextExport = new BulkTextExport($dbManager);
    $csv = $bulkTextExport->exportBulkText();
 
    $handle = fopen('php://temp', 'r+');
    fwrite($handle, $csv);
    rewind($handle);
 
    $rows = array();
    while (($row = fgetcsv($handle, 0, ',', '"')) !== false) {
      $rows[] = $row;
    }
    fclose($handle);
 
    $this->assertCount(2, $rows);
    $this->assertCount(7, $rows[0]);
    $this->assertSame('License Text', $rows[0][5]);
  }
}