Skip to content

Fix content-type on /v2/jobs/script/{jobid} #389

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

Merged
kevin-mcgoldrick merged 1 commit into from
Apr 21, 2025
Merged

Fix content-type on /v2/jobs/script/{jobid} #389

Show file tree
Hide file tree
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
11 changes: 3 additions & 8 deletions rest-mvc/impl/src/main/java/com/intuit/tank/rest/mvc/rest/controllers/AgentController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,11 +70,8 @@ public ResponseEntity<org.springframework.core.io.Resource> getSupportFiles() th
File supportFiles = agentService.getSupportFiles();
InputStreamResource resource = new InputStreamResource(new FileInputStream(supportFiles));

HttpHeaders headers = new HttpHeaders();
headers.add(HttpHeaders.CONTENT_DISPOSITION, "attachment; filename=\"" + supportFiles.getName() + "\"");

return ResponseEntity.ok()
.headers(headers)
.header(HttpHeaders.CONTENT_DISPOSITION, "attachment; filename=\"" + supportFiles.getName() + "\"")
.contentLength(supportFiles.length())
.contentType(MediaType.APPLICATION_OCTET_STREAM)
.body(resource);
Expand Down Expand Up @@ -132,10 +129,8 @@ public ResponseEntity<Void> setStandaloneAgentAvailability(
})
public ResponseEntity<CloudVmStatus> getInstanceStatus(@PathVariable @Parameter(description = "The instance ID associated with the instance", required = true) String instanceId) {
CloudVmStatus status = agentService.getInstanceStatus(instanceId);
if (status != null) {
return new ResponseEntity<CloudVmStatus>(status, HttpStatus.OK);
}
return ResponseEntity.notFound().build();
if (status == null) return ResponseEntity.notFound().build();
return new ResponseEntity<CloudVmStatus>(status, HttpStatus.OK);
}

@RequestMapping(value = "/instance/status/{instanceId}", method = RequestMethod.PUT, consumes = { MediaType.APPLICATION_JSON_VALUE })
Expand Down
13 changes: 5 additions & 8 deletions ...-mvc/impl/src/main/java/com/intuit/tank/rest/mvc/rest/controllers/DataFileController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,10 +76,8 @@ public ResponseEntity<Map<Integer, String>> getAllDatafileNames() {
})
public ResponseEntity<DataFileDescriptor> getDatafile(@PathVariable @Parameter(description = "Datafile ID", required = true) Integer datafileId) {
DataFileDescriptor datafile = dataFileService.getDatafile(datafileId);
if (datafile != null){
return new ResponseEntity<>(datafile, HttpStatus.OK);
}
return ResponseEntity.notFound().build();
if (datafile == null) return ResponseEntity.notFound().build();
return new ResponseEntity<>(datafile, HttpStatus.OK);
}

@RequestMapping(value = "/content", method = RequestMethod.GET, produces = { MediaType.TEXT_PLAIN_VALUE } )
Expand All @@ -100,17 +98,16 @@ public ResponseEntity<String> getDatafileContent(@RequestParam(required = true)
return ResponseEntity.notFound().build();
}

@RequestMapping(value = "/download/{datafileId}", method = RequestMethod.GET)
@RequestMapping(value = "/download/{datafileId}", method = RequestMethod.GET, produces = { MediaType.APPLICATION_OCTET_STREAM_VALUE })
@Operation(description = "Downloads a datafile with the corresponding datafile ID", summary = "Download a datafile")
@ApiResponses(value = {
@ApiResponse(responseCode = "200", description = "Successfully downloaded the datafile", content = @Content),
@ApiResponse(responseCode = "404", description = "Datafile could not be found", content = @Content)
})
public ResponseEntity<StreamingResponseBody> downloadDatafile(@PathVariable @Parameter(description = "Datafile ID", required = true) Integer datafileId) throws IOException {
Map<String, StreamingResponseBody> response = dataFileService.downloadDatafile(datafileId);
if (response == null) {
return ResponseEntity.notFound().build();
}
if (response == null) return ResponseEntity.notFound().build();

String filename = response.keySet().iterator().next();
StreamingResponseBody responseBody = response.get(filename);

Expand Down
34 changes: 12 additions & 22 deletions rest-mvc/impl/src/main/java/com/intuit/tank/rest/mvc/rest/controllers/JobController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,10 +116,8 @@ public ResponseEntity<Map<String, String>> createJob(
})
public ResponseEntity<List<Map<String, String>>> getAllJobStatus() {
List<Map<String, String>> status = jobService.getAllJobStatus();
if (status != null){
return new ResponseEntity<>(status, HttpStatus.OK);
}
return ResponseEntity.notFound().build();
if (status == null) return ResponseEntity.notFound().build();
return new ResponseEntity<>(status, HttpStatus.OK);
}

