Github Actions: Add Phpstan (#187)

Icinga · Sep 6, 2023 · ca78cf1 · ca78cf1
2 parents 062ba04 + bd355b5
commit ca78cf1
Show file tree

Hide file tree

Showing 22 changed files with 1,539 additions and 76 deletions.
diff --git a/.github/workflows/php.yml b/.github/workflows/php.yml
@@ -31,12 +31,22 @@ jobs:
           tools: phpcs
 
       - name: Setup dependencies
-        run: composer require -n --no-progress overtrue/phplint
+        run: |
+          composer require -n --no-progress overtrue/phplint
+          git clone --depth 1 https://github.com/Icinga/icingaweb2.git vendor/icingaweb2
+          git clone --depth 1 https://github.com/Icinga/icingadb-web.git vendor/icingadb
+          git clone --depth 1 https://github.com/Icinga/icingaweb2-module-pdfexport.git vendor/pdfexport
+          git clone --depth 1 -b snapshot/nightly https://github.com/Icinga/icinga-php-library.git vendor/icinga-php-library
+          git clone --depth 1 -b snapshot/nightly https://github.com/Icinga/icinga-php-thirdparty.git vendor/icinga-php-thirdparty
 
       - name: PHP Lint
-        if: success() || matrix.allow_failure
+        if: ${{ ! cancelled() }}
         run: ./vendor/bin/phplint -n --exclude={^vendor/.*} -- .
 
       - name: PHP CodeSniffer
-        if: success() || matrix.allow_failure
+        if: ${{ ! cancelled() }}
         run: phpcs -wps --colors
+
+      - name: PHPStan
+        if: ${{ ! cancelled() }}
+        uses: php-actions/phpstan@v3
diff --git a/application/clicommands/DownloadCommand.php b/application/clicommands/DownloadCommand.php
@@ -47,6 +47,7 @@ public function defaultAction()
             $this->fail($this->translate('Argument id is mandatory'));
         }
 
+        /** @var Model\Report $report */
         $report = Model\Report::on($this->getDb())
             ->with('timeframe')
             ->filter(Filter::equal('id', $id))

diff --git a/application/clicommands/ListCommand.php b/application/clicommands/ListCommand.php
@@ -70,7 +70,7 @@ public function indexAction()
         }
 
         if ($reports->count() === 0) {
-            printf($this->translate("No reports found\n"));
+            print $this->translate("No reports found\n");
             exit;
         }
 
@@ -121,7 +121,7 @@ protected function outputTable($reports, array $dataCallbacks)
         $beautifier .= "\n";
 
         printf($format, ...array_keys($columnsAndLengths));
