sta-szek / pojo-tester

Java testing framework for testing pojo methods. It tests equals, hashCode, toString, getters, setters, constructors and whatever you report in issues ;)

POJO-TESTER - Java framework for pojo-testing

PROJECT IS ON HOLD

I have no time to invest more in this project. See #247

Thank you for using pojo-tester! It has 131 019 (05.06.2020) downloads total! I was not expecting such popularity 🚀

---

POJO-TESTER is a java testing library, which makes your pojo-tests much easier. You can test your pojo against equals, hashCode, toString, getters, setters and constructors.

Get more information at pojo-tester documentation site

If you have any questions, we can chat on

Build status is provided by

Current coverage is

Project quality

Download latest version

Get automatic notifications about new POJO-TESTER versions

pojo-tester's Issues

Change org.pojo.tester.field.primitive.* tests to parametrized

Change org.pojo.tester.field.primitive.* tests to parametrized
Tests to change:
Should_Return_False_If_Values_Are_Not_Different
and
Should_Return_True_If_Values_Are_Different

Similar to
StreamValueChangerTest

Implement testing nested classes

Check if nested classes can be tested now. If not implement this.

Find out the most user friendly pojo tester api for testing

What is the most user friendly / given-when-then convention compatible way to invoke pojo tests?

// given
PojoTester tester = new PojoTester();
PojoTester tester = new PojoTester(fieldValueChanger);
PojoTester tester = new PojoTester().using(fieldValueChanger);

Class coffee = Coffee.class;
Class cake = Cake.class;

Class[] classes = new Class[]{coffee, cake};

// when

// then
tester.test(coffee);
tester.testAll(coffee, cake,);
tester.testAll(classes);

OR

// given
Class coffee = Coffee.class;
Class cake = Cake.class;

Class[] classes = new Class[]{coffee, cake};

// when

// then
assertThat(class).using(fieldValueChanger).hasWellImplemented...();
assertThat(class1, class2).using(fieldValueChanger).haveWellImplemented...();

EXPLANATION

Currently test and testAll methods throw exception when pojo has invalid equals, hashcode or toString method implementation.

NESTED CLASSES

You can also define nested classes to change in your main class e.g.

A {
  B b;
  C c.
}
Class baseClass = A.class;
Class[] nestedClasses = new Class[]{B.class, C.class};

test(baseClass, nestedClasses )

KIND OF TESTS

There is no option to choose which tests should be run (equals, hashcode or toString).
How do you want to provide it? E.g.

new PojoTester(EQUALS | HASHCODE | TO_STRING)
or
new PojoTester().addTesters(new EqualsTester(), ...)
or
assertThat(class).using(new HashCodeTester()).hasWellImplemented...();

CHANGING FIELDS

At this moment you can provide you own fieldsValuesChanger that should change field of specific type e.g. Coffee.
In order to do this you have to extend AbstractFieldsValuesChanger class and implement some methods.

If you do not specify your own fields values changer and pojo tester could not change field value then it sets it either to null or class.instantiate()

FieldUtils.findGetter/SetterFor fails on primitve/wapped

Method fails when you have primitive wapped filed and primitive return value on getter and vice versa
e.g.

private Boolean x;

public boolean getX(){...}

and

private Boolean x;

public void settX(boolean x){...}

Test fields that wrap primitive types

Test fields that wrap primitive types e.g. Integer, Long, etc. write more tests

Extract abstract class for all testers

EqualsTester, HashCodeTester, ToStringTester, ... all have similar methods for testing.

Provide resolving fields that need to be changes

Determine which fields should be changed.
Private, public, static or final? Maybe all of them?

Rename classes in tests and separate them for each test class

Classes for tests like A or "Good_Pojo_...are common for each tests, which started to be difficult to maintance. Also names likeA` are not expressive.

Separate classes and rename them

Configure gradle jar task

Jar task should build jar, that can be added to dependencies.
Update manifest.

Add library to bintray, jcenter and mavenCentral

Add library to mvnrepository.com
and other repositories if needed

Find out how to add libraries automatically, e.g. on closing milestone

Provide Codacy code coverage

Script sending coverage should be placed on TeamCity or TravisCI

Remove tests with Character.*_SURROGATE

JUnit5 fails when generating tests, that names contains Character.*_SURROGATE

Provide abstractions on assertions

Implement enums changing

Fields that are enums should be changes as follow:
Take next value, if there is only one, then set null

Refactor building messages

Messages are created by StringBuilder which makes hard to change formatting etc... Extract abstraction e.g. message container, which will display them in better way.

Change test naming convention

Change naming convention from shouldDoSomething to Should_Do_Something

Improve primitive value changer testing

Currently method changeFieldsValues(...) is tested instead of increaseValue()

Javadoc documentation

Provide testing fields by name. Not only all

User should have possibility to choose fields for testing. From those fields should be generated different objects. Use generating different objects implemented in #11

Implement testing hashCode()

Implement testing hashCode() method with possibility to choose fields like in EqualsTester

Generate different objects

EqualsTester class should test objects that have different fields values. It should test n! +2 objects where n is quantity of fields. +2 is additional cases with all fields changed and default values.
E.g.

class A {
   private int a;
   private int b;
}

Should be generated objects:
A(0, 0)
A(0,1)
A(1,0)
A(1,1)

0 - defaultowa value
1 - changed value

Switch to Junit5

Switch from JUnit4 to JUnit5

Testing toString()

Implement testing toString() method with possibility to choose fields like in EqualsTester

Wrong abstract class implementation throws SetterAssertionError

When class is abstract, it is implemented as proxy, so setters and getters are not working properly.
This makes pojo tester throw SetterAssertionError

Consider creating api and internal package

