40ee386edd
Removed the `ReaderEntityFactory::createReader(Type)` method and replaced it by 3 methods: - `ReaderEntityFactory::createCSVReader()` - `ReaderEntityFactory::createXLSXReader()` - `ReaderEntityFactory::createODSReader()` This has the advantage of enabling autocomplete in the IDE, as the return type is no longer the interface but the concrete type. Since readers may expose different options, this is pretty useful. Similarly, removed the `WriterEntityFactory::createWriter(Type)` method and replaced it by 3 methods: - `WriterEntityFactory::createCSVWriter()` - `WriterEntityFactory::createXLSXWriter()` - `WriterEntityFactory::createODSWriter()` Since this is a breaking change, I also updated the Upgrade guide. Finally, the doc is up to date too.
99 lines
3.4 KiB
PHP
99 lines
3.4 KiB
PHP
<?php
|
|
|
|
namespace Box\Spout\Writer\ODS;
|
|
|
|
use Box\Spout\TestUsingResource;
|
|
use Box\Spout\Writer\Common\Creator\WriterEntityFactory;
|
|
use PHPUnit\Framework\TestCase;
|
|
|
|
/**
|
|
* Class WriterPerfTest
|
|
* Performance tests for ODS Writer
|
|
*/
|
|
class WriterPerfTest extends TestCase
|
|
{
|
|
use TestUsingResource;
|
|
|
|
/**
|
|
* 1 million rows (each row containing 3 cells) should be written
|
|
* in less than 4 minutes and the execution should not require
|
|
* more than 3MB of memory
|
|
*
|
|
* @group perf-tests
|
|
*
|
|
* @return void
|
|
*/
|
|
public function testPerfWhenWritingOneMillionRowsODS()
|
|
{
|
|
// getting current memory peak to avoid taking into account the memory used by PHPUnit
|
|
$beforeMemoryPeakUsage = memory_get_peak_usage(true);
|
|
|
|
$numRows = 1000000;
|
|
$expectedMaxExecutionTime = 240; // 4 minutes in seconds
|
|
$expectedMaxMemoryPeakUsage = 3 * 1024 * 1024; // 3MB in bytes
|
|
$startTime = time();
|
|
|
|
$fileName = 'ods_with_one_million_rows.ods';
|
|
$this->createGeneratedFolderIfNeeded($fileName);
|
|
$resourcePath = $this->getGeneratedResourcePath($fileName);
|
|
|
|
$writer = WriterEntityFactory::createODSWriter();
|
|
$writer->setShouldCreateNewSheetsAutomatically(true);
|
|
|
|
$writer->openToFile($resourcePath);
|
|
|
|
for ($i = 1; $i <= $numRows; $i++) {
|
|
$writer->addRow(WriterEntityFactory::createRowFromArray(["ods--{$i}-1", "ods--{$i}-2", "ods--{$i}-3"]));
|
|
}
|
|
|
|
$writer->close();
|
|
|
|
$this->assertEquals($numRows, $this->getNumWrittenRows($resourcePath), "The created ODS ($fileName) should contain $numRows rows");
|
|
|
|
$executionTime = time() - $startTime;
|
|
$this->assertTrue($executionTime < $expectedMaxExecutionTime, "Writing 1 million rows should take less than $expectedMaxExecutionTime seconds (took $executionTime seconds)");
|
|
|
|
$memoryPeakUsage = memory_get_peak_usage(true) - $beforeMemoryPeakUsage;
|
|
$this->assertTrue($memoryPeakUsage < $expectedMaxMemoryPeakUsage, 'Writing 1 million rows should require less than ' . ($expectedMaxMemoryPeakUsage / 1024 / 1024) . ' MB of memory (required ' . ($memoryPeakUsage / 1024 / 1024) . ' MB)');
|
|
}
|
|
|
|
/**
|
|
* @param string $resourcePath
|
|
* @return int
|
|
*/
|
|
private function getNumWrittenRows($resourcePath)
|
|
{
|
|
$numWrittenRows = 0;
|
|
// to avoid executing the regex of the entire file to get the last row number, we only retrieve the last 10 lines
|
|
$endingContentXmlContents = $this->getLastCharactersOfContentXmlFile($resourcePath);
|
|
|
|
if (preg_match_all('/<text:p>ods--(\d+)-\d<\/text:p>/', $endingContentXmlContents, $matches)) {
|
|
$lastMatch = array_pop($matches);
|
|
$numWrittenRows = (int) (array_pop($lastMatch));
|
|
}
|
|
|
|
return $numWrittenRows;
|
|
}
|
|
|
|
/**
|
|
* @param string $resourcePath
|
|
* @return string
|
|
*/
|
|
private function getLastCharactersOfContentXmlFile($resourcePath)
|
|
{
|
|
$pathToContentXmlFile = 'zip://' . $resourcePath . '#content.xml';
|
|
|
|
// since we cannot execute "tail" on a file inside a zip, we need to copy it outside first
|
|
$tmpFile = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'get_last_characters.xml';
|
|
copy($pathToContentXmlFile, $tmpFile);
|
|
|
|
// Get the last 200 characters
|
|
$lastCharacters = `tail -c 200 $tmpFile`;
|
|
|
|
// remove the temporary file
|
|
unlink($tmpFile);
|
|
|
|
return $lastCharacters;
|
|
}
|
|
}
|