ButtonLCA_Test.java

/*******************************************************************************
 * Copyright (c) 2002, 2015 Innoopract Informationssysteme GmbH 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:
 *    Innoopract Informationssysteme GmbH - initial API and implementation
 *    EclipseSource - ongoing development
 ******************************************************************************/
package org.eclipse.swt.internal.widgets.buttonkit;

import static org.eclipse.rap.rwt.internal.lifecycle.WidgetUtil.getId;
import static org.eclipse.rap.rwt.internal.protocol.RemoteObjectFactory.getRemoteObject;
import static org.eclipse.rap.rwt.testfixture.internal.TestMessage.getParent;
import static org.eclipse.rap.rwt.testfixture.internal.TestMessage.getStyles;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertSame;
import static org.junit.Assert.assertTrue;
import static org.mockito.Matchers.any;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.times;
import static org.mockito.Mockito.verify;

import java.io.IOException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;

import org.eclipse.rap.json.JsonArray;
import org.eclipse.rap.json.JsonObject;
import org.eclipse.rap.json.JsonValue;
import org.eclipse.rap.rwt.RWT;
import org.eclipse.rap.rwt.internal.lifecycle.RemoteAdapter;
import org.eclipse.rap.rwt.internal.lifecycle.WidgetUtil;
import org.eclipse.rap.rwt.internal.protocol.ClientMessageConst;
import org.eclipse.rap.rwt.internal.protocol.Operation.CreateOperation;
import org.eclipse.rap.rwt.internal.remote.RemoteObjectRegistry;
import org.eclipse.rap.rwt.remote.OperationHandler;
import org.eclipse.rap.rwt.scripting.ClientListener;
import org.eclipse.rap.rwt.testfixture.internal.Fixture;
import org.eclipse.rap.rwt.testfixture.internal.TestMessage;
import org.eclipse.rap.rwt.testfixture.internal.TestUtil;
import org.eclipse.swt.SWT;
import org.eclipse.swt.events.SelectionAdapter;
import org.eclipse.swt.events.SelectionEvent;
import org.eclipse.swt.events.SelectionListener;
import org.eclipse.swt.graphics.Image;
import org.eclipse.swt.internal.graphics.ImageFactory;
import org.eclipse.swt.internal.widgets.IShellAdapter;
import org.eclipse.swt.internal.widgets.Props;
import org.eclipse.swt.internal.widgets.controlkit.ControlLCATestUtil;
import org.eclipse.swt.internal.widgets.shellkit.ShellOperationHandler;
import org.eclipse.swt.widgets.Button;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Event;
import org.eclipse.swt.widgets.Label;
import org.eclipse.swt.widgets.Listener;
import org.eclipse.swt.widgets.Shell;
import org.eclipse.swt.widgets.Widget;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;


public class ButtonLCA_Test {

  private Display display;
  private Shell shell;
  private Button button;
  private ButtonLCA lca;

  @Before
  public void setUp() {
    Fixture.setUp();
    display = new Display();
    shell = new Shell( display );
    button = new Button( shell, SWT.PUSH );
    lca = ButtonLCA.INSTANCE;
  }

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

  @Test
  public void testCommonControlProperties() throws IOException {
    ControlLCATestUtil.testCommonControlProperties( button );
  }

  @Test
  public void testRadioPreserveValues() throws IOException {
    button = new Button( shell, SWT.RADIO );
    Fixture.markInitialized( display );
    testPreserveValues( display, button );
    button.setSelection( true );
    Fixture.preserveWidgets();
    RemoteAdapter adapter = WidgetUtil.getAdapter( button );
    assertEquals( Boolean.TRUE, adapter.getPreserved( "selection" ) );
  }

  @Test
  public void testCheckPreserveValues() throws IOException {
    button = new Button( shell, SWT.CHECK );
    Fixture.markInitialized( display );
    testPreserveValues( display, button );
    button.setSelection( true );
    button.setGrayed( true );
    Fixture.preserveWidgets();
    RemoteAdapter adapter = WidgetUtil.getAdapter( button );
    assertEquals( Boolean.TRUE, adapter.getPreserved( "selection" ) );
    assertEquals( Boolean.TRUE, adapter.getPreserved( "grayed" ) );
  }

  @Test
  public void testTogglePreserveValues() throws IOException {
    button = new Button( shell, SWT.TOGGLE );
    Fixture.markInitialized( display );
    testPreserveValues( display, button );
    button.setSelection( true );
    Fixture.preserveWidgets();
    RemoteAdapter adapter = WidgetUtil.getAdapter( button );
    assertEquals( Boolean.TRUE, adapter.getPreserved( "selection" ) );
  }

