rife2/bld-spring-boot
rife2/bld-spring-boot
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Cleaned up API to match bld operations and options APIs

Browse source
This commit is contained in:
Erik C. Thauvin 2024-08-27 10:11:08 -07:00
parent 7b6e75d44c
commit f340aed106
Signed by: erik
GPG key ID: 776702A6A2DA330E
5 changed files with 284 additions and 41 deletions
Download patch file Download diff file Expand all files Collapse all files

2
README.md
View file

@ -49,7 +49,7 @@ Don't forget to include the _Spring Boot Loader_ dependency to your project:
```java
scope(standalone)
.include(dependency("org.springframeworkboot:spring-boot-loader:3.3.2"));
.include(dependency("org.springframeworkboot:spring-boot-loader:3.3.3"));
```
Please check the [BootJarOperation documentation](https://rife2.github.io/bld-spring-boot/rife/bld/extension/BootJarOperation.html#method-summary)

2
examples/lib/bld/bld-wrapper.properties
View file

@ -1,7 +1,7 @@
bld.downloadExtensionJavadoc=false
bld.downloadExtensionSources=true
bld.downloadLocation=
bld.extension-boot=com.uwyn.rife2:bld-spring-boot:0.9.7
bld.extension-boot=com.uwyn.rife2:bld-spring-boot:0.9.8-SNAPSHOT
bld.repositories=MAVEN_LOCAL,MAVEN_CENTRAL,RIFE2_SNAPSHOTS,RIFE2_RELEASES
bld.sourceDirectories=
bld.version=2.0.1

158
src/main/java/rife/bld/extension/AbstractBootOperation.java
View file

@ -29,7 +29,10 @@ import java.io.StringWriter;
import java.nio.file.Files;
import java.nio.file.Path;
import java.text.MessageFormat;
import java.util.*;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
import java.util.logging.Level;
import java.util.logging.Logger;
@ -89,6 +92,17 @@ public abstract class AbstractBootOperation<T extends AbstractBootOperation<T>>
return destinationDirectory(new File(directory));
}
/**
* Provides the destination directory in which the archive will be created.
*
* @param directory the destination directory
* @return this operation instance
* @throws IOException if an error occurs
*/
public T destinationDirectory(Path directory) throws IOException {
return destinationDirectory(directory.toFile());
}
/**
* Provides the file name that will be used for the archive creation.
*
@ -275,9 +289,17 @@ public abstract class AbstractBootOperation<T extends AbstractBootOperation<T>>
* @return this operation instance
*/
public T infLibs(File... jars) {
infLibs_.addAll(List.of(jars));
//noinspection unchecked
return (T) this;
return infLibs(List.of(jars));
}
/**
* Provides the libraries that will be stored in {@code BOOT-INF} or {@code WEB-INF}.
*
* @param jars one or more Java archive files
* @return this operation instance
*/
public T infLibs(Path... jars) {
return infLibsPaths(List.of(jars));
}
/**
@ -287,9 +309,7 @@ public abstract class AbstractBootOperation<T extends AbstractBootOperation<T>>
* @return this operation instance
*/
public T infLibs(String... jars) {
infLibs_.addAll(Arrays.stream(jars).map(File::new).toList());
//noinspection unchecked
return (T) this;
return infLibsStrings(List.of(jars));
}
/**
@ -301,6 +321,26 @@ public abstract class AbstractBootOperation<T extends AbstractBootOperation<T>>
return infLibs_;
}
/**
* Provides the libraries that will be stored in {@code BOOT-INF} or {@code WEB-INF}.
*
* @param jars one or more Java archive files
* @return this operation instance
*/
public T infLibsPaths(Collection<Path> jars) {
return infLibs(jars.stream().map(Path::toFile).toList());
}
/**
* Provides the libraries that will be stored in {@code BOOT-INF} or {@code WEB-INF}.
*
* @param jars one or more Java archive files
* @return this operation instance
*/
public T infLibsStrings(Collection<String> jars) {
return infLibs(jars.stream().map(File::new).toList());
}
/**
* Provides the Spring Boot loader launcher fully-qualified class name.
* <p>
@ -367,17 +407,8 @@ public abstract class AbstractBootOperation<T extends AbstractBootOperation<T>>
* @return this operation instance
* @throws IOException if a JAR could not be found
*/
@SuppressWarnings("UnusedReturnValue")
public T launcherLibs(File... jars) throws IOException {
for (var j : jars) {
if (j.exists()) {
launcherLibs_.add(j);
} else {
throw new IOException("Spring Boot loader launcher library not found: " + j);
}
}
//noinspection unchecked
return (T) this;
return launcherLibs(List.of(jars));
}
/**
@ -387,18 +418,41 @@ public abstract class AbstractBootOperation<T extends AbstractBootOperation<T>>
* @return this operation instance
* @throws IOException if a JAR could not be found
*/
@SuppressWarnings("UnusedReturnValue")
public T launcherLibs(String... jars) throws IOException {
for (var j : jars) {
var p = Path.of(j);
if (Files.exists(p)) {
launcherLibs_.add(p.toFile());
} else {
throw new IOException("Spring Boot loader launcher library not found: " + j);
}
}
//noinspection unchecked
return (T) this;
return launcherLibsStrings(List.of(jars));
}
/**
* Provides the libraries for the Spring Boot loader launcher.
*
* @param jars one or more Java archives
* @return this operation instance
* @throws IOException if a JAR could not be found
*/
public T launcherLibs(Path... jars) throws IOException {
return launcherLibsPaths(List.of(jars));
}
/**
* Provides the libraries for the Spring Boot loader launcher.
*
* @param jars one or more Java archives
* @return this operation instance
* @throws IOException if a JAR could not be found
*/
public T launcherLibsPaths(Collection<Path> jars) throws IOException {
return launcherLibs(jars.stream().map(Path::toFile).toList());
}
/**
* Provides the libraries for the Spring Boot loader launcher.
*
* @param jars one or more Java archives
* @return this operation instance
* @throws IOException if a JAR could not be found
*/
public T launcherLibsStrings(Collection<String> jars) throws IOException {
return launcherLibs(jars.stream().map(File::new).toList());
}
/**
@ -463,12 +517,22 @@ public abstract class AbstractBootOperation<T extends AbstractBootOperation<T>>
* @param directories one or more source directories
* @return this operation instance
*/
public T sourceDirectories(File... directories) {
sourceDirectories_.addAll(List.of(directories));
public T sourceDirectories(Collection<File> directories) {
sourceDirectories_.addAll(directories);
//noinspection unchecked
return (T) this;
}
/**
* Provides source directories that will be used for the archive creation.
*
* @param directories one or more source directories
* @return this operation instance
*/
public T sourceDirectories(File... directories) {
return sourceDirectories(List.of(directories));
}
/**
* Provides source directories that will be used for the archive creation.
*
@ -476,9 +540,17 @@ public abstract class AbstractBootOperation<T extends AbstractBootOperation<T>>
* @return this operation instance
*/
public T sourceDirectories(String... directories) {
sourceDirectories_.addAll(Arrays.stream(directories).map(File::new).toList());
//noinspection unchecked
return (T) this;
return sourceDirectoriesStrings(List.of(directories));
}
/**
* Provides source directories that will be used for the archive creation.
*
* @param directories one or more source directories
* @return this operation instance
*/
public T sourceDirectories(Path... directories) {
return sourceDirectoriesPaths(List.of(directories));
}
/**
@ -490,6 +562,26 @@ public abstract class AbstractBootOperation<T extends AbstractBootOperation<T>>
return sourceDirectories_;
}
/**
* Provides source directories that will be used for the archive creation.
*
* @param directories one or more source directories
* @return this operation instance
*/
public T sourceDirectoriesPaths(Collection<Path> directories) {
return sourceDirectories(directories.stream().map(Path::toFile).toList());
}
/**
* Provides source directories that will be used for the archive creation.
*
* @param directories one or more source directories
* @return this operation instance
*/
public T sourceDirectoriesStrings(Collection<String> directories) {
return sourceDirectories(directories.stream().map(File::new).toList());
}
/**
* Verifies that all the elements ({@link #mainClass() mainClass}, {@link #launcherClass() launcherClass} and
* {@link #launcherLibs() launcherLibs}) required to create the archive have been provided, throws an

53
src/main/java/rife/bld/extension/BootWarOperation.java
View file

@ -22,6 +22,7 @@ import rife.tools.FileUtils;
import java.io.File;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
@ -151,6 +152,16 @@ public class BootWarOperation extends AbstractBootOperation<BootWarOperation> {
return this;
}
/**
* Provides the libraries that will be used for the WAR creation in {@code /WEB-INF/lib-provided}.
*
* @param jars one or more Java archive files
* @return this operation instance
*/
public BootWarOperation providedLibs(String... jars) {
return providedLibsStrings(List.of(jars));
}
/**
* Provides the libraries that will be used for the WAR creation in {@code /WEB-INF/lib-provided}.
*
@ -158,7 +169,47 @@ public class BootWarOperation extends AbstractBootOperation<BootWarOperation> {
* @return this operation instance
*/
public BootWarOperation providedLibs(File... jars) {
providedLibs_.addAll(List.of(jars));
return providedLibs(List.of(jars));
}
/**
* Provides the libraries that will be used for the WAR creation in {@code /WEB-INF/lib-provided}.
*
* @param jars one or more Java archive files
* @return this operation instance
*/
public BootWarOperation providedLibs(Path... jars) {
return providedLibsPaths(List.of(jars));
}
/**
* Retrieves the libraries that will be used for the WAR creation in {@code /WEB-INF/lib-provided}.
*
* @return the list of Java archive files.
*/
public List<File> providedLibs() {
return providedLibs_;
}
/**
* Provides the libraries that will be used for the WAR creation in {@code /WEB-INF/lib-provided}.
*
* @param jars one or more Java archive files
* @return this operation instance
*/
public BootWarOperation providedLibsPaths(Collection<Path> jars) {
providedLibs_.addAll(jars.stream().map(Path::toFile).toList());
return this;
}
/**
* Provides the libraries that will be used for the WAR creation in {@code /WEB-INF/lib-provided}.
*
* @param jars one or more Java archive files
* @return this operation instance
*/
public BootWarOperation providedLibsStrings(Collection<String> jars) {
providedLibs_.addAll(jars.stream().map(File::new).toList());
return this;
}
}

