phpvms/tests/TestCase.php
Nabeel S 4a3ec38919
Option for SB only on bids; add the new file type #642 (#643)
Option for SB only on bids; add the new file type #642
2020-03-27 11:49:19 -04:00

322 lines
8.1 KiB
PHP
Executable File

<?php
use App\Repositories\SettingRepository;
use App\Services\DatabaseService;
use GuzzleHttp\Client;
use GuzzleHttp\Handler\MockHandler;
use GuzzleHttp\HandlerStack;
use GuzzleHttp\Psr7\Response;
use Illuminate\Routing\Middleware\ThrottleRequests;
use Illuminate\Support\Facades\Artisan;
use Illuminate\Support\Facades\Notification;
use Tests\CreatesApplication;
use Tests\TestData;
class TestCase extends Illuminate\Foundation\Testing\TestCase
{
use TestData;
use CreatesApplication;
/**
* The base URL to use while testing the application.
*
* @var string
*/
public static $prefix = '/api';
protected $app;
protected $baseUrl = 'http://localhost';
protected $connectionsToTransact = ['test'];
protected $user;
protected static $auth_headers = [
'x-api-key' => 'testadminapikey',
];
/**
* @throws Exception
*/
public function setUp(): void
{
parent::setUp();
// Don't throttle requests when running the tests
$this->withoutMiddleware(
ThrottleRequests::class
);
Notification::fake();
Artisan::call('database:create', ['--reset' => true]);
Artisan::call('migrate:refresh', ['--env' => 'testing']);
}
public function tearDown(): void
{
parent::tearDown();
}
/**
* @param $user
* @param array $headers
*
* @return array
*/
public function headers($user = null, array $headers = []): array
{
if ($user !== null) {
$headers['x-api-key'] = $user->api_key;
return $headers;
}
if ($this->user !== null) {
$headers['x-api-key'] = $this->user->api_key;
}
return $headers;
}
/**
* Import data from a YML file
*
* @param $file
*/
public function addData($file)
{
$svc = app(DatabaseService::class);
$file_path = base_path('tests/data/'.$file.'.yml');
try {
$svc->seed_from_yaml_file($file_path);
} catch (Exception $e) {
}
}
/**
* Make sure an object has the list of keys
*
* @param $obj
* @param array $keys
*/
public function assertHasKeys($obj, array $keys = []): void
{
foreach ($keys as $key) {
$this->assertArrayHasKey($key, $obj);
}
}
/**
* Read a file from the data directory
*
* @param $filename
*
* @return false|string
*/
public function readDataFile($filename)
{
$paths = [
'data/'.$filename,
'tests/data/'.$filename,
];
foreach ($paths as $p) {
if (file_exists($p)) {
return file_get_contents($p);
}
}
return false;
}
/**
* Return a mock Guzzle Client with a response loaded from $mockFile
*
* @param array|string $files
*/
public function mockGuzzleClient($files): void
{
if (!is_array($files)) {
$files = [$files];
}
$responses = [];
foreach ($files as $file) {
$responses[] = new Response(200, [
'Content-Type' => 'application/json; charset=utf-8',
], $this->readDataFile($file));
}
$mock = new MockHandler($responses);
$handler = HandlerStack::create($mock);
$guzzleClient = new Client(['handler' => $handler]);
app()->instance(Client::class, $guzzleClient);
}
/**
* @param array|string $files The filename or files to respond with
*/
public function mockXmlResponse($files)
{
if (!is_array($files)) {
$files = [$files];
}
$responses = [];
foreach ($files as $file) {
$responses[] = new Response(200, [
'Content-Type' => 'text/xml',
], $this->readDataFile($file));
}
$mock = new MockHandler($responses);
$handler = HandlerStack::create($mock);
$guzzleClient = new Client(['handler' => $handler]);
app()->instance(Client::class, $guzzleClient);
}
/**
* Update a setting
*
* @param $key
* @param $value
*/
public function updateSetting($key, $value)
{
$settingsRepo = app(SettingRepository::class);
$settingsRepo->store($key, $value);
}
/**
* So we can test private/protected methods
* http://bit.ly/1mr5hMq
*
* @param $object
* @param $methodName
* @param array $parameters
*
* @throws ReflectionException
*
* @return mixed
*/
public function invokeMethod(&$object, $methodName, array $parameters = [])
{
$reflection = new \ReflectionClass(get_class($object));
$method = $reflection->getMethod($methodName);
$method->setAccessible(true);
return $method->invokeArgs($object, $parameters);
}
/**
* Transform any data that's passed in. E.g, make sure that any mutator
* classes (e.g, units) are not passed in as the mutator class
*
* @param array $data
*
* @return array
*/
protected function transformData(&$data)
{
foreach ($data as $key => &$value) {
if (is_array($value)) {
$this->transformData($value);
}
if (is_subclass_of($value, App\Contracts\Unit::class)) {
$data[$key] = $value->__toString();
}
if ($value instanceof DateTimeImmutable) {
$data[$key] = $value->format(DATE_ATOM);
} elseif ($value instanceof Carbon) {
$data[$key] = $value->toIso8601ZuluString();
}
}
return $data;
}
/**
* Override the GET call to inject the user API key
*
* @param string $uri
* @param array $headers
* @param null $user
*
* @return \Illuminate\Foundation\Testing\TestResponse
*/
public function get($uri, array $headers = [], $user = null): \Illuminate\Foundation\Testing\TestResponse
{
$req = parent::get($uri, $this->headers($user, $headers));
if ($req->isClientError() || $req->isServerError()) {
Log::error('GET Error: '.$uri, $req->json());
}
return $req;
}
/**
* Override the POST calls to inject the user API key
*
* @param string $uri
* @param array $data
* @param array $headers
* @param null $user
*
* @return \Illuminate\Foundation\Testing\TestResponse
*/
public function post($uri, array $data = [], array $headers = [], $user = null)
{
$data = $this->transformData($data);
$req = parent::post($uri, $data, $this->headers($user, $headers));
if ($req->isClientError() || $req->isServerError()) {
Log::error('POST Error: '.$uri, $req->json());
}
return $req;
}
/**
* Override the PUT calls to inject the user API key
*
* @param string $uri
* @param array $data
* @param array $headers
* @param null $user
*
* @return \Illuminate\Foundation\Testing\TestResponse
*/
public function put($uri, array $data = [], array $headers = [], $user = null)
{
$req = parent::put($uri, $this->transformData($data), $this->headers($user, $headers));
if ($req->isClientError() || $req->isServerError()) {
Log::error('PUT Error: '.$uri, $req->json());
}
return $req;
}
/**
* Override the DELETE calls to inject the user API key
*
* @param string $uri
* @param array $data
* @param array $headers
* @param null $user
*
* @return \Illuminate\Foundation\Testing\TestResponse
*/
public function delete($uri, array $data = [], array $headers = [], $user = null)
{
$req = parent::delete($uri, $this->transformData($data), $this->headers($user, $headers));
if ($req->isClientError() || $req->isServerError()) {
Log::error('DELETE Error: '.$uri, $req->json());
}
return $req;
}
}