  private void testPreserveValues( Display display, Button button ) throws IOException {
    // Text,Image
    RemoteAdapter adapter = WidgetUtil.getAdapter( button );
    if( ( button.getStyle() & SWT.ARROW ) == 0 ) {
      button.setText( "abc" );
      Fixture.preserveWidgets();
      adapter = WidgetUtil.getAdapter( button );
      Object object = adapter.getPreserved( Props.TEXT );
      assertEquals( "abc", object );
      Fixture.clearPreserved();
      Image image = TestUtil.createImage( display, Fixture.IMAGE1 );
      button.setImage( image );
      Fixture.preserveWidgets();
      adapter = WidgetUtil.getAdapter( button );
      assertSame( image, adapter.getPreserved( Props.IMAGE ) );
      Fixture.clearPreserved();
    }
  }

  @Test
  public void testDisabledButtonSelection() {
    getRemoteObject( shell ).setHandler( new ShellOperationHandler( shell ) );
    button = new Button( shell, SWT.NONE );
    getRemoteObject( button ).setHandler( new ButtonOperationHandler( button ) );
    Label label = new Label( shell, SWT.NONE );
    button.addListener( SWT.Activate, new Listener() {
      @Override
      public void handleEvent( Event event ) {
        button.setEnabled( false );
      }
    } );
    SelectionListener listener = mock( SelectionListener.class );
    button.addSelectionListener( listener );
    shell.getAdapter( IShellAdapter.class ).setActiveControl( label );
    Fixture.fakeNewRequest();
    Fixture.fakeNotifyOperation( getId( button ), ClientMessageConst.EVENT_SELECTION, null );
    fakeActiveControl( button );

    Fixture.readDataAndProcessAction( display );

    assertFalse( button.getEnabled() );
    verify( listener, times( 0 ) ).widgetSelected( any( SelectionEvent.class ) );
  }

  @Test
  public void testRadioTypedSelectionEventOrder_TypedListener() {
    final List<Widget> log = new ArrayList<Widget>();
    Button button1 = new Button( shell, SWT.RADIO );
    getRemoteObject( button1 ).setHandler( new ButtonOperationHandler( button1 ) );
    Button button2 = new Button( shell, SWT.RADIO );
    getRemoteObject( button2 ).setHandler( new ButtonOperationHandler( button2 ) );
    button2.setSelection( true );
    SelectionAdapter listener = new SelectionAdapter() {
      @Override
      public void widgetSelected( SelectionEvent event ) {
        log.add( event.widget );
      }
    };
    button1.addSelectionListener( listener );
    button2.addSelectionListener( listener );

    Fixture.fakeSetProperty( getId( button2 ), "selection", false );
    Fixture.fakeNotifyOperation( getId( button2 ), ClientMessageConst.EVENT_SELECTION, null );
    Fixture.fakeSetProperty( getId( button1 ), "selection", true );
    Fixture.fakeNotifyOperation( getId( button1 ), ClientMessageConst.EVENT_SELECTION, null );
    Fixture.readDataAndProcessAction( display );

    assertTrue( Arrays.equals( new Widget[]{ button2, button1 }, log.toArray() ) );
  }

  @Test
  public void testRadioTypedSelectionEventOrder_UntypedListener() {
    final List<Widget> log = new ArrayList<Widget>();
    Button button1 = new Button( shell, SWT.RADIO );
    getRemoteObject( button1 ).setHandler( new ButtonOperationHandler( button1 ) );
    Button button2 = new Button( shell, SWT.RADIO );
    getRemoteObject( button2 ).setHandler( new ButtonOperationHandler( button2 ) );
    button2.setSelection( true );
    Listener listener = new Listener() {
      @Override
      public void handleEvent( Event event ) {
        log.add( event.widget );
      }
    };
    button1.addListener( SWT.Selection, listener );
    button2.addListener( SWT.Selection, listener );

    Fixture.fakeSetProperty( getId( button2 ), "selection", false );
    Fixture.fakeNotifyOperation( getId( button2 ), ClientMessageConst.EVENT_SELECTION, null );
    Fixture.fakeSetProperty( getId( button1 ), "selection", true );
    Fixture.fakeNotifyOperation( getId( button1 ), ClientMessageConst.EVENT_SELECTION, null );
    Fixture.readDataAndProcessAction( display );

    assertTrue( Arrays.equals( new Widget[]{ button2, button1 }, log.toArray() ) );
  }

