Changeset 32705 for gs3-extensions/testing/trunk/src/src/org/greenstone/gsdl3/testing/GSGUITestingUtil.java

Timestamp:

2018-12-17T23:33:18+13:00 (5 years ago)

Author:

ak19

Message:

1. Implemented (and testing as I implement) more of the GSGUITestingUtil helper functions. Most of the File Menu is done. Unfortunately can't yet commit the EDT corrections in GLI as at least one of them requires a more complex solution, possibly with a SwingWorker as there's conflict with the ProgressBar. 2. infrastructure for JUnit reports. Not working yet despite the inclusion of necessary jar, will investigate this later.

File:

• gs3-extensions/testing/trunk/src/src/org/greenstone/gsdl3/testing/GSGUITestingUtil.java (modified) (6 diffs)

gs3-extensions/testing/trunk/src/src/org/greenstone/gsdl3/testing/GSGUITestingUtil.java

@@ -1 +1 @@
 package org.greenstone.gsdl3.testing;
 
+import java.io.File;
 import java.util.Map;
+import java.util.regex.*;
 import java.awt.Component;
 
@@ -7 +9 @@
 import org.junit.Assert;
 import org.assertj.swing.fixture.*;
+import org.assertj.swing.timing.Timeout ;
+        
 
 // GLI imports
@@ -18 +22 @@
 
 public class GSGUITestingUtil
-{ 
+{
+    public static final boolean PAUSE_ON = true;
+    
+    public static final int SECOND = 1000; // 1000 ms
+    
     public static final String DOWNLOAD_PANE = "Download"; 
     public static final String GATHER_PANE = "Gather"; 
@@ -33 +41 @@
 
     /************************ GENERAL *******************************/
+    public static void PAUSE() {    
+    PAUSE(5);
+    }
+    public static void PAUSE(int seconds) {
+    if(!PAUSE_ON) return; // ignore calls to PAUSE
+    
+    // wait a couple of seconds again?
+     try{
+         Thread.sleep(seconds*SECOND);
+     } catch(Exception e) {
+         e.printStackTrace();
+     }
+    }
+    
+    
     //https://joel-costigliola.github.io/assertj/swing/api/org/assertj/swing/fixture/FrameFixture.html
     public static void switchToPane(FrameFixture window, String pane) {
@@ -49 +72 @@
     }
 
+    /*
+    public static void stealAnyLock(FrameFixture window) {
+    DialogFixture dialog = window.dialog("LockFileDialog");
+    if(dialog != null) {
+        dialog.button("LockFileDialog.ok_button").click();
+    }
+    }*/
+
+    
     // e.g. pane = Enrich,view=collection; pane = Gather, view = workspace (or collection)
     public static void getFolderPath(String pane, String view, String folderPath) {}
@@ -54 +86 @@
     
     /**********************FILE MENU*******************************/
-    public static void setPrefs(String tab, Map params) {}
-    // mode e.g. librarian, expert
-    public static void changeUserMode(String mode) {}
-    
-    public static void deleteCollection(){}
-    public static void saveCollection(){}
-    public static void closeCollection(){}    
-    public static void createCollection(String basedOn) {}    
-    public static void loadCollection(FrameFixture window, String colName) {
+    public static void setPrefs(FrameFixture window, String tab, Map params) {
+    openMenuItem(window, "file", "options");
+
+    }
+    
+    /**
+     * @param toMode must be the dictionary key for Preferences mode.
+     * Choose from Preferences.Mode.Assistant, Preferences.Mode.Librarian, Preferences.Mode.Expert
+     */
+    public static void changeUserMode(FrameFixture window, String toMode) {
+    openMenuItem(window, "file", "options"); // click MenuBar.file -> MenuBar.file_options
+
+    // switch to Mode tab
+    String paneLabel = Dictionary.get("Preferences.Mode");
+    DialogFixture dialog = window.dialog("Preferences");
+    JTabbedPaneFixture tab = window.tabbedPane("Preferences.tab_pane");
+    tab.selectTab(paneLabel); // select tab by its title
+
+    String mode = "assistant"; // library assistant
+    if(toMode.contains("xpert")) {
+        mode = "expert";
+    } else if (toMode.endsWith("ibrarian")) {
+        mode = "librarian";
+    }
+    dialog.radioButton("Preferences."+mode+"_mode_radio_button").check(true);
+
+    // apply and close dialog
+    dialog.button("Preferences.apply_button").click();
+    dialog.button("Preferences.ok_button").click();
+    }
+
+    public static void exitGLI(FrameFixture window) {
+    openMenuItem(window, "file", "exit");
+    PAUSE(5);
+    }
+    
+    public static void closeCollection(FrameFixture window){
+    // Through componennt names, clicks on MenuBar.file then MenuBar.file_close
+    openMenuItem(window, "file", "close");
+    }
+
+    public static void deleteCollection(FrameFixture window, String collName) {
+    openMenuItem(window, "file", "delete");
+    DialogFixture dialog = window.dialog("DeleteCollectionPrompt"); // could call window.dialg() too as there will be only one, unless GLI run in debug mode?
+    
+    JListFixture collection_list = dialog.list("DeleteCollectionPrompt.list");
+    
+    Pattern collNameRegex = Pattern.compile(".*"+collName+".*");
+    collection_list.selectItem(collNameRegex);
+    
+    collection_list.requireSelection(collNameRegex); // assert it exists and is selectable. Can't select (or delete) coll if it's open
+    
+    dialog.checkBox("DeleteCollectionPrompt.confirmation").check(true); // check checkbox to be sure to delete
+    dialog.button("DeleteCollectionPrompt.ok_button").click(); // delete button
+
+    // A close confirmation optionPane dialog appears - click OK in it
+    dialog.optionPane().okButton().click();
+    
+    dialog.button("DeleteCollectionPrompt.close_button").click(); // close deleteColl dialog
+    }
+    
+    public static void saveCollection(FrameFixture window) {
+    openMenuItem(window, "file", "save"); // MenuBar.file -> MenuBar.file_save
+    }
+
+    public static void createCollection(FrameFixture window,
+                    String collTitle, String collDescription, String baseColl)
+    {
+    openMenuItem(window, "file", "new");
+    DialogFixture dialog = window.dialog("col"); // GLI is unable to setName() of this dialog
+    // to NewCollectioNDetailsPrompt. Not sure why.
+
+    dialog.textBox("NewCollectionDetailsPrompt.title").enterText(collTitle); // JTextField
+    if(collDescription != null && !collDescription.equals("")) {
+        // JTextArea description
+        dialog.textBox("NewCollectionDetailsPrompt.description").enterText(collDescription);
+    }
+
+    // JComboBox base_collection
+    if(baseColl != null && !baseColl.equals("")) {
+        JComboBoxFixture baseCollBox = dialog.comboBox("NewCollectionDetailsPrompt.base_collection");
+        Pattern collNameRegex = Pattern.compile(".*"+baseColl+".*"); // comboBox should CONTAIN this string
+        baseCollBox.selectItem(collNameRegex);
+        baseCollBox.requireSelection(collNameRegex); // assert the baseColl name exists     
+    }
+    dialog.button("NewCollectionDetailsPrompt.create_button").click();
+    }
+
+    public static void loadCollection(FrameFixture window, String collName) {
     openMenuItem(window, "file", "open");
-    
-    }
-
-    // only for GS2?
-    public static void exportCollection() {}
+    DialogFixture dialog = window.dialog("OpenCollectionDialog");
+    JListFixture collection_list = dialog.list("OpenCollectionDialog.collection_list");
+
+    // See section 4.2 of http://www.vogella.com/tutorials/JavaRegularExpressions/article.html
+    // Apparently, testing Pattern "collName" expects it to match in entirety
+    // whereas testing ".*collName.*" will test the string contains this Pattern
+    Pattern collNameRegex = Pattern.compile(".*"+collName+".*");
+    
+    /*String[] items = collection_list.contents();
+    for(String item : items) {
+        System.err.println("@@@ ITEM: " + item);
+        }*/
+    
+
+    //JListItemFixture collItem = collection_list.item(collNameRegex);
+    //collItem.click();
+    //collection_list.requireSelection(collNameRegex); // assert that the requested collection exists
+    //collItem.doubleClick();
+    collection_list.selectItem(collNameRegex);
+    collection_list.requireSelection(collNameRegex); // assert that the requested collection exists
+
+    
+    /*String[] selections = collection_list.selection();
+    for(String s : selections) {
+        System.err.println("@@@ opening collection " + s);
+        }*/
+
+    JListItemFixture selectedColl = collection_list.item(collNameRegex);
+    //collection_list.doubleClick(); // will double-click on last item regardless of what's selected
+    selectedColl.doubleClick();
+
+    //steal any lock
+    /*
+    DialogFixture dialog = window.dialog("LockFileDialog");
+    if(dialog != null) {
+        dialog.button("LockFileDialog.ok_button").click();
+    }
+    */
+    }
+
+    /**
+     * @param exportColl has to be internal GS collection name, e.g. lucene-jdbm-demo
+     * not public collection name like "Demo Collection".
+     */
+    public static void exportCollection(FrameFixture window, String exportToFormat, String exportColl)
+    {
+    openMenuItem(window, "file", "exportas"); // Clicks MenuBar.file -> MenuBar.file_exportas
+
+    DialogFixture dialog = window.dialog("ExportAsPrompt"); 
+    dialog.comboBox("ExportAsPrompt.saveas_combobox").selectItem(exportToFormat);
+    
+    Pattern collNameRegex = Pattern.compile(".*"+exportColl+".*");
+    JListFixture collection_list = dialog.list("ExportAsPrompt.list");
+    collection_list.selectItem(collNameRegex); //JList of collections
+    collection_list.requireSelection(collNameRegex); // check it exists
+
+    dialog.button("ExportAsPrompt.ok_button").click(); // do export
+
+    // first we see a progress dialog
+    
+    // Wait for subsequent export complete dialog
+    DialogFixture exportCompleteDialog = window.dialog("SimpleResultDialog", Timeout.timeout(30*SECOND));
+
+    // non-modal dialog, so give it focus, so we can close it through its Close button
+    exportCompleteDialog.focus();
+    
+    //exportCompleteDialog.button().click();
+    exportCompleteDialog.button("SimpleResultDialog.GLIButton."+Dictionary.get("General.Close")).click(); // it only has a single button: "Close", still want to future proof if more buttons get added by specifying the particular button
+
+
+    // Close outer dialog too - cancel doubles as close button now that export is complete
+    dialog.button("ExportAsPrompt.cancel_button").click();
+    
+    File file = new File(System.getenv("GSDLHOME") + File.separator + "tmp" + File.separator + "exported_"+exportColl+"_"+exportToFormat);
+
+    Assert.assertTrue(file.exists());
+    Assert.assertTrue(file.isDirectory());  
+    }
     
     /*************** DESIGN ******************************/