app/bundles/ReportBundle/Tests/Scheduler/Model/FileHandlerTest.php

<?php

declare(strict_types=1);

namespace Mautic\ReportBundle\Tests\Scheduler\Model;

use Mautic\CoreBundle\Helper\CoreParametersHelper;
use Mautic\CoreBundle\Helper\FilePathResolver;
use Mautic\CoreBundle\Helper\FileProperties;
use Mautic\ReportBundle\Entity\Report;
use Mautic\ReportBundle\Exception\FileTooBigException;
use Mautic\ReportBundle\Scheduler\Model\FileHandler;
use PHPUnit\Framework\MockObject\MockObject;

class FileHandlerTest extends \PHPUnit\Framework\TestCase
{
    /**
     * @var MockObject|FilePathResolver
     */
    private MockObject $filePathResolver;

    /**
     * @var MockObject|FileProperties
     */
    private MockObject $fileProperties;

    /**
     * @var MockObject|CoreParametersHelper
     */
    private MockObject $coreParametersHelper;

    private FileHandler $fileHandler;

    protected function setUp(): void
    {
        $this->filePathResolver     = $this->createMock(FilePathResolver::class);
        $this->fileProperties       = $this->createMock(FileProperties::class);
        $this->coreParametersHelper = $this->createMock(CoreParametersHelper::class);
        $this->fileHandler          = new FileHandler(
            $this->filePathResolver,
            $this->fileProperties,
            $this->coreParametersHelper
        );
    }

    public function testFileCanBeAttachedIfTrue(): void
    {
        $filePath  = 'file/path.csv';
        $fileSize  = 1000;
        $fileLimit = 5000;

        $this->fileProperties->expects($this->once())
            ->method('getFileSize')
            ->with($filePath)
            ->willReturn($fileSize);

        $this->coreParametersHelper->expects($this->once())
            ->method('get')
            ->with('report_export_max_filesize_in_bytes')
            ->willReturn($fileLimit);

        $this->fileHandler->fileCanBeAttached($filePath);
    }

    public function testFileCanBeAttachedIfFalse(): void
    {
        $filePath  = 'file/path.csv';
        $fileSize  = 10000;
        $fileLimit = 5000;

        $this->fileProperties->expects($this->once())
            ->method('getFileSize')
            ->with($filePath)
            ->willReturn($fileSize);

        $this->coreParametersHelper->expects($this->once())
            ->method('get')
            ->with('report_export_max_filesize_in_bytes')
            ->willReturn($fileLimit);

        $this->expectException(FileTooBigException::class);

        $this->fileHandler->fileCanBeAttached($filePath);
    }

    public function testZipIt(): void
    {
        $tmpFilePath    = $this->createTmpFile();
        $tmpZipFilePath = $this->fileHandler->zipIt($tmpFilePath);

        $this->assertFileExists($tmpZipFilePath);

        unlink($tmpFilePath);
        unlink($tmpZipFilePath);
    }

    public function testGetPathToCompressedCsvFileForReport(): void
    {
        $report = $this->createMock(Report::class);

        $report->expects($this->once())
            ->method('getId')
            ->willReturn(33);

        $this->coreParametersHelper->expects($this->once())
            ->method('get')
            ->with('report_temp_dir')
            ->willReturn('/some/path');

        $filePath = $this->fileHandler->getPathToCompressedCsvFileForReport($report);

        $this->assertSame('/some/path/csv_reports/report_33.zip', $filePath);
    }

    public function testMoveZipToPermanentLocation(): void
    {
        $report   = $this->createMock(Report::class);
        $filePath = 'file/path.csv';

        $report->expects($this->once())
            ->method('getId')
            ->willReturn(33);

        $this->coreParametersHelper->expects($this->once())
            ->method('get')
            ->with('report_temp_dir')
            ->willReturn('/some/path');

        $this->filePathResolver->expects($this->once())
            ->method('delete')
            ->with('/some/path/csv_reports/report_33.zip');

        $this->filePathResolver->expects($this->once())
            ->method('createDirectory')
            ->with('/some/path/csv_reports');

        $this->filePathResolver->expects($this->once())
            ->method('move')
            ->with($filePath, '/some/path/csv_reports/report_33.zip');

        $this->fileHandler->moveZipToPermanentLocation($report, $filePath);
    }

    public function testDeleteCompressedCsvFileForReportId(): void
    {
        $reportId   = 33;
        $tempDir    = sys_get_temp_dir();
        $reportsDir = $tempDir.'/csv_reports';
        $fileName   = "report_{$reportId}.zip";
        $filePath   = $reportsDir.'/'.$fileName;

        if (!file_exists($reportsDir)) {
            mkdir($reportsDir);
        }

        $this->createTmpFile('csv_reports/'.$fileName);

        $this->coreParametersHelper->expects($this->once())
            ->method('get')
            ->with('report_temp_dir')
            ->willReturn($tempDir);

        $this->filePathResolver->expects($this->once())
            ->method('delete')
            ->with($filePath);

        $this->fileHandler->deleteCompressedCsvFileForReportId($reportId);

        unlink($filePath);
        rmdir($reportsDir);
    }

    private function createTmpFile(string $name = 'test.csv', string $content = ''): string
    {
        $filePath = sys_get_temp_dir().'/'.$name;
        file_put_contents($filePath, $content);

        return $filePath;
    }
}