Merge pull request #472 from fugerit-org/471-enhancement-fj-doc-val-expose-failed-validation-reason

DocTypeValidationResult has now validation message and exceptions #471

Author: fugerit79

CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- [fj-doc-val-*] DocTypeValidationResult has now validation message and exceptions
+
 ### Changed
 
 - quarkus-version set to 3.24.3 across all the modules <https://github.com/fugerit-org/fj-doc/issues/469>

fj-doc-val-core/src/main/java/org/fugerit/java/doc/val/core/DocTypeValidationResult.java

@@ -1,12 +1,16 @@
 package org.fugerit.java.doc.val.core;
+import org.fugerit.java.core.util.ObjectUtils;
 import org.fugerit.java.core.util.result.BasicResult;
 
+import java.util.ArrayList;
+import java.util.List;
+
 public class DocTypeValidationResult extends BasicResult {
 
 	public DocTypeValidationResult(int resultCode) {
 		super(resultCode);
 	}
-	
+
 	public static DocTypeValidationResult newOk() {
 		return new DocTypeValidationResult( RESULT_CODE_OK );
 	}
@@ -15,4 +19,28 @@ public static DocTypeValidationResult newFail() {
 		return new DocTypeValidationResult( RESULT_CODE_KO );
 	}
 
+	private static final String ATT_VALIDATION_MESSAGE = "validation-message";
+
+	private static final String ATT_VALIDATION_EXECPTIONS = "validation-exceptions";
+
+
+	public DocTypeValidationResult withValidationMessage(String validationMessage) {
+		this.getInfoMap().put(ATT_VALIDATION_MESSAGE, validationMessage);
+		return this;
+	}
+
+	public String getValidationMessage() {
+		return (String)this.getInfoMap().get(ATT_VALIDATION_MESSAGE);
+	}
+
+	public List<Exception> getValidationExceptions() {
+		return  ObjectUtils.objectWithDefault((List<Exception>)this.getInfoMap().get(ATT_VALIDATION_EXECPTIONS), new ArrayList<>());
+	}
+
+	public DocTypeValidationResult withMainException( Exception e ) {
+		this.withValidationMessage( e.getMessage() );
+		this.getValidationExceptions().add( e );
+		return this;
+	}
+
 }

fj-doc-val-core/src/main/java/org/fugerit/java/doc/val/core/basic/AbstractDocTypeValidator.java