110
src/test/java/rife/bld/extension/BootJarOperationTest.java
View file

@ -24,6 +24,7 @@ import rife.tools.FileUtils;
import java.io.File;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.Enumeration;
import java.util.List;
import java.util.jar.JarEntry;
@ -159,6 +160,7 @@ class BootJarOperationTest {
private static final String SPRING_BOOT = "spring-boot-" + BOOT_VERSION + ".jar";
private static final String SPRING_BOOT_ACTUATOR = "spring-boot-actuator-" + BOOT_VERSION + ".jar";
private static final String SPRING_BOOT_LOADER = "spring-boot-loader-" + BOOT_VERSION + ".jar";
private static final String SRC_MAIN_JAVA = "src/main/java";
private StringBuilder readJarEntries(File jar) throws IOException {
var jarEntries = new StringBuilder();
@ -200,6 +202,37 @@ class BootJarOperationTest {
assertThat(bootWar.verifyExecute()).isTrue();
}
@Test
void testInfLibs() {
var op = new BootWarOperation();
var foo = new File(EXAMPLES_LIB_COMPILE + SPRING_BOOT);
op = op.infLibs(EXAMPLES_LIB_COMPILE + SPRING_BOOT);
assertThat(op.infLibs()).containsExactly(foo);
op.infLibs().clear();
op = op.infLibs(foo);
assertThat(op.infLibs()).containsExactly(foo);
op.infLibs().clear();
op = op.infLibs(foo.toPath());
assertThat(op.infLibs()).containsExactly(foo);
op.infLibs().clear();
var bar = new File(EXAMPLES_LIB_COMPILE + SPRING_BOOT_ACTUATOR);
op.infLibs(EXAMPLES_LIB_COMPILE + SPRING_BOOT, EXAMPLES_LIB_COMPILE + SPRING_BOOT_ACTUATOR);
assertThat(op.infLibs()).containsExactly(foo, bar);
op.infLibs().clear();
op.infLibs(foo, bar);
assertThat(op.infLibs()).containsExactly(foo, bar);
op.infLibs().clear();
op.infLibs(foo.toPath(), bar.toPath());
assertThat(op.infLibs()).containsExactly(foo, bar);
op.infLibs().clear();
}
@Test
@SuppressWarnings("PMD.AvoidDuplicateLiterals")
void testJarExecute() throws Exception {
@ -274,16 +307,34 @@ class BootJarOperationTest {
FileUtils.deleteDirectory(tmp_dir);
}
@Test
void testLauncherLibs() throws IOException {
var op = new BootJarOperation();
var launcher = new File(EXAMPLES_LIB_STANDALONE + SPRING_BOOT_LOADER);
op = op.launcherLibs(EXAMPLES_LIB_STANDALONE + SPRING_BOOT_LOADER);
assertThat(op.launcherLibs()).containsExactly(launcher);
op.launcherLibs().clear();
op = op.launcherLibs(launcher);
assertThat(op.launcherLibs()).containsExactly(launcher);
op.launcherLibs().clear();
op = op.launcherLibs(launcher.toPath());
assertThat(op.launcherLibs()).containsExactly(launcher);
op.launcherLibs().clear();
}
@Test
void testProject() throws IOException {
var tmp_dir = Files.createTempDirectory("bootprjtmp").toFile();
var project = new CustomProject(tmp_dir);
var bootJar = new BootJarOperation().fromProject(project).sourceDirectories("src/main/java");
var bootJar = new BootJarOperation().fromProject(project).sourceDirectories(SRC_MAIN_JAVA);
assertThat(bootJar.mainClass()).as("mainClass").isEqualTo(MAIN_CLASS);
assertThat(bootJar.sourceDirectories()).as("sourceDirectories.size").hasSize(3)
.containsExactly(project.buildMainDirectory(), project.srcMainResourcesDirectory(),
new File("src/main/java"));
new File(SRC_MAIN_JAVA));
assertThat(bootJar.manifestAttributes()).as("manifestAttributes.size").hasSize(3);
assertThat(bootJar.manifestAttributes().get("Manifest-Version")).as("Manifest-Version").isEqualTo("1.0");
assertThat(bootJar.manifestAttributes().get("Main-Class")).as("Main-Class").endsWith("JarLauncher");
@ -299,6 +350,37 @@ class BootJarOperationTest {
FileUtils.deleteDirectory(tmp_dir);
}
@Test
void testSourceDirectories() {
var op = new BootJarOperation();
var src = new File(SRC_MAIN_JAVA);
op = op.sourceDirectories(SRC_MAIN_JAVA);
assertThat(op.sourceDirectories()).containsExactly(src);
op.sourceDirectories().clear();
op = op.sourceDirectories(src);
assertThat(op.sourceDirectories()).containsExactly(src);
op.sourceDirectories().clear();
op = op.sourceDirectories(src.toPath());
assertThat(op.sourceDirectories()).containsExactly(src);
op.sourceDirectories().clear();
var test = new File("src/test/java");
op.sourceDirectories(SRC_MAIN_JAVA, "src/test/java");
assertThat(op.sourceDirectories()).containsExactly(src, test);
op.sourceDirectories().clear();
op.sourceDirectories(src, test);
assertThat(op.sourceDirectories()).containsExactly(src, test);
op.sourceDirectories().clear();
op.sourceDirectories(src.toPath(), test.toPath());
assertThat(op.sourceDirectories()).containsExactly(src, test);
op.sourceDirectories().clear();
}
@Test
void testWarProjectExecute() throws Exception {
var tmp_dir = Files.createTempDirectory("bootjartmp").toFile();
@ -306,9 +388,9 @@ class BootJarOperationTest {
new BootWarOperation()
.fromProject(project)
.launcherLibs(List.of(new File(EXAMPLES_LIB_STANDALONE + SPRING_BOOT_LOADER)))
.destinationDirectory(tmp_dir)
.infLibs(new File(EXAMPLES_LIB_COMPILE + SPRING_BOOT),
new File(EXAMPLES_LIB_COMPILE + SPRING_BOOT_ACTUATOR))
.destinationDirectory(tmp_dir.toPath())
.infLibs(Path.of(EXAMPLES_LIB_COMPILE + SPRING_BOOT),
Path.of(EXAMPLES_LIB_COMPILE + SPRING_BOOT_ACTUATOR))
.providedLibs(new File(EXAMPLES_LIB_RUNTIME + PROVIDED_LIB))
.execute();
@ -339,6 +421,24 @@ class BootJarOperationTest {
FileUtils.deleteDirectory(tmp_dir);
}
@Test
void testWarProvidedLibs() {
var op = new BootWarOperation();
var foo = new File(EXAMPLES_LIB_RUNTIME + PROVIDED_LIB);
op = op.providedLibs(EXAMPLES_LIB_RUNTIME + PROVIDED_LIB);
assertThat(op.providedLibs()).containsExactly(foo);
op.providedLibs().clear();
op = op.providedLibs(foo);
assertThat(op.providedLibs()).containsExactly(foo);
op.providedLibs().clear();
op = op.providedLibs(foo.toPath());
assertThat(op.providedLibs()).containsExactly(foo);
op.providedLibs().clear();
}
static class CustomProject extends Project {
CustomProject(File tmp) {
super();