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

Jump to bottom

Refactor: inputs management FIX #798 #808

Merged
merged 19 commits into from
Jun 10, 2019
Merged

Refactor: inputs management FIX #798 #808

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
c2cce43
feat: add setup methods to set all the values that come from the comm…
danglotb May 28, 2019
bc7d07f
refactor: no more use of camel case in options
danglotb May 28, 2019
e05ea09
refactor: all the configuration in done now in one place
danglotb May 28, 2019
2eb6ba5
refactor: the example is now done as a normal configuration to avoid …
danglotb May 28, 2019
99465e9
style: remove unused imports
danglotb May 28, 2019
a193189
fix: update API in dspot-prettifier
danglotb May 28, 2019
d77b46e
test: update command line option
danglotb May 29, 2019
9436bf8
fix: check not null
danglotb May 29, 2019
8f1da92
fix: the key of with comment option
danglotb May 29, 2019
562e81b
fix: do not always use the pit mutant score selector
danglotb May 29, 2019
ba30560
test: update test with new command line option name
danglotb May 30, 2019
10716b2
fix: use initialize
danglotb May 30, 2019
dadc1dd
fix: check the input of test criterion before creating test criterion
danglotb May 30, 2019
d2d6b69
style: remove unused imports
danglotb May 30, 2019
b4d4b05
feat: let now the user to specify an absolute path for others paths
danglotb May 30, 2019
4a316af
refactor: factorize the check and substring
danglotb Jun 5, 2019
b5e5bae
fix: substring now paths to have relative path instead of absolute paths
danglotb Jun 5, 2019
df0f55b
refactor: factorize the code to manage relative paths and make it vis…
danglotb Jun 5, 2019
d7bd585
fix: change absolute paths by relative paths
danglotb Jun 5, 2019
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
186 changes: 98 additions & 88 deletions dspot-maven/src/main/java/eu/stamp_project/DSpotMojo.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,8 @@
package eu.stamp_project;

import eu.stamp_project.dspot.selector.PitMutantScoreSelector;
import eu.stamp_project.utils.AmplificationHelper;
import eu.stamp_project.utils.DSpotUtils;
import eu.stamp_project.utils.options.AmplifierEnum;
import eu.stamp_project.utils.options.BudgetizerEnum;
import eu.stamp_project.utils.options.JSAPOptions;
import eu.stamp_project.utils.options.SelectorEnum;
import eu.stamp_project.utils.options.*;
import eu.stamp_project.utils.program.ConstantsProperties;
import eu.stamp_project.utils.program.InputConfiguration;
import org.apache.commons.io.FilenameUtils;
Expand All @@ -20,7 +16,6 @@
import org.jetbrains.annotations.NotNull;

