org.assertj.assertions.generator

Class BaseAssertionGenerator

java.lang.Object

org.assertj.assertions.generator.BaseAssertionGenerator

All Implemented Interfaces:

AssertionGenerator, AssertionsEntryPointGenerator

public class BaseAssertionGenerator
extends Object
implements AssertionGenerator, AssertionsEntryPointGenerator

Constructor Summary

Constructors

Constructor and Description
BaseAssertionGenerator() Creates a new BaseAssertionGenerator with default templates directory.
BaseAssertionGenerator(String templatesDirectory) Creates a new BaseAssertionGenerator with the templates from the given directory.

Method Summary

Modifier and Type	Method and Description
String	generateAssertionsEntryPointClassContentFor(Set<ClassDescription> classDescriptionSet, AssertionsEntryPointType assertionsEntryPointType, String entryPointClassPackage) Returns the assertions entry point class content for the given ClassDescription set.
File	generateAssertionsEntryPointClassFor(Set<ClassDescription> classDescriptionSet, AssertionsEntryPointType assertionsEntryPointType, String entryPointClassPackage) Same as AssertionsEntryPointGenerator.generateAssertionsEntryPointClassContentFor(Set, AssertionsEntryPointType, String) but in addition create the corresponding java class file.
protected void	generateAssertionsForDeclaredFieldsOf(StringBuilder contentBuilder, ClassDescription classDescription)
protected void	generateAssertionsForDeclaredGettersOf(StringBuilder contentBuilder, ClassDescription classDescription)
protected void	generateAssertionsForFields(StringBuilder assertionsForPublicFields, Set<FieldDescription> fields, ClassDescription classDescription)
protected void	generateAssertionsForFieldsOf(StringBuilder contentBuilder, ClassDescription classDescription)
protected void	generateAssertionsForGetters(StringBuilder assertionsForGetters, Set<GetterDescription> getters, ClassDescription classDescription)
protected void	generateAssertionsForGettersOf(StringBuilder contentBuilder, ClassDescription classDescription)
String	generateCustomAssertionContentFor(ClassDescription classDescription) Builds and returns the custom assertion java file content for the given ClassDescription.
File	generateCustomAssertionFor(ClassDescription classDescription) Builds and returns the custom assertion java file for the given ClassDescription.
String[]	generateHierarchicalCustomAssertionContentFor(ClassDescription classDescription, Set<com.google.common.reflect.TypeToken<?>> classes) Generates hierarchical assertion classes for the class represented by the given classDescription.
File[]	generateHierarchicalCustomAssertionFor(ClassDescription classDescription, Set<com.google.common.reflect.TypeToken<?>> allClasses) Generates hierarchical assertion classes for the class represented by the given classDescription.
void	register(Template template) Registers a template in the internal TemplateRegistry so that customers can override default templates.
void	setDirectoryWhereAssertionFilesAreGenerated(File targetBaseDirectory)
void	setGenerateAssertionsForAllFields(boolean generateAssertionsForAllFields)
void	setGeneratedAssertionsPackage(String generatedAssertionsPackage)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BaseAssertionGenerator

public BaseAssertionGenerator()
                       throws IOException

Creates a new BaseAssertionGenerator with default templates directory.

Throws:

IOException - if some template file could not be found or read

BaseAssertionGenerator

public BaseAssertionGenerator(String templatesDirectory)
                       throws IOException

Creates a new BaseAssertionGenerator with the templates from the given directory.

Parameters:

templatesDirectory - path where to find templates

Throws:

IOException - if some template file could not be found or read

Method Detail

setDirectoryWhereAssertionFilesAreGenerated

public void setDirectoryWhereAssertionFilesAreGenerated(File targetBaseDirectory)

setGenerateAssertionsForAllFields

public void setGenerateAssertionsForAllFields(boolean generateAssertionsForAllFields)

setGeneratedAssertionsPackage

public void setGeneratedAssertionsPackage(String generatedAssertionsPackage)

generateCustomAssertionFor

public File generateCustomAssertionFor(ClassDescription classDescription)
                                throws IOException

Description copied from interface: AssertionGenerator

Builds and returns the custom assertion java file for the given ClassDescription.

Let's say we have the ClassDescription corresponding to :

 public class Race {

   private final String name;
   private final boolean immortal;

   public Race(String name, boolean immortal) {
     this.name = name;
     this.immortal = immortal;
   }

   public String getName() {
     return name;
   }

   public boolean isImmortal() {
     return immortal;
   }
 }
 

