Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Resource level logging testcase added. #13260

Closed
wants to merge 1 commit into from
Closed

Resource level logging testcase added. #13260

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
185 changes: 175 additions & 10 deletions ...ion/tests-backend/src/test/java/org/wso2/am/integration/tests/logging/APILoggingTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,35 +19,42 @@

import org.apache.axis2.AxisFault;
import org.apache.commons.codec.binary.Base64;
import org.apache.commons.httpclient.HttpStatus;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.conn.ssl.AllowAllHostnameVerifier;
import org.apache.http.impl.client.HttpClientBuilder;
import org.testng.Assert;
import org.testng.annotations.AfterClass;
import org.testng.annotations.BeforeClass;
import org.testng.annotations.DataProvider;
import org.testng.annotations.Factory;
import org.testng.annotations.Test;
import org.wso2.am.integration.clients.publisher.api.v1.dto.APIOperationsDTO;
import org.wso2.am.integration.clients.store.api.v1.dto.ApplicationDTO;
import org.wso2.am.integration.clients.store.api.v1.dto.ApplicationKeyDTO;
import org.wso2.am.integration.clients.store.api.v1.dto.ApplicationKeyGenerateRequestDTO;
import org.wso2.am.integration.test.utils.APIManagerIntegrationTestException;
import org.wso2.am.integration.test.utils.base.APIMIntegrationConstants;
import org.wso2.am.integration.test.utils.bean.APIRequest;
import org.wso2.am.integration.test.utils.bean.APIThrottlingTier;
import org.wso2.am.integration.test.utils.http.HTTPSClientUtils;
import org.wso2.am.integration.tests.api.lifecycle.APIManagerLifecycleBaseTest;
import org.wso2.am.integration.tests.restapi.RESTAPITestConstants;
import org.wso2.carbon.automation.engine.context.TestUserMode;
import org.wso2.carbon.automation.test.utils.http.client.HttpResponse;
import org.wso2.carbon.user.mgt.stub.UserAdminUserAdminException;
import org.wso2.carbon.utils.ServerConstants;

import java.io.BufferedReader;
import java.io.File;
import java.io.FileReader;
import java.net.URL;
import java.nio.charset.StandardCharsets;
import java.rmi.RemoteException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import javax.xml.xpath.XPathExpressionException;

Expand All @@ -57,7 +64,19 @@

