-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: Added a Class to Help in API Testing
- Loading branch information
Showing
3 changed files
with
214 additions
and
50 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,193 @@ | ||
| <?php | ||
| /** | ||
| * This file is licensed under MIT License. | ||
| * | ||
| * Copyright (c) 2024 Ibrahim BinAlshikh | ||
| * | ||
| * For more information on the license, please visit: | ||
| * https://github.com/WebFiori/http/blob/master/LICENSE | ||
| */ | ||
|
|
||
| namespace webfiori\http; | ||
|
|
||
| use PHPUnit\Framework\TestCase; | ||
| /** | ||
| * A helper class which is used to implement test cases for API calls. | ||
| * | ||
| * @author Ibrahim | ||
| */ | ||
| class APITestCase extends TestCase { | ||
| const NL = "\r\n"; | ||
| const OUTPUT_STREAM = __DIR__.DIRECTORY_SEPARATOR.'outputStream.txt'; | ||
| /** | ||
| * Sends a GET request to specific endpoint. | ||
| * | ||
| * @param WebServicesManager $manager The manager which is used to manage the endpoint. | ||
| * | ||
| * @param string $endpoint The name of the endpoint. | ||
| * | ||
| * @param array $parameters An optional array of request parameters that can be | ||
| * passed to the endpoint. | ||
| * | ||
| * @return string The method will return the output that was produced by | ||
| * the endpoint as string. | ||
| */ | ||
| public function getRequest(WebServicesManager $manager, string $endpoint, array $parameters = []) : string { | ||
| return $this->callEndpoint($manager, RequestMethod::GET, $endpoint, $parameters); | ||
| } | ||
| /** | ||
| * Sends a POST request to specific endpoint. | ||
| * | ||
| * @param WebServicesManager $manager The manager which is used to manage the endpoint. | ||
| * | ||
| * @param string $endpoint The name of the endpoint. | ||
| * | ||
| * @param array $parameters An optional array of request parameters that can be | ||
| * passed to the endpoint. | ||
| * | ||
| * @return string The method will return the output that was produced by | ||
| * the endpoint as string. | ||
| */ | ||
| public function postRequest(WebServicesManager $manager, string $endpoint, array $parameters = []) : string { | ||
| return $this->callEndpoint($manager, RequestMethod::POST, $endpoint, $parameters); | ||
| } | ||
| /** | ||
| * Sends a PUT request to specific endpoint. | ||
| * | ||
| * @param WebServicesManager $manager The manager which is used to manage the endpoint. | ||
| * | ||
| * @param string $endpoint The name of the endpoint. | ||
| * | ||
| * @param array $parameters An optional array of request parameters that can be | ||
| * passed to the endpoint. | ||
| * | ||
| * @return string The method will return the output that was produced by | ||
| * the endpoint as string. | ||
| */ | ||
| public function putRequest(WebServicesManager $manager, string $endpoint, array $parameters = []) : string { | ||
| return $this->callEndpoint($manager, RequestMethod::PUT, $endpoint, $parameters); | ||
| } | ||
| /** | ||
| * Sends a DELETE request to specific endpoint. | ||
| * | ||
| * @param WebServicesManager $manager The manager which is used to manage the endpoint. | ||
| * | ||
| * @param string $endpoint The name of the endpoint. | ||
| * | ||
| * @param array $parameters An optional array of request parameters that can be | ||
| * passed to the endpoint. | ||
| * | ||
| * @return string The method will return the output that was produced by | ||
| * the endpoint as string. | ||
| */ | ||
| public function deletRequest(WebServicesManager $manager, string $endpoint, array $parameters = []) : string { | ||
| return $this->callEndpoint($manager, RequestMethod::DELETE, $endpoint, $parameters); | ||
| } | ||
| /** | ||
| * Performs a call to an endpoint. | ||
| * | ||
| * @param WebServicesManager $manager The services manager instance that is used to | ||
| * manage the service. | ||
| * | ||
| * @param string $requestMethod A string that represents the name of request | ||
| * method such as 'get' or 'post'. | ||
| * | ||
| * @param string $apiEndpointName The name of the endpoint that will be called such as 'add-user'. | ||
| * | ||
| * @param array $parameters A dictionary thar represents the parameters that | ||
| * will be sent to the endpoint. The name is parameter name as it appears in | ||
| * service implementation and its value is the value of the parameter. | ||
| * | ||
| * @return string The method will return the output of the endpoint. | ||
| */ | ||
| public function callEndpoint(WebServicesManager $manager, string $requestMethod, string $apiEndpointName, array $parameters = []) : string { | ||
| $manager->setOutputStream(fopen(self::OUTPUT_STREAM,'w')); | ||
| $method = strtoupper($requestMethod); | ||
| putenv('REQUEST_METHOD='.$method); | ||
|
|
||
| if ($method == 'GET' || $method == 'DELETE') { | ||
|
|
||
| foreach ($parameters as $key => $val) { | ||
| $_GET[$key] = $val; | ||
| } | ||
| $_GET['service'] = $apiEndpointName; | ||
| $this->unset($_GET, $parameters, $manager); | ||
| } else if ($method == 'POST' || $method == 'PUT') { | ||
|
|
||
| foreach ($parameters as $key => $val) { | ||
| $_POST[$key] = $val; | ||
| } | ||
| $_POST['service'] = $apiEndpointName; | ||
| $_SERVER['CONTENT_TYPE'] = 'multipart/form-data'; | ||
| $this->unset($_POST, $parameters, $manager); | ||
| } | ||
|
|
||
| $retVal = $manager->readOutputStream(); | ||
| unlink(self::OUTPUT_STREAM); | ||
|
|
||
| return $retVal; | ||
| } | ||
| /** | ||
| * Adds a file to the array $_FILES for testing API with upload. | ||
| * | ||
| * @param string $fileIdx The name of the index that will hold the blob. | ||
| * This is usually represented by the attribute 'name' of file input in | ||
| * the front-end. | ||
| * | ||
| * @param string $filePath The path of the file within testing environment. | ||
| * | ||
| * @param bool $reset If set to true, the array $_FILES will be re-initialized. | ||
| */ | ||
| public function addFile(string $fileIdx, string $filePath, bool $reset = false) { | ||
| if ($reset) { | ||
| $_FILES = []; | ||
| } | ||
| if (!isset($_FILES[$fileIdx])) { | ||
| $_FILES[$fileIdx] = []; | ||
| $_FILES[$fileIdx]['name'] = []; | ||
| $_FILES[$fileIdx]['type'] = []; | ||
| $_FILES[$fileIdx]['size'] = []; | ||
| $_FILES[$fileIdx]['tmp_name'] = []; | ||
| $_FILES[$fileIdx]['error'] = []; | ||
| } | ||
| $info = $this->extractPathAndName($filePath); | ||
| $path = $info['path'].DS.$info['name']; | ||
|
|
||
| $_FILES[$fileIdx]['name'][] = $info['name']; | ||
| $_FILES[$fileIdx]['type'][] = mime_content_type($path); | ||
| $_FILES[$fileIdx]['size'][] = filesize($this->getAbsolutePath()); | ||
| $_FILES[$fileIdx]['tmp_name'][] = $path; | ||
| $_FILES[$fileIdx]['error'][] = 0; | ||
| } | ||
| private function extractPathAndName($absPath): array { | ||
| $DS = DIRECTORY_SEPARATOR; | ||
| $cleanPath = str_replace('\\', $DS, str_replace('/', $DS, trim($absPath))); | ||
| $pathArr = explode($DS, $cleanPath); | ||
|
|
||
| if (count($pathArr) != 0) { | ||
| $fPath = ''; | ||
| $name = $pathArr[count($pathArr) - 1]; | ||
|
|
||
| for ($x = 0 ; $x < count($pathArr) - 1 ; $x++) { | ||
| $fPath .= $pathArr[$x].$DS; | ||
| } | ||
|
|
||
| return [ | ||
| 'path' => $fPath, | ||
| 'name' => $name | ||
| ]; | ||
| } | ||
|
|
||
| return [ | ||
| 'name' => $cleanPath, | ||
| 'path' => '' | ||
| ]; | ||
| } | ||
| private function unset(array &$arr, array $params, WebServicesManager $m) { | ||
| $m->process(); | ||
|
|
||
| foreach ($params as $key => $val) { | ||
| unset($arr[$key]); | ||
| } | ||
| } | ||
| } |