sonot
/
PteroTheme
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix some data integrity issues

This commit is contained in:
Dane Everitt 2018-02-17 13:37:53 -06:00
parent d52f8d9215
commit 241f7d0125
No known key found for this signature in database
GPG Key ID: EEA66103B3D71F53
6 changed files with 41 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
CHANGELOG.md
View File

@ -12,6 +12,7 @@ This project follows [Semantic Versioning](http://semver.org) guidelines.
* `[rc.2]` — Fix data integrity exception that could occur when an email containing non-username characters was passed. * `[rc.2]` — Fix data integrity exception that could occur when an email containing non-username characters was passed.
* `[rc.2]` — Fix data integrity exception occurring when no default value is provided for an egg variable. * `[rc.2]` — Fix data integrity exception occurring when no default value is provided for an egg variable.
* `[rc.2]` — Fixes a bug that would cause non-editable variables on the front-end to throw a validation error. * `[rc.2]` — Fixes a bug that would cause non-editable variables on the front-end to throw a validation error.
* `[rc.2]` — Fixes a data integrity exception occurring when saving egg variables with no value.
### Added ### Added
* Added ability to search the following API endpoints: list users, list servers, and list locations. * Added ability to search the following API endpoints: list users, list servers, and list locations.

2
app/Models/EggVariable.php
View File

@ -65,7 +65,7 @@ class EggVariable extends Model implements CleansAttributes, ValidableContract
protected static $dataIntegrityRules = [ protected static $dataIntegrityRules = [
'egg_id' => 'exists:eggs,id', 'egg_id' => 'exists:eggs,id',
'name' => 'string|between:1,255', 'name' => 'string|between:1,255',
'description' => 'nullable|string', 'description' => 'string',
'env_variable' => 'regex:/^[\w]{1,255}$/|notIn:' . self::RESERVED_ENV_NAMES, 'env_variable' => 'regex:/^[\w]{1,255}$/|notIn:' . self::RESERVED_ENV_NAMES,
'default_value' => 'string', 'default_value' => 'string',
'user_viewable' => 'boolean', 'user_viewable' => 'boolean',

9
app/Services/Eggs/Variables/VariableCreationService.php
View File

@ -44,10 +44,15 @@ class VariableCreationService
$options = array_get($data, 'options') ?? []; $options = array_get($data, 'options') ?? [];
return $this->repository->create(array_merge($data, [ return $this->repository->create([
'egg_id' => $egg, 'egg_id' => $egg,
'name' => $data['name'] ?? '',
'description' => $data['description'] ?? '',
'env_variable' => $data['env_variable'] ?? '',
'default_value' => $data['default_value'] ?? '',
'user_viewable' => in_array('user_viewable', $options), 'user_viewable' => in_array('user_viewable', $options),
'user_editable' => in_array('user_editable', $options), 'user_editable' => in_array('user_editable', $options),
])); 'rules' => $data['rules'] ?? '',
]);
} }
} }

12
app/Services/Eggs/Variables/VariableUpdateService.php
View File

@ -46,7 +46,7 @@ class VariableUpdateService
} }
$search = $this->repository->setColumns('id')->findCountWhere([ $search = $this->repository->setColumns('id')->findCountWhere([
['env_variable', '=', array_get($data, 'env_variable')], ['env_variable', '=', $data['env_variable']],
['egg_id', '=', $variable->egg_id], ['egg_id', '=', $variable->egg_id],
['id', '!=', $variable->id], ['id', '!=', $variable->id],
]); ]);
@ -60,10 +60,14 @@ class VariableUpdateService
$options = array_get($data, 'options') ?? []; $options = array_get($data, 'options') ?? [];
return $this->repository->withoutFreshModel()->update($variable->id, array_merge($data, [ return $this->repository->withoutFreshModel()->update($variable->id, [
'default_value' => array_get($data, 'default_value') ?? '', 'name' => $data['name'] ?? '',
'description' => $data['description'] ?? '',
'env_variable' => $data['env_variable'] ?? '',
'default_value' => $data['default_value'] ?? '',
'user_viewable' => in_array('user_viewable', $options), 'user_viewable' => in_array('user_viewable', $options),
'user_editable' => in_array('user_editable', $options), 'user_editable' => in_array('user_editable', $options),
])); 'rules' => $data['rules'] ?? '',
]);
} }
} }

34
tests/Unit/Services/Eggs/Variables/VariableCreationServiceTest.php
View File