We will generate assertions specific to Race in RaceAssert class, like :

 import static java.lang.String.format;

 import org.assertj.core.api.AbstractObjectAssert;
 import org.assertj.core.api.Assertions;

 public class RaceAssert extends AbstractObjectAssert<RaceAssert, Race> {

   public RaceAssert(Race actual) {
     super(actual, RaceAssert.class);
   }

   public static RaceAssert assertThat(Race actual) {
     return new RaceAssert(actual);
   }

   public RaceAssert hasName(String name) {
     // check that actual Race we want to make assertions on is not null.
     isNotNull();
     // we overrides the default error message with a more explicit one
     String assertjErrorMessage = format("Expected Race's name to be <%s> but was <%s>", name, actual.getName());
     // check
     if (!actual.getName().equals(name)) { throw new AssertionError(assertjErrorMessage); }

     // return the current assertion for method chaining
     return this;
   }

   public RaceAssert isImmortal() {
     // check that actual Race we want to make assertions on is not null.
     isNotNull();
     // we overrides the default error message with a more explicit one
     String assertjErrorMessage = format("Expected actual Race to be immortal but was not.", actual);
     // check
     if (!actual.isImmortal()) throw new AssertionError(assertjErrorMessage);
     // return the current assertion for method chaining
     return this;
   }
 

Specified by:

generateCustomAssertionFor in interface AssertionGenerator

Parameters:

classDescription - the ClassDescription used to generate the assertions class.

Returns:

the custom assertion java file for the given class

Throws:

IOException - if something went wrong when creating the assertion file.

generateHierarchicalCustomAssertionFor

public File[] generateHierarchicalCustomAssertionFor(ClassDescription classDescription,
                                                     Set<com.google.common.reflect.TypeToken<?>> allClasses)
                                              throws IOException

Description copied from interface: AssertionGenerator

Generates hierarchical assertion classes for the class represented by the given classDescription. Two classes are generated:

• An abstract base class containing the assertion definitions, eg

  public abstract class AbstractRaceAssert<S extends AbstractRaceAssert, T extends Race>
   

• A concrete final class which inherits from the abstract base class, eg

   public final class RaceAssert extends AbstractRaceAssert<RaceAssert, Race>
   

If the classDescription has a supertype with a known assertion class, then the generated abstract assertion class will inherit from the superclass' abstract assertion class. Otherwise, it will inherit from AbstractObjectAssert<S, T>.

Specified by:

generateHierarchicalCustomAssertionFor in interface AssertionGenerator

Parameters:

classDescription - the ClassDescription used to generate the assertions class.

allClasses - set of all classes that we are currently generating assertions for. Used to find superclass assertions.

Returns:

two-element File array with the first containing the file for the abstract base assertion and the second containing the file for the concrete final assertion.

Throws:

IOException - if something went wrong when creating the assertion files.

generateHierarchicalCustomAssertionContentFor

public String[] generateHierarchicalCustomAssertionContentFor(ClassDescription classDescription,
                                                              Set<com.google.common.reflect.TypeToken<?>> classes)

Description copied from interface: AssertionGenerator

Generates hierarchical assertion classes for the class represented by the given classDescription. Two classes are generated:

• An abstract base class containing the assertion definitions, eg

  public abstract class AbstractRaceAssert<S extends AbstractRaceAssert, T extends Race>
   

• A concrete final class which inherits from the abstract base class, eg

   public final class RaceAssert extends AbstractRaceAssert<RaceAssert, Race>
   

If the classDescription has a supertype with a known assertion class, then the generated abstract assertion class will inherit from the superclass' abstract assertion class. Otherwise, it will inherit from AbstractObjectAssert<S, T>.

Specified by:

generateHierarchicalCustomAssertionContentFor in interface AssertionGenerator

Parameters:

classDescription - the ClassDescription used to generate the assertions class.

classes - set of all classes that we are currently generating assertions for. Used to find superclass assertions.

Returns:

two-element String array with the first containing the content of the abstract base assertion and the second containing the concrete final assertion.

generateCustomAssertionContentFor

public String generateCustomAssertionContentFor(ClassDescription classDescription)

Description copied from interface: AssertionGenerator

Builds and returns the custom assertion java file content for the given ClassDescription.

Let's say we have the ClassDescription corresponding to :

 public class Race {

   private final String name;
   private final boolean immortal;

   public Race(String name, boolean immortal) {
     this.name = name;
     this.immortal = immortal;
   }

   public String getName() {
     return name;
   }

   public boolean isImmortal() {
     return immortal;
   }
 }
 

We will generate assertions specific to Race in RaceAssert class, like :

 import static java.lang.String.format;

 import org.assertj.core.api.AbstractObjectAssert;
 import org.assertj.core.api.Assertions;

 public class RaceAssert extends AbstractObjectAssert<RaceAssert, Race> {

   public RaceAssert(Race actual) {
     super(actual, RaceAssert.class);
   }

   public static RaceAssert assertThat(Race actual) {
     return new RaceAssert(actual);
   }

   public RaceAssert hasName(String name) {
     // check that actual Race we want to make assertions on is not null.
     isNotNull();
     // we overrides the default error message with a more explicit one
     String assertjErrorMessage = format("Expected Race's name to be <%s> but was <%s>", name, actual.getName());
     // check
     if (!actual.getName().equals(name)) { throw new AssertionError(assertjErrorMessage); }

     // return the current assertion for method chaining
     return this;
   }

   public RaceAssert isImmortal() {
     // check that actual Race we want to make assertions on is not null.
     isNotNull();
     // we overrides the default error message with a more explicit one
     String assertjErrorMessage = format("Expected actual Race to be immortal but was not.", actual);
     // check
     if (!actual.isImmortal()) throw new AssertionError(assertjErrorMessage);
     // return the current assertion for method chaining
     return this;
   }
 

Specified by:

generateCustomAssertionContentFor in interface AssertionGenerator

Parameters:

classDescription - the ClassDescription used to generate the assertions class.

Returns:

the custom assertion content.

generateAssertionsEntryPointClassContentFor

public String generateAssertionsEntryPointClassContentFor(Set<ClassDescription> classDescriptionSet,
                                                          AssertionsEntryPointType assertionsEntryPointType,
                                                          String entryPointClassPackage)

Description copied from interface: AssertionsEntryPointGenerator

Returns the assertions entry point class content for the given ClassDescription set.

The idea is to generate an equivalent of assertj-core Assertions class to give easy access to all generated assertions. With AssertionsEntryPointType parameter one can generate standard, BDD or Soft assertions entry point class (default is AssertionsEntryPointType.STANDARD).

You can define the package of the generated entry point class, if null the common base package of the given classes, will be used, i.e if some classe are in a.b.c and others in a.b.c.d, then entry point class will be in a.b.c.

Specified by:

generateAssertionsEntryPointClassContentFor in interface AssertionsEntryPointGenerator

Parameters:

classDescriptionSet - the set of ClassDescription we want to generate an entry point for.

assertionsEntryPointType - the valueType of entry point class to generate

entryPointClassPackage - the package of the generated entry point class

Returns:

the assertions entry point class content

generateAssertionsEntryPointClassFor

public File generateAssertionsEntryPointClassFor(Set<ClassDescription> classDescriptionSet,
                                                 AssertionsEntryPointType assertionsEntryPointType,
                                                 String entryPointClassPackage)
                                          throws IOException

Description copied from interface: AssertionsEntryPointGenerator

Same as AssertionsEntryPointGenerator.generateAssertionsEntryPointClassContentFor(Set, AssertionsEntryPointType, String) but in addition create the corresponding java class file.

Specified by:

generateAssertionsEntryPointClassFor in interface AssertionsEntryPointGenerator

Parameters:

classDescriptionSet - class descriptions

assertionsEntryPointType - entry point type

entryPointClassPackage - entry point class package name

Returns:

the generated file

Throws:

IOException - if entry point file can't be created.

generateAssertionsForGettersOf

protected void generateAssertionsForGettersOf(StringBuilder contentBuilder,
                                              ClassDescription classDescription)

generateAssertionsForDeclaredGettersOf

protected void generateAssertionsForDeclaredGettersOf(StringBuilder contentBuilder,
                                                      ClassDescription classDescription)

generateAssertionsForGetters

protected void generateAssertionsForGetters(StringBuilder assertionsForGetters,
                                            Set<GetterDescription> getters,
                                            ClassDescription classDescription)

generateAssertionsForFieldsOf

protected void generateAssertionsForFieldsOf(StringBuilder contentBuilder,
                                             ClassDescription classDescription)

generateAssertionsForDeclaredFieldsOf

protected void generateAssertionsForDeclaredFieldsOf(StringBuilder contentBuilder,
                                                     ClassDescription classDescription)

generateAssertionsForFields

protected void generateAssertionsForFields(StringBuilder assertionsForPublicFields,
                                           Set<FieldDescription> fields,
                                           ClassDescription classDescription)

register

public void register(Template template)

Description copied from interface: AssertionGenerator

Registers a template in the internal TemplateRegistry so that customers can override default templates.

Specified by:

register in interface AssertionGenerator

Parameters:

template - template