bartek/esa-tool
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

2: Add --exclude option and --help

Browse Source
This commit is contained in:
Bartłomiej Pluta
2019-03-30 09:49:33 +01:00
parent 01f236a44f
commit 5b90131e02
3 changed files with 67 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
src/main/java/com/bartek/esa/EsaMain.java
View File

@@ -1,10 +1,10 @@
package com.bartek.esa;
import com.bartek.esa.cli.model.CliArgsOptions;
import com.bartek.esa.dispatcher.dispatcher.MethodDispatcher;
import com.bartek.esa.dispatcher.model.DispatcherActions;
import com.bartek.esa.cli.parser.CliArgsParser;
import com.bartek.esa.di.DaggerDependencyInjector;
import com.bartek.esa.dispatcher.dispatcher.MethodDispatcher;
import com.bartek.esa.dispatcher.model.DispatcherActions;
import javax.inject.Inject;

12
src/main/java/com/bartek/esa/cli/model/CliArgsOptions.java
View File

@@ -3,11 +3,15 @@ package com.bartek.esa.cli.model;
import lombok.Builder;
import lombok.Data;
import java.util.Collections;
import java.util.List;
@Data
@Builder
public class CliArgsOptions {
private String sourceAnalysisDirectory;
private String apkAuditFile;
private List<String> excludes;
public boolean isSourceAnalysis() {
return sourceAnalysisDirectory != null;
@@ -16,4 +20,12 @@ public class CliArgsOptions {
public boolean isApkAudit() {
return apkAuditFile != null;
}
public static CliArgsOptions empty() {
return CliArgsOptions.builder()
.sourceAnalysisDirectory(null)
.apkAuditFile(null)
.excludes(Collections.emptyList())
.build();
}
}

61
src/main/java/com/bartek/esa/cli/parser/CliArgsParser.java
View File

@@ -1,39 +1,66 @@
package com.bartek.esa.cli.parser;
import com.bartek.esa.cli.model.CliArgsOptions;
import com.bartek.esa.error.EsaException;
import io.vavr.control.Try;
import org.apache.commons.cli.*;
import javax.inject.Inject;
import static java.util.Arrays.asList;
import static java.util.Collections.emptyList;
public class CliArgsParser {
private static final String SRC_OPT = "src";
private static final String APK_OPT = "apk";
private static final String EXCLUDE_OPT = "exclude";
private static final String HELP_OPT = "help";
@Inject
public CliArgsParser() {}
public CliArgsOptions parse(String[] args) {
CommandLine command = Try.of(() -> new DefaultParser().parse(prepareOptions(), args))
.getOrElseThrow(EsaException::new);
try {
CommandLine command = new DefaultParser().parse(prepareOptions(), args);
return CliArgsOptions.builder()
.sourceAnalysisDirectory(command.hasOption(SRC_OPT) ? command.getOptionValue(SRC_OPT) : null)
.apkAuditFile(command.hasOption(APK_OPT) ? command.getOptionValue(APK_OPT) : null)
.build();
if (command.hasOption(HELP_OPT)) {
printHelp();
return CliArgsOptions.empty();
}
boolean isNeitherAuditNorAnalysis = !command.hasOption(SRC_OPT) && !command.hasOption(APK_OPT);
if (isNeitherAuditNorAnalysis) {
printHelp();
return CliArgsOptions.empty();
}
return CliArgsOptions.builder()
.sourceAnalysisDirectory(command.hasOption(SRC_OPT) ? command.getOptionValue(SRC_OPT) : null)
.apkAuditFile(command.hasOption(APK_OPT) ? command.getOptionValue(APK_OPT) : null)
.excludes(command.hasOption(EXCLUDE_OPT) ? asList(command.getOptionValues(EXCLUDE_OPT)) : emptyList())
.build();
} catch (ParseException e) {
printHelp();
return CliArgsOptions.empty();
}
}
private void printHelp() {
HelpFormatter formatter = new HelpFormatter();
formatter.printHelp("esa", prepareOptions(), true);
}
private Options prepareOptions() {
Options options = new Options();
options.addOption(source());
options.addOption(apk());
options.addOption(exclude());
options.addOption(help());
return options;
}
private Option source() {
return Option.builder()
.longOpt(SRC_OPT)
.argName("SOURCE_PATH")
.hasArg()
.desc("perform analysis for Java code and XML resources")
.build();
@@ -42,8 +69,26 @@ public class CliArgsParser {
private Option apk() {
return Option.builder()
.longOpt(APK_OPT)
.argName("APK_PATH")
.hasArg()
.desc("perform audit for compiled APK file")
.build();
}
private Option exclude() {
return Option.builder()
.longOpt(EXCLUDE_OPT)
.argName("CODES")
.numberOfArgs(Option.UNLIMITED_VALUES)
.desc("exclude particular security checks from audit/analysis")
.build();
}
private Option help() {
return Option.builder()
.longOpt(HELP_OPT)
.argName("h")
.desc("print this help")
.build();
}
}