@@ -30,10 +30,14 @@ public static Set<String> createSet( String... s ) {
 	}
 
 	protected DocTypeValidationResult validationHelper( UnsafeVoid<Exception> fun ) {
+		final DocTypeValidationResult resultFail = DocTypeValidationResult.newFail();
 		return ObjectUtils.objectWithDefault( SafeFunction.get( () -> {
 			fun.apply();
 			return DocTypeValidationResult.newOk();
-		}, e -> log.warn( "validation failed {}, {}", this.getMimeType(), e.toString() ) ), DocTypeValidationResult.newFail() );
+		}, e ->   {
+			log.warn( "validation failed {}, {}", this.getMimeType(), e.toString() );
+			resultFail.withMainException( e );
+		} ), resultFail );
 	}
 
 	protected AbstractDocTypeValidator(String mimeType, String extension) {
@@ -67,7 +71,7 @@ public boolean check(InputStream is) throws IOException {
 
 	@Override
 	public boolean checkCompatibility() {
-		return true;
+		return Boolean.TRUE;
 	}
 
 }

fj-doc-val-core/src/main/java/org/fugerit/java/doc/val/core/basic/ImageValidator.java

@@ -53,6 +53,8 @@ public static boolean javaVersionSupportHelper( int javaMajorVersionFound, int j
 
 	@Override
 	public DocTypeValidationResult validate(InputStream is) {
+		DocTypeValidationResult resultFail = DocTypeValidationResult.newFail()
+				.withValidationMessage(  String.format( "No image reader found for format :%s", this.format ) );
 		try ( ImageInputStream iis = ImageIO.createImageInputStream( is ) ) {
 			Iterator<ImageReader> readers = ImageIO.getImageReadersByFormatName( this.format );
 			if (readers.hasNext()) {
@@ -63,8 +65,9 @@ public DocTypeValidationResult validate(InputStream is) {
 			}
 		}  catch (Exception exp) {
 			log.debug( "checkImage (v2) {}", exp.getMessage() );
+			resultFail.withMainException( exp );
 		}
-		return DocTypeValidationResult.newFail();
+		return resultFail;
 	}
 
 	protected ImageValidator(String mimeType, Set<String> supportedExtensions, String format, int javaMajorVersionRequired) {

fj-doc-val-core/src/test/java/test/org/fugerit/java/doc/core/val/TestDocTypeValidationResult.java

@@ -0,0 +1,16 @@
+package test.org.fugerit.java.doc.core.val;
+
+import org.fugerit.java.doc.val.core.DocTypeValidationResult;
+import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.api.Test;
+
+class TestDocTypeValidationResult {
+
+    @Test
+    void getValidationMessage() {
+        String testMessage = "test message";
+        DocTypeValidationResult result =DocTypeValidationResult.newFail().withValidationMessage( testMessage );
+        Assertions.assertEquals( testMessage, result.getValidationMessage() );
+    }
+
+}

fj-doc-val-pdfbox/src/main/java/org/fugerit/java/doc/val/pdf/box/PdfboxStrictValidator.java

@@ -25,6 +25,7 @@ public DocTypeValidationResult validate(InputStream is) {
 			result = DocTypeValidationResult.newOk();
 		} catch (Exception e) {
 			log.warn( "Failed check on pdf : {}", e.toString() );
+			result.withMainException( e );
 		}
 		return result;
 	}

fj-doc-val-pdfbox/src/main/java/org/fugerit/java/doc/val/pdf/box/PdfboxValidator.java

@@ -29,6 +29,7 @@ public DocTypeValidationResult validate(InputStream is) {
 			result = DocTypeValidationResult.newOk();
 		} catch (Exception e) {
 			log.warn( "Failed check on pdf : {}", e.toString() );
+			result.withMainException( e );
 		}
 		return result;
 	}

fj-doc-val-pdfbox/src/test/java/test/org/fugerit/java/doc/pdfbox/val/TestDocValidatorFacade.java

@@ -4,6 +4,7 @@
 
 import org.fugerit.java.core.function.SafeFunction;
 import org.fugerit.java.core.lang.helpers.ClassHelper;
+import org.fugerit.java.doc.val.core.DocTypeValidationResult;
 import org.fugerit.java.doc.val.core.DocValidatorFacade;
 import org.junit.jupiter.api.Assertions;
 import org.slf4j.Logger;
@@ -20,7 +21,9 @@ protected boolean  worker( DocValidatorFacade facade, String fileName, boolean r
 			String path = BASE_PATH+"/"+fileName;
 			logger.info( "test path {}, expected result {}", path, result );
 			try ( InputStream is = ClassHelper.loadFromDefaultClassLoader( path ) ) {
-				boolean check = facade.check(fileName, is);
+				DocTypeValidationResult validationResult = facade.validate(fileName, is);
+				logger.info( "validation message : {}", validationResult.getValidationMessage() );
+				boolean check = validationResult.isResultOk();
 				Assertions.assertEquals( result, check );
 				return ( result == check );
 			}

fj-doc-val-poi/src/main/java/org/fugerit/java/doc/val/poi/DocValidator.java

@@ -30,6 +30,7 @@ public DocTypeValidationResult validate(InputStream is) {
 			result = DocTypeValidationResult.newOk();
 		} catch (Exception e) {
 			logger.warn( "Failed check on pdf : {}", e.toString() );
+			result.withMainException( e );
 		}
 		return result;
 	}

fj-doc-val-poi/src/main/java/org/fugerit/java/doc/val/poi/DocxValidator.java

@@ -30,6 +30,7 @@ public DocTypeValidationResult validate(InputStream is) {
 			result = DocTypeValidationResult.newOk();
 		} catch (Exception e) {
 			logger.warn("Failed check on pdf : {}", e.toString());
+			result.withMainException( e );
 		}
 		return result;
 	}