tests/test.integration.ui/src/main/java/org/apache/directory/studio/test/integration/ui/bots/DialogBot.java

/*
 *  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.directory.studio.test.integration.ui.bots;


import org.apache.commons.lang3.StringUtils;
import org.apache.directory.studio.test.integration.ui.utils.JobWatcher;
import org.eclipse.swtbot.eclipse.finder.SWTWorkbenchBot;
import org.eclipse.swtbot.swt.finder.utils.SWTBotPreferences;
import org.eclipse.swtbot.swt.finder.waits.DefaultCondition;
import org.eclipse.swtbot.swt.finder.widgets.SWTBotButton;
import org.eclipse.swtbot.swt.finder.widgets.SWTBotShell;


public abstract class DialogBot
{

    protected SWTWorkbenchBot bot = new SWTWorkbenchBot();
    protected String title;
    protected String[] okButtonJobWatcherJobNames = null;

    protected DialogBot( String title )
    {
        this.title = title;
    }


    public void setWaitAfterClickOkButton( boolean wait, String... jobNames )
    {
        if ( wait )
        {
            this.okButtonJobWatcherJobNames = jobNames;
        }
        else
        {
            this.okButtonJobWatcherJobNames = null;
        }
    }


    public void activate()
    {
        bot.shell( title ).setFocus();
    }


    public boolean isVisible()
    {
        return bot.shell( title ).isVisible();
    }


    public boolean isOkButtonEnabled()
    {
        return isButtonEnabled( "OK" );
    }


    private boolean isButtonEnabled( String buttonTitle )
    {
        activate();
        final SWTBotButton button = bot.button( buttonTitle );
        return button.isEnabled();
    }


    public void clickOkButton()
    {
        if ( okButtonJobWatcherJobNames != null )
        {
            JobWatcher jobWatcher = new JobWatcher( okButtonJobWatcherJobNames );
            clickButton( "OK" );
            jobWatcher.waitUntilDone();
        }
        else
        {
            clickButton( "OK" );
        }
    }


    public ErrorDialogBot clickOkButtonExpectingErrorDialog()
    {
        String shellText = BotUtils.shell( () -> clickButton( "OK" ), "Error", "Problem Occurred" ).getText();
        return new ErrorDialogBot( shellText );
    }


    public void clickCancelButton()
    {
        clickButton( "Cancel" );
    }


    public void waitForDialog()
    {
        bot.waitUntil( new DefaultCondition()
        {

            @Override
            public boolean test() throws Exception
            {
                return isVisible();
            }


            @Override
            public String getFailureMessage()
            {
                return "Dialog did not appear: " + title;
            }
        }, SWTBotPreferences.TIMEOUT * 4 );
    }


    protected void clickButton( final String buttonTitle )
    {
        activate();
        final SWTBotButton button = bot.button( buttonTitle );
        button.click();
    }


    protected CheckResponse clickCheckButton( final String label, final String title )
    {
        SWTBotShell parentShell = bot.activeShell();
        SWTBotShell shell = BotUtils.shell( new Runnable()
        {
            public void run()
            {
                bot.button( label ).click();
            }
        }, "Error", title );

        String shellText = shell.getText();
        // label(0) may be the image
        String messageText = bot.label( 0 ).getText();
        if ( StringUtils.isBlank( messageText ) )
        {
            messageText = bot.label( 1 ).getText();
        }
        bot.button( "OK" ).click();
        parentShell.activate();

        if ( shellText.equals( title ) )
        {
            return new CheckResponse( false, shellText, messageText );
        }
        else
        {
            return new CheckResponse( true, shellText, messageText );
        }
    }

    public static class CheckResponse
    {
        boolean isError;
        String title;
        String message;

        public CheckResponse( boolean isError, String title, String message )
        {
            this.isError = isError;
            this.title = title;
            this.message = message;
        }


        public boolean isError()
        {
            return isError;
        }


        public String getTitle()
        {
            return title;
        }


        public String getMessage()
        {
            return message;
        }

    }
}