blob: 87042c559b3734e53f253eee190965697e78726f (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
|
<?php
/**
* Tests for the Helpindex widget.
*
* SPDX-FileCopyrightText: 2024 Harald Eilertsen
* SPDX-FileCopyrightText: 2024 Hubzilla Community
*
* SPDX-License-Identifier: MIT
*/
use PHPUnit\Framework\Attributes\Before;
/**
* Test class for testing the Helpindex widget.
*/
class HelpindexTest extends \Zotlabs\Tests\Unit\Module\TestCase {
use \phpmock\phpunit\PHPMock;
private string $output;
/**
* Define the stubs to make sure they work later in the test.
*
* @see https://php-mock.github.io/php-mock-phpunit/api/class-phpmock.phpunit.PHPMock.html#_defineFunctionMock
*
* @beforeClass
*/
public static function define_stubs(): void {
self::defineFunctionMock('Zotlabs\Lib\Traits', 'file_exists');
self::defineFunctionMock('Zotlabs\Widget', 'file_get_contents');
}
#[Before]
public function setup_state(): void {
// Make sure the output is cleared before running the test
$this->output = '';
}
public function test_loading_toc(): void {
// Stub `file_get_contents` to plant our own content.
$fgc_stub = $this->getFunctionMock('Zotlabs\Widget', 'file_get_contents');
$fgc_stub
->expects($this->once())
->with($this->equalTo('doc/en/toc.html'))
->willReturn('toc');
// Stub `file_exists` to only return true for the english toc file
$fe_stub = $this->getFunctionMock('Zotlabs\Lib\Traits', 'file_exists');
$fe_stub
->expects($this->any())
->willReturnCallback(fn (string $path) => $path === 'doc/en/toc.html' );
$this->render_widget();
$this->assertOutputContains('toc');
//$this->assertOutputContains('Help Content');
}
public function test_that_result_is_empty_when_toc_not_present(): void {
// Ensure `file_get_contents` is not called during the test.
$fgc_stub = $this->getFunctionMock('Zotlabs\Widget', 'file_get_contents');
$fgc_stub->expects($this->never());
// Stub `file_exists` to always return false to simulate that we
// can't find the toc file.
$fe_stub = $this->getFunctionMock('Zotlabs\Lib\Traits', 'file_exists');
$fe_stub
->expects($this->any())
->willReturn(false);
$this->render_widget();
}
/**
* Initializes the app and calls the widget code.
*/
private function render_widget(): void {
$_GET['q'] = 'help/en/about/about';
$_SERVER['REQUEST_METHOD'] = 'GET';
\App::init();
$widget = new \Zotlabs\Widget\Helpindex();
$this->output = $widget->widget([]);
}
private function assertOutputContains(string $needle): void {
$this->assertStringContainsString($needle, $this->output);
}
}
|
