Skip to content

Commit dba66ce

Browse files
t-heusert-heuser
authored
Merge pull request #4 from Flowpack/add-static-code-analysis
TASK: add static code analysis
2 parents 14171d7 + 73ccba7 commit dba66ce

10 files changed

+76
-34
lines changed

‎.github/workflows/ci.yml

+11-3
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,8 @@ jobs:
77
runs-on: ubuntu-latest
88

99
steps:
10-
- uses: actions/checkout@v3
11-
10+
- uses: actions/checkout@v4
1211
- uses: php-actions/composer@v6
13-
1412
- name: PHPUnit Tests
1513
uses: php-actions/phpunit@v4
1614
with:
@@ -20,3 +18,13 @@ jobs:
2018
coverage_text: true
2119
env:
2220
XDEBUG_MODE: coverage
21+
22+
phpstan:
23+
runs-on: ubuntu-latest
24+
steps:
25+
- uses: actions/checkout@v4
26+
- uses: php-actions/composer@v6
27+
- uses: php-actions/phpstan@v3
28+
with:
29+
path: Classes Tests
30+
configuration: phpstan.neon

‎Classes/Command/CspConfigCommandController.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ class CspConfigCommandController extends CommandController
3131

3232
/**
3333
* @Flow\InjectConfiguration(path="content-security-policy")
34-
* @var mixed[]
34+
* @var string[][][]
3535
*/
3636
protected array $configuration;
3737

‎Classes/Helpers/TagHelper.php

