Return Batch ID on Revocation List Upload (#145)

eu-digital-green-certificates · Jan 11, 2022 · f35dab5 · f35dab5
1 parent 8b15d91
commit f35dab5
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 13 deletions.
diff --git a/...java/eu/europa/ec/dgc/gateway/restapi/controller/CertificateRevocationListController.java b/...java/eu/europa/ec/dgc/gateway/restapi/controller/CertificateRevocationListController.java
@@ -21,6 +21,7 @@
 package eu.europa.ec.dgc.gateway.restapi.controller;
 
 import eu.europa.ec.dgc.gateway.config.OpenApiConfig;
+import eu.europa.ec.dgc.gateway.entity.RevocationBatchEntity;
 import eu.europa.ec.dgc.gateway.exception.DgcgResponseException;
 import eu.europa.ec.dgc.gateway.model.RevocationBatchDownload;
 import eu.europa.ec.dgc.gateway.restapi.converter.CmsStringMessageConverter;
@@ -209,7 +210,8 @@ public ResponseEntity<String> downloadBatch(
         responses = {
             @ApiResponse(
                 responseCode = "201",
-                description = "Batch created."),
+                description = "Batch created.",
+                headers = @Header(name = HttpHeaders.ETAG, description = "Batch ID of created Batch")),
             @ApiResponse(
                 responseCode = "409",
                 description = "Batch already exists.")
@@ -224,13 +226,17 @@ public ResponseEntity<Void> uploadBatch(
                 "Submitted string needs to be signed by a valid upload certificate");
         }
 
+        String batchId;
+
         try {
-            revocationListService.addRevocationBatch(
+            RevocationBatchEntity entity = revocationListService.addRevocationBatch(
                 batch.getPayloadString(),
                 batch.getSignerCertificate(),
                 batch.getRawMessage(),
                 countryCode
             );
+
+            batchId = entity.getBatchId();
         } catch (RevocationListService.RevocationBatchServiceException e) {
             log.error("Upload of Revocation Batch failed: {}, {}", e.getReason(), e.getMessage());
 
@@ -254,7 +260,10 @@ public ResponseEntity<Void> uploadBatch(
             }
         }
 
-        return ResponseEntity.status(HttpStatus.CREATED).build();
+        return ResponseEntity
+            .status(HttpStatus.CREATED)
+            .header(HttpHeaders.ETAG, batchId)
+            .build();
     }
 
     /**

diff --git a/...eu/europa/ec/dgc/gateway/restapi/controller/CertificateRevocationListIntegrationTest.java b/...eu/europa/ec/dgc/gateway/restapi/controller/CertificateRevocationListIntegrationTest.java
@@ -23,6 +23,7 @@
 import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.delete;
 import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
 import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.post;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.header;
 import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath;
 import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
 
@@ -63,8 +64,10 @@
 import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;
 import org.springframework.boot.test.context.SpringBootTest;
 import org.springframework.http.HttpHeaders;
+import org.springframework.http.HttpStatus;
 import org.springframework.mock.web.MockHttpServletResponse;
 import org.springframework.test.web.servlet.MockMvc;
+import org.springframework.test.web.servlet.MvcResult;
 
 @SpringBootTest
 @AutoConfigureMockMvc
@@ -139,13 +142,14 @@ void testSuccessfulUpload() throws Exception {
 
         String authCertHash = trustedPartyTestHelper.getHash(TrustedPartyEntity.CertificateType.AUTHENTICATION, countryCode);
 
-        mockMvc.perform(post("/revocation-list")
-                .content(payload)
-                .contentType("application/cms")
-                .header(dgcConfigProperties.getCertAuth().getHeaderFields().getThumbprint(), authCertHash)
-                .header(dgcConfigProperties.getCertAuth().getHeaderFields().getDistinguishedName(), authCertSubject)
-            )
-            .andExpect(status().isCreated());
+        MvcResult mvcResult = mockMvc.perform(post("/revocation-list")
+            .content(payload)
+            .contentType("application/cms")
+            .header(dgcConfigProperties.getCertAuth().getHeaderFields().getThumbprint(), authCertHash)
+            .header(dgcConfigProperties.getCertAuth().getHeaderFields().getDistinguishedName(), authCertSubject)
+        ).andReturn();
+
+        Assertions.assertEquals(HttpStatus.CREATED.value(), mvcResult.getResponse().getStatus());
 
         Assertions.assertEquals(revocationBatchesInDb + 1, revocationBatchRepository.count());
         Optional<RevocationBatchEntity> createdRevocationBatch =
@@ -161,6 +165,7 @@ void testSuccessfulUpload() throws Exception {
         Assertions.assertEquals(countryCode, createdRevocationBatch.get().getCountry());
         Assertions.assertEquals(revocationBatchDto.getHashType().name(), createdRevocationBatch.get().getType().name());
         Assertions.assertEquals(revocationBatchDto.getKid(), createdRevocationBatch.get().getKid());
+        Assertions.assertEquals(createdRevocationBatch.get().getBatchId(), mvcResult.getResponse().getHeader(HttpHeaders.ETAG));
         Assertions.assertEquals(36, createdRevocationBatch.get().getBatchId().length());
 
         SignedStringMessageParser parser = new SignedStringMessageParser(createdRevocationBatch.get().getSignedBatch());
@@ -192,6 +197,7 @@ void testUploadFailedInvalidJson() throws Exception {
             )
             .andExpect(status().isBadRequest());
 
+
         Assertions.assertEquals(revocationBatchesInDb, revocationBatchRepository.count());
         Assertions.assertEquals(auditEventEntitiesInDb, auditEventRepository.count());
     }
@@ -230,7 +236,8 @@ void testUploadFailedInvalidJsonValues() throws Exception {
                 .header(dgcConfigProperties.getCertAuth().getHeaderFields().getThumbprint(), authCertHash)
                 .header(dgcConfigProperties.getCertAuth().getHeaderFields().getDistinguishedName(), authCertSubject)
             )
-            .andExpect(status().isBadRequest());
+            .andExpect(status().isBadRequest())
+            .andExpect(header().doesNotExist(HttpHeaders.ETAG));
 
         Assertions.assertEquals(revocationBatchesInDb, revocationBatchRepository.count());
         Assertions.assertEquals(auditEventEntitiesInDb, auditEventRepository.count());
@@ -270,7 +277,8 @@ void testUploadFailedInvalidJsonValuesInHashEntries() throws Exception {
                 .header(dgcConfigProperties.getCertAuth().getHeaderFields().getThumbprint(), authCertHash)
                 .header(dgcConfigProperties.getCertAuth().getHeaderFields().getDistinguishedName(), authCertSubject)
             )
-            .andExpect(status().isBadRequest());
+            .andExpect(status().isBadRequest())
+            .andExpect(header().doesNotExist(HttpHeaders.ETAG));
 
         Assertions.assertEquals(revocationBatchesInDb, revocationBatchRepository.count());
         Assertions.assertEquals(auditEventEntitiesInDb, auditEventRepository.count());
@@ -310,7 +318,8 @@ void testUploadFailedInvalidCountry() throws Exception {
                 .header(dgcConfigProperties.getCertAuth().getHeaderFields().getThumbprint(), authCertHash)
                 .header(dgcConfigProperties.getCertAuth().getHeaderFields().getDistinguishedName(), authCertSubject)
             )
-            .andExpect(status().isForbidden());
+            .andExpect(status().isForbidden())
+            .andExpect(header().doesNotExist(HttpHeaders.ETAG));
 
         Assertions.assertEquals(revocationBatchesInDb, revocationBatchRepository.count());
         Assertions.assertEquals(auditEventEntitiesInDb, auditEventRepository.count());