com.github.gv2011.testutil.AbstractTest Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of util-test Show documentation
Common test module for all other modules
There is a newer version: 0.14
package com.github.gv2011.testutil;

/*-
 * #%L
 * util-test
 * %%
 * Copyright (C) 2016 - 2017 Vinz (https://github.com/gv2011)
 * %%
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 * #L%
 */
import static com.github.gv2011.util.StreamUtils.readText;
import static com.github.gv2011.util.bytes.ByteUtils.copyFromStream;
import static com.github.gv2011.util.ex.Exceptions.format;
import static org.slf4j.LoggerFactory.getLogger;

import java.net.URL;
import java.nio.file.Path;

import org.hamcrest.Description;
import org.hamcrest.Matcher;
import org.hamcrest.TypeSafeMatcher;
import org.junit.Rule;
import org.slf4j.Logger;

import com.github.gv2011.util.ResourceUtils;
import com.github.gv2011.util.bytes.ByteUtils;
import com.github.gv2011.util.bytes.Bytes;

public abstract class AbstractTest {

  private final TestFolderRule testFolderRule;
  protected final Logger log;


  protected AbstractTest(){
    log = getLogger(getClass());
    testFolderRule = TestFolderRule.create(this::after);
  }

  @Rule
  public final TestFolderRule testFolderRule(){
    return testFolderRule;
  }

  protected final Path testFolder(){
    return testFolderRule.testFolder();
  }

  protected void after(){}

  protected final String getResourceAsString(final String extension){
    return getResourceAsString(getClass(), extension);
  }

  protected final String getResourceAsString(final Class base, final String extension){
    return readText(getResource(base, extension)::openStream);
  }

  protected final URL getResource(final String extension){
    return getResource(getClass(), extension);
  }

  protected final Bytes getResourceBytes(final String extension){
    return ByteUtils.copyFromStream(getResource(getClass(), extension)::openStream);
  }

  protected final URL getResource(final Class base, final String extension){
    return ResourceUtils.getResourceUrl(base, getLocalResourceName(base, extension));
  }

  private String getLocalResourceName(final Class base, final String extension) {
    return base.getSimpleName()+"."+extension;
  }

  protected final Matcher isBytes(final String extension){
    return isBytes(getClass(), extension);
  }

  protected final Matcher isBytes(final Class base, final String extension){
    final String local = getLocalResourceName(base, extension);
    final URL url = ResourceUtils.getResourceUrl(base, local);
    final Bytes expected = copyFromStream(url::openStream);
    return new TypeSafeMatcher(){
      @Override
      public void describeTo(final Description description) {
        description.appendText(format("A byte array with same content as resource {} ({}).", local, base));
      }
      @Override
      protected boolean matchesSafely(final Bytes bytes) {
        return bytes.equals(expected);
      }
    };
  }

}