+5-4
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,15 @@ public static function tagHasAttribute(
1111
string $name,
1212
string $value = null
1313
): bool {
14-
if (! $value) {
15-
return ! ! preg_match(
14+
$value = (string)$value;
15+
if ($value === '') {
16+
return (bool)preg_match(
1617
self::buildMatchAttributeNameReqex($name),
1718
$tag
1819
);
1920
}
2021

21-
return ! ! preg_match(
22+
return (bool)preg_match(
2223
self::buildMatchAttributeNameWithSpecificValueReqex(
2324
$name,
2425
$value
@@ -53,7 +54,7 @@ public static function tagAddAttribute(
5354
return preg_replace_callback(
5455
self::buildMatchEndOfOpeningTagReqex(),
5556
function ($hits) use ($name, $value) {
56-
if ($value) {
57+
if ((string)$value !== '') {
5758
return $hits["start"].
5859
' '.
5960
$name.

‎Classes/Http/CspHeaderMiddleware.php

+4-11
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ class CspHeaderMiddleware implements MiddlewareInterface
4444

4545
/**
4646
* @Flow\InjectConfiguration(path="content-security-policy")
47-
* @var mixed[]
47+
* @var string[][][]
4848
*/
4949
protected array $configuration;
5050

@@ -107,7 +107,7 @@ private function addNonceToTags(string $markup): string
107107

108108
return $this->checkTagAndReplaceUsingACallback($tagNames, $markup, function (
109109
$tagMarkup,
110-
) {
110+
): string {
111111
if (TagHelper::tagHasAttribute($tagMarkup, self::NONCE)) {
112112
return TagHelper::tagChangeAttributeValue($tagMarkup, self::NONCE, $this->nonce->getValue());
113113
}
@@ -118,9 +118,6 @@ private function addNonceToTags(string $markup): string
118118

119119
/**
120120
* @param string[] $tagNames
121-
* @param string $contentMarkup
122-
* @param callable $hitCallback
123-
* @return string
124121
*/
125122
private function checkTagAndReplaceUsingACallback(
126123
array $tagNames,
@@ -131,14 +128,10 @@ private function checkTagAndReplaceUsingACallback(
131128

132129
return preg_replace_callback(
133130
$regex,
134-
function ($hits) use ($hitCallback, $tagNames) {
131+
function ($hits) use ($hitCallback) {
135132
$tagMarkup = $hits[0];
136133
$tagName = $hits[1];
137-
138-
if (! $hitCallback) {
139-
return $tagMarkup;
140-
}
141-
134+
142135
return call_user_func(
143136
$hitCallback,
144137
$tagMarkup,

‎Classes/Model/Directive.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ class Directive
3939

4040
public static function isValidDirective(string $directive): bool
4141
{
42-
return in_array($directive, self::VALID_DIRECTIVES);
42+
return in_array($directive, self::VALID_DIRECTIVES, true);
4343
}
4444

4545
}

‎Classes/Model/Policy.php

+6-2
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ class Policy
2727
*/
2828
protected bool $reportOnly;
2929

30+
/** @var string[][] */
3031
private array $directives = [];
3132

3233
private readonly Nonce $nonce;
@@ -49,6 +50,9 @@ public function getSecurityHeaderKey(): string
4950
return self::SECURITY_HEADER_KEY;
5051
}
5152

53+
/**
54+
* @return string[][]
55+
*/
5256
public function getDirectives(): array
5357
{
5458
return $this->directives;
@@ -68,7 +72,7 @@ public function addDirective(string $directive, array $values): self
6872
if (! Directive::isValidDirective($directive)) {
6973
throw new InvalidDirectiveException($directive);
7074
}
71-
$this->directives[$directive] = array_map(function ($value) use ($directive) {
75+
$this->directives[$directive] = array_map(function ($value) {
7276
return $this->sanitizeValue($value);
7377
}, $values);
7478

@@ -91,7 +95,7 @@ public function __toString(): string
9195

9296
private function sanitizeValue(string $value): string
9397
{
94-
if (in_array($value, self::SPECIAL_DIRECTIVES)) {
98+
if (in_array($value, self::SPECIAL_DIRECTIVES, true)) {
9599
return "'$value'";
96100
}
97101

‎Tests/Unit/Http/CspHeaderMiddlewareTest.php

+11-10
Original file line numberDiff line numberDiff line change
@@ -30,14 +30,13 @@ class CspHeaderMiddlewareTest extends TestCase
3030
{
3131
private readonly CspHeaderMiddleware $middleware;
3232
private readonly ReflectionClass $middlewareReflection;
33-
private readonly ServerRequestInterface|MockObject $requestMock;
34-
private readonly RequestHandlerInterface|MockObject $requestHandlerMock;
35-
private readonly ResponseInterface|MockObject $responseMock;
36-
private readonly LoggerInterface|MockObject $loggerMock;
37-
private readonly Nonce|MockObject $nonceMock;
38-
private readonly UriInterface|MockObject $uriMock;
39-
private readonly PolicyFactory|MockObject $policyFactoryMock;
40-
private readonly Policy|MockObject $policyMock;
33+
private readonly ServerRequestInterface&MockObject $requestMock;
34+
private readonly RequestHandlerInterface&MockObject $requestHandlerMock;
35+
private readonly ResponseInterface&MockObject $responseMock;
36+
private readonly LoggerInterface&MockObject $loggerMock;
37+
private readonly UriInterface&MockObject $uriMock;
38+
private readonly PolicyFactory&MockObject $policyFactoryMock;
39+
private readonly Policy&MockObject $policyMock;
4140

4241
/**
4342
* @throws Throwable
@@ -52,7 +51,7 @@ protected function setUp(): void
5251
$this->requestHandlerMock = $this->createMock(RequestHandlerInterface::class);
5352
$this->responseMock = $this->createMock(ResponseInterface::class);
5453
$this->loggerMock = $this->createMock(LoggerInterface::class);
55-
$this->nonceMock = $this->createMock(Nonce::class);
54+
$nonceMock = $this->createMock(Nonce::class);
5655
$this->uriMock = $this->createMock(UriInterface::class);
5756
$this->policyFactoryMock = $this->createMock(PolicyFactory::class);
5857
$this->policyMock = $this->createMock(Policy::class);
@@ -66,7 +65,7 @@ protected function setUp(): void
6665
$reflectionProperty->setValue($this->middleware, true);
6766

6867
$reflectionProperty = $this->middlewareReflection->getProperty('nonce');
69-
$reflectionProperty->setValue($this->middleware, $this->nonceMock);
68+
$reflectionProperty->setValue($this->middleware, $nonceMock);
7069

7170
$reflectionProperty = $this->middlewareReflection->getProperty('policyFactory');
7271
$reflectionProperty->setValue($this->middleware, $this->policyFactoryMock);
@@ -99,6 +98,8 @@ public function testProcessShouldDoNothingIfPolicyIsInvalid(): void
9998
new InvalidPolicyException()
10099
);
101100

101+
$this->loggerMock->expects($this->once())->method('critical');
102+
102103
$this->responseMock->expects($this->never())->method('withAddedHeader');
103104

104105
$this->middleware->process($this->requestMock, $this->requestHandlerMock);

‎composer.json

+7-2
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,15 @@
2626
},
2727
"config": {
2828
"allow-plugins": {
29-
"neos/composer-plugin": true
29+
"neos/composer-plugin": true,
30+
"phpstan/extension-installer": true
3031
}
3132
},
3233
"require-dev": {
33-
"phpunit/phpunit": "^11.4"
34+
"phpunit/phpunit": "^11.4",
35+
"phpstan/phpstan": "^1.12",
36+
"phpstan/phpstan-phpunit": "^1.4",
37+
"phpstan/extension-installer": "^1.4",
38+
"phpstan/phpstan-strict-rules": "^1.6"
3439
}
3540
}

‎phpstan-baseline.neon

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
parameters:
2+
ignoreErrors:
3+
-
4+
message: "#^Method Flowpack\\\\ContentSecurityPolicy\\\\Helpers\\\\TagHelper\\:\\:tagAddAttribute\\(\\) should return string but returns string\\|null\\.$#"
5+
count: 1
6+
path: Classes/Helpers/TagHelper.php
7+
8+
-
9+
message: "#^Method Flowpack\\\\ContentSecurityPolicy\\\\Helpers\\\\TagHelper\\:\\:tagChangeAttributeValue\\(\\) should return string but returns string\\|null\\.$#"
10+
count: 1
11+
path: Classes/Helpers/TagHelper.php
12+
13+
-
14+
message: "#^Method Flowpack\\\\ContentSecurityPolicy\\\\Http\\\\CspHeaderMiddleware\\:\\:checkTagAndReplaceUsingACallback\\(\\) should return string but returns string\\|null\\.$#"
15+
count: 1
16+
path: Classes/Http/CspHeaderMiddleware.php

‎phpstan.neon

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
includes:
2+
- phpstan-baseline.neon
3+
parameters:
4+
level: max
5+
paths:
6+
- Classes
7+
- Tests
8+
ignoreErrors:
9+
-
10+
identifier: property.uninitializedReadonly
11+
-
12+
identifier: property.readOnlyAssignNotInConstructor
13+
-
14+
identifier: missingType.generics

0 commit comments

Comments
 (0)