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/Api/ComponentGroupTest.php

@@ -11,6 +11,9 @@
 
 namespace CachetHQ\Tests\Cachet\Api;
 
+use CachetHQ\Cachet\Models\Component;
+use CachetHQ\Cachet\Models\ComponentGroup;
+
 /**
  * This is the component group test class.
  *
@@ -19,9 +22,13 @@ namespace CachetHQ\Tests\Cachet\Api;
  */
 class ComponentGroupTest extends AbstractApiTestCase
 {
+    const COMPONENT_GROUP_1_NAME = 'Component Group 1';
+    const COMPONENT_GROUP_2_NAME = 'Component Group 2';
+
     public function testGetGroups()
     {
-        $groups = factory('CachetHQ\Cachet\Models\ComponentGroup', 3)->create();
+        $groups = factory('CachetHQ\Cachet\Models\ComponentGroup', 3)
+            ->create(['visible' => ComponentGroup::VISIBLE_GUEST]);
 
         $this->get('/api/v1/components/groups');
         $this->seeJson(['id' => $groups[0]->id]);
@@ -59,8 +66,9 @@ class ComponentGroupTest extends AbstractApiTestCase
             'name'      => 'Foo',
             'order'     => 1,
             'collapsed' => 1,
+            'visible'   => ComponentGroup::VISIBLE_GUEST,
         ]);
-        $this->seeJson(['name' => 'Foo', 'order' => 1, 'collapsed' => 1]);
+        $this->seeJson(['name' => 'Foo', 'order' => 1, 'collapsed' => 1, 'visible' => ComponentGroup::VISIBLE_GUEST]);
         $this->assertResponseOk();
     }
 
@@ -93,4 +101,58 @@ class ComponentGroupTest extends AbstractApiTestCase
         $this->delete('/api/v1/components/groups/1');
         $this->assertResponseStatus(204);
     }
+
+    /** @test */
+    public function only_public_component_groups_are_shown_for_a_guest()
+    {
+        $this->createComponentGroups();
+
+        $this->get('/api/v1/components/groups')
+            ->seeJson(['name' => self::COMPONENT_GROUP_1_NAME])
+            ->dontSeeJson(['name' => self::COMPONENT_GROUP_2_NAME]);
+        $this->assertResponseOk();
+    }
+
+    /** @test */
+    public function all_component_groups_are_displayed_for_loggedin_users()
+    {
+        $this->createComponentGroups()
+            ->signIn();
+
+        $this->get('/api/v1/components/groups')
+            ->seeJson(['name' => self::COMPONENT_GROUP_1_NAME])
+            ->seeJson(['name' => self::COMPONENT_GROUP_2_NAME]);
+        $this->assertResponseOk();
+    }
+
+    /**
+     * Set up the needed data for the tests.
+     *
+     * @return TestCase
+     */
+    protected function createComponentGroups()
+    {
+        $this->createComponentGroup(self::COMPONENT_GROUP_1_NAME, ComponentGroup::VISIBLE_GUEST)
+            ->createComponentGroup(self::COMPONENT_GROUP_2_NAME, ComponentGroup::VISIBLE_AUTHENTICATED);
+
+        return $this;
+    }
+
+    /**
+     * Create a component group.
+     * Also attaches a creator if any given as a parameter
+     * or exists in the test class.
+     *
+     * @param string $name
+     * @param string $visible
+     *
+     * @return AbstractApiTestCase
+     */
+    protected function createComponentGroup($name, $visible)
+    {
+        factory(ComponentGroup::class)
+            ->create(['name' => $name, 'visible' => $visible]);
+
+        return $this;
+    }
 }