@RequestMapping(value = "/status/{jobId}", method = RequestMethod.GET, produces = { MediaType.TEXT_PLAIN_VALUE })
Expand All @@ -130,10 +128,8 @@ public ResponseEntity<List<Map<String, String>>> getAllJobStatus() {
})
public ResponseEntity<String> getJobStatus(@PathVariable @Parameter(description = "The job ID associated with the job", required = true) Integer jobId) {
String status = jobService.getJobStatus(jobId);
if (status != null){
return new ResponseEntity<>(status, HttpStatus.OK);
}
return ResponseEntity.notFound().build();
if (status == null) return ResponseEntity.notFound().build();
return new ResponseEntity<>(status, HttpStatus.OK);
}

@RequestMapping(value = "/instance-status/{jobId}", method = RequestMethod.GET)
Expand All @@ -144,10 +140,8 @@ public ResponseEntity<String> getJobStatus(@PathVariable @Parameter(description
})
public ResponseEntity<CloudVmStatusContainer> getJobVMStatuses(@PathVariable @Parameter(description = "The job ID associated with the job", required = true) String jobId) {
CloudVmStatusContainer status = jobService.getJobVMStatus(jobId);
if (status != null){
return new ResponseEntity<>(status, HttpStatus.OK);
}
return ResponseEntity.notFound().build();
if (status == null) return ResponseEntity.notFound().build();
return new ResponseEntity<>(status, HttpStatus.OK);
}

@RequestMapping(value = "/script/{jobId}", method = RequestMethod.GET, produces = { MediaType.APPLICATION_XML_VALUE })
Expand All @@ -158,29 +152,25 @@ public ResponseEntity<CloudVmStatusContainer> getJobVMStatuses(@PathVariable @Pa
})
public ResponseEntity<StreamingResponseBody> getTestScriptForJob(@PathVariable @Parameter(description = "Job ID", required = true) Integer jobId) throws IOException {
StreamingResponseBody response = jobService.getTestScriptForJob(jobId);
return new ResponseEntity<>(response, HttpStatus.OK);
return ResponseEntity.ok().contentType(MediaType.APPLICATION_XML).body(response);
}

@RequestMapping(value = "/download/{jobId}", method = RequestMethod.GET)
@RequestMapping(value = "/download/{jobId}", method = RequestMethod.GET, produces = { MediaType.APPLICATION_XML_VALUE })
@Operation(description = "Downloads a job's harness XML file", summary = "Download the job's harness file")
@ApiResponses(value = {
@ApiResponse(responseCode = "200", description = "Successfully downloaded job's harness file", content = @Content),
@ApiResponse(responseCode = "404", description = "Job's harness file could not be found", content = @Content)
})
public ResponseEntity<StreamingResponseBody> downloadTestScriptForJob(@PathVariable @Parameter(description = "Job ID", required = true) Integer jobId) throws IOException {
Map<String, StreamingResponseBody> response = jobService.downloadTestScriptForJob(jobId);
if (response == null) {
return ResponseEntity.notFound().build();
}
if (response == null) return ResponseEntity.notFound().build();

String filename = response.keySet().iterator().next();
StreamingResponseBody responseBody = response.get(filename);

HttpHeaders headers = new HttpHeaders();
headers.add(HttpHeaders.CONTENT_DISPOSITION, "attachment; filename=\"" + filename + "\"");

return ResponseEntity.ok()
.headers(headers)
.contentType(MediaType.APPLICATION_OCTET_STREAM)
.header(HttpHeaders.CONTENT_DISPOSITION, "attachment; filename=\"" + filename + "\"")
.contentType(MediaType.APPLICATION_XML)
.body(responseBody);
}