  @Test
  public void testRenderWrap() throws Exception {
    button = new Button( shell, SWT.PUSH | SWT.WRAP );
    Fixture.fakeResponseWriter();

    lca.renderInitialization( button );

    TestMessage message = Fixture.getProtocolMessage();
    CreateOperation operation = message.findCreateOperation( button );
    assertTrue( getStyles( operation ).contains( "WRAP" ) );
  }

  @Test
  public void testRenderCreate() throws IOException {
    Button pushButton = new Button( shell, SWT.PUSH );

    lca.renderInitialization( pushButton );

    TestMessage message = Fixture.getProtocolMessage();
    CreateOperation operation = message.findCreateOperation( pushButton );
    assertEquals( "rwt.widgets.Button", operation.getType() );
    assertTrue( getStyles( operation ).contains( "PUSH" ) );
  }

  @Test
  public void testRenderCreateArrow() throws IOException {
    Button pushButton = new Button( shell, SWT.ARROW );

    lca.renderInitialization( pushButton );

    TestMessage message = Fixture.getProtocolMessage();
    CreateOperation operation = message.findCreateOperation( pushButton );
    assertEquals( "rwt.widgets.Button", operation.getType() );
    assertTrue( getStyles( operation ).contains( "ARROW" ) );
  }

  @Test
  public void testRenderCreateWithMarkupEnabled() throws IOException {
    button.setData( RWT.MARKUP_ENABLED, Boolean.TRUE );

    lca.renderInitialization( button );

    TestMessage message = Fixture.getProtocolMessage();
    CreateOperation operation = message.findCreateOperation( button );
    assertEquals( JsonValue.TRUE, operation.getProperties().get( "markupEnabled" ) );
  }

  @Test
  public void testRenderInitialization_setsOperationHandler() throws IOException {
    String id = getId( button );
    lca.renderInitialization( button );

    OperationHandler handler = RemoteObjectRegistry.getInstance().get( id ).getHandler();
    assertTrue( handler instanceof ButtonOperationHandler );
  }

  @Test
  public void testRenderParent() throws IOException {
    Button pushButton = new Button( shell, SWT.PUSH );

    lca.renderInitialization( pushButton );

    TestMessage message = Fixture.getProtocolMessage();
    CreateOperation operation = message.findCreateOperation( pushButton );
    assertEquals( getId( pushButton.getParent() ), getParent( operation ) );
  }

  @Test
  public void testRenderDirection_default() throws IOException {
    lca.render( button );

    TestMessage message = Fixture.getProtocolMessage();
    CreateOperation operation = message.findCreateOperation( button );
    assertNull( operation.getProperties().get( "direction" ) );
  }

  @Test
  public void testRenderDirection_RTL() throws IOException {
    button = new Button( shell, SWT.PUSH | SWT.RIGHT_TO_LEFT );

    lca.render( button );

    TestMessage message = Fixture.getProtocolMessage();
    assertEquals( "rtl", message.findCreateProperty( button, "direction" ).asString() );
  }

  @Test
  public void testRenderInitialText() throws IOException {
    lca.renderChanges( button );

    TestMessage message = Fixture.getProtocolMessage();
    assertNull( message.findSetOperation( button, "text" ) );
  }

  @Test
  public void testRenderText() throws IOException {
    button.setText( "test" );
    lca.renderChanges( button );

    TestMessage message = Fixture.getProtocolMessage();
    assertEquals( "test", message.findSetProperty( button, "text" ).asString() );
  }

  @Test
  public void testRenderTextWithQuotationMarks() throws IOException {
    button.setText( "te\"s't" );
    lca.renderChanges( button );

    TestMessage message = Fixture.getProtocolMessage();
    assertEquals( "te\"s't", message.findSetProperty( button, "text" ).asString() );
  }

  @Test
  public void testRenderTextWithMnemonic() throws IOException {
    button.setText( "te&st" );
    lca.renderChanges( button );

    TestMessage message = Fixture.getProtocolMessage();
    assertEquals( "test", message.findSetProperty( button, "text" ).asString() );
  }

  @Test
  public void testRenderTextWithNewlines() throws IOException {
    button.setText( "\ntes\r\nt\n" );
    lca.renderChanges( button );

    TestMessage message = Fixture.getProtocolMessage();
    assertEquals( "\ntes\r\nt\n", message.findSetProperty( button, "text" ).asString() );
  }

