java-private-constructor-checker

Additional

Language
Java
Version
v1.2.0 (Jan 2, 2016)
Created
Jul 28, 2015
Updated
Jan 2, 2016 (Retired)
Owner
Pushtorefresh (pushtorefresh)
Contributors
Vladislav Bauer (vbauer)
Artem Zinnatullin :slowpoke: (artem-zinnatullin)
Niklas Baudy (vanniktech)
nikitin-da
4
Activity
Badge
Generate
Download
Source code

Commercial

###Goal Max code coverage!

It means, that you need to test even private constructors of classes that must not be instantiated.

Q: Why would I want to test that constructor is private and that it throws exception??

A: Because if you are not the only developer in the project — others may change this (make constructor public, etc) and you may miss this on the code review because you are human).

A2: Because if you want to have as max code coverage as possible — you need to test even such unreacheable code.

###Sample Now, imagine you have such class with private constructor:

class Checks {

  private Checks() {
    throw new IllegalStateException("No instances please!");
  }

  public static void checkNotNull(Object ref, String message) {
    if (ref == null) {
      throw new AssertionError(message);
    }
  }

  // other methods
}

###The problem

Let's try to test this constructor!

@Test
public void constructorMustBePrivateAndThrowException() {
  try {
    new Checks(); // won't compile! Constructor is private!
    fail("constructor must throw exception");
  } catch (IllegalStateException expected) {
    assertEquals("No instances please!", expected.getMessage());
  }
}

Okay, we can not just write a test for private constructor, we need reflection!

@Test
public void constructorMustBePrivateAndThrowException() {
  Constructor<?> constructor = Checks.class.getConstructor();
  constructor.setAccessible(true);

  try {
    constructor.newInstance();
    fail("constructor must throw exception");
  } catch (InvocationTargetException expected) {
    IllegalStateException cause = (IllegalStateException) expected.getCause();
    assertEquals("No instances please!", cause.getMessage());
  }
}

And that's not even full code that you'll have to write, you also need to check that class does not have other constructors and some other things. So, you really want to write this boilerplate unreadable code every time?

###Clear solution

@Test
public void constructorMustBePrivateAndThrowException() {
  PrivateConstructorChecker
    .forClass(Checks.class) // Or you can use forClasses() and check multiple classes!
    .expectedTypeOfException(IllegalStateException.class)
    .expectedExceptionMessage("No instances please!")
    .check();
}

This is how we do! Clear, nice and readable!

What PrivateConstructorChecker does:

  • Checks that class has only one constructor without args and that it's private.
  • Checks that constructor throws exception (optional).
  • Can check exception type and/or exception message.
  • Saves you from boilerplate code!

###Download

Gradle:

testCompile 'com.pushtorefresh.java-private-constructor-checker:checker:1.2.0'

Maven:

<dependency>
    <groupId>com.pushtorefresh.java-private-constructor-checker</groupId>
    <artifactId>checker</artifactId>
    <version>1.2.0</version>
</dependency>

Use, share, have fun!

Made with love in Pushtorefresh.com by @artem_zin and @nikitin-da