Skip to content

Component should fail when there are set PKs for non-existing columns in manifest #91

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 14, 2024
Merged

Component should fail when there are set PKs for non-existing columns in manifest #91

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b4e1f94
Validate when there are set PKs for non-existing columns in manifest
AdamVyborny Aug 9, 2024
90b5722
Remove non-existing command from composer.json
AdamVyborny Aug 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,6 @@
"phpcs": "phpcs --extensions=php src tests example",
"phpcbf": "phpcbf --extensions=php src tests example",
"build": [
"@phplint",
"@phpcs",
"@phpstan",
"@tests"
Expand Down
12 changes: 12 additions & 0 deletions src/Manifest/ManifestManager/Options/OutTable/Serializer/LegacyManifestNormalizer.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
use Keboola\Component\Manifest\ManifestManager\Options\OptionsValidationException;
use Keboola\Component\Manifest\ManifestManager\Options\OutTable\ManifestOptions;
use Keboola\Component\Manifest\ManifestManager\Options\OutTable\ManifestOptionsSchema;
use Keboola\Component\UserException;
use Symfony\Component\Serializer\Normalizer\DenormalizerInterface;
use Symfony\Component\Serializer\Normalizer\NormalizerInterface;

Expand Down Expand Up @@ -181,6 +182,7 @@ private function setSchema(
): void {
$schema = [];

$primaryKeysSet = [];
foreach ($data['columns'] as $columnName) {
$columnMetadata = $data['column_metadata'][$columnName] ?? [];
$dataTypes = [];
Expand All @@ -198,6 +200,9 @@ private function setSchema(
}

$isPK = $primaryKey ?: (isset($data['primary_key']) && in_array($columnName, $data['primary_key']));
if ($isPK) {
$primaryKeysSet[] = $columnName;
}
$schema[] = new ManifestOptionsSchema(
$columnName,
$dataTypes,
Expand All @@ -208,6 +213,13 @@ private function setSchema(
);
}

if (isset($data['primary_key']) && count($primaryKeysSet) !== count($data['primary_key'])) {
throw new UserException(sprintf(
'Primary keys do not match columns. Missing columns: %s',
implode(', ', array_diff($data['primary_key'], $primaryKeysSet)),
));
}

$manifestOptions->setSchema($schema);
}

Expand Down
25 changes: 25 additions & 0 deletions tests/Manifest/ManifestManager/Options/OutTableManifestOptionsTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
use Keboola\Component\Manifest\ManifestManager\Options\OptionsValidationException;
use Keboola\Component\Manifest\ManifestManager\Options\OutTable\ManifestOptions;
use Keboola\Component\Manifest\ManifestManager\Options\OutTable\ManifestOptionsSchema;
use Keboola\Component\UserException;
use PHPUnit\Framework\TestCase;

class OutTableManifestOptionsTest extends TestCase
Expand Down Expand Up @@ -182,6 +183,30 @@ public function validNamesProvider(): array
];
}

public function testFromArrayWithNonExistingPrimaryKey(): void
{
$this->expectException(UserException::class);
$this->expectExceptionMessage('Primary keys do not match columns. Missing columns: number');

ManifestOptions::fromArray([
'destination' => 'my.table',
'columns' => ['id', 'number #', 'other_column'],
'incremental' => true,
'primary_key' => ['id', 'number'],
]);

$this->expectException(UserException::class);
$this->expectExceptionMessage('Primary keys do not match columns. ' .
'Missing columns: non-existing-column-1, non-existing-column-2');

ManifestOptions::fromArray([
'destination' => 'my.table',
'columns' => ['id', 'number', 'other_column'],
'incremental' => true,
'primary_key' => ['id', 'non-existing-column-1', 'non-existing-column-2'],
]);
}

/**
* @dataProvider provideInvalidOptions
*/
Expand Down