import java.io.*;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.Properties;
Expand All @@ -30,24 +25,24 @@
public class DSpotMojo extends AbstractMojo {

/**
* [optional] specify the path to the configuration file (format Java properties) of the target project (e.g. ./foo.properties).
* [mandatory] specify the path to the configuration file (format Java properties) of the target project (e.g. ./foo.properties).
*/
@Parameter(property = "path-to-properties", defaultValue = "")
@Parameter(property = "path-to-properties")
private String pathToProperties;

/**
* [optional] specify the list of amplifiers to use. Default with all available amplifiers.
* - StringLiteralAmplifier
* - NumberLiteralAmplifier
* - CharLiteralAmplifier
* - BooleanLiteralAmplifier
* - AllLiteralAmplifiers
* [optional] specify the list of amplifiers to use. By default, DSpot does not use any amplifiers (None) and applies only assertion amplification.
* Possible values are:
* - MethodAdd
* - MethodRemove
* - TestDataMutator (deprecated)
* - TestDataMutator
* - MethodGeneratorAmplifier
* - ReturnValueAmplifier
* - ReplacementAmplifier
* - StringLiteralAmplifier
* - NumberLiteralAmplifier
* - BooleanLiteralAmplifier
* - CharLiteralAmplifier
* - AllLiteralAmplifiers
* - NullifierAmplifier
* - None
*/
Expand All @@ -61,17 +56,31 @@ public class DSpotMojo extends AbstractMojo {
private Integer iteration;

/**
* [optional] specify the test adequacy criterion to be maximized with amplification
* [optional] specify the test adequacy criterion to be maximized with amplification.
* Possible values are:
* - PitMutantScoreSelector
* - JacocoCoverageSelector
* - TakeAllSelector
* - ChangeDetectorSelector
*/
@Parameter(defaultValue = "PitMutantScoreSelector", property = "test-criterion")
private String testCriterion;

/**
* [optional] specify a Bugdetizer.
* Possible values are:
* - RandomBudgetizer
* - TextualDistanceBudgetizer
* - SimpleBudgetizer
* [optional] specify the Pit output format.
* Possible values are:
* - XML
* - CSV
*/
@Parameter(defaultValue = "XML", property = "pit-output-format")
private String pitOutputFormat;

/**
* [optional] specify a Bugdetizer.
* Possible values are:
* - RandomBudgetizer
* - TextualDistanceBudgetizer
* - SimpleBudgetizer
*/
@Parameter(defaultValue = "RandomBudgetizer", property = "budgetizer")
private String budgetizer;
Expand All @@ -91,8 +100,8 @@ public class DSpotMojo extends AbstractMojo {
/**
* specify the test cases to amplify
*/
@Parameter(property = "cases")
private List<String> cases;
@Parameter(property = "test-cases")
private List<String> testCases;

/**
* [optional] specify the output folder
Expand All @@ -101,21 +110,21 @@ public class DSpotMojo extends AbstractMojo {
private String outputPath;

/**
* [optional] if enabled, DSpot will remove the out directory if exists, else it will append the results to the exist files. (default: off)
* [optional] if enabled, DSpot will remove the out directory if exists, else it will append the results to the exist files.
*/
@Parameter(defaultValue = "false", property = "clean")
private Boolean clean;

/**
* [optional, expert mode] specify the path to the .csv of the original result of Pit Test. If you use this option the selector will be forced to PitMutantScoreSelector
* [optional, expert mode] specify the path to the .xml or .csv of the original result of Pit Test. If you use this option the selector will be forced to PitMutantScoreSelector
*/
@Parameter(property = "path-pit-result")
private String pathPitResult;

/**
* [optional, expert] enable this option will make DSpot computing the mutation score of only one test class (the first pass through --test command line option)
*/
@Parameter(defaultValue = "false", property = "targetOneTestClass")
@Parameter(defaultValue = "false", property = "target-one-test-class")
private Boolean targetOneTestClass;

/**
Expand All @@ -124,10 +133,16 @@ public class DSpotMojo extends AbstractMojo {
@Parameter(defaultValue = "true", property = "descartes")
private Boolean descartes;

/**
* Enable the gregor engine for Pit Mutant Score Selector.
*/
@Parameter(defaultValue = "false", property = "gregor")
private Boolean gregor;

/**
* [optional] specify the automatic builder to build the project
*/
@Parameter(defaultValue = "MavenBuilder", property = "automatic-builder")
@Parameter(defaultValue = "", property = "automatic-builder")
private String automaticBuilder;

/**
Expand All @@ -139,13 +154,13 @@ public class DSpotMojo extends AbstractMojo {
/**
* specify a seed for the random object (used for all randomized operation)
*/
@Parameter(defaultValue = "23", property = "randomSeed")
@Parameter(defaultValue = "23", property = "random-seed")
private Long randomSeed;

/**
* specify the timeout value of the degenerated tests in millisecond
*/
@Parameter(defaultValue = "10000", property = "timeOut")
@Parameter(defaultValue = "10000", property = "time-out")
private Integer timeOut;

/**
Expand Down Expand Up @@ -188,10 +203,10 @@ public class DSpotMojo extends AbstractMojo {
* If enabled, DSpot will use maven to execute the tests.
*/
@Parameter(defaultValue = "false", property = "use-maven-to-exe-test")
private Boolean useMavenToExeTest = false;
private Boolean useMavenToExeTest;

/**
* If enabled, DSpot will generate assertions for values that seems like to be paths.
* If enabled, DSpot will generate assertions for values that seems like to be paths.
*/
@Parameter(defaultValue = "false", property = "allow-path-in-assertions")
private Boolean allowPathInAssertions;
Expand Down Expand Up @@ -246,51 +261,41 @@ public void execute() {
return;
}
}

if (this.amplifiers.size() == 1 &&
this.amplifiers.get(0).contains(AmplificationHelper.PATH_SEPARATOR)) {
this.amplifiers = Arrays.stream(this.amplifiers.get(0).split(AmplificationHelper.PATH_SEPARATOR))
.collect(Collectors.toList());
}
try {
InputConfiguration.initialize(properties)
.setAmplifiers(AmplifierEnum.buildAmplifiersFromString(new ArrayList<>(this.amplifiers)))
.setNbIteration(this.iteration)
.setTestClasses(this.test)
.setBudgetizer(BudgetizerEnum.valueOf(this.budgetizer))
.setTestCases(this.cases)
.setSeed(this.randomSeed)
.setTimeOutInMs(this.timeOut)
.setBuilderName(this.automaticBuilder)
.setMaxTestAmplified(this.maxTestAmplified)
.setClean(this.clean)
.setMinimize(this.noMinimize)
.setVerbose(this.verbose)
.setUseWorkingDirectory(this.workingDirectory)
.setWithComment(this.withComment)
.setDescartesMode(this.descartes)
.setGenerateAmplifiedTestClass(this.generateNewTestClass)
.setKeepOriginalTestMethods(this.keepOriginalTestMethods)
.setUseMavenToExecuteTest(this.useMavenToExeTest)
.setTargetOneTestClass(this.targetOneTestClass)
.setAllowPathInAssertion(this.allowPathInAssertions);

InputConfiguration.get().setOutputDirectory(
ConstantsProperties.OUTPUT_DIRECTORY.get(properties).isEmpty() ?
this.outputPath : ConstantsProperties.OUTPUT_DIRECTORY.get(properties));

if (this.pathPitResult != null && !this.pathPitResult.isEmpty()) {
InputConfiguration.get().setSelector(new PitMutantScoreSelector(this.pathPitResult,
this.pathPitResult.endsWith(".xml") ?
PitMutantScoreSelector.OutputFormat.XML : PitMutantScoreSelector.OutputFormat.CSV,
PitMutantScoreSelector.OutputFormat.XML)
);
} else {
InputConfiguration.get().setSelector(SelectorEnum.valueOf(this.testCriterion).buildSelector());
}

if (!this.pathToSecondVersion.isEmpty()) {
InputConfiguration.get().setAbsolutePathToSecondVersionProjectRoot(this.pathToSecondVersion);
}
Configuration.configure(
properties,
this.amplifiers,
this.testCriterion,
this.budgetizer,
this.pitOutputFormat,
this.pathPitResult,
this.AUTOMATIC_BUILDER_NAME,
this.outputPath,
this.iteration,
this.randomSeed,
this.timeOut,
this.maxTestAmplified,
this.clean,
this.verbose,
this.workingDirectory,
this.withComment,
this.generateNewTestClass,
this.keepOriginalTestMethods,
this.gregor,
this.descartes,
this.useMavenToExeTest,
this.targetOneTestClass,
this.allowPathInAssertions,
this.test,
this.testCases
);

if (!this.pathToTestListCsv.isEmpty()) {
// clear both list of test classes and test cases
Expand All @@ -312,35 +317,40 @@ public void execute() {
} catch (Exception e) {
throw new RuntimeException(e);
}
// global report handling
Main.GLOBAL_REPORT.output();
Main.GLOBAL_REPORT.reset();
}

// visible for testing...
@NotNull
Properties initializeProperties() {
Properties properties = new Properties();
final String absolutePathProjectRoot = project.getBasedir().getAbsolutePath();
properties.setProperty(ConstantsProperties.PROJECT_ROOT_PATH.getName(), absolutePathProjectRoot);
final Build build = project.getBuild();
properties.setProperty(ConstantsProperties.SRC_CODE.getName(),
DSpotUtils.removeProjectRootIfAbsoluteAndAddSeparator(absolutePathProjectRoot, build.getSourceDirectory())
);
properties.setProperty(ConstantsProperties.TEST_SRC_CODE.getName(),
DSpotUtils.removeProjectRootIfAbsoluteAndAddSeparator(absolutePathProjectRoot, build.getTestSourceDirectory())
);
properties.setProperty(ConstantsProperties.SRC_CLASSES.getName(),
DSpotUtils.removeProjectRootIfAbsoluteAndAddSeparator(absolutePathProjectRoot, build.getOutputDirectory())
);
properties.setProperty(ConstantsProperties.TEST_CLASSES.getName(),
DSpotUtils.removeProjectRootIfAbsoluteAndAddSeparator(absolutePathProjectRoot, build.getTestOutputDirectory())
);
// TODO checks that we can use an empty module for multi module project
// TODO the guess here is that the user will launch the plugin from the root of the targeted module
// TODO and thus, we do not need to compute the relative path from its parents
// TODO however, it may lacks some dependencies and the user should run a resolve dependency goal
// TODO before using the dspot plugin
// TODO we must maybe need to use a correct lifecycle
properties.setProperty(ConstantsProperties.MODULE.getName(), "");
if (this.pathToProperties != null && !this.pathToProperties.isEmpty()) {
try {
properties.load(new FileInputStream(this.pathToProperties));
} catch (IOException e) {
e.printStackTrace();
}
} else {
properties.setProperty(ConstantsProperties.PROJECT_ROOT_PATH.getName(), project.getBasedir().getAbsolutePath());
final Build build = project.getBuild();
properties.setProperty(ConstantsProperties.SRC_CODE.getName(), build.getSourceDirectory());
properties.setProperty(ConstantsProperties.TEST_SRC_CODE.getName(), build.getTestSourceDirectory());
properties.setProperty(ConstantsProperties.SRC_CLASSES.getName(), build.getOutputDirectory());
properties.setProperty(ConstantsProperties.TEST_CLASSES.getName(), build.getTestOutputDirectory());
// TODO checks that we can use an empty module for multi module project
// TODO the guess here is that the user will launch the plugin from the root of the targeted module
// TODO and thus, we do not need to compute the relative path from its parents
// TODO however, it may lacks some dependencies and the user should run a resolve dependency goal
// TODO before using the dspot plugin
// TODO we must maybe need to use a correct lifecycle
properties.setProperty(ConstantsProperties.MODULE.getName(), "");
}
return properties;
}
Expand Down Expand Up @@ -369,7 +379,7 @@ void setTestClassesNames(List<String> test) {
}

void setTestMethods(List<String> cases) {
this.cases = cases;
this.testCases = cases;
}

void setVerbose(Boolean verbose) {
Expand Down
8 changes: 4 additions & 4 deletions dspot-maven/src/test/java/eu/stamp_project/MultiModuleDSpotMojoTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,13 +35,13 @@ public void testOnMultiModuleParent() throws Exception {
assertNotNull(properties.get(ConstantsProperties.PROJECT_ROOT_PATH.getName()));
assertEquals(testPom.getAbsolutePath(), properties.get(ConstantsProperties.PROJECT_ROOT_PATH.getName()));
assertNotNull(properties.get(ConstantsProperties.SRC_CODE.getName()));
assertEquals(testPom.getAbsolutePath() + "/src/main/java", properties.get(ConstantsProperties.SRC_CODE.getName()));
assertEquals("src/main/java/", properties.get(ConstantsProperties.SRC_CODE.getName()));
assertNotNull(properties.get(ConstantsProperties.TEST_SRC_CODE.getName()));
assertEquals(testPom.getAbsolutePath() + "/src/test/java", properties.get(ConstantsProperties.TEST_SRC_CODE.getName()));
assertEquals("src/test/java/", properties.get(ConstantsProperties.TEST_SRC_CODE.getName()));
assertNotNull(properties.get(ConstantsProperties.SRC_CLASSES.getName()));
assertEquals(testPom.getAbsolutePath() + "/target/classes", properties.get(ConstantsProperties.SRC_CLASSES.getName()));
assertEquals("target/classes/", properties.get(ConstantsProperties.SRC_CLASSES.getName()));
assertNotNull(properties.get(ConstantsProperties.TEST_CLASSES.getName()));
assertEquals(testPom.getAbsolutePath() + "/target/test-classes", properties.get(ConstantsProperties.TEST_CLASSES.getName()));
assertEquals("target/test-classes/", properties.get(ConstantsProperties.TEST_CLASSES.getName()));
assertNotNull(properties.get(ConstantsProperties.MODULE.getName()));
assertEquals("", properties.get(ConstantsProperties.MODULE.getName()));
}
Expand Down
4 changes: 1 addition & 3 deletions dspot-prettifier/src/main/java/eu/stamp_project/prettifier/options/JSAPOptions.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ public class JSAPOptions extends eu.stamp_project.utils.options.JSAPOptions {
* @param args command line arguments. Refer to the README on the github page or use --help command line option to display all the accepted arguments.
* @return always true
*/
public static boolean parse(String[] args) {
public static void parse(String[] args) {
SplittedCommandLineOptions splittedOptions = new SplittedCommandLineOptions(args);
System.out.println(splittedOptions);
eu.stamp_project.utils.options.JSAPOptions.parse(splittedOptions.getDSpotOptions());
Expand All @@ -44,8 +44,6 @@ public static boolean parse(String[] args) {
.setRelativePathToModelForCode2Vec(jsapConfig.getString("path-to-code2vec-model"));

System.out.println(InputConfiguration.get());

return true;
}

public static void showUsage() {
Expand Down
Loading