Update tests

veraPDF · Jan 10, 2024 · c9966b4 · c9966b4
1 parent 86c6256
commit c9966b4
Show file tree

Hide file tree

Showing 51 changed files with 240 additions and 286 deletions.
diff --git a/...config option tests with docker build.yml → ...flows/options-tests-with-docker-build.yml b/...config option tests with docker build.yml → ...flows/options-tests-with-docker-build.yml
@@ -1,4 +1,4 @@
-name: Config option tests with build rest:dev
+name: Options tests with build rest:dev
 
 on:
   schedule:
@@ -15,7 +15,7 @@ jobs:
 
       - name: Build and run Docker Image
         run: |
-          docker build  --build-arg  GH_CHECKOUT=integration -t  ghcr.io/verapdf/rest:dev . && docker run --user root -d -p 8080:8080 -p 8081:8081 ghcr.io/verapdf/rest:dev
+          docker build  --build-arg  GH_CHECKOUT=integration -t  ghcr.io/verapdf/rest:dev . && docker run --user root -d -p 8080:8080 -p 8081:8081  -e VERAPDF_MAX_FILE_SIZE=1  -v /tmp:/home/Res_tmp ghcr.io/verapdf/rest:dev
           echo whoami: $(docker inspect $(docker ps -q) --format '{{.Config.User}} {{.Name}}')
 
       - name: Check Docker Container
@@ -49,14 +49,15 @@ jobs:
 
           ./bats/bin/bats -v
 
-      - name: Config option ... running tests
+      - name: Running tests ... Options
         working-directory: ./tests
         run: |
           echo pwd: $PWD
           echo dir: $(ls ./)
           ./bats/bin/bats -r ./Options --show-output-of-passing-tests  --print-output-on-failure  --report-formatter junit --output ./results
 
       - name: Generating report
+        if: always()
         working-directory: ./tests/results
         run: |
           echo pwd: $PWD

diff --git a/...ows/rest-api tests with ghcr rest:dev.yml → ...ows/rest-api-tests-with-ghcr-rest:dev.yml b/...ows/rest-api tests with ghcr rest:dev.yml → ...ows/rest-api-tests-with-ghcr-rest:dev.yml
diff --git a/.gitignore b/.gitignore
@@ -33,3 +33,4 @@ verapdf/
 *.log
 *.html
 *.css
+*.code-workspace
diff --git a/kubernetes.yaml b/kubernetes.yaml
@@ -14,14 +14,19 @@ spec:
       labels:
         project: verapdf-rest
     spec:
+      terminationGracePeriodSeconds: 300
       containers:
         - name : verapdf-rest
           image: ghcr.io/verapdf/rest:dev
+          lifecycle:
+            preStop:
+              exec:
+                command: ["/bin/sleep", "300"]
           resources:
             requests:
               cpu: "250m"
             limits:
-              cpu: "250m"
+              cpu: "2000m"
           ports:
             - containerPort: 8080
               name         : rest-api-port

