/*******************************************************************************
* Copyright (c) 2009, 2010 Sven Kiera
* 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
*******************************************************************************/
package org.phpsrc.eclipse.pti.tools.phpunit;
import java.io.File;
import java.net.URL;
import java.util.ArrayList;
import java.util.List;
import org.eclipse.core.resources.IProject;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.FileLocator;
import org.eclipse.core.runtime.IConfigurationElement;
import org.eclipse.core.runtime.IExtensionPoint;
import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.ListenerList;
import org.eclipse.core.runtime.MultiStatus;
import org.eclipse.core.runtime.Path;
import org.eclipse.core.runtime.Platform;
import org.eclipse.core.runtime.Status;
import org.eclipse.jface.action.IAction;
import org.eclipse.jface.dialogs.IDialogSettings;
import org.eclipse.jface.resource.ImageDescriptor;
import org.eclipse.jface.resource.ImageRegistry;
import org.eclipse.swt.graphics.Image;
import org.eclipse.ui.IWorkbench;
import org.eclipse.ui.IWorkbenchPage;
import org.eclipse.ui.IWorkbenchWindow;
import org.osgi.framework.Bundle;
import org.osgi.framework.BundleContext;
import org.phpsrc.eclipse.pti.core.AbstractPHPToolPlugin;
import org.phpsrc.eclipse.pti.library.pear.PHPLibraryPEARPlugin;
import org.phpsrc.eclipse.pti.tools.phpunit.core.model.ITestRunListener;
import org.phpsrc.eclipse.pti.tools.phpunit.core.model.PHPUnitModel;
import org.phpsrc.eclipse.pti.tools.phpunit.core.preferences.PHPUnitPreferences;
import org.phpsrc.eclipse.pti.tools.phpunit.core.preferences.PHPUnitPreferencesFactory;
/**
* The activator class controls the plug-in life cycle
*/
public class PHPUnitPlugin extends AbstractPHPToolPlugin {
// The plug-in ID
public static final String PLUGIN_ID = "org.phpsrc.eclipse.pti.tools.phpunit";
public static final String IMG_PHPUNIT = "IMG_PHPUNIT"; //$NON-NLS-1$
public static final String IMG_PHPUNIT_TEST = "IMG_PHPUNIT_TEST"; //$NON-NLS-1$
public static final String IMG_PHPUNIT_TEST_ERROR = "IMG_PHPUNIT_TEST_ERROR"; //$NON-NLS-1$
public static final String IMG_PHPUNIT_TEST_FAIL = "IMG_PHPUNIT_TEST_FAIL"; //$NON-NLS-1$
public static final String IMG_PHPUNIT_TEST_IGNORED = "IMG_PHPUNIT_TEST_IGNORED"; //$NON-NLS-1$
public static final String IMG_PHPUNIT_TEST_OK = "IMG_PHPUNIT_TEST_OK"; //$NON-NLS-1$
public static final String IMG_PHPUNIT_TEST_SUITE = "IMG_PHPUNIT_TEST_SUITE"; //$NON-NLS-1$
public static final String IMG_PHPUNIT_TEST_SUITE_ERROR = "IMG_PHPUNIT_TEST_SUITE_ERROR"; //$NON-NLS-1$
public static final String IMG_PHPUNIT_TEST_SUITE_FAIL = "IMG_PHPUNIT_TEST_SUITE_FAIL"; //$NON-NLS-1$
public static final String IMG_PHPUNIT_TEST_SUITE_OK = "IMG_PHPUNIT_TEST_SUITE_OK"; //$NON-NLS-1$
public static final String ID_EXTENSION_POINT_TESTRUN_LISTENERS = PLUGIN_ID
+ "." + "testRunListeners"; //$NON-NLS-1$ //$NON-NLS-2$
private static final IPath ICONS_PATH = new Path("$nl$/icons/full"); //$NON-NLS-1$
private static final String HISTORY_DIR_NAME = "history"; //$NON-NLS-1$
private static final String CODE_COVERAGE_DIR_NAME = "codecoverage"; //$NON-NLS-1$
// The shared instance
private static PHPUnitPlugin plugin;
private final PHPUnitModel fPHPUnitModel = new PHPUnitModel();
/**
* List storing the registered test run listeners
*/
private List/* <ITestRunListener> */fLegacyTestRunListeners;
/**
* List storing the registered test run listeners
*/
private ListenerList/* <TestRunListener> */fNewTestRunListeners;
private static boolean fIsStopped = false;
/**
* The constructor
*/
public PHPUnitPlugin() {
fNewTestRunListeners = new ListenerList();
}
/*
* (non-Javadoc)
*
* @see
* org.eclipse.ui.plugin.AbstractUIPlugin#start(org.osgi.framework.BundleContext
* )
*/
public void start(BundleContext context) throws Exception {
super.start(context);
plugin = this;
fIsStopped = false;
fPHPUnitModel.start();
}
protected void initializeImageRegistry(ImageRegistry registry) {
registry.put(
IMG_PHPUNIT,
ImageDescriptor
.createFromURL(resolvePluginResourceURL("icons/full/obj16/phpunit.gif")));
registry.put(
IMG_PHPUNIT_TEST,
ImageDescriptor
.createFromURL(resolvePluginResourceURL("icons/full/obj16/test.gif")));
registry.put(
IMG_PHPUNIT_TEST_ERROR,
ImageDescriptor
.createFromURL(resolvePluginResourceURL("icons/full/obj16/testerr.gif")));
registry.put(
IMG_PHPUNIT_TEST_FAIL,
ImageDescriptor
.createFromURL(resolvePluginResourceURL("icons/full/obj16/testfail.gif")));
registry.put(
IMG_PHPUNIT_TEST_IGNORED,
ImageDescriptor
.createFromURL(resolvePluginResourceURL("icons/full/obj16/testignored.gif")));
registry.put(
IMG_PHPUNIT_TEST_OK,
ImageDescriptor
.createFromURL(resolvePluginResourceURL("icons/full/obj16/testok.gif")));
registry.put(
IMG_PHPUNIT_TEST_SUITE,
ImageDescriptor
.createFromURL(resolvePluginResourceURL("icons/full/obj16/tsuite.gif")));
registry.put(
IMG_PHPUNIT_TEST_SUITE_ERROR,
ImageDescriptor
.createFromURL(resolvePluginResourceURL("icons/full/obj16/tsuiteerror.gif")));
registry.put(
IMG_PHPUNIT_TEST_SUITE_FAIL,
ImageDescriptor
.createFromURL(resolvePluginResourceURL("icons/full/obj16/tsuitefail.gif")));
registry.put(
IMG_PHPUNIT_TEST_SUITE_OK,
ImageDescriptor
.createFromURL(resolvePluginResourceURL("icons/full/obj16/tsuiteok.gif")));
}
/*
* (non-Javadoc)
*
* @see
* org.eclipse.ui.plugin.AbstractUIPlugin#stop(org.osgi.framework.BundleContext
* )
*/
public void stop(BundleContext context) throws Exception {
try {
for (File file : getHistoryDirectory().listFiles()) {
if (file.isFile())
file.delete();
}
} catch (Exception e) {
}
fIsStopped = true;
try {
fPHPUnitModel.stop();
} finally {
plugin = null;
super.stop(context);
}
}
public static PHPUnitModel getModel() {
return getDefault().fPHPUnitModel;
}
/**
* Returns the shared instance
*
* @return the shared instance
*/
public static PHPUnitPlugin getDefault() {
return plugin;
}
public IPath[] getPluginIncludePaths(IProject project) {
PHPUnitPreferences prefs = PHPUnitPreferencesFactory.factory(project);
IPath[] pearPaths = PHPLibraryPEARPlugin.getDefault()
.getPluginIncludePaths(prefs.getPearLibraryName());
IPath[] includePaths = new IPath[pearPaths.length + 1];
includePaths[0] = resolvePluginResource("/php/tools");
System.arraycopy(pearPaths, 0, includePaths, 1, pearPaths.length);
return includePaths;
}
public static ImageDescriptor getImageDescriptor(String relativePath) {
IPath path = ICONS_PATH.append(relativePath);
return createImageDescriptor(getDefault().getBundle(), path, true);
}
public static Image createImage(String path) {
return getImageDescriptor(path).createImage();
}
/**
* Sets the three image descriptors for enabled, disabled, and hovered to an
* action. The actions are retrieved from the *lcl16 folders.
*
* @param action
* the action
* @param iconName
* the icon name
*/
public static void setLocalImageDescriptors(IAction action, String iconName) {
setImageDescriptors(action, "lcl16", iconName); //$NON-NLS-1$
}
private static void setImageDescriptors(IAction action, String type,
String relPath) {
ImageDescriptor id = createImageDescriptor("d" + type, relPath, false); //$NON-NLS-1$
if (id != null)
action.setDisabledImageDescriptor(id);
ImageDescriptor descriptor = createImageDescriptor(
"e" + type, relPath, true); //$NON-NLS-1$
action.setHoverImageDescriptor(descriptor);
action.setImageDescriptor(descriptor);
}
/*
* Creates an image descriptor for the given prefix and name in the JDT UI
* bundle. The path can contain variables like $NL$. If no image could be
* found, <code>useMissingImageDescriptor</code> decides if either the
* 'missing image descriptor' is returned or <code>null</code>. or
* <code>null</code>.
*/
private static ImageDescriptor createImageDescriptor(String pathPrefix,
String imageName, boolean useMissingImageDescriptor) {
IPath path = ICONS_PATH.append(pathPrefix).append(imageName);
return createImageDescriptor(PHPUnitPlugin.getDefault().getBundle(),
path, useMissingImageDescriptor);
}
/**
* Creates an image descriptor for the given path in a bundle. The path can
* contain variables like $NL$. If no image could be found,
* <code>useMissingImageDescriptor</code> decides if either the 'missing
* image descriptor' is returned or <code>null</code>.
*
* @param bundle
* a bundle
* @param path
* path in the bundle
* @param useMissingImageDescriptor
* if <code>true</code>, returns the shared image descriptor for
* a missing image. Otherwise, returns <code>null</code> if the
* image could not be found
* @return an {@link ImageDescriptor}, or <code>null</code> iff there's no
* image at the given location and
* <code>useMissingImageDescriptor</code> is <code>true</code>
*/
private static ImageDescriptor createImageDescriptor(Bundle bundle,
IPath path, boolean useMissingImageDescriptor) {
URL url = FileLocator.find(bundle, path, null);
if (url != null) {
return ImageDescriptor.createFromURL(url);
}
if (useMissingImageDescriptor) {
return ImageDescriptor.getMissingImageDescriptor();
}
return null;
}
public static boolean isStopped() {
return fIsStopped;
}
public IDialogSettings getDialogSettingsSection(String name) {
IDialogSettings dialogSettings = getDialogSettings();
IDialogSettings section = dialogSettings.getSection(name);
if (section == null) {
section = dialogSettings.addNewSection(name);
}
return section;
}
public static File getHistoryDirectory() throws IllegalStateException {
File historyDir = getDefault().getStateLocation()
.append(HISTORY_DIR_NAME).toFile();
if (!historyDir.isDirectory()) {
historyDir.mkdir();
}
return historyDir;
}
public static File getCodeCoverageDirectory() throws IllegalStateException {
File coverageDir = getDefault().getStateLocation()
.append(CODE_COVERAGE_DIR_NAME).toFile();
if (!coverageDir.isDirectory()) {
coverageDir.mkdir();
}
return coverageDir;
}
/**
* Returns the active workbench window
*
* @return the active workbench window
*/
public static IWorkbenchWindow getActiveWorkbenchWindow() {
if (plugin == null)
return null;
IWorkbench workBench = plugin.getWorkbench();
if (workBench == null)
return null;
return workBench.getActiveWorkbenchWindow();
}
public static IWorkbenchPage getActivePage() {
IWorkbenchWindow activeWorkbenchWindow = getActiveWorkbenchWindow();
if (activeWorkbenchWindow == null)
return null;
return activeWorkbenchWindow.getActivePage();
}
/**
* @return a <code>ListenerList</code> of all <code>TestRunListener</code>s
*/
public ListenerList/* <TestRunListener> */getNewTestRunListeners() {
return fNewTestRunListeners;
}
/**
* @return an array of all TestRun listeners
*/
public ITestRunListener[] getTestRunListeners() {
if (fLegacyTestRunListeners == null) {
loadTestRunListeners();
}
return (ITestRunListener[]) fLegacyTestRunListeners
.toArray(new ITestRunListener[fLegacyTestRunListeners.size()]);
}
/**
* Initializes TestRun Listener extensions
*
*/
private void loadTestRunListeners() {
fLegacyTestRunListeners = new ArrayList();
IExtensionPoint extensionPoint = Platform.getExtensionRegistry()
.getExtensionPoint(ID_EXTENSION_POINT_TESTRUN_LISTENERS);
if (extensionPoint == null) {
return;
}
IConfigurationElement[] configs = extensionPoint
.getConfigurationElements();
MultiStatus status = new MultiStatus(PLUGIN_ID, IStatus.OK,
"Could not load some testRunner extension points", null); //$NON-NLS-1$
for (int i = 0; i < configs.length; i++) {
try {
Object testRunListener = configs[i]
.createExecutableExtension("class"); //$NON-NLS-1$
if (testRunListener instanceof ITestRunListener) {
fLegacyTestRunListeners.add(testRunListener);
}
} catch (CoreException e) {
status.add(e.getStatus());
}
}
if (!status.isOK()) {
PHPUnitPlugin.getDefault().getLog().log(status);
}
}
public static void log(Throwable e) {
log(new Status(IStatus.ERROR, PLUGIN_ID, IStatus.ERROR, "Error", e)); //$NON-NLS-1$
}
public static void log(IStatus status) {
getDefault().getLog().log(status);
}
}