com.cedarsoft.test.utils.MockitoTemplate Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of test-utils Show documentation
There is a newer version: 8.9.2
/**
 * Copyright (C) cedarsoft GmbH.
 *
 * Licensed under the GNU General Public License version 3 (the "License")
 * with Classpath Exception; you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at
 *
 *         http://www.cedarsoft.org/gpl3ce
 *         (GPL 3 with Classpath Exception)
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 3 only, as
 * published by the Free Software Foundation. cedarsoft GmbH designates this
 * particular file as subject to the "Classpath" exception as provided
 * by cedarsoft GmbH in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 3 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 3 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact cedarsoft GmbH, 72810 Gomaringen, Germany,
 * or visit www.cedarsoft.com if you need additional information or
 * have any questions.
 */

package com.cedarsoft.test.utils;

import org.mockito.Mockito;
import org.mockito.MockitoAnnotations;

/**
 * Simple template for mockito.
 *
 * @author Johannes Schneider ([email protected])
 */
public abstract class MockitoTemplate {

  /**
   * Stub the mocks
   *
   * @throws Exception if any.
   */
  protected abstract void stub() throws Exception;

  /**
   * Execute the test code / assertions
   *
   * @throws Exception if any.
   */
  protected abstract void execute() throws Exception;

  /**
   * Finally verify the mocks using {@link Mockito#verify(Object)}
   *
   * @throws Exception if any.
   */
  protected abstract void verifyMocks() throws Exception;

  /**
   * Runs the tests
   *
   * @throws Exception if any.
   */
  public void run() throws Exception {
    initMocks();
    stub();
    execute();
    verifyMocks();
  }

  /**
   * initMocks
   */
  protected void initMocks() {
    MockitoAnnotations.initMocks( this );
  }
}