GuiTestRunnerFrameActionPerformer.java

/*
 * Copyright [1999-2015] Wellcome Trust Sanger Institute and the EMBL-European Bioinformatics Institute
 * Copyright [2016-2017] EMBL-European Bioinformatics Institute
 * 
 * Licensed 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.ensembl.healthcheck.eg_gui;

import java.util.ArrayList;
import java.util.List;

import javax.swing.JComponent;
import javax.swing.JList;
import javax.swing.ListModel;

import org.ensembl.healthcheck.DatabaseRegistry;
import org.ensembl.healthcheck.DatabaseRegistryEntry;
import org.ensembl.healthcheck.configuration.ConfigureHost;
import org.ensembl.healthcheck.eg_gui.TestProgressDialog;
import org.ensembl.healthcheck.testcase.EnsTestCase;
import org.ensembl.healthcheck.testcase.PerlScriptConfig;
import org.ensembl.healthcheck.util.ConnectionPool;
import org.ensembl.healthcheck.util.DBUtils;

/**
 * 
 * <p>
 * 	Collection of static methods. The actionPerformed method in the 
 * GuiGroupTestRunnerFrame delegates here. It is a collection of code
 * that executes actions the user requested. Put here so it won't clutter
 * the code in GuiGroupTestRunnerFrame.
 * </p>
 * 
 * @author michael
 *
 */
public class GuiTestRunnerFrameActionPerformer {

	/**
	 * <p>
	 * 	This is called when the user has selected a different database server.
	 * </p>
	 * 
	 * <p>
	 * 	Resets the databaseTabbedPane pane with dbDetails. The DBUtils
	 * object is reset in case it was used for accessing a different database
	 * server before this one.
	 * </p>
	 * 
	 * @param databaseTabbedPane
	 * @param dbDetails
	 * 
	 */
	public static Thread setupDatabasePane(
			final DatabaseTabbedPane databaseTabbedPane,
			ConfigureHost dbDetails
	) {
		DBUtils.initialise();
		DBUtils.setHostConfiguration(dbDetails);
		
		final List<String> regexps = new ArrayList<String>();
		regexps.add(".*");

		Thread t = new Thread() {

			public void run() {
			
				DatabaseRegistry databaseRegistry = new DatabaseRegistry(regexps, null,
						null, false);
				
				// Prevent holding lots of extra connections that might never be used.
				//
				ConnectionPool.closeAll();
				
				// Should throw an exception which can be caught and displayed 
				// something in a dialog box.
				//
				//if (databaseRegistry.getEntryCount() == 0) {
				//	logger.warning("Warning: no databases found!");
				//}
				
				databaseTabbedPane.init(databaseRegistry);
				databaseTabbedPane.repaint();
				
				//List<String> searchTerm = new ArrayList<String>();
				//searchTerm.add("ara");
				//databaseTabbedPane.applySearchtermFilter(searchTerm);
			}
		};
		databaseTabbedPane.setMessage(
			"Changing database server", 
			"Connecting and loading database entries, please wait"
		);
		t.start();
		return t;
	}

	/**
	 * <p>
	 * 	Finds out which tests the user wants to run and runs them.
	 * </p>
	 * 
	 * @param listOfTestsToBeRun
	 * @param databases
	 * @param testProgressDialog
	 * 
	 */
	public static Thread runSelectedTests(
			final JList listOfTestsToBeRun,
			final DatabaseRegistryEntry[] databases,
			final TestProgressDialog testProgressDialog,
			//final JComponent resultDisplayComponent,
			final String PERL5LIB,
			final PerlScriptConfig psc,
			final GuiLogHandler guiLogHandler
	) {
		
		Object[] whatsthis = listOfTestsToBeRun.getSelectedValues();
		
		// Awkward doing this with a loop, but necessary. This won't work:
		//
		// List<TestClassListItem> TestClassListItemList = Arrays.asList( (TestClassListItem[]) whatsthis);
		//
		List<TestClassListItem> TestClassListItemList = new ArrayList<TestClassListItem>();
		
		for (Object somethingNotEasilyCasted : whatsthis) {
			TestClassListItemList.add((TestClassListItem) somethingNotEasilyCasted);
		}
		
		return runListOfTestItems(
			TestClassListItemList,
			databases,
			testProgressDialog,
			//resultDisplayComponent,
			PERL5LIB,
			psc,
			guiLogHandler
		);
	}
	
	public static Thread runAllTests(
			final JList listOfTestsToBeRun,
			final DatabaseRegistryEntry[] databases,
			final TestProgressDialog testProgressDialog,
			//final JComponent resultDisplayComponent,
			final String PERL5LIB,
			final PerlScriptConfig psc,
			final GuiLogHandler guiLogHandler
	) {
		
		ListModel lm = listOfTestsToBeRun.getModel();
		List<TestClassListItem> TestClassListItemList = new ArrayList<TestClassListItem>();
		
		for(int i=0; i<lm.getSize(); i++) {
			
			TestClassListItemList.add((TestClassListItem) lm.getElementAt(i));
		}
		
		return runListOfTestItems(
			TestClassListItemList,
			databases,
			testProgressDialog,
			//resultDisplayComponent,
			PERL5LIB,
			psc,
			guiLogHandler
		);
	}
	
	public static Thread runListOfTestItems(
			final List<TestClassListItem> TestClassListItemList,
			final DatabaseRegistryEntry[] databases,
			final TestProgressDialog testProgressDialog,
			//final JComponent resultDisplayComponent,
			final String PERL5LIB,
			final PerlScriptConfig psc,
			final GuiLogHandler guiLogHandler
	) {
		
		List<Class<? extends EnsTestCase>> selectedTests = new ArrayList();
		
		for (TestClassListItem somethingNotEasilyCasted : TestClassListItemList) {
			
			TestClassListItem currentTestClassListItem = (TestClassListItem) somethingNotEasilyCasted;
			
			Class<? extends EnsTestCase> ensTestCaseClass = currentTestClassListItem.getTestClass();				
			selectedTests.add(ensTestCaseClass);
		}
		return GuiTestRunner.runAllTests(
			selectedTests, 
			databases, 
			testProgressDialog, 
			//resultDisplayComponent, 
			PERL5LIB,
			psc,
			guiLogHandler
		);
	}
	
	/**
	 * 
	 * <p>
	 * 	Removes the tests the user has selected from the list of tests to be run.
	 * </p>
	 * 
	 * @param listOfTestsToBeRun
	 * 
	 */
	public static void removeSelectedTests(final JList listOfTestsToBeRun) {
		
		TestClassListModel currentListModel = (TestClassListModel) listOfTestsToBeRun.getModel();
		
		for (Object selectedTestClassObject : listOfTestsToBeRun.getSelectedValues()) {
			
			TestClassListItem selectedTestClass = (TestClassListItem) selectedTestClassObject;
			currentListModel.removeTest(selectedTestClass.getTestClass());
		}
		listOfTestsToBeRun.clearSelection();
		listOfTestsToBeRun.repaint();
	}
}