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

feat(接口测试): 补充分享导出下载接口

This commit is contained in:
song-cc-rock 2024-10-16 18:29:13 +08:00 committed by Craftsman
parent 0b60e549cd
commit d4f7ecf205
2 changed files with 28 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
backend/services/api-test/src/main/java/io/metersphere/api/controller/definition/ApiDocShareController.java
View File

@ -24,6 +24,7 @@ import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.media.Schema; import io.swagger.v3.oas.annotations.media.Schema;
import io.swagger.v3.oas.annotations.tags.Tag; import io.swagger.v3.oas.annotations.tags.Tag;
import jakarta.annotation.Resource; import jakarta.annotation.Resource;
import jakarta.servlet.http.HttpServletResponse;
import org.apache.commons.lang3.StringUtils; import org.apache.commons.lang3.StringUtils;
import org.apache.shiro.authz.annotation.RequiresPermissions; import org.apache.shiro.authz.annotation.RequiresPermissions;
import org.springframework.validation.annotation.Validated; import org.springframework.validation.annotation.Validated;
@ -37,7 +38,7 @@ import java.util.Map;
*/ */
@RestController @RestController
@RequestMapping(value = "/api/doc/share") @RequestMapping(value = "/api/doc/share")
@Tag(name = "接口测试-接口管理-接口定义-分享") @Tag(name = "接口测试-定义-分享")
public class ApiDocShareController { public class ApiDocShareController {
@Resource @Resource
@ -46,7 +47,7 @@ public class ApiDocShareController {
private ApiDefinitionExportService apiDefinitionExportService; private ApiDefinitionExportService apiDefinitionExportService;
@PostMapping(value = "/page") @PostMapping(value = "/page")
@Operation(summary = "接口测试-接口管理-接口定义-分页获取分享列表") @Operation(summary = "接口测试-定义-分页获取分享列表")
@RequiresPermissions(PermissionConstants.PROJECT_API_DEFINITION_DOC_SHARE) @RequiresPermissions(PermissionConstants.PROJECT_API_DEFINITION_DOC_SHARE)
@CheckOwner(resourceId = "#request.getProjectId()", resourceType = "project") @CheckOwner(resourceId = "#request.getProjectId()", resourceType = "project")
public Pager<List<ApiDocShareDTO>> page(@Validated @RequestBody ApiDocSharePageRequest request) { public Pager<List<ApiDocShareDTO>> page(@Validated @RequestBody ApiDocSharePageRequest request) {
@ -56,7 +57,7 @@ public class ApiDocShareController {
} }
@PostMapping(value = "/add") @PostMapping(value = "/add")
@Operation(summary = "接口测试-接口管理-接口定义-新增分享") @Operation(summary = "接口测试-定义-新增分享")
@RequiresPermissions(PermissionConstants.PROJECT_API_DEFINITION_DOC_SHARE) @RequiresPermissions(PermissionConstants.PROJECT_API_DEFINITION_DOC_SHARE)
@CheckOwner(resourceId = "#request.getProjectId()", resourceType = "project") @CheckOwner(resourceId = "#request.getProjectId()", resourceType = "project")
@Log(type = OperationLogType.ADD, expression = "#msClass.addLog(#request)", msClass = ApiDocShareLogService.class) @Log(type = OperationLogType.ADD, expression = "#msClass.addLog(#request)", msClass = ApiDocShareLogService.class)
@ -65,7 +66,7 @@ public class ApiDocShareController {
} }
@PostMapping(value = "/update") @PostMapping(value = "/update")
@Operation(summary = "接口测试-接口管理-接口定义-更新分享") @Operation(summary = "接口测试-定义-更新分享")
@RequiresPermissions(PermissionConstants.PROJECT_API_DEFINITION_DOC_SHARE) @RequiresPermissions(PermissionConstants.PROJECT_API_DEFINITION_DOC_SHARE)
@CheckOwner(resourceId = "#request.getId()", resourceType = "api_doc_share") @CheckOwner(resourceId = "#request.getId()", resourceType = "api_doc_share")
@Log(type = OperationLogType.UPDATE, expression = "#msClass.updateLog(#request)", msClass = ApiDocShareLogService.class) @Log(type = OperationLogType.UPDATE, expression = "#msClass.updateLog(#request)", msClass = ApiDocShareLogService.class)
@ -74,7 +75,7 @@ public class ApiDocShareController {
} }
@GetMapping("/delete/{id}") @GetMapping("/delete/{id}")
@Operation(summary = "接口测试-接口管理-接口定义-删除分享") @Operation(summary = "接口测试-定义-删除分享")
@Parameter(name = "id", description = "分享ID", schema = @Schema(requiredMode = Schema.RequiredMode.REQUIRED)) @Parameter(name = "id", description = "分享ID", schema = @Schema(requiredMode = Schema.RequiredMode.REQUIRED))
@RequiresPermissions(PermissionConstants.PROJECT_API_DEFINITION_DOC_SHARE) @RequiresPermissions(PermissionConstants.PROJECT_API_DEFINITION_DOC_SHARE)
@CheckOwner(resourceId = "#id", resourceType = "api_doc_share") @CheckOwner(resourceId = "#id", resourceType = "api_doc_share")
@ -84,40 +85,46 @@ public class ApiDocShareController {
} }
@PostMapping("/check") @PostMapping("/check")
@Operation(summary = "接口测试-接口管理-接口定义-校验分享密码") @Operation(summary = "接口测试-定义-校验分享密码")
public Boolean delete(@Validated @RequestBody ApiDocShareCheckRequest request) { public Boolean delete(@Validated @RequestBody ApiDocShareCheckRequest request) {
return apiDocShareService.check(request); return apiDocShareService.check(request);
} }
@GetMapping("/detail/{id}") @GetMapping("/detail/{id}")
@Operation(summary = "接口测试-接口管理-接口定义-分享-查看链接") @Operation(summary = "接口测试-定义-分享-查看链接")
@Parameter(name = "id", description = "分享ID", schema = @Schema(requiredMode = Schema.RequiredMode.REQUIRED)) @Parameter(name = "id", description = "分享ID", schema = @Schema(requiredMode = Schema.RequiredMode.REQUIRED))
public ApiDocShareDetail detail(@PathVariable String id) { public ApiDocShareDetail detail(@PathVariable String id) {
return apiDocShareService.detail(id); return apiDocShareService.detail(id);
} }
@PostMapping("/module/tree") @PostMapping("/module/tree")
@Operation(summary = "接口测试-接口管理-接口定义-分享-模块树") @Operation(summary = "接口测试-定义-分享-模块树")
public List<BaseTreeNode> getShareDocTree(@Validated @RequestBody ApiDocShareModuleRequest request) { public List<BaseTreeNode> getShareDocTree(@Validated @RequestBody ApiDocShareModuleRequest request) {
return apiDocShareService.getShareTree(request); return apiDocShareService.getShareTree(request);
} }
@PostMapping("/module/count") @PostMapping("/module/count")
@Operation(summary = "接口测试-接口管理-接口定义-分享-模块树数量") @Operation(summary = "接口测试-定义-分享-模块树数量")
public Map<String, Long> getShareDocTreeCount(@Validated @RequestBody ApiDocShareModuleRequest request) { public Map<String, Long> getShareDocTreeCount(@Validated @RequestBody ApiDocShareModuleRequest request) {
return apiDocShareService.getShareTreeCount(request); return apiDocShareService.getShareTreeCount(request);
} }
@PostMapping("/export/{type}") @PostMapping("/export/{type}")
@Operation(summary = "接口测试-接口管理-接口定义-分享-导出") @Operation(summary = "接口测试-定义-分享-导出")
public String export(@RequestBody ApiDocShareExportRequest request, @PathVariable String type) { public String export(@RequestBody ApiDocShareExportRequest request, @PathVariable String type) {
return apiDocShareService.export(request, type, SessionUtils.getUserId()); return apiDocShareService.export(request, type, SessionUtils.getUserId());
} }
@GetMapping("/stop/{taskId}") @GetMapping("/stop/{taskId}")
@Operation(summary = "接口测试-接口管理-导出-停止导出") @Operation(summary = "接口测试-定义-分享-导出-停止导出")
public void caseStopExport(@PathVariable String taskId) { public void caseStopExport(@PathVariable String taskId) {
apiDefinitionExportService.stopExport(taskId, SessionUtils.getUserId()); apiDefinitionExportService.stopExport(taskId, SessionUtils.getUserId());
} }
@GetMapping(value = "/download/file/{projectId}/{fileId}")
@Operation(summary = "接口测试-定义-分享-导出-下载文件")
public void downloadImgById(@PathVariable String projectId, @PathVariable String fileId, HttpServletResponse httpServletResponse) {
apiDefinitionExportService.downloadFile(projectId, fileId, SessionUtils.getUserId(), httpServletResponse);
}
} }

