misc_pterodactyl-panel/tests/Unit/Services/Eggs/Variables/VariableUpdateServiceTest.php

242 lines
8.7 KiB
PHP
Raw Normal View History

2017-08-13 19:55:09 +00:00
<?php
2017-10-08 04:29:08 +00:00
namespace Tests\Unit\Services\Eggs\Variables;
2017-08-13 19:55:09 +00:00
use Exception;
use Mockery as m;
2017-08-16 04:21:01 +00:00
use Tests\TestCase;
use BadMethodCallException;
use Pterodactyl\Models\EggVariable;
use Illuminate\Contracts\Validation\Factory;
2017-08-16 04:21:01 +00:00
use Pterodactyl\Exceptions\DisplayException;
2017-10-08 04:29:08 +00:00
use Pterodactyl\Services\Eggs\Variables\VariableUpdateService;
use Pterodactyl\Contracts\Repository\EggVariableRepositoryInterface;
2020-06-25 04:54:56 +00:00
use Pterodactyl\Exceptions\Service\Egg\Variable\BadValidationRuleException;
use Pterodactyl\Exceptions\Service\Egg\Variable\ReservedVariableNameException;
2017-08-13 19:55:09 +00:00
class VariableUpdateServiceTest extends TestCase
{
/**
* @var \Pterodactyl\Models\EggVariable|\Mockery\Mock
2017-08-13 19:55:09 +00:00
*/
private $model;
2017-08-13 19:55:09 +00:00
/**
2017-10-08 04:29:08 +00:00
* @var \Pterodactyl\Contracts\Repository\EggVariableRepositoryInterface|\Mockery\Mock
2017-08-13 19:55:09 +00:00
*/
private $repository;
2017-08-13 19:55:09 +00:00
/**
* @var \Illuminate\Contracts\Validation\Factory|\Mockery\Mock
2017-08-13 19:55:09 +00:00
*/
private $validator;
2017-08-13 19:55:09 +00:00
/**
* Setup tests.
*/
public function setUp(): void
2017-08-13 19:55:09 +00:00
{
parent::setUp();
$this->model = factory(EggVariable::class)->make();
2017-10-08 04:29:08 +00:00
$this->repository = m::mock(EggVariableRepositoryInterface::class);
$this->validator = m::mock(Factory::class);
2017-08-13 19:55:09 +00:00
}
/**
* Test the function when no env_variable key is passed into the function.
*/
public function testVariableIsUpdatedWhenNoEnvironmentVariableIsPassed()
{
2018-01-05 22:33:50 +00:00
$this->repository->shouldReceive('withoutFreshModel')->withNoArgs()->once()->andReturnSelf()
->shouldReceive('update')->with($this->model->id, m::subset([
2017-08-13 19:55:09 +00:00
'user_viewable' => false,
'user_editable' => false,
]))->once()->andReturn(true);
2017-08-13 19:55:09 +00:00
$this->assertTrue($this->getService()->handle($this->model, []));
2017-08-13 19:55:09 +00:00
}
2017-09-27 03:16:26 +00:00
/**
* Test that a null value passed in for the default is converted to a string.
*
* @see https://github.com/Pterodactyl/Panel/issues/934
2017-09-27 03:16:26 +00:00
*/
public function testNullDefaultValue()
2017-09-27 03:16:26 +00:00
{
2018-02-17 19:37:53 +00:00
$this->repository->shouldReceive('withoutFreshModel->update')->with($this->model->id, m::subset([
'user_viewable' => false,
'user_editable' => false,
'default_value' => '',
]))->once()->andReturn(true);
2017-09-27 03:16:26 +00:00
$this->assertTrue($this->getService()->handle($this->model, ['default_value' => null]));
2017-09-27 03:16:26 +00:00
}
2017-08-13 19:55:09 +00:00
/**
* Test the function when a valid env_variable key is passed into the function.
*/
public function testVariableIsUpdatedWhenValidEnvironmentVariableIsPassed()
{
$this->repository->shouldReceive('setColumns')->with('id')->once()->andReturnSelf()
2017-08-13 19:55:09 +00:00
->shouldReceive('findCountWhere')->with([
['env_variable', '=', 'TEST_VAR_123'],
2017-10-08 04:29:08 +00:00
['egg_id', '=', $this->model->option_id],
2017-08-16 04:21:01 +00:00
['id', '!=', $this->model->id],
2017-08-13 19:55:09 +00:00
])->once()->andReturn(0);
2018-01-05 22:33:50 +00:00
$this->repository->shouldReceive('withoutFreshModel')->withNoArgs()->once()->andReturnSelf()
->shouldReceive('update')->with($this->model->id, m::subset([
2017-08-13 19:55:09 +00:00
'user_viewable' => false,
'user_editable' => false,
'env_variable' => 'TEST_VAR_123',
]))->once()->andReturn(true);
2017-08-13 19:55:09 +00:00
$this->assertTrue($this->getService()->handle($this->model, ['env_variable' => 'TEST_VAR_123']));
2017-08-13 19:55:09 +00:00
}
2017-12-31 01:56:42 +00:00
/**
* Test that an empty (null) value passed in the option key is handled
2018-02-17 19:37:53 +00:00
* properly as an array. Also tests that a null description is handled.
2017-12-31 01:56:42 +00:00
*
* @see https://github.com/Pterodactyl/Panel/issues/841
*/
public function testNullOptionValueIsPassedAsArray()
{
2018-01-05 22:33:50 +00:00
$this->repository->shouldReceive('withoutFreshModel')->withNoArgs()->once()->andReturnSelf()
->shouldReceive('update')->with($this->model->id, m::subset([
2017-12-31 01:56:42 +00:00
'user_viewable' => false,
'user_editable' => false,
2018-02-17 19:37:53 +00:00
'description' => '',
]))->once()->andReturn(true);
2017-12-31 01:56:42 +00:00
$this->assertTrue($this->getService()->handle($this->model, ['options' => null, 'description' => null]));
2017-12-31 01:56:42 +00:00
}
2017-10-08 04:29:08 +00:00
/**
* Test that data passed into the handler is overwritten inside the handler.
*/
public function testDataPassedIntoHandlerTakesLowerPriorityThanDataSet()
{
$this->repository->shouldReceive('setColumns')->with('id')->once()->andReturnSelf()
2017-10-08 04:29:08 +00:00
->shouldReceive('findCountWhere')->with([
['env_variable', '=', 'TEST_VAR_123'],
['egg_id', '=', $this->model->option_id],
['id', '!=', $this->model->id],
])->once()->andReturn(0);
2018-01-05 22:33:50 +00:00
$this->repository->shouldReceive('withoutFreshModel')->withNoArgs()->once()->andReturnSelf()
->shouldReceive('update')->with($this->model->id, m::subset([
2017-10-08 04:29:08 +00:00
'user_viewable' => false,
'user_editable' => false,
'env_variable' => 'TEST_VAR_123',
]))->once()->andReturn(true);
2017-10-08 04:29:08 +00:00
$this->assertTrue($this->getService()->handle($this->model, ['user_viewable' => 123456, 'env_variable' => 'TEST_VAR_123']));
2017-10-08 04:29:08 +00:00
}
2017-08-13 19:55:09 +00:00
/**
* Test that a non-unique environment variable triggers an exception.
*/
public function testExceptionIsThrownIfEnvironmentVariableIsNotUnique()
{
$this->repository->shouldReceive('setColumns')->with('id')->once()->andReturnSelf()
2017-08-13 19:55:09 +00:00
->shouldReceive('findCountWhere')->with([
['env_variable', '=', 'TEST_VAR_123'],
2017-10-08 04:29:08 +00:00
['egg_id', '=', $this->model->option_id],
2017-08-16 04:21:01 +00:00
['id', '!=', $this->model->id],
2017-08-13 19:55:09 +00:00
])->once()->andReturn(1);
try {
$this->getService()->handle($this->model, ['env_variable' => 'TEST_VAR_123']);
2017-08-13 19:55:09 +00:00
} catch (Exception $exception) {
$this->assertInstanceOf(DisplayException::class, $exception);
$this->assertEquals(trans('exceptions.service.variables.env_not_unique', [
2017-08-13 19:55:09 +00:00
'name' => 'TEST_VAR_123',
]), $exception->getMessage());
}
}
/**
* Test that all of the reserved variables defined in the model trigger an exception.
*
* @dataProvider reservedNamesProvider
*/
2017-10-08 04:29:08 +00:00
public function testExceptionIsThrownIfEnvironmentVariableIsInListOfReservedNames(string $variable)
2017-08-13 19:55:09 +00:00
{
2020-06-25 04:54:56 +00:00
$this->expectException(ReservedVariableNameException::class);
$this->getService()->handle($this->model, ['env_variable' => $variable]);
}
/**
* Test that validation errors due to invalid rules are caught and handled properly.
*/
public function testInvalidValidationRulesResultInException()
{
2020-06-25 04:54:56 +00:00
$this->expectException(BadValidationRuleException::class);
$this->expectExceptionMessage('The validation rule "hodor_door" is not a valid rule for this application.');
$data = ['env_variable' => 'TEST_VAR_123', 'rules' => 'string|hodorDoor'];
$this->repository->shouldReceive('setColumns->findCountWhere')->once()->andReturn(0);
$this->validator->shouldReceive('make')->once()
->with(['__TEST' => 'test'], ['__TEST' => 'string|hodorDoor'])
->andReturnSelf();
$this->validator->shouldReceive('fails')->once()
->withNoArgs()
->andThrow(new BadMethodCallException('Method [validateHodorDoor] does not exist.'));
$this->getService()->handle($this->model, $data);
}
/**
* Test that an exception not stemming from a bad rule is not caught.
*/
public function testExceptionNotCausedByBadRuleIsNotCaught()
{
2020-06-25 04:54:56 +00:00
$this->expectException(BadMethodCallException::class);
$this->expectExceptionMessage('Received something, but no expectations were specified.');
$data = ['rules' => 'string'];
$this->validator->shouldReceive('make')->once()
->with(['__TEST' => 'test'], ['__TEST' => 'string'])
->andReturnSelf();
$this->validator->shouldReceive('fails')->once()
->withNoArgs()
->andThrow(new BadMethodCallException('Received something, but no expectations were specified.'));
$this->getService()->handle($this->model, $data);
2017-08-13 19:55:09 +00:00
}
/**
* Provides the data to be used in the tests.
*
* @return array
*/
public function reservedNamesProvider()
{
$data = [];
$exploded = explode(',', EggVariable::RESERVED_ENV_NAMES);
2017-08-13 19:55:09 +00:00
foreach ($exploded as $e) {
$data[] = [$e];
}
return $data;
}
/**
* Return an instance of the service with mocked dependencies for testing.
*
* @return \Pterodactyl\Services\Eggs\Variables\VariableUpdateService
*/
private function getService(): VariableUpdateService
{
return new VariableUpdateService($this->repository, $this->validator);
}
2017-08-13 19:55:09 +00:00
}