Merge pull request #73 from Icinga/release/v1.0

Release/v1.0
Icinga · Aug 9, 2024 · b0f0e1a · b0f0e1a
2 parents 54c1aa2 + 6d318a3
commit b0f0e1a
Show file tree

Hide file tree

Showing 43 changed files with 1,357 additions and 657 deletions.
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -0,0 +1,6 @@
+version: 2
+updates:
+- package-ecosystem: "github-actions"
+  directory: "/"
+  schedule:
+    interval: monthly
diff --git a/.github/workflows/php.yml b/.github/workflows/php.yml
@@ -8,21 +8,22 @@ on:
   pull_request:
     branches:
       - main
+      - release/*
 
 jobs:
   lint:
-    name: Static analysis for php ${{ matrix.php }} on ${{ matrix.os }}
+    name: Lint and Code Style
     runs-on: ${{ matrix.os }}
 
     strategy:
       fail-fast: false
       matrix:
-        php: ['8.0', '8.1', '8.2']
+        php: ['8.2', '8.3']
         os: ['ubuntu-latest']
 
     steps:
       - name: Checkout code base
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
@@ -40,3 +41,37 @@ jobs:
       - name: PHP CodeSniffer
         if: success() || matrix.allow_failure
         run: phpcs -wps --colors
+
+  test:
+    name: Unittest
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      fail-fast: false
+      matrix:
+        php: ['8.2', '8.3']
+        os: ['ubuntu-latest']
+
+    steps:
+      - name: Checkout code base
+        uses: actions/checkout@v4
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php }}
+          tools: 'phpunit:10.4'
+
+      - name: Setup Libraries
+        run: |
+          mkdir -p _libraries
+          git clone --depth 1 -b snapshot/nightly https://github.com/Icinga/icinga-php-library.git _libraries/ipl
+          git clone --depth 1 -b snapshot/nightly https://github.com/Icinga/icinga-php-thirdparty.git _libraries/vendor
+          git clone --depth 1 https://github.com/Icinga/icingaweb2.git _icingaweb2
+          git clone --depth 1 https://github.com/Icinga/icingadb-web.git _icingaweb2/modules/icingadb
+          ln -s `pwd` _icingaweb2/modules/toplevelview
+
+      - name: PHPUnit
+        env:
+          ICINGAWEB_LIBDIR:  _libraries/
+        run: phpunit
diff --git a/.gitignore b/.gitignore
@@ -8,7 +8,11 @@
 !.git*
 
 # Artifacts from vendor parts in testing
+_icingaweb2/
+_libraries/
+.phpunit.cache/
 .phplint.cache/
+reports/
 /docker-compose.yml
 /*.phar
 /Icinga

diff --git a/Makefile b/Makefile
@@ -0,0 +1,15 @@
+.PHONY: setup test
+
+setup:
+	mkdir -p _libraries &&\
+	git clone --depth 1 -b snapshot/nightly https://github.com/Icinga/icinga-php-library.git _libraries/ipl &&\
+	git clone --depth 1 -b snapshot/nightly https://github.com/Icinga/icinga-php-thirdparty.git _libraries/vendor &&\
+	git clone --depth 1 https://github.com/Icinga/icingaweb2.git _icingaweb2 &&\
+	git clone --depth 1 https://github.com/Icinga/icingadb-web.git _icingaweb2/modules/icingadb
+	ln -s `pwd` _icingaweb2/modules/toplevelview
+test:
+	ICINGAWEB_LIBDIR=_libraries phpunit
+lint:
+	phplint application/ library/
+phpcs:
+	phpcs application/ library/
diff --git a/README.md b/README.md
@@ -23,19 +23,13 @@ children:
     - host: anotherhost
       service: ssh
   - name: Tile 2
-    - hostgroup: linux-servers
-  - name: Tile 3
-- name: Section 2
-  - name: Tile 1
-  - name: Tile 2
+    hostgroup: linux-servers
+  - servicegroup: http
 ```
 
 With a caching layer, this view can aggregate thousands of status objects and make
 them easily available for overview and drill down.
 
-This view extends the status logic and behavior of Icinga Web 2 a bit,
-please see the documentation on details.
-
 ## Requirements
 
 * Icinga Web 2 >= 2.5.0

diff --git a/RELEASE.md b/RELEASE.md
@@ -3,7 +3,7 @@
 Specify the release version.
 
 ```
-VERSION=0.x.x
+VERSION=1.x.x
 ```
 
 ## Issues

diff --git a/application/controllers/EditController.php b/application/controllers/EditController.php
@@ -3,10 +3,13 @@
 
 namespace Icinga\Module\Toplevelview\Controllers;
 
+use Icinga\Module\Toplevelview\Model\View;
 use Icinga\Module\Toplevelview\Forms\EditForm;
 use Icinga\Module\Toplevelview\ViewConfig;
 use Icinga\Module\Toplevelview\Web\Controller;
+
 use Icinga\Web\Url;
+use Icinga\Application\Icinga;
 
 class EditController extends Controller
 {
@@ -39,26 +42,45 @@ public function indexAction()
     {
         $action = $this->getRequest()->getActionName();
 
+        $config_dir_module = Icinga::app()
+                           ->getModuleManager()
+                           ->getModule('toplevelview')
+                           ->getConfigDir();
+
+        $c = new ViewConfig($config_dir_module);
+        $view = null;
+
         if ($action === 'add') {
             $this->view->title = sprintf('%s Top Level View', $this->translate('Add'));
-            $view = new ViewConfig();
-            $view->setConfigDir();
+            $view = new View('', $c::FORMAT_YAML);
         } elseif ($action === 'clone') {
+            // Clone the view and give it to the View
             $name = $this->params->getRequired('name');
             $this->view->title = sprintf('%s Top Level View', $this->translate('Clone'));
-            $view = clone ViewConfig::loadByName($name);
+
+            // Check if the user has permissions/restrictions for this View
+            $restrictions = $c->getRestrictions('toplevelview/filter/edit');
+            $c->assertAccessToView($restrictions, $name);
+
+            $view = clone $c->loadByName($name);
         } else {
             $this->view->name = $name = $this->params->getRequired('name');
             $this->view->title = sprintf('%s Top Level View: %s', $this->translate('Edit'), $this->params->getRequired('name'));
-            $view = ViewConfig::loadByName($name);
+
+            // Check if the user has permissions/restrictions for this View
+            $restrictions = $c->getRestrictions('toplevelview/filter/edit');
+            $c->assertAccessToView($restrictions, $name);
+
+            $view = $c->loadByName($name);
         }
 
+        $view->setFormat($c::FORMAT_YAML);
+
         $this->view->form = $form = new EditForm();
+        $form->setViewConfig($c);
+        $form->setViews($view);
 
-        $view->setFormat(ViewConfig::FORMAT_YAML);
-        $form->setViewConfig($view);
         $form->handleRequest();
-
         $this->setViewScript('edit/index');
     }
 

diff --git a/application/controllers/IndexController.php b/application/controllers/IndexController.php
@@ -6,6 +6,8 @@
 use Icinga\Module\Toplevelview\ViewConfig;
 use Icinga\Module\Toplevelview\Web\Controller;
 
+use Icinga\Application\Icinga;
+
 /**
  * IndexController loads all existing Views from their YAML files.
  */
