Package ch.rswk.bootstrap.core

Class Build

java.lang.Object

ch.rswk.bootstrap.core.Build

public class Build
extends Object

Build creates a bootstrap module ZIP from the given build configuration using Maven.

See Also:

• buildModule(BuildConfig, Path, String, Path, Path)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Build.AbstractBuildValidator<T>
static final record	Build.BuildConfig
static final record	Build.BuildCopyConfig
static final record	Build.BuildDeployConfig
static final record	Build.BuildMergeConfig
static final record	Build.BuildValidateConfig
static final record	Build.MatchingCustomerModule

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	ARCHIVE_PATH_FORMAT
static final String	BIN_DIR
private static final String	BOOTSTRAP_CONFIG_ERROR_FORMAT
private static final String	BOOTSTRAP_CONFIG_MERGE_ERROR_FORMAT
private static final String	BUILD_BIN_DIR
static final String	BUILD_BIN_DIR_VAR
static final String	BUILD_CUSTOMIZE_DIR_VAR
static final String	BUILD_MODULE_DIR_VAR
private static final String	COPY_BIN_TARGET_ERROR
private static final String	CUSTOMIZE_DIR_ERROR_FORMAT
static final String	CUSTOMIZE_OPTION
private static final String	DEFINITION_FILE_TYPE
static final String	DOWNLOAD_DIR
private static final String	EXECUTE_SCRIPT_NIX
private static final String	EXECUTE_SCRIPT_WIN
private static final org.slf4j.Logger	LOG
static final String	MAVEN_REPO_OPTION
private static final String	MAVEN_SETTINGS_FILE
private static final String	MERGE_ERROR_FORMAT
private static final Set<String>	MERGE_EXCLUDE
static final String	MERGE_OPTION
private static final String	MODULE_DIR_ERROR_FORMAT
static final String	MODULE_OPTION
private static final String	MVN_SUCCESS
private static final org.apache.commons.cli.Options	OPTIONS
static final String	RESOURCE_DIR
private static final String	RUN_MVN_ERROR_MESSAGE
private static final String	VALIDATE_ERROR_FORMAT
private static final String	VERSION_ERROR_FORMAT

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Build()

Method Summary

Modifier and Type	Method	Description
private static void	addWgetDownloadsToArchive(Path boostrapArchive, Execute.ExecuteConfig config)
protected static void	buildModule(Build.BuildConfig config, String... args)
static void	buildModule(Build.BuildConfig config, @Nullable Path customizeDir, @Nullable String mavenRepo, @Nullable Path mergeConfig, Path moduleDir)	buildModule prepares and builds a bootstrap module.
private static void	deleteBootstrapConfigAndScript(Path moduleDir, Env.EnvType targetEnv)
static List<Build.MatchingCustomerModule>	getMatchingCustomerModules(String buildConfigFile, String module, Path repoDir, String version)
private static List<String>	getMvnArgs(@Nullable String repoDir, VariableResolver resolver)
static Path	getPlatformDataDirFile(String fileName)
private static Execute.ExecuteConfig	loadBootstrapConfig(Build.BuildConfig config, @Nullable Path mergeConfig, VariableResolver resolver)
private static void	mvnCleanPackage(Path moduleDir, String moduleName, @Nullable String repoDir, VariableResolver resolver, Env.EnvType targetEnv)
private static void	mvnDeploy(Path boostrapArchive, Build.BuildDeployConfig deploy, Path moduleDir, @Nullable String repoDir, VariableResolver resolver, String version)
private static org.apache.commons.cli.Options	newOptions()
private static Map<Path,Path>	prepareMerge(@Nullable List<Build.BuildMergeConfig> mergeConfigs, VariableResolver resolver)
private static void	processCopy(List<Build.BuildCopyConfig> copyConfigs, VariableResolver resolver)
private static void	processMerge(@Nullable Path customizeDir, @Nullable List<Build.BuildMergeConfig> merge, Path moduleResourceDir, VariableResolver resolver)
private static void	processValidate(Path moduleDir, VariableResolver resolver, List<Build.BuildValidateConfig> validateConfigs)
static Path	resolveArchivePath(Path moduleDir, String version)
static void	runMvn(List<String> commands, Path moduleDir, @Nullable String repoDir, VariableResolver resolver)
private static void	validateDefinitions(Path definitionsPath)
private static void	writeBootstrapConfigAndScript(Execute.ExecuteConfig config, Path moduleDir, VariableResolver resolver)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