10
backend/services/api-test/src/test/java/io/metersphere/api/controller/ApiDocShareControllerTests.java
View File

@ -2,6 +2,7 @@ package io.metersphere.api.controller;
import io.metersphere.api.domain.ApiDocShare; import io.metersphere.api.domain.ApiDocShare;
import io.metersphere.api.dto.definition.request.*; import io.metersphere.api.dto.definition.request.*;
import io.metersphere.sdk.constants.SessionConstants;
import io.metersphere.sdk.util.BeanUtils; import io.metersphere.sdk.util.BeanUtils;
import io.metersphere.sdk.util.JSON; import io.metersphere.sdk.util.JSON;
import io.metersphere.system.base.BaseTest; import io.metersphere.system.base.BaseTest;
@ -14,6 +15,7 @@ import org.junit.jupiter.api.TestMethodOrder;
import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc; import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;
import org.springframework.boot.test.context.SpringBootTest; import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.web.servlet.MvcResult; import org.springframework.test.web.servlet.MvcResult;
import org.springframework.test.web.servlet.request.MockMvcRequestBuilders;
import java.nio.charset.StandardCharsets; import java.nio.charset.StandardCharsets;
import java.util.List; import java.util.List;
@ -35,6 +37,7 @@ public class ApiDocShareControllerTests extends BaseTest {
private final static String MODULE_TREE = BASE_PATH + "module/tree"; private final static String MODULE_TREE = BASE_PATH + "module/tree";
private final static String MODULE_COUNT = BASE_PATH + "module/count"; private final static String MODULE_COUNT = BASE_PATH + "module/count";
private final static String EXPORT = BASE_PATH + "export/Swagger"; private final static String EXPORT = BASE_PATH + "export/Swagger";
private final static String DOWNLOAD = BASE_PATH + "download/file/";
@Order(1) @Order(1)
@Test @Test
@ -79,6 +82,7 @@ public class ApiDocShareControllerTests extends BaseTest {
exportRequest.setSelectAll(false); exportRequest.setSelectAll(false);
exportRequest.setSelectIds(List.of("export-id")); exportRequest.setSelectIds(List.of("export-id"));
this.requestPost(EXPORT, exportRequest); this.requestPost(EXPORT, exportRequest);
this.download(DEFAULT_PROJECT_ID, "export-id");
this.requestGetWithOk(DELETE + docShare.getId()); this.requestGetWithOk(DELETE + docShare.getId());
// 不存在的ID // 不存在的ID
this.requestGet(DELETE + "not-exist-id").andExpect(status().is5xxServerError()); this.requestGet(DELETE + "not-exist-id").andExpect(status().is5xxServerError());
@ -132,4 +136,10 @@ public class ApiDocShareControllerTests extends BaseTest {
pageRequest.setPageSize(10); pageRequest.setPageSize(10);
this.requestPostWithOk(PAGE, pageRequest); this.requestPostWithOk(PAGE, pageRequest);
} }
private MvcResult download(String projectId, String fileId) throws Exception {
return mockMvc.perform(MockMvcRequestBuilders.get(DOWNLOAD + projectId + "/" + fileId)
.header(SessionConstants.HEADER_TOKEN, sessionId)
.header(SessionConstants.CSRF_TOKEN, csrfToken)).andReturn();
}
} }