org.specrunner.junit.SpecRunnerParametrized Maven / Gradle / Ivy
/*
SpecRunner - Acceptance Test Driven Development Tool
Copyright (C) 2011-2018 Thiago Santos
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see
* public class TestParametrized extends SpecRunnerParametrized {
*
* public TestParametrized(Entry entry) {
* super(entry);
* }
*
* // JUnit annotation
* @SuppressWarnings("unchecked")
* @Parameters
* public static Collection<Object[]> getTestFiles() {
* File inDir = new File("src/test/resources/sources"); // input directory
* File outDir = new File("src/test/resources/out"); // output directory
* // files ending with 'e.html' OR starting with 'cust' OR containing 'st'
* return merge(endsWith(inDir, "e.html", outDir), startsWith(inDir, "cust", outDir), contains(inDir, "st", outDir));
* }
* }
*
*
* @author Thiago Santos
*
*/
@RunWith(Parameterized.class)
public abstract class SpecRunnerParametrized {
/**
* File entry.
*/
protected final Entry entry;
/**
* Creates a instance by entry.
*
* @param entry
* The entry.
*/
protected SpecRunnerParametrized(Entry entry) {
this.entry = entry;
}
/**
* A execution mapping.
*
* @author Thiago Santos
*
*/
protected static final class Entry {
/**
* Entry input.
*/
protected final Object input;
/**
* Entry output.
*/
protected final Object output;
/**
* Entry configuration.
*/
protected final IConfiguration cfg;
/**
* Creates an entry.
*
* @param input
* The input file.
* @param output
* The output file.
* @param cfg
* The configuration.
*/
protected Entry(Object input, Object output, IConfiguration cfg) {
this.input = input;
this.output = output;
this.cfg = cfg;
}
@Override
public int hashCode() {
final int prime = 31;
int result = 1;
result = prime * result + ((cfg == null) ? 0 : cfg.hashCode());
result = prime * result + ((input == null) ? 0 : input.hashCode());
result = prime * result + ((output == null) ? 0 : output.hashCode());
return result;
}
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (getClass() != obj.getClass()) {
return false;
}
Entry other = (Entry) obj;
return input.equals(other.input) && output.equals(other.output);
}
}
/**
* Runs a specification.
*
*/
@Test
public void run() {
SpecRunnerJUnit.defaultRun(String.valueOf(entry.input), String.valueOf(entry.output), entry.cfg);
}
/**
* Filter types.
*
* @author Thiago Santos
*
*/
enum Filter {
/**
* Starts with a string.
*/
STARTWITH,
/**
* Contains a string.
*/
CONTAINS,
/**
* Ends with a string.
*/
ENDSWITH;
}
/**
* Filter files starting with.
*
* @param inDir
* Base directory.
* @param prefix
* Prefix.
* @param outDir
* The output directory.
* @return A collection of entries.
*/
protected static Collection startsWith(File inDir, String prefix, File outDir) {
return startsWith(inDir, prefix, outDir, SRServices.get(IConfigurationFactory.class).newConfiguration());
}
/**
* Filter files starting with.
*
* @param inDir
* Base directory.
* @param prefix
* Prefix.
* @param outDir
* The output directory.
* @param cfg
* A configuration.
* @return A collection of entries.
*/
protected static Collection startsWith(File inDir, String prefix, File outDir, IConfiguration cfg) {
return filter(inDir, prefix, Filter.STARTWITH, outDir, cfg);
}
/**
* Filter files containing a string.
*
* @param inDir
* The base directory.
* @param suffix
* The suffix.
* @param outDir
* The output directory.
* @return A collection of entries.
*/
protected static Collection contains(File inDir, String suffix, File outDir) {
return contains(inDir, suffix, outDir, SRServices.get(IConfigurationFactory.class).newConfiguration());
}
/**
* Filter files containing a string.
*
* @param inDir
* The base directory.
* @param suffix
* The suffix.
* @param outDir
* The output directory.
* @param cfg
* A configuration.
* @return A collection of entries.
*/
protected static Collection contains(File inDir, String suffix, File outDir, IConfiguration cfg) {
return filter(inDir, suffix, Filter.CONTAINS, outDir, cfg);
}
/**
* Filter files ending with.
*
* @param inDir
* The base directory.
* @param suffix
* The suffix.
* @param outDir
* The output directory.
* @return A collection of entries.
*/
protected static Collection endsWith(File inDir, String suffix, File outDir) {
return endsWith(inDir, suffix, outDir, SRServices.get(IConfigurationFactory.class).newConfiguration());
}
/**
* Filter files ending with.
*
* @param inDir
* The base directory.
* @param suffix
* The suffix.
* @param outDir
* The output directory.
* @param cfg
* A configuration.
* @return A collection of entries.
*/
protected static Collection endsWith(File inDir, String suffix, File outDir, IConfiguration cfg) {
return filter(inDir, suffix, Filter.ENDSWITH, outDir, cfg);
}
/**
* Generic filter method.
*
* @param inDir
* Base directory.
* @param str
* String.
* @param filter
* The filter type.
* @param outDir
* The output directory.
* @param cfg
* A configuration.
* @return A collection of entries.
*/
protected static Collection filter(File inDir, final String str, final Filter filter, File outDir, IConfiguration cfg) {
if (!inDir.exists()) {
throw new IllegalArgumentException("Diretory '" + inDir + "' not found.");
}
if (!outDir.exists() && !outDir.mkdirs()) {
throw new IllegalArgumentException("Diretory '" + outDir + "' could not be created.");
}
File[] accepted = inDir.listFiles(new FilenameFilter() {
@Override
public boolean accept(File dir, String name) {
switch (filter) {
case STARTWITH:
return name.startsWith(str);
case CONTAINS:
return name.contains(str);
case ENDSWITH:
return name.endsWith(str);
default:
return false;
}
}
});
List result = new LinkedList();
for (File f : accepted) {
result.add(new Object[] { new Entry(f, new File(outDir, f.getName()), cfg) });
if (UtilLog.LOG.isInfoEnabled()) {
UtilLog.LOG.info(filter + "(" + str + "): test '" + f + "' added.");
}
}
return result;
}
/**
* Merge to different collections.
*
* @param lists
* The lists.
* @return A merged collection.
*/
protected static Collection merge(Collection... lists) {
List result = new LinkedList();
if (lists != null) {
List list = new LinkedList();
for (Collection l : lists) {
for (Object[] o : l) {
Entry e = (Entry) o[0];
if (!list.contains(e)) {
list.add(e);
result.add(o);
if (UtilLog.LOG.isInfoEnabled()) {
UtilLog.LOG.info(" MERGE: test '" + e.input + "' added.");
}
} else {
if (UtilLog.LOG.isInfoEnabled()) {
UtilLog.LOG.info("IGNORE: test '" + e.input + "' duplicated.");
}
}
}
}
}
return result;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy