phpmyadmin/test/classes/Plugins/Export/ExportLatexTest.php
Kamil Tekiela f5bb90ebb9 Move queryAsControlUser - Dbal refactoring pt.3
Signed-off-by: Kamil Tekiela <tekiela246@gmail.com>
2022-01-06 19:31:27 +00:00

819 lines
23 KiB
PHP

<?php
declare(strict_types=1);
namespace PhpMyAdmin\Tests\Plugins\Export;
use PhpMyAdmin\ConfigStorage\Relation;
use PhpMyAdmin\ConfigStorage\RelationParameters;
use PhpMyAdmin\DatabaseInterface;
use PhpMyAdmin\Plugins\Export\ExportLatex;
use PhpMyAdmin\Properties\Options\Groups\OptionsPropertyMainGroup;
use PhpMyAdmin\Properties\Options\Groups\OptionsPropertyRootGroup;
use PhpMyAdmin\Properties\Options\Items\BoolPropertyItem;
use PhpMyAdmin\Properties\Options\Items\RadioPropertyItem;
use PhpMyAdmin\Properties\Options\Items\TextPropertyItem;
use PhpMyAdmin\Properties\Plugins\ExportPluginProperties;
use PhpMyAdmin\Tests\AbstractTestCase;
use PhpMyAdmin\Tests\Stubs\DummyResult;
use ReflectionMethod;
use function __;
use function array_shift;
use function ob_get_clean;
use function ob_start;
/**
* @covers \PhpMyAdmin\Plugins\Export\ExportLatex
* @group medium
*/
class ExportLatexTest extends AbstractTestCase
{
/** @var ExportLatex */
protected $object;
/**
* Configures global environment.
*/
protected function setUp(): void
{
parent::setUp();
$GLOBALS['server'] = 0;
$GLOBALS['output_kanji_conversion'] = false;
$GLOBALS['output_charset_conversion'] = false;
$GLOBALS['buffer_needed'] = false;
$GLOBALS['asfile'] = true;
$GLOBALS['save_on_server'] = false;
$GLOBALS['plugin_param'] = [];
$GLOBALS['plugin_param']['export_type'] = 'table';
$GLOBALS['plugin_param']['single_table'] = false;
$GLOBALS['db'] = 'db';
$GLOBALS['table'] = 'table';
$this->object = new ExportLatex();
}
/**
* tearDown for test cases
*/
protected function tearDown(): void
{
parent::tearDown();
unset($this->object);
}
public function testSetProperties(): void
{
$GLOBALS['plugin_param']['export_type'] = '';
$GLOBALS['plugin_param']['single_table'] = false;
$relationParameters = RelationParameters::fromArray([
'db' => 'db',
'relation' => 'relation',
'column_info' => 'column_info',
'relwork' => true,
'mimework' => true,
]);
$_SESSION = ['relation' => [$GLOBALS['server'] => $relationParameters->toArray()]];
$method = new ReflectionMethod(ExportLatex::class, 'setProperties');
$method->setAccessible(true);
$properties = $method->invoke($this->object, null);
$this->assertInstanceOf(ExportPluginProperties::class, $properties);
$this->assertEquals(
'LaTeX',
$properties->getText()
);
$this->assertEquals(
'tex',
$properties->getExtension()
);
$this->assertEquals(
'application/x-tex',
$properties->getMimeType()
);
$this->assertEquals(
'Options',
$properties->getOptionsText()
);
$options = $properties->getOptions();
$this->assertInstanceOf(OptionsPropertyRootGroup::class, $options);
$this->assertEquals(
'Format Specific Options',
$options->getName()
);
$generalOptionsArray = $options->getProperties();
$generalOptions = array_shift($generalOptionsArray);
$this->assertInstanceOf(OptionsPropertyMainGroup::class, $generalOptions);
$this->assertEquals(
'general_opts',
$generalOptions->getName()
);
$generalProperties = $generalOptions->getProperties();
$property = array_shift($generalProperties);
$this->assertInstanceOf(BoolPropertyItem::class, $property);
$this->assertEquals(
'caption',
$property->getName()
);
$this->assertEquals(
'Include table caption',
$property->getText()
);
$generalOptions = array_shift($generalOptionsArray);
$this->assertInstanceOf(OptionsPropertyMainGroup::class, $generalOptions);
$this->assertEquals(
'dump_what',
$generalOptions->getName()
);
$this->assertEquals(
'Dump table',
$generalOptions->getText()
);
$generalProperties = $generalOptions->getProperties();
$property = array_shift($generalProperties);
$this->assertInstanceOf(RadioPropertyItem::class, $property);
$this->assertEquals(
'structure_or_data',
$property->getName()
);
$this->assertEquals(
[
'structure' => __('structure'),
'data' => __('data'),
'structure_and_data' => __('structure and data'),
],
$property->getValues()
);
// hide structure
$generalOptions = array_shift($generalOptionsArray);
$this->assertInstanceOf(OptionsPropertyMainGroup::class, $generalOptions);
$this->assertEquals(
'structure',
$generalOptions->getName()
);
$this->assertEquals(
'Object creation options',
$generalOptions->getText()
);
$this->assertEquals(
'data',
$generalOptions->getForce()
);
$generalProperties = $generalOptions->getProperties();
$property = array_shift($generalProperties);
$this->assertInstanceOf(TextPropertyItem::class, $property);
$this->assertEquals(
'structure_caption',
$property->getName()
);
$this->assertEquals(
'Table caption:',
$property->getText()
);
$this->assertEquals(
'faq6-27',
$property->getDoc()
);
$property = array_shift($generalProperties);
$this->assertInstanceOf(TextPropertyItem::class, $property);
$this->assertEquals(
'structure_continued_caption',
$property->getName()
);
$this->assertEquals(
'Table caption (continued):',
$property->getText()
);
$this->assertEquals(
'faq6-27',
$property->getDoc()
);
$property = array_shift($generalProperties);
$this->assertInstanceOf(TextPropertyItem::class, $property);
$this->assertEquals(
'structure_label',
$property->getName()
);
$this->assertEquals(
'Label key:',
$property->getText()
);
$this->assertEquals(
'faq6-27',
$property->getDoc()
);
$property = array_shift($generalProperties);
$this->assertInstanceOf(BoolPropertyItem::class, $property);
$this->assertEquals(
'relation',
$property->getName()
);
$this->assertEquals(
'Display foreign key relationships',
$property->getText()
);
$property = array_shift($generalProperties);
$this->assertInstanceOf(BoolPropertyItem::class, $property);
$this->assertEquals(
'comments',
$property->getName()
);
$this->assertEquals(
'Display comments',
$property->getText()
);
$property = array_shift($generalProperties);
$this->assertInstanceOf(BoolPropertyItem::class, $property);
$this->assertEquals(
'mime',
$property->getName()
);
$this->assertEquals(
'Display media types',
$property->getText()
);
// data options
$generalOptions = array_shift($generalOptionsArray);
$this->assertInstanceOf(OptionsPropertyMainGroup::class, $generalOptions);
$this->assertEquals(
'data',
$generalOptions->getName()
);
$this->assertEquals(
'Data dump options',
$generalOptions->getText()
);
$this->assertEquals(
'structure',
$generalOptions->getForce()
);
$generalProperties = $generalOptions->getProperties();
$property = array_shift($generalProperties);
$this->assertInstanceOf(BoolPropertyItem::class, $property);
$this->assertEquals(
'columns',
$property->getName()
);
$this->assertEquals(
'Put columns names in the first row:',
$property->getText()
);
$property = array_shift($generalProperties);
$this->assertInstanceOf(TextPropertyItem::class, $property);
$this->assertEquals(
'data_caption',
$property->getName()
);
$this->assertEquals(
'Table caption:',
$property->getText()
);
$this->assertEquals(
'faq6-27',
$property->getDoc()
);
$property = array_shift($generalProperties);
$this->assertInstanceOf(TextPropertyItem::class, $property);
$this->assertEquals(
'data_continued_caption',
$property->getName()
);
$this->assertEquals(
'Table caption (continued):',
$property->getText()
);
$this->assertEquals(
'faq6-27',
$property->getDoc()
);
$property = array_shift($generalProperties);
$this->assertInstanceOf(TextPropertyItem::class, $property);
$this->assertEquals(
'data_label',
$property->getName()
);
$this->assertEquals(
'Label key:',
$property->getText()
);
$this->assertEquals(
'faq6-27',
$property->getDoc()
);
$property = array_shift($generalProperties);
$this->assertInstanceOf(TextPropertyItem::class, $property);
$this->assertEquals(
'null',
$property->getName()
);
$this->assertEquals(
'Replace NULL with:',
$property->getText()
);
// case 2
$GLOBALS['plugin_param']['export_type'] = 'table';
$GLOBALS['plugin_param']['single_table'] = false;
$method->invoke($this->object, null);
$generalOptionsArray = $options->getProperties();
$this->assertCount(4, $generalOptionsArray);
}
public function testExportHeader(): void
{
$GLOBALS['crlf'] = "\n";
$GLOBALS['cfg']['Server']['port'] = 80;
$GLOBALS['cfg']['Server']['host'] = 'localhost';
ob_start();
$this->assertTrue(
$this->object->exportHeader()
);
$result = ob_get_clean();
$this->assertIsString($result);
$this->assertStringContainsString("\n% Host: localhost:80", $result);
}
public function testExportFooter(): void
{
$this->assertTrue(
$this->object->exportFooter()
);
}
public function testExportDBHeader(): void
{
$GLOBALS['crlf'] = "\n";
$this->expectOutputString("% \n% Database: 'testDB'\n% \n");
$this->assertTrue(
$this->object->exportDBHeader('testDB')
);
}
public function testExportDBFooter(): void
{
$this->assertTrue(
$this->object->exportDBFooter('testDB')
);
}
public function testExportDBCreate(): void
{
$this->assertTrue(
$this->object->exportDBCreate('testDB', 'database')
);
}
public function testExportData(): void
{
$GLOBALS['latex_caption'] = true;
$GLOBALS['latex_data_caption'] = 'latex data caption';
$GLOBALS['latex_data_continued_caption'] = 'continued caption';
$GLOBALS['latex_columns'] = true;
$GLOBALS['latex_data_label'] = 'datalabel';
$GLOBALS['latex_null'] = 'null';
$GLOBALS['cfg']['Server']['host'] = 'localhost';
$GLOBALS['cfg']['Server']['verbose'] = 'verb';
ob_start();
$this->assertTrue($this->object->exportData(
'test_db',
'test_table',
"\n",
'localhost',
'SELECT * FROM `test_db`.`test_table`;'
));
$result = ob_get_clean();
$this->assertEquals(
"\n" . '%' . "\n" .
'% Data: test_table' . "\n" .
'%' . "\n" .
' \begin{longtable}{|l|l|l|} ' . "\n" .
' \hline \endhead \hline \endfoot \hline ' . "\n" .
' \caption{latex data caption} \label{datalabel} \\\\\hline \multicolumn{1}{|c|}' .
'{\textbf{id}} & \multicolumn{1}{|c|}{\textbf{name}} & \multicolumn{1}{|c|}' .
'{\textbf{datetimefield}} \\\ \hline \hline \endfirsthead ' . "\n" .
'\caption{continued caption} \\\ \hline \multicolumn{1}{|c|}{\textbf{id}} & \multicolumn{1}' .
'{|c|}{\textbf{name}} & \multicolumn{1}{|c|}{\textbf{datetimefield}}' .
' \\\ \hline \hline \endhead \endfoot' . "\n" .
'1 & abcd & 2011-01-20 02:00:02 \\\\ \hline ' . "\n" .
'2 & foo & 2010-01-20 02:00:02 \\\\ \hline ' . "\n" .
'3 & Abcd & 2012-01-20 02:00:02 \\\\ \hline ' . "\n" .
' \end{longtable}' . "\n",
$result
);
// case 2
unset($GLOBALS['latex_columns']);
ob_start();
$this->assertTrue($this->object->exportData(
'test_db',
'test_table',
"\n",
'localhost',
'SELECT * FROM `test_db`.`test_table`;'
));
$result = ob_get_clean();
$this->assertIsString($result);
$this->assertEquals(
"\n" . '%' . "\n" .
'% Data: test_table' . "\n" .
'%' . "\n" .
' \begin{longtable}{|l|l|l|} ' . "\n" .
' \hline \endhead \hline \endfoot \hline ' . "\n" .
' \caption{latex data caption} \label{datalabel} \\\\\\\\ \hline' .
'1 & abcd & 2011-01-20 02:00:02 \\\\ \hline ' . "\n" .
'2 & foo & 2010-01-20 02:00:02 \\\\ \hline ' . "\n" .
'3 & Abcd & 2012-01-20 02:00:02 \\\\ \hline ' . "\n" .
' \end{longtable}' . "\n",
$result
);
}
public function testExportStructure(): void
{
$keys = [
[
'Non_unique' => 0,
'Column_name' => 'name1',
],
[
'Non_unique' => 1,
'Column_name' => 'name2',
],
];
// case 1
$resultStub = $this->createMock(DummyResult::class);
$dbi = $this->getMockBuilder(DatabaseInterface::class)
->disableOriginalConstructor()
->getMock();
$dbi->expects($this->once())
->method('getTableIndexes')
->with('database', '')
->will($this->returnValue($keys));
$dbi->expects($this->exactly(2))
->method('fetchResult')
->willReturnOnConsecutiveCalls(
[],
[
'name1' => [
'values' => 'test-',
'transformation' => 'testfoo',
'mimetype' => 'testmimetype_',
],
]
);
$columns = [
[
'Null' => 'Yes',
'Field' => 'name1',
'Key' => 'PRI',
'Type' => 'set(abc)enum123',
],
[
'Null' => 'NO',
'Field' => 'fields',
'Key' => 'COMP',
'Type' => '',
'Default' => 'def',
],
];
$dbi->expects($this->once())
->method('getColumns')
->with('database', '')
->will($this->returnValue($columns));
$dbi->expects($this->once())
->method('tryQueryAsControlUser')
->will($this->returnValue($resultStub));
$resultStub->expects($this->once())
->method('numRows')
->will($this->returnValue(1));
$resultStub->expects($this->once())
->method('fetchAssoc')
->will($this->returnValue(['comment' => 'testComment']));
$GLOBALS['dbi'] = $dbi;
$this->object->relation = new Relation($dbi);
if (isset($GLOBALS['latex_caption'])) {
unset($GLOBALS['latex_caption']);
}
$_SESSION['relation'] = [];
$_SESSION['relation'][$GLOBALS['server']] = RelationParameters::fromArray([
'relwork' => true,
'commwork' => true,
'mimework' => true,
'db' => 'database',
'relation' => 'rel',
'column_info' => 'col',
])->toArray();
ob_start();
$this->assertTrue(
$this->object->exportStructure(
'database',
'',
"\n",
'example.com',
'test',
'test',
true,
true,
true
)
);
$result = ob_get_clean();
//echo $result; die;
$this->assertEquals(
"\n" . '%' . "\n" .
'% Structure: ' . "\n" .
'%' . "\n" .
' \\begin{longtable}{|l|c|c|c|l|l|} ' . "\n" .
' \\hline \\multicolumn{1}{|c|}{\\textbf{Column}} & ' .
'\\multicolumn{1}{|c|}{\\textbf{Type}} & \\multicolumn{1}{|c|}' .
'{\\textbf{Null}} & \\multicolumn{1}{|c|}{\\textbf{Default}} &' .
' \\multicolumn{1}{|c|}{\\textbf{Comments}} & \\multicolumn{1}' .
'{|c|}{\\textbf{MIME}} \\\\ \\hline \\hline' . "\n" .
'\\endfirsthead' . "\n" . ' \\hline \\multicolumn{1}{|c|}' .
'{\\textbf{Column}} & \\multicolumn{1}{|c|}{\\textbf{Type}}' .
' & \\multicolumn{1}{|c|}{\\textbf{Null}} & \\multicolumn' .
'{1}{|c|}{\\textbf{Default}} & \\multicolumn{1}{|c|}{\\textbf' .
'{Comments}} & \\multicolumn{1}{|c|}{\\textbf{MIME}} \\\\ ' .
'\\hline \\hline \\endhead \\endfoot ' . "\n" . '\\textbf{\\textit' .
'{name1}} & set(abc) & Yes & NULL & ' .
'& Testmimetype/ \\\\ \\hline ' . "\n" .
'fields & & No & def & & \\\\ \\hline ' . "\n" .
' \\end{longtable}' . "\n",
$result
);
// case 2
$resultStub = $this->createMock(DummyResult::class);
$dbi = $this->getMockBuilder(DatabaseInterface::class)
->disableOriginalConstructor()
->getMock();
$dbi->expects($this->exactly(2))
->method('fetchResult')
->willReturnOnConsecutiveCalls(
[
'name1' => [
'foreign_table' => 'ftable',
'foreign_field' => 'ffield',
],
'foreign_keys_data' => [],
],
[
'field' => [
'values' => 'test-',
'transformation' => 'testfoo',
'mimetype' => 'test<',
],
]
);
$dbi->expects($this->once())
->method('getTableIndexes')
->with('database', '')
->will($this->returnValue($keys));
$dbi->expects($this->once())
->method('getColumns')
->with('database', '')
->will($this->returnValue($columns));
$dbi->expects($this->once())
->method('tryQueryAsControlUser')
->will($this->returnValue($resultStub));
$resultStub->expects($this->once())
->method('numRows')
->will($this->returnValue(1));
$resultStub->expects($this->once())
->method('fetchAssoc')
->will($this->returnValue(['comment' => 'testComment']));
$GLOBALS['dbi'] = $dbi;
$this->object->relation = new Relation($dbi);
$_SESSION['relation'] = [];
$_SESSION['relation'][$GLOBALS['server']] = RelationParameters::fromArray([
'relwork' => true,
'commwork' => true,
'mimework' => true,
'db' => 'database',
'relation' => 'rel',
'column_info' => 'col',
])->toArray();
ob_start();
$this->assertTrue(
$this->object->exportStructure(
'database',
'',
"\n",
'example.com',
'test',
'test',
true,
true,
true
)
);
$result = ob_get_clean();
$this->assertIsString($result);
$this->assertStringContainsString(
'\\textbf{\\textit{name1}} & set(abc) & Yes & NULL & ' .
'ftable (ffield) & & \\\\ \\hline',
$result
);
// case 3
$dbi = $this->getMockBuilder(DatabaseInterface::class)
->disableOriginalConstructor()
->getMock();
$dbi->expects($this->once())
->method('getTableIndexes')
->with('database', '')
->will($this->returnValue($keys));
$dbi->expects($this->once())
->method('getColumns')
->with('database', '')
->will($this->returnValue($columns));
$dbi->expects($this->never())
->method('tryQuery');
$GLOBALS['dbi'] = $dbi;
$GLOBALS['latex_caption'] = true;
$GLOBALS['latex_structure_caption'] = 'latexstructure';
$GLOBALS['latex_structure_label'] = 'latexlabel';
$GLOBALS['latex_structure_continued_caption'] = 'latexcontinued';
$GLOBALS['cfg']['Server']['host'] = 'localhost';
$GLOBALS['cfg']['Server']['verbose'] = 'verb';
$_SESSION['relation'] = [];
$_SESSION['relation'][$GLOBALS['server']] = RelationParameters::fromArray([
'db' => 'database',
'relation' => 'rel',
'column_info' => 'col',
])->toArray();
ob_start();
$this->assertTrue(
$this->object->exportStructure(
'database',
'',
"\n",
'example.com',
'test',
'test'
)
);
$result = ob_get_clean();
$this->assertIsString($result);
$this->assertStringContainsString('\\caption{latexstructure} \\label{latexlabel}', $result);
$this->assertStringContainsString('caption{latexcontinued}', $result);
// case 4
$this->assertTrue(
$this->object->exportStructure(
'database',
'',
"\n",
'example.com',
'triggers',
'test'
)
);
}
public function testTexEscape(): void
{
$this->assertEquals(
'\\$\\%\\{foo\\&bar\\}\\#\\_\\^',
ExportLatex::texEscape('$%{foo&bar}#_^')
);
}
}