  @Test
  public void testRenderTextUnchanged() throws IOException {
    Fixture.markInitialized( display );
    Fixture.markInitialized( button );

    button.setText( "foo" );
    Fixture.preserveWidgets();
    lca.renderChanges( button );

    TestMessage message = Fixture.getProtocolMessage();
    assertNull( message.findSetOperation( button, "text" ) );
  }

  @Test
  public void testRenderInitialAlignment() throws IOException {
    lca.renderChanges( button );

    TestMessage message = Fixture.getProtocolMessage();
    assertNull( message.findSetOperation( button, "alignment" ) );
  }

  @Test
  public void testRenderInitialAlignment_Arrow() throws IOException {
    button = new Button( shell, SWT.ARROW );

    lca.renderChanges( button );

    TestMessage message = Fixture.getProtocolMessage();
    assertEquals( "up", message.findSetProperty( button, "alignment" ).asString() );
  }

  @Test
  public void testRenderAlignment() throws IOException {
    button.setAlignment( SWT.RIGHT );
    lca.renderChanges( button );

    TestMessage message = Fixture.getProtocolMessage();
    assertEquals( "right", message.findSetProperty( button, "alignment" ).asString() );
  }

  @Test
  public void testRenderAlignment_Arrow() throws IOException {
    button = new Button( shell, SWT.ARROW | SWT.DOWN );

    lca.renderChanges( button );

    TestMessage message = Fixture.getProtocolMessage();
    assertEquals( "down", message.findSetProperty( button, "alignment" ).asString() );
  }

  @Test
  public void testRenderAlignmentUnchanged() throws IOException {
    Fixture.markInitialized( display );
    Fixture.markInitialized( button );

    button.setAlignment( SWT.RIGHT );
    Fixture.preserveWidgets();
    lca.renderChanges( button );

    TestMessage message = Fixture.getProtocolMessage();
    assertNull( message.findSetOperation( button, "alignment" ) );
  }

  @Test
  public void testRenderListen_Selection() throws Exception {
    Fixture.markInitialized( button );
    Fixture.clearPreserved();

    button.addListener( SWT.Selection, mock( Listener.class ) );
    lca.renderChanges( button );

    TestMessage message = Fixture.getProtocolMessage();
    assertEquals( JsonValue.TRUE, message.findListenProperty( button, "Selection" ) );
  }

  @Test
  public void testRenderInitialImage() throws IOException {
    lca.renderChanges( button );

    TestMessage message = Fixture.getProtocolMessage();
    assertNull( message.findSetOperation( button, "image" ) );
  }

  @Test
  public void testRenderImage() throws IOException {
    Image image = TestUtil.createImage( display, Fixture.IMAGE_100x50 );

    button.setImage( image );
    lca.renderChanges( button );

    TestMessage message = Fixture.getProtocolMessage();
    String imageLocation = ImageFactory.getImagePath( image );
    JsonArray expected = new JsonArray().add( imageLocation ).add( 100 ).add ( 50 );
    assertEquals( expected, message.findSetProperty( button, "image" ) );
  }

  @Test
  public void testRenderImageUnchanged() throws IOException {
    Fixture.markInitialized( display );
    Fixture.markInitialized( button );
    Image image = TestUtil.createImage( display, Fixture.IMAGE_100x50 );

    button.setImage( image );
    Fixture.preserveWidgets();
    lca.renderChanges( button );

    TestMessage message = Fixture.getProtocolMessage();
    assertNull( message.findSetOperation( button, "image" ) );
  }

  @Test
  public void testRenderImageReset() throws IOException {
    Fixture.markInitialized( display );
    Fixture.markInitialized( button );
    Image image = TestUtil.createImage( display, Fixture.IMAGE_100x50 );
    button.setImage( image );

    Fixture.preserveWidgets();
    button.setImage( null );
    lca.renderChanges( button );

    TestMessage message = Fixture.getProtocolMessage();
    assertEquals( JsonObject.NULL, message.findSetProperty( button, "image" ) );
  }

  @Test
  public void testRenderInitialSelection() throws IOException {
    button = new Button( shell, SWT.CHECK );

    lca.renderChanges( button );

    TestMessage message = Fixture.getProtocolMessage();
    assertNull( message.findSetOperation( button, "selection" ) );
  }

