aboutsummaryrefslogtreecommitdiffstats
path: root/build/integration/features/bootstrap/Search.php
blob: 6d6d9c3ecdaf550c938ee02a3e5bc4a16174c783 (plain)
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
/**
 * @copyright Copyright (c) 2018, Daniel Calviño Sánchez (danxuliu@gmail.com)
 *
 * @author Daniel Calviño Sánchez <danxuliu@gmail.com>
 *
 * @license GNU AGPL version 3 or any later version
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 *
 */

use Behat\Gherkin\Node\TableNode;
use PHPUnit\Framework\Assert;

trait Search {

	// BasicStructure trait is expected to be used in the class that uses this
	// trait.

	/**
	 * @When /^searching for "([^"]*)"$/
	 * @param string $query
	 */
	public function searchingFor(string $query) {
		$this->searchForInApp($query, '');
	}

	/**
	 * @When /^searching for "([^"]*)" in app "([^"]*)"$/
	 * @param string $query
	 * @param string $app
	 */
	public function searchingForInApp(string $query, string $app) {
		$url = '/index.php/core/search';

		$parameters[] = 'query=' . $query;
		$parameters[] = 'inApps[]=' . $app;

		$url .= '?' . implode('&', $parameters);

		$this->sendingAToWithRequesttoken('GET', $url);
	}

	/**
	 * @Then /^the list of search results has "(\d+)" results$/
	 */
	public function theListOfSearchResultsHasResults(int $count) {
		$this->theHTTPStatusCodeShouldBe(200);

		$searchResults = json_decode($this->response->getBody());

		Assert::assertEquals($count, count($searchResults));
	}

	/**
	 * @Then /^search result "(\d+)" contains$/
	 *
	 * @param int $number
	 * @param TableNode $body
	 */
	public function searchResultXContains(int $number, TableNode $body) {
		if (!($body instanceof TableNode)) {
			return;
		}

		$searchResults = json_decode($this->response->getBody(), $asAssociativeArray = true);
		$searchResult = $searchResults[$number];

		foreach ($body->getRowsHash() as $expectedField => $expectedValue) {
			if (!array_key_exists($expectedField, $searchResult)) {
				Assert::fail("$expectedField was not found in response");
			}

			Assert::assertEquals($expectedValue, $searchResult[$expectedField], "Field '$expectedField' does not match ({$searchResult[$expectedField]})");
		}
	}

}