@ -37,13 +37,14 @@ class VariableCreationServiceTest extends TestCase
*/ */
public function testVariableIsCreatedAndStored() public function testVariableIsCreatedAndStored()
{ {
$data = ['env_variable' => 'TEST_VAR_123']; $data = ['env_variable' => 'TEST_VAR_123', 'default_value' => 'test'];
$this->repository->shouldReceive('create')->with([ $this->repository->shouldReceive('create')->with(m::subset([
'egg_id' => 1, 'egg_id' => 1,
'default_value' => 'test',
'user_viewable' => false, 'user_viewable' => false,
'user_editable' => false, 'user_editable' => false,
'env_variable' => 'TEST_VAR_123', 'env_variable' => 'TEST_VAR_123',
])->once()->andReturn(new EggVariable); ]))->once()->andReturn(new EggVariable);
$this->assertInstanceOf(EggVariable::class, $this->service->handle(1, $data)); $this->assertInstanceOf(EggVariable::class, $this->service->handle(1, $data));
} }
@ -54,33 +55,31 @@ class VariableCreationServiceTest extends TestCase
public function testOptionsPassedInArrayKeyAreParsedProperly() public function testOptionsPassedInArrayKeyAreParsedProperly()
{ {
$data = ['env_variable' => 'TEST_VAR_123', 'options' => ['user_viewable', 'user_editable']]; $data = ['env_variable' => 'TEST_VAR_123', 'options' => ['user_viewable', 'user_editable']];
$this->repository->shouldReceive('create')->with([ $this->repository->shouldReceive('create')->with(m::subset([
'egg_id' => 1, 'default_value' => '',
'user_viewable' => true, 'user_viewable' => true,
'user_editable' => true, 'user_editable' => true,
'env_variable' => 'TEST_VAR_123', 'env_variable' => 'TEST_VAR_123',
'options' => ['user_viewable', 'user_editable'], ]))->once()->andReturn(new EggVariable);
])->once()->andReturn(new EggVariable);
$this->assertInstanceOf(EggVariable::class, $this->service->handle(1, $data)); $this->assertInstanceOf(EggVariable::class, $this->service->handle(1, $data));
} }
/** /**
* Test that an empty (null) value passed in the option key is handled * Test that an empty (null) value passed in the option key is handled
* properly as an array. * properly as an array. Also tests the same case aganist the default_value.
* *
* @see https://github.com/Pterodactyl/Panel/issues/841 * @see https://github.com/Pterodactyl/Panel/issues/841
* @see https://github.com/Pterodactyl/Panel/issues/943
*/ */
public function testNullOptionValueIsPassedAsArray() public function testNullOptionValueIsPassedAsArray()
{ {
$data = ['env_variable' => 'TEST_VAR_123', 'options' => null]; $data = ['env_variable' => 'TEST_VAR_123', 'options' => null, 'default_value' => null];
$this->repository->shouldReceive('create')->with([ $this->repository->shouldReceive('create')->with(m::subset([
'egg_id' => 1, 'default_value' => '',
'user_viewable' => false, 'user_viewable' => false,
'user_editable' => false, 'user_editable' => false,
'env_variable' => 'TEST_VAR_123', ]))->once()->andReturn(new EggVariable);
'options' => null,
])->once()->andReturn(new EggVariable);
$this->assertInstanceOf(EggVariable::class, $this->service->handle(1, $data)); $this->assertInstanceOf(EggVariable::class, $this->service->handle(1, $data));
} }
@ -103,12 +102,9 @@ class VariableCreationServiceTest extends TestCase
public function testEggIdPassedInDataIsNotApplied() public function testEggIdPassedInDataIsNotApplied()
{ {
$data = ['egg_id' => 123456, 'env_variable' => 'TEST_VAR_123']; $data = ['egg_id' => 123456, 'env_variable' => 'TEST_VAR_123'];
$this->repository->shouldReceive('create')->with([ $this->repository->shouldReceive('create')->with(m::subset([
'egg_id' => 1, 'egg_id' => 1,
'user_viewable' => false, ]))->once()->andReturn(new EggVariable);
'user_editable' => false,
'env_variable' => 'TEST_VAR_123',
])->once()->andReturn(new EggVariable);
$this->assertInstanceOf(EggVariable::class, $this->service->handle(1, $data)); $this->assertInstanceOf(EggVariable::class, $this->service->handle(1, $data));
} }

14
tests/Unit/Services/Eggs/Variables/VariableUpdateServiceTest.php
View File

@ -49,10 +49,9 @@ class VariableUpdateServiceTest extends TestCase
->shouldReceive('update')->with($this->model->id, m::subset([ ->shouldReceive('update')->with($this->model->id, m::subset([
'user_viewable' => false, 'user_viewable' => false,
'user_editable' => false, 'user_editable' => false,
'test-data' => 'test-value',
]))->once()->andReturn(true); ]))->once()->andReturn(true);
$this->assertTrue($this->service->handle($this->model, ['test-data' => 'test-value'])); $this->assertTrue($this->service->handle($this->model, []));
} }
/** /**
@ -62,12 +61,11 @@ class VariableUpdateServiceTest extends TestCase
*/ */
public function testNullDefaultValue() public function testNullDefaultValue()
{ {
$this->repository->shouldReceive('withoutFreshModel')->withNoArgs()->once()->andReturnSelf() $this->repository->shouldReceive('withoutFreshModel->update')->with($this->model->id, m::subset([
->shouldReceive('update')->with($this->model->id, [
'user_viewable' => false, 'user_viewable' => false,
'user_editable' => false, 'user_editable' => false,
'default_value' => '', 'default_value' => '',
])->once()->andReturn(true); ]))->once()->andReturn(true);
$this->assertTrue($this->service->handle($this->model, ['default_value' => null])); $this->assertTrue($this->service->handle($this->model, ['default_value' => null]));
} }
@ -96,7 +94,7 @@ class VariableUpdateServiceTest extends TestCase
/** /**
* Test that an empty (null) value passed in the option key is handled * Test that an empty (null) value passed in the option key is handled
* properly as an array. * properly as an array. Also tests that a null description is handled.
* *
* @see https://github.com/Pterodactyl/Panel/issues/841 * @see https://github.com/Pterodactyl/Panel/issues/841
*/ */
@ -106,10 +104,10 @@ class VariableUpdateServiceTest extends TestCase
->shouldReceive('update')->with($this->model->id, m::subset([ ->shouldReceive('update')->with($this->model->id, m::subset([
'user_viewable' => false, 'user_viewable' => false,
'user_editable' => false, 'user_editable' => false,
'options' => null, 'description' => '',
]))->once()->andReturn(true); ]))->once()->andReturn(true);
$this->assertTrue($this->service->handle($this->model, ['options' => null])); $this->assertTrue($this->service->handle($this->model, ['options' => null, 'description' => null]));
} }
/** /**