tests/org.eclipse.rap.clientscripting.test/src/org/eclipse/rap/clientscripting/internal/ClientFunction_Test.java

/*******************************************************************************
 * Copyright (c) 2012, 2013 EclipseSource and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *    EclipseSource - initial API and implementation
 ******************************************************************************/
package org.eclipse.rap.clientscripting.internal;

import static org.eclipse.rap.clientscripting.internal.TestUtil.fakeConnection;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;
import static org.mockito.Matchers.eq;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.spy;
import static org.mockito.Mockito.times;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;

import org.eclipse.rap.clientscripting.Script;
import org.eclipse.rap.rwt.remote.Connection;
import org.eclipse.rap.rwt.remote.RemoteObject;
import org.eclipse.rap.rwt.testfixture.Fixture;
import org.junit.*;


public class ClientFunction_Test {

  private static final String CLIENT_LISTENER_TYPE = "rwt.scripting.Function";
  private static final String LISTENER_BINDING_TYPE = "rwt.scripting.EventBinding";

  private ClientFunction function;

  @Before
  public void setUp() throws Exception {
    Fixture.setUp();
    createListener();
  }

  @After
  public void tearDown() throws Exception {
    Fixture.tearDown();
  }

  @Test
  public void testCreation_failsWithStringNull() {
    try {
      new ClientFunction( ( String )null );
      fail();
    } catch( NullPointerException expected ) {
      assertTrue( expected.getMessage().contains( "scriptCode" ) );
    }
  }

  @Test
  public void testCreation_failsWithScriptNull() {
    try {
      new ClientFunction( ( Script )null );
      fail();
    } catch( NullPointerException expected ) {
      assertTrue( expected.getMessage().contains( "script" ) );
    }
  }

  @Test
  public void testCreation_createsRemoteObject() {
    Connection connection = fakeConnection( mock( RemoteObject.class ), CLIENT_LISTENER_TYPE );

    new ClientFunction( new Script( "script code" ) );

    verify( connection ).createRemoteObject( "rwt.scripting.Function" );
  }

  @Test
  public void testCreation_setsName() {
    RemoteObject listenerRemoteObject = mock( RemoteObject.class );
    RemoteObject scriptRemoteObject = mock( RemoteObject.class );
    Connection connection = mock( Connection.class );
    when( connection.createRemoteObject( eq( CLIENT_LISTENER_TYPE ) ) )
      .thenReturn( listenerRemoteObject );
    when( scriptRemoteObject.getId() ).thenReturn( "fooId" );
    Fixture.fakeConnection( connection );

    new ClientFunction( "my script code" );

    verify( listenerRemoteObject ).set( eq( "name" ), eq( "handleEvent" ) );
  }

  @Test
  public void testCreationWithString_setsString() {
    RemoteObject listenerRemoteObject = mock( RemoteObject.class );
    Connection connection = mock( Connection.class );
    when( connection.createRemoteObject( eq( CLIENT_LISTENER_TYPE ) ) )
    .thenReturn( listenerRemoteObject );
    Fixture.fakeConnection( connection );

    new ClientFunction( "my script code" );

    verify( listenerRemoteObject ).set( eq( "scriptCode" ), eq( "my script code" ) );
  }

  @Test
  public void testCreationWithScript_setsScriptId() {
    RemoteObject listenerRemoteObject = mock( RemoteObject.class );
    fakeConnection( listenerRemoteObject, CLIENT_LISTENER_TYPE );
    Script script = mock( Script.class );
    when( script.getId() ).thenReturn( "fooId" );

    new ClientFunction( script );

    verify( listenerRemoteObject ).set( eq( "scriptId" ), eq( "fooId" ) );
  }

  @Test
  public void testAddTo_createsBinding() {
    function.addTo( "w101", "MouseDown" );

    assertNotNull( function.findBinding( "w101", "MouseDown" ) );
  }

  @Test
  public void testAddTo_ignoresSubsequentCalls() {
    Connection connection = fakeConnection( mock( RemoteObject.class ), LISTENER_BINDING_TYPE );

    function.addTo( "w101", "KeyDown" );
    function.addTo( "w101", "KeyDown" );

    assertEquals( 1, function.getBindings().size() );
    verify( connection, times( 1 ) ).createRemoteObject( eq( LISTENER_BINDING_TYPE ) );
  }

  @Test
  public void testRemoveFrom_disposesBinding() {
    function.addTo( "w101", "MouseDown" );
    ClientListenerBinding binding = function.findBinding( "w101", "MouseDown" );

    function.removeFrom( "w101", "MouseDown" );

    assertTrue( binding.isDisposed() );
  }

  @Test
  public void testRemoveFrom_RemovesBindingFromList() {
    function.addTo( "w101", "MouseDown" );

    function.removeFrom( "w101", "MouseDown" );

    assertNull( function.findBinding( "w101", "MouseDown" ) );
  }

  @Test
  public void testRemoveFrom_mayBeCalledTwice() {
    function.addTo( "w101", "MouseDown" );
    ClientListenerBinding binding = function.findBinding( "w101", "MouseDown" );

    function.removeFrom( "w101", "MouseDown" );
    function.removeFrom( "w101", "MouseDown" );

    assertTrue( binding.isDisposed() );
  }

  @Test
  public void testRemoveFrom_ignoresNonExistingBinding() {
    function.removeFrom( "w101", "MouseDown" );

    assertNull( function.findBinding( "w101", "MouseDown" ) );
  }

  private void createListener() {
    function = spy( new ClientFunction( new Script( "code" ) ) );
  }

}