From 3cdbe583c45e3d33f542380797b1b84d96b588dd Mon Sep 17 00:00:00 2001
From: Miguel Reboiro Jato <mrjato@esei.uvigo.es>
Date: Thu, 21 Sep 2023 00:58:27 +0200
Subject: [PATCH] Adds test report and first release assembly

An HTML report is now generated for the tests and the project can be
packaged for the first release using the `mvn package` command.
---
 .gitignore                                   |  1 +
 README.md                                    | 15 +++++
 pom.xml                                      | 63 +++++++++++++++++++-
 src/main/assembly/assembly-first-release.xml | 25 ++++++++
 4 files changed, 101 insertions(+), 3 deletions(-)
 create mode 100644 src/main/assembly/assembly-first-release.xml

diff --git a/.gitignore b/.gitignore
index 6198db2..319c122 100644
--- a/.gitignore
+++ b/.gitignore
@@ -8,4 +8,5 @@ target
 
 #General
 bak
+*.tar.gz
 
diff --git a/README.md b/README.md
index c560029..71595a0 100644
--- a/README.md
+++ b/README.md
@@ -16,6 +16,21 @@ En el desarrollo de este proyecto debe utilizarse:
 
 * Java 11
 * MySQL 8+
+* Maven 3.6+
+* Git 2+ (en el caso de querer hacer commits, lo cual es recomendable)
+
+Es importante que antes de empezar a trabajar se edite el fichero `pom.xml` para:
+
+* Poner en la propiedad `group.name` el nombre del grupo en Moovi.
+* Descomentar y completar la sección `developers` con los datos de los miembros del grupo.
+
+### Comandos útiles
+Algunos comandos Maven que te serán útiles son:
+
+* `mvn test`: ejecuta los tests y genera un informe en `target/site/surefire-report.html`.
+* `mvn exec:java`: ejecuta la aplicación (es decir, ejecuta `Launcher`).
+* `mvn exec:java -Dexec.args="arg1 arg2 arg3"`: ejecuta la aplicación con los parámetos `arg1 arg2 arg3`. Por ejemplo, `mvn exec:java -Dexec.args="config.props"` ejecuta `Launcher` pasándole el parámetro `config.props`.
+* `mvn package`: empaqueta la aplicación. Generará un fichero `hybrid-server-<nombre del grupo>.r1.tar.gz` en la raíz del proyecto que es el que habrá que entregar en Moovi en la primera entrega.
 
 ## Arquitectura
 
diff --git a/pom.xml b/pom.xml
index da5ee9a..55fba46 100644
--- a/pom.xml
+++ b/pom.xml
@@ -30,7 +30,8 @@
 			<id>[Login el email de la ESEI (p.ej. student@esei.uvigo.es => student)]</id>
 			<email>[xxx@esei.uvigo.es]</email>
 			<name>[Nombre completo]</name>
-			<organization>Escola Superior de Enxeñaría Informática - Universidade de Vigo</organization>
+			<organization>Escola Superior de Enxeñaría Informática - Universidade de
+	Vigo</organization>
 			<roles>
 				<role>student</role>
 			</roles>
@@ -39,7 +40,8 @@
 			<id>[Login el email de la ESEI (p.ej. student@esei.uvigo.es => student)]</id>
 			<email>[xxx@esei.uvigo.es]</email>
 			<name>[Nombre completo]</name>
-			<organization>Escola Superior de Enxeñaría Informática - Universidade de Vigo</organization>
+			<organization>Escola Superior de Enxeñaría Informática - Universidade de
+	Vigo</organization>
 			<roles>
 				<role>student</role>
 			</roles>
@@ -47,6 +49,8 @@
 	</developers -->
 
 	<properties>
+		<group.name>[nombre_del_grupo]</group.name>
+
 		<maven.compiler.source>11</maven.compiler.source>
 		<maven.compiler.target>11</maven.compiler.target>
 		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
