xref: /webtrees/tests/app/Services/ModuleServiceTest.php (revision ca50fb84724cb523ca8f4be8abd453a667296dcf) 
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2019 webtrees development team
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program. If not, see <http://www.gnu.org/licenses/>.
16 */
17
18declare(strict_types=1);
19
20namespace Fisharebest\Webtrees\Services;
21
22use Fisharebest\Webtrees\Module\ModuleAnalyticsInterface;
23use Fisharebest\Webtrees\Module\ModuleBlockInterface;
24use Fisharebest\Webtrees\Module\ModuleChartInterface;
25use Fisharebest\Webtrees\Module\ModuleConfigInterface;
26use Fisharebest\Webtrees\Module\ModuleInterface;
27use Fisharebest\Webtrees\Module\ModuleMenuInterface;
28use Fisharebest\Webtrees\Module\ModuleReportInterface;
29use Fisharebest\Webtrees\Module\ModuleSidebarInterface;
30use Fisharebest\Webtrees\Module\ModuleTabInterface;
31use Fisharebest\Webtrees\Module\ModuleThemeInterface;
32use Fisharebest\Webtrees\TestCase;
33use Illuminate\Database\Capsule\Manager as DB;
34
35/**
36 * Test the modules
37 *
38 * @coversNothing
39 */
40class ModuleServiceTest extends TestCase
41{
42    protected static $uses_database = true;
43
44    /**
45     * @covers \Fisharebest\Webtrees\Services\ModuleService::all
46     * @covers \Fisharebest\Webtrees\Services\ModuleService::coreModules
47     * @covers \Fisharebest\Webtrees\Services\ModuleService::customModules
48     * @covers \Fisharebest\Webtrees\Services\ModuleService::moduleSorter
49     * @return void
50     */
51    public function testAll(): void
52    {
53        $module_service = new ModuleService();
54
55        $this->assertNotEmpty($module_service->all());
56    }
57
58    /**
59     * @covers \Fisharebest\Webtrees\Services\ModuleService::findByComponent
60     * @covers \Fisharebest\Webtrees\Services\ModuleService::menuSorter
61     * @covers \Fisharebest\Webtrees\Services\ModuleService::sidebarSorter
62     * @covers \Fisharebest\Webtrees\Services\ModuleService::tabSorter
63     * @return void
64     */
65    public function testFindByComponent(): void
66    {
67        $user_service   = new UserService();
68        $module_service = new ModuleService();
69
70        $tree = $this->importTree('demo.ged');
71        $user = $user_service->create('UserName', 'RealName', 'user@example.com', 'secret');
72
73        $this->assertNotEmpty($module_service->findByComponent(ModuleBlockInterface::class, $tree, $user)->all());
74        $this->assertNotEmpty($module_service->findByComponent(ModuleChartInterface::class, $tree, $user)->all());
75        $this->assertNotEmpty($module_service->findByComponent(ModuleMenuInterface::class, $tree, $user)->all());
76        $this->assertNotEmpty($module_service->findByComponent(ModuleReportInterface::class, $tree, $user)->all());
77        $this->assertNotEmpty($module_service->findByComponent(ModuleSidebarInterface::class, $tree, $user)->all());
78        $this->assertNotEmpty($module_service->findByComponent(ModuleTabInterface::class, $tree, $user)->all());
79    }
80
81    /**
82     * @covers \Fisharebest\Webtrees\Services\ModuleService::findByInterface
83     * @return void
84     */
85    public function testFindByInterface(): void
86    {
87        $module_service = new ModuleService();
88
89        $this->assertNotEmpty($module_service->findByInterface(ModuleAnalyticsInterface::class, true)->all());
90        $this->assertNotEmpty($module_service->findByInterface(ModuleBlockInterface::class, true)->all());
91        $this->assertNotEmpty($module_service->findByInterface(ModuleChartInterface::class, true)->all());
92        $this->assertNotEmpty($module_service->findByInterface(ModuleConfigInterface::class, true)->all());
93        $this->assertNotEmpty($module_service->findByInterface(ModuleMenuInterface::class, true)->all());
94        $this->assertNotEmpty($module_service->findByInterface(ModuleInterface::class, true)->all());
95        $this->assertNotEmpty($module_service->findByInterface(ModuleReportInterface::class, true)->all());
96        $this->assertNotEmpty($module_service->findByInterface(ModuleSidebarInterface::class, true)->all());
97        $this->assertNotEmpty($module_service->findByInterface(ModuleTabInterface::class, true)->all());
98        $this->assertNotEmpty($module_service->findByInterface(ModuleThemeInterface::class, true)->all());
99
100        // Search for an invalid module type
101        $this->assertEmpty($module_service->findByInterface('not-a-valid-class-or-interface')->all());
102    }
103
104    /**
105     * @covers \Fisharebest\Webtrees\Services\ModuleService::otherModules
106     * @return void
107     */
108    public function testOtherModules(): void
109    {
110        DB::table('module')->insert(['module_name' => 'not-a-module']);
111
112        $module_service = new ModuleService();
113
114        $this->assertSame(3, $module_service->otherModules()->count());
115    }
116
117    /**
118     * @covers \Fisharebest\Webtrees\Services\ModuleService::deletedModules
119     * @return void
120     */
121    public function testDeletedModules(): void
122    {
123        DB::table('module')->insert(['module_name' => 'not-a-module']);
124
125        $module_service = new ModuleService();
126
127        $this->assertSame(1, $module_service->deletedModules()->count());
128        $this->assertSame('not-a-module', $module_service->deletedModules()->first());
129    }
130}
131