Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

UX session 2, implemented feedbacks. Extracted Openshift releated content to the api module. #56

Merged
merged 9 commits into from
Mar 28, 2024
Merged

UX session 2, implemented feedbacks. Extracted Openshift releated content to the api module. #56

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
83a07e6
Extract openshift support from cli. use amq instead of artemis
Mar 28, 2024
f7bc55c
Enforce cloud for Openshift, introduce fails-on-error
Mar 28, 2024
8bc7e13
Fix docker message, implies cloud for docker image
Mar 28, 2024
04a043c
Do not duplicate env variables in the output
Mar 28, 2024
2c7570d
Better message to export env variables
Mar 28, 2024
5b8cda5
Better message for suggest
Mar 28, 2024
51972de
Provided user env can be used to setup deployers
Mar 28, 2024
0e7db91
Fix init-script short name
Mar 28, 2024
4d3affc
Introduce a cli-script option for openshift
Mar 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion cli/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
</dependency>
<dependency>
<groupId>${project.groupId}</groupId>
<artifactId>wildfly-glow-openshift-deployment-artemis</artifactId>
<artifactId>wildfly-glow-openshift-deployment-amq</artifactId>
</dependency>
<dependency>
<groupId>${project.groupId}</groupId>
Expand Down
9 changes: 7 additions & 2 deletions cli/src/main/java/org/wildfly/glow/cli/commands/Constants.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,19 +52,24 @@ public interface Constants {
String EXCLUDE_ARCHIVES_FROM_SCAN_OPTION = "--exclude-archives-from-scan";
String EXCLUDE_ARCHIVES_FROM_SCAN_OPTION_LABEL = "<list of nested archive names>";
String EXCLUDE_ARCHIVES_FROM_SCAN_OPTION_SHORT = "-ea";
String FAILS_ON_ERROR_OPTION = "--fails-on-error";
String FAILS_ON_ERROR_OPTION_SHORT = "-foe";
String HA_OPTION = "--ha";

String HELP_OPTION = "--help";
String HELP_OPTION_SHORT = "-h";
String CLI_SCRIPT_OPTION = "--cli-script";
String CLI_SCRIPT_OPTION_SHORT = "-cs";
String CLI_SCRIPT_OPTION_LABEL = "<CLI script file path>";
String INIT_SCRIPT_OPTION = "--init-script";
String INIT_SCRIPT_OPTION_SHORT = "-id";
String INIT_SCRIPT_OPTION_SHORT = "-is";
String INIT_SCRIPT_OPTION_LABEL = "<init script file path>";
String INPUT_FEATURE_PACKS_FILE_OPTION = "--input-feature-packs-file";
String INPUT_FEATURE_PACKS_FILE_OPTION_LABEL = "<provisioning file path>";
String NO_DOCKER_IMAGE_OPTION = "--no-docker-image";
String NO_DOCKER_IMAGE_OPTION_SHORT = "-nd";
String PROVISION_OPTION = "--provision";
String PROVISION_OPTION_LABEL = "<SERVER|BOOTABLE_JAR|DOCKER_IMAGE|PROVISIONING_XML>";
String PROVISION_OPTION_LABEL = "<SERVER|BOOTABLE_JAR|OPENSHIFT|DOCKER_IMAGE|PROVISIONING_XML>";
String PROVISION_OPTION_SHORT = "-p";
String SERVER_VERSION_OPTION = "--server-version";
String SERVER_VERSION_OPTION_SHORT = "-sv";
Expand Down
116 changes: 74 additions & 42 deletions cli/src/main/java/org/wildfly/glow/cli/commands/ScanCommand.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@
*/
package org.wildfly.glow.cli.commands;

import org.wildfly.glow.deployment.openshift.api.OpenShiftSupport;
import org.wildfly.glow.deployment.openshift.api.OpenShiftConfiguration;
import java.nio.file.Files;
import org.jboss.galleon.util.IoUtils;
import org.wildfly.glow.Arguments;
Expand Down Expand Up @@ -64,9 +66,9 @@ public Stability convert(String value) throws Exception {
}
}

private static final String ADD_ADD_ONS_MSG="@|bold To enable add-ons, add the|@ @|fg(yellow) " +
Constants.ADD_ONS_OPTION + "=<list of add-ons>|@ @|bold option to the|@ @|fg(yellow) " +
Constants.SCAN_COMMAND + "|@ @|bold command|@";
private static final String ADD_ADD_ONS_MSG = "@|bold To enable add-ons, add the|@ @|fg(yellow) "
+ Constants.ADD_ONS_OPTION + "=<list of add-ons>|@ @|bold option to the|@ @|fg(yellow) "
+ Constants.SCAN_COMMAND + "|@ @|bold command|@";

