Skip to content

Commit

Permalink
Layout improvements on pdf campaign execution report pdf. #2475
Browse files Browse the repository at this point in the history
  • Loading branch information
@vertigo17
vertigo17 committed Sep 4, 2023
1 parent cf15b4a commit c9e3364
Show file tree
Hide file tree
Showing 6 changed files with 320 additions and 168 deletions.
70 changes: 60 additions & 10 deletions source/src/main/java/org/cerberus/core/api/controllers/CampaignExecutionController.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,9 @@
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiResponse;
import io.swagger.annotations.ApiResponses;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
Expand All @@ -51,8 +53,18 @@

import javax.servlet.http.HttpServletRequest;
import java.security.Principal;
import java.text.DateFormat;
import java.text.SimpleDateFormat;
import java.util.Arrays;
import java.util.Calendar;
import java.util.Date;
import java.util.List;
import java.util.UUID;
import java.util.zip.ZipEntry;
import java.util.zip.ZipOutputStream;
import org.cerberus.core.crud.entity.Tag;
import org.cerberus.core.service.pdf.IPDFService;
import org.cerberus.core.util.DateUtil;
import org.springframework.core.io.InputStreamResource;

/**
Expand Down Expand Up @@ -106,15 +118,15 @@ public ResponseWrapper<CampaignExecutionDTOV001> findCampaignExecutionById(
);
}

@ApiOperation(value = "Get a campaign execution report in pdf format by campaign execution id (tag)")
@ApiOperation(value = "Get Campaign execution reports in pdf format inside a zip file by campaign execution id (tag)")
@ApiResponses(value = {
@ApiResponse(code = 200, message = "Campaign execution pdf report successfully returned."),
@ApiResponse(code = 200, message = "Campaign execution pdfs report successfully returned."),
@ApiResponse(code = 404, message = "Campaign execution was not found."),
@ApiResponse(code = 500, message = "An error occurred when retrieving the campaign execution pdf report.")
@ApiResponse(code = 500, message = "An error occurred when retrieving the campaign execution pdfs report.")
})
@JsonView(View.Public.GET.class)
@ResponseStatus(HttpStatus.OK)
@GetMapping(path = "/pdf/{campaignExecutionId}", produces = MediaType.APPLICATION_PDF_VALUE)
@GetMapping(path = "/pdf/{campaignExecutionId}", produces = "application/zip")
public ResponseEntity<InputStreamResource> findCampaignExecutionPdfById(
@PathVariable("campaignExecutionId") String campaignExecutionId,
@RequestHeader(name = API_KEY, required = false) String apiKey,
Expand All @@ -126,16 +138,54 @@ public ResponseEntity<InputStreamResource> findCampaignExecutionPdfById(
try {
Tag campaignExeIdTag = this.campaignExecutionService.findByExecutionIdWithExecutions(campaignExecutionId, null);

String pdfFilenameOri = this.pdfService.generatePdf(campaignExeIdTag);
String pdfFilename = this.pdfService.addHeaderAndFooter(pdfFilenameOri, campaignExeIdTag);
Date today = Calendar.getInstance().getTime();
DateFormat df = new SimpleDateFormat(DateUtil.DATE_FORMAT_REPORT_FILE);

String rootPath = "";
if (System.getProperty("java.io.tmpdir") != null) {
rootPath = System.getProperty("java.io.tmpdir");
} else {
String sep = "" + File.separatorChar;
if (sep.equalsIgnoreCase("/")) {
rootPath = "/tmp";
} else {
rootPath = "C:";
}
LOG.warn("Java Property for temporary folder not defined. Default to :" + rootPath);
}
UUID fileUUID = UUID.randomUUID();
String tmpFolderPath = rootPath + File.separatorChar + fileUUID.toString().substring(0, 17) + File.separatorChar;
File folderPath = new File(tmpFolderPath);
folderPath.mkdirs();

String pdfFilenameOri = this.pdfService.generatePdf(campaignExeIdTag, today, tmpFolderPath);
String pdfFilename = this.pdfService.addHeaderAndFooter(pdfFilenameOri, tmpFolderPath + "Campaign Execution.pdf", campaignExeIdTag, today);
Path filePath = Paths.get(pdfFilename);

logEventService.createForPublicCalls(EXECUTIONS_CAMPAIGN_PDF_PATH, "CALLRESULT", String.format("PDF calculated for campaign '%s'", campaignExecutionId), request);
String pdfFilenameOriAppendix = this.pdfService.generatePdfAppendix(campaignExeIdTag, today, tmpFolderPath);
String pdfFilenameAppendix = this.pdfService.addHeaderAndFooter(pdfFilenameOriAppendix, tmpFolderPath + "Campaign Execution - Appendix.pdf", campaignExeIdTag, today);
Path filePathAppendix = Paths.get(pdfFilenameAppendix);

// Creating a PdfWriter
String zipPath = rootPath + File.separatorChar + "campaignExecutionReport-" + fileUUID.toString().substring(0, 17) + ".zip";
Path zipFilePath = Paths.get(zipPath);

List<String> filePaths = Arrays.asList(pdfFilename, pdfFilenameAppendix);

try (ZipOutputStream zipOut = new ZipOutputStream(new FileOutputStream(zipPath))) {
for (String filePath1 : filePaths) {
File fileToZip = new File(filePath1);
zipOut.putNextEntry(new ZipEntry(fileToZip.getName()));
Files.copy(fileToZip.toPath(), zipOut);
}
}

logEventService.createForPublicCalls(EXECUTIONS_CAMPAIGN_PDF_PATH, "CALLRESULT", String.format("PDFs calculated for campaign '%s'", campaignExecutionId), request);
return ResponseEntity
.status(HttpStatus.OK)
.contentLength(filePath.toFile().length())
.header("Content-Disposition", "attachment; filename=CampaignReport-" + campaignExecutionId + ".pdf")
.body(new InputStreamResource(Files.newInputStream(filePath)));
.contentLength(zipFilePath.toFile().length())
.header("Content-Disposition", "attachment; filename=CampaignReport-" + campaignExecutionId + "_" + String.valueOf(df.format(today)) + ".zip")
.body(new InputStreamResource(Files.newInputStream(zipFilePath)));
} catch (EntityNotFoundException exception) {
return ResponseEntity
.status(HttpStatus.NOT_FOUND)
Expand Down
20 changes: 18 additions & 2 deletions source/src/main/java/org/cerberus/core/crud/service/impl/TagService.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,12 @@
import org.apache.logging.log4j.Logger;
import org.apache.logging.log4j.LogManager;
import org.cerberus.core.crud.dao.ITagDAO;
import org.cerberus.core.crud.entity.Campaign;
import org.cerberus.core.crud.entity.EventHook;
import org.cerberus.core.crud.entity.Tag;
import org.cerberus.core.crud.entity.TestCaseExecution;
import org.cerberus.core.crud.factory.IFactoryTag;
import org.cerberus.core.crud.service.ICampaignService;
import org.cerberus.core.crud.service.ITagService;
import org.cerberus.core.crud.service.ITestCaseExecutionQueueService;
import org.cerberus.core.crud.service.ITestCaseExecutionService;
Expand Down Expand Up @@ -80,6 +82,8 @@ public class TagService implements ITagService {
private ITestCaseExecutionQueueService executionQueueService;
@Autowired
private IEventService eventService;
@Autowired
private ICampaignService campaignService;

private static final Logger LOG = LogManager.getLogger("TagService");

Expand Down Expand Up @@ -275,8 +279,20 @@ public Answer createAuto(String tagS, String campaign, String user, JSONArray re
answerTag = readByKey(tagS);
Tag tag = (Tag) answerTag.getItem();
if (tag == null) {
Tag newTag = factoryTag.create(0, tagS, "", "", campaign, null, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, "", "", "", "", "", "",
reqEnvironmentList.toString(), reqCountryList.toString(), "", "", "", "", user, null, user, null);
Campaign cmp = null;
try {
cmp = campaignService.convert(campaignService.readByKey(campaign));
} catch (CerberusException ex) {
LOG.error(ex,ex);
}
Tag newTag;
if (cmp == null) {
newTag = factoryTag.create(0, tagS, "", "", campaign, null, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, "", "", "", "", "", "",
reqEnvironmentList.toString(), reqCountryList.toString(), "", "", "", "", user, null, user, null);
} else {
newTag = factoryTag.create(0, tagS, cmp.getLongDescription(), "", campaign, null, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, "", "", "", "", "", "",
reqEnvironmentList.toString(), reqCountryList.toString(), "", "", "", "", user, null, user, null);
}
Answer ans = tagDAO.create(newTag);
// If campaign is not empty, we can notify the Start of campaign execution.
if (!StringUtil.isEmpty(campaign)) {
Expand Down
24 changes: 19 additions & 5 deletions source/src/main/java/org/cerberus/core/service/pdf/IPDFService.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
package org.cerberus.core.service.pdf;

import java.io.FileNotFoundException;
import java.util.Date;
import org.cerberus.core.crud.entity.Tag;

/**
Expand All @@ -29,18 +30,31 @@ public interface IPDFService {

/**
* @param tag
* @param today
* @param folder
* @return
* @throws java.io.FileNotFoundException
*/
String generatePdf(Tag tag) throws FileNotFoundException;

String generatePdf(Tag tag, Date today, String folder) throws FileNotFoundException;

/**
* @param tag
* @param today
* @param folder
* @return
* @throws java.io.FileNotFoundException
*/
String generatePdfAppendix(Tag tag, Date today, String folder) throws FileNotFoundException;

/**
*
* @param pdfFilePath
* @param pdfFilePathSrc
* @param pdfFilePathDst
* @param tag
* @param today
* @return
* @throws FileNotFoundException
*/
String addHeaderAndFooter(String pdfFilePath, Tag tag) throws FileNotFoundException;
String addHeaderAndFooter(String pdfFilePathSrc, String pdfFilePathDst, Tag tag, Date today) throws FileNotFoundException;

}
Loading

0 comments on commit c9e3364

Please sign in to comment.