com.cedarsoft.test.utils.matchers.ContainsFileMatcher 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.matchers;

import com.google.common.base.Function;
import com.google.common.base.Joiner;
import com.google.common.collect.Lists;
import org.apache.commons.io.FileUtils;
import org.apache.commons.io.filefilter.TrueFileFilter;
import org.hamcrest.BaseMatcher;
import org.hamcrest.Description;
import org.hamcrest.Matcher;

import javax.annotation.Nonnull;
import java.io.File;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;

/**
 *
 */
public class ContainsFileMatcher extends BaseMatcher {
  @Nonnull
  private final String relativeFilePath;

  public ContainsFileMatcher( @Nonnull String relativeFilePath ) {
    this.relativeFilePath = relativeFilePath;
  }

  @Override
  public boolean matches( Object o ) {
    File file = ( File ) o;
    if ( !file.isDirectory() ) {
      return false;
    }

    File searched = new File( file, relativeFilePath );
    return searched.isFile();
  }

  @Override
  public void describeTo( Description description ) {
    description.appendText( "contains file " );
    description.appendValue( relativeFilePath );
  }

  @Nonnull
  public static ContainsFileMatcher containsFile( @Nonnull String relativeFilePath ) {
    return new ContainsFileMatcher( relativeFilePath );
  }

  @Nonnull
  public static Matcher empty() {
    return new BaseMatcher() {
      @Override
      public boolean matches( Object o ) {
        return ( ( File ) o ).list().length == 0;
      }

      @Override
      public void describeTo( Description description ) {
        description.appendText( "empty" );
      }
    };
  }

  @Nonnull
  public static Matcher containsFiles( @Nonnull String... relativeFilePaths ) {
    List> matchers = new ArrayList>();
    for ( String relativeFilePath : relativeFilePaths ) {
      matchers.add( containsFile( relativeFilePath ) );
    }

    return new AndMatcher( matchers );
  }

  @Nonnull
  public static String toTree( @Nonnull final File dir ) {
    List files = Lists.newArrayList( ( Iterator ) FileUtils.iterateFiles( dir, TrueFileFilter.TRUE, TrueFileFilter.TRUE ) );

    List names = Lists.newArrayList( Lists.transform( files, new Function() {
      @Override
      public String apply( File from ) {
        return from.getPath().substring( dir.getPath().length() + 1 );
      }
    } ) );
    Collections.sort( names );

    Joiner joiner = Joiner.on( "\n" );
    return joiner.join( names );
  }


  @Nonnull
  public static String toMessage( @Nonnull final File dir ) {
    return dir.getAbsolutePath() + ":\n" + toTree( dir );
  }

}