/*
 * 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.hadoop.hbase.client;

import java.io.IOException;
import org.apache.hadoop.conf.Configuration;
import org.mockito.Mockito;

/**
 * {@link Connection} testing utility.
 */
public class HConnectionTestingUtility {

  /*
   * Not part of {@link HBaseTestingUtility} because this class is not in same package as {@link
   * ConnectionImplementation}. Would have to reveal ugly {@link ConnectionImplementation} innards
   * to HBaseTestingUtility to give it access.
   */
  /**
   * Get a Mocked {@link Connection} that goes with the passed <code>conf</code> configuration
   * instance. Minimally the mock will return &lt;code>conf&lt;/conf> when
   * {@link Connection#getConfiguration()} is invoked. Be sure to shutdown the connection when done
   * by calling {@link Connection#close()} else it will stick around; this is probably not what you
   * want.
   * @param conf configuration
   * @return ConnectionImplementation object for <code>conf</code>
   */
  public static Connection getMockedConnection(final Configuration conf) throws IOException {
    Connection connection = Mockito.mock(Connection.class);
    Mockito.when(connection.getConfiguration()).thenReturn(conf);

    // Some test cases need Mock of getTable and getScanner
    Table t = Mockito.mock(Table.class);
    Mockito.when(connection.getTable(Mockito.any())).thenReturn(t);
    ResultScanner rs = Mockito.mock(ResultScanner.class);
    Mockito.when(t.getScanner((Scan) Mockito.any())).thenReturn(rs);

    return connection;
  }
}
