[TASK] Replace Scrutinizer analysis by PHPStan :: Level 3

TYPO3-Solr · Aug 15, 2023 · 640d234 · 640d234
1 parent f16e4bd
commit 640d234
Show file tree

Hide file tree

Showing 16 changed files with 49 additions and 125 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -98,11 +98,6 @@ jobs:
           echo "Current Size of EXT:tika build Artefacts: " \
             && sudo du -sh $CI_BUILD_DIRECTORY/ \
             && sudo du -sh $CI_BUILD_DIRECTORY/*
-      -
-        name: Upload code coverage to Scrutinizer
-        run: |
-          ocular code-coverage:upload --format=php-clover coverage.unit.clover
-          ocular code-coverage:upload --format=php-clover coverage.integration.clover
 
   publish:
     name: Publish new version to TER

diff --git a/.scrutinizer.yml b/.scrutinizer.yml
diff --git a/Build/Test/bootstrap.sh b/Build/Test/bootstrap.sh
@@ -74,10 +74,9 @@ export COMPOSER_NO_INTERACTION=1
 # Install build tools
 echo "Install build tools: "
 if ! composer global require \
-  sclable/xml-lint \
-  scrutinizer/ocular
+  sclable/xml-lint
 then
-  echo "The build tools(sclable/xml-lint, scrutinizer/ocular) could not be installed. Please fix this issue."
+  echo "The build tools(sclable/xml-lint) could not be installed. Please fix this issue."
   exit 1
 fi
 

diff --git a/Build/Test/phpstan.neon b/Build/Test/phpstan.neon
@@ -0,0 +1,16 @@
+includes:
+  - %rootDir%/../phpstan-phpunit/extension.neon
+
+parameters:
+  level: 3
+  treatPhpDocTypesAsCertain: false
+
+  bootstrapFiles:
+    - %rootDir%/../../apache-solr-for-typo3/solr/Build/Test/phpstan-constants.php
+
+  paths:
+    - %currentWorkingDirectory%/Classes
+    - %currentWorkingDirectory%/Tests
+
+  ignoreErrors:
+  	- '#^Variable \$value on left side of \?\? always exists and is not nullable.#'
diff --git a/Classes/Controller/Backend/PreviewController.php b/Classes/Controller/Backend/PreviewController.php
@@ -27,7 +27,6 @@
 use Psr\Http\Message\ServerRequestInterface;
 use Throwable;
 use TYPO3\CMS\Core\Http\HtmlResponse;
-use TYPO3\CMS\Core\Http\Response;
 use TYPO3\CMS\Core\Resource\ResourceFactory;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 use TYPO3\CMS\Fluid\View\StandaloneView;
@@ -38,8 +37,6 @@
 class PreviewController
 {
     /**
-     * @param ServerRequestInterface $request
-     * @return string|Response
      * @throws ClientExceptionInterface
      * @throws Throwable
      */
@@ -57,20 +54,20 @@ public function previewAction(ServerRequestInterface $request): ResponseInterfac
 
         $tikaService = $this->getConfiguredTikaService();
         $metadata = $tikaService->extractMetaData(
-            /** @scrutinizer ignore-type because checked in {@link \ApacheSolrForTypo3\Tika\ContextMenu\Preview::canHandle()} */
+            /** not real static-analysis error, because checked in {@link \ApacheSolrForTypo3\Tika\ContextMenu\Preview::canHandle()} */
             $file
         );
         $content = $tikaService->extractText(
-            /** @scrutinizer ignore-type because checked in {@link \ApacheSolrForTypo3\Tika\ContextMenu\Preview::canHandle()} */
+            /** not real static-analysis error, because checked in {@link \ApacheSolrForTypo3\Tika\ContextMenu\Preview::canHandle()} */
             $file
         );
 
         try {
             $language = $tikaService->detectLanguageFromFile(
-                /** @scrutinizer ignore-type because checked in {@link \ApacheSolrForTypo3\Tika\ContextMenu\Preview::canHandle()} */
+                /** not real static-analysis error, because checked in {@link \ApacheSolrForTypo3\Tika\ContextMenu\Preview::canHandle()} */
                 $file
             );
-        } catch (Throwable $e) {
+        } catch (Throwable) {
             $language = 'not detectable';
         }
 