@@ -69,6 +73,7 @@
 		<!-- Plugin versions -->
 		<exec-maven-plugin.version>3.1.0</exec-maven-plugin.version>
 		<maven-compiler-plugin.version>3.11.0</maven-compiler-plugin.version>
+		<maven-jxr-plugin.version>3.3.0</maven-jxr-plugin.version>
 		<maven-surefire-plugin.version>3.1.2</maven-surefire-plugin.version>
 	</properties>
 
@@ -176,12 +181,64 @@
 				<artifactId>maven-surefire-plugin</artifactId>
 				<version>${maven-surefire-plugin.version}</version>
 				<configuration>
+					<testFailureIgnore>true</testFailureIgnore>
 					<includes>
 						<include>
-							es/uvigo/esei/dai/hybridserver/HybridServerFirstReleaseTestSuite.java</include>
+							es/uvigo/esei/dai/hybridserver/HybridServerFirstReleaseTestSuite.java
+						</include>
 					</includes>
 				</configuration>
 			</plugin>
+			<plugin>
+				<groupId>org.apache.maven.plugins</groupId>
+				<artifactId>maven-surefire-report-plugin</artifactId>
+				<version>${maven-surefire-plugin.version}</version>
+				<executions>
+					<execution>
+						<phase>test</phase>
+						<goals>
+							<goal>report-only</goal>
+						</goals>
+					</execution>
+				</executions>
+			</plugin>
+			<plugin>
+				<groupId>org.apache.maven.plugins</groupId>
+				<artifactId>maven-assembly-plugin</artifactId>
+				<executions>
+					<execution>
+						<phase>package</phase>
+						<goals>
+							<goal>single</goal>
+						</goals>
+						<configuration>
+							<appendAssemblyId>false</appendAssemblyId>
+							<finalName>hybrid-server-${group.name}.r1</finalName>
+							<outputDirectory>${project.basedir}</outputDirectory>
+							<descriptors>
+								<descriptor>
+									src/main/assembly/assembly-first-release.xml
+								</descriptor>
+							</descriptors>
+						</configuration>
+					</execution>
+				</executions>
+			</plugin>
 		</plugins>
 	</build>
+
+	<reporting>
+		<plugins>
+			<plugin>
+				<groupId>org.apache.maven.plugins</groupId>
+				<artifactId>maven-surefire-report-plugin</artifactId>
+				<version>${maven-surefire-plugin.version}</version>
+			</plugin>
+			<plugin>
+				<groupId>org.apache.maven.plugins</groupId>
+				<artifactId>maven-jxr-plugin</artifactId>
+				<version>${maven-jxr-plugin.version}</version>
+			</plugin>
+		</plugins>
+	</reporting>
 </project>
diff --git a/src/main/assembly/assembly-first-release.xml b/src/main/assembly/assembly-first-release.xml
new file mode 100644
index 0000000..85b7e4d
--- /dev/null
+++ b/src/main/assembly/assembly-first-release.xml
@@ -0,0 +1,25 @@
+<assembly xmlns="http://maven.apache.org/ASSEMBLY/2.2.0"
+	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+	xsi:schemaLocation="http://maven.apache.org/ASSEMBLY/2.2.0 http://maven.apache.org/xsd/assembly-2.2.0.xsd">
+	<id>first-release</id>
+	<formats>
+		<format>tar.gz</format>
+	</formats>
+	<includeBaseDirectory>false</includeBaseDirectory>
+	<fileSets>
+		<fileSet>
+			<directory>${project.build.sourceDirectory}</directory>
+			<outputDirectory>src</outputDirectory>
+		</fileSet>
+		<fileSet>
+			<directory>${project.build.directory}/site</directory>
+			<outputDirectory>site</outputDirectory>
+		</fileSet>
+	</fileSets>
+	<files>
+		<file>
+			<source>pom.xml</source>
+			<outputDirectory>/</outputDirectory>
+		</file>
+	</files>
+</assembly>
-- 
2.18.1