diff --git a/.drone.star b/.drone.star index 9fda683de..7fa4f5a7a 100644 --- a/.drone.star +++ b/.drone.star @@ -242,6 +242,16 @@ config = { "GATEWAY_GRPC_ADDR": "0.0.0.0:9142", }, }, + "authApp": { + "suites": [ + "apiAuthApp", + ], + "skip": False, + "extraServerEnvironment": { + "OCIS_ADD_RUN_SERVICES": "auth-app", + "PROXY_ENABLE_APP_AUTH": True, + }, + }, "cliCommands": { "suites": [ "cliCommands", diff --git a/tests/acceptance/TestHelpers/AuthAppHelper.php b/tests/acceptance/TestHelpers/AuthAppHelper.php new file mode 100644 index 000000000..f308280b2 --- /dev/null +++ b/tests/acceptance/TestHelpers/AuthAppHelper.php @@ -0,0 +1,94 @@ + + * @copyright Copyright (c) 2024 Niraj Acharya niraj@jankaritech.com + * + * This code 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 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 + * + */ + +namespace TestHelpers; + +use Psr\Http\Message\ResponseInterface; + +/** + * A helper class for managing Auth App API requests + */ +class AuthAppHelper { + + /** + * @return string + */ + public static function getAuthAppEndpoint():string { + return "/auth-app/tokens"; + } + + /** + * @param string $baseUrl + * @param string $user + * @param string $password + * + * @return ResponseInterface + */ + public static function listAllAppAuthToken(string $baseUrl, string $user, string $password) : ResponseInterface { + $url = $baseUrl . self::getAuthAppEndpoint(); + return HttpRequestHelper::sendRequest( + $url, + null, + "GET", + $user, + $password, + ); + } + + /** + * @param string $baseUrl + * @param string $user + * @param string $password + * @param string $expiration + * + * @return ResponseInterface + */ + public static function createAppAuthToken(string $baseUrl, string $user, string $password, string $expiration) : ResponseInterface { + $url = $baseUrl . self::getAuthAppEndpoint() . "?expiry=$expiration"; + return HttpRequestHelper::sendRequest( + $url, + null, + "POST", + $user, + $password, + ); + } + + /** + * @param string $baseUrl + * @param string $user + * @param string $password + * @param string $token + * + * @return ResponseInterface + */ + public static function deleteAppAuthToken(string $baseUrl, string $user, string $password, string $token) : ResponseInterface { + $url = $baseUrl . self::getAuthAppEndpoint() . "?token=$token"; + return HttpRequestHelper::sendRequest( + $url, + null, + "DELETE", + $user, + $password, + ); + } +} diff --git a/tests/acceptance/bootstrap/AuthAppContext.php b/tests/acceptance/bootstrap/AuthAppContext.php new file mode 100644 index 000000000..50f77a28a --- /dev/null +++ b/tests/acceptance/bootstrap/AuthAppContext.php @@ -0,0 +1,138 @@ + + * @copyright Copyright (c) 2024 Niraj Acharya niraj@jankaritech.com + * + * This code 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 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 + * + */ + +use Behat\Behat\Context\Context; +use Behat\Behat\Hook\Scope\BeforeScenarioScope; +use TestHelpers\BehatHelper; +use GuzzleHttp\Exception\GuzzleException; +use TestHelpers\AuthAppHelper; + +require_once 'bootstrap.php'; + +/** + * AuthApp context + */ +class AuthAppContext implements Context { + private FeatureContext $featureContext; + private array $allCreatedTokens = []; + + /** + * @BeforeScenario + * + * @param BeforeScenarioScope $scope + * + * @return void + */ + public function before(BeforeScenarioScope $scope): void { + // Get the environment + $environment = $scope->getEnvironment(); + // Get all the contexts you need in this context + $this->featureContext = BehatHelper::getContext($scope, $environment, 'FeatureContext'); + } + + /** + * @When the administrator creates app token with expiration time :expiration using the API + * + * @param string $expiration + * + * @return void + */ + public function theAdministratorCreatesAppTokenForUserWithExpirationTimeUsingTheApi(string $expiration): void { + $this->featureContext->setResponse( + AuthAppHelper::createAppAuthToken( + $this->featureContext->getBaseUrl(), + $this->featureContext->getAdminUsername(), + $this->featureContext->getAdminPassword(), + $expiration, + ) + ); + } + + /** + * @Given the administrator has created app token with expiration time :expiration using the API + * + * @param string $expiration + * + * @return void + */ + public function theAdministratorHasCreatedAppTokenWithExpirationTimeUsingTheApi(string $expiration): void { + $response = AuthAppHelper::createAppAuthToken( + $this->featureContext->getBaseUrl(), + $this->featureContext->getAdminUsername(), + $this->featureContext->getAdminPassword(), + $expiration, + ); + $this->featureContext->theHTTPStatusCodeShouldBe(200, "", $response); + } + + /** + * @When admin lists all created tokens + * + * @return void + */ + public function adminListsAllCreatedTokens(): void { + $this->featureContext->setResponse( + AuthAppHelper::listAllAppAuthToken( + $this->featureContext->getBaseUrl(), + $this->featureContext->getAdminUsername(), + $this->featureContext->getAdminPassword(), + ) + ); + } + + /** + * @return void + */ + public function deleteAllToken() : void { + $response = AuthAppHelper::listAllAppAuthToken( + $this->featureContext->getBaseUrl(), + $this->featureContext->getAdminUsername(), + $this->featureContext->getAdminPassword(), + ); + $this->featureContext->theHTTPStatusCodeShouldBe(200, "", $response); + $rawBody = $response->getBody()->getContents(); + $tokens = json_decode($rawBody); + foreach ($tokens as $token) { + $this->featureContext->theHTTPStatusCodeShouldBe( + 200, + "", + AuthAppHelper::deleteAppAuthToken( + $this->featureContext->getBaseUrl(), + $this->featureContext->getAdminUsername(), + $this->featureContext->getAdminPassword(), + $token->token + ) + ); + } + } + + /** + * @AfterScenario + * + * @return void + * + * @throws Exception|GuzzleException + */ + public function cleanDataAfterTests(): void { + $this->deleteAllToken(); + } +} diff --git a/tests/acceptance/config/behat.yml b/tests/acceptance/config/behat.yml index 8d35def18..04a57217c 100644 --- a/tests/acceptance/config/behat.yml +++ b/tests/acceptance/config/behat.yml @@ -424,6 +424,14 @@ default: - FeatureContext: *common_feature_context_params - OcisConfigContext: + apiAuthApp: + paths: + - "%paths.base%/../features/apiAuthApp" + context: *common_ldap_suite_context + contexts: + - FeatureContext: *common_feature_context_params + - AuthAppContext: + cliCommands: paths: - "%paths.base%/../features/cliCommands" diff --git a/tests/acceptance/features/apiAuthApp/token.feature b/tests/acceptance/features/apiAuthApp/token.feature new file mode 100644 index 000000000..5b2673d84 --- /dev/null +++ b/tests/acceptance/features/apiAuthApp/token.feature @@ -0,0 +1,62 @@ +Feature: create auth token + As a admin + I want to create App Tokens + So that I can use 3rd party apps + + + Scenario: admin creates app token + When the administrator creates app token with expiration time "72h" using the API + Then the HTTP status code should be "200" + And the JSON data of the response should match + """ + { + "type": "object", + "required": [ + "token", + "expiration_date", + "created_date", + "label" + ], + "properties": { + "token": { + "type": "string", + "pattern": "^[a-zA-Z0-9]{16}$" + }, + "label": { + "const": "Generated via API" + } + } + } + """ + + + Scenario: admin lists app token + Given the administrator has created app token with expiration time "72h" using the API + When admin lists all created tokens + Then the HTTP status code should be "200" + And the JSON data of the response should match + """ + { + "type": "array", + "minItems": 1, + "maxItems": 1, + "items": { + "type": "object", + "required": [ + "token", + "expiration_date", + "created_date", + "label" + ], + "properties": { + "token": { + "type": "string", + "pattern": "^\\$2a\\$11\\$[A-Za-z0-9./]{53}$" + }, + "label": { + "const": "Generated via API" + } + } + } + } + """