-        printf($beautifier);
+        print $beautifier;
 
         foreach ($rows as $row) {
             printf($format, ...$row);

diff --git a/application/controllers/ReportController.php b/application/controllers/ReportController.php
@@ -33,6 +33,7 @@ public function init()
     {
         $reportId = $this->params->getRequired('id');
 
+        /** @var Model\Report $report */
         $report = Model\Report::on($this->getDb())
             ->with(['timeframe'])
             ->filter(Filter::equal('id', $reportId))
@@ -74,8 +75,8 @@ public function cloneAction()
 
         foreach ($reportlet->getConfig() as $name => $value) {
             if ($name === 'name') {
-                if (preg_match('/(?:Clone )(\d+)$/', $value, $matches)) {
-                    $value = preg_replace('/\d+$/', ++$matches[1], $value);
+                if (preg_match('/(?:Clone )(\d+)$/', $value, $m)) {
+                    $value = preg_replace('/\d+$/', (string) ((int) $m[1] + 1), $value);
                 } else {
                     $value .= ' Clone 1';
                 }
@@ -153,7 +154,11 @@ public function scheduleAction()
         $form = ScheduleForm::fromReport($this->report);
         $form->setAction((string) Url::fromRequest())
             ->on(ScheduleForm::ON_SUCCESS, function () use ($form) {
-                $pressedButton = $form->getPressedSubmitElement()->getName();
+                $pressedButton = $form->getPressedSubmitElement();
+                if ($pressedButton) {
+                    $pressedButton = $pressedButton->getName();
+                }
+
                 if ($pressedButton === 'remove') {
                     Notification::success($this->translate('Removed schedule successfully'));
                 } elseif ($pressedButton === 'send') {
@@ -192,8 +197,9 @@ public function downloadAction()
 
         switch ($type) {
             case 'pdf':
-                /** @var Hook\PdfexportHook */
-                Pdfexport::first()->streamPdfFromHtml($this->report->toPdf(), $name);
+                /** @var Hook\PdfexportHook $exports */
+                $exports = Pdfexport::first();
+                $exports->streamPdfFromHtml($this->report->toPdf(), $name);
                 exit;
             case 'csv':
                 $response = $this->getResponse();

diff --git a/application/controllers/ReportsController.php b/application/controllers/ReportsController.php
@@ -55,6 +55,7 @@ public function indexAction()
 
         $this->addControl($sortControl);
 
+        /** @var Report $report */
         foreach ($reports as $report) {
             $url = Url::fromPath('reporting/report', ['id' => $report->id])->getAbsoluteUrl('&');
 

diff --git a/application/controllers/TemplateController.php b/application/controllers/TemplateController.php
@@ -24,6 +24,7 @@ public function indexAction()
     {
         $this->createTabs()->activate('preview');
 
+        /** @var Model\Template $template */
         $template = Model\Template::on($this->getDb())
             ->filter(Filter::equal('id', $this->params->getRequired('id')))
             ->first();
@@ -50,6 +51,7 @@ public function editAction()
 
         $this->createTabs()->activate('edit');
 
+        /** @var Model\Template $template */
         $template = Model\Template::on($this->getDb())
             ->filter(Filter::equal('id', $this->params->getRequired('id')))
             ->first();

diff --git a/application/controllers/TemplatesController.php b/application/controllers/TemplatesController.php
@@ -53,6 +53,10 @@ public function indexAction()
 
         $this->addControl($sortControl);
 
+
+        $tableRows = [];
+
+        /** @var Model\Template $template */
         foreach ($templates as $template) {
             if ($canManage) {
                 $subjectLink = new Link(

diff --git a/application/controllers/TestController.php b/application/controllers/TestController.php
diff --git a/application/controllers/TimeframeController.php b/application/controllers/TimeframeController.php
@@ -22,6 +22,7 @@ class TimeframeController extends Controller
 
     public function init()
     {
+        /** @var Model\Timeframe $timeframe */
         $timeframe = Model\Timeframe::on($this->getDb())
             ->filter(Filter::equal('id', $this->params->getRequired('id')))
             ->first();

diff --git a/library/Reporting/Actions/SendMail.php b/library/Reporting/Actions/SendMail.php
@@ -33,7 +33,7 @@ public function execute(Report $report, array $config)
         $mail = new Mail();
 
         $mail->setFrom(
-            Config::module('reporting', 'config', 'true')->get('mail', 'from', 'reporting@icinga')
+            Config::module('reporting', 'config', true)->get('mail', 'from', 'reporting@icinga')
         );
 
         if (isset($config['subject'])) {

diff --git a/library/Reporting/Database.php b/library/Reporting/Database.php
@@ -8,6 +8,7 @@
 use Icinga\Data\ResourceFactory;
 use ipl\Sql;
 use PDO;
+use stdClass;
 
 trait Database
 {
@@ -35,7 +36,7 @@ protected function listTimeframes()
             ->columns(['id', 'name']);
 
         $timeframes = [];
-
+        /** @var stdClass $row */
         foreach ($this->getDb()->select($select) as $row) {
             $timeframes[$row->id] = $row->name;
         }
@@ -50,7 +51,7 @@ protected function listTemplates()
             ->columns(['id', 'name']);
 
         $templates = [];
-
+        /** @var stdClass $row */
         foreach ($this->getDb()->select($select) as $row) {
             $templates[$row->id] = $row->name;
         }

diff --git a/library/Reporting/Hook/ReportHook.php b/library/Reporting/Hook/ReportHook.php
@@ -56,7 +56,7 @@ public function initConfigForm(Form $form)
     /**
      * Get the description of the report
      *
-     * @return  string
+     * @return ?string
      */
     public function getDescription()
     {

diff --git a/library/Reporting/Mail.php b/library/Reporting/Mail.php
@@ -14,13 +14,13 @@ class Mail
     /** @var string */
     public const DEFAULT_SUBJECT = 'Icinga Reporting';
 
-    /** @var string */
+    /** @var ?string */
     protected $from;
 
     /** @var string */
     protected $subject = self::DEFAULT_SUBJECT;
 
-    /** @var Zend_Mail_Transport_Sendmail */
+    /** @var ?Zend_Mail_Transport_Sendmail */
     protected $transport;
 
     /** @var array */

diff --git a/library/Reporting/Reportlet.php b/library/Reporting/Reportlet.php
@@ -22,8 +22,6 @@ class Reportlet
     public static function fromModel(Model\Reportlet $reportletModel): self
     {
         $reportlet = new static();
-
-        $reportlet->id = $reportletModel->id;
         $reportlet->class = $reportletModel->class;
 
         $reportletConfig = [

diff --git a/library/Reporting/Schedule.php b/library/Reporting/Schedule.php
@@ -147,6 +147,9 @@ public function run(): ExtendedPromiseInterface
             $deferred->resolve();
         });
 
-        return $deferred->promise();
+        /** @var ExtendedPromiseInterface $promise */
+        $promise = $deferred->promise();
+
+        return $promise;
     }
 }
diff --git a/library/Reporting/Web/Forms/ReportForm.php b/library/Reporting/Web/Forms/ReportForm.php
@@ -9,6 +9,7 @@
 use Icinga\Module\Reporting\ProvidedReports;
 use ipl\Html\Contract\FormSubmitElement;
 use ipl\Html\Form;
+use ipl\Html\HtmlDocument;
 use ipl\Validator\CallbackValidator;
 use ipl\Web\Compat\CompatForm;
 
@@ -148,7 +149,10 @@ protected function assemble()
                 'formnovalidate' => true
             ]);
             $this->registerElement($removeButton);
-            $this->getElement('submit')->getWrapper()->prepend($removeButton);
+
+            /** @var HtmlDocument $wrapper */
+            $wrapper = $this->getElement('submit')->getWrapper();
+            $wrapper->prepend($removeButton);
         }
     }
 

diff --git a/library/Reporting/Web/Forms/ScheduleForm.php b/library/Reporting/Web/Forms/ScheduleForm.php
@@ -6,6 +6,7 @@
 
 use DateTime;
 use Icinga\Application\Icinga;
+use Icinga\Application\Web;
 use Icinga\Authentication\Auth;
 use Icinga\Module\Reporting\Database;
 use Icinga\Module\Reporting\Hook\ActionHook;
@@ -14,6 +15,7 @@
 use Icinga\Util\Json;
 use ipl\Html\Contract\FormSubmitElement;
 use ipl\Html\Form;
+use ipl\Html\HtmlDocument;
 use ipl\Html\HtmlElement;
 use ipl\Scheduler\Contract\Frequency;
 use ipl\Web\Compat\CompatForm;
@@ -35,7 +37,9 @@ class ScheduleForm extends CompatForm
     public function __construct()
     {
         $this->scheduleElement = new ScheduleElement('schedule_element');
-        $this->scheduleElement->setIdProtector([Icinga::app()->getRequest(), 'protectId']);
+        /** @var Web $app */
+        $app = Icinga::app();
+        $this->scheduleElement->setIdProtector([$app->getRequest(), 'protectId']);
     }
 
     public function getPartUpdates(): array
@@ -122,7 +126,10 @@ protected function assemble()
                 'formnovalidate' => true
             ]);
             $this->registerElement($sendButton);
-            $this->getElement('submit')->getWrapper()->prepend($sendButton);
+
+            /** @var HtmlDocument $wrapper */
+            $wrapper = $this->getElement('submit')->getWrapper();
+            $wrapper->prepend($sendButton);
 
             /** @var FormSubmitElement $removeButton */
             $removeButton = $this->createElement('submit', 'remove', [
@@ -131,7 +138,7 @@ protected function assemble()
                 'formnovalidate' => true
             ]);
             $this->registerElement($removeButton);
-            $this->getElement('submit')->getWrapper()->prepend($removeButton);
+            $wrapper->prepend($removeButton);
         }
     }
 

diff --git a/library/Reporting/Web/Forms/TemplateForm.php b/library/Reporting/Web/Forms/TemplateForm.php
@@ -10,6 +10,7 @@
 use Icinga\Module\Reporting\Database;
 use ipl\Html\Contract\FormSubmitElement;
 use ipl\Html\Html;
+use ipl\Html\HtmlDocument;
 use ipl\Web\Compat\CompatForm;
 
 class TemplateForm extends CompatForm
@@ -143,7 +144,10 @@ protected function assemble()
                 'formnovalidate' => true
             ]);
             $this->registerElement($removeButton);
-            $this->getElement('submit')->getWrapper()->prepend($removeButton);
+
+            /** @var HtmlDocument $wrapper */
+            $wrapper = $this->getElement('submit')->getWrapper();
+            $wrapper->prepend($removeButton);
         }
     }
 

diff --git a/library/Reporting/Web/Forms/TimeframeForm.php b/library/Reporting/Web/Forms/TimeframeForm.php
@@ -9,6 +9,7 @@
 use Icinga\Module\Reporting\Database;
 use ipl\Html\Contract\FormSubmitElement;
 use ipl\Html\FormElement\LocalDateTimeElement;
+use ipl\Html\HtmlDocument;
 use ipl\Validator\CallbackValidator;
 use ipl\Web\Compat\CompatForm;
 
@@ -174,7 +175,10 @@ protected function assemble()
                 'formnovalidate' => true
             ]);
             $this->registerElement($removeButton);
-            $this->getElement('submit')->getWrapper()->prepend($removeButton);
+
+            /** @var HtmlDocument $wrapper */
+            $wrapper = $this->getElement('submit')->getWrapper();
+            $wrapper->prepend($removeButton);
         }
     }
 

diff --git a/library/Reporting/Web/Widget/HeaderOrFooter.php b/library/Reporting/Web/Widget/HeaderOrFooter.php
@@ -64,9 +64,9 @@ protected function resolveVariable($variable)
 
     protected function createColumn(array $data, $key)
     {
-        $typeKey = "${key}_type";
-        $valueKey = "${key}_value";
-        $type = isset($data[$typeKey]) ? $data[$typeKey] : null;
+        $typeKey = "{$key}_type";
+        $valueKey = "{$key}_value";
+        $type = $data[$typeKey] ?? null;
 
         switch ($type) {
             case 'text':