Expand Down
2 changes: 1 addition & 1 deletion rest-mvc/impl/src/main/java/com/intuit/tank/rest/mvc/rest/controllers/LogController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ public class LogController {
@Resource
private LogServiceV2 logServiceV2;

@RequestMapping(value = "/{filename}", method = RequestMethod.GET)
@RequestMapping(value = "/{filename}", method = RequestMethod.GET, produces = { MediaType.APPLICATION_OCTET_STREAM_VALUE })
@Operation(description = "Retrieves a specific log file from logs", summary = "Get streaming log file output", hidden = true)
public ResponseEntity<StreamingResponseBody> getFile(@PathVariable String filename, @RequestParam(required = false) String from) throws IOException {
StreamingResponseBody response = logServiceV2.getFile(filename, from);
Expand Down
14 changes: 5 additions & 9 deletions rest-mvc/impl/src/main/java/com/intuit/tank/rest/mvc/rest/controllers/ProjectController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,26 +132,22 @@ public ResponseEntity<Map<String, String>> updateProject(
return new ResponseEntity<>(response, HttpStatus.OK);
}

@RequestMapping(value = "/download/{projectId}", method = RequestMethod.GET)
@RequestMapping(value = "/download/{projectId}", method = RequestMethod.GET, produces = { MediaType.APPLICATION_XML_VALUE })
@Operation(description = "Downloads a project's harness XML file", summary = "Download the project's harness file")
@ApiResponses(value = {
@ApiResponse(responseCode = "200", description = "Successfully downloaded project's harness file", content = @Content),
@ApiResponse(responseCode = "404", description = "Project's harness file could not be found", content = @Content)
})
public ResponseEntity<StreamingResponseBody> downloadTestScriptForProject(@PathVariable @Parameter(description = "Project ID", required = true) Integer projectId) throws IOException {
Map<String, StreamingResponseBody> response = projectService.downloadTestScriptForProject(projectId);
if (response == null) {
return ResponseEntity.notFound().build();
}
if (response == null) return ResponseEntity.notFound().build();

String filename = response.keySet().iterator().next();
StreamingResponseBody responseBody = response.get(filename);

HttpHeaders headers = new HttpHeaders();
headers.add(HttpHeaders.CONTENT_DISPOSITION, "attachment; filename=\"" + filename + "\"");

return ResponseEntity.ok()
.headers(headers)
.contentType(MediaType.APPLICATION_OCTET_STREAM)
.header(HttpHeaders.CONTENT_DISPOSITION, "attachment; filename=\"" + filename + "\"")
.contentType(MediaType.APPLICATION_XML)
.body(responseBody);
}

Expand Down
45 changes: 16 additions & 29 deletions rest-mvc/impl/src/main/java/com/intuit/tank/rest/mvc/rest/controllers/ScriptController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,10 +80,8 @@ public ResponseEntity<Map<Integer, String>> getAllScriptNames() {
})
public ResponseEntity<ScriptDescription> getScript(@PathVariable @Parameter(description = "Script ID", required = true) Integer scriptId) {
ScriptDescription script = scriptService.getScript(scriptId);
if (script != null){
return new ResponseEntity<>(script, HttpStatus.OK);
}
return ResponseEntity.notFound().build();
if (script == null) return ResponseEntity.notFound().build();
return new ResponseEntity<>(script, HttpStatus.OK);
}

@RequestMapping(method = RequestMethod.POST)
Expand Down Expand Up @@ -129,9 +127,8 @@ public ResponseEntity<Map<String, String>> createScript(@RequestHeader(value = H
})
public ResponseEntity<StreamingResponseBody> downloadScript(@PathVariable @Parameter(description = "Script ID", required = true) Integer scriptId) throws IOException {
Map<String, StreamingResponseBody> response = scriptService.downloadScript(scriptId);
if (response == null) {
return ResponseEntity.notFound().build();
}
if (response == null) return ResponseEntity.notFound().build();

String filename = response.keySet().iterator().next();
StreamingResponseBody responseBody = response.get(filename);

Expand All @@ -144,26 +141,22 @@ public ResponseEntity<StreamingResponseBody> downloadScript(@PathVariable @Param
.body(responseBody);
}

@RequestMapping(value = "/harness/download/{scriptId}", method = RequestMethod.GET)
@RequestMapping(value = "/harness/download/{scriptId}", method = RequestMethod.GET, produces = { MediaType.APPLICATION_XML_VALUE })
@Operation(description = "Downloads the Tank Harness file for a script with the corresponding script ID", summary = "Download the Tank Harness script file")
@ApiResponses(value = {
@ApiResponse(responseCode = "200", description = "Successfully downloaded the Tank Harness script file", content = @Content),
@ApiResponse(responseCode = "404", description = "Tank Harness script file could not be found", content = @Content)
})
public ResponseEntity<StreamingResponseBody> downloadHarnessScript(@PathVariable @Parameter(description = "Script ID", required = true) Integer scriptId) throws IOException {
Map<String, StreamingResponseBody> response = scriptService.downloadHarnessScript(scriptId);
if (response == null) {
return ResponseEntity.notFound().build();
}
if (response == null) return ResponseEntity.notFound().build();

String filename = response.keySet().iterator().next();
StreamingResponseBody responseBody = response.get(filename);

HttpHeaders headers = new HttpHeaders();
headers.add(HttpHeaders.CONTENT_DISPOSITION, "attachment; filename=\"" + filename + "\"");

return ResponseEntity.ok()
.headers(headers)
.contentType(MediaType.APPLICATION_OCTET_STREAM)
.header(HttpHeaders.CONTENT_DISPOSITION, "attachment; filename=\"" + filename + "\"")
.contentType(MediaType.APPLICATION_XML)
.body(responseBody);
}

Expand Down Expand Up @@ -201,10 +194,8 @@ public ResponseEntity<ExternalScriptContainer> getExternalScripts() {
})
public ResponseEntity<ExternalScriptTO> getExternalScript(@PathVariable @Parameter(description = "External Script ID", required = true) Integer externalScriptId) {
ExternalScriptTO script = scriptService.getExternalScript(externalScriptId);
if (script != null){
return new ResponseEntity<>(script, HttpStatus.OK);
}
return ResponseEntity.notFound().build();
if (script == null) return ResponseEntity.notFound().build();
return new ResponseEntity<>(script, HttpStatus.OK);
}

@RequestMapping(value = "/external", method = RequestMethod.POST, consumes = { MediaType.APPLICATION_JSON_VALUE })
Expand All @@ -222,26 +213,22 @@ public ResponseEntity<ExternalScriptTO> createExternalScript(
return new ResponseEntity<>(savedScript, responseHeaders, HttpStatus.CREATED);
}

@RequestMapping(value = "/external/download/{externalScriptId}", method = RequestMethod.GET)
@RequestMapping(value = "/external/download/{externalScriptId}", method = RequestMethod.GET, produces = { MediaType.APPLICATION_XML_VALUE })
@Operation(description = "Downloads the Tank XML file for an external script with the corresponding external script ID", summary = "Download an external script")
@ApiResponses(value = {
@ApiResponse(responseCode = "200", description = "Successfully downloaded the Tank XML external script file", content = @Content),
@ApiResponse(responseCode = "404", description = "Tank XML external script file could not be found", content = @Content)
})
public ResponseEntity<StreamingResponseBody> downloadExternalScript(@PathVariable @Parameter(description = "External Script ID", required = true) Integer externalScriptId) throws IOException {
Map<String, StreamingResponseBody> response = scriptService.downloadExternalScript(externalScriptId);
if (response == null) {
return ResponseEntity.notFound().build();
}
if (response == null) return ResponseEntity.notFound().build();

String filename = response.keySet().iterator().next();
StreamingResponseBody responseBody = response.get(filename);

HttpHeaders headers = new HttpHeaders();
headers.add(HttpHeaders.CONTENT_DISPOSITION, "attachment; filename=\"" + filename + "\"");

return ResponseEntity.ok()
.headers(headers)
.contentType(MediaType.APPLICATION_OCTET_STREAM)
.header(HttpHeaders.CONTENT_DISPOSITION, "attachment; filename=\"" + filename + "\"")
.contentType(MediaType.APPLICATION_XML)
.body(responseBody);
}

Expand Down
3 changes: 2 additions & 1 deletion rest-mvc/impl/src/test/java/com/intuit/tank/rest/mvc/rest/controllers/JobControllerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,6 +196,7 @@ public void testGetTestScriptForJob() throws IOException {
"csv, 3, 4\n" +
"file, 5, 6\n", out.toString());
}
assertEquals(MediaType.APPLICATION_XML, result.getHeaders().getContentType());
assertEquals(200, result.getStatusCode().value());
verify(jobService).getTestScriptForJob(2);
}
Expand All @@ -211,7 +212,7 @@ public void testDownloadTestScriptForJob() throws IOException {
payload.put(filename, responseBody);
when(jobService.downloadTestScriptForJob(2)).thenReturn(payload);
ResponseEntity<StreamingResponseBody> result = jobController.downloadTestScriptForJob(2);
assertEquals(MediaType.APPLICATION_OCTET_STREAM, result.getHeaders().getContentType());
assertEquals(MediaType.APPLICATION_XML, result.getHeaders().getContentType());
assertEquals(filename, result.getHeaders().getContentDisposition().getFilename());
assertEquals(200, result.getStatusCode().value());
verify(jobService).downloadTestScriptForJob(2);
Expand Down
2 changes: 1 addition & 1 deletion ...c/impl/src/test/java/com/intuit/tank/rest/mvc/rest/controllers/ProjectControllerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ public void testDownloadTestScriptForProject() throws IOException {
payload.put(filename, streamingResponse);
when(projectService.downloadTestScriptForProject(4)).thenReturn(payload);
ResponseEntity<StreamingResponseBody> result = projectController.downloadTestScriptForProject(4);
assertEquals(MediaType.APPLICATION_OCTET_STREAM, result.getHeaders().getContentType());
assertEquals(MediaType.APPLICATION_XML, result.getHeaders().getContentType());
assertEquals(filename, result.getHeaders().getContentDisposition().getFilename());
assertEquals(200, result.getStatusCode().value());
verify(projectService).downloadTestScriptForProject(4);
Expand Down
4 changes: 2 additions & 2 deletions ...vc/impl/src/test/java/com/intuit/tank/rest/mvc/rest/controllers/ScriptControllerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -257,7 +257,7 @@ public void testDownloadHarnessScript() throws IOException {
payload.put(filename, streamingResponse);
when(scriptService.downloadHarnessScript(4)).thenReturn(payload);
ResponseEntity<StreamingResponseBody> result = scriptController.downloadHarnessScript(4);
assertEquals(MediaType.APPLICATION_OCTET_STREAM, result.getHeaders().getContentType());
assertEquals(MediaType.APPLICATION_XML, result.getHeaders().getContentType());
assertEquals(filename, result.getHeaders().getContentDisposition().getFilename());
assertEquals(200, result.getStatusCode().value());
verify(scriptService).downloadHarnessScript(4);
Expand Down Expand Up @@ -348,7 +348,7 @@ public void testDownloadExternalScript() throws IOException {
payload.put(filename, streamingResponse);
when(scriptService.downloadExternalScript(5)).thenReturn(payload);
ResponseEntity<StreamingResponseBody> result = scriptController.downloadExternalScript(5);
assertEquals(MediaType.APPLICATION_OCTET_STREAM, result.getHeaders().getContentType());
assertEquals(MediaType.APPLICATION_XML, result.getHeaders().getContentType());
assertEquals(filename, result.getHeaders().getContentDisposition().getFilename());
assertEquals(200, result.getStatusCode().value());
verify(scriptService).downloadExternalScript(5);
Expand Down