@@ -85,10 +82,7 @@ public function previewAction(ServerRequestInterface $request): ResponseInterfac
         return $response;
     }
 
-    /**
-     * @return AppService|ServerService|SolrCellService
-     */
-    protected function getConfiguredTikaService(): AbstractService
+    protected function getConfiguredTikaService(): AbstractService|AppService|ServerService|SolrCellService
     {
         return ServiceFactory::getConfiguredTika();
     }
@@ -103,7 +97,7 @@ protected function getFileResourceFactory(): ResourceFactory
      */
     protected function getInitializedPreviewView(): StandaloneView
     {
-        /** @var $view StandaloneView */
+        /** @var StandaloneView $view */
         $view = GeneralUtility::makeInstance(StandaloneView::class);
         $templatePathAndFile = 'EXT:tika/Resources/Private/Templates/Backend/Preview.html';
         $view->setTemplatePathAndFilename(GeneralUtility::getFileAbsFileName($templatePathAndFile));

diff --git a/Classes/Controller/Backend/SolrModule/TikaControlPanelModuleController.php b/Classes/Controller/Backend/SolrModule/TikaControlPanelModuleController.php
@@ -19,7 +19,6 @@
 
 use ApacheSolrForTypo3\Solr\Controller\Backend\Search\AbstractModuleController;
 use ApacheSolrForTypo3\Solr\Domain\Site\Exception\UnexpectedTYPO3SiteInitializationException;
-use ApacheSolrForTypo3\Tika\Service\Tika\AbstractService;
 use ApacheSolrForTypo3\Tika\Service\Tika\AppService;
 use ApacheSolrForTypo3\Tika\Service\Tika\ServerService;
 use ApacheSolrForTypo3\Tika\Service\Tika\ServiceFactory;
@@ -46,7 +45,7 @@ class TikaControlPanelModuleController extends AbstractModuleController
 {
     protected array $tikaConfiguration = [];
 
-    protected AbstractService|AppService|ServerService|SolrCellService $tikaService;
+    protected ServerService|AppService|SolrCellService $tikaService;
 
     /**
      * Can be used in the test context to mock a {@link view}.
@@ -68,7 +67,7 @@ public function overwriteModuleTemplate(ModuleTemplate $moduleTemplate): void
         $this->moduleTemplate = $moduleTemplate;
     }
 
-    public function setTikaService(AbstractService $tikaService): void
+    public function setTikaService(ServerService|AppService|SolrCellService $tikaService): void
     {
         $this->tikaService = $tikaService;
     }
@@ -80,8 +79,6 @@ public function setTikaService(AbstractService $tikaService): void
      * @throws ExtensionConfigurationExtensionNotConfiguredException
      * @throws ExtensionConfigurationPathDoesNotExistException
      * @throws UnexpectedTYPO3SiteInitializationException
-     *
-     * @noinspection PhpUnused
      */
     protected function initializeAction(): void
     {
@@ -149,6 +146,7 @@ public function indexAction(): ResponseInterface
 
     /**
      * Starts the Tika server
+     *
      * @noinspection PhpUnused
      */
     public function startServerAction(): ResponseInterface
@@ -169,6 +167,7 @@ public function startServerAction(): ResponseInterface
 
     /**
      * Stops the Tika server
+     *
      * @noinspection PhpUnused
      */
     public function stopServerAction(): ResponseInterface

diff --git a/Classes/Report/TikaStatus.php b/Classes/Report/TikaStatus.php
@@ -183,7 +183,7 @@ protected function getSolrCellConfigurationStatus(): Status
             $solr = $this->getSolrConnectionFromTikaConfiguration();
 
             // try to extract text & meta data
-            /** @var $query Query */
+            /** @var Query $query */
             $query = GeneralUtility::makeInstance(Query::class);
             $query->setExtractOnly(true);
             $query->setFile(ExtensionManagementUtility::extPath('tika', 'ext_emconf.php'));

diff --git a/Classes/Service/Extractor/AbstractExtractor.php b/Classes/Service/Extractor/AbstractExtractor.php
@@ -22,6 +22,8 @@
 use Psr\Log\LoggerAwareInterface;
 use Psr\Log\LoggerAwareTrait;
 use Psr\Log\LogLevel;
+use TYPO3\CMS\Core\Configuration\Exception\ExtensionConfigurationExtensionNotConfiguredException;
+use TYPO3\CMS\Core\Configuration\Exception\ExtensionConfigurationPathDoesNotExistException;
 use TYPO3\CMS\Core\Resource\Index\ExtractorInterface;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 
@@ -34,27 +36,18 @@ abstract class AbstractExtractor implements ExtractorInterface, LoggerAwareInter
 {
     use LoggerAwareTrait;
 
-    /**
-     * @var array
-     */
     protected array $configuration;
 
     /**
      * Priority in handling extraction
-     *
-     * @var int
      */
     protected int $priority = 0;
 
-    /**
-     * @var SizeValidator
-     */
     protected SizeValidator $fileSizeValidator;
 
     /**
-     * Constructor
-     * @param array|null $extensionConfiguration
-     * @param SizeValidator|null $fileSizeValidator
+     * @throws ExtensionConfigurationPathDoesNotExistException
+     * @throws ExtensionConfigurationExtensionNotConfiguredException
      */
     public function __construct(array $extensionConfiguration = null, SizeValidator $fileSizeValidator = null)
     {
@@ -67,8 +60,6 @@ public function __construct(array $extensionConfiguration = null, SizeValidator
 
     /**
      * Returns an array of supported file types
-     *
-     * @return array
      */
     public function getFileTypeRestrictions(): array
     {
@@ -87,8 +78,6 @@ public function getDriverRestrictions(): array
 
     /**
      * Returns the data priority of the extraction Service.
-     *
-     * @return int
      */
     public function getPriority(): int
     {
@@ -97,8 +86,6 @@ public function getPriority(): int
 
     /**
      * Returns the execution priority of the extraction Service
-     *
-     * @return int
      */
     public function getExecutionPriority(): int
     {
@@ -107,16 +94,13 @@ public function getExecutionPriority(): int
 
     /**
      * Logs a message and optionally data to log file
-     *
-     * @param string $message Log message
-     * @param array $data Optional data
      */
     protected function log(string $message, array $data = []): void
     {
         if (!$this->configuration['logging']) {
             return;
         }
-        $this->logger->/** @scrutinizer ignore-call */ log(
+        $this->logger->log(
             LogLevel::DEBUG, // Previous value 0
             $message,
             $data

diff --git a/Classes/Service/Tika/AppService.php b/Classes/Service/Tika/AppService.php
@@ -61,7 +61,7 @@ protected function initializeService(): void
      */
     public function getTikaVersion(): string
     {
-        $tikaCommand = /** @scrutinizer ignore-type */ CommandUtility::getCommand('java')
+        $tikaCommand = CommandUtility::getCommand('java')
             . ' -Dfile.encoding=UTF8' // forces UTF8 output
             . $this->getAdditionalCommandOptions()
             . ' -jar ' . escapeshellarg(FileUtility::getAbsoluteFilePath($this->configuration['tikaPath']))
@@ -80,7 +80,7 @@ public function extractText(FileInterface $file): string
     {
         $localTempFilePath = $file->getForLocalProcessing(false);
         $tikaCommand = ShellUtility::getLanguagePrefix()
-            . /** @scrutinizer ignore-type */  CommandUtility::getCommand('java')
+            . CommandUtility::getCommand('java')
             . ' -Dfile.encoding=UTF8' // forces UTF8 output
             . $this->getAdditionalCommandOptions()
             . ' -jar ' . escapeshellarg(FileUtility::getAbsoluteFilePath($this->configuration['tikaPath']))
@@ -111,7 +111,7 @@ public function extractMetaData(FileInterface $file): array
     {
         $localTempFilePath = $file->getForLocalProcessing(false);
         $tikaCommand = ShellUtility::getLanguagePrefix()
-            . /** @scrutinizer ignore-type */ CommandUtility::getCommand('java')
+            . CommandUtility::getCommand('java')
             . ' -Dfile.encoding=UTF8'
             . $this->getAdditionalCommandOptions()
             . ' -jar ' . escapeshellarg(FileUtility::getAbsoluteFilePath($this->configuration['tikaPath']))
@@ -177,7 +177,7 @@ public function detectLanguageFromString(string $input): string
     protected function detectLanguageFromLocalFile(string $localFilePath): string
     {
         $tikaCommand = ShellUtility::getLanguagePrefix()
-            . /** @scrutinizer ignore-type */ CommandUtility::getCommand('java')
+            . CommandUtility::getCommand('java')
             . ' -Dfile.encoding=UTF8'
             . $this->getAdditionalCommandOptions()
             . ' -jar ' . escapeshellarg(FileUtility::getAbsoluteFilePath($this->configuration['tikaPath']))
@@ -315,7 +315,7 @@ public function isAvailable(): bool
     protected function getMimeTypeOutputFromTikaJar(): string
     {
         $tikaCommand = ShellUtility::getLanguagePrefix()
-            . /** @scrutinizer ignore-type */ CommandUtility::getCommand('java')
+            . CommandUtility::getCommand('java')
             . ' -Dfile.encoding=UTF8'
             . $this->getAdditionalCommandOptions()
             . ' -jar ' . escapeshellarg(FileUtility::getAbsoluteFilePath($this->configuration['tikaPath']))

diff --git a/README.md b/README.md
@@ -1,8 +1,6 @@
 # Apache Tika for TYPO3
 
 [![Build Status](https://github.com/TYPO3-Solr/ext-tika/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/TYPO3-Solr/ext-tika/actions?query=branch:release-10.0.x)
-[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/TYPO3-Solr/ext-tika/badges/quality-score.png?b=main)](https://scrutinizer-ci.com/g/TYPO3-Solr/ext-tika/?branch=main)
-[![Code Coverage](https://scrutinizer-ci.com/g/TYPO3-Solr/ext-tika/badges/coverage.png?b=main)](https://scrutinizer-ci.com/g/TYPO3-Solr/ext-tika/?branch=main)
 [![Latest Stable Version](https://poser.pugx.org/apache-solr-for-typo3/tika/v/stable)](https://packagist.org/packages/apache-solr-for-typo3/tika)
 [![License](https://poser.pugx.org/apache-solr-for-typo3/tika/license)](https://packagist.org/packages/apache-solr-for-typo3/tika)
 [![Total Downloads](http://poser.pugx.org/apache-solr-for-typo3/tika/downloads)](https://packagist.org/packages/apache-solr-for-typo3/tika)

diff --git a/Tests/Integration/Service/Tika/AppServiceTest.php b/Tests/Integration/Service/Tika/AppServiceTest.php
@@ -141,7 +141,7 @@ public function canParseMimeList(): void
     {
         $fixtureContent = file_get_contents(__DIR__ . '/Fixtures/mimeOut');
 
-        /** @var $service AppService|MockObject */
+        /** @var AppService|MockObject $service */
         $service = $this->getMockBuilder(AppService::class)
             ->disableOriginalConstructor()
             ->onlyMethods(['getMimeTypeOutputFromTikaJar'])

diff --git a/Tests/Integration/Service/Tika/ServiceIntegrationTestCase.php b/Tests/Integration/Service/Tika/ServiceIntegrationTestCase.php
@@ -206,8 +206,8 @@ protected function createDriverFixture(
         array $driverConfiguration = [],
         array $mockedDriverMethods = []
     ): LocalDriver {
-        /** @var LocalDriver $driver */
         $mockedDriverMethods[] = 'isPathValid';
+        /** @var LocalDriver|MockObject $driver */
         $driver = $this->getAccessibleMock(
             LocalDriver::class,
             $mockedDriverMethods,