SocketConnectorTest.java

/*
 * Copyright (c) 2002-2017 "Neo Technology,"
 * Network Engine for Objects in Lund AB [http://neotechnology.com]
 *
 * This file is part of Neo4j.
 *
 * Licensed 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.neo4j.driver.internal.net;

import org.junit.Test;

import java.util.List;
import java.util.Map;
import java.util.concurrent.CopyOnWriteArrayList;

import org.neo4j.driver.internal.ConnectionSettings;
import org.neo4j.driver.internal.security.InternalAuthToken;
import org.neo4j.driver.internal.security.SecurityPlan;
import org.neo4j.driver.internal.spi.Connection;
import org.neo4j.driver.v1.AuthToken;
import org.neo4j.driver.v1.AuthTokens;
import org.neo4j.driver.v1.Logging;
import org.neo4j.driver.v1.exceptions.ClientException;

import static org.hamcrest.Matchers.instanceOf;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertSame;
import static org.junit.Assert.assertThat;
import static org.junit.Assert.fail;
import static org.mockito.Matchers.any;
import static org.mockito.Matchers.anyInt;
import static org.mockito.Matchers.anyString;
import static org.mockito.Matchers.eq;
import static org.mockito.Mockito.RETURNS_MOCKS;
import static org.mockito.Mockito.doReturn;
import static org.mockito.Mockito.doThrow;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.spy;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;
import static org.neo4j.driver.internal.net.BoltServerAddress.LOCAL_DEFAULT;
import static org.neo4j.driver.internal.security.SecurityPlan.insecure;

public class SocketConnectorTest
{
    private static final int CONNECTION_TIMEOUT = 42;

    @Test
    public void connectCreatesConnection()
    {
        ConnectionSettings settings = new ConnectionSettings( basicAuthToken(), CONNECTION_TIMEOUT );
        SocketConnector connector = new RecordingSocketConnector( settings );

        Connection connection = connector.connect( LOCAL_DEFAULT );

        assertThat( connection, instanceOf( ConcurrencyGuardingConnection.class ) );
    }

    @Test
    @SuppressWarnings( "unchecked" )
    public void connectSendsInit()
    {
        String userAgent = "agentSmith";
        ConnectionSettings settings = new ConnectionSettings( basicAuthToken(), userAgent, CONNECTION_TIMEOUT );
        RecordingSocketConnector connector = new RecordingSocketConnector( settings );

        connector.connect( LOCAL_DEFAULT );

        assertEquals( 1, connector.createConnections.size() );
        Connection connection = connector.createConnections.get( 0 );
        verify( connection ).init( eq( userAgent ), any( Map.class ) );
    }

    @Test
    public void connectThrowsForUnknownAuthToken()
    {
        ConnectionSettings settings = new ConnectionSettings( mock( AuthToken.class ), CONNECTION_TIMEOUT );
        RecordingSocketConnector connector = new RecordingSocketConnector( settings );

        try
        {
            connector.connect( LOCAL_DEFAULT );
            fail( "Exception expected" );
        }
        catch ( Exception e )
        {
            assertThat( e, instanceOf( ClientException.class ) );
        }
    }

    @Test
    @SuppressWarnings( "unchecked" )
    public void connectClosesOpenedConnectionIfInitThrows()
    {
        Connection connection = mock( Connection.class );
        RuntimeException initError = new RuntimeException( "Init error" );
        doThrow( initError ).when( connection ).init( anyString(), any( Map.class ) );

        SocketConnector connector = stubSocketConnector( connection );

        try
        {
            connector.connect( LOCAL_DEFAULT );
            fail( "Exception expected" );
        }
        catch ( Exception e )
        {
            assertSame( initError, e );
        }

        verify( connection ).close();
    }

    @Test
    public void createsConnectionWithUsingConnectionSettings()
    {
        AuthToken authToken = AuthTokens.basic( "neo4j", "test" );
        String userAgent = "tester";
        int connectionTimeoutMillis = CONNECTION_TIMEOUT;
        ConnectionSettings settings = new ConnectionSettings( authToken, userAgent, connectionTimeoutMillis );

        Connection connection = mock( Connection.class );
        SocketConnector connector = stubSocketConnector( connection, settings );

        assertNotNull( connector.connect( LOCAL_DEFAULT ) );

        verify( connector ).createConnection( eq( LOCAL_DEFAULT ), any( SecurityPlan.class ),
                eq( connectionTimeoutMillis ), any( Logging.class ) );
        verify( connection ).init( userAgent, ((InternalAuthToken) authToken).toMap() );
    }

    private static Logging loggingMock()
    {
        return mock( Logging.class, RETURNS_MOCKS );
    }

    private static AuthToken basicAuthToken()
    {
        return AuthTokens.basic( "neo4j", "neo4j" );
    }

    private static SocketConnector stubSocketConnector( Connection connection )
    {
        return stubSocketConnector( connection, new ConnectionSettings( basicAuthToken(), CONNECTION_TIMEOUT ) );
    }

    private static SocketConnector stubSocketConnector( Connection connection, ConnectionSettings settings )
    {
        SocketConnector connector = spy( new SocketConnector( settings, insecure(), loggingMock() ) );
        doReturn( connection ).when( connector ).createConnection(
                any( BoltServerAddress.class ), any( SecurityPlan.class ), anyInt(), any( Logging.class ) );
        return connector;
    }

    private static class RecordingSocketConnector extends SocketConnector
    {
        final List<Connection> createConnections = new CopyOnWriteArrayList<>();

        RecordingSocketConnector( ConnectionSettings settings )
        {
            super( settings, insecure(), loggingMock() );
        }

        @Override
        Connection createConnection( BoltServerAddress address, SecurityPlan securityPlan, int timeoutMillis,
                Logging logging )
        {
            Connection connection = mock( Connection.class );
            when( connection.boltServerAddress() ).thenReturn( address );
            createConnections.add( connection );
            return connection;
        }
    }
}