/**
    * 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.serialization;
  
  import org.apache.commons.io.IOUtils;
  import org.junit.experimental.theories.*;
  import org.junit.runner.*;
  import org.mockito.internal.matchers.apachecommons.ReflectionEquals;
  
  import javax.annotation.Nonnull;
  import java.io.ByteArrayInputStream;
  import java.io.ByteArrayOutputStream;
  import java.io.IOException;
  import java.io.InputStream;
  import java.net.URL;
  
  import static org.hamcrest.CoreMatchers.*;
  import static org.junit.Assert.*;
  
  /**
   * Abstract base class for serializer tests.
   *
   * @param <T> the type of domain object
   */
  @RunWith( Theories.class )
  public abstract class AbstractSerializerTest2<T> {
    @Theory
    public void testSerializer( @Nonnull Entry<T> entry ) throws Exception {
      Serializer<T> serializer = getSerializer();
  
      //Serialize
      byte[] serialized = serialize( serializer, entry.getObject() );
  
      //Verify
      verifySerialized( entry, serialized );
  
      verifyDeserialized( serializer.deserialize( new ByteArrayInputStream( serialized ) ), entry.getObject() );
    }
  
    @Nonnull
    protected byte[] serialize( @Nonnull Serializer<T> serializer, @Nonnull T objectToSerialize ) throws IOException {
      ByteArrayOutputStream out = new ByteArrayOutputStream();
      serializer.serialize( objectToSerialize, out );
      return out.toByteArray();
    }
  
    protected abstract void verifySerialized( @Nonnull Entry<T> entry, @Nonnull byte[] serialized ) throws Exception;
  
    /**
     * Returns the serializer
     *
     * @return the serializer
     */
    @Nonnull
    protected abstract Serializer<T> getSerializer() throws Exception;
  
    /**
     * Verifies the deserialized object
     *
     * @param deserialized the deserialized object
     * @param original     the original
     */
    protected void verifyDeserialized( @Nonnull T deserialized, @Nonnull T original ) {
      assertEquals( original, deserialized );
      assertThat( deserialized, is( new ReflectionEquals( original ) ) );
    }
  
    @Nonnull
    public static <T> Entry<? extends T> create( @Nonnull T object, @Nonnull byte[] expected ) {
      return new Entry<T>( object, expected );
   }
 
   @Nonnull
   public static <T> Entry<? extends T> create( @Nonnull T object, @Nonnull URL expected ) {
     try {
       return new Entry<T>( object, IOUtils.toByteArray( expected.openStream() ) );
     } catch ( IOException e ) {
       throw new RuntimeException( e );
     }
   }
 
   @Nonnull
   public static <T> Entry<? extends T> create( @Nonnull T object, @Nonnull InputStream expected ) {
     try {
       return new Entry<T>( object, IOUtils.toByteArray( expected ) );
     } catch ( IOException e ) {
       throw new RuntimeException( e );
     }
   }
 }