Skip to content
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

Replace SensioLabs Security Checker with CLI tool #871

Closed
wants to merge 1 commit into from
+15 −55
Closed

Replace SensioLabs Security Checker with CLI tool #871

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
22 changes: 3 additions & 19 deletions doc/tasks/securitychecker.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,9 @@

The Security Checker will check your `composer.lock` file for known security vulnerabilities.

***Composer***
***Binary***

```
composer require --dev sensiolabs/security-checker
```
Download the latest binary from https://github.com/fabpot/local-php-security-checker/releases and make sure it is parth of your PATH or place it in one of the directories defined by environment.paths in your grumphp.yml file.

***Config***

Expand All @@ -19,8 +17,6 @@ grumphp:
securitychecker:
lockfile: ./composer.lock
format: ~
end_point: ~
timeout: ~
run_always: false
```

Expand All @@ -34,19 +30,7 @@ If your `composer.lock` file is located in an exotic location, you can specify t

*Default: null*

You can choose the format of the output. The available options are `text`, `json` and `simple`. By default, grumphp will use the format `text`.

**end_point**

*Default: null*

You can use a different end point for the security checks. Grumphp will use the default end point which is [https://security.symfony.com/check_lock](https://security.symfony.com/check_lock).

**timeout**

*Default: null*

You can change the timeout value for the command. By default this value is `20`.
You can choose the format of the output. The available options are `ansi`, `json`, `markdown` and `yaml`. By default, grumphp will use the format `ansi`.

**run_always**

Expand Down
11 changes: 2 additions & 9 deletions src/Task/SecurityChecker.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,15 +19,11 @@ public static function getConfigurableOptions(): OptionsResolver
$resolver->setDefaults([
'lockfile' => './composer.lock',
'format' => null,
'end_point' => null,
'timeout' => null,
'run_always' => false,
]);

$resolver->addAllowedTypes('lockfile', ['string']);
$resolver->addAllowedTypes('format', ['null', 'string']);
$resolver->addAllowedTypes('end_point', ['null', 'string']);
$resolver->addAllowedTypes('timeout', ['null', 'int']);
$resolver->addAllowedTypes('run_always', ['bool']);

return $resolver;
Expand All @@ -49,12 +45,9 @@ public function run(ContextInterface $context): TaskResultInterface
return TaskResult::createSkipped($this, $context);
}

$arguments = $this->processBuilder->createArgumentsForCommand('security-checker');
$arguments->add('security:check');
$arguments->addOptionalArgument('%s', $config['lockfile']);
$arguments = $this->processBuilder->createArgumentsForCommand('local-php-security-checker');
$arguments->addOptionalArgument('--path=%s', $config['lockfile']);
$arguments->addOptionalArgument('--format=%s', $config['format']);
$arguments->addOptionalArgument('--end-point=%s', $config['end_point']);
$arguments->addOptionalArgument('--timeout=%s', $config['timeout']);

$process = $this->processBuilder->buildProcess($arguments);
$process->run();
Expand Down
37 changes: 10 additions & 27 deletions test/Unit/Task/SecurityCheckerTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,6 @@ public function provideConfigurableOptions(): iterable
[
'lockfile' => './composer.lock',
'format' => null,
'end_point' => null,
'timeout' => null,
'run_always' => false,
]
];
Expand Down Expand Up @@ -58,7 +56,7 @@ public function provideFailsOnStuff(): iterable
[],
$this->mockContext(RunContext::class, ['composer.lock']),
function () {
$this->mockProcessBuilder('security-checker', $process = $this->mockProcess(1));
$this->mockProcessBuilder('local-php-security-checker', $process = $this->mockProcess(1));
$this->formatter->format($process)->willReturn('nope');
},
'nope'
Expand All @@ -71,7 +69,7 @@ public function providePassesOnStuff(): iterable
[],
$this->mockContext(RunContext::class, ['composer.lock']),
function () {
$this->mockProcessBuilder('security-checker', $this->mockProcess(0));
$this->mockProcessBuilder('local-php-security-checker', $this->mockProcess(0));
}
];
yield 'exitCode0WhenRunAlways' => [
Expand All @@ -80,7 +78,7 @@ function () {
],
$this->mockContext(RunContext::class, ['notrelated.php']),
function () {
$this->mockProcessBuilder('security-checker', $this->mockProcess(0));
$this->mockProcessBuilder('local-php-security-checker', $this->mockProcess(0));
}
];
}
Expand All @@ -104,36 +102,21 @@ public function provideExternalTaskRuns(): iterable
yield 'defaults' => [
[],
$this->mockContext(RunContext::class, ['composer.lock']),
'security-checker',
'local-php-security-checker',
[
'security:check',
'./composer.lock',
'--path=./composer.lock',
]
];

yield 'endpoint' => [
yield 'format' => [
[
'end_point' => $endpoint = 'http://myserver.com',
'format' => 'json',
],
$this->mockContext(RunContext::class, ['composer.lock']),
'security-checker',
'local-php-security-checker',
[
'security:check',
'./composer.lock',
'--end-point='.$endpoint
]
];

yield 'timeout' => [
[
'timeout' => 2,
],
$this->mockContext(RunContext::class, ['composer.lock']),
'security-checker',
[
'security:check',
'./composer.lock',
'--timeout=2'
'--path=./composer.lock',
'--format=json'
]
];
}
Expand Down