LOG

private static final org.slf4j.Logger LOG

BIN_DIR

public static final String BIN_DIR

See Also:

• Constant Field Values

BUILD_BIN_DIR_VAR

public static final String BUILD_BIN_DIR_VAR

See Also:

• Constant Field Values

BUILD_CUSTOMIZE_DIR_VAR

public static final String BUILD_CUSTOMIZE_DIR_VAR

See Also:

• Constant Field Values

BUILD_MODULE_DIR_VAR

public static final String BUILD_MODULE_DIR_VAR

See Also:

• Constant Field Values

CUSTOMIZE_OPTION

public static final String CUSTOMIZE_OPTION

See Also:

• Constant Field Values

DOWNLOAD_DIR

public static final String DOWNLOAD_DIR

See Also:

• Constant Field Values

MAVEN_REPO_OPTION

public static final String MAVEN_REPO_OPTION

See Also:

• Constant Field Values

MERGE_OPTION

public static final String MERGE_OPTION

See Also:

• Constant Field Values

MODULE_OPTION

public static final String MODULE_OPTION

See Also:

• Constant Field Values

RESOURCE_DIR

public static final String RESOURCE_DIR

See Also:

• Constant Field Values

ARCHIVE_PATH_FORMAT

private static final String ARCHIVE_PATH_FORMAT

See Also:

• Constant Field Values

BOOTSTRAP_CONFIG_ERROR_FORMAT

private static final String BOOTSTRAP_CONFIG_ERROR_FORMAT

See Also:

• Constant Field Values

BOOTSTRAP_CONFIG_MERGE_ERROR_FORMAT

private static final String BOOTSTRAP_CONFIG_MERGE_ERROR_FORMAT

See Also:

• Constant Field Values

BUILD_BIN_DIR

private static final String BUILD_BIN_DIR

See Also:

• Constant Field Values

COPY_BIN_TARGET_ERROR

private static final String COPY_BIN_TARGET_ERROR

See Also:

• Constant Field Values

CUSTOMIZE_DIR_ERROR_FORMAT

private static final String CUSTOMIZE_DIR_ERROR_FORMAT

See Also:

• Constant Field Values

DEFINITION_FILE_TYPE

private static final String DEFINITION_FILE_TYPE

See Also:

• Constant Field Values

EXECUTE_SCRIPT_NIX

private static final String EXECUTE_SCRIPT_NIX

See Also:

• Constant Field Values

EXECUTE_SCRIPT_WIN

private static final String EXECUTE_SCRIPT_WIN

See Also:

• Constant Field Values

MAVEN_SETTINGS_FILE

private static final String MAVEN_SETTINGS_FILE

MERGE_ERROR_FORMAT

private static final String MERGE_ERROR_FORMAT

See Also:

• Constant Field Values

MERGE_EXCLUDE

private static final Set<String> MERGE_EXCLUDE

MODULE_DIR_ERROR_FORMAT

private static final String MODULE_DIR_ERROR_FORMAT

See Also:

• Constant Field Values

MVN_SUCCESS

private static final String MVN_SUCCESS

See Also:

• Constant Field Values

OPTIONS

private static final org.apache.commons.cli.Options OPTIONS

RUN_MVN_ERROR_MESSAGE

private static final String RUN_MVN_ERROR_MESSAGE

See Also:

• Constant Field Values

VALIDATE_ERROR_FORMAT

private static final String VALIDATE_ERROR_FORMAT

See Also:

• Constant Field Values

VERSION_ERROR_FORMAT

