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

feat(测试用例): 下载xmind模板

This commit is contained in:
WangXu10 2024-08-06 10:57:37 +08:00 committed by Craftsman
parent 5ecbefb884
commit 8b38fd8878
4 changed files with 74 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
backend/services/case-management/src/main/java/io/metersphere/functional/service/FunctionalCaseFileService.java
View File

@ -210,7 +210,7 @@ public class FunctionalCaseFileService {
return list; return list;
} }
private Map<String, List<String>> getCustomFieldOptionsMap(List<TemplateCustomFieldDTO> customFields) { public Map<String, List<String>> getCustomFieldOptionsMap(List<TemplateCustomFieldDTO> customFields) {
Map<String, List<String>> returnMap = new HashMap<>(); Map<String, List<String>> returnMap = new HashMap<>();
customFields.forEach(item -> { customFields.forEach(item -> {
List<String> values = getOptionValues(Optional.ofNullable(item.getOptions()).orElse(new ArrayList<>())); List<String> values = getOptionValues(Optional.ofNullable(item.getOptions()).orElse(new ArrayList<>()));

5
backend/services/case-management/src/main/java/io/metersphere/functional/service/FunctionalCaseXmindService.java
View File

@ -15,6 +15,7 @@ import org.springframework.transaction.annotation.Transactional;
import java.io.InputStream; import java.io.InputStream;
import java.util.List; import java.util.List;
import java.util.Map;
/** /**
* @author wx * @author wx
@ -31,11 +32,13 @@ public class FunctionalCaseXmindService {
public void downloadXmindTemplate(String projectId, HttpServletResponse response) { public void downloadXmindTemplate(String projectId, HttpServletResponse response) {
List<TemplateCustomFieldDTO> customFields = functionalCaseFileService.getCustomFields(projectId); List<TemplateCustomFieldDTO> customFields = functionalCaseFileService.getCustomFields(projectId);
//默认字段+自定义字段的 options集合
Map<String, List<String>> customFieldOptionsMap = functionalCaseFileService.getCustomFieldOptionsMap(customFields);
try (InputStream stream = FunctionalCaseXmindService.class.getResourceAsStream(template)) { try (InputStream stream = FunctionalCaseXmindService.class.getResourceAsStream(template)) {
FunctionalCaseXmindData functionalCaseXmindData = JSON.parseObject(stream, FunctionalCaseXmindData.class); FunctionalCaseXmindData functionalCaseXmindData = JSON.parseObject(stream, FunctionalCaseXmindData.class);
setTemplateCustomFields(functionalCaseXmindData.getChildren(), customFields); setTemplateCustomFields(functionalCaseXmindData.getChildren(), customFields);
XmindExportUtil.downloadTemplate(response, functionalCaseXmindData, true); XmindExportUtil.downloadTemplate(response, functionalCaseXmindData, true, customFieldOptionsMap);
} catch (Exception e) { } catch (Exception e) {
LogUtils.error(e.getMessage()); LogUtils.error(e.getMessage());

77
backend/services/case-management/src/main/java/io/metersphere/functional/xmind/utils/XmindExportUtil.java
View File

@ -3,10 +3,12 @@ package io.metersphere.functional.xmind.utils;
import io.metersphere.functional.constants.FunctionalCaseTypeConstants; import io.metersphere.functional.constants.FunctionalCaseTypeConstants;
import io.metersphere.functional.xmind.domain.FunctionalCaseXmindDTO; import io.metersphere.functional.xmind.domain.FunctionalCaseXmindDTO;
import io.metersphere.functional.xmind.domain.FunctionalCaseXmindData; import io.metersphere.functional.xmind.domain.FunctionalCaseXmindData;
import io.metersphere.sdk.constants.CustomFieldType;
import io.metersphere.sdk.exception.MSException; import io.metersphere.sdk.exception.MSException;
import io.metersphere.sdk.util.JSON; import io.metersphere.sdk.util.JSON;
import io.metersphere.sdk.util.LogUtils; import io.metersphere.sdk.util.LogUtils;
import io.metersphere.sdk.util.Translator; import io.metersphere.sdk.util.Translator;
import io.metersphere.system.dto.sdk.TemplateCustomFieldDTO;
import jakarta.servlet.http.HttpServletResponse; import jakarta.servlet.http.HttpServletResponse;
import org.apache.commons.collections.CollectionUtils; import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.lang3.StringUtils; import org.apache.commons.lang3.StringUtils;
@ -34,8 +36,8 @@ public class XmindExportUtil {
* @param caseData * @param caseData
* @param template * @param template
*/ */
public static void downloadTemplate(HttpServletResponse response, FunctionalCaseXmindData caseData, boolean template) { public static void downloadTemplate(HttpServletResponse response, FunctionalCaseXmindData caseData, boolean template, Map<String, List<String>> customFieldOptionsMap) {
IWorkbook workBook = createXmindByCaseData(caseData, template); IWorkbook workBook = createXmindByCaseData(caseData, template, customFieldOptionsMap);
response.setContentType("application/octet-stream"); response.setContentType("application/octet-stream");
response.setCharacterEncoding(StandardCharsets.UTF_8.name()); response.setCharacterEncoding(StandardCharsets.UTF_8.name());
@ -51,7 +53,7 @@ public class XmindExportUtil {
} }
} }
private static IWorkbook createXmindByCaseData(FunctionalCaseXmindData caseData, boolean template) { private static IWorkbook createXmindByCaseData(FunctionalCaseXmindData caseData, boolean template, Map<String, List<String>> customFieldOptionsMap) {
// 创建思维导图的工作空间 // 创建思维导图的工作空间
IWorkbookBuilder workbookBuilder = Core.getWorkbookBuilder(); IWorkbookBuilder workbookBuilder = Core.getWorkbookBuilder();
IWorkbook workbook = workbookBuilder.createWorkbook(); IWorkbook workbook = workbookBuilder.createWorkbook();
@ -73,13 +75,14 @@ public class XmindExportUtil {
if (CollectionUtils.isNotEmpty(caseData.getChildren())) { if (CollectionUtils.isNotEmpty(caseData.getChildren())) {
for (FunctionalCaseXmindData data : caseData.getChildren()) { for (FunctionalCaseXmindData data : caseData.getChildren()) {
addItemTopic(rootTopic, workbook, styleMap, data, true, template); addItemTopic(rootTopic, workbook, styleMap, data, true, template, customFieldOptionsMap);
} }
} }
return workbook; return workbook;
} }
private static void addItemTopic(ITopic parentTpoic, IWorkbook workbook, Map<String, IStyle> styleMap, FunctionalCaseXmindData xmindData, boolean isFirstLevel, boolean template) { private static void addItemTopic(ITopic parentTpoic, IWorkbook workbook, Map<String, IStyle> styleMap, FunctionalCaseXmindData xmindData,
boolean isFirstLevel, boolean template, Map<String, List<String>> customFieldOptionsMap) {
ITopic topic = workbook.createTopic(); ITopic topic = workbook.createTopic();
topic.setTitleText(xmindData.getModuleName()); topic.setTitleText(xmindData.getModuleName());
if (isFirstLevel) { if (isFirstLevel) {
@ -106,27 +109,30 @@ public class XmindExportUtil {
} }
if (template) { if (template) {
// 模板 // 模板
buildTemplateTopic(topic, style, dto, itemTopic, workbook); buildTemplateTopic(topic, style, dto, itemTopic, workbook, customFieldOptionsMap);
} }
} }
} }
if (CollectionUtils.isNotEmpty(xmindData.getChildren())) { if (CollectionUtils.isNotEmpty(xmindData.getChildren())) {
for (FunctionalCaseXmindData data : xmindData.getChildren()) { for (FunctionalCaseXmindData data : xmindData.getChildren()) {
addItemTopic(topic, workbook, styleMap, data, false, template); addItemTopic(topic, workbook, styleMap, data, false, template, customFieldOptionsMap);
} }
} }
} }
private static void buildTemplateTopic(ITopic topic, IStyle style, FunctionalCaseXmindDTO dto, ITopic itemTopic, IWorkbook workbook) { private static void buildTemplateTopic(ITopic topic, IStyle style, FunctionalCaseXmindDTO dto, ITopic itemTopic, IWorkbook workbook,Map<String, List<String>> customFieldOptionsMap) {
//用例名称 //用例名称
itemTopic.setTitleText("case-P0: " + dto.getName()); TemplateCustomFieldDTO priorityDto = dto.getTemplateCustomFieldDTOList().stream().filter(item -> StringUtils.equalsIgnoreCase(item.getFieldName(), Translator.get("custom_field.functional_priority"))).findFirst().get();
String priority = Translator.get("custom_field.functional_priority").concat("：").concat(Translator.get("required")).concat(", ").concat(Translator.get("options")).concat(JSON.toJSONString(customFieldOptionsMap.get(priorityDto.getFieldName())));
String name = Translator.get("case.export.system.columns.name").concat(", ").concat(Translator.get("required"));
itemTopic.setTitleText("case-P0: ".concat(dto.getName()).concat(" ").concat(priority).concat(name));
//前置条件 //前置条件
if (StringUtils.isNotBlank(dto.getPrerequisite())) { if (StringUtils.isNotBlank(dto.getPrerequisite())) {
ITopic preTopic = workbook.createTopic(); ITopic preTopic = workbook.createTopic();
preTopic.setTitleText(Translator.get("xmind_prerequisite") + ": " + dto.getPrerequisite()); preTopic.setTitleText(Translator.get("xmind_prerequisite").concat(": ").concat(dto.getPrerequisite()));
if (style != null) { if (style != null) {
preTopic.setStyleId(style.getId()); preTopic.setStyleId(style.getId());
} }
@ -136,7 +142,7 @@ public class XmindExportUtil {
//备注 //备注
if (StringUtils.isNotBlank(dto.getDescription())) { if (StringUtils.isNotBlank(dto.getDescription())) {
ITopic deTopic = workbook.createTopic(); ITopic deTopic = workbook.createTopic();
deTopic.setTitleText(Translator.get("xmind_description") + ": " + dto.getDescription()); deTopic.setTitleText(Translator.get("xmind_description").concat(": ").concat(dto.getDescription()));
if (style != null) { if (style != null) {
deTopic.setStyleId(style.getId()); deTopic.setStyleId(style.getId());
} }
@ -146,16 +152,8 @@ public class XmindExportUtil {
//标签 //标签
if (StringUtils.isNotBlank(dto.getTags())) { if (StringUtils.isNotBlank(dto.getTags())) {
try { try {
List<String> arr = JSON.parseArray(dto.getTags());
String tagStr = StringUtils.EMPTY;
for (int i = 0; i < arr.size(); i++) {
tagStr = tagStr + arr.get(i) + "|";
}
if (tagStr.endsWith("|")) {
tagStr = tagStr.substring(0, tagStr.length() - 1);
}
ITopic tagTopic = workbook.createTopic(); ITopic tagTopic = workbook.createTopic();
tagTopic.setTitleText(Translator.get("xmind_tags") + ":" + tagStr); tagTopic.setTitleText(Translator.get("xmind_tags").concat(": ").concat(dto.getTags()));
if (style != null) { if (style != null) {
tagTopic.setStyleId(style.getId()); tagTopic.setStyleId(style.getId());
} }
@ -168,14 +166,14 @@ public class XmindExportUtil {
//文本描述 //文本描述
ITopic textDesTopic = workbook.createTopic(); ITopic textDesTopic = workbook.createTopic();
String desc = dto.getTextDescription(); String desc = dto.getTextDescription();
textDesTopic.setTitleText(desc == null ? Translator.get("xmind_textDescription") + ": " : Translator.get("xmind_textDescription") + ": " + desc); textDesTopic.setTitleText(desc == null ? Translator.get("xmind_textDescription").concat(": ") : Translator.get("xmind_textDescription").concat(": ").concat(Translator.get("xmind_textDescription")).concat(": ").concat(desc));
if (style != null) { if (style != null) {
textDesTopic.setStyleId(style.getId()); textDesTopic.setStyleId(style.getId());
} }
String result = dto.getExpectedResult(); String result = dto.getExpectedResult();
ITopic resultTopic = workbook.createTopic(); ITopic resultTopic = workbook.createTopic();
resultTopic.setTitleText(result == null ? Translator.get("xmind_expectedResult") + ": " : Translator.get("xmind_expectedResult") + ": " + result); resultTopic.setTitleText(result == null ? Translator.get("xmind_expectedResult").concat(": ") : Translator.get("xmind_expectedResult").concat(": ").concat(result));
if (style != null) { if (style != null) {
resultTopic.setStyleId(style.getId()); resultTopic.setStyleId(style.getId());
} }
@ -198,7 +196,7 @@ public class XmindExportUtil {
if (obj.containsKey("desc")) { if (obj.containsKey("desc")) {
ITopic stepTopic = workbook.createTopic(); ITopic stepTopic = workbook.createTopic();
String desc = obj.get("desc"); String desc = obj.get("desc");
stepTopic.setTitleText(Translator.get("xmind_step") + ": " + desc); stepTopic.setTitleText(Translator.get("xmind_step").concat(": ").concat(desc));
if (style != null) { if (style != null) {
stepTopic.setStyleId(style.getId()); stepTopic.setStyleId(style.getId());
} }
@ -209,7 +207,7 @@ public class XmindExportUtil {
if (StringUtils.isNotEmpty(result)) { if (StringUtils.isNotEmpty(result)) {
hasResult = true; hasResult = true;
ITopic resultTopic = workbook.createTopic(); ITopic resultTopic = workbook.createTopic();
resultTopic.setTitleText(Translator.get("xmind_expectedResult") + ": " + result); resultTopic.setTitleText(Translator.get("xmind_expectedResult").concat(": ").concat(result));
if (style != null) { if (style != null) {
resultTopic.setStyleId(style.getId()); resultTopic.setStyleId(style.getId());
} }
@ -230,9 +228,10 @@ public class XmindExportUtil {
//自定义字段 //自定义字段
dto.getTemplateCustomFieldDTOList().forEach(item -> { dto.getTemplateCustomFieldDTOList().forEach(item -> {
if (!StringUtils.equalsIgnoreCase(item.getFieldName(), "functional_priority")) { if (!StringUtils.equalsIgnoreCase(item.getFieldName(), Translator.get("custom_field.functional_priority"))) {
ITopic customTopic = workbook.createTopic(); ITopic customTopic = workbook.createTopic();
customTopic.setTitleText(item.getFieldName() + ":"); String fieldComment = getComment(item,customFieldOptionsMap);
customTopic.setTitleText(item.getFieldName().concat(": ").concat(fieldComment));
if (style != null) { if (style != null) {
customTopic.setStyleId(style.getId()); customTopic.setStyleId(style.getId());
} }
@ -243,6 +242,32 @@ public class XmindExportUtil {
topic.add(itemTopic); topic.add(itemTopic);
} }
private static String getComment(TemplateCustomFieldDTO templateCustomFieldDTO,Map<String, List<String>> customFieldOptionsMap) {
String comment = "";
if (StringUtils.equalsAnyIgnoreCase(templateCustomFieldDTO.getType(), CustomFieldType.MULTIPLE_MEMBER.name(), CustomFieldType.MEMBER.name())) {
if (templateCustomFieldDTO.getRequired()) {
comment = Translator.get("required").concat(",").concat(Translator.get("excel.template.member"));
} else {
comment = Translator.get("excel.template.not_required").concat(",").concat(Translator.get("excel.template.member"));
}
} else {
if (templateCustomFieldDTO.getRequired()) {
if (CollectionUtils.isNotEmpty(templateCustomFieldDTO.getOptions())) {
comment = Translator.get("required").concat("：").concat(Translator.get("options")).concat(JSON.toJSONString(customFieldOptionsMap.get(templateCustomFieldDTO.getFieldName())));
} else {
comment = Translator.get("required");
}
} else {
if (CollectionUtils.isNotEmpty(templateCustomFieldDTO.getOptions())) {
comment = Translator.get("excel.template.not_required").concat("：").concat(Translator.get("options")).concat(JSON.toJSONString(customFieldOptionsMap.get(templateCustomFieldDTO.getFieldName())));
} else {
comment = Translator.get("excel.template.not_required");
}
}
}
return comment;
}
private static Map<String, IStyle> initTheme(IWorkbook workbook) { private static Map<String, IStyle> initTheme(IWorkbook workbook) {
Map<String, IStyle> styleMap = new HashMap<>(); Map<String, IStyle> styleMap = new HashMap<>();

36
backend/services/case-management/src/main/resources/template/template.json
View File

@ -9,32 +9,32 @@
"id": "1", "id": "1",
"num": 1, "num": 1,
"projectId": "12314", "projectId": "12314",
"name": "导出模板用例A", "name": "",
"tags": "[\"标签789\"]", "tags": "多个｜分隔，非必填",
"caseEditType": "STEP", "caseEditType": "STEP",
"steps": "[{\"num\":1,\"desc\":\"123\",\"result\":\"123\"},{\"num\":2,\"desc\":\"SDFS\",\"result\":\"SDFS\"}]", "steps": "[{\"num\":1,\"desc\":\"非必填\",\"result\":\"非必填\"},{\"num\":2,\"desc\":\"非必填\",\"result\":\"非必填\"}]",
"textDescription": "", "textDescription": "",
"expectedResult": "", "expectedResult": "",
"prerequisite": "这是前置", "prerequisite": "非必填",
"description": "这是备注", "description": "非必填",
"customFieldDTOList": [] "customFieldDTOList": []
}, },
{ {
"id": "2", "id": "2",
"num": 2, "num": 2,
"projectId": "12314", "projectId": "12314",
"name": "导出模板用例B", "name": "",
"tags": "[\"标签789\"]", "tags": "标签，多个｜分隔，非必填",
"caseEditType": "TEXT", "caseEditType": "TEXT",
"steps": "", "steps": "",
"textDescription": "<p style=\"\">akhfksajhfaskfha</p>", "textDescription": "非必填",
"expectedResult": "<p style=\"\">asdfsdfasfs</p>", "expectedResult": "非必填",
"prerequisite": "前置", "prerequisite": "非必填",
"description": "这是备注", "description": "非必填",
"customFieldDTOList": [] "customFieldDTOList": []
} }
], ],
"moduleName": "模块1", "moduleName": "模块1：若无该模块将自动创建",
"moduleId": "module1", "moduleId": "module1",
"children": [ "children": [
{ {
@ -43,18 +43,18 @@
"id": "3", "id": "3",
"num": 3, "num": 3,
"projectId": "12314", "projectId": "12314",
"name": "导出模板用例C", "name": "",
"tags": "[\"标签789\"]", "tags": "多个｜分隔，非必填",
"caseEditType": "STEP", "caseEditType": "STEP",
"steps": "[{\"num\":1,\"desc\":\"123\",\"result\":\"123\"},{\"num\":2,\"desc\":\"SDFS\",\"result\":\"SDFS\"}]", "steps": "[{\"num\":1,\"desc\":\"非必填\",\"result\":\"非必填\"},{\"num\":2,\"desc\":\"非必填\",\"result\":\"非必填\"}]",
"textDescription": "", "textDescription": "",
"expectedResult": "", "expectedResult": "",
"prerequisite": "前置", "prerequisite": "非必填",
"description": "这是备注", "description": "非必填",
"customFieldDTOList": [] "customFieldDTOList": []
} }
], ],
"moduleName": "模块2", "moduleName": "模块2：若无该模块将自动创建",
"moduleId": "module2", "moduleId": "module2",
"children": [] "children": []
} }