aboutsummaryrefslogtreecommitdiffstats
path: root/tests/phpunit/structure/ContentHandlerFunctionalTest.php
blob: f119d6d9b96ff2021e9f00ae2c9a9c8244b473a3 (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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
<?php
/**
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 * http://www.gnu.org/copyleft/gpl.html
 *
 * @file
 */

use MediaWiki\Content\Renderer\ContentParseParams;
use MediaWiki\Content\TextContentHandler;
use MediaWiki\Content\Transform\PreloadTransformParamsValue;
use MediaWiki\Content\Transform\PreSaveTransformParamsValue;
use MediaWiki\MediaWikiServices;
use MediaWiki\Parser\ParserOutput;
use Wikimedia\TestingAccessWrapper;

/**
 * @group Database
 * @coversNothing
 */
class ContentHandlerFunctionalTest extends MediaWikiIntegrationTestCase {

	public function testMakeEmptyContent() {
		$contentHandlerFactory = MediaWikiServices::getInstance()->getContentHandlerFactory();
		foreach ( $contentHandlerFactory->getContentModels() as $model ) {
			$handler = $this->getServiceContainer()->getContentHandlerFactory()
				->getContentHandler( $model );

			$content = $handler->makeEmptyContent();
			$this->assertInstanceOf( Content::class, $content );
			if ( $handler instanceof TextContentHandler ) {
				// TextContentHandler::getContentClass() is protected, so bypass
				// that restriction
				$testingWrapper = TestingAccessWrapper::newFromObject( $handler );
				$this->assertInstanceOf( $testingWrapper->getContentClass(), $content );
			}

			$handlerClass = get_class( $handler );
			$contentClass = get_class( $content );

			if ( $handler->supportsDirectEditing() ) {
				$this->assertTrue(
					$content->isValid(),
					"$handlerClass::makeEmptyContent() did not return a valid content ($contentClass::isValid())"
				);
			}
		}
	}

	/**
	 * Test that getParserOutput works on all content models
	 */
	public function testGetParserOutput() {
		$contentHandlerFactory = MediaWikiServices::getInstance()->getContentHandlerFactory();
		foreach ( $contentHandlerFactory->getContentModels() as $model ) {
			$this->filterDeprecated( '/Use of AbstractContent::getParserOutput was deprecated/' );

			$handler = $this->getServiceContainer()->getContentHandlerFactory()
				->getContentHandler( $model );

			$title = $this->getExistingTestPage()->getTitle();
			$content = $handler->makeEmptyContent();

			$gpoParams = new ContentParseParams( $title );
			$this->assertInstanceOf(
				ParserOutput::class,
				$handler->getParserOutput( $content, $gpoParams )
			);
		}
	}

	/**
	 * Test that preSaveTransform works on all content models
	 */
	public function testPreSaveTransform() {
		$contentHandlerFactory = MediaWikiServices::getInstance()->getContentHandlerFactory();
		foreach ( $contentHandlerFactory->getContentModels() as $model ) {
			$this->filterDeprecated( '/Use of AbstractContent::preSaveTransform was deprecated/' );

			$handler = $this->getServiceContainer()->getContentHandlerFactory()
				->getContentHandler( $model );

			$title = $this->getExistingTestPage()->getTitle();
			$user = $this->getTestUser()->getUser();
			$popts = ParserOptions::newFromAnon();
			$content = $handler->makeEmptyContent();

			$pstParams = new PreSaveTransformParamsValue( $title, $user, $popts );
			$this->assertInstanceOf(
				Content::class,
				$handler->preSaveTransform( $content, $pstParams )
			);
		}
	}

	/**
	 * Test that preloadTransform works on all content models
	 */
	public function testPreloadTransform() {
		$contentHandlerFactory = MediaWikiServices::getInstance()->getContentHandlerFactory();
		foreach ( $contentHandlerFactory->getContentModels() as $model ) {
			$this->filterDeprecated( '/Use of AbstractContent::preloadTransform was deprecated/' );

			$handler = $this->getServiceContainer()->getContentHandlerFactory()
				->getContentHandler( $model );

			$title = $this->getExistingTestPage()->getTitle();
			$popts = ParserOptions::newFromAnon();
			$content = $handler->makeEmptyContent();

			$pltParams = new PreloadTransformParamsValue( $title, $popts, [] );
			$this->assertInstanceOf(
				Content::class,
				$handler->preloadTransform( $content, $pltParams )
			);
		}
	}

	/**
	 * Test that serialization and unserialization works on all content models
	 */
	public function testSerializationRoundTrips() {
		$contentHandlerFactory = MediaWikiServices::getInstance()->getContentHandlerFactory();
		foreach ( $contentHandlerFactory->getContentModels() as $model ) {
			if ( preg_match( '/^wikibase-/', $model ) ) {
				// TODO: Make Wikibase support serialization of empty content, just so
				//       we can test it here.
				$this->markTestSkipped( 'Wikibase doesn\'t support serializing empty content' );
			}

			$handler = $this->getServiceContainer()->getContentHandlerFactory()
				->getContentHandler( $model );

			$content = $handler->makeEmptyContent();
			$data = $content->serialize();
			$content2 = $handler->unserializeContent( $data );
			$this->assertTrue( $content->equals( $content2 ) );
		}
	}
}