/*
    *  Licensed to the Apache Software Foundation (ASF) under one
    *  or more contributor license agreements.  See the NOTICE file
    *  distributed with this work for additional information
    *  regarding copyright ownership.  The ASF licenses this file
    *  to you under the Apache License, Version 2.0 (the
    *  "License"); you may not use this file except in compliance
    *  with the License.  You may obtain a copy of the License at
    *
   *    http://www.apache.org/licenses/LICENSE-2.0
   *
   *  Unless required by applicable law or agreed to in writing,
   *  software distributed under the License is distributed on an
   *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
   *  KIND, either express or implied.  See the License for the
   *  specific language governing permissions and limitations
   *  under the License.
   *
   */
  package org.apache.mina.transport;
  
  import static org.junit.Assert.assertEquals;
  import static org.junit.Assert.assertTrue;
  
  import java.io.File;
  import java.io.FileOutputStream;
  import java.io.IOException;
  import java.net.InetSocketAddress;
  import java.nio.ByteBuffer;
  import java.nio.channels.FileChannel;
  import java.util.concurrent.CountDownLatch;
  
  import org.apache.mina.core.buffer.IoBuffer;
  import org.apache.mina.core.future.ConnectFuture;
  import org.apache.mina.core.service.IoAcceptor;
  import org.apache.mina.core.service.IoConnector;
  import org.apache.mina.core.service.IoHandlerAdapter;
  import org.apache.mina.core.session.IoSession;
  import org.apache.mina.transport.socket.nio.NioSocketAcceptor;
  import org.apache.mina.util.AvailablePortFinder;
  import org.junit.Test;
  
  /**
   * TODO Add documentation
   * 
   * @author <a href="http://mina.apache.org">Apache MINA Project</a>
   */
  public abstract class AbstractFileRegionTest {
  
      private static final int FILE_SIZE = 1 * 1024 * 1024; // 1MB file
  
      protected abstract IoAcceptor createAcceptor();
  
      protected abstract IoConnector createConnector();
  
      @Test
      public void testSendLargeFile() throws Throwable {
          File file = createLargeFile();
          assertEquals("Test file not as big as specified", FILE_SIZE, file.length());
  
          final CountDownLatch latch = new CountDownLatch(1);
          final boolean[] success = { false };
          final Throwable[] exception = { null };
  
          int port = AvailablePortFinder.getNextAvailable(1025);
          IoAcceptor acceptor = createAcceptor();
          IoConnector connector = createConnector();
  
          try {
              acceptor.setHandler(new IoHandlerAdapter() {
                  private int index = 0;
  
                  @Override
                  public void exceptionCaught(IoSession session, Throwable cause) throws Exception {
                      exception[0] = cause;
                      session.closeNow();
                  }
  
                  @Override
                  public void messageReceived(IoSession session, Object message) throws Exception {
                      IoBuffer buffer = (IoBuffer) message;
                      while (buffer.hasRemaining()) {
                          int x = buffer.getInt();
                          if (x != index) {
                              throw new Exception(String.format("Integer at %d was %d but should have been %d", index, x,
                                      index));
                          }
                          index++;
                      }
                      if (index > FILE_SIZE / 4) {
                          throw new Exception("Read too much data");
                      }
                      if (index == FILE_SIZE / 4) {
                          success[0] = true;
                          session.closeNow();
                      }
                  }
              });
  
             ((NioSocketAcceptor) acceptor).setReuseAddress(true);
 
             acceptor.bind(new InetSocketAddress(port));
 
             connector.setHandler(new IoHandlerAdapter() {
                 @Override
                 public void exceptionCaught(IoSession session, Throwable cause) throws Exception {
                     exception[0] = cause;
                     session.closeNow();
                 }
 
                 @Override
                 public void sessionClosed(IoSession session) throws Exception {
                     latch.countDown();
                 }
             });
 
             ConnectFuture future = connector.connect(new InetSocketAddress("localhost", port));
             future.awaitUninterruptibly();
 
             IoSession session = future.getSession();
             session.write(file);
 
             latch.await();
 
             if (exception[0] != null) {
                 throw exception[0];
             }
             assertTrue("Did not complete file transfer successfully", success[0]);
 
             assertEquals("Written messages should be 1 (we wrote one file)", 1, session.getWrittenMessages());
             assertEquals("Written bytes should match file size", FILE_SIZE, session.getWrittenBytes());
         } finally {
             try {
                 connector.dispose();
             } finally {
                 acceptor.dispose();
             }
         }
     }
 
     private File createLargeFile() throws IOException {
         File largeFile = File.createTempFile("mina-test", "largefile");
         largeFile.deleteOnExit();
         FileChannel channel = null;
         FileOutputStream out = null;
         
         try {
             out =  new FileOutputStream(largeFile);
             channel = out.getChannel();
             ByteBuffer buffer = createBuffer();
             channel.write(buffer);
             channel.close();
             out.close();
         } finally {
             if (channel != null) {
                 channel.close();
             }
             
             if (out != null) {
                 out.close();
             }
         }
         
         return largeFile;
     }
 
     private ByteBuffer createBuffer() {
         ByteBuffer buffer = ByteBuffer.allocate(FILE_SIZE);
         for (int i = 0; i < FILE_SIZE / 4; i++) {
             buffer.putInt(i);
         }
         buffer.flip();
         return buffer;
     }
 }