test-version22
/
MeterSphere
mirror of https://gitee.com/fit2cloud-feizhiyun/MeterSphere.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

refactor(接口测试): 优化mock执行可以带mock的期望id

This commit is contained in:
wxg0103 2024-05-13 17:01:37 +08:00 committed by 刘瑞斌
parent 782eaa88fd
commit ce0ed0711e
7 changed files with 54 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
backend/services/api-test/src/main/java/io/metersphere/api/controller/mockserver/MockServerController.java
View File

@ -11,7 +11,7 @@ import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.*;
@RestController
@RequestMapping(value = "/mock-server/{projectNum}/{apiNum}/**")
@RequestMapping(value = {"/mock-server/{projectNum}/{apiNum}/{mockNum}/**", "/mock-server/{projectNum}/{apiNum}/**"})
@Tag(name = "接口测试-接口管理-接口定义-Mock")
@MultipartConfig
public class MockServerController {
@ -21,54 +21,54 @@ public class MockServerController {
@RequestMapping(method = RequestMethod.OPTIONS)
@NoResultHolder
public ResponseEntity<?> optionsRequest(@PathVariable String projectNum, @PathVariable String apiNum, HttpServletRequest request) {
return mockServerService.execute(HttpMethod.OPTIONS.name(), projectNum, apiNum, request);
public ResponseEntity<?> optionsRequest(@PathVariable String projectNum, @PathVariable String apiNum, @PathVariable String mockNum, HttpServletRequest request) {
return mockServerService.execute(HttpMethod.OPTIONS.name(), projectNum, apiNum, mockNum, request);
}
@RequestMapping(method = RequestMethod.HEAD)
@NoResultHolder
public ResponseEntity<?> headerRequest(@PathVariable String projectNum, @PathVariable String apiNum, HttpServletRequest request) {
return mockServerService.execute(HttpMethod.HEAD.name(), projectNum, apiNum, request);
public ResponseEntity<?> headerRequest(@PathVariable String projectNum, @PathVariable String apiNum, @PathVariable String mockNum, HttpServletRequest request) {
return mockServerService.execute(HttpMethod.HEAD.name(), projectNum, apiNum, mockNum, request);
}
@RequestMapping(method = RequestMethod.TRACE)
@NoResultHolder
public ResponseEntity<?> traceRequest(@PathVariable String projectNum, @PathVariable String apiNum, HttpServletRequest request) {
return mockServerService.execute(HttpMethod.TRACE.name(), projectNum, apiNum, request);
public ResponseEntity<?> traceRequest(@PathVariable String projectNum, @PathVariable String apiNum, @PathVariable String mockNum, HttpServletRequest request) {
return mockServerService.execute(HttpMethod.TRACE.name(), projectNum, apiNum, mockNum, request);
}
@GetMapping
@NoResultHolder
public ResponseEntity<?> getMockRequest(@PathVariable String projectNum, @PathVariable String apiNum, HttpServletRequest request) {
return handleMockRequest(HttpMethod.GET.name(), projectNum, apiNum, request);
public ResponseEntity<?> getMockRequest(@PathVariable String projectNum, @PathVariable String apiNum, @PathVariable(required = false) String mockNum, HttpServletRequest request) {
return handleMockRequest(HttpMethod.GET.name(), projectNum, apiNum, mockNum, request);
}
@PostMapping
@NoResultHolder
public ResponseEntity<?> postMockRequest(@PathVariable String projectNum, @PathVariable String apiNum, HttpServletRequest request) {
return handleMockRequest(HttpMethod.POST.name(), projectNum, apiNum, request);
public ResponseEntity<?> postMockRequest(@PathVariable String projectNum, @PathVariable String apiNum, @PathVariable String mockNum, HttpServletRequest request) {
return handleMockRequest(HttpMethod.POST.name(), projectNum, apiNum, mockNum, request);
}
@PutMapping
@NoResultHolder
public ResponseEntity<?> putMockRequest(@PathVariable String projectNum, @PathVariable String apiNum, HttpServletRequest request) {
return handleMockRequest(HttpMethod.PUT.name(), projectNum, apiNum, request);
public ResponseEntity<?> putMockRequest(@PathVariable String projectNum, @PathVariable String apiNum, @PathVariable String mockNum, HttpServletRequest request) {
return handleMockRequest(HttpMethod.PUT.name(), projectNum, apiNum, mockNum, request);
}
@DeleteMapping
@NoResultHolder
public ResponseEntity<?> deleteMockRequest(@PathVariable String projectNum, @PathVariable String apiNum, HttpServletRequest request) {
return handleMockRequest(HttpMethod.DELETE.name(), projectNum, apiNum, request);
public ResponseEntity<?> deleteMockRequest(@PathVariable String projectNum, @PathVariable String apiNum, @PathVariable String mockNum, HttpServletRequest request) {
return handleMockRequest(HttpMethod.DELETE.name(), projectNum, apiNum, mockNum, request);
}
@PatchMapping
@NoResultHolder
public ResponseEntity<?> patchMockRequest(@PathVariable String projectNum, @PathVariable String apiNum, HttpServletRequest request) {
return handleMockRequest(HttpMethod.PATCH.name(), projectNum, apiNum, request);
public ResponseEntity<?> patchMockRequest(@PathVariable String projectNum, @PathVariable String apiNum, @PathVariable String mockNum, HttpServletRequest request) {
return handleMockRequest(HttpMethod.PATCH.name(), projectNum, apiNum, mockNum, request);
}
private ResponseEntity<?> handleMockRequest(String method, String projectNum, String apiNum, HttpServletRequest request) {
return mockServerService.execute(method, projectNum, apiNum, request);
private ResponseEntity<?> handleMockRequest(String method, String projectNum, String apiNum, String mockNum, HttpServletRequest request) {
return mockServerService.execute(method, projectNum, apiNum, mockNum, request);
}
}

6
backend/services/api-test/src/main/java/io/metersphere/api/dto/mockserver/keyValueMatchRule.java
View File

@ -2,6 +2,7 @@ package io.metersphere.api.dto.mockserver;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Data;
import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.collections4.MapUtils;
import java.util.List;
@ -15,8 +16,9 @@ public class keyValueMatchRule {
private List<KeyValueInfo> matchRules;
public boolean match(Map<String, String> matchParam) {
if (MapUtils.isEmpty(matchParam)) {
return true;
if ((MapUtils.isEmpty(matchParam) && CollectionUtils.isNotEmpty(matchRules)) ||
(CollectionUtils.isEmpty(matchRules) && MapUtils.isNotEmpty(matchParam))) {
return false;
}
if (isMatchAll) {
for (KeyValueInfo matchRule : matchRules) {

6
backend/services/api-test/src/main/java/io/metersphere/api/dto/request/http/MsHTTPElement.java
View File

@ -1,8 +1,8 @@
package io.metersphere.api.dto.request.http;
import io.metersphere.project.dto.environment.auth.HTTPAuthConfig;
import io.metersphere.api.dto.request.http.body.Body;
import io.metersphere.plugin.api.spi.AbstractMsProtocolTestElement;
import io.metersphere.project.dto.environment.auth.HTTPAuthConfig;
import io.metersphere.sdk.constants.HttpMethodConstants;
import io.metersphere.system.valid.EnumValue;
import jakarta.validation.Valid;
@ -72,4 +72,8 @@ public class MsHTTPElement extends AbstractMsProtocolTestElement {
* mock执行需要的接口编号
*/
private Long num;
/**
* mock调试过来的mock编号
*/
private String mockNum;
}

9
backend/services/api-test/src/main/java/io/metersphere/api/parser/jmeter/MsHTTPElementConverter.java
View File

@ -105,7 +105,7 @@ public class MsHTTPElementConverter extends AbstractJmeterElementConverter<MsHTT
HTTPAuthConfig authConfig = msHTTPElement.getAuthConfig();
if ((authConfig == null || !authConfig.isHTTPAuthValid()) && httpConfig != null) {
if ((authConfig == null || !authConfig.isHTTPAuthValid()) && httpConfig != null) {
authConfig = httpConfig.getAuthConfig();
}
// 处理认证信息
@ -119,6 +119,7 @@ public class MsHTTPElementConverter extends AbstractJmeterElementConverter<MsHTT
* 判断是否启用环境
* 非自定义请求启用
* 自定义请求需要判断是否启用
*
* @param httpElement
* @return
*/
@ -379,7 +380,7 @@ public class MsHTTPElementConverter extends AbstractJmeterElementConverter<MsHTT
if (match) {
// 如果是mock 返回的url格式是 /mock-server/projectNum/apiNum
if (BooleanUtils.isTrue(envConfig.getMock())) {
httpConfig.setHostname(StringUtils.join(httpConfig.getHostname(),"/", msHTTPElement.getNum()));
httpConfig.setHostname(StringUtils.join(httpConfig.getHostname(), "/", msHTTPElement.getNum(), StringUtils.isNotBlank(msHTTPElement.getMockNum()) ? "/" + msHTTPElement.getMockNum() : StringUtils.EMPTY));
}
return httpConfig;
}
@ -421,7 +422,7 @@ public class MsHTTPElementConverter extends AbstractJmeterElementConverter<MsHTT
.filter(KeyValueParam::isValid)
.filter(header ->
StringUtils.equalsIgnoreCase(header.getKey().trim(), ApiConstants.CONTENT_TYPE)
&& StringUtils.contains(header.getValue(), contentType)
&& StringUtils.contains(header.getValue(), contentType)
)
.toList();
// 不包含则添加一个
@ -475,7 +476,7 @@ public class MsHTTPElementConverter extends AbstractJmeterElementConverter<MsHTT
return stringBuffer.substring(0, stringBuffer.length() - 1);
}
private DNSCacheManager getEnvDns(String name , EnvironmentInfoDTO envConfig, HttpConfig httpConfig) {
private DNSCacheManager getEnvDns(String name, EnvironmentInfoDTO envConfig, HttpConfig httpConfig) {
if (envConfig == null ||
envConfig.getConfig() == null ||
envConfig.getConfig().getHostConfig() == null ||

7
backend/services/api-test/src/main/java/io/metersphere/api/service/definition/ApiDefinitionImportUtilService.java
View File

@ -215,11 +215,6 @@ public class ApiDefinitionImportUtilService {
ApiDetailWithDataUpdate apiDetailWithDataUpdate = new ApiDetailWithDataUpdate();
getNeedUpdateData(request, apiDealWithData, apiDetailWithDataUpdate);
//不用的数据清空，保证内存回收
apiLists = new ArrayList<>();
apiModules = new ArrayList<>();
importData = new ArrayList<>();
List<LogDTO> operationLogs = new ArrayList<>();
//数据入库
insertData(modulePathMap, idModuleMap, apiDetailWithDataUpdate, request, operationLogs);
@ -229,7 +224,7 @@ public class ApiDefinitionImportUtilService {
@Transactional(rollbackFor = Exception.class)
public void batchSaveLog(List<LogDTO> operationLogs) {
SubListUtils.dealForSubList(operationLogs, 100, operationLogService::batchAdd);
operationLogService.batchAdd(operationLogs);
}
public Long getNextOrder(String projectId) {

17
backend/services/api-test/src/main/java/io/metersphere/api/service/mockserver/MockServerService.java
View File

@ -62,9 +62,10 @@ public class MockServerService {
}
public ResponseEntity<?> execute(String method, String projectNum, String apiNum, HttpServletRequest request) {
public ResponseEntity<?> execute(String method, String projectNum, String apiNum, String mockNum, HttpServletRequest request) {
var requestHeaderMap = MockServerUtils.getHttpRequestHeader(request);
String url = request.getRequestURL().toString();
//判断根据mockNum是否可以找到对应的mock配置 如果找不到，需要拿接口下所有的mock配置进行匹配
String requestUrlSuffix = MockServerUtils.getUrlSuffix(StringUtils.joinWith("/", "/mock-server", projectNum, apiNum), request);
// Try to find API definition based on projectNum and apiNum
@ -80,6 +81,13 @@ public class MockServerService {
return requestNotFound();
}
if (StringUtils.isNotBlank(mockNum) && mockNum.startsWith(apiNum)) {
requestUrlSuffix = MockServerUtils.getUrlSuffix(StringUtils.joinWith("/", "/mock-server", projectNum, apiNum, mockNum), request);
} else {
mockNum = null;
}
// Check if method and path match the API definition
if (!StringUtils.equalsIgnoreCase(method, apiDefinition.getMethod()) || !MockServerUtils.checkUrlMatch(apiDefinition.getPath(), requestUrlSuffix)) {
return requestNotFound();
@ -89,7 +97,7 @@ public class MockServerService {
HttpRequestParam requestMockParams = MockServerUtils.getHttpRequestParam(request, requestUrlSuffix, apiDefinition.getPath(), !isUrlParamMethod(method));
LogUtils.info("Mock [" + url + "] Header:{}", requestHeaderMap);
LogUtils.info("Mock [" + url + "] request:{}", JSON.toJSONString(requestMockParams));
ApiMockConfigDTO compareMockConfig = findMatchingMockConfig(apiDefinition.getId(), requestHeaderMap, requestMockParams);
ApiMockConfigDTO compareMockConfig = findMatchingMockConfig(apiDefinition.getId(), requestHeaderMap, requestMockParams, mockNum);
if (compareMockConfig != null && !compareMockConfig.isEnable()) {
return requestNotFound();
@ -111,10 +119,13 @@ public class MockServerService {
.orElse(null);
}
private ApiMockConfigDTO findMatchingMockConfig(String apiId, Map<String, String> requestHeaderMap, HttpRequestParam param) {
private ApiMockConfigDTO findMatchingMockConfig(String apiId, Map<String, String> requestHeaderMap, HttpRequestParam param, String mockNum) {
// 查询符合条件的 ApiDefinitionMockConfig 列表
ApiDefinitionMockExample mockExample = new ApiDefinitionMockExample();
mockExample.createCriteria().andApiDefinitionIdEqualTo(apiId);
if (StringUtils.isNotBlank(mockNum)) {
mockExample.getOredCriteria().forEach(criteria -> criteria.andExpectNumEqualTo(mockNum));
}
List<ApiDefinitionMock> apiDefinitionMockList = apiDefinitionMockMapper.selectByExample(mockExample);
if (CollectionUtils.isEmpty(apiDefinitionMockList)) {

6
backend/services/api-test/src/test/java/io/metersphere/api/controller/ApiDefinitionMockControllerTests.java
View File

@ -1250,6 +1250,12 @@ public class ApiDefinitionMockControllerTests extends BaseTest {
MockHttpServletRequestBuilder requestBuilder = mockServerTestService.getRequestBuilder("GET", url);
ResultActions action = mockMvc.perform(requestBuilder);
MockHttpServletResponse mockServerResponse = action.andReturn().getResponse();
url = "/" + mockServerDomain + "/100001/" + apiDefinition.getNum() + "/" + mockData.getExpectNum() + apiDefinition.getPath();
//开始创建请求
requestBuilder = mockServerTestService.getRequestBuilder("GET", url);
action = mockMvc.perform(requestBuilder);
mockServerResponse = action.andReturn().getResponse();
//判断响应
mockServerResponse.getContentAsString(StandardCharsets.UTF_8);
mockData.setEnable(false);