Creating org.pojo.tester.api., org.pojo.tester.internal. package to indicate for end-users which classes they should use and which are internal ones.

Rename package org.pojo.* to pl.pojo.* - I own domain pojo.pl, so it will be easy to guess homepage for all pojo projects

Refresh project and dependencies

After few months dependencies and build scripts need to be upgraded

Split getters and setters tests

Split class GettersAnsSettersTester into two.

Implement getter and setter verification

Similar to EqualsTester and HashCodeTester provide SetGetTester that will test setters and getters

SetterNotFoundException when field is boolean and has `is` prefix

When field is boolean and has prefix is, pojo-tester tries to find setter setIsActive, but frameworks like lombok names this setter in this way setActive

Accessing setters / getters in not public classes makes SetterGetterTester throw GetOrSetValueException

When class is not public and is tested against setters and getters, the GetOrSetValueException is thrown.
It is caused by java IllegalAccessException.

Find out better way to get generic class

Currently casting to ParametrizedTypeImpl is kind of dangerous. That class is internal class of Java, which should not be used.
Warnings are reported whlie compiling code:
D:\workspaces\intellij\pojo-tester\src\main\java\org\pojo\tester\field\collections\map\AbstractMapFieldValueChanger.java:5: warning: ParameterizedTypeImpl is internal proprietary API and may be removed in a future release import sun.reflect.generics.reflectiveObjects.ParameterizedTypeImpl;

Refactoring ObjectGenerator

Method createInstanceWithDifferentFieldValues in ObjectGenerator class should take objects as parameter instead of class, that it can properly generate different object from taken one.
Currently creates two object and returns the second one, but what if someones has already that object?

Provide possibility for testing classes by it's name

Currently, user can provide only Class<?> instance, so testing package, nested private and other classes is impossible. objectGenerator already supports creating class by name.

Accessing not public class makes pojo-tester throw java.lang.IllegalAccessException when creating objects

Exception is thrown when trying to create instance by default constructor of non public class.

java.lang.IllegalAccessException: Class org.pojo.tester.instantiator.DefaultConstructorInstantiator can not access a member of class org.pojo.playground.GoodPojo with modifiers "public"

Related topic http://stackoverflow.com/questions/15015675/accessing-non-visible-classes-with-reflection

Allow user to choose constructor and pass parameters

When creating objects via construcotrs, exception occurs if parameters don't pass validation.
User could have possibility to provide constructor and parameters (or just parameters and construcotr will chosen by java, based on parameters type).

Proposed API:

assert...(...).create(X.class, constructor, parameters)
or
make ClassAndFieldPredicate to contain construcor and parameters
assert...(ClassAndFieldPredicate)....

Implement testing unpublic classes

Check if unpublic classes can be tested now. If not implement this.

Create parameters validation

Create parameters validation in constructors, setters and other methods.

It could look like
Preconditions.notNull(...) throws NullPointerException

Apply to all neccessary classes

Implement changing fields recursively

Currently while creating new objects, only fields that are primitive are being changed.
Add changing fields recursively that are not primitive types e.g. Object or CustomClass

Change exceptions from java and other libraries to pojo exceptions

Currently exceptions from java and other libraries are thrown to end user.
It provides to brake the OCP rule every time, the underlaying libraries will change

Field value changer should change interable values

Implement changing lists, arrays, collections, etc.

Getting more done in GitHub with ZenHub

Hola! @sta-szek has created a ZenHub account for the sta-szek organization. ZenHub is the only project management tool integrated natively in GitHub – created specifically for fast-moving, software-driven teams.

---

How do I use ZenHub?

To get set up with ZenHub, all you have to do is download the browser extension and log in with your GitHub account. Once you do, you’ll get access to ZenHub’s complete feature-set immediately.

What can ZenHub do?

ZenHub adds a series of enhancements directly inside the GitHub UI:

• Real-time, customizable task boards for GitHub issues;
• Multi-Repository burndown charts, estimates, and velocity tracking based on GitHub Milestones;
• Personal to-do lists and task prioritization;
• Time-saving shortcuts – like a quick repo switcher, a “Move issue” button, and much more.

Add ZenHub to GitHub

Still curious? See more ZenHub features or read user reviews. This issue was written by your friendly ZenHub bot, posted by request from @sta-szek.

Remove codacy coverage from CI

Codacy coverage requires sudo at travisCI.
This makes build slower than non-sudo builds.
Overmore codacy refused me to extend the license for private repos, so the system is useless

Support classes without default constructors

Support classes without default constructors

Tesst test same objects, which cause assertion exception

Tests test same objects, which makes e.g. NotEqualEqualsAssertionError and the message is:

pl.pojo.tester.internal.assertion.equals.NotEqualEqualsAssertionError: 


Class org.pojo.playground.GoodPojo has bad 'equals' method implementation.
The equals method should return false if objects should not be equal.
Current implementation returns true.
Object:
GoodPojo{byteField=0, shortType=0, intType=0, longType=0, doubleType=0.0, booleanType=false, floatType=0.0, charType= }
should not be equal to:
GoodPojo{byteField=0, shortType=0, intType=0, longType=0, doubleType=0.0, booleanType=false, floatType=0.0, charType= }

Add mutation tests result on TeamCity

Add mutation tests result on TeamCity

Implement testing static classes

Check if static classes can be tested now. If not implement this.

Change default string value in newly created objects

When creating new objects, and changing values of String type, an empty string is given "".
The problem is that empty string and null string have same hash codes =0

Create github pages

Create github pages.
There should be user guide, quick start and more.
Similar to http://joel-costigliola.github.io/assertj/index.html - assertj github pages

Resolve codacy issues

Resolve codacy issues

Improve unit tests and coverage

Improve unit tests that they use more mocked dependencies.