bld-generated-version/src/test/java/rife/bld/extension/GeneratedVersionTest.java

234 lines
8.2 KiB
Java

/*
* Copyright 2023-2024 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package rife.bld.extension;
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.Test;
import rife.bld.BaseProject;
import rife.bld.Project;
import rife.bld.blueprints.BaseProjectBlueprint;
import rife.bld.dependencies.VersionNumber;
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.Objects;
import java.util.logging.ConsoleHandler;
import java.util.logging.Level;
import java.util.logging.Logger;
import static org.assertj.core.api.Assertions.assertThat;
/**
* Implements the GeneratedVersionTest class.
*
* @author <a href="https://erik.thauvin.net/">Erik C. Thauvin</a>
* @since 1.0
*/
class GeneratedVersionTest {
private final BaseProject PROJECT = new Project() {
@Override
public String pkg() {
return "com.example";
}
@Override
public String name() {
return "MyExample";
}
@Override
public VersionNumber version() {
return new VersionNumber(2, 1, 3);
}
};
@BeforeAll
static void beforeAll() {
var level = Level.ALL;
var logger = Logger.getLogger("rife.bld.extension");
var consoleHandler = new ConsoleHandler();
consoleHandler.setLevel(level);
logger.addHandler(consoleHandler);
logger.setLevel(level);
logger.setUseParentHandlers(false);
}
static void deleteOnExit(File folder) {
folder.deleteOnExit();
for (var f : Objects.requireNonNull(folder.listFiles())) {
if (f.isDirectory()) {
deleteOnExit(f);
} else {
f.deleteOnExit();
}
}
}
@Test
void testBuildCustomTemplate() {
var gv = new GeneratedVersion();
gv.setProject(PROJECT);
gv.setTemplate(new File(gv.getProject().srcTestResourcesDirectory().getAbsolutePath(), "version_test.txt"));
gv.setPackageName("com.example.my");
gv.setProjectName("My App");
gv.setClassName("MyVersion");
var t = gv.buildTemplate();
assertThat(t.getContent()).isEqualTo("""
package com.example.my;
public final class MyVersion {
public static final int PROJECT = "My App";
public static final int MAJOR = 2;
public static final int MINOR = 1;
public static final int REVISION = 3;
public static final String QUALIFIER = "";
private MyVersion() {
// no-op
}
}
""");
}
@Test
void testBuildTemplate() {
var gv = new GeneratedVersion();
gv.setProject(PROJECT);
var t = gv.buildTemplate();
assertThat(t).isNotNull();
assertThat(gv.getProject()).isEqualTo(PROJECT);
assertThat(gv.getPackageName()).isEqualTo(PROJECT.pkg());
assertThat(gv.getProjectName()).isEqualTo(PROJECT.name());
assertThat(t.getContent()).contains("package com.example;").contains("class GeneratedVersion")
.contains("PROJECT = \"MyExample\";").contains("MAJOR = 2").contains("MINOR = 1")
.contains("REVISION = 3").contains("QUALIFIER = \"\"").contains("VERSION = \"2.1.3\"")
.contains("private GeneratedVersion");
}
@Test
void testDirectories() {
var foo = new File("foo");
var bar = new File("bar");
var op = new GeneratedVersionOperation().directory(foo);
assertThat(op.generatedVersion().getDirectory()).as("as file").isEqualTo(foo);
op = op.directory(bar.toPath());
assertThat(op.generatedVersion().getDirectory()).as("as path").isEqualTo(bar);
op = op.directory("foo");
assertThat(op.generatedVersion().getDirectory()).as("as string").isEqualTo(foo);
}
@Test
void testExample() throws Exception {
var tmpDir = Files.createTempDirectory("bld-generated-version-example-").toFile();
tmpDir.deleteOnExit();
new GeneratedVersionOperation()
.fromProject(new BaseProjectBlueprint(new File("examples"), "com.example", "Example"))
.directory(tmpDir.getAbsolutePath())
//.classTemplate(new File("examples", "my_app_version.txt"))
.classTemplate(new File("examples", "version.txt"))
.execute();
deleteOnExit(tmpDir);
var template = Path.of(tmpDir.getAbsolutePath(), "com", "example", "GeneratedVersion.java");
assertThat(template).exists();
var content = Files.readString(template);
assertThat(content).contains("class GeneratedVersion").contains("PROJECT = \"Example\";")
.contains("MAJOR = 0").contains("MINOR = 0").contains("REVISION = 1").contains("QUALIFIER = \"\"")
.doesNotContain("ERASED!"); // only in default template
}
@Test
void testExecute() throws Exception {
var tmpDir = Files.createTempDirectory("bld-generated-version-execute-").toFile();
tmpDir.deleteOnExit();
new GeneratedVersionOperation()
.fromProject(PROJECT)
.directory(tmpDir.getAbsolutePath())
.extension(".java")
.classTemplate("src/test/resources/foo/version_test.txt")
.packageName("")
.className("MyVersion")
.execute();
deleteOnExit(tmpDir);
var template = new File(tmpDir, "MyVersion.java");
assertThat(template).exists();
var content = Files.readString(template.toPath());
assertThat(content).contains("class MyVersion")
.contains("PROJECT = \"MyExample\";").contains("MAJOR = 2").contains("MINOR = 1")
.contains("REVISION = 3").contains("QUALIFIER = \"\"").contains("private MyVersion")
.doesNotContain("package");
}
@Test
void testGeneratedVersion() {
var gv = new GeneratedVersion();
gv.setProject(PROJECT);
gv.setTemplate(new File(gv.getProject().srcTestResourcesDirectory().getAbsolutePath(), "version_test.txt"));
gv.setPackageName("com.example.cool");
gv.setProjectName("Cool App");
gv.setClassName("CoolVersion");
gv.setDirectory(new File("build"));
gv.setExtension(".java");
assertThat(gv.getProject()).as("project").isEqualTo(PROJECT);
assertThat(gv.getTemplate()).as("template").exists();
assertThat(gv.getPackageName()).as("package name").isEqualTo("com.example.cool");
assertThat(gv.getProjectName()).as("project name").isEqualTo("Cool App");
assertThat(gv.getClassName()).as("class name").isEqualTo("CoolVersion");
assertThat(gv.getExtension()).as("extension").isEqualTo(".java");
assertThat(gv.getDirectory()).as("directory").isDirectory();
}
@Test
void testWriteTemplate() throws IOException {
var tmpDir = Files.createTempDirectory("bld-generated-version-write-").toFile();
tmpDir.deleteOnExit();
var gv = new GeneratedVersion();
gv.setProject(PROJECT);
gv.setDirectory(tmpDir);
var t = gv.buildTemplate();
gv.writeTemplate(t);
deleteOnExit(tmpDir);
assertThat(gv.getClassFile()).exists();
var versionClass = FileUtils.readString(gv.getClassFile());
assertThat(versionClass).contains("package com.example;").contains("class GeneratedVersion")
.contains("MAJOR = 2").contains("MINOR = 1").contains("REVISION = 3")
.contains("private GeneratedVersion");
}
}