Skip to content
Permalink
Browse files

Add end to end tests that invoke psalm as a separate process (#1798)

* Add end to end tests that invoke psalm as a separate process

* Assert that psalm --init creates config file
  • Loading branch information...
bdsl authored and muglug committed Jun 16, 2019
1 parent a0866da commit 4c57c67e2f1b821e2ef8aa0b00448ff24ce92201
@@ -50,7 +50,8 @@
"squizlabs/php_codesniffer": "3.4.0",
"bamarni/composer-bin-plugin": "^1.2",
"psalm/plugin-phpunit": "^0.6",
"phpmyadmin/sql-parser": "^5.0"
"phpmyadmin/sql-parser": "^5.0",
"symfony/process": "^4.3"
},
"suggest": {
"ext-igbinary": "^2.0.5"
@@ -0,0 +1,150 @@
<?php
namespace Psalm\Tests\EndToEnd;
use PHPUnit\Framework\TestCase;
use Symfony\Component\Process\Process;
/**
* Tests some of the most important use cases of the psalm and psalter commands, by launching a new
* process as if invoked by a real user.
*
* This is primarily intended to test the code in `psalm`, `src/psalm.php` and related files.
*/
class PsalmEndToEndTest extends TestCase
{
/** @var string */
private $psalm = __DIR__ . '/../../psalm';
/** @var string */
private $psalter = __DIR__ . '/../../psalter';
/** @var string */
private static $previousWorkingDir;
/** @var string */
private static $tmpDir;
public static function setUpBeforeClass(): void
{
self::$tmpDir = tempnam(sys_get_temp_dir(), 'PsalmEndToEndTest_');
unlink(self::$tmpDir);
mkdir(self::$tmpDir);
$getcwd = getcwd();
if (! is_string($getcwd)) {
throw new \Exception('Couldn\'t get working directory');
}
self::$previousWorkingDir = $getcwd;
chdir(self::$tmpDir);
mkdir('src');
copy(__DIR__ . '/../fixtures/DummyProjectWithErrors/composer.json', 'composer.json');
(new Process(['composer', 'install']))->mustRun();
}
public static function tearDownAfterClass(): void
{
chdir(self::$previousWorkingDir);
self::recursiveRemoveDirectory(self::$tmpDir);
parent::tearDownAfterClass();
}
public function setUp(): void
{
@unlink('psalm.xml');
copy(__DIR__ . '/../fixtures/DummyProjectWithErrors/src/FileWithErrors.php', 'src/FileWithErrors.php');
parent::setUp();
}
public function testHelpReturnsMessage(): void
{
$this->assertStringContainsString('Usage:', $this->runPsalm(['--help'])['STDOUT']);
}
public function testVersion(): void
{
$this->assertStringStartsWith('Psalm 3', $this->runPsalm(['--version'])['STDOUT']);
}
public function testInit(): void
{
$this->assertStringStartsWith('Config file created', $this->runPsalm(['--init'])['STDOUT']);
$this->assertFileExists('psalm.xml');
}
public function testAlter(): void
{
$this->runPsalm(['--init']);
$this->assertStringContainsString(
'No errors found!',
$this->runPsalm(['--alter', '--issues=all'])['STDOUT']
);
$this->assertSame(0, $this->runPsalm([])['CODE']);
}
public function testPsalter(): void
{
$this->runPsalm(['--init']);
(new Process([$this->psalter, '--alter', '--issues=InvalidReturnType']))->mustRun();
$this->assertSame(0, $this->runPsalm([])['CODE']);
}
public function testPsalm(): void
{
$this->runPsalm(['--init']);
$result = $this->runPsalm([], true);
$this->assertStringContainsString('InvalidReturnType', $result['STDOUT']);
$this->assertStringContainsString('InvalidReturnStatement', $result['STDOUT']);
$this->assertStringContainsString('2 errors', $result['STDOUT']);
$this->assertSame(1, $result['CODE']);
}
/**
* @param array<string> $args
* @return array{STDOUT: string, STDERR: string, CODE: int|null}
*/
private function runPsalm(array $args, bool $shouldFail = false): array
{
$process = new Process(array_merge([$this->psalm], $args));
if (! $shouldFail) {
$process->mustRun();
} else {
$process->run();
$this->assertGreaterThan(0, $process->getExitCode());
}
return [
'STDOUT' => $process->getOutput(),
'STDERR' => $process->getErrorOutput(),
'CODE' => $process->getExitCode()
];
}
/** from comment by itay at itgoldman dot com at
* https://www.php.net/manual/en/function.rmdir.php#117354
*/
private static function recursiveRemoveDirectory(string $src): void
{
$dir = opendir($src);
while (false !== ( $file = readdir($dir))) {
if (( $file != '.' ) && ( $file != '..' )) {
$full = $src . '/' . $file;
if (is_dir($full)) {
self::recursiveRemoveDirectory($full);
} else {
unlink($full);
}
}
}
closedir($dir);
rmdir($src);
}
}
@@ -0,0 +1,11 @@
{
"name": "acme/sample-project",
"description": "A sample project to be used when testing Psalm",
"type": "project",
"require": {},
"autoload": {
"psr-4": {
"Acme\\SampleProject\\": "src/"
}
}
}
@@ -0,0 +1,6 @@
<?php
namespace Acme\SampleProject;
function foo(string $s): int {
return "bar";
}

0 comments on commit 4c57c67

Please sign in to comment.
You can’t perform that action at this time.