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

refactor(接口测试): 优化csv相关接口

This commit is contained in:
AgAngle 2024-05-16 20:14:28 +08:00 committed by Craftsman
parent f0afd5241c
commit 0ff9b831cd
6 changed files with 70 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
backend/services/api-test/src/main/java/io/metersphere/api/dto/scenario/CsvVariable.java
View File

@ -1,11 +1,15 @@
package io.metersphere.api.dto.scenario;
import io.metersphere.api.dto.ApiFile;
import io.metersphere.sdk.constants.ValueEnum;
import io.metersphere.system.valid.EnumValue;
import io.swagger.v3.oas.annotations.media.Schema;
import jakarta.validation.Valid;
import jakarta.validation.constraints.NotBlank;
import jakarta.validation.constraints.NotNull;
import jakarta.validation.constraints.Size;
import lombok.Data;
import org.apache.commons.lang3.StringUtils;
/**
@ -20,22 +24,15 @@ public class CsvVariable {
@Size(max = 50)
private String id;
@Schema(description = "文件id/引用文件id", requiredMode = Schema.RequiredMode.REQUIRED)
@Size(max = 50, message = "{api_scenario_csv.file_id.length_range}")
@NotBlank
private String fileId;
@Schema(description = "文件名称")
@NotBlank
private String fileName;
@Schema(description = "是否是关联文件")
private Boolean association = false;
@Schema(description = "csv变量名称", requiredMode = Schema.RequiredMode.REQUIRED)
@Size(max = 255, message = "{api_scenario_csv.name.length_range}")
private String name;
@Schema(description = "csv 文件", requiredMode = Schema.RequiredMode.REQUIRED)
@NotNull
@Valid
private ApiFile file;
/**
* @see CsvVariableScope
*/
@ -80,9 +77,12 @@ public class CsvVariable {
@Schema(description = "遇到文件结束符停止线程")
private Boolean stopThreadOnEof = false;
public boolean isValid() {
return StringUtils.isNotBlank(name) && file != null;
}
public enum CsvEncodingType implements ValueEnum {
UTF8("UTF-8"), UFT16("UTF-16"), ISO885915("ISO-8859-15"), US_ASCII("US-ASCII");
UTF8("UTF-8"), UFT16("UTF-16"), ISO885915("ISO-8859-15"), US_ASCII("US-ASCII"), GBK("GBK");
private String value;
CsvEncodingType(String value) {

3
backend/services/api-test/src/main/java/io/metersphere/api/mapper/ExtApiScenarioStepMapper.java
View File

@ -2,7 +2,6 @@ package io.metersphere.api.mapper;
import io.metersphere.api.domain.ApiScenarioCsvStep;
import io.metersphere.api.dto.scenario.ApiScenarioStepDTO;
import io.metersphere.api.dto.scenario.CsvVariable;
import org.apache.ibatis.annotations.Param;
import java.util.List;
@ -16,8 +15,6 @@ public interface ExtApiScenarioStepMapper {
List<ApiScenarioStepDTO> getStepDTOByScenarioIds(@Param("scenarioIds") List<String> scenarioIds);
List<CsvVariable> getCsvVariableByScenarioId(@Param("id") String id);
List<ApiScenarioCsvStep> getCsvStepByScenarioId(@Param("scenarioId") String scenarioId);
/**

5
backend/services/api-test/src/main/java/io/metersphere/api/mapper/ExtApiScenarioStepMapper.xml
View File

@ -13,11 +13,6 @@
#{scenarioId}
</foreach>
</select>
<select id="getCsvVariableByScenarioId" resultType="io.metersphere.api.dto.scenario.CsvVariable">
select
<include refid="io.metersphere.api.mapper.ApiScenarioCsvMapper.Base_Column_List"/>
from api_scenario_csv where scenario_id = #{id}
</select>
<select id="getCsvStepByScenarioId" resultType="io.metersphere.api.domain.ApiScenarioCsvStep">
select
<include refid="io.metersphere.api.mapper.ApiScenarioCsvStepMapper.Base_Column_List"/>

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

@ -37,9 +37,7 @@ public class MsCsvChildPreConverter extends AbstractJmeterElementConverter<Abstr
csvIds.forEach(csvId -> {
CsvVariable csvVariable = apiParamConfig.getCsvVariable(csvId);
if (csvVariable != null) {
String shareMode = StringUtils.equals(csvVariable.getScope(), CsvVariable.CsvVariableScope.SCENARIO.name()) ?
JmeterProperty.CSVDataSetProperty.SHARE_MODE_GROUP : JmeterProperty.CSVDataSetProperty.SHARE_MODE_THREAD;
addCsvDataSet(tree, shareMode, csvVariable);
addCsvDataSet(tree, JmeterProperty.CSVDataSetProperty.SHARE_MODE_THREAD, csvVariable);
}
});
}
@ -49,8 +47,11 @@ public class MsCsvChildPreConverter extends AbstractJmeterElementConverter<Abstr
}
private static void addCsvDataSet(HashTree tree, String shareMode, CsvVariable csvVariable) {
if (!csvVariable.isValid()) {
return;
}
// 执行机执行文件存放的缓存目录
String path = LocalRepositoryDir.getSystemCacheDir() + "/" + csvVariable.getFileId() + "/" + csvVariable.getFileName();
String path = LocalRepositoryDir.getSystemCacheDir() + "/" + csvVariable.getFile().getFileId() + "/" + csvVariable.getFile().getFileName();
if (!StringUtils.equals(File.separator, "/")) {
// windows 系统下运行，将 / 转换为 \，否则jmeter报错
path = path.replace("/", File.separator);

47
backend/services/api-test/src/main/java/io/metersphere/api/service/scenario/ApiScenarioService.java
View File

@ -565,6 +565,11 @@ public class ApiScenarioService extends MoveNodeService {
BeanUtils.copyBean(scenarioCsv, item);
scenarioCsv.setScenarioId(scenario.getId());
scenarioCsv.setProjectId(scenario.getProjectId());
ApiFile file = item.getFile();
scenarioCsv.setFileId(file.getFileId());
scenarioCsv.setFileName(file.getFileName());
scenarioCsv.setAssociation(BooleanUtils.isFalse(file.getLocal()));
if (!dbCsvIdSet.contains(item.getId())) {
addCsvList.add(scenarioCsv);
} else {
@ -595,7 +600,9 @@ public class ApiScenarioService extends MoveNodeService {
// 获取请求中关联的文件id
List<String> refFileIds = csvVariables.stream()
.filter(c -> BooleanUtils.isTrue(c.getAssociation())).map(CsvVariable::getFileId).toList();
.map(CsvVariable::getFile)
.filter(c -> BooleanUtils.isFalse(c.getLocal()))
.map(ApiFile::getFileId).toList();
List<String> unlinkFileIds = ListUtils.subtract(dbRefFileIds, refFileIds);
resourceUpdateRequest.setUnLinkFileIds(unlinkFileIds);
@ -612,8 +619,9 @@ public class ApiScenarioService extends MoveNodeService {
// 获取请求中的本地文件
List<String> localFileIds = csvVariables.stream()
.filter(c -> BooleanUtils.isFalse(c.getAssociation()))
.map(CsvVariable::getFileId).toList();
.map(CsvVariable::getFile)
.filter(c -> BooleanUtils.isTrue(c.getLocal()))
.map(ApiFile::getFileId).toList();
// 待删除文件
List<String> deleteLocals = ListUtils.subtract(dbLocalFileIds, localFileIds);
@ -2056,6 +2064,15 @@ public class ApiScenarioService extends MoveNodeService {
followerExample.createCriteria().andUserIdEqualTo(userId);
List<ApiScenarioFollower> followers = apiScenarioFollowerMapper.selectByExample(followerExample);
apiScenarioDetailDTO.setFollow(CollectionUtils.isNotEmpty(followers));
// 设置关联的文件的最新信息
List<ApiFile> csvApiFiles = apiScenarioDetail.getScenarioConfig()
.getVariable()
.getCsvVariables()
.stream()
.map(CsvVariable::getFile)
.toList();
apiCommonService.setLinkFileInfo(apiScenarioDetail.getId(), csvApiFiles);
return apiScenarioDetailDTO;
}
@ -2104,8 +2121,7 @@ public class ApiScenarioService extends MoveNodeService {
}
//存放csv变量
List<CsvVariable> csvVariables = extApiScenarioStepMapper.getCsvVariableByScenarioId(scenarioId);
apiScenarioDetail.getScenarioConfig().getVariable().setCsvVariables(csvVariables);
apiScenarioDetail.getScenarioConfig().getVariable().setCsvVariables(getCsvVariables(scenarioId));
// 获取所有步骤
List<ApiScenarioStepDTO> allSteps = getAllStepsByScenarioIds(List.of(scenarioId))
@ -2154,6 +2170,22 @@ public class ApiScenarioService extends MoveNodeService {
return apiScenarioDetail;
}
private List<CsvVariable> getCsvVariables(String scenarioId) {
ApiScenarioCsvExample example = new ApiScenarioCsvExample();
example.createCriteria().andScenarioIdEqualTo(scenarioId);
List<ApiScenarioCsv> csvList = apiScenarioCsvMapper.selectByExample(example);
List<CsvVariable> csvVariables = csvList.stream().map(apiScenarioCsv -> {
CsvVariable csvVariable = BeanUtils.copyBean(new CsvVariable(), apiScenarioCsv);
ApiFile apiFile = new ApiFile();
apiFile.setFileId(apiScenarioCsv.getFileId());
apiFile.setLocal(!apiScenarioCsv.getAssociation());
apiFile.setFileName(apiScenarioCsv.getFileName());
csvVariable.setFile(apiFile);
return csvVariable;
}).collect(Collectors.toList());
return csvVariables;
}
/**
* 设置部分引用的步骤的启用状态
*/
@ -2312,7 +2344,6 @@ public class ApiScenarioService extends MoveNodeService {
if (stepDetail instanceof AbstractMsTestElement msTestElement) {
// 设置关联的文件的最新信息
if (isRef(step.getRefType())) {
apiCommonService.setLinkFileInfo(step.getResourceId(), msTestElement);
if (isApi(step.getStepType())) {
ApiDefinition apiDefinition = apiDefinitionMapper.selectByPrimaryKey(step.getResourceId());
apiCommonService.setApiDefinitionExecuteInfo(msTestElement, apiDefinition);
@ -2321,9 +2352,9 @@ public class ApiScenarioService extends MoveNodeService {
ApiDefinition apiDefinition = apiDefinitionMapper.selectByPrimaryKey(apiTestCase.getApiDefinitionId());
apiCommonService.setApiDefinitionExecuteInfo(msTestElement, apiDefinition);
}
} else {
apiCommonService.setLinkFileInfo(step.getScenarioId(), msTestElement);
}
apiCommonService.setLinkFileInfo(step.getId(), msTestElement);
apiCommonService.setEnableCommonScriptProcessorInfo(msTestElement);
} else if (stepDetail instanceof MsScriptElement msScriptElement) {
apiCommonService.setEnableCommonScriptProcessorInfo(msScriptElement);

20
backend/services/api-test/src/test/java/io/metersphere/api/controller/ApiScenarioControllerTests.java
View File

@ -481,18 +481,24 @@ public class ApiScenarioControllerTests extends BaseTest {
List<CsvVariable> csvVariables = new ArrayList<>();
CsvVariable csvVariable = new CsvVariable();
csvVariable.setId(UUID.randomUUID().toString());
csvVariable.setFileId(localFileId);
csvVariable.setName("csv变量");
csvVariable.setFileName("test.jbc");
csvVariable.setScope(CsvVariable.CsvVariableScope.SCENARIO.name());
ApiFile file = new ApiFile();
file.setFileName("test.jbc");
file.setLocal(true);
file.setFileId(localFileId);
csvVariable.setFile(file);
csvVariables.add(csvVariable);
csvVariable = new CsvVariable();
csvVariable.setId(UUID.randomUUID().toString());
csvVariable.setFileId(fileMetadataId);
csvVariable.setName("csv-关联的");
csvVariable.setFileName("test.jbc");
file = new ApiFile();
file.setFileId(fileMetadataId);
file.setFileName("test.jbc");
file.setLocal(false);
csvVariable.setScope(CsvVariable.CsvVariableScope.SCENARIO.name());
csvVariable.setAssociation(true);
csvVariable.setFile(file);
csvVariables.add(csvVariable);
return csvVariables;
}
@ -646,9 +652,9 @@ public class ApiScenarioControllerTests extends BaseTest {
// 验证修改步骤
steps.get(0).setName("test name update");
CsvVariable csvVariable = request.getScenarioConfig().getVariable().getCsvVariables().get(0);
request.getScenarioConfig().getVariable().getCsvVariables().get(0).setId(collect.get(csvVariable.getFileId()).getId());
request.getScenarioConfig().getVariable().getCsvVariables().get(0).setId(collect.get(csvVariable.getFile().getFileId()).getId());
CsvVariable csvVariable1 = request.getScenarioConfig().getVariable().getCsvVariables().get(0);
request.getScenarioConfig().getVariable().getCsvVariables().get(1).setId(collect.get(csvVariable1.getFileId()).getId());
request.getScenarioConfig().getVariable().getCsvVariables().get(1).setId(collect.get(csvVariable1.getFile().getFileId()).getId());
this.requestPostWithOk(DEFAULT_UPDATE, request);
assertUpdateSteps(steps, steptDetailMap);
addApiScenarioSteps = steps;