source: trunk/org.modelica.mdt.test/src/org/modelica/mdt/test/Utility.java @ 79

/*
 * This file is part of Modelica Development Tooling.
 *
 * Copyright (c) 2005, Linköpings universitet, Department of
 * Computer and Information Science, PELAB
 *
 * All rights reserved.
 *
 * (The new BSD license, see also
 * http://www.opensource.org/licenses/bsd-license.php)
 *
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 * * Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 *
 * * Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in
 *   the documentation and/or other materials provided with the
 *   distribution.
 *
 * * Neither the name of Linköpings universitet nor the names of its
 *   contributors may be used to endorse or promote products derived from
 *   this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

package org.modelica.mdt.test;

import java.util.concurrent.Semaphore;

import junit.framework.Assert;

import org.eclipse.core.runtime.CoreException;
import org.eclipse.jface.viewers.IStructuredSelection;
import org.eclipse.jface.viewers.StructuredSelection;
import org.eclipse.jface.wizard.WizardDialog;
import org.eclipse.swt.widgets.Button;
import org.eclipse.ui.IWorkbench;
import org.eclipse.ui.IWorkbenchWizard;
import org.eclipse.ui.PlatformUI;
import org.eclipse.ui.wizards.IWizardDescriptor;

import abbot.finder.matchers.swt.TextMatcher;
import abbot.finder.swt.BasicFinder;
import abbot.finder.swt.MultipleWidgetsFoundException;
import abbot.finder.swt.TestHierarchy;
import abbot.finder.swt.WidgetNotFoundException;

/**
 * @author Elmir Jagudin
 *
 * This class contains some utility code for assisting the testcases
 */
public class Utility 
{

    /**
     * creates and opens a wizard
     *  
     * @param wizardID the ID of the wizard to create and open
     * @param selection the selection which is used to initialize the wizard
     */
    public static IWorkbenchWizard openWizard(String wizardID, 
            IStructuredSelection selection)
    {
        
        IWorkbench workbench = PlatformUI.getWorkbench();
        IWizardDescriptor wizDesc = 
            workbench.getNewWizardRegistry().findWizard(wizardID);  
        Assert.assertNotNull("wizard " + wizardID + " not found", wizDesc);
        
        IWorkbenchWizard wizard = null;
        try
        {
            wizard = wizDesc.createWizard();
        }
        catch (CoreException e)
        {
            Assert.fail("Could not create " + wizardID + 
                    " wizard, CoreException thrown\n" + e.getMessage());
        }
        Assert.assertNotNull(wizard);
        
        wizard.init(workbench, selection);
        final WizardDialog dialog = 
            new WizardDialog(workbench.getActiveWorkbenchWindow().getShell(), wizard);
        dialog.create();

        final Semaphore sem = new Semaphore(0);
        
        dialog.getShell().getDisplay().syncExec(new Runnable()
        {
            public void run()
            {
                dialog.setBlockOnOpen(false);
                dialog.open();
                sem.release();
            }
        });
        
        try
        {
            sem.acquire();
        } 
        catch (InterruptedException e)
        {
            Assert.fail("interruped while waiting for dialog to open");
        }
        
        return wizard;
    }
    /**
     * creates and opens a wizard initialized with empty selection
     *  
     * @param wizardID the ID of the wizard to create and open
     */
    public static IWorkbenchWizard openWizard(String wizardID)
    {
        return openWizard(wizardID, StructuredSelection.EMPTY);
    }
    
    /**
     * 
     * @return currently displayed button with text '&Finish'
     * this function will fail if not exactly one finish button is
     * on the screen
     */
    public static Button findFinishButton()
    {
        BasicFinder finder =  /* find finish button */
            new BasicFinder(new TestHierarchy(PlatformUI.getWorkbench().getDisplay()));

        try
        {
            return (Button) finder.find(new TextMatcher("&Finish"));
        }
        catch (WidgetNotFoundException e)
        {
            Assert.fail("Finish button not found.");
        } 
        catch (MultipleWidgetsFoundException e) 
        {
            Assert.fail("Multiple finish buttons found.");
        }
        
        Assert.fail("this is not happening");
        return null;
    }
    /*
     * sleeps for approx time seconds
     * this method does not garantee that it will sleep any particular time
     */
    public static void sleep(Object mutex, long time)
    {
        try 
        {
            synchronized (mutex)
            {
                mutex.wait(time);
            }
        } 
        catch (InterruptedException e)
        {
            e.printStackTrace();
        }
    }
}