> implements IParseResultHandler {
+ /** {@inheritDoc} */
+ public int execute(ParseResult parseResult) throws ExecutionException { return super.execute(parseResult); }
+
/** Prints help if requested, and otherwise executes the top-level command and all subcommands as {@code Runnable},
* {@code Callable} or {@code Method}. Finally, either a list of result objects is returned, or the JVM is terminated if an exit
* code {@linkplain #andExit(int) was set}. If any of the {@code CommandLine} commands does not implement either
@@ -3648,22 +3657,33 @@ public enum ScopeType {
boolean required() default false;
/**
- * Set {@code help=true} if this option should disable validation of the remaining arguments:
- * If the {@code help} option is specified, no error message is generated for missing required options.
- *
- * This attribute is useful for special options like help ({@code -h} and {@code --help} on unix,
- * {@code -?} and {@code -Help} on Windows) or version ({@code -V} and {@code --version} on unix,
- * {@code -Version} on Windows).
+ *
This should rarely be used: the recommended attributes are {@link #usageHelp() usageHelp} and {@link #versionHelp() versionHelp}.
+ *
+ * Only set {@code help=true} when this option should disable validation of the remaining
+ * arguments, and no error message should be generated for missing required options.
+ *
+ * This is useful for custom help options that are in addition to the standard help and
+ * version options. For example if your application has many hidden options or
+ * subcommands, and there is a custom help option like {@code --detailed-help} that prints
+ * the usage help message for these hidden options and subcommands.
*
+ * Note:
*
- * Note that the {@link #parse(String...)} method will not print help documentation. It will only set
- * the value of the annotated field. It is the responsibility of the caller to inspect the annotated fields
- * and take the appropriate action.
+ * Use the {@link #usageHelp() usageHelp} for "normal" help options (like {@code -h} and {@code --help} on unix,
+ * {@code -?} and {@code -Help} on Windows)
+ * and use {@link #versionHelp() versionHelp} for "normal" version help ({@code -V} and {@code --version} on unix,
+ * {@code -Version} on Windows):
+ * picocli has built-in logic so that options with {@code usageHelp=true} or {@code versionHelp=true}
+ * will automatically cause the requested help message to be printed in applications
+ * that use the {@link #execute(String...)} method, without any code in the application.
+ *
+ * Note that there is no such automatic help printing for options with {@code help=true};
+ * applications need to check whether the end user specified this option and take appropriate action
+ * in the business logic of the application.
*
* @return whether this option disables validation of the other arguments
- * @deprecated Use {@link #usageHelp()} and {@link #versionHelp()} instead. See {@link #printHelpIfRequested(List, PrintStream, CommandLine.Help.Ansi)}
*/
- @Deprecated boolean help() default false;
+ boolean help() default false;
/**
* Set {@code usageHelp=true} for the {@code --help} option that triggers display of the usage help message.
@@ -3735,7 +3755,7 @@ public enum ScopeType {
* command line, a {@link MissingParameterException} is thrown by the {@link #parse(String...)} method.
*
* In many cases picocli can deduce the number of required parameters from the field's type.
- * By default, flags (boolean options) have arity zero,
+ * By default, flags (boolean options) have arity "0..1",
* and single-valued type fields (String, int, Integer, double, Double, File, Date, etc) have arity one.
* Generally, fields with types that cannot hold multiple values can omit the {@code arity} attribute.
*
@@ -3747,7 +3767,8 @@ public enum ScopeType {
*
* A note on boolean options
*
- * By default picocli does not expect boolean options (also called "flags" or "switches") to have a parameter.
+ * By default picocli allows boolean options (also called "flags" or "switches") to have an optional parameter,
+ * which must be either "true" or "false" (lowercase, other values are rejected).
* You can make a boolean option take a required parameter by annotating your field with {@code arity="1"}.
* For example:
* @Option(names = "-v", arity = "1") boolean verbose;
@@ -3757,12 +3778,11 @@ public enum ScopeType {
* on the command line, or a {@link MissingParameterException} is thrown by the {@link #parse(String...)}
* method.
*
- * To make the boolean parameter possible but optional, define the field with {@code arity = "0..1"}.
+ * To remove the optional parameter, define the field with {@code arity = "0"}.
* For example:
- * @Option(names="-v", arity="0..1") boolean verbose;
- * This will accept any of the below without throwing an exception:
+ * @Option(names="-v", arity="0") boolean verbose;
+ * This will reject any of the below:
*
- * -v
* -v true
* -v false
*
@@ -4974,6 +4994,8 @@ private static class NoDefaultProvider implements IDefaultValueProvider {
* }
* }
* }
+ * If this interface does not meet your requirements, you may have a look at the more powerful
+ * and flexible {@link IParameterPreprocessor} interface introduced with picocli 4.6.
* @see Option#parameterConsumer()
* @see Parameters#parameterConsumer()
* @since 4.0 */
@@ -5602,9 +5624,14 @@ static Range adjustForType(Range result, IAnnotatedElement member) {
return result.isUnspecified ? defaultArity(member) : result;
}
/** Returns the default arity {@code Range}: for interactive options/positional parameters,
- * this is 0; for {@link Option options} this is 0 for booleans and 1 for
- * other types, for {@link Parameters parameters} booleans have arity 0, arrays or Collections have
+ * this is 0; for {@link Option options} this is effectively "0..1" for booleans and 1 for
+ * other types, for {@link Parameters parameters} booleans have arity 1, arrays or Collections have
* arity "0..*", and other types have arity 1.
+ * Implementation Notes
+ * The returned {@code Range} for boolean options has an effective arity of "0..1".
+ * This is implemented by returning a {@code Range} with arity "0",
+ * and its {@code unspecified} property set to {@code true}.
+ * This implementation may change in the future.
* @param field the field whose default arity to return
* @return a new {@code Range} indicating the default arity of the specified field
* @since 2.0 */
@@ -6386,7 +6413,7 @@ public CommandSpec addSubcommand(String name, CommandSpec subcommand) {
*/
public CommandSpec addSubcommand(String name, CommandLine subCommandLine) {
CommandSpec subSpec = subCommandLine.getCommandSpec();
- String actualName = validateSubcommandName(name, subSpec);
+ String actualName = validateSubcommandName(interpolator.interpolateCommandName(name), subSpec);
Tracer t = new Tracer();
if (t.isDebug()) {t.debug("Adding subcommand '%s' to '%s'%n", actualName, this.qualifiedName());}
String previousName = commands.getCaseSensitiveKey(actualName);
@@ -6396,7 +6423,7 @@ public CommandSpec addSubcommand(String name, CommandLine subCommandLine) {
subSpec.parent(this);
for (String alias : subSpec.aliases()) {
if (t.isDebug()) {t.debug("Adding alias '%s' for '%s'%n", (parent == null ? "" : parent.qualifiedName() + " ") + alias, this.qualifiedName());}
- previous = commands.put(alias, subCommandLine);
+ previous = commands.put(interpolator.interpolate(alias), subCommandLine);
if (previous != null && previous != subCommandLine) { throw new DuplicateNameException("Alias '" + alias + "' for subcommand '" + actualName + "' is already used by another subcommand of '" + this.name() + "'"); }
}
subSpec.initCommandHierarchyWithResourceBundle(resourceBundleBaseName(), resourceBundle());
@@ -6424,8 +6451,8 @@ private void inheritAttributesFrom(CommandSpec root) {
updatedSubcommandsToInheritFrom(root);
}
private void updatedSubcommandsToInheritFrom(CommandSpec root) {
- if (root != this) {
- mixinStandardHelpOptions(root.mixinStandardHelpOptions());
+ if (root != this && root.mixinStandardHelpOptions()) { // #1331 only add, don't remove
+ mixinStandardHelpOptions(true);
}
Set subcommands = new HashSet(subcommands().values());
for (CommandLine sub : subcommands) {
@@ -6702,6 +6729,7 @@ public CommandSpec remove(ArgSpec arg) {
if (positionalParameters.remove(arg)) {
removed++;
}
+ args.remove(arg);
if (removed == 0) {
throw new NoSuchElementException(String.valueOf(arg));
}
@@ -6936,7 +6964,8 @@ public Set names() {
public List args() { return Collections.unmodifiableList(args); }
Object[] commandMethodParamValues() {
Object[] values = new Object[methodParams.length];
- int argIndex = mixins.containsKey(AutoHelpMixin.KEY) ? 2 : 0;
+ CommandSpec autoHelpMixin = mixins.get(AutoHelpMixin.KEY);
+ int argIndex = autoHelpMixin == null || autoHelpMixin.inherited() ? 0 : 2;
for (int i = 0; i < methodParams.length; i++) {
if (methodParams[i].isAnnotationPresent(Mixin.class)) {
String name = methodParams[i].getAnnotation(Mixin.class).name();
@@ -7155,7 +7184,20 @@ public CommandSpec negatableOptionTransformer(INegatableOptionTransformer newVal
public CommandSpec mixinStandardHelpOptions(boolean newValue) {
if (newValue) {
CommandSpec mixin = CommandSpec.forAnnotatedObject(new AutoHelpMixin(), new DefaultFactory());
- addMixin(AutoHelpMixin.KEY, mixin);
+ boolean overlap = false;
+ for (String key : mixin.optionsMap().keySet()) {
+ if (optionsMap().containsKey(key)) { overlap = true; break; }
+ }
+ if (!overlap) { // #1316, 1319 avoid DuplicateOptionAnnotationsException
+ mixin.inherited = this.inherited();
+ addMixin(AutoHelpMixin.KEY, mixin);
+ }
+ // #1331 if inherit(ed) we also add to subcommands
+ if (scopeType() == ScopeType.INHERIT || inherited()) {
+ for (CommandLine sub : new HashSet(subcommands().values())) {
+ sub.getCommandSpec().mixinStandardHelpOptions(newValue);
+ }
+ }
} else {
CommandSpec helpMixin = mixins.remove(AutoHelpMixin.KEY);
if (helpMixin != null) {
@@ -7167,11 +7209,7 @@ public CommandSpec mixinStandardHelpOptions(boolean newValue) {
}
}
}
- }
- if (scopeType() == ScopeType.INHERIT || inherited()) {
- for (CommandLine sub : new HashSet(subcommands().values())) {
- sub.getCommandSpec().mixinStandardHelpOptions(newValue);
- }
+ // #1331 we don't remove StandardHelpOptions from subcommands, even if they inherit from us
}
return this;
}
@@ -8669,10 +8707,20 @@ public String[] description() {
private String[] expandVariables(String[] desc) {
if (desc.length == 0) { return desc; }
StringBuilder candidates = new StringBuilder();
- if (completionCandidates() != null) {
- for (String c : completionCandidates()) {
- if (candidates.length() > 0) { candidates.append(", "); }
- candidates.append(c);
+ boolean isCompletionCandidatesUsed = false;
+ for (String s: desc) {
+ if (s.contains(DESCRIPTION_VARIABLE_COMPLETION_CANDIDATES)) {
+ isCompletionCandidatesUsed = true;
+ break;
+ }
+ }
+ if (isCompletionCandidatesUsed) {
+ Iterable iter = completionCandidates();
+ if (iter != null) {
+ for (String c : iter) {
+ if (candidates.length() > 0) { candidates.append(", "); }
+ candidates.append(c);
+ }
}
}
String defaultValueString = defaultValueString(false); // interpolate later
@@ -8740,7 +8788,7 @@ private String[] expandVariables(String[] desc) {
/** Returns the root option or positional parameter (on the parent command), if this option or positional parameter was inherited;
* or {@code null} if it was not.
* @see Option#scope()
- * @since 4.6.1 */
+ * @since 4.6.2 */
public ArgSpec root() { return root; }
/** Returns the type to convert the option or positional parameter to before {@linkplain #setValue(Object) setting} the value.
@@ -8787,8 +8835,10 @@ public String mapFallbackValue() {
public Object initialValue() {
// not not initialize if already CACHED, or UNAVAILABLE, or if annotatedElement==null
if (initialValueState == InitialValueState.POSTPONED && annotatedElement != null) {
- try { initialValue = annotatedElement.getter().get(); } catch (Exception ex) { }
- initialValueState = InitialValueState.CACHED;
+ try {
+ initialValue = annotatedElement.getter().get();
+ initialValueState = InitialValueState.CACHED; // only if successfully initialized
+ } catch (Exception ex) { } // #1300 if error: keep initialValueState == POSTPONED
}
return initialValue;
}
@@ -9376,7 +9426,7 @@ private static String inferLabel(String label, String fieldName, ITypeInfo typeI
/** Returns the root option or positional parameter (on the parent command), if this option or positional parameter was inherited;
* or {@code null} if it was not.
* @see Option#scope()
- * @since 4.6.1 */
+ * @since 4.6.2 */
public ArgSpec root() { return root; }
/** Returns the type to convert the option or positional parameter to before {@linkplain #setValue(Object) setting} the value.
@@ -9519,7 +9569,7 @@ private static String inferLabel(String label, String fieldName, ITypeInfo typeI
/**
* Sets the root object for this inherited option, and returns this builder.
- * @since 4.6.1 */
+ * @since 4.6.2 */
public T root(ArgSpec root) { this.root = root ; return self(); }
/** Sets the type to convert the option or positional parameter to before {@linkplain #setValue(Object) setting} the value, and returns this builder.
@@ -13264,12 +13314,14 @@ private void processArguments(List parsedCommands,
if (commandSpec.parent() != null && commandSpec.parent().subcommandsRepeatable() && commandSpec.parent().subcommands().containsKey(arg)) {
tracer.debug("'%s' is a repeatable subcommand of %s%n", arg, commandSpec.parent().qualifiedName());// #454 repeatable subcommands
CommandLine subcommand = commandSpec.parent().subcommands().get(arg);
+ Set inheritedInitialized = initialized;
if (subcommand.interpreter.parseResultBuilder != null) {
tracer.debug("Subcommand '%s' has been matched before. Making a copy...%n", subcommand.getCommandName());
subcommand = subcommand.copy();
subcommand.getCommandSpec().parent(commandSpec.parent()); // hook it up with its parent
+ inheritedInitialized = new LinkedHashSet(inheritedInitialized);
}
- processSubcommand(subcommand, getParent().interpreter.parseResultBuilder, parsedCommands, args, required, initialized, originalArgs, nowProcessing, separator, arg);
+ processSubcommand(subcommand, getParent().interpreter.parseResultBuilder, parsedCommands, args, required, inheritedInitialized, originalArgs, nowProcessing, separator, arg);
continue;
}
@@ -14387,7 +14439,9 @@ private static String optionDescription(String prefix, ArgSpec argSpec, int opti
if (argSpec.arity().max > 1) {
desc += " at index " + optionParamIndex;
}
- desc += " (" + argSpec.paramLabel() + ")";
+ if (argSpec.arity().max > 0) {
+ desc += " (" + argSpec.paramLabel() + ")";
+ }
}
} else {
desc = prefix + "positional parameter at index " + ((PositionalParamSpec) argSpec).index() + " (" + argSpec.paramLabel() + ")";
@@ -14469,6 +14523,17 @@ static void close(Closeable closeable) {
new Tracer().warn("Could not close " + closeable + ": " + ex.toString());
}
}
+ static Charset getStdoutEncoding() {
+ String encoding = System.getProperty("sun.stdout.encoding");
+ return encoding != null ? Charset.forName(encoding) : Charset.defaultCharset();
+ }
+ static Charset getStderrEncoding() {
+ String encoding = System.getProperty("sun.stderr.encoding");
+ return encoding != null ? Charset.forName(encoding) : Charset.defaultCharset();
+ }
+ static PrintWriter newPrintWriter(OutputStream stream, Charset charset) {
+ return new PrintWriter(new BufferedWriter(new OutputStreamWriter(stream, charset)), true);
+ }
static class PositionalParametersSorter implements Comparator {
private static final Range OPTION_INDEX = new Range(0, 0, false, true, "0");
public int compare(ArgSpec p1, ArgSpec p2) {
@@ -18008,7 +18073,7 @@ static List stripErrorMessage(List unmatched) {
public boolean isUnknownOption() { return isUnknownOption(unmatched, getCommandLine()); }
/** Returns {@code true} and prints suggested solutions to the specified stream if such solutions exist, otherwise returns {@code false}.
* @since 3.3.0 */
- public boolean printSuggestions(PrintStream out) { return printSuggestions(new PrintWriter(out, true)); }
+ public boolean printSuggestions(PrintStream out) { return printSuggestions(newPrintWriter(out, getStdoutEncoding())); }
/** Returns {@code true} and prints suggested solutions to the specified stream if such solutions exist, otherwise returns {@code false}.
* @since 4.0 */
public boolean printSuggestions(PrintWriter writer) {
diff --git a/cli/src/main/resources/META-INF/native-image/sourcehawk-cli/native-image.properties b/cli/src/main/resources/META-INF/native-image/sourcehawk-cli/native-image.properties
index 10ea548..57ad3db 100644
--- a/cli/src/main/resources/META-INF/native-image/sourcehawk-cli/native-image.properties
+++ b/cli/src/main/resources/META-INF/native-image/sourcehawk-cli/native-image.properties
@@ -1,3 +1,2 @@
Args = -H:Class=${cli.class} \
- -H:Name=${cli.name} \
- --no-server
\ No newline at end of file
+ -H:Name=${cli.name}
\ No newline at end of file
diff --git a/cli/src/test/groovy/com/optum/sourcehawk/cli/BitbucketScanCommandSpec.groovy b/cli/src/test/groovy/com/optum/sourcehawk/cli/BitbucketScanCommandSpec.groovy
index 4bb99e7..249773b 100644
--- a/cli/src/test/groovy/com/optum/sourcehawk/cli/BitbucketScanCommandSpec.groovy
+++ b/cli/src/test/groovy/com/optum/sourcehawk/cli/BitbucketScanCommandSpec.groovy
@@ -10,11 +10,11 @@ class BitbucketScanCommandSpec extends CliBaseSpecification {
def "getRawRemoteReference"() {
when:
- Pair rawRemoteReference = new BitbucketScanCommand(bitbucket: new CommandOptions.Bitbucket(remoteReference: "owner/repo@master")).getRawRemoteReference()
+ Pair rawRemoteReference = new BitbucketScanCommand(bitbucket: new CommandOptions.Bitbucket(remoteReference: "owner/repo@master")).getRawRemoteReference()
then:
- rawRemoteReference.left == RemoteRef.Type.BITBUCKET
- rawRemoteReference.right == "owner/repo@master"
+ rawRemoteReference.left == "owner/repo@master"
+ rawRemoteReference.right == "main"
}
@Unroll
@@ -63,16 +63,16 @@ class BitbucketScanCommandSpec extends CliBaseSpecification {
def "createRepositoryFileReader"() {
given:
String rawReference = "project/repo@master"
- BitbucketScanCommand githubScanCommand = new BitbucketScanCommand(bitbucket: new CommandOptions.Bitbucket(remoteReference: "owner/repo@main"))
+ BitbucketScanCommand bitbucketScanCommand = new BitbucketScanCommand(bitbucket: new CommandOptions.Bitbucket(remoteReference: "owner/repo@main"))
when:
- RepositoryFileReader repositoryFileReader = githubScanCommand.createRepositoryFileReader(RemoteRef.parse(RemoteRef.Type.BITBUCKET, rawReference))
+ RepositoryFileReader repositoryFileReader = bitbucketScanCommand.createRepositoryFileReader(RemoteRef.parse(rawReference, "main"))
then:
repositoryFileReader
}
- def "createRepositoryFileReader - enterprise"() {
+ def "createRepositoryFileReader - server"() {
given:
String rawReference = "project/repo@master"
BitbucketScanCommand githubScanCommand = new BitbucketScanCommand(bitbucket:
@@ -80,7 +80,7 @@ class BitbucketScanCommandSpec extends CliBaseSpecification {
)
when:
- RepositoryFileReader repositoryFileReader = githubScanCommand.createRepositoryFileReader(RemoteRef.parse(RemoteRef.Type.BITBUCKET, rawReference))
+ RepositoryFileReader repositoryFileReader = githubScanCommand.createRepositoryFileReader(RemoteRef.parse(rawReference, "main"))
then:
repositoryFileReader
diff --git a/cli/src/test/groovy/com/optum/sourcehawk/cli/BitbucketScanSubCommandSpec.groovy b/cli/src/test/groovy/com/optum/sourcehawk/cli/BitbucketScanSubCommandSpec.groovy
index 04f639d..b17a9d7 100644
--- a/cli/src/test/groovy/com/optum/sourcehawk/cli/BitbucketScanSubCommandSpec.groovy
+++ b/cli/src/test/groovy/com/optum/sourcehawk/cli/BitbucketScanSubCommandSpec.groovy
@@ -37,13 +37,15 @@ class BitbucketScanSubCommandSpec extends Specification {
clientAndServer
.when(HttpRequest.request()
.withMethod("HEAD")
- .withPath("/project/repo/raw/master/lombok.config"),
+ .withPath("/rest/api/1.0/projects/project/repos/repo/raw/lombok.config")
+ .withQueryStringParameter("at", "main"),
Times.exactly(1))
.respond(HttpResponse.response().withStatusCode(200))
clientAndServer
.when(HttpRequest.request()
.withMethod("GET")
- .withPath("/project/repo/raw/master/lombok.config")
+ .withPath("/rest/api/1.0/projects/project/repos/repo/raw/lombok.config")
+ .withQueryStringParameter("at", "main")
.withHeader("Accept", "text/plain"),
Times.exactly(2))
.respond(HttpResponse.response()
@@ -65,13 +67,15 @@ class BitbucketScanSubCommandSpec extends Specification {
clientAndServer
.when(HttpRequest.request()
.withMethod("HEAD")
- .withPath("/project/repo/raw/develop/lombok2.config"),
+ .withPath("/rest/api/1.0/projects/project/repos/repo/raw/lombok2.config")
+ .withQueryStringParameter("at", "main"),
Times.exactly(1))
.respond(HttpResponse.response().withStatusCode(200))
clientAndServer
.when(HttpRequest.request()
.withMethod("GET")
- .withPath("/project/repo/raw/develop/lombok2.config")
+ .withPath("/rest/api/1.0/projects/project/repos/repo/raw/lombok2.config")
+ .withQueryStringParameter("at", "main")
.withHeader("Accept", "text/plain"),
Times.exactly(2))
.respond(HttpResponse.response()
@@ -92,9 +96,9 @@ class BitbucketScanSubCommandSpec extends Specification {
String[] args = ["bitbucket", "-S", bitbucketServerUrl, "project/repo@develop" ]
clientAndServer
.when(HttpRequest.request()
- .withMethod("GET")
- .withPath("/project/repo/raw/develop/sourcehawk.yml")
- .withHeader("Accept", "text/plain"),
+ .withMethod("HEAD")
+ .withPath("/rest/api/1.0/projects/project/repos/repo/raw/lombok.config")
+ .withQueryStringParameter("at", "main"),
Times.exactly(1))
.respond(HttpResponse.notFoundResponse())
diff --git a/cli/src/test/groovy/com/optum/sourcehawk/cli/CliBaseSpecification.groovy b/cli/src/test/groovy/com/optum/sourcehawk/cli/CliBaseSpecification.groovy
index fafc98c..690f599 100644
--- a/cli/src/test/groovy/com/optum/sourcehawk/cli/CliBaseSpecification.groovy
+++ b/cli/src/test/groovy/com/optum/sourcehawk/cli/CliBaseSpecification.groovy
@@ -31,7 +31,7 @@ class CliBaseSpecification extends Specification {
}
def cleanupSpec() {
- System.setSecurityManager(defaultSecurityManager)
+ System.setSecurityManager(defaultSecurityManager) // TODO: Deprecated starting in JDK 17
}
protected void createParentDirectories(final File child) {
diff --git a/cli/src/test/groovy/com/optum/sourcehawk/cli/GithubScanCommandSpec.groovy b/cli/src/test/groovy/com/optum/sourcehawk/cli/GithubScanCommandSpec.groovy
index 87cfe86..6c84afe 100644
--- a/cli/src/test/groovy/com/optum/sourcehawk/cli/GithubScanCommandSpec.groovy
+++ b/cli/src/test/groovy/com/optum/sourcehawk/cli/GithubScanCommandSpec.groovy
@@ -10,11 +10,11 @@ class GithubScanCommandSpec extends CliBaseSpecification {
def "getRawRemoteReference"() {
when:
- Pair rawRemoteReference = new GithubScanCommand(github: new CommandOptions.Github(remoteReference: "owner/repo@main")).getRawRemoteReference()
+ Pair rawRemoteReference = new GithubScanCommand(github: new CommandOptions.Github(remoteReference: "owner/repo@main")).getRawRemoteReference()
then:
- rawRemoteReference.left == RemoteRef.Type.GITHUB
- rawRemoteReference.right == "owner/repo@main"
+ rawRemoteReference.left == "owner/repo@main"
+ rawRemoteReference.right == "main"
}
@Unroll
@@ -66,7 +66,7 @@ class GithubScanCommandSpec extends CliBaseSpecification {
GithubScanCommand githubScanCommand = new GithubScanCommand(github: new CommandOptions.Github(remoteReference: "owner/repo@main"))
when:
- RepositoryFileReader repositoryFileReader = githubScanCommand.createRepositoryFileReader(RemoteRef.parse(RemoteRef.Type.GITHUB, rawReference))
+ RepositoryFileReader repositoryFileReader = githubScanCommand.createRepositoryFileReader(RemoteRef.parse(rawReference, "main"))
then:
repositoryFileReader
@@ -80,7 +80,7 @@ class GithubScanCommandSpec extends CliBaseSpecification {
)
when:
- RepositoryFileReader repositoryFileReader = githubScanCommand.createRepositoryFileReader(RemoteRef.parse(RemoteRef.Type.GITHUB, rawReference))
+ RepositoryFileReader repositoryFileReader = githubScanCommand.createRepositoryFileReader(RemoteRef.parse(rawReference, "main"))
then:
repositoryFileReader
diff --git a/cli/src/test/groovy/com/optum/sourcehawk/cli/NativeImageConfigSpec.groovy b/cli/src/test/groovy/com/optum/sourcehawk/cli/NativeImageConfigSpec.groovy
index e657673..85ad9bc 100644
--- a/cli/src/test/groovy/com/optum/sourcehawk/cli/NativeImageConfigSpec.groovy
+++ b/cli/src/test/groovy/com/optum/sourcehawk/cli/NativeImageConfigSpec.groovy
@@ -19,7 +19,6 @@ class NativeImageConfigSpec extends Specification {
then:
args.contains("-H:Class=${Sourcehawk.name}")
args.contains("-H:Name=sourcehawk")
- args.contains("--no-server")
}
def "all native image configs are on classpath"() {
diff --git a/cli/src/test/resources/flattened/sourcehawk-flattened-base.yml b/cli/src/test/resources/flattened/sourcehawk-flattened-base.yml
index b250224..2a183f9 100644
--- a/cli/src/test/resources/flattened/sourcehawk-flattened-base.yml
+++ b/cli/src/test/resources/flattened/sourcehawk-flattened-base.yml
@@ -53,4 +53,4 @@ file-protocols:
enforcers:
- enforcer: ".common.StringPropertyEquals"
property-name: "distributionUrl"
- expected-property-value: "https://apache.claz.org/maven/maven-3/3.6.3/binaries/apache-maven-3.6.3-bin.zip"
+ expected-property-value: "https://repo1.maven.org/maven2/org/apache/maven/apache-maven/3.8.4/apache-maven-3.8.4-bin.zip"
diff --git a/cli/src/test/resources/flattened/sourcehawk-flattened-override.yml b/cli/src/test/resources/flattened/sourcehawk-flattened-override.yml
index 0f6a243..865aeb5 100644
--- a/cli/src/test/resources/flattened/sourcehawk-flattened-override.yml
+++ b/cli/src/test/resources/flattened/sourcehawk-flattened-override.yml
@@ -72,4 +72,4 @@ file-protocols:
enforcers:
- enforcer: ".common.StringPropertyEquals"
property-name: "distributionUrl"
- expected-property-value: "https://apache.claz.org/maven/maven-3/3.6.3/binaries/apache-maven-3.6.3-bin.zip"
+ expected-property-value: "https://repo1.maven.org/maven2/org/apache/maven/apache-maven/3.8.4/apache-maven-3.8.4-bin.zip"
diff --git a/cli/src/test/resources/sourcehawk-simple.yml b/cli/src/test/resources/sourcehawk-simple.yml
index 908c760..8bf174b 100644
--- a/cli/src/test/resources/sourcehawk-simple.yml
+++ b/cli/src/test/resources/sourcehawk-simple.yml
@@ -8,28 +8,6 @@ file-protocols:
repository-path: README.md
required: true
severity: WARNING
- - name: Lombok
- repository-path: lombok.config
- required: true
- severity: WARNING
- enforcers:
- - enforcer: .common.StringPropertyEquals
- property-name: config.stopBubbling
- expected-property-value: false
- - enforcer: .common.StringPropertyEquals
- property-name: lombok.addLombokGeneratedAnnotation
- expected-property-value: false
- - name: Lombok
- repository-path: lombok.config
- required: true
- severity: WARNING
- enforcers:
- - enforcer: .common.StringPropertyEquals
- property-name: config.stopBubbling
- expected-property-value: false
- - enforcer: .common.StringPropertyEquals
- property-name: lombok.addLombokGeneratedAnnotation
- expected-property-value: false
- name: Lombok
repository-path: lombok.config
required: true
diff --git a/core/pom.xml b/core/pom.xml
index aa79050..0d73a61 100644
--- a/core/pom.xml
+++ b/core/pom.xml
@@ -8,7 +8,7 @@
com.optum.sourcehawk
sourcehawk
- 0.6.0-SNAPSHOT
+ 0.7.0-SNAPSHOT
../pom.xml
diff --git a/core/src/main/java/com/optum/sourcehawk/core/data/RemoteRef.java b/core/src/main/java/com/optum/sourcehawk/core/data/RemoteRef.java
index c17c32e..09f179e 100644
--- a/core/src/main/java/com/optum/sourcehawk/core/data/RemoteRef.java
+++ b/core/src/main/java/com/optum/sourcehawk/core/data/RemoteRef.java
@@ -25,13 +25,7 @@ public class RemoteRef {
private static final String PARSE_ERROR_PREFIX = "Invalid remote reference";
/**
- * The type of the remote reference
- */
- @NonNull
- Type type;
-
- /**
- * The remote namespace, such as Github owner / organization, or Bitbucket project
+ * The remote namespace, such as Github owner / organization, or Bitbucket user / project
*/
@NonNull
String namespace;
@@ -51,20 +45,20 @@ public class RemoteRef {
/**
* Create the remote ref from the type and raw reference
*
- * @param type the type of the remote ref
* @param rawRemoteRef the raw remote reference
+ * @param defaultRef the default ref to use if none provided
* @return the remote reference
*/
- public static RemoteRef parse(final Type type, final String rawRemoteRef) {
+ public static RemoteRef parse(final String rawRemoteRef, final String defaultRef) {
if (rawRemoteRef.indexOf(COORDINATES_DELIMITER) == -1) {
- val message = String.format("%s, must contain '%s' separator between %s and repository", PARSE_ERROR_PREFIX, COORDINATES_DELIMITER, type.getNamespaceType());
+ val message = String.format("%s, must contain '%s' separator between repository coordinates", PARSE_ERROR_PREFIX, COORDINATES_DELIMITER);
throw new IllegalArgumentException(message);
}
val remoteRefBuilder = builder();
final String rawCoordinates;
if (rawRemoteRef.indexOf(REF_DELIMITER) == -1) {
rawCoordinates = rawRemoteRef;
- remoteRefBuilder.ref(type.getDefaultBranch());
+ remoteRefBuilder.ref(defaultRef);
} else {
val refDelimiterIndex= rawRemoteRef.indexOf(REF_DELIMITER);
rawCoordinates = rawRemoteRef.substring(0, refDelimiterIndex);
@@ -77,7 +71,7 @@ public static RemoteRef parse(final Type type, final String rawRemoteRef) {
if (coordinates.length < 2) {
throw new IllegalArgumentException(PARSE_ERROR_PREFIX + ", repository must not be empty");
}
- return remoteRefBuilder.type(type)
+ return remoteRefBuilder
.namespace(coordinates[0])
.repository(coordinates[1])
.build();
@@ -86,36 +80,7 @@ public static RemoteRef parse(final Type type, final String rawRemoteRef) {
/** {@inheritDoc} */
@Override
public String toString() {
- return String.format("[%s] %s%s%s%s%s", type.name(), namespace, COORDINATES_DELIMITER, repository, REF_DELIMITER, ref);
- }
-
- /**
- * The type of the remote reference
- *
- * @author Brian Wyka
- */
- @Getter
- @AllArgsConstructor(access = AccessLevel.PRIVATE)
- public enum Type {
-
- BITBUCKET("https://bitbucket.org", "master", "project"),
- GITHUB("https://raw.githubusercontent.com", "main", "owner");
-
- /**
- * The base URL
- */
- private final String baseUrl;
-
- /**
- * The name of the default branch
- */
- private final String defaultBranch;
-
- /**
- * The namespace type
- */
- private final String namespaceType;
-
+ return String.format("%s%s%s%s%s", namespace, COORDINATES_DELIMITER, repository, REF_DELIMITER, ref);
}
}
diff --git a/core/src/main/java/com/optum/sourcehawk/core/repository/BitbucketRepositoryFileReader.java b/core/src/main/java/com/optum/sourcehawk/core/repository/BitbucketRepositoryFileReader.java
deleted file mode 100644
index ceb9ccf..0000000
--- a/core/src/main/java/com/optum/sourcehawk/core/repository/BitbucketRepositoryFileReader.java
+++ /dev/null
@@ -1,52 +0,0 @@
-package com.optum.sourcehawk.core.repository;
-
-import com.optum.sourcehawk.core.data.RemoteRef;
-import lombok.NonNull;
-import lombok.val;
-
-/**
- * A {@link RemoteRepositoryFileReader} implementation which reads files from remote Bitbucket repositories
- *
- * @author Brian Wyka
- */
-public class BitbucketRepositoryFileReader extends RemoteRepositoryFileReader {
-
- /**
- * The authorization token prefix
- */
- private static final String AUTHORIZATION_TOKEN_PREFIX = "Bearer ";
-
- /**
- * Constructs the Bitbucket repository file reader
- *
- * @param token the token
- * @param bitbucketBaseUrl the Bitbucket base URL
- * @param remoteRef the remote ref
- */
- public BitbucketRepositoryFileReader(final String token, @NonNull final String bitbucketBaseUrl, final RemoteRef remoteRef) {
- super(constructBaseUrl(remoteRef, bitbucketBaseUrl), constructRequestProperties(AUTHORIZATION_TOKEN_PREFIX, token));
- }
-
- /**
- * Constructs an instance of this reader with the provided project, repo, and ref
- *
- * @param token the github token (optional)
- * @param remoteRef the remote reference
- */
- public BitbucketRepositoryFileReader(final String token, @NonNull final RemoteRef remoteRef) {
- this(token, RemoteRef.Type.BITBUCKET.getBaseUrl(), remoteRef);
- }
-
- /**
- * Construct the base URL of the Bitbucket repository based on the provided project, repo, and ref
- *
- * @param remoteRef the remote reference
- * @param bitbucketBaseUrl the base URL
- * @return the constructed base URL with a trailing {@value #SEPARATOR}
- */
- public static String constructBaseUrl(final RemoteRef remoteRef, final String bitbucketBaseUrl) {
- val baseUrl = bitbucketBaseUrl.endsWith(SEPARATOR) ? bitbucketBaseUrl.substring(0, bitbucketBaseUrl.length() - 1) : bitbucketBaseUrl;
- return String.format("%s/%s/%s/raw/%s/", baseUrl, remoteRef.getNamespace(), remoteRef.getRepository(), remoteRef.getRef());
- }
-
-}
diff --git a/core/src/main/java/com/optum/sourcehawk/core/repository/GithubRepositoryFileReader.java b/core/src/main/java/com/optum/sourcehawk/core/repository/GithubRepositoryFileReader.java
deleted file mode 100644
index dabcf8e..0000000
--- a/core/src/main/java/com/optum/sourcehawk/core/repository/GithubRepositoryFileReader.java
+++ /dev/null
@@ -1,54 +0,0 @@
-package com.optum.sourcehawk.core.repository;
-
-import com.optum.sourcehawk.core.data.RemoteRef;
-import lombok.NonNull;
-import lombok.val;
-
-/**
- * A {@link RemoteRepositoryFileReader} implementation which reads files from remote Github repositories
- *
- * @author Brian Wyka
- */
-public class GithubRepositoryFileReader extends RemoteRepositoryFileReader {
-
- /**
- * The authorization token prefix
- */
- private static final String AUTHORIZATION_TOKEN_PREFIX = "token ";
-
- /**
- * Constructs an instance of this reader with the provided Github Enterprise URL
- *
- * @param token the github token (optional)
- * @param githubEnterpriseUrl the Github enterprise URL
- * @param remoteRef the remote reference
- */
- public GithubRepositoryFileReader(final String token, @NonNull final String githubEnterpriseUrl, @NonNull final RemoteRef remoteRef) {
- super(constructBaseUrl(githubEnterpriseUrl, true, remoteRef), constructRequestProperties(AUTHORIZATION_TOKEN_PREFIX, token));
- }
-
- /**
- * Constructs an instance of this reader with the provided owner, repo, and ref
- *
- * @param token the github token (optional)
- * @param remoteRef the remote reference
- */
- public GithubRepositoryFileReader(final String token, @NonNull final RemoteRef remoteRef) {
- super(constructBaseUrl(RemoteRef.Type.GITHUB.getBaseUrl(), false, remoteRef), constructRequestProperties(AUTHORIZATION_TOKEN_PREFIX, token));
- }
-
- /**
- * Construct the base URL of the Github repository based on the provided owner, repo, and ref
- *
- * @param githubUrl the Github URL
- * @param githubEnterprise true if Github Enterprise, false otherwise
- * @param remoteRef the remote reference
- * @return the constructed base URL with a trailing {@value #SEPARATOR}
- */
- public static String constructBaseUrl(final String githubUrl, final boolean githubEnterprise, final RemoteRef remoteRef) {
- val baseUrl = githubUrl.endsWith(SEPARATOR) ? githubUrl.substring(0, githubUrl.length() - 1) : githubUrl;
- val githubBaseUrl = githubEnterprise ? baseUrl + "/raw" : baseUrl;
- return String.format("%s/%s/%s/%s/", githubBaseUrl, remoteRef.getNamespace(), remoteRef.getRepository(), remoteRef.getRef());
- }
-
-}
diff --git a/core/src/main/java/com/optum/sourcehawk/core/repository/LocalRepositoryFileReader.java b/core/src/main/java/com/optum/sourcehawk/core/repository/LocalRepositoryFileReader.java
index 802d58d..c4f88c6 100644
--- a/core/src/main/java/com/optum/sourcehawk/core/repository/LocalRepositoryFileReader.java
+++ b/core/src/main/java/com/optum/sourcehawk/core/repository/LocalRepositoryFileReader.java
@@ -59,6 +59,12 @@ public Optional read(@NonNull final String repositoryFilePath) thro
return getInputStream(directory.resolve(Paths.get(repositoryFilePath)));
}
+ /** {@inheritDoc} */
+ @Override
+ public String getAbsoluteLocation(final String repositoryFilePath) {
+ return directory.resolve(Paths.get(repositoryFilePath)).toAbsolutePath().toString();
+ }
+
/**
* Get the {@link InputStream} from the {@link File} reference
*
diff --git a/core/src/main/java/com/optum/sourcehawk/core/repository/RemoteRepositoryFileReader.java b/core/src/main/java/com/optum/sourcehawk/core/repository/RemoteRepositoryFileReader.java
index 76bda54..20c49b8 100644
--- a/core/src/main/java/com/optum/sourcehawk/core/repository/RemoteRepositoryFileReader.java
+++ b/core/src/main/java/com/optum/sourcehawk/core/repository/RemoteRepositoryFileReader.java
@@ -1,36 +1,33 @@
package com.optum.sourcehawk.core.repository;
-import com.optum.sourcehawk.core.utils.StringUtils;
-import lombok.NonNull;
-import lombok.val;
-
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.InputStream;
import java.net.HttpURLConnection;
import java.net.URL;
-import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
import java.util.Optional;
+import lombok.NonNull;
+import lombok.val;
/**
* A remote repository file reader which treats the repository file paths relative
- * to the base URL provided during construction
+ * to the raw file URL template provided during construction
*
* @author Brian Wyka
*/
-abstract class RemoteRepositoryFileReader implements RepositoryFileReader {
+public final class RemoteRepositoryFileReader implements RepositoryFileReader {
/**
* URL Separator
*/
- protected static final String SEPARATOR = "/";
+ private static final String SEPARATOR = "/";
/**
- * The base URL to read from
+ * The raw file URL template. Takes one parameter: The path of the file in the repository
*/
- private final String baseUrl;
+ private final String rawFileUrlTemplate;
/**
* The required request properties
@@ -45,31 +42,18 @@ abstract class RemoteRepositoryFileReader implements RepositoryFileReader {
/**
* Constructs an instance of this reader with the provided base URL
*
- * @param baseUrl the base URL
+ * @param rawFileUrlTemplate the raw file URL template
* @param requestProperties the request properties required for connection
*/
- protected RemoteRepositoryFileReader(@NonNull final String baseUrl, final Map requestProperties) {
- if (baseUrl.endsWith(SEPARATOR)) {
- this.baseUrl = baseUrl;
- } else {
- this.baseUrl = baseUrl + SEPARATOR;
- }
+ public RemoteRepositoryFileReader(@NonNull final String rawFileUrlTemplate, @NonNull final Map requestProperties) {
+ this.rawFileUrlTemplate = rawFileUrlTemplate;
this.requestProperties = requestProperties;
}
- /**
- * Constructs an instance of this reader with the provided base URL
- *
- * @param baseUrl the base URL
- */
- protected RemoteRepositoryFileReader(@NonNull final String baseUrl) {
- this(baseUrl, Collections.emptyMap());
- }
-
/** {@inheritDoc} */
@Override
public boolean exists(final String repositoryFilePath) throws IOException {
- val absoluteUrl = constructAbsoluteUrl(baseUrl, repositoryFilePath);
+ val absoluteUrl = new URL(constructAbsoluteLocation(rawFileUrlTemplate, repositoryFilePath));
val absoluteUrlString = absoluteUrl.toString();
if (urlExistenceCache.containsKey(absoluteUrlString)) {
return urlExistenceCache.get(absoluteUrlString);
@@ -82,7 +66,7 @@ public boolean exists(final String repositoryFilePath) throws IOException {
/** {@inheritDoc} */
@Override
public Optional read(final String repositoryFilePath) throws IOException {
- val absoluteUrl = constructAbsoluteUrl(baseUrl, repositoryFilePath);
+ val absoluteUrl = new URL(constructAbsoluteLocation(rawFileUrlTemplate, repositoryFilePath));
if (exists(repositoryFilePath)) {
val httpUrlConnection = (HttpURLConnection) absoluteUrl.openConnection();
requestProperties.forEach(httpUrlConnection::setRequestProperty);
@@ -91,6 +75,12 @@ public Optional read(final String repositoryFilePath) throws IOExce
return Optional.empty();
}
+ /** {@inheritDoc} */
+ @Override
+ public String getAbsoluteLocation(final String repositoryFilePath) {
+ return constructAbsoluteLocation(rawFileUrlTemplate, repositoryFilePath);
+ }
+
/**
* Get the input stream from the {@link HttpURLConnection}
*
@@ -117,38 +107,25 @@ private boolean urlExists(final URL url) throws IOException {
val httpUrlConnection = (HttpURLConnection) url.openConnection();
httpUrlConnection.setRequestMethod("HEAD");
requestProperties.forEach(httpUrlConnection::setRequestProperty);
- return httpUrlConnection.getResponseCode() == HttpURLConnection.HTTP_OK;
+ val httpResponseCode = httpUrlConnection.getResponseCode();
+ if (httpResponseCode != HttpURLConnection.HTTP_OK) {
+ System.err.println("HTTP Request to " + url + " returned response code " + httpResponseCode); // FIXME
+ }
+ return httpResponseCode == HttpURLConnection.HTTP_OK;
}
/**
- * Construct the absolute URL to the remote file
+ * Construct the absolute location to the remote file
*
- * @param baseUrl the repository base URL
+ * @param rawFileUrlTemplate the raw file URL template
* @param repositoryFilePath the repository file path
- * @return the absolute URL to the file
- * @throws IOException if the URL is malformed
+ * @return the absolute location to the repository file
*/
- private static URL constructAbsoluteUrl(final String baseUrl, final String repositoryFilePath) throws IOException {
+ private static String constructAbsoluteLocation(final String rawFileUrlTemplate, final String repositoryFilePath) {
if (repositoryFilePath.startsWith(SEPARATOR)) {
- return new URL(baseUrl + repositoryFilePath.substring(1));
- }
- return new URL(baseUrl + repositoryFilePath);
- }
-
- /**
- * Construct the request properties for the provided github token
- *
- * @param authorizationPrefix the authorization request property prefix
- * @param authorizationToken the authorization token
- * @return the request properties
- */
- protected static Map constructRequestProperties(final String authorizationPrefix, final String authorizationToken) {
- val requestProperties = new HashMap();
- requestProperties.put("Accept", "text/plain");
- if (StringUtils.isNotBlankOrEmpty(authorizationToken)) {
- requestProperties.put("Authorization", authorizationPrefix + authorizationToken);
+ return String.format(rawFileUrlTemplate, repositoryFilePath.substring(1));
}
- return requestProperties;
+ return String.format(rawFileUrlTemplate, repositoryFilePath);
}
}
diff --git a/core/src/main/java/com/optum/sourcehawk/core/repository/RepositoryFileReader.java b/core/src/main/java/com/optum/sourcehawk/core/repository/RepositoryFileReader.java
index 1fabc10..ca4c43e 100644
--- a/core/src/main/java/com/optum/sourcehawk/core/repository/RepositoryFileReader.java
+++ b/core/src/main/java/com/optum/sourcehawk/core/repository/RepositoryFileReader.java
@@ -38,4 +38,12 @@ default boolean supportsGlobPatterns() {
*/
Optional read(final String repositoryFilePath) throws IOException;
+ /**
+ * Get a string representation of the absolute location of {@code repositoryFilePath}
+ *
+ * @param repositoryFilePath the repository file path
+ * @return the absolute location
+ */
+ String getAbsoluteLocation(final String repositoryFilePath);
+
}
diff --git a/core/src/test/groovy/com/optum/sourcehawk/core/data/RemoteRefSpec.groovy b/core/src/test/groovy/com/optum/sourcehawk/core/data/RemoteRefSpec.groovy
index 5d7e567..7b26ae4 100644
--- a/core/src/test/groovy/com/optum/sourcehawk/core/data/RemoteRefSpec.groovy
+++ b/core/src/test/groovy/com/optum/sourcehawk/core/data/RemoteRefSpec.groovy
@@ -7,14 +7,12 @@ class RemoteRefSpec extends Specification {
def "builder and toString"() {
given:
- RemoteRef.Type type = RemoteRef.Type.GITHUB
String namespace = "namespace"
String repository = "repository"
String ref = "ref"
when:
RemoteRef remoteRef = RemoteRef.builder()
- .type(type)
.namespace(namespace)
.repository(repository)
.ref(ref)
@@ -22,32 +20,29 @@ class RemoteRefSpec extends Specification {
then:
remoteRef
- remoteRef.type == type
remoteRef.namespace == namespace
remoteRef.repository == repository
remoteRef.ref == ref
and:
- remoteRef.toString() == "[GITHUB] namespace/repository@ref"
+ remoteRef.toString() == "namespace/repository@ref"
}
def "parse"() {
given:
- RemoteRef.Type type = RemoteRef.Type.GITHUB
String rawReference = "namespace/repository@ref"
when:
- RemoteRef remoteRef = RemoteRef.parse(type, rawReference)
+ RemoteRef remoteRef = RemoteRef.parse(rawReference, "main")
then:
remoteRef
- remoteRef.type == type
remoteRef.namespace == "namespace"
remoteRef.repository == "repository"
remoteRef.ref == "ref"
and:
- remoteRef.toString() == "[GITHUB] ${rawReference}"
+ remoteRef.toString() == rawReference
}
@Unroll
@@ -56,31 +51,22 @@ class RemoteRefSpec extends Specification {
String rawReference = "namespace/repository"
when:
- RemoteRef remoteRef = RemoteRef.parse(type, rawReference)
+ RemoteRef remoteRef = RemoteRef.parse(rawReference, "main")
then:
remoteRef
- remoteRef.type == type
remoteRef.namespace == "namespace"
remoteRef.repository == "repository"
- remoteRef.ref == expected
+ remoteRef.ref == "main"
and:
- remoteRef.toString() == "[${type.name()}] ${rawReference}@${expected}"
-
- where:
- type | expected
- RemoteRef.Type.GITHUB | "main"
- RemoteRef.Type.BITBUCKET | "master"
+ remoteRef.toString() == "${rawReference}@main"
}
@Unroll
def "parse - invalid (throws IllegalArgumentException)"() {
- given:
- RemoteRef.Type type = RemoteRef.Type.GITHUB
-
when:
- RemoteRef.parse(type, rawReference)
+ RemoteRef.parse(rawReference, "main")
then:
thrown(IllegalArgumentException)
diff --git a/core/src/test/groovy/com/optum/sourcehawk/core/repository/BitbucketRepositoryFileReaderSpec.groovy b/core/src/test/groovy/com/optum/sourcehawk/core/repository/BitbucketRepositoryFileReaderSpec.groovy
deleted file mode 100644
index 6aef8f3..0000000
--- a/core/src/test/groovy/com/optum/sourcehawk/core/repository/BitbucketRepositoryFileReaderSpec.groovy
+++ /dev/null
@@ -1,184 +0,0 @@
-package com.optum.sourcehawk.core.repository
-
-import com.optum.sourcehawk.core.data.RemoteRef
-import org.mockserver.configuration.ConfigurationProperties
-import org.mockserver.integration.ClientAndServer
-import org.mockserver.matchers.Times
-import org.mockserver.model.HttpRequest
-import org.mockserver.model.HttpResponse
-import spock.lang.AutoCleanup
-import spock.lang.Shared
-import spock.lang.Specification
-
-class BitbucketRepositoryFileReaderSpec extends Specification {
-
- @Shared
- @AutoCleanup
- ClientAndServer clientAndServer
-
- @Shared
- String baseUrl
-
- def setupSpec() {
- clientAndServer = ClientAndServer.startClientAndServer("http://127.0.0.1", 8122)
- ConfigurationProperties.logLevel("WARN")
- baseUrl = "${clientAndServer.remoteAddress.hostString}:${clientAndServer.port}"
- }
-
- def setup() {
- clientAndServer.reset()
- }
-
- def "constructors"() {
- expect:
- new BitbucketRepositoryFileReader(null, RemoteRef.parse(RemoteRef.Type.BITBUCKET, "project/repo@master"))
- new BitbucketRepositoryFileReader("abc", "https://bitbucket.example.com/", RemoteRef.parse(RemoteRef.Type.BITBUCKET, "project/repo@master"))
- }
-
- def "supportsGlobPatterns"() {
- given:
- BitbucketRepositoryFileReader reader = new BitbucketRepositoryFileReader(null, RemoteRef.parse(RemoteRef.Type.BITBUCKET, "project/repo@master"))
-
- when:
- boolean supportsGlobPatterns = reader.supportsGlobPatterns()
-
- then:
- !supportsGlobPatterns
- }
-
- def "exists - found"() {
- given:
- RemoteRef remoteRef = RemoteRef.parse(RemoteRef.Type.BITBUCKET, "project/repo@master")
- BitbucketRepositoryFileReader reader = new BitbucketRepositoryFileReader(null, baseUrl, remoteRef)
- clientAndServer
- .when(HttpRequest.request()
- .withMethod("HEAD")
- .withPath("/project/repo/raw/master/README.md"),
- Times.exactly(1))
- .respond(HttpResponse.response().withStatusCode(200))
-
- when:
- boolean exists = reader.exists("README.md")
-
- then:
- exists
- }
-
- def "exists - not found"() {
- given:
- RemoteRef remoteRef = RemoteRef.parse(RemoteRef.Type.BITBUCKET, "project/repo@master")
- BitbucketRepositoryFileReader reader = new BitbucketRepositoryFileReader(null, baseUrl, remoteRef)
- clientAndServer
- .when(HttpRequest.request()
- .withMethod("HEAD")
- .withPath("/project/repo/raw/master/README.md"),
- Times.exactly(1))
- .respond(HttpResponse.notFoundResponse())
-
- when:
- boolean exists = reader.exists("README.md")
-
- then:
- !exists
- }
-
- def "read - found"() {
- given:
- RemoteRef remoteRef = RemoteRef.parse(RemoteRef.Type.BITBUCKET, "project/repo@master")
- BitbucketRepositoryFileReader reader = new BitbucketRepositoryFileReader(null, baseUrl, remoteRef)
- clientAndServer
- .when(HttpRequest.request()
- .withMethod("HEAD")
- .withPath("/project/repo/raw/master/README.md"),
- Times.exactly(1))
- .respond(HttpResponse.response().withStatusCode(200))
- clientAndServer
- .when(HttpRequest.request()
- .withMethod("GET")
- .withPath("/project/repo/raw/master/README.md"),
- Times.exactly(2))
- .respond(HttpResponse.response().withStatusCode(200).withBody("# Title".bytes))
-
- when:
- Optional inputStreamOptional = reader.read("README.md")
-
- then:
- inputStreamOptional
- inputStreamOptional.isPresent()
-
- when:
- inputStreamOptional = reader.read("/README.md")
-
- then:
- inputStreamOptional
- inputStreamOptional.isPresent()
- }
-
- def "read - not found"() {
- given:
- RemoteRef remoteRef = RemoteRef.parse(RemoteRef.Type.BITBUCKET, "project/repo@master")
- BitbucketRepositoryFileReader reader = new BitbucketRepositoryFileReader(null, baseUrl, remoteRef)
- clientAndServer
- .when(HttpRequest.request()
- .withMethod("HEAD")
- .withPath("/project/repo/raw/master/README.md"),
- Times.exactly(1))
- .respond(HttpResponse.notFoundResponse())
-
- when:
- Optional inputStreamOptional = reader.read("README.md")
-
- then:
- !inputStreamOptional
- }
-
- def "constructBaseUrl"() {
- given:
- RemoteRef remoteRef = RemoteRef.parse(RemoteRef.Type.BITBUCKET, "project/repo@master")
-
- when:
- String baseUrl = BitbucketRepositoryFileReader.constructBaseUrl(remoteRef, RemoteRef.Type.BITBUCKET.baseUrl)
-
- then:
- baseUrl == "https://bitbucket.org/project/repo/raw/master/"
- }
-
- def "constructor - null parameter"() {
- when:
- new BitbucketRepositoryFileReader("abc", null)
-
- then:
- thrown(NullPointerException)
-
- when:
- new BitbucketRepositoryFileReader(null, null)
-
- then:
- thrown(NullPointerException)
-
- when:
- new BitbucketRepositoryFileReader("abc", null, RemoteRef.parse(RemoteRef.Type.BITBUCKET, "project/repo@master"))
-
- then:
- thrown(NullPointerException)
-
- when:
- new BitbucketRepositoryFileReader(null, null, RemoteRef.parse(RemoteRef.Type.BITBUCKET, "project/repo@master"))
-
- then:
- thrown(NullPointerException)
-
- when:
- new BitbucketRepositoryFileReader("abc", null, null)
-
- then:
- thrown(NullPointerException)
-
- when:
- new BitbucketRepositoryFileReader(null, null, null)
-
- then:
- thrown(NullPointerException)
- }
-
-}
diff --git a/core/src/test/groovy/com/optum/sourcehawk/core/repository/GithubRepositoryFileReaderSpec.groovy b/core/src/test/groovy/com/optum/sourcehawk/core/repository/GithubRepositoryFileReaderSpec.groovy
deleted file mode 100644
index d2e3e37..0000000
--- a/core/src/test/groovy/com/optum/sourcehawk/core/repository/GithubRepositoryFileReaderSpec.groovy
+++ /dev/null
@@ -1,239 +0,0 @@
-package com.optum.sourcehawk.core.repository
-
-import com.optum.sourcehawk.core.data.RemoteRef
-import org.mockserver.configuration.ConfigurationProperties
-import org.mockserver.integration.ClientAndServer
-import org.mockserver.matchers.Times
-import org.mockserver.model.HttpRequest
-import org.mockserver.model.HttpResponse
-import spock.lang.AutoCleanup
-import spock.lang.Shared
-import spock.lang.Specification
-import spock.lang.Unroll
-
-class GithubRepositoryFileReaderSpec extends Specification {
-
- @Shared
- @AutoCleanup
- ClientAndServer clientAndServer
-
- @Shared
- String enterpriseUrl
-
- def setupSpec() {
- clientAndServer = ClientAndServer.startClientAndServer("http://127.0.0.1", 8121)
- ConfigurationProperties.logLevel("WARN")
- enterpriseUrl = "${clientAndServer.remoteAddress.hostString}:${clientAndServer.port}"
- }
-
- def setup() {
- clientAndServer.reset()
- }
-
- def "supportsGlobPatterns"() {
- given:
- RemoteRef remoteRef = RemoteRef.parse(RemoteRef.Type.GITHUB, "owner/repo@main")
- GithubRepositoryFileReader githubRepositoryFileReader = new GithubRepositoryFileReader(null, enterpriseUrl, remoteRef)
-
- when:
- boolean supportsGlobPatterns = githubRepositoryFileReader.supportsGlobPatterns()
-
- then:
- !supportsGlobPatterns
- }
-
- def "exists (found)"() {
- given:
- RemoteRef remoteRef = RemoteRef.parse(RemoteRef.Type.GITHUB, "owner/repo@main")
- GithubRepositoryFileReader githubRepositoryFileReader = new GithubRepositoryFileReader(null, enterpriseUrl, remoteRef)
- clientAndServer
- .when(HttpRequest.request()
- .withMethod("HEAD")
- .withPath("/raw/owner/repo/main/README.md"),
- Times.exactly(1))
- .respond(HttpResponse.response().withStatusCode(200))
-
- when:
- boolean exists = githubRepositoryFileReader.exists("README.md")
-
- then:
- exists
- }
-
- def "exists (not found)"() {
- given:
- RemoteRef remoteRef = RemoteRef.parse(RemoteRef.Type.GITHUB, "owner/repo@nope")
- GithubRepositoryFileReader githubRepositoryFileReader = new GithubRepositoryFileReader(null, enterpriseUrl, remoteRef)
- clientAndServer
- .when(HttpRequest.request()
- .withMethod("HEAD")
- .withPath("/raw/owner/repo/main/README.md"),
- Times.exactly(1))
- .respond(HttpResponse.notFoundResponse())
-
- when:
- boolean exists = githubRepositoryFileReader.exists("README.md")
-
- then:
- !exists
- }
-
- def "read (found)"() {
- given:
- RemoteRef remoteRef = RemoteRef.parse(RemoteRef.Type.GITHUB, "owner/repo@main")
- GithubRepositoryFileReader githubRepositoryFileReader = new GithubRepositoryFileReader(null, enterpriseUrl, remoteRef)
- clientAndServer
- .when(HttpRequest.request()
- .withMethod("HEAD")
- .withPath("/raw/owner/repo/main/README.md"),
- Times.exactly(1))
- .respond(HttpResponse.response().withStatusCode(200))
- clientAndServer
- .when(HttpRequest.request()
- .withMethod("GET")
- .withPath("/raw/owner/repo/main/README.md"),
- Times.exactly(2))
- .respond(HttpResponse.response().withStatusCode(200).withBody("# Title".bytes))
-
- when:
- Optional inputStream = githubRepositoryFileReader.read("README.md")
-
- then:
- inputStream
- inputStream.isPresent()
-
- when:
- inputStream = githubRepositoryFileReader.read("/README.md")
-
- then:
- inputStream
- inputStream.isPresent()
- }
-
- def "read (not found)"() {
- given:
- RemoteRef remoteRef = RemoteRef.parse(RemoteRef.Type.GITHUB, "owner/repo@master")
- GithubRepositoryFileReader githubRepositoryFileReader = new GithubRepositoryFileReader(null, remoteRef)
- clientAndServer
- .when(HttpRequest.request()
- .withMethod("HEAD")
- .withPath("/raw/owner/repo/master/README.md"),
- Times.exactly(1))
- .respond(HttpResponse.notFoundResponse())
-
- when:
- Optional inputStream = githubRepositoryFileReader.read("README.md")
-
- then:
- !inputStream
- !inputStream.isPresent()
- }
-
- def "constructBaseUrl - public github"() {
- given:
- String githubUrl = "https://raw.githubusercontent.com"
- RemoteRef remoteRef = RemoteRef.parse(RemoteRef.Type.GITHUB, "owner/repo@main")
-
- when:
- String baseUrl = GithubRepositoryFileReader.constructBaseUrl(githubUrl, false, remoteRef)
-
- then:
- baseUrl == "https://raw.githubusercontent.com/owner/repo/main/"
- }
-
- @Unroll
- def "constructBaseUrl - enterprise github"() {
- given:
- RemoteRef remoteRef = RemoteRef.parse(RemoteRef.Type.GITHUB, "owner/repo@main")
-
- when:
- String baseUrl = GithubRepositoryFileReader.constructBaseUrl(githubUrl, true, remoteRef)
-
- then:
- baseUrl == "https://github.example.com/raw/owner/repo/main/"
-
- where:
- githubUrl << ["https://github.example.com", "https://github.example.com/"]
- }
-
- def "constructRequestProperties"() {
- when:
- Map requestProperties = GithubRepositoryFileReader.constructRequestProperties("token ", "abc")
-
- then:
- requestProperties
- requestProperties.size() == 2
- requestProperties["Accept"] == "text/plain"
- requestProperties["Authorization"] == "token abc"
- }
-
- def "constructRequestProperties - null"() {
- when:
- Map requestProperties = GithubRepositoryFileReader.constructRequestProperties("token ", null)
-
- then:
- requestProperties
- requestProperties.size() == 1
- requestProperties["Accept"] == "text/plain"
- }
-
- def "constructor - enterprise"() {
- given:
- RemoteRef remoteRef = RemoteRef.parse(RemoteRef.Type.GITHUB, "owner/repo@main")
-
- expect:
- new GithubRepositoryFileReader(null, "https://github.example.com", remoteRef)
- new GithubRepositoryFileReader("abc", "https://github.example.com", remoteRef)
- }
-
- def "constructors - null parameter"() {
- when:
- new GithubRepositoryFileReader(null, null, null)
-
- then:
- thrown(NullPointerException)
-
- when:
- new GithubRepositoryFileReader("abc", null, null)
-
- then:
- thrown(NullPointerException)
-
- when:
- new GithubRepositoryFileReader("abc", null, RemoteRef.parse(RemoteRef.Type.GITHUB, "owner/repo@main"))
-
- then:
- thrown(NullPointerException)
-
- when:
- new GithubRepositoryFileReader("abc", "https://github.example.com", null)
-
- then:
- thrown(NullPointerException)
-
- when:
- new GithubRepositoryFileReader(null, "https://github.example.com", null)
-
- then:
- thrown(NullPointerException)
-
- when:
- new GithubRepositoryFileReader(null, null, RemoteRef.parse(RemoteRef.Type.GITHUB, "owner/repo@main"))
-
- then:
- thrown(NullPointerException)
-
- when:
- new GithubRepositoryFileReader("abc", null)
-
- then:
- thrown(NullPointerException)
-
- when:
- new GithubRepositoryFileReader(null, null)
-
- then:
- thrown(NullPointerException)
- }
-
-}
diff --git a/core/src/test/groovy/com/optum/sourcehawk/core/repository/RemoteRepositoryFileReaderSpec.groovy b/core/src/test/groovy/com/optum/sourcehawk/core/repository/RemoteRepositoryFileReaderSpec.groovy
index 51592b5..ef755dc 100644
--- a/core/src/test/groovy/com/optum/sourcehawk/core/repository/RemoteRepositoryFileReaderSpec.groovy
+++ b/core/src/test/groovy/com/optum/sourcehawk/core/repository/RemoteRepositoryFileReaderSpec.groovy
@@ -1,71 +1,168 @@
package com.optum.sourcehawk.core.repository
-import spock.lang.Specification
+import org.mockserver.configuration.ConfigurationProperties
+import org.mockserver.integration.ClientAndServer
+import org.mockserver.matchers.Times
+import org.mockserver.model.HttpRequest
+import org.mockserver.model.HttpResponse
+import spock.lang.AutoCleanup
+import spock.lang.Shared
+import spock.lang.Specification
class RemoteRepositoryFileReaderSpec extends Specification {
- def "constructor"() {
- expect:
- new GenericRemoteRepositoryFileReader()
- new TrailingSlashRemoteRepositoryFileReader()
+ @Shared
+ @AutoCleanup
+ ClientAndServer clientAndServer
+
+ @Shared
+ String baseUrl
+
+ def setupSpec() {
+ clientAndServer = ClientAndServer.startClientAndServer("http://127.0.0.1", 8122)
+ ConfigurationProperties.logLevel("WARN")
+ baseUrl = "${clientAndServer.remoteAddress.hostString}:${clientAndServer.port}"
}
- def "constructor - null argument"() {
+ def "supportsGlobPatterns"() {
+ given:
+ RepositoryFileReader reader = new RemoteRepositoryFileReader("rawFileUrlTemplate", Collections.emptyMap())
+
when:
- new InvalidRemoteRepositoryFileReader()
+ boolean supportsGlobPatterns = reader.supportsGlobPatterns()
then:
- thrown(NullPointerException)
+ !supportsGlobPatterns
+ }
+
+ def "exists - found"() {
+ given:
+ String rawFileUrlTemplate = "$baseUrl/project/repo/raw/master/%s"
+ RepositoryFileReader reader = new RemoteRepositoryFileReader(rawFileUrlTemplate, Collections.emptyMap())
+ clientAndServer
+ .when(HttpRequest.request()
+ .withMethod("HEAD")
+ .withPath("/project/repo/raw/master/README.md"),
+ Times.exactly(1))
+ .respond(HttpResponse.response().withStatusCode(200))
when:
- new InvalidRemoteRepositoryFileReader2()
+ boolean exists = reader.exists("README.md")
then:
- thrown(NullPointerException)
+ exists
}
- def "getInputStream - not found"() {
+ def "exists - not found"() {
given:
- HttpURLConnection mockHttpUrlConnection = Mock()
+ String rawFileUrlTemplate = "$baseUrl/project/repo/raw/master/%s"
+ RepositoryFileReader reader = new RemoteRepositoryFileReader(rawFileUrlTemplate, Collections.emptyMap())
+ clientAndServer
+ .when(HttpRequest.request()
+ .withMethod("HEAD")
+ .withPath("/project/repo/raw/master/README.md"),
+ Times.exactly(1))
+ .respond(HttpResponse.notFoundResponse())
when:
- Optional inputStreamOptional = RemoteRepositoryFileReader.getInputStream(mockHttpUrlConnection)
+ boolean exists = reader.exists("README.md")
then:
- 1 * mockHttpUrlConnection.getInputStream() >> { throw new FileNotFoundException("404") }
- 0 * _
-
- and:
- !inputStreamOptional.isPresent()
+ !exists
}
- private static class GenericRemoteRepositoryFileReader extends RemoteRepositoryFileReader {
+ def "read - found"() {
+ given:
+ String rawFileUrlTemplate = "$baseUrl/raw/project/repo/main/%s"
+ RepositoryFileReader reader = new RemoteRepositoryFileReader(rawFileUrlTemplate, Collections.emptyMap())
+ clientAndServer
+ .when(HttpRequest.request()
+ .withMethod("HEAD")
+ .withPath("/raw/project/repo/main/README.md"),
+ Times.exactly(1))
+ .respond(HttpResponse.response().withStatusCode(200))
+ clientAndServer
+ .when(HttpRequest.request()
+ .withMethod("GET")
+ .withPath("/raw/project/repo/main/README.md"),
+ Times.exactly(2))
+ .respond(HttpResponse.response().withStatusCode(200).withBody("# Title".bytes))
+
+ when:
+ Optional inputStreamOptional = reader.read("README.md")
+
+ then:
+ inputStreamOptional
+ inputStreamOptional.isPresent()
+
+ when:
+ inputStreamOptional = reader.read("/README.md")
- protected GenericRemoteRepositoryFileReader() {
- super("https://optum.github.io")
- }
+ then:
+ inputStreamOptional
+ inputStreamOptional.isPresent()
}
- private static class TrailingSlashRemoteRepositoryFileReader extends RemoteRepositoryFileReader {
+ def "read - not found"() {
+ given:
+ String rawFileUrlTemplate = "$baseUrl/raw/project/repo/main/%s"
+ RepositoryFileReader reader = new RemoteRepositoryFileReader(rawFileUrlTemplate, Collections.emptyMap())
+ clientAndServer
+ .when(HttpRequest.request()
+ .withMethod("HEAD")
+ .withPath("/raw/project/repo/main/README.md"),
+ Times.exactly(1))
+ .respond(HttpResponse.notFoundResponse())
+
+ when:
+ Optional inputStreamOptional = reader.read("README.md")
- protected TrailingSlashRemoteRepositoryFileReader() {
- super("https://optum.github.io/")
- }
+ then:
+ !inputStreamOptional.isPresent()
}
- private static class InvalidRemoteRepositoryFileReader extends RemoteRepositoryFileReader {
+ def "getAbsoluteLocation"() {
+ given:
+ String rawFileUrlTemplate = "$baseUrl/raw/project/repo/main/%s"
+ RepositoryFileReader reader = new RemoteRepositoryFileReader(rawFileUrlTemplate, Collections.emptyMap())
+ String repositoryFilePath = "README.md"
+
+ when:
+ String absoluteLocation = reader.getAbsoluteLocation(repositoryFilePath)
+
+ then:
+ absoluteLocation
+ absoluteLocation == "$baseUrl/raw/project/repo/main/README.md"
+
+
+ when:
+ repositoryFilePath = "/path/to/file.txt"
+ absoluteLocation = reader.getAbsoluteLocation(repositoryFilePath)
- protected InvalidRemoteRepositoryFileReader() {
- super(null)
- }
+ then:
+ absoluteLocation
+ absoluteLocation == "$baseUrl/raw/project/repo/main/path/to/file.txt"
}
- private static class InvalidRemoteRepositoryFileReader2 extends RemoteRepositoryFileReader {
+ def "constructor - null parameter"() {
+ when:
+ new RemoteRepositoryFileReader("abc", null)
+
+ then:
+ thrown(NullPointerException)
+
+ when:
+ new RemoteRepositoryFileReader(null, Collections.emptyMap())
+
+ then:
+ thrown(NullPointerException)
+
+ when:
+ new RemoteRepositoryFileReader(null, null)
- protected InvalidRemoteRepositoryFileReader2() {
- super(null, Collections.emptyMap())
- }
+ then:
+ thrown(NullPointerException)
}
}
\ No newline at end of file
diff --git a/distributions/debian/pom.xml b/distributions/debian/pom.xml
index 7c27965..717f22a 100644
--- a/distributions/debian/pom.xml
+++ b/distributions/debian/pom.xml
@@ -8,7 +8,7 @@
com.optum.sourcehawk
sourcehawk-dist
- 0.6.0-SNAPSHOT
+ 0.7.0-SNAPSHOT
../pom.xml
@@ -21,7 +21,7 @@
${project.build.directory}/debian
${bintray.package}
${project.version}
- ~${git.commit.time}+${git.commit.id.abbrev}
+
amd64
@@ -38,7 +38,7 @@
com.optum.sourcehawk
sourcehawk-cli
${project.version}
- bash-completion
+ completion
sh
provided
@@ -49,15 +49,27 @@
- pl.project13.maven
- git-commit-id-plugin
-
- ${maven.build.timestamp.format}
- ${maven.multiModuleProjectDirectory}/.git
- false
- true
- ${project.build.directory}/git.properties
-
+ org.codehaus.gmavenplus
+ gmavenplus-plugin
+
+
+ save-git-information
+ validate
+
+ execute
+
+
+
+
+
+
+
+
@@ -124,7 +136,7 @@
com.optum.sourcehawk
sourcehawk-cli
- bash-completion
+ completion
sh
${debian.build.directory}/usr/share/bash-completion/completions
${debian.package}
@@ -280,95 +292,96 @@
-
-
- debian-package-release
-
-
- ci.release
-
-
-
-
-
-
-
- debian-package-snapshot
-
-
- ci.snapshot
-
-
-
-
-
- org.codehaus.mojo
- exec-maven-plugin
-
-
- dev-snapshots
-
-
-
-
-
-
-
- debian-package-publish
-
-
- ci.deploy
-
-
-
-
-
- org.codehaus.mojo
- exec-maven-plugin
-
-
- ${bintray.organization}
- ${debian.package}
- ${debian.package.version}${debian.package.version.suffix}
- ${debian.architecture},i386,x86_64
-
-
-
-
- publish-debian-buster-package
-
- exec
-
- deploy
-
- ${project.basedir}/scripts/publish-package-version-to-bintray.sh
-
- ${project.build.directory}/${debian.package}-debian-buster.deb
- deb
- buster,jessie,stretch
-
-
-
-
- publish-ubuntu-focal-package
-
- exec
-
- deploy
-
- ${project.basedir}/scripts/publish-package-version-to-bintray.sh
-
- ${project.build.directory}/${debian.package}-ubuntu-focal.deb
- ubuntu
- focal
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/distributions/docker-builders/Dockerfile-nativeimage b/distributions/docker-builders/Dockerfile-nativeimage
index d06225e..b0c52ca 100644
--- a/distributions/docker-builders/Dockerfile-nativeimage
+++ b/distributions/docker-builders/Dockerfile-nativeimage
@@ -1,6 +1,20 @@
-# Oracle GraalVM Java 8 Base Container
-ARG FROM=ghcr.io/graalvm/graalvm-ce:java8-21.2.0
-FROM ${FROM}
+# GraalVM Community Edition Base Container
+ARG FROM_VERSION=java11-21.3.0
+FROM ghcr.io/graalvm/graalvm-ce:${FROM_VERSION}
# Install native-image tool
-RUN gu install --no-progress native-image
\ No newline at end of file
+RUN gu install --no-progress native-image
+
+# Install musl libc
+RUN curl -ksL -o x86_64-linux-musl-native.tgz https://more.musl.cc/10.2.1/x86_64-linux-musl/x86_64-linux-musl-native.tgz \
+ && tar -xf x86_64-linux-musl-native.tgz -C /opt \
+ && export CC=/opt/x86_64-linux-musl-native/bin/gcc \
+ && curl -ksL -o zlib.tar.gz https://zlib.net/zlib-1.2.11.tar.gz \
+ && tar -xf zlib.tar.gz \
+ && cd zlib-1.2.11 \
+ && ./configure --prefix=/opt/x86_64-linux-musl-native --static \
+ && make \
+ && make install
+
+# Update PATH Environment Variable
+ENV PATH="$PATH:/opt/x86_64-linux-musl-native/bin"
diff --git a/distributions/docker/Dockerfile b/distributions/docker/Dockerfile
index 8bb6827..168bf95 100644
--- a/distributions/docker/Dockerfile
+++ b/distributions/docker/Dockerfile
@@ -1,23 +1,17 @@
-# glibc is required for proper DNS resolution within app
-FROM busybox:1.32.0-glibc
+FROM scratch
-# Dynamically pass in name
ARG NAME="sourcehawk"
-# Setup user and group
-ENV GROUP=${NAME} USER=${NAME}
-RUN addgroup ${GROUP} && adduser -h /home/${USER} -G ${NAME} -D ${USER}
+# Copy Group and User Files
+COPY "/etc" "/etc"
# Copy the native image executable into the image
-ARG NATIVE_IMAGE_PATH
-COPY --chown=${GROUP}:${USER} ${NATIVE_IMAGE_PATH} /usr/bin/sourcehawk
-
-# Give the native image executable permissions
-RUN chmod +x /usr/bin/${NAME}
+COPY --chown="${NAME}":"${NAME}" "target/native-image" "/entrypoint"
# Set the user and working directory
-USER ${USER}
-WORKDIR /home/${USER}
+USER "${NAME}"
+WORKDIR "/work"
# Set the native image as the entrypoint
-ENTRYPOINT ["/usr/bin/sourcehawk"]
\ No newline at end of file
+CMD ["--help"]
+ENTRYPOINT ["/entrypoint"]
\ No newline at end of file
diff --git a/distributions/docker/README.md b/distributions/docker/README.md
index ec3aa6d..7528041 100644
--- a/distributions/docker/README.md
+++ b/distributions/docker/README.md
@@ -1,15 +1,15 @@
-# Sourcehawk Alpine Docker Image
+# Sourcehawk Docker Image
### Scanning from local directory
```shell script
-docker run -v "$(pwd):/home/sourcehawk" optumopensource/sourcehawk:1.0.0-alpine
+docker run --rm -v $PWD:/work optumopensource/sourcehawk
```
Or with a custom working directory:
```shell script
-docker run -v "$(pwd):/tmp" -w /tmp optumopensource/sourcehawk:1.0.0-alpine
+docker run --rm -v $PWD:/tmp -w /tmp optumopensource/sourcehawk
```
The volume mounting is necessary in order to give the container access to the files to scan.
\ No newline at end of file
diff --git a/distributions/docker/etc/group b/distributions/docker/etc/group
new file mode 100644
index 0000000..0d9e16b
--- /dev/null
+++ b/distributions/docker/etc/group
@@ -0,0 +1 @@
+sourcehawk:x:1000:sourcehawk
\ No newline at end of file
diff --git a/distributions/docker/etc/passwd b/distributions/docker/etc/passwd
new file mode 100644
index 0000000..f96df68
--- /dev/null
+++ b/distributions/docker/etc/passwd
@@ -0,0 +1 @@
+sourcehawk:x:1000:1000:Sourcehawk User,,,:/home/sourcehawk:/entrypoint
\ No newline at end of file
diff --git a/distributions/docker/pom.xml b/distributions/docker/pom.xml
index 4412275..2485517 100644
--- a/distributions/docker/pom.xml
+++ b/distributions/docker/pom.xml
@@ -8,7 +8,7 @@
com.optum.sourcehawk
sourcehawk-dist
- 0.6.0-SNAPSHOT
+ 0.7.0-SNAPSHOT
../pom.xml
@@ -19,6 +19,7 @@
${project.version}
+ ghcr.io/optum/sourcehawk
@@ -61,25 +62,68 @@