diff --git a/src/main/java/org/verapdf/rest/resources/ProfileResource.java b/src/main/java/org/verapdf/rest/resources/ProfileResource.java
@@ -93,7 +93,7 @@ public static Set<PDFAFlavour> getFlavours() {
 	/**
 	 * @param profileId
 	 *            the String id of the Validation profile (1b, 1a, 2b, 2a, 2u,
-	 *            3b, 3a, 3u, 4, 4e, 4f or ua1)
+	 *            3b, 3a, 3u, 4, 4e, 4f, ua1 or ua2)
 	 * @return a validation profile selected by id
 	 */
 	@GET
@@ -108,15 +108,15 @@ public static Set<PDFAFlavour> getFlavours() {
 			)})})
 	@Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
 	public static ValidationProfile getProfile(@Parameter(description = "the String id of the Validation profile " +
-	                                                                    "(1b, 1a, 2b, 2a, 2u, 3b, 3a, 3u, 4, 4e, 4f or ua1)")
+	                                                                    "(1b, 1a, 2b, 2a, 2u, 3b, 3a, 3u, 4, 4e, 4f, ua1 or ua2)")
 	                                           @PathParam("profileId") String profileId) {
 		return DIRECTORY.getValidationProfileById(profileId);
 	}
 
 	/**
 	 * @param profileId
 	 *            the String id of the Validation profile (1b, 1a, 2b, 2a, 2u,
-	 *            3b, 3a, 3u, 4, 4e, 4f or ua1)
+	 *            3b, 3a, 3u, 4, 4e, 4f, ua1 or ua2)
 	 * @return the {@link java.util.Set} of
 	 *         {@link org.verapdf.pdfa.validation.profiles.RuleId}s for the selected
 	 *         Validation Profile
@@ -133,7 +133,7 @@ public static ValidationProfile getProfile(@Parameter(description = "the String
 			)})})
 	@Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
 	public static Set<RuleId> getProfileRules(@Parameter(description = "the String id of the Validation profile " +
-	                                                                   "(1b, 1a, 2b, 2a, 2u, 3b, 3a, 3u, 4, 4e, 4f or ua1)")
+	                                                                   "(1b, 1a, 2b, 2a, 2u, 3b, 3a, 3u, 4, 4e, 4f, ua1 or ua2)")
 	                                          @PathParam("profileId") String profileId) {
 		SortedSet<RuleId> ids = new TreeSet<>(new Profiles.RuleIdComparator());
 		for (Rule rule : DIRECTORY.getValidationProfileById(profileId).getRules()) {
@@ -145,7 +145,7 @@ public static Set<RuleId> getProfileRules(@Parameter(description = "the String i
 	/**
 	 * @param profileId
 	 *            the String id of the Validation profile (1b, 1a, 2b, 2a, 2u,
-	 *            3b, 3a, 3u, 4, 4e, 4f or ua1)
+	 *            3b, 3a, 3u, 4, 4e, 4f, ua1 or ua2)
 	 * @param clause
 	 *            a {@link java.lang.String} identifying the profile clause to
 	 *            return the Rules for
@@ -165,7 +165,7 @@ public static Set<RuleId> getProfileRules(@Parameter(description = "the String i
 			)})})
 	@Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
 	public static Set<Rule> getRulesForClause(@Parameter(description = "the String id of the Validation profile " +
-	                                                                   "(1b, 1a, 2b, 2a, 2u, 3b, 3a, 3u, 4, 4e, 4f or ua1)")
+	                                                                   "(1b, 1a, 2b, 2a, 2u, 3b, 3a, 3u, 4, 4e, 4f, ua1 or ua2)")
 	                                          @PathParam("profileId") String profileId,
 	                                          @Parameter(description = "a string identifying the profile clause to return the rules for")
 	                                          @PathParam("clause") String clause) {

diff --git a/src/main/java/org/verapdf/rest/resources/ValidateResource.java b/src/main/java/org/verapdf/rest/resources/ValidateResource.java
@@ -85,7 +85,7 @@ public static ComponentDetails getDetails() {
 	 * @param profileId
 	 *                                 the String id of the Validation profile
 	 *                                 (auto, 1b, 1a, 2b, 2a, 2u,
-	 *                                 3b, 3a, 3u, 4, 4e, 4f or ua1)
+	 *                                 3b, 3a, 3u, 4, 4e, 4f, ua1 or ua2)
 	 * @param uploadedInputStream
 	 *                                 a {@link java.io.InputStream} to the PDF to
 	 *                                 be validated
@@ -108,7 +108,7 @@ public static ComponentDetails getDetails() {
 	@Consumes(MediaType.MULTIPART_FORM_DATA)
 	@Produces({MediaType.APPLICATION_XML})
 	public static InputStream validateXml(@Parameter(description = "the String id of the Validation profile " +
-	                                                               "(auto, 1b, 1a, 2b, 2a, 2u, 3b, 3a, 3u, 4, 4e, 4f or ua1)")
+	                                                               "(auto, 1b, 1a, 2b, 2a, 2u, 3b, 3a, 3u, 4, 4e, 4f, ua1 or ua2)")
 	                                      @PathParam("profileId") String profileId,
 	                                      @Parameter(name = "file", schema = @Schema(implementation = File.class),
 	                                                 style = ParameterStyle.FORM, description = "an InputStream of the PDF to be validated")
@@ -123,7 +123,7 @@ public static InputStream validateXml(@Parameter(description = "the String id of
 	 * @param profileId
 	 *                                 the String id of the Validation profile
 	 *                                 (auto, 1b, 1a, 2b, 2a, 2u,
-	 *                                 3b, 3a, 3u, 4, 4e, 4f or ua1)
+	 *                                 3b, 3a, 3u, 4, 4e, 4f, ua1 or ua2)
 	 * @param sha1Hex
 	 *                                 the hex String representation of the file's
 	 *                                 SHA-1 hash
@@ -149,7 +149,7 @@ public static InputStream validateXml(@Parameter(description = "the String id of
 	@Consumes(MediaType.MULTIPART_FORM_DATA)
 	@Produces({MediaType.APPLICATION_XML})
 	public static InputStream validateXml(@Parameter(description = "the String id of the Validation profile " +
-	                                                               "(auto, 1b, 1a, 2b, 2a, 2u, 3b, 3a, 3u, 4, 4e, 4f or ua1)")
+	                                                               "(auto, 1b, 1a, 2b, 2a, 2u, 3b, 3a, 3u, 4, 4e, 4f, ua1 or ua2)")
 	                                      @PathParam("profileId") String profileId,
 	                                      @Parameter(description = "the hex String representation of the file's SHA-1 hash")
 	                                      @FormDataParam("sha1Hex") String sha1Hex,
@@ -177,7 +177,7 @@ public static InputStream validateXml(@Parameter(description = "the String id of
 	@Consumes(MediaType.MULTIPART_FORM_DATA)
 	@Produces({MediaType.APPLICATION_XML})
 	public static InputStream validateXml(@Parameter(description = "the String id of the Validation profile " +
-	                                                               "(auto, 1b, 1a, 2b, 2a, 2u, 3b, 3a, 3u, 4, 4e, 4f or ua1)")
+	                                                               "(auto, 1b, 1a, 2b, 2a, 2u, 3b, 3a, 3u, 4, 4e, 4f, ua1 or ua2)")
 	                                      @PathParam("profileId") String profileId,
 	                                      @Parameter(description = "a URL of PDF to be validated")
 	                                      @FormDataParam("url") String urlLink,
@@ -190,7 +190,7 @@ public static InputStream validateXml(@Parameter(description = "the String id of
 	 * @param profileId
 	 *                                 the String id of the Validation profile
 	 *                                 (auto, 1b, 1a, 2b, 2a, 2u,
-	 *                                 3b, 3a, 3u, 4, 4e, 4f or ua1)
+	 *                                 3b, 3a, 3u, 4, 4e, 4f, ua1 or ua2)
 	 * @param uploadedInputStream
 	 *                                 a {@link java.io.InputStream} to the PDF to
 	 *                                 be validated
@@ -203,7 +203,7 @@ public static InputStream validateXml(@Parameter(description = "the String id of
 	@Consumes(MediaType.MULTIPART_FORM_DATA)
 	@Produces({MediaType.APPLICATION_JSON})
 	public static InputStream validateJson(@Parameter(description = "the String id of the Validation profile " +
-	                                                                "(auto, 1b, 1a, 2b, 2a, 2u, 3b, 3a, 3u, 4, 4e, 4f or ua1)")
+	                                                                "(auto, 1b, 1a, 2b, 2a, 2u, 3b, 3a, 3u, 4, 4e, 4f, ua1 or ua2)")
 	                                       @PathParam("profileId") String profileId,
 	                                       @Parameter(name = "file", schema = @Schema(implementation = File.class),
 	                                                  style = ParameterStyle.FORM, description = "an InputStream of the PDF to be validated")
@@ -218,7 +218,7 @@ public static InputStream validateJson(@Parameter(description = "the String id o
 	 * @param profileId
 	 *                                 the String id of the Validation profile
 	 *                                 (auto, 1b, 1a, 2b, 2a, 2u,
-	 *                                 3b, 3a, 3u, 4, 4e, 4f or ua1)
+	 *                                 3b, 3a, 3u, 4, 4e, 4f, ua1 or ua2)
 	 * @param sha1Hex
 	 *                                 the hex String representation of the file's
 	 *                                 SHA-1 hash
@@ -234,7 +234,7 @@ public static InputStream validateJson(@Parameter(description = "the String id o
 	@Consumes(MediaType.MULTIPART_FORM_DATA)
 	@Produces({MediaType.APPLICATION_JSON})
 	public static InputStream validateJson(@Parameter(description = "the String id of the Validation profile " +
-	                                                                "(auto, 1b, 1a, 2b, 2a, 2u, 3b, 3a, 3u, 4, 4e, 4f or ua1)")
+	                                                                "(auto, 1b, 1a, 2b, 2a, 2u, 3b, 3a, 3u, 4, 4e, 4f, ua1 or ua2)")
 	                                       @PathParam("profileId") String profileId,
 	                                       @Parameter(description = "the hex String representation of the file's SHA-1 hash")
 	                                       @FormDataParam("sha1Hex") String sha1Hex,
@@ -253,7 +253,7 @@ public static InputStream validateJson(@Parameter(description = "the String id o
 	@Consumes(MediaType.MULTIPART_FORM_DATA)
 	@Produces({MediaType.APPLICATION_JSON})
 	public static InputStream validateJson(@Parameter(description = "the String id of the Validation profile " +
-	                                                                "(auto, 1b, 1a, 2b, 2a, 2u, 3b, 3a, 3u, 4, 4e, 4f or ua1)")
+	                                                                "(auto, 1b, 1a, 2b, 2a, 2u, 3b, 3a, 3u, 4, 4e, 4f, ua1 or ua2)")
 	                                       @PathParam("profileId") String profileId,
 	                                       @Parameter(description = "a URL of PDF to be validated")
 	                                       @FormDataParam("url") String urlLink,
@@ -266,7 +266,7 @@ public static InputStream validateJson(@Parameter(description = "the String id o
 	 * @param profileId
 	 *                                 the String id of the Validation profile
 	 *                                 (auto, 1b, 1a, 2b, 2a, 2u,
-	 *                                 3b, 3a, 3u, 4, 4e, 4f or ua1)
+	 *                                 3b, 3a, 3u, 4, 4e, 4f, ua1 or ua2)
 	 * @param uploadedInputStream
 	 *                                 a {@link java.io.InputStream} to the PDF to
 	 *                                 be validated
@@ -291,7 +291,7 @@ public static InputStream validateHtml(@PathParam("profileId") String profileId,
 	 * @param profileId
 	 *                                 the String id of the Validation profile
 	 *                                 (auto, 1b, 1a, 2b, 2a, 2u,
-	 *                                 3b, 3a, 3u, 4, 4e, 4f or ua1)
+	 *                                 3b, 3a, 3u, 4, 4e, 4f, ua1 or ua2)
 	 * @param sha1Hex
 	 *                                 the hex String representation of the file's
 	 *                                 SHA-1 hash
@@ -322,7 +322,7 @@ public static InputStream validateHtml(@PathParam("profileId") String profileId,
 	@Consumes(MediaType.MULTIPART_FORM_DATA)
 	@Produces({MediaType.TEXT_HTML})
 	public static InputStream validateHtml(@Parameter(description = "the String id of the Validation profile " +
-	                                                                "(auto, 1b, 1a, 2b, 2a, 2u, 3b, 3a, 3u, 4, 4e, 4f or ua1)")
+	                                                                "(auto, 1b, 1a, 2b, 2a, 2u, 3b, 3a, 3u, 4, 4e, 4f, ua1 or ua2)")
 	                                       @PathParam("profileId") String profileId,
 	                                       @Parameter(description = "a URL of PDF to be validated")
 	                                       @FormDataParam("url") String urlLink,

diff --git a/src/main/resources/org/verapdf/rest/views/restclient.mustache b/src/main/resources/org/verapdf/rest/views/restclient.mustache
@@ -93,6 +93,7 @@
                 <option value="4e">PDF/A-4e Engineering</option>
                 <option value="4f">PDF/A-4f EmbeddedFiles</option>
                 <option value="ua1">PDF/UA-1</option>
+                <option value="ua2">PDF/UA-2</option>
               </select>
             </div>
             <div class="form-group">
@@ -151,6 +152,9 @@
             <li><a target="_blank" href="https://www.loc.gov/preservation/digital/formats/fdd/fdd000350.shtml">PDF/UA-1</a> |
                 <a href="/api/profiles/ua1" target="_blank">ua1</a>
             </li>
+            <li><a target="_blank">PDF/UA-2</a> |
+                <a href="/api/profiles/ua2" target="_blank">ua2</a>
+            </li>
           </ul>
       </div>
       <div id="footer">

diff --git a/tests/Options/config/app/fixerFolder.bats b/tests/Options/config/app/fixerFolder.bats
diff --git a/tests/Options/config/app/fixerFolder/app.xml b/tests/Options/config/app/fixerFolder/app.xml
diff --git a/tests/Options/config/app/format.bats b/tests/Options/config/app/format.bats
@@ -5,24 +5,31 @@ setup() {
     load "$PROJECT_ROOT/tools/test_helper/common-setup.bash"
     _common_setup
 
-    remove_verapdf_config_files
+    prepare_fresh_verapdf_config_files
 
     docker cp $BATS_TEST_DIRNAME/format/app.xml $DOCKER_CONTAINER:/opt/verapdf-rest/config/app.xml
 
 }
 
 teardown() {
     docker cp $DOCKER_CONTAINER:/opt/verapdf-rest/config/app.xml $BATS_TEST_TMPDIR
-    cat $BATS_TEST_TMPDIR/app.xml >&3 
+    cat $BATS_TEST_TMPDIR/app.xml >&3
 
     echo -e "Done ..." >&3
 }
 
-@test "--format, Chooses the default reporting format, format=JSON" {
-    skip "Looks like it isn't ready to go yet"
-
-    run curl -F "file=@$PROJECT_ROOT/Resources/Mustang_505.pdf" localhost:8080/api/validate/1b  
-    assert_output --partial "ICC profiles"
+@test "--format, Chooses output format, the default format=XML" {
+
+    run curl -F "file=@$PROJECT_ROOT/Resources/Mustang_505.pdf" localhost:8080/api/validate/1b 
+    assert_output --partial "<name>Mustang_505.pdf</name>"
+
+    [ "$status" -eq 0 ]
+}
+
+@test "--format, Chooses output format, format=JSON" {
+
+    run curl -F "file=@$PROJECT_ROOT/Resources/Mustang_505.pdf" localhost:8080/api/validate/1b -H 'accept: application/json'
+    assert_output --partial '"jobEndStatus" : "normal"'
 
     [ "$status" -eq 0 ]
 }
diff --git a/tests/Options/config/app/isVerbose.bats b/tests/Options/config/app/isVerbose.bats
diff --git a/tests/Options/config/app/isVerbose/app.xml b/tests/Options/config/app/isVerbose/app.xml
diff --git a/tests/Options/config/app/policyFile.bats b/tests/Options/config/app/policyFile.bats
diff --git a/tests/Options/config/app/policyFile/app.xml b/tests/Options/config/app/policyFile/app.xml
-Original file line number
+Diff line change
@@ Expand Up / @@ -33,3 +33,4 @@ verapdf/ @@
     *.log
     *.html
     *.css
+    *.code-workspace