Add visibility to component groups (#2027)

Implement visibility for the components groups. Closes #1892

Add functional test that asserts a guest can only see public items.

* Fix tests not running due to hitting the Setup page.

The missing `boostrap/cachet/testing.php` file is now generated the first time tests are ran.

* Add a functional test that asserts logged in users can see all items.

Add constants for possible values for the visible column/field of the ComponentGroup model.
Code review changes.

* Add API tests for component group visibility feature.

* Implement the visibility hidden option for a component group. Fixes #1892.

Add migration for the created_by column, in component_groups table.
Add methods to the ComponentGroup and User models to be able to work with the created_by column.
Hidden component groups are no longer displayed on the index page for loggedin users.
Add functional test for the dashboard page.
Save owner on create/edit component group.
Update the API tests for Component group visibility feature.

* Replace auth() usage with app(Guard::class).

* Apply StyleCI fixes.

* Drop the hidden visibility feature and fix all tests.

Some code review fixes too.

* Rename public to visible since it's a reserved keyword. Apply StyleCI fixes and correct typo.

* Code review changes.

* Tidy up component and component groups gathering.

* Code review changes and StyleCI fixes.

* Code review changes.

* Remove extra whitespace

* Remove useless method.

tests/Http/Controllers/Dashboard/DashboardControllerTest.php

@@ -0,0 +1,84 @@
+<?php
+
+/*
+ * This file is part of Cachet.
+ *
+ * (c) Alt Three Services Limited
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace CachetHQ\Tests\Cachet\Http\Controllers;
+
+use CachetHQ\Cachet\Models\Component;
+use CachetHQ\Cachet\Models\ComponentGroup;
+use CachetHQ\Cachet\Models\Setting;
+use CachetHQ\Cachet\Models\User;
+use CachetHQ\Tests\Cachet\AbstractTestCase;
+use Illuminate\Foundation\Testing\DatabaseMigrations;
+use Illuminate\Foundation\Testing\TestCase;
+
+class DashboardControllerTest extends AbstractTestCase
+{
+    use DatabaseMigrations;
+
+    const COMPONENT_GROUP_1_NAME = 'Component Group 1';
+    const COMPONENT_GROUP_2_NAME = 'Component Group 2';
+
+    /**
+     * @var User
+     */
+    protected $user;
+
+    protected function setUp()
+    {
+        parent::setUp();
+
+        $this->setupPublicAndNonPublicComponentGroups()
+            ->setupConfig();
+    }
+
+    /** @test */
+    public function on_dashboard_all_component_groups_are_displayed()
+    {
+        $this->signIn();
+
+        $this->visit('/dashboard')
+            ->see(self::COMPONENT_GROUP_1_NAME)
+            ->see(self::COMPONENT_GROUP_2_NAME);
+    }
+
+    /**
+     * Set up the needed data for the components groups tests.
+     *
+     * @return TestCase
+     */
+    protected function setupPublicAndNonPublicComponentGroups()
+    {
+        $this->createAComponentGroupAndAddAComponent(self::COMPONENT_GROUP_1_NAME, ComponentGroup::VISIBLE_GUEST)
+            ->createAComponentGroupAndAddAComponent(self::COMPONENT_GROUP_2_NAME, ComponentGroup::VISIBLE_AUTHENTICATED);
+
+        factory(Setting::class)->create();
+
+        return $this;
+    }
+
+    /**
+     * Create a component group and add one component to it.
+     *
+     * @param string $name
+     * @param string $visible
+     *
+     * @return TestCase
+     */
+    protected function createAComponentGroupAndAddAComponent($name, $visible)
+    {
+        factory(ComponentGroup::class)
+            ->create(['name' => $name, 'visible' => $visible])
+            ->components()
+            ->save(factory(Component::class)->create());
+
+        return $this;
+    }
+}

tests/Http/Controllers/StatusPageControllerTest.php

@@ -0,0 +1,91 @@
+<?php
+
+/*
+ * This file is part of Cachet.
+ *
+ * (c) Alt Three Services Limited
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace CachetHQ\Tests\Cachet\Http\Controllers;
+
+use CachetHQ\Cachet\Models\Component;
+use CachetHQ\Cachet\Models\ComponentGroup;
+use CachetHQ\Cachet\Models\Setting;
+use CachetHQ\Cachet\Models\User;
+use CachetHQ\Tests\Cachet\AbstractTestCase;
+use Illuminate\Foundation\Testing\DatabaseMigrations;
+
+class StatusPageControllerTest extends AbstractTestCase
+{
+    use DatabaseMigrations;
+
+    const COMPONENT_GROUP_1_NAME = 'Component Group 1';
+    const COMPONENT_GROUP_2_NAME = 'Component Group 2';
+
+    /**
+     * @var User
+     */
+    protected $user;
+
+    protected function setUp()
+    {
+        parent::setUp();
+
+        $this->setupPublicAndNonPublicComponentGroups()
+            ->setupConfig();
+    }
+
+    /** @test */
+    public function on_index_only_public_component_groups_are_shown_to_a_guest()
+    {
+        $this->visit('/')
+            ->see(self::COMPONENT_GROUP_1_NAME)
+            ->dontSee(self::COMPONENT_GROUP_2_NAME);
+    }
+
+    /** @test */
+    public function on_index_all_component_groups_are_displayed_to_logged_in_users()
+    {
+        $this->signIn();
+
+        $this->visit('/')
+            ->see(self::COMPONENT_GROUP_1_NAME)
+            ->see(self::COMPONENT_GROUP_2_NAME);
+    }
+
+    /**
+     * Set up the needed data for the components groups tests.
+     *
+     * @return AbstractTestCase
+     */
+    protected function setupPublicAndNonPublicComponentGroups()
+    {
+        $this->createAComponentGroupAndAddAComponent(self::COMPONENT_GROUP_1_NAME, ComponentGroup::VISIBLE_GUEST)
+            ->createAComponentGroupAndAddAComponent(self::COMPONENT_GROUP_2_NAME, ComponentGroup::VISIBLE_AUTHENTICATED);
+
+        factory(Setting::class)->create();
+
+        return $this;
+    }
+
+    /**
+     * Create a component group and add one component to it.
+     *
+     * @param string $name
+     * @param string $visible
+     *
+     * @return AbstractTestCase
+     */
+    protected function createAComponentGroupAndAddAComponent($name, $visible)
+    {
+        factory(ComponentGroup::class)
+            ->create(['name' => $name, 'visible' => $visible])
+            ->components()
+            ->save(factory(Component::class)->create());
+
+        return $this;
+    }
+}