mirror of
https://framagit.org/hubzilla/core.git
synced 2026-06-21 00:52:33 -04:00
7a7ff97e63
We need to mock the call to `is_readable`, since the file requested in the test does not actually exist in the file system.
96 lines
2.7 KiB
PHP
96 lines
2.7 KiB
PHP
<?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_from_html(): 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 `is_readable` to only return true for the english toc file
|
|
$is_readable_stub = $this->getFunctionMock('Zotlabs\Widget', 'is_readable');
|
|
$is_readable_stub
|
|
->expects($this->any())
|
|
->willReturnCallback(fn (string $path) => $path === 'doc/en/toc.html' );
|
|
|
|
// 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');
|
|
}
|
|
|
|
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);
|
|
}
|
|
}
|