@@ -19,7 +21,15 @@ public function indexAction()
         ])->activate('index');
 
         // Load add views from the existing YAML files
-        $this->view->views = ViewConfig::loadAll();
+        $config_dir_module = Icinga::app()
+                           ->getModuleManager()
+                           ->getModule('toplevelview')
+                           ->getConfigDir();
+
+        $c = new ViewConfig($config_dir_module);
+        $views = $c->loadAll();
+
+        $this->view->views = $views;
 
         $this->setAutorefreshInterval(30);
     }

diff --git a/application/controllers/ShowController.php b/application/controllers/ShowController.php
@@ -5,16 +5,16 @@
 
 use Icinga\Module\Toplevelview\ViewConfig;
 use Icinga\Module\Toplevelview\Web\Controller;
+
 use Icinga\Web\Url;
+use Icinga\Application\Icinga;
 
 class ShowController extends Controller
 {
     public function init()
     {
         $tabs = $this->getTabs();
-
         $url = Url::fromRequest()->setParams(clone $this->params);
-
         $tiles = Url::fromPath('toplevelview/show', ['name' => $this->params->getRequired('name')]);
 
         $tabs->add('index', [
@@ -43,7 +43,21 @@ public function init()
     public function indexAction()
     {
         $this->view->name = $name = $this->params->getRequired('name');
-        $this->view->view = $view = ViewConfig::loadByName($name);
+
+        $config_dir_module = Icinga::app()
+                           ->getModuleManager()
+                           ->getModule('toplevelview')
+                           ->getConfigDir();
+
+        $c = new ViewConfig($config_dir_module);
+
+        // Check if the user has permissions/restrictions for this View
+        $restrictions = $c->getRestrictions('toplevelview/filter/views');
+        $c->assertAccessToView($restrictions, $name);
+
+        $view = $c->loadByName($name);
+        $this->view->view = $view;
+
         $tree = $view->getTree();
 
         if (($lifetime = $this->getParam('cache')) !== null) {
@@ -56,7 +70,20 @@ public function indexAction()
     public function treeAction()
     {
         $this->view->name = $name = $this->params->getRequired('name');
-        $this->view->view = $view = ViewConfig::loadByName($name);
+
+        $config_dir_module = Icinga::app()
+                           ->getModuleManager()
+                           ->getModule('toplevelview')
+                           ->getConfigDir();
+
+        $c = new ViewConfig($config_dir_module);
+
+        // Check if the user has permissions/restrictions for this View
+        $restrictions = $c->getRestrictions('toplevelview/filter/views');
+        $c->assertAccessToView($restrictions, $name);
+
+        $view = $c->loadByName($name);
+        $this->view->view = $view;
 
         $tree = $view->getTree();
 
@@ -72,7 +99,20 @@ public function treeAction()
     public function sourceAction()
     {
         $this->view->name = $name = $this->params->getRequired('name');
-        $this->view->view = $view = ViewConfig::loadByName($name);
+
+        $config_dir_module = Icinga::app()
+                           ->getModuleManager()
+                           ->getModule('toplevelview')
+                           ->getConfigDir();
+
+        $c = new ViewConfig($config_dir_module);
+
+        // Check if the user has permissions/restrictions for this View
+        $restrictions = $c->getRestrictions('toplevelview/filter/views');
+        $c->assertAccessToView($restrictions, $name);
+
+        $view = $c->loadByName($name);
+        $this->view->view = $view;
 
         $this->view->text = $view->getText();
         $this->setViewScript('index', 'text');