@CommandLine.Option(names = {Constants.CLOUD_OPTION_SHORT, Constants.CLOUD_OPTION})
Optional<Boolean> cloud;
Expand Down Expand Up @@ -118,10 +120,13 @@ public Stability convert(String value) throws Exception {
Optional<Stability> configStability;

@CommandLine.Option(names = {Constants.ENV_FILE_OPTION_SHORT, Constants.ENV_FILE_OPTION}, paramLabel = Constants.ENV_FILE_OPTION_LABEL)
Optional<Path> envFile;
Optional<Path> envFile;

@CommandLine.Option(names = {Constants.INIT_SCRIPT_OPTION_SHORT, Constants.INIT_SCRIPT_OPTION}, paramLabel = Constants.INIT_SCRIPT_OPTION_LABEL)
Optional<Path> initScriptFile;
Optional<Path> initScriptFile;

@CommandLine.Option(names = {Constants.CLI_SCRIPT_OPTION_SHORT, Constants.CLI_SCRIPT_OPTION}, paramLabel = Constants.CLI_SCRIPT_OPTION_LABEL)
Optional<Path> cliScriptFile;

@CommandLine.Option(names = Constants.DISABLE_DEPLOYERS, split = ",", paramLabel = Constants.ADD_ONS_OPTION_LABEL)
Set<String> disableDeployers = new LinkedHashSet<>();
Expand All @@ -130,6 +135,9 @@ public Stability convert(String value) throws Exception {
split = " ", paramLabel = Constants.SYSTEM_PROPERTIES_LABEL)
Set<String> systemProperties = new HashSet<>();

@CommandLine.Option(names = {Constants.FAILS_ON_ERROR_OPTION_SHORT, Constants.FAILS_ON_ERROR_OPTION}, defaultValue = "true")
Optional<Boolean> failsOnError;

@Override
public Integer call() throws Exception {
if (!systemProperties.isEmpty()) {
Expand All @@ -146,7 +154,7 @@ public Integer call() throws Exception {
}
System.setProperty(propName, value);
} else {
throw new Exception("Invalid system property " + p +". A property must start with -D");
throw new Exception("Invalid system property " + p + ". A property must start with -D");
}
}
}
Expand All @@ -156,9 +164,6 @@ public Integer call() throws Exception {
print("Wildfly Glow is scanning...");
}
Builder builder = Arguments.scanBuilder();
if (cloud.orElse(false)) {
builder.setExecutionContext(CLOUD_EXECUTION_CONTEXT);
}
if (haProfile.orElse(false)) {
Set<String> profiles = new HashSet<>();
profiles.add(Constants.HA);
Expand Down Expand Up @@ -189,13 +194,14 @@ public Integer call() throws Exception {
if (!Files.exists(p)) {
throw new Exception(p + " file doesn't exist");
}
for(String l : Files.readAllLines(p)) {
if (!l.startsWith("#")) {
for (String l : Files.readAllLines(p)) {
l = l.trim();
if (!l.isEmpty() && !l.startsWith("#")) {
int i = l.indexOf("=");
if (i < 0 || i == l.length() - 1) {
throw new Exception("Invalid environment variable " + l + " in " + p);
}
extraEnv.put(l.substring(0, i), l.substring(i+1));
extraEnv.put(l.substring(0, i), l.substring(i + 1));
}
}
}
Expand Down Expand Up @@ -227,13 +233,16 @@ public Integer call() throws Exception {
throw new Exception("Can't produce a Bootable JAR for cloud. Use the " + Constants.PROVISION_OPTION + "=SERVER option for cloud.");
}
if (DOCKER_IMAGE.equals(provision.get()) && !cloud.orElse(false)) {
throw new Exception("Can't produce a Docker image if cloud is not enabled. Use the " + Constants.CLOUD_OPTION + " option.");
cloud = Optional.of(Boolean.TRUE);
}
if (OPENSHIFT.equals(provision.get()) && !cloud.orElse(false)) {
throw new Exception("Can't build/deploy on openShift if cloud is not enabled. Use the " + Constants.CLOUD_OPTION + " option.");
cloud = Optional.of(Boolean.TRUE);
}
builder.setOutput(provision.get());
}
if (cloud.orElse(false)) {
builder.setExecutionContext(CLOUD_EXECUTION_CONTEXT);
}
builder.setExcludeArchivesFromScan(excludeArchivesFromScan);
if (stability.isPresent()) {
if (configStability.isPresent()) {
Expand All @@ -256,6 +265,7 @@ public Integer call() throws Exception {
throw new Exception("Can only set a docker image name when provisioning a docker image. Remove the " + Constants.DOCKER_IMAGE_NAME_OPTION + " option");
}
}
builder.setIsCli(true);
ScanResults scanResults = GlowSession.scan(MavenResolver.newMavenResolver(), builder.build(), GlowMessageWriter.DEFAULT);
scanResults.outputInformation();
if (provision.isEmpty()) {
Expand All @@ -271,24 +281,27 @@ public Integer call() throws Exception {
if (scanResults.getErrorSession().hasErrors()) {
if (!suggest.orElse(false)) {
boolean hasAddOn = false;
// Do we have errors and add-ons to set?
for(IdentifiedError err : scanResults.getErrorSession().getErrors()) {
if (!err.getPossibleAddons().isEmpty()) {
hasAddOn = true;
break;
}
}
// Do we have errors and add-ons to set?
for (IdentifiedError err : scanResults.getErrorSession().getErrors()) {
if (!err.getPossibleAddons().isEmpty()) {
hasAddOn = true;
break;
}
}
if (hasAddOn) {
System.out.println(CommandLine.Help.Ansi.AUTO.string(ADD_ADD_ONS_MSG));
}
}
print("@|bold Some errors have been reported. You should fix them prior provisioning a server with the|@ @|fg(yellow) " + Constants.PROVISION_OPTION + "|@ @|bold option of the|@ @|fg(yellow) " + Constants.SCAN_COMMAND + "|@ @|bold command|@");
} else {
print("@|bold If you had included a|@ @|fg(yellow) " + Constants.PROVISION_OPTION + "|@ @|bold option to the|@ @|fg(yellow) " + Constants.SCAN_COMMAND + "|@ @|bold command, after outputting this report, WildFly Glow will continue on to provisioning your WildFly server, bootable jar or Docker image.|@");
print("@|bold If you had included a|@ @|fg(yellow) " + Constants.PROVISION_OPTION+"="+Constants.PROVISION_OPTION_LABEL + "|@ @|bold option to the|@ @|fg(yellow) " + Constants.SCAN_COMMAND + "|@ @|bold command, after outputting this report, WildFly Glow will continue on to provisioning your WildFly server, bootable jar, a Docker image or deploy your application to OpenShift.|@");
}
}
} else {
print();
if (failsOnError.orElse(false) && scanResults.getErrorSession().hasErrors()) {
throw new Exception("Your are provisioning although errors have been reported. If you want to enforce provisioning, set --fails-on-error=false to ignore errors.");
}
String vers = wildflyServerVersion.orElse(null) == null ? FeaturePacks.getLatestVersion() : wildflyServerVersion.get();
Path target = Paths.get(provisionOutputDir.orElse("server-" + vers));
IoUtils.recursiveDelete(target);
Expand Down Expand Up @@ -319,34 +332,35 @@ public Integer call() throws Exception {
}
OutputContent content = scanResults.outputConfig(target, dockerImageName.orElse(null));
Path base = Paths.get("").toAbsolutePath();
String envMessage = null;
String completedMessage = null;
for (OutputContent.OutputFile f : content.getFiles().keySet()) {
Path rel = base.relativize(content.getFiles().get(f));
switch (f) {
case BOOTABLE_JAR_FILE: {
print("@|bold Bootable JAR build DONE.|@");
print("@|bold To run the jar call: 'java -jar " + rel + "'|@");
completedMessage = "@|bold To run the jar call: 'java -jar " + rel + "'|@";
break;
}
case DOCKER_FILE: {
print("@|bold Image generation DONE.|@.");
print("@|bold Docker file generated in %s|@.", rel);
break;
}
case ENV_FILE: {
if (!OutputFormat.OPENSHIFT.equals(provision.get())) {
print("@|bold The file " + rel + " contains the list of environment variables that you must set prior to start the server.|@");
}
// Exposing this file seems to create confusion
// if (!OutputFormat.OPENSHIFT.equals(provision.get())) {
// print("@|bold The file " + rel + " contains the list of environment variables that you must set prior to start the server.|@");
// }
switch (provision.get()) {
case SERVER: {
print("@|bold Export the suggested env variables for the server to take them into account.|@");
envMessage = "WARNING: You have to export the suggested env variables prior to start the server.";
break;
}
case BOOTABLE_JAR: {
print("@|bold Export the suggested env variables for the bootable JAR to take them into account.|@");
envMessage="WARNING: You have to export the suggested env variables prior to start the bootable JAR.";
break;
}
case DOCKER_IMAGE: {
print("@|bold For each env variable add `-e <env name>=<env value>` to the `docker run` command.|@");
envMessage = "WARNING: For each suggested env variable add `-e <env name>=<env value>` to the `[docker | podman] run` command.";
break;
}
}
Expand All @@ -355,19 +369,17 @@ public Integer call() throws Exception {
case PROVISIONING_XML_FILE: {
switch (provision.get()) {
case PROVISIONING_XML: {
print("@|bold Generation DONE.|@");
print("@|bold Galleon Provisioning configuration is located in " + rel + " file|@");
}
}
break;

}
case SERVER_DIR: {
print("@|bold Provisioning DONE.|@");
if (cloud.orElse(false)) {
print("@|bold To run the server call: 'JBOSS_HOME=" + rel + " sh " + rel + "/bin/openshift-launch.sh'|@");
completedMessage = "@|bold To run the server call: 'JBOSS_HOME=" + rel + " sh " + rel + "/bin/openshift-launch.sh'|@";
} else {
print("@|bold To run the server call: 'sh " + rel + "/bin/standalone.sh'|@");
completedMessage = "@|bold To run the server call: 'sh " + rel + "/bin/standalone.sh'|@";
}
break;
}
Expand All @@ -383,17 +395,37 @@ public Integer call() throws Exception {
name = p.getFileName().toString().substring(0, ext);
}
Map<String, String> envMap = new HashMap<>();
for(Set<Env> envs : scanResults.getSuggestions().getStronglySuggestedConfigurations().values()) {
for(Env env : envs) {
for (Set<Env> envs : scanResults.getSuggestions().getStronglySuggestedConfigurations().values()) {
for (Env env : envs) {
envMap.put(env.getName(), env.getDescription());
}
}
OpenShiftSupport.deploy(GlowMessageWriter.DEFAULT, target, name == null ? "app-from-wildfly-glow" : name.toLowerCase(), envMap, scanResults.getDiscoveredLayers(),
scanResults.getEnabledAddOns(), haProfile.orElse(false), extraEnv, disableDeployers, initScriptFile.orElse(null));
OpenShiftSupport.deploy(GlowMessageWriter.DEFAULT,
target, name == null ? "app-from-wildfly-glow" : name.toLowerCase(),
envMap,
scanResults.getDiscoveredLayers(),
scanResults.getEnabledAddOns(),
haProfile.orElse(false),
extraEnv,
disableDeployers,
initScriptFile.orElse(null),
cliScriptFile.orElse(null),
new OpenShiftConfiguration.Builder().build());
print("@|bold \nOpenshift build and deploy DONE.|@");
}
if (content.getDockerImageName() != null) {
print("@|bold To run the image call: 'docker run " + content.getDockerImageName() + "'|@");
} else {
if (content.getDockerImageName() != null) {
print("@|bold To run the image call: '[docker | podman] run -p 8080:8080 -p 9990:9990 " + content.getDockerImageName() + "'|@");
if (envMessage != null) {
GlowMessageWriter.DEFAULT.warn(envMessage);
}
} else {
if (completedMessage != null) {
print(completedMessage);
if (envMessage != null) {
GlowMessageWriter.DEFAULT.warn(envMessage);
}
}
}
}
}
return 0;
Expand Down
3 changes: 2 additions & 1 deletion cli/src/main/resources/UsageMessages.properties
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,10 +39,11 @@ config-stability-level = Specify a stability to be used when provisioning the se
package-stability-level = Specify a stability to be used when provisioning server packages. The stability is also used to identify server packages that would be not provisioned by the specified stability. The stability is by default the minimum stability of each Galleon feature-packs. The stability can be @|fg(yellow) default|@, @|fg(yellow) community|@, @|fg(yellow) preview|@, @|fg(yellow) experimental|@.
env-file = The path to a file that contains environment variables (in the form env=value) to be passed to the OpenShift deployment. Can only be used with @|fg(yellow) OPENSHIFT|@ kind of provisioning.
init-script = The path to a script that contains commands (JBoss CLI, add-user, ...) to fine tune the server on OpenShift deployment. Can only be used with @|fg(yellow) OPENSHIFT|@ kind of provisioning.
cli-script = The path to a CLI script file that only contains CLI commands in order to fine tune the server on OpenShift deployment. Can only be used with @|fg(yellow) OPENSHIFT|@ kind of provisioning.

disable-deployers = A comma separated list of deployer names to disable. To retrieve all the deployer names call the @|fg(yellow) show-configuration|@ operation. To disable them all, use @|fg(yellow) ALL|@ value. Can only be used with @|fg(yellow) OPENSHIFT|@ kind of provisioning.
properties = A space separated list of Java system properties. When multiple system properties are set, the list must be enclosed in double quotes. For example: "-Dfoo=bar -DmyProp"

fails-on-error= By default provisioning will be aborted if an error is reported by WildFly Glow. Set this option to false to not fail and process with the provisioning.
usage.synopsisHeading = %nUsage:\u0020
# for the main command do not prepend with new line character:
wildfly-glow.usage.synopsisHeading = Usage:\u0020
Expand Down
Loading
Loading