aboutsummaryrefslogtreecommitdiffstats
path: root/tests/phpunit/unit/includes/Rest/PathTemplateMatcher/PathMatcherTest.php
blob: 870ef8f16d6eb940983a6bd69cdb296fb52e1c06 (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
<?php

namespace MediaWiki\Tests\Rest\PathTemplateMatcher;

use MediaWiki\Rest\PathTemplateMatcher\PathConflict;
use MediaWiki\Rest\PathTemplateMatcher\PathMatcher;
use MediaWiki\Rest\PathTemplateMatcher\PathSegmentException;
use MediaWikiUnitTestCase;

/**
 * @covers \MediaWiki\Rest\PathTemplateMatcher\PathMatcher
 * @covers \MediaWiki\Rest\PathTemplateMatcher\PathConflict
 * @covers \MediaWiki\Rest\PathTemplateMatcher\PathSegmentException
 */
class PathMatcherTest extends MediaWikiUnitTestCase {
	private const NORMAL_ROUTES = [
		'/a/b',
		'/b/{x}',
		'/c/{x}/d',
		'/c/{x}/e',
		'/c/{x}/{y}/d',
		'/d/',
		'/d/{x}',
		'/',
		'/{x}'
	];

	public static function provideErrorRoutes() {
		return [
			[ '/d//e' ]
		];
	}

	public static function provideConflictingRoutes() {
		return [
			[ '/a/b', 0, '/a/b' ],
			[ '/a/{x}', 0, '/a/b' ],
			[ '/{x}/c', 1, '/b/{x}' ],
			[ '/b/a', 1, '/b/{x}' ],
			[ '/b/{x}', 1, '/b/{x}' ],
			[ '/{x}/{y}/d', 2, '/c/{x}/d' ]
		];
	}

	public static function provideMatch() {
		return [
			[ '', false ],
			[ '/a/', false ],
			[ '/a/b', [ 'params' => [], 'userData' => 0 ] ],
			[ '/b/1', [ 'params' => [ 'x' => '1' ], 'userData' => 1 ] ],
			[ '/c/1', false ],
			[ '/c/1/d', [ 'params' => [ 'x' => '1' ], 'userData' => 2 ] ],
			[ '/c/1/e', [ 'params' => [ 'x' => '1' ], 'userData' => 3 ] ],
			[ '/c/000/e', [ 'params' => [ 'x' => '000' ], 'userData' => 3 ] ],
			[ '/c/1/f', false ],
			[ '/c//e', [ 'params' => [ 'x' => '' ], 'userData' => 3 ] ],
			[ '/c///e', false ],
			[ '/d/', [ 'params' => [], 'userData' => 5 ] ],
			[ '/d/1', [ 'params' => [ 'x' => '1' ], 'userData' => 6 ] ],
			[ '/', [ 'params' => [], 'userData' => 7 ] ],
			[ '/1', [ 'params' => [ 'x' => '1' ], 'userData' => 8 ] ],
			[ '/1/', false ]
		];
	}

	public function createNormalRouter() {
		$pm = new PathMatcher;
		foreach ( self::NORMAL_ROUTES as $i => $route ) {
			$pm->add( $route, $i );
		}
		return $pm;
	}

	/** @dataProvider provideErrorRoutes */
	public function testAddError( $attempt ) {
		$pm = $this->createNormalRouter();

		$this->expectException( PathSegmentException::class );
		$pm->add( $attempt, 'error' );
	}

	/** @dataProvider provideConflictingRoutes */
	public function testAddConflict( $attempt, $expectedUserData, $expectedTemplate ) {
		$pm = $this->createNormalRouter();
		$actualTemplate = null;
		$actualUserData = null;
		try {
			$pm->add( $attempt, 'conflict' );
		} catch ( PathConflict $pc ) {
			$actualTemplate = $pc->existingTemplate;
			$actualUserData = $pc->existingUserData;
		}
		$this->assertSame( $expectedUserData, $actualUserData );
		$this->assertSame( $expectedTemplate, $actualTemplate );
	}

	/** @dataProvider provideMatch */
	public function testMatch( $path, $expectedResult ) {
		$pm = $this->createNormalRouter();
		$result = $pm->match( $path );
		$this->assertSame( $expectedResult, $result );
	}
}