Yesterday I bumped up the version of Freud from 0.9 to 1.0.
Apart from finally getting round to write some wiki entries on how to start using Freud, the main addition is the support for analysis of Java class files.
Freud can now iterate over class files and parse them into a ClassFile object.
This allows assertions to inspect the constant pool, the fields and methods inside the class.
Inside every method, we can now look into the JVM instruction set, the local variables etc. and assert things like:
There should be no call to BigDecimal.equals(Object) method (i.e we don’t want to use equals – good in contexts where all we care about is the equality of the numeric value – not true object equality).
public static FreudAnalyser
doNotUseBigDecimalEquals(final AnalysedObjectIterator iterator)
{
return Freud.iterateOver(ClassFileMethod.class).
within(iterator).
assertThat(no(
hasMethodInvocation(BigDecimal.class, "equals", Object.class)));
}
or
The code should not throw any exceptions
public static FreudAnalyser
doNotThrowAnyExceptions(final AnalysedObjectIterator iterator)
{
return Freud.iterateOver(ClassFileMethod.class).within(iterator).
assertThat(no(containsInstructions(Opcode.ATHROW)));
}
also – any method named “criticalPath” must not have any branch logic
public static FreudAnalyser
specificMethodsShouldNotHaveBranchLogic(
final AnalysedObjectIterator iterator)
{
return Freud.iterateOver(ClassFileMethod.class).within(iterator).
assertThat(no(methodName().matches("criticalPath")).
or(no(containsInstructions(Opcode.IFEQ,
Opcode.IFLT,
Opcode.IFLE,
Opcode.IFNE,
Opcode.IFGT,
Opcode.IFGE,
Opcode.IFNULL,
Opcode.IFNONNULL,
Opcode.IF_ICMPEQ,
Opcode.IF_ICMPGE,
Opcode.IF_ICMPGT,
Opcode.IF_ICMPLE,
Opcode.IF_ICMPLT,
Opcode.IF_ICMPNE,
Opcode.IF_ACMPEQ,
Opcode.IF_ACMPNE,
Opcode.TABLESWITCH,
Opcode.LOOKUPSWITCH,
Opcode.GOTO,
Opcode.GOTO_W,
Opcode.JSR,
Opcode.JSR_W))));
}
etc.
This joins the list of other currently supported content types in Freud:
Text
(For asserting things like – number of lines, line length, regex queries etc.)
Java Source
(Tests may include code block source size or existence of compile time annotation etc.).
Java Class
(Analysing declared methods signatures, fields, access modifiers etc.)
Properties
(Existence of properties, inspecting values using regex etc.)
CSS
(Analysing css rule declarations, ordering, patterns and conventions etc.)
Spring config.
(Bean construction/naming conventions, and also coupled with java class assertions – existence of specific annotations for specific spring beans etc.)
What’s next?
Adding more and more custom assertions to the growing DSLs inside Freud.
So far I’ve only added assertions as I needed them.
If anyone needs an assertion that does not exist – That shouldn’t stop you.
An assertion is simply a hamcrest matcher – implement it and if its generic enough to be reused, please let me know about it so I can add it to the right DSL.