Test coverage review

Author: fugerit79

CHANGELOG.md

@@ -0,0 +1,23 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.4.0] - 2023-09-23
+
+### Added
+
+- [workflow deploy on branch deploy](.github/workflows/deploy_maven_package.yml)
+- [workflow maven build](.github/workflows/build_maven_package.yml)
+- keep a changelog and coverage badge
+
+### Changed
+
+- [workflow sonar cloud](.github/workflows/sonarcloud-maven.yml)
+- fj-bom version set to 1.4.0
+- fj-core version set to 8.3.7
+

README.md

@@ -2,6 +2,12 @@
 
 Tool export query in CSV and XLS / XLSX format
 
+[![Keep a Changelog v1.1.0 badge](https://img.shields.io/badge/changelog-Keep%20a%20Changelog%20v1.1.0-%23E05735)](CHANGELOG.md) 
+[![Maven Central](https://img.shields.io/maven-central/v/org.fugerit.java/query-export-tool.svg)](https://mvnrepository.com/artifact/org.fugerit.java/query-export-tool)
+[![license](https://img.shields.io/badge/License-Apache%20License%202.0-teal.svg)](https://opensource.org/licenses/Apache-2.0)
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=fugerit-org_query-export-tool&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=fugerit-org_query-export-tool)
+[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=fugerit-org_query-export-tool&metric=coverage)](https://sonarcloud.io/summary/new_code?id=fugerit-org_query-export-tool)
+
 ![Java runtime version](https://img.shields.io/badge/run%20on-java%208+-%23113366.svg?style=for-the-badge&logo=openjdk&logoColor=white)
 ![Java build version](https://img.shields.io/badge/build%20on-java%2011+-%23ED8B00.svg?style=for-the-badge&logo=openjdk&logoColor=white)
 ![Apache Maven](https://img.shields.io/badge/Apache%20Maven-3.9.0+-C71A36?style=for-the-badge&logo=Apache%20Maven&logoColor=white)

pom.xml

@@ -12,11 +12,11 @@
 
 	<artifactId>query-export-tool</artifactId>
 
-	<version>0.3.2</version>
+	<version>0.4.0</version>
 	<packaging>jar</packaging>
 
 	<name>query-export-tool</name>
-	<description>Tool export query in CSV (and in the future other) formats</description>
+	<description>Tool export query in CSV and other formats</description>
 	<url>http://www.fugerit.org/java/</url>
 
 	<scm>
@@ -27,8 +27,10 @@
 
 	<properties>
 		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
-		<maven.compiler.target>1.8</maven.compiler.target>
-		<maven.compiler.source>1.8</maven.compiler.source>
+	    <java-version-compliance>8</java-version-compliance>
+	    <maven.compiler.source>${java-version-compliance}</maven.compiler.source>
+	    <maven.compiler.target>${java-version-compliance}</maven.compiler.target>	
+	    <maven.compiler.release>${java-version-compliance}</maven.compiler.release>
 		<!-- libraries versions -->
 		<fj-version>8.3.7</fj-version>
 		<opencsv-version>5.8</opencsv-version>
@@ -82,6 +84,14 @@
 			<groupId>org.apache.poi</groupId>
 			<artifactId>poi</artifactId>
 			<version>${poi-version}</version>
+			<scope>provided</scope>
+		</dependency>
+
+		<dependency>
+		    <groupId>org.slf4j</groupId>
+		    <artifactId>slf4j-simple</artifactId>
+		    <version>2.0.9</version>
+		    <scope>test</scope>
 		</dependency>
 
 		<!-- https://mvnrepository.com/artifact/org.apache.poi/poi-ooxml -->
@@ -108,6 +118,24 @@
 
 		<profile>
 			<id>singlepackage</id>
+			<dependencies>
+				<dependency>
+					<groupId>org.apache.poi</groupId>
+					<artifactId>poi</artifactId>
+				</dependency>
+				<dependency>
+					<groupId>org.apache.logging.log4j</groupId>
+				    <artifactId>log4j-api</artifactId>
+				</dependency>
+				<dependency>
+				    <groupId>org.apache.logging.log4j</groupId>
+				    <artifactId>log4j-core</artifactId>
+				</dependency>
+				<dependency>
+					<groupId>org.apache.logging.log4j</groupId>
+				    <artifactId>log4j-slf4j2-impl</artifactId>
+				</dependency>
+			</dependencies>
 			<build>
 				<plugins>
 					<plugin>

src/main/java/org/fugerit/java/query/export/facade/QueryExportConfig.java

@@ -13,11 +13,19 @@ public class QueryExportConfig {
 	public static QueryExportConfig newConfigHTML( OutputStream output, Connection conn, String query ) {
 		return new QueryExportConfig( QueryExportFacade.FORMAT_HTML , QueryExportFacade.CSV_SEPARATOR_DEF, output, conn, query, DEFAULT_EXPORT_HEADER );
 	}
-	
+
 	public static QueryExportConfig newConfigCSV( OutputStream output, Connection conn, String query ) {
 		return new QueryExportConfig( QueryExportFacade.FORMAT_CSV , QueryExportFacade.CSV_SEPARATOR_DEF, output, conn, query, DEFAULT_EXPORT_HEADER );
 	}
 
+	public static QueryExportConfig newConfigXLS( OutputStream output, Connection conn, String query ) {
+		return new QueryExportConfig( QueryExportFacade.FORMAT_XLS , QueryExportFacade.CSV_SEPARATOR_DEF, output, conn, query, DEFAULT_EXPORT_HEADER );
+	}
+	
+	public static QueryExportConfig newConfigXLSX( OutputStream output, Connection conn, String query ) {
+		return new QueryExportConfig( QueryExportFacade.FORMAT_XLSX , QueryExportFacade.CSV_SEPARATOR_DEF, output, conn, query, DEFAULT_EXPORT_HEADER );
+	}
+	
 	public static QueryExportConfig newConfigCSV( OutputStream output, char separator ) {
 		return new QueryExportConfig( QueryExportFacade.FORMAT_CSV , separator, output, null, null, DEFAULT_EXPORT_HEADER );
 	}
@@ -38,6 +46,7 @@ public QueryExportConfig(String format, char separator, OutputStream output, Con
 		this.conn = conn;
 		this.query = query;
 		this.exportHeader = exportHeader;
+		this.params = new Properties();
 	}
 
 	private String format;

src/main/java/org/fugerit/java/query/export/facade/QueryExportFacade.java

@@ -25,14 +25,16 @@ private QueryExportFacade() {}
 	public static final char CSV_SEPARATOR_DEF = ',';
 
 	public static final String FORMAT_HTML = "html";
+
+	public static final String ARG_XLS_TEMPLATE = "xls-template";
 
 	protected static final Logger logger = LoggerFactory.getLogger(QueryExportFacade.class);
 
 	private static void registerHandler( String type, ListMapStringKey<QueryExportHandler> handlers ) {
 		try {
 			QueryExportHandler handler = (QueryExportHandler)ClassHelper.newInstance( type );
 			handlers.add( handler );
-		} catch (Exception e) {
+		} catch (Exception | NoClassDefFoundError e) {
 			String message = "Failed to register handler : "+type+" "+e;
 			logger.warn("{} [set log level to debug for full stack trace]", message );
 			logger.debug( message, e );
@@ -50,9 +52,9 @@ private static void registerHandler( String type, ListMapStringKey<QueryExportHa
 	public static int export( QueryExportConfig config ) {
 		return SafeFunction.get( () -> {
 			int res = 0;
-			try (Statement stm = config.getConn().createStatement()) {
+			try (Statement stm = config.getConn().createStatement();
+					ResultSet rs = stm.executeQuery( config.getQuery() ) ) {
 				logger.info( "sql : {}", config.getQuery() );
-				ResultSet rs = stm.executeQuery( config.getQuery() );
 				MetaResult meta = new BasicMetaResult( BasicMetaRSE.newInstanceAllToString( rs.getMetaData(), config.getObjectFormat() ) , rs );
 				export( config, meta );
 				int count = meta.close();

src/main/java/org/fugerit/java/query/export/facade/QueryExportFacadeXLS.java

@@ -8,21 +8,23 @@
 
 import org.fugerit.java.core.db.dao.RSExtractor;
 
-public abstract class BasicMetaRSE implements RSExtractor<MetaRecord> {
+public abstract class BasicMetaRSE implements RSExtractor<MetaRecord>, AutoCloseable {
 
+	private static final BasicObjectFormat DEF = new BasicObjectFormat();
+	
 	private ResultSetMetaData rsmd;
 
 	private BasicObjectFormat format;
 
 	public void init( ResultSetMetaData rsmd ) {
-		this.init( rsmd , BasicObjectFormat.DEF );
+		this.init( rsmd , null );
 	}
 
 	public void init( ResultSetMetaData rsmd, BasicObjectFormat format ) {
 		this.rsmd = rsmd;
 		this.format = format;
 		if ( format == null ) {
-			this.format = BasicObjectFormat.DEF;	
+			this.format = DEF;	
 		}
 	}
 
@@ -45,7 +47,12 @@ public static BasicMetaRSE newInstanceAllToString( ResultSetMetaData rsmd, Basic
 	}
 
 	public static BasicMetaRSE newInstanceAllToString( ResultSetMetaData rsmd ) {
-		return newInstanceAllToString( rsmd, BasicObjectFormat.DEF );
+		return newInstanceAllToString( rsmd, new BasicObjectFormat() );
+	}
+
+	@Override
+	public void close() throws Exception {
+		this.destroy();
 	}
 
 }

src/main/java/org/fugerit/java/query/export/meta/BasicMetaRSE.java

@@ -5,9 +5,12 @@
 import java.util.ArrayList;
 import java.util.Iterator;
 import java.util.List;
+import java.util.NoSuchElementException;
 
 import org.fugerit.java.core.cfg.CloseHelper;
+import org.fugerit.java.core.cfg.ConfigRuntimeException;
 import org.fugerit.java.core.function.SafeFunction;
+import org.fugerit.java.core.function.SimpleValue;
 
 public class BasicMetaResult implements MetaResult {
 
@@ -23,13 +26,14 @@ public BasicMetaResult( BasicMetaRSE rse, ResultSet rs) {
 		super();
 		this.rse = rse;
 		this.rs = rs;
+		this.count = new SimpleValue<>( 0 );
 	}
 
 	private BasicMetaRSE rse;
 
 	private ResultSet rs;
 
-	private int count;
+	private SimpleValue<Integer> count;
 
 	@Override
 	public boolean hasHeader() {
@@ -56,12 +60,18 @@ public int getColumnCount() {
 	@Override
 	public Iterator<MetaRecord> recordIterator() {
 		return new Iterator<MetaRecord>() {
+			private boolean hasNext = false;
 			@Override
 			public boolean hasNext() {
-				return SafeFunction.get( () -> rs.next() );
+				this.hasNext = SafeFunction.get( () -> rs.next() );
+				return this.hasNext;
 			}
 			@Override
 			public MetaRecord next() {
+				count.setValue( count.getValue()+1 );
+				if ( !this.hasNext ) {
+					throw new NoSuchElementException( "No more elements : "+count.getValue() );
+				}
 				return SafeFunction.get( () -> rse.extractNext( rs ) );
 			}
 			@Override
@@ -73,11 +83,11 @@ public void remove() {
 
 	@Override
 	public int close() {
-		CloseHelper.closeRuntimeEx( this.rs );
+		Exception ex = CloseHelper.closeAll( this.rs, this.rse );
 		this.rs = null;
-		this.rse.destroy();
 		this.rse = null;
-		return this.count;
+		SafeFunction.applyIfNotNull( ex , () -> { throw new ConfigRuntimeException( ex ); } );
+		return this.count.getValue();
 	}
 
 }

src/main/java/org/fugerit/java/query/export/meta/BasicMetaResult.java

@@ -2,10 +2,6 @@
 
 public class BasicObjectFormat {
 
-	private BasicObjectFormat() {}
-	
-	public static final BasicObjectFormat DEF = new BasicObjectFormat();
-	
 	public String format( Object current ) {
 		String value = null;
 		if ( current != null ) {