public class APILoggingTest extends APIManagerLifecycleBaseTest {
private String apiId;
private String apiId2;
private APIRequest apiRequest;
private Map<String, String> requestHeaders = new HashMap<String, String>();
private String applicationId;
private ArrayList<String> grantTypes = new ArrayList<>();
private final String CALLBACK_URL = "https://localhost:9443/store/";
private String applicationId2;
private final String TIER_COLLECTION = APIMIntegrationConstants.API_TIER.UNLIMITED;
private String API_VERSION = "1.0.0";
private String endpointUrl;
private int logLineCounter = 0;
private String tokenURL;
private String identityLoginURL;

@Factory(dataProvider = "userModeDataProvider")
public APILoggingTest(TestUserMode userMode) {
Expand All @@ -70,7 +89,9 @@ public static Object[][] userModeDataProvider() {
}

@BeforeClass(alwaysRun = true)
public void initialize() throws APIManagerIntegrationTestException, AxisFault, XPathExpressionException {
public void initialize() throws APIManagerIntegrationTestException, RemoteException, XPathExpressionException,
UserAdminUserAdminException {
logLineCounter = 0;
super.init();
}

Expand All @@ -91,7 +112,6 @@ public void testAPIPerAPILoggingTestcase() throws Exception {
String API_CONTEXT = "apiloggingtest";
String API_TAGS = "testTag1, testTag2, testTag3";
String API_END_POINT_POSTFIX_URL = "xmlapi";
String API_VERSION = "1.0.0";
String APPLICATION_NAME = "APILoggingTestApp";

// Create an application
Expand All @@ -115,20 +135,21 @@ public void testAPIPerAPILoggingTestcase() throws Exception {
// Get list of APIs with an API
loggingResponse = HTTPSClientUtils.doGet(getStoreURLHttps()
+ "api/am/devops/v0/tenant-logs/carbon.super/apis", header);
assertEquals(loggingResponse.getData(), "{\"apis\":[{\"context\":\"/" + API_CONTEXT + "/" + API_VERSION + "\","
+ "\"logLevel\":\"OFF\",\"apiId\":\"" + apiId + "\"}]}");

// Change logLevel to FULL
assertEquals(loggingResponse.getData(), "{\"apis\":[{\"context\":\"/" + API_CONTEXT + "/" + API_VERSION +
"\",\"logLevel\":\"OFF\",\"apiId\":\"" + apiId + "\",\"resourceMethod\":null,\"resourcePath\":null}," +
"{\"context\":\"/" + API_CONTEXT + "/" + API_VERSION + "\",\"logLevel\":\"OFF\",\"apiId\":\""+apiId+"\",\"" +
"resourceMethod\":\"GET\",\"resourcePath\":\""
+ apiRequest.getUriTemplate() + "\"}]}");
String addNewLoggerPayload = "{ \"logLevel\": \"FULL\" }";
HTTPSClientUtils.doPut(getStoreURLHttps() + "api/am/devops/v0/tenant-logs/carbon.super/apis/" + apiId, header,
addNewLoggerPayload);

// Get list of APIs which have log-level=FULL
loggingResponse = HTTPSClientUtils.doGet(getStoreURLHttps()
+ "api/am/devops/v0/tenant-logs/carbon.super/apis?log-level=full", header);
assertEquals(loggingResponse.getData(), "{\"apis\":[{\"context\":\"/" + API_CONTEXT + "/" + API_VERSION + "\","
+ "\"logLevel\":\"FULL\",\"apiId\":\"" + apiId + "\"}]}");

assertEquals(loggingResponse.getData(), "{\"apis\":[{\"context\":\"/" + API_CONTEXT + "/" + API_VERSION +
"\",\"logLevel\":\"FULL\",\"apiId\":\"" + apiId + "\",\"resourceMethod\":null,\"resourcePath\":null}" +
"]}");
// Invoke the API
ArrayList<String> grantTypes = new ArrayList<>();
grantTypes.add("client_credentials");
Expand All @@ -148,14 +169,158 @@ public void testAPIPerAPILoggingTestcase() throws Exception {
+ File.separator + "logs" + File.separator + "api.log";
BufferedReader bufferedReader = new BufferedReader(new FileReader(apiLogFilePath));
String logLine;
int lineNo = 0;
while ((logLine = bufferedReader.readLine()) != null) {
if (lineNo == logLineCounter) {
if (logLineCounter < 4 || (logLineCounter >= 8 && logLineCounter < 12)) {
assertTrue(logLine.contains("INFO {API_LOG} " + API_NAME));
}
logLineCounter++;
}
lineNo++;
}
}

@Test(groups = {"wso2.am"}, description = "Sending http request to per API logging enabled API: ",
dependsOnMethods = "testAPIPerAPILoggingTestcase")
public void testAPIPerAPIResourceLoggingTestcase() throws Exception {
// Get list of APIs without any API
Map<String, String> header = new HashMap<>();
byte[] encodedBytes = Base64.encodeBase64(RESTAPITestConstants.BASIC_AUTH_HEADER
.getBytes(StandardCharsets.UTF_8));
header.put("Authorization", "Basic " + new String(encodedBytes, StandardCharsets.UTF_8));
header.put("Content-Type", "application/json");
HttpResponse loggingResponse = HTTPSClientUtils.doGet(getStoreURLHttps()
+ "api/am/devops/v0/tenant-logs/carbon.super/apis?log-level=full", header);
assertEquals(loggingResponse.getData(), "{\"apis\":[{\"context\":\"/apiloggingtest/" + API_VERSION +
"\",\"logLevel\":\"FULL\",\"apiId\":\"" + apiId + "\",\"resourceMethod\":null,\"resourcePath\":null}" +
"]}");

String API_NAME = "APILoggingTestAPIWithResources";
String API_CONTEXT = "apiloggingtestwithresources";
String API_TAGS = "testTag1, testTag2, testTag3";
String APPLICATION_NAME = "APILoggingTestApp2";
String DESCRIPTION = "This is a test Application";

storeURLHttp = getStoreURLHttp();
endpointUrl = backEndServerUrl.getWebAppURLHttp() + "am/sample/calculator/v1/api";
tokenURL = getKeyManagerURLHttps() + "oauth2/token";
identityLoginURL = getKeyManagerURLHttps() + "oauth2/authorize";

//create Application
HttpResponse applicationResponse = restAPIStore.createApplication(APPLICATION_NAME,
"Test Application", APIThrottlingTier.UNLIMITED.getState(),
ApplicationDTO.TokenTypeEnum.JWT);
assertEquals(applicationResponse.getResponseCode(), HttpStatus.SC_OK, "Response code is not as expected");
applicationId2 = applicationResponse.getData();
String providerName = user.getUserName();

List<APIOperationsDTO> apiOperationsDTOS = new ArrayList<>();
APIOperationsDTO apiOperationsDTOAdd = new APIOperationsDTO();
APIOperationsDTO apiOperationsDTOMultiply = new APIOperationsDTO();
apiOperationsDTOAdd.setVerb(RESTAPITestConstants.GET_METHOD);
apiOperationsDTOAdd
.setAuthType(APIMIntegrationConstants.ResourceAuthTypes.APPLICATION_AND_APPLICATION_USER.getAuthType());
apiOperationsDTOMultiply.setVerb(RESTAPITestConstants.GET_METHOD);
apiOperationsDTOMultiply
.setAuthType(APIMIntegrationConstants.ResourceAuthTypes.APPLICATION_AND_APPLICATION_USER.getAuthType());
apiOperationsDTOAdd.setThrottlingPolicy(APIMIntegrationConstants.RESOURCE_TIER.TWENTYK_PER_MIN);
apiOperationsDTOMultiply.setThrottlingPolicy(APIMIntegrationConstants.RESOURCE_TIER.TWENTYK_PER_MIN);
apiOperationsDTOAdd.setTarget("/add");
apiOperationsDTOMultiply.setTarget("/multiply");
apiOperationsDTOS.add(apiOperationsDTOAdd);
apiOperationsDTOS.add(apiOperationsDTOMultiply);

apiRequest = new APIRequest(API_NAME, API_CONTEXT, new URL(endpointUrl));
apiRequest.setVersion(API_VERSION);
apiRequest.setProvider(providerName);
apiRequest.setTiersCollection(APIMIntegrationConstants.API_TIER.UNLIMITED);
apiRequest.setTier(APIMIntegrationConstants.API_TIER.UNLIMITED);
apiRequest.setOperationsDTOS(apiOperationsDTOS);
apiRequest.setTiersCollection(TIER_COLLECTION);
apiRequest.setTags(API_TAGS);
apiRequest.setDescription(DESCRIPTION);

// Create an API and subscribe to it using created application
apiId2 = createPublishAndSubscribeToAPIUsingRest(apiRequest, restAPIPublisher, restAPIStore, applicationId2,
APIMIntegrationConstants.API_TIER.UNLIMITED);

grantTypes.add(APIMIntegrationConstants.GRANT_TYPE.CLIENT_CREDENTIAL);
grantTypes.add(APIMIntegrationConstants.GRANT_TYPE.AUTHORIZATION_CODE);
grantTypes.add(APIMIntegrationConstants.GRANT_TYPE.PASSWORD);
grantTypes.add(APIMIntegrationConstants.GRANT_TYPE.REFRESH_CODE);
grantTypes.add(APIMIntegrationConstants.GRANT_TYPE.SAML2);
grantTypes.add(APIMIntegrationConstants.GRANT_TYPE.NTLM);
grantTypes.add(APIMIntegrationConstants.GRANT_TYPE.JWT);
grantTypes.add(APIMIntegrationConstants.GRANT_TYPE.IMPLICIT);

ApplicationKeyDTO applicationKeyDTO = restAPIStore
.generateKeys(applicationId2, "3600", CALLBACK_URL, ApplicationKeyGenerateRequestDTO.KeyTypeEnum.PRODUCTION,
null, grantTypes);
assertNotNull(applicationKeyDTO.getToken().getAccessToken());
String consumerKey = applicationKeyDTO.getConsumerKey();
String consumerSecret = applicationKeyDTO.getConsumerSecret();
Assert.assertNotNull(consumerKey, "Consumer Key not found");
Assert.assertNotNull(consumerSecret, "Consumer Secret not found ");

//Invoking the api with /add and /multiply with logging disabled
requestHeaders.clear();
requestHeaders.put(APIMIntegrationConstants.AUTHORIZATION_HEADER, "Bearer " +
applicationKeyDTO.getToken().getAccessToken());
String invokeURL = getAPIInvocationURLHttp(API_CONTEXT, API_VERSION);
HttpResponse res1 = HTTPSClientUtils.doGet(invokeURL + "/add?x=1&y=1", requestHeaders);
HttpResponse res2 = HTTPSClientUtils.doGet(invokeURL + "/multiply?x=1&y=1", requestHeaders);
assertEquals(res1.getResponseCode(), HTTP_RESPONSE_CODE_OK,
"Invocation fails for GET request");
assertEquals(res2.getResponseCode(), HTTP_RESPONSE_CODE_OK,
"Invocation fails for GET request");
//Enabling the log level as full for the /add resource path and GET resource method
String addNewLoggerPayload = "{\"logLevel\": \"full\", \"resourceMethod\":\"GET\", \"resourcePath\":\"/add\"}";
HTTPSClientUtils.doPut(getStoreURLHttps() + "api/am/devops/v0/tenant-logs/carbon.super/apis/" + apiId2,
header, addNewLoggerPayload);
//Get the apis which have enabled the log level as full
loggingResponse = HTTPSClientUtils.doGet(getStoreURLHttps()
+ "api/am/devops/v0/tenant-logs/carbon.super/apis?log-level=full", header);
assertEquals(loggingResponse.getData(), "{\"apis\":[{\"context\":\"/apiloggingtest/1.0.0\",\"logLevel\":" +
"\"FULL\",\"apiId\":\"" + apiId + "\",\"resourceMethod\":null,\"resourcePath\":null},{\"context\":\"/"
+ API_CONTEXT + "/1.0.0\",\"logLevel\":\"FULL\",\"apiId\":\"" + apiId2 + "\",\"resourceMethod\":" +
"\"GET\",\"resourcePath\":\"/add\"}]}");
Thread.sleep(1000);
//Invoking the /add and /multply resource, When invoking /add, full log should be printed.
res1 = HTTPSClientUtils.doGet(invokeURL + "/add?x=1&y=1", requestHeaders);
res2 = HTTPSClientUtils.doGet(invokeURL + "/multiply?x=1&y=1", requestHeaders);
assertEquals(res1.getResponseCode(), HTTP_RESPONSE_CODE_OK,
"Invocation fails for GET request");
assertEquals(res2.getResponseCode(), HTTP_RESPONSE_CODE_OK,
"Invocation fails for GET request");

//Disabling the log level.
addNewLoggerPayload = "{\"logLevel\": \"off\", \"resourceMethod\":\"GET\", \"resourcePath\":\"/add\"}";
HTTPSClientUtils.doPut(getStoreURLHttps() + "api/am/devops/v0/tenant-logs/carbon.super/apis/" + apiId2,
header, addNewLoggerPayload);

//Validate API Logs
String apiLogFilePath = System.getProperty(ServerConstants.CARBON_HOME) + File.separator + "repository"
+ File.separator + "logs" + File.separator + "api.log";
String logLine;
BufferedReader bufferedReader = new BufferedReader(new FileReader(apiLogFilePath));
int lineNo = 0;
while ((logLine = bufferedReader.readLine()) != null) {
assertTrue(logLine.contains("INFO {API_LOG} " + API_NAME));
if (lineNo == logLineCounter) {
if (logLineCounter >= 12 || (logLineCounter >= 4 && logLineCounter < 8)) {
assertTrue(logLine.contains("INFO {API_LOG} " + API_NAME));
}
logLineCounter++;
}
lineNo++;
}
}

@AfterClass(alwaysRun = true)
void destroy() throws Exception {
restAPIStore.deleteApplication(applicationId);
restAPIStore.deleteApplication(applicationId2);
restAPIPublisher.deleteAPI(apiId);
restAPIPublisher.deleteAPI(apiId2);
}
}