/*
* Copyright 2005 JBoss Inc
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.drools.decisiontable;
import java.io.InputStream;
import java.util.ArrayList;
import java.util.List;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import org.drools.decisiontable.parser.DefaultRuleSheetListener;
import org.drools.decisiontable.parser.RuleMatrixSheetListener;
import org.drools.decisiontable.parser.RuleSheetParserUtil;
import org.drools.decisiontable.parser.xls.ExcelParser;
import org.drools.template.model.Global;
import org.drools.template.model.Import;
import org.drools.template.parser.DataListener;
import org.junit.Test;
import org.kie.api.io.ResourceType;
import org.kie.internal.KnowledgeBase;
import org.kie.internal.KnowledgeBaseFactory;
import org.kie.internal.builder.DecisionTableConfiguration;
import org.kie.internal.builder.DecisionTableInputType;
import org.kie.internal.builder.KnowledgeBuilder;
import org.kie.internal.builder.KnowledgeBuilderError;
import org.kie.internal.builder.KnowledgeBuilderErrors;
import org.kie.internal.builder.KnowledgeBuilderFactory;
import org.kie.internal.io.ResourceFactory;
import org.kie.internal.runtime.StatefulKnowledgeSession;
import static org.junit.Assert.*;
/**
* Some basic unit tests for converter utility. Note that some of this may still
* use the drools 2.x syntax, as it is not compiled, only tested that it
* generates DRL in the correct structure (not that the DRL itself is correct).
*/
public class SpreadsheetCompilerUnitTest {
@Test
public void testLoadFromClassPath() {
final SpreadsheetCompiler converter = new SpreadsheetCompiler();
String drl = converter.compile( "/data/MultiSheetDST.xls",
InputType.XLS );
assertNotNull( drl );
assertTrue( drl.indexOf( "rule \"How cool am I_12\"" ) > drl.indexOf( "rule \"How cool am I_11\"" ) );
assertTrue( drl.indexOf( "import example.model.User;" ) > -1 );
assertTrue( drl.indexOf( "import example.model.Car;" ) > -1 );
assertTrue( drl.indexOf( "package " ) > -1 );
InputStream ins = this.getClass().getResourceAsStream( "/data/MultiSheetDST.xls" );
drl = converter.compile( false,
ins,
InputType.XLS );
assertNotNull( drl );
assertTrue( drl.indexOf( "rule \"How cool am I_12\"" ) > 0 );
assertTrue( drl.indexOf( "import example.model.User;" ) > -1 );
assertTrue( drl.indexOf( "import example.model.Car;" ) > -1 );
assertTrue( drl.indexOf( "package " ) == -1 );
}
@Test
public void testLoadSpecificWorksheet() {
final SpreadsheetCompiler converter = new SpreadsheetCompiler();
final InputStream stream = this.getClass().getResourceAsStream( "/data/MultiSheetDST.xls" );
final String drl = converter.compile( stream,
"Another Sheet" );
assertNotNull( drl );
}
@Test
public void testLoadCustomListener() {
final SpreadsheetCompiler converter = new SpreadsheetCompiler();
final InputStream stream = this.getClass().getResourceAsStream( "/data/CustomWorkbook.xls" );
final String drl = converter.compile( stream,
InputType.XLS,
new RuleMatrixSheetListener() );
assertNotNull( drl );
assertTrue( drl.indexOf( "\"matrix\"" ) != -1 );
assertTrue( drl.indexOf( "$v : FundVisibility" ) != -1 );
assertTrue( drl.indexOf( "FundType" ) != -1 );
assertTrue( drl.indexOf( "Role" ) != -1 );
}
@Test
public void testLoadCsv() {
final SpreadsheetCompiler converter = new SpreadsheetCompiler();
final InputStream stream = this.getClass().getResourceAsStream( "/data/ComplexWorkbook.csv" );
final String drl = converter.compile( stream,
InputType.CSV );
assertNotNull( drl );
// System.out.println( drl );
assertTrue( drl.indexOf( "myObject.setIsValid(1, 2)" ) > 0 );
assertTrue( drl.indexOf( "myObject.size () > 50" ) > 0 );
assertTrue( drl.indexOf( "Foo(myObject.getColour().equals(red), myObject.size () > 1)" ) > 0 );
}
@Test
public void testLoadBasicWithMergedCells() {
final SpreadsheetCompiler converter = new SpreadsheetCompiler();
final InputStream stream = this.getClass().getResourceAsStream( "/data/BasicWorkbook.xls" );
final String drl = converter.compile( stream,
InputType.XLS );
assertNotNull( drl );
System.out.println( drl );
Pattern p = Pattern.compile( ".*setIsValid\\(Y\\).*setIsValid\\(Y\\).*setIsValid\\(Y\\).*",
Pattern.DOTALL | Pattern.MULTILINE );
Matcher m = p.matcher( drl );
assertTrue( m.matches() );
assertTrue( drl.indexOf( "This is a function block" ) > -1 );
assertTrue( drl.indexOf( "global Class1 obj1;" ) > -1 );
assertTrue( drl.indexOf( "myObject.setIsValid(10-Jul-1974)" ) > -1 );
assertTrue( drl.indexOf( "myObject.getColour().equals(blue)" ) > -1 );
assertTrue( drl.indexOf( "Foo(myObject.getColour().equals(red), myObject.size () > 12\\\")" ) > -1 );
assertTrue( drl.indexOf( "b: Bar() eval(myObject.size() < 3)" ) > -1 );
assertTrue( drl.indexOf( "b: Bar() eval(myObject.size() < 9)" ) > -1 );
assertTrue( drl.indexOf( "Foo(myObject.getColour().equals(red), myObject.size () > 1)" ) < drl.indexOf( "b: Bar() eval(myObject.size() < 3)" ) );
assertTrue( drl.indexOf( "myObject.setIsValid(\"19-Jul-1992\")" ) > -1 );
}
@Test
public void testDeclaresXLS() {
final SpreadsheetCompiler converter = new SpreadsheetCompiler();
String drl = converter.compile( "DeclaresWorkbook.xls",
InputType.XLS );
assertNotNull( drl );
assertTrue( drl.indexOf( "declare Smurf name : String end" ) > -1 );
}
@Test
public void testDeclaresCSV() {
final SpreadsheetCompiler converter = new SpreadsheetCompiler();
String drl = converter.compile( "DeclaresWorkbook.csv",
InputType.CSV );
assertNotNull( drl );
assertTrue( drl.indexOf( "declare Smurf name : String end" ) > -1 );
}
@Test
public void testAttributesXLS() {
final SpreadsheetCompiler converter = new SpreadsheetCompiler();
String drl = converter.compile( "Attributes.xls",
InputType.XLS );
assertNotNull( drl );
int rule1 = drl.indexOf( "rule \"N1\"" );
assertFalse( rule1 == -1 );
assertTrue( drl.indexOf( "no-loop true",
rule1 ) > -1 );
assertTrue( drl.indexOf( "duration 100",
rule1 ) > -1 );
assertTrue( drl.indexOf( "salience 1",
rule1 ) > -1 );
assertTrue( drl.indexOf( "ruleflow-group \"RFG1\"",
rule1 ) > -1 );
assertTrue( drl.indexOf( "agenda-group \"AG1\"",
rule1 ) > -1 );
assertTrue( drl.indexOf( "timer (T1)",
rule1 ) > -1 );
assertTrue( drl.indexOf( "lock-on-active true",
rule1 ) > -1 );
assertTrue( drl.indexOf( "activation-group \"g1\"",
rule1 ) > -1 );
assertTrue( drl.indexOf( "auto-focus true",
rule1 ) > -1 );
assertTrue( drl.indexOf( "calendars \"CAL1\"",
rule1 ) > -1 );
assertTrue( drl.indexOf( "date-effective \"01-Jan-2007\"",
rule1 ) > -1 );
assertTrue( drl.indexOf( "date-expires \"31-Dec-2007\"",
rule1 ) > -1 );
int rule2 = drl.indexOf( "rule \"N2\"" );
assertFalse( rule2 == -1 );
assertTrue( drl.indexOf( "no-loop false",
rule2 ) > -1 );
assertTrue( drl.indexOf( "duration 200",
rule2 ) > -1 );
assertTrue( drl.indexOf( "salience 2",
rule2 ) > -1 );
assertTrue( drl.indexOf( "ruleflow-group \"RFG2\"",
rule2 ) > -1 );
assertTrue( drl.indexOf( "agenda-group \"AG2\"",
rule2 ) > -1 );
assertTrue( drl.indexOf( "timer (T2)",
rule2 ) > -1 );
assertTrue( drl.indexOf( "lock-on-active false",
rule2 ) > -1 );
assertTrue( drl.indexOf( "activation-group \"g2\"",
rule2 ) > -1 );
assertTrue( drl.indexOf( "auto-focus false",
rule2 ) > -1 );
assertTrue( drl.indexOf( "calendars \"CAL2\"",
rule2 ) > -1 );
assertTrue( drl.indexOf( "date-effective \"01-Jan-2012\"",
rule2 ) > -1 );
assertTrue( drl.indexOf( "date-expires \"31-Dec-2015\"",
rule2 ) > -1 );
}
@Test
public void testPropertiesXLS() {
final List<DataListener> listeners = new ArrayList<DataListener>();
final DefaultRuleSheetListener listener = new DefaultRuleSheetListener();
listeners.add( listener );
final ExcelParser parser = new ExcelParser( listeners );
final InputStream is = this.getClass().getResourceAsStream( "Properties.xls" );
parser.parseFile( is );
listener.getProperties();
final String rulesetName = listener.getProperties().getSingleProperty( DefaultRuleSheetListener.RULESET_TAG );
assertNotNull( rulesetName );
assertEquals( "Properties",
rulesetName );
final List<Import> importList = RuleSheetParserUtil.getImportList( listener.getProperties().getProperty( DefaultRuleSheetListener.IMPORT_TAG ) );
assertNotNull( importList );
assertEquals( 1,
importList.size() );
assertEquals( "java.util.List",
importList.get( 0 ).getClassName() );
final List<Global> variableList = RuleSheetParserUtil.getVariableList( listener.getProperties().getProperty( DefaultRuleSheetListener.VARIABLES_TAG ) );
assertNotNull( variableList );
assertEquals( 1,
variableList.size() );
assertEquals( "java.util.List",
variableList.get( 0 ).getClassName() );
assertEquals( "list",
variableList.get( 0 ).getIdentifier() );
final List<String> functions = listener.getProperties().getProperty( DefaultRuleSheetListener.FUNCTIONS_TAG );
assertNotNull( functions );
assertEquals( 1,
functions.size() );
assertEquals( "A function",
functions.get( 0 ) );
final List<String> queries = listener.getProperties().getProperty( DefaultRuleSheetListener.QUERIES_TAG );
assertNotNull( queries );
assertEquals( 1,
queries.size() );
assertEquals( "A query",
queries.get( 0 ) );
final List<String> declarations = listener.getProperties().getProperty( DefaultRuleSheetListener.DECLARES_TAG );
assertNotNull( declarations );
assertEquals( 1,
declarations.size() );
assertEquals( "A declared type",
declarations.get( 0 ) );
final String sequentialFlag = listener.getProperties().getSingleProperty( DefaultRuleSheetListener.SEQUENTIAL_FLAG );
assertNotNull( sequentialFlag );
assertEquals( "false",
sequentialFlag );
final String escapeQuotesFlag = listener.getProperties().getSingleProperty( DefaultRuleSheetListener.ESCAPE_QUOTES_FLAG );
assertNotNull( escapeQuotesFlag );
assertEquals( "false",
escapeQuotesFlag );
}
@Test
public void testPropertiesWithWhiteSpaceXLS() {
final List<DataListener> listeners = new ArrayList<DataListener>();
final DefaultRuleSheetListener listener = new DefaultRuleSheetListener();
listeners.add( listener );
final ExcelParser parser = new ExcelParser( listeners );
final InputStream is = this.getClass().getResourceAsStream( "PropertiesWithWhiteSpace.xls" );
parser.parseFile( is );
listener.getProperties();
final String rulesetName = listener.getProperties().getSingleProperty( DefaultRuleSheetListener.RULESET_TAG );
assertNotNull( rulesetName );
assertEquals( "Properties",
rulesetName );
final List<Import> importList = RuleSheetParserUtil.getImportList( listener.getProperties().getProperty( DefaultRuleSheetListener.IMPORT_TAG ) );
assertNotNull( importList );
assertEquals( 1,
importList.size() );
assertEquals( "java.util.List",
importList.get( 0 ).getClassName() );
final List<Global> variableList = RuleSheetParserUtil.getVariableList( listener.getProperties().getProperty( DefaultRuleSheetListener.VARIABLES_TAG ) );
assertNotNull( variableList );
assertEquals( 1,
variableList.size() );
assertEquals( "java.util.List",
variableList.get( 0 ).getClassName() );
assertEquals( "list",
variableList.get( 0 ).getIdentifier() );
final List<String> functions = listener.getProperties().getProperty( DefaultRuleSheetListener.FUNCTIONS_TAG );
assertNotNull( functions );
assertEquals( 1,
functions.size() );
assertEquals( "A function",
functions.get( 0 ) );
final List<String> queries = listener.getProperties().getProperty( DefaultRuleSheetListener.QUERIES_TAG );
assertNotNull( queries );
assertEquals( 1,
queries.size() );
assertEquals( "A query",
queries.get( 0 ) );
final List<String> declarations = listener.getProperties().getProperty( DefaultRuleSheetListener.DECLARES_TAG );
assertNotNull( declarations );
assertEquals( 1,
declarations.size() );
assertEquals( "A declared type",
declarations.get( 0 ) );
final String sequentialFlag = listener.getProperties().getSingleProperty( DefaultRuleSheetListener.SEQUENTIAL_FLAG );
assertNotNull( sequentialFlag );
assertEquals( "false",
sequentialFlag );
final String escapeQuotesFlag = listener.getProperties().getSingleProperty( DefaultRuleSheetListener.ESCAPE_QUOTES_FLAG );
assertNotNull( escapeQuotesFlag );
assertEquals( "false",
escapeQuotesFlag );
}
@Test
public void testProcessSheetForExtremeLowNumbers() {
final SpreadsheetCompiler converter = new SpreadsheetCompiler();
final InputStream stream = this.getClass().getResourceAsStream( "/data/BasicWorkbook_with_low_values.xls" );
final String drl = converter.compile( stream,
InputType.XLS );
assertNotNull( drl );
System.out.println( drl );
// Should parse the correct number
assertTrue( drl.indexOf( "myObject.size() < 0" ) == -1 );
assertTrue( drl.indexOf( "myObject.size() < 8.0E-11" ) > -1 );
assertTrue( drl.indexOf( "myObject.size() < 9.0E-7" ) > -1 );
assertTrue( drl.indexOf( "myObject.size() < 3.0E-4" ) > -1 );
}
@Test
public void testNegativeNumbers() throws Exception {
KnowledgeBase kbase = readKnowledgeBase( "/data/DT_WithNegativeNumbers.xls" );
StatefulKnowledgeSession ksession = kbase.newStatefulKnowledgeSession();
IntHolder i1 = new IntHolder( 1 );
IntHolder i2 = new IntHolder( -1 );
ksession.insert( i1 );
ksession.insert( i2 );
ksession.fireAllRules();
}
@Test
public void testOOXMLParseCellValue() {
final SpreadsheetCompiler converter = new SpreadsheetCompiler();
String drl = converter.compile( "/data/BZ963584.xls",
InputType.XLS );
assertNotNull( drl );
}
@Test
public void testNoConstraintsEmptyCells() {
final SpreadsheetCompiler converter = new SpreadsheetCompiler();
/**
* +--------------+--------------+
* | CONDITION | CONDITION |
* +--------------+--------------+
* | Person |
* +--------------+--------------+
* | name | age |
* +--------------+--------------+
* | <empty> | 55 |
* | Fred | <empty> |
* | Fred | 55 |
* | <empty> | <empty> |
* +--------------+--------------+
*/
String drl = converter.compile( "/data/NoConstraintsEmptyCells.xls",
InputType.XLS );
assertNotNull( drl );
final String expected = "package Some_business_rules;\n" +
"//generated from Decision Table\n" +
"import org.drools.decisiontable.Person;\n" +
"// rule values at C10, header at C5\n" +
"rule \"Cheese fans_10\"\n" +
" when\n" +
" Person(age == \"55\")\n" +
" then\n" +
"end\n" +
"// rule values at C11, header at C5\n" +
"rule \"Cheese fans_11\"\n" +
" when\n" +
" Person(name == \"Fred\")\n" +
" then\n" +
"end\n" +
"// rule values at C12, header at C5\n" +
"rule \"Cheese fans_12\"\n" +
" when\n" +
" Person(name == \"Fred\", age == \"55\")\n" +
" then\n" +
"end";
//No Pattern generated when all constraints have empty values
assertEqualsIgnoreWhitespace( expected,
drl );
}
@Test
public void testNoConstraintsSpacesInCells() {
final SpreadsheetCompiler converter = new SpreadsheetCompiler();
/**
* +--------------+--------------+
* | CONDITION | CONDITION |
* +--------------+--------------+
* | Person |
* +--------------+--------------+
* | name | age |
* +--------------+--------------+
* | <spaces> | 55 |
* | Fred | <spaces> |
* | Fred | 55 |
* | <spaces> | <spaces> |
* +--------------+--------------+
*/
String drl = converter.compile( "/data/NoConstraintsSpacesInCells.xls",
InputType.XLS );
assertNotNull( drl );
final String expected = "package Some_business_rules;\n" +
"//generated from Decision Table\n" +
"import org.drools.decisiontable.Person;\n" +
"// rule values at C10, header at C5\n" +
"rule \"Cheese fans_10\"\n" +
" when\n" +
" Person(age == \"55\")\n" +
" then\n" +
"end\n" +
"// rule values at C11, header at C5\n" +
"rule \"Cheese fans_11\"\n" +
" when\n" +
" Person(name == \"Fred\")\n" +
" then\n" +
"end\n" +
"// rule values at C12, header at C5\n" +
"rule \"Cheese fans_12\"\n" +
" when\n" +
" Person(name == \"Fred\", age == \"55\")\n" +
" then\n" +
"end";
//No Pattern generated when all constraints have empty values
assertEqualsIgnoreWhitespace( expected,
drl );
}
@Test
public void testNoConstraintsDelimitedSpacesInCells() {
final SpreadsheetCompiler converter = new SpreadsheetCompiler();
/**
* +--------------+--------------+
* | CONDITION | CONDITION |
* +--------------+--------------+
* | Person |
* +--------------+--------------+
* | name | age |
* +--------------+--------------+
* | " " | 55 |
* | Fred | " " |
* | Fred | 55 |
* | " " | " " |
* | "" | 55 |
* | Fred | "" |
* +--------------+--------------+
*/
String drl = converter.compile( "/data/NoConstraintsDelimitedSpacesInCells.xls",
InputType.XLS );
assertNotNull( drl );
final String expected = "package Some_business_rules;\n" +
"//generated from Decision Table\n" +
"import org.drools.decisiontable.Person;\n" +
"// rule values at C10, header at C5\n" +
"rule \"Cheese fans_10\"\n" +
" when\n" +
" Person(name == \" \", age == \"55\")\n" +
" then\n" +
"end\n" +
"// rule values at C11, header at C5\n" +
"rule \"Cheese fans_11\"\n" +
" when\n" +
" Person(name == \"Fred\", age == \"\")\n" +
" then\n" +
"end\n" +
"// rule values at C12, header at C5\n" +
"rule \"Cheese fans_12\"\n" +
" when\n" +
" Person(name == \"Fred\", age == \"55\")\n" +
" then\n" +
"end\n" +
"// rule values at C13, header at C5\n" +
"rule \"Cheese fans_13\"\n" +
" when\n" +
" Person(name == \" \", age == \"\")\n" +
" then\n" +
"end\n" +
"// rule values at C14, header at C5\n" +
"rule \"Cheese fans_14\"\n" +
" when\n" +
" Person(name == \"\", age == \"55\")\n" +
" then\n" +
"end\n" +
"// rule values at C15, header at C5\n" +
"rule \"Cheese fans_15\"\n" +
" when\n" +
" Person(name == \"Fred\", age == \"\")\n" +
" then\n" +
"end";
assertEqualsIgnoreWhitespace( expected,
drl );
}
public static class IntHolder {
private int value;
public IntHolder( int i ) {
value = i;
}
public int getValue() {
return value;
}
public void setValue( int value ) {
this.value = value;
}
@Override
public String toString() {
return "IntHolder [value=" + value + "]";
}
}
private KnowledgeBase readKnowledgeBase( String resource ) throws Exception {
KnowledgeBuilder kbuilder = KnowledgeBuilderFactory.newKnowledgeBuilder();
DecisionTableConfiguration config = KnowledgeBuilderFactory.newDecisionTableConfiguration();
config.setInputType( DecisionTableInputType.XLS );
kbuilder.add( ResourceFactory.newClassPathResource( resource, getClass() ), ResourceType.DTABLE,
config );
KnowledgeBuilderErrors errors = kbuilder.getErrors();
if ( errors.size() > 0 ) {
for ( KnowledgeBuilderError error : errors ) {
System.err.println( error );
}
throw new IllegalArgumentException( "Could not parse knowledge." );
}
KnowledgeBase kbase = KnowledgeBaseFactory.newKnowledgeBase();
kbase.addKnowledgePackages( kbuilder.getKnowledgePackages() );
return kbase;
}
private void assertEqualsIgnoreWhitespace( final String expected,
final String actual ) {
final String cleanExpected = expected.replaceAll( "\\s+",
"" );
final String cleanActual = actual.replaceAll( "\\s+",
"" );
assertEquals( cleanExpected,
cleanActual );
}
}