  @Test
  public void testRenderSelection() throws IOException {
    button = new Button( shell, SWT.CHECK );

    button.setSelection( true );
    lca.renderChanges( button );

    TestMessage message = Fixture.getProtocolMessage();
    assertEquals( JsonValue.TRUE, message.findSetProperty( button, "selection" ) );
  }

  @Test
  public void testRenderSelectionUnchanged() throws IOException {
    button = new Button( shell, SWT.CHECK );
    Fixture.markInitialized( display );
    Fixture.markInitialized( button );

    button.setSelection( true );
    Fixture.preserveWidgets();
    lca.renderChanges( button );

    TestMessage message = Fixture.getProtocolMessage();
    assertNull( message.findSetOperation( button, "selection" ) );
  }

  @Test
  public void testRenderInitialGrayed() throws IOException {
    button = new Button( shell, SWT.CHECK );

    lca.renderChanges( button );

    TestMessage message = Fixture.getProtocolMessage();
    assertNull( message.findSetOperation( button, "grayed" ) );
  }

  @Test
  public void testRenderGrayed() throws IOException {
    button = new Button( shell, SWT.CHECK );

    button.setGrayed( true );
    lca.renderChanges( button );

    TestMessage message = Fixture.getProtocolMessage();
    assertEquals( JsonValue.TRUE, message.findSetProperty( button, "grayed" ) );
  }

  @Test
  public void testRenderGrayedUnchanged() throws IOException {
    button = new Button( shell, SWT.CHECK );
    Fixture.markInitialized( display );
    Fixture.markInitialized( button );

    button.setGrayed( true );
    Fixture.preserveWidgets();
    lca.renderChanges( button );

    TestMessage message = Fixture.getProtocolMessage();
    assertNull( message.findSetOperation( button, "grayed" ) );
  }

  @Test
  public void testRenderInitialMnemonicIndex() throws IOException {
    lca.renderChanges( button );

    TestMessage message = Fixture.getProtocolMessage();
    assertNull( message.findSetOperation( button, "mnemonicIndex" ) );
  }

  @Test
  public void testRenderMnemonicIndex() throws IOException {
    button.setText( "te&st" );
    lca.renderChanges( button );

    TestMessage message = Fixture.getProtocolMessage();
    assertEquals( 2, message.findSetProperty( button, "mnemonicIndex" ).asInt() );
  }

  @Test
  public void testRenderMnemonic_OnTextChange() throws IOException {
    Fixture.markInitialized( display );
    Fixture.markInitialized( button );

    button.setText( "te&st" );
    Fixture.preserveWidgets();
    button.setText( "aa&bb" );
    lca.renderChanges( button );

    TestMessage message = Fixture.getProtocolMessage();
    assertEquals( 2, message.findSetProperty( button, "mnemonicIndex" ).asInt() );
  }

  @Test
  public void testRenderMnemonicIndexUnchanged() throws IOException {
    Fixture.markInitialized( display );
    Fixture.markInitialized( button );

    button.setText( "te&st" );
    Fixture.preserveWidgets();
    lca.renderChanges( button );

    TestMessage message = Fixture.getProtocolMessage();
    assertNull( message.findSetOperation( button, "mnemonicIndex" ) );
  }

  @Test
  public void testRenderChanges_rendersClientListener() throws IOException {
    button.addListener( SWT.Paint, new ClientListener( "" ) );

    lca.renderChanges( button );

    TestMessage message = Fixture.getProtocolMessage();
    assertNotNull( message.findCallOperation( button, "addListener" ) );
  }

  @Test
  public void testRenderInitialBadge() throws IOException {
    lca.renderChanges( button );

    TestMessage message = Fixture.getProtocolMessage();
    assertNull( message.findSetOperation( button, "badge" ) );
  }

  @Test
  public void testRenderBadge() throws IOException {
    button.setData( RWT.BADGE, "11" );

    lca.renderChanges( button );

    TestMessage message = Fixture.getProtocolMessage();
    assertEquals( "11", message.findSetProperty( button, "badge" ).asString() );
  }

  @Test
  public void testRenderBadgeUnchanged() throws IOException {
    Fixture.markInitialized( display );
    Fixture.markInitialized( button );

    button.setData( RWT.BADGE, "11" );
    Fixture.preserveWidgets();
    lca.renderChanges( button );

    TestMessage message = Fixture.getProtocolMessage();
    assertNull( message.findSetOperation( button, "badge" ) );
  }

  private void fakeActiveControl( Control control ) {
    Fixture.fakeSetProperty( getId( control.getShell() ), "activeControl", getId( control ) );
  }

}