private static final String VERSION_ERROR_FORMAT

See Also:

• Constant Field Values

Constructor Details

Build

private Build()

Method Details

addWgetDownloadsToArchive

private static void addWgetDownloadsToArchive(Path boostrapArchive,
 Execute.ExecuteConfig config)
                                       throws IOException

Throws:

IOException

buildModule

protected static void buildModule(Build.BuildConfig config,
 String... args)
                           throws Exception

Throws:

Exception

buildModule

public static void buildModule(Build.BuildConfig config,
 @Nullable Path customizeDir,
 @Nullable String mavenRepo,
 @Nullable Path mergeConfig,
 Path moduleDir)
                        throws Exception

buildModule prepares and builds a bootstrap module. Prepare means generating/writing the final execute config and boostrap scripts, then merging the base module with any customer specific content. Maven is used to package the ZIP and deploy it to the artifact repository.

Available properties in build config:

• "buildModuleDir"
• "buildCustomizeDir"
• "buildBinDir"
• Environment variables

Parameters:

config - build config

customizeDir - optional, path to customize module

mavenRepo - optional, path to local maven repository

mergeConfig - optional, path to bootstrap config to merge with Build.BuildConfig.bootstrapConfig()

moduleDir - path to bootstrap module

Throws:

Exception

deleteBootstrapConfigAndScript

private static void deleteBootstrapConfigAndScript(Path moduleDir,
 Env.EnvType targetEnv)
                                            throws IOException

Throws:

IOException

getMatchingCustomerModules

public static List<Build.MatchingCustomerModule> getMatchingCustomerModules(String buildConfigFile,
 String module,
 Path repoDir,
 String version)
                                                                     throws IOException

Throws:

IOException

getMvnArgs

private static List<String> getMvnArgs(@Nullable String repoDir,
 VariableResolver resolver)

getPlatformDataDirFile

public static Path getPlatformDataDirFile(String fileName)

loadBootstrapConfig

private static Execute.ExecuteConfig loadBootstrapConfig(Build.BuildConfig config,
 @Nullable Path mergeConfig,
 VariableResolver resolver)
                                                  throws IOException

Throws:

IOException

mvnCleanPackage

private static void mvnCleanPackage(Path moduleDir,
 String moduleName,
 @Nullable String repoDir,
 VariableResolver resolver,
 Env.EnvType targetEnv)

mvnDeploy

private static void mvnDeploy(Path boostrapArchive,
 Build.BuildDeployConfig deploy,
 Path moduleDir,
 @Nullable String repoDir,
 VariableResolver resolver,
 String version)

newOptions

private static org.apache.commons.cli.Options newOptions()

prepareMerge

private static Map<Path,Path> prepareMerge(@Nullable List<Build.BuildMergeConfig> mergeConfigs,
 VariableResolver resolver)
                                    throws Exception

Throws:

Exception

processCopy

private static void processCopy(List<Build.BuildCopyConfig> copyConfigs,
 VariableResolver resolver)
                         throws IOException

Throws:

IOException

processMerge

private static void processMerge(@Nullable Path customizeDir,
 @Nullable List<Build.BuildMergeConfig> merge,
 Path moduleResourceDir,
 VariableResolver resolver)
                          throws Exception

Throws:

Exception

processValidate

private static void processValidate(Path moduleDir,
 VariableResolver resolver,
 List<Build.BuildValidateConfig> validateConfigs)

resolveArchivePath

public static Path resolveArchivePath(Path moduleDir,
 String version)

runMvn

public static void runMvn(List<String> commands,
 Path moduleDir,
 @Nullable String repoDir,
 VariableResolver resolver)

validateDefinitions

private static void validateDefinitions(Path definitionsPath)
                                 throws IOException

Throws:

IOException

writeBootstrapConfigAndScript

private static void writeBootstrapConfigAndScript(Execute.ExecuteConfig config,
 Path moduleDir,
 VariableResolver resolver)
                                           throws IOException

Throws:

IOException