Changeset 39033

Timestamp:

2024-05-18T23:03:28+12:00 (2 weeks ago)

Author:

anupama

Message:

1. Unfortunately the build and preview buttons have different component names automatically assigned by TestingPreparation GLI code when in Expert versus when in Librarian mode. Coded to handle both cases. 2. Checking for building success message (varies between Expert and Librarian modes) too before previewing. 3. The step of creating a shortcut in the workspace is finished. 4. All the utility functions for the former are completed. With this most of the GUI functionality in GS3 tutorial 1 (the small html collection) is done. Assert statements for checking the enrich pane is as expected may be needed. And tests of GS Reader results (browser testing) on preview need to be implemented.

Location:

gs3-extensions/testing/trunk/src

Files:

• README (modified) (1 diff)
• lib/java/GSTestingUtil.jar (modified) ( previous)
• src/gstests/tutorials/RunGLITest.java (modified) (6 diffs)
• src/org/greenstone/gsdl3/testing/GSGUITestingUtil.java (modified) (18 diffs)

gs3-extensions/testing/trunk/src/README

@@ -38 +38 @@
 - VERY USEFUL BASICS: https://docs.oracle.com/javase/6/docs/api/javax/swing/package-summary.html#threading
 - EDT and AssertJ Swing: https://joel-costigliola.github.io/assertj/assertj-swing-edt.html
+
+
+NOTES on moving any code into Runnable class inside Gatherer.invokeOnDispatchThread (which does SwingUtilities.invokeAndWait/invokeLater):
+- Only an outer class' member variables and final local variables are available to inner class.
+This is necessary to know when calling SwingUtilities.invokeAndWait/invokeLater(new Runnable() {
+     public void run() {
+            // here, only the outer class' member and final local vars are available
+        // As a closure is created with those variables, like in JavaScript
+     }
+});
+- Rewrite any 'this' reference as '<OuterClassName>.this' when moving code containing any THIS ptr references into inner Runnable class
 
 ----------------------

gs3-extensions/testing/trunk/src/src/gstests/tutorials/RunGLITest.java

@@ -167 +167 @@
       // For testing, want GLI to be in librarian mode by default
       changeUserMode("librarian");
-      /*      
+            
       switchToPane(GATHER_PANE);
       
@@ -190 +190 @@
       
       switchToPane(GATHER_PANE);      
-      */
+      
       exitGLI(); //System.exit() on GLI won't allow quit to be called on Selenium's web _driver, why? Because System.exit exited the JUnit tests too
       
@@ -209 +209 @@
     stealAnyCollectionLock(1);
     switchToPane(GATHER_PANE);
-
+    */
     // dummy tests
-    testGLIRunning();
-    */
+    //testGLIRunning();
+    
     // First tutorial
     simpleHTML();
@@ -236 +236 @@
     stealAnyCollectionLock(1);
     switchToPane(GATHER_PANE);
-    //changeUserMode("librarian");
+    changeUserMode("expert");
     //openWorkspacePath(WKS_TOP_FOLDER_LOCAL, props.get("samplefiles.path").toString());
 
@@ -245 +245 @@
     openCollectionPath("b17mie/b17mie.htm", CLICK);
     PAUSE(3);
-    openWorkspacePath(WKS_TOP_FOLDER_LOCAL, props.get("samplefiles.path").toString());
-    
+    openWorkspacePath(WKS_TOP_FOLDER_LOCAL, props.get("samplefiles.path").toString());  
     */
+
+    
     
     // Start a new collection within the Librarian Interface:
@@ -260 +261 @@
     String dragNodePath = openWorkspacePath(WKS_TOP_FOLDER_LOCAL, props.get("samplefiles.path").toString()+"simple_html/html_files", SELECT);
 
-    dragNDrop(dragNodePath, "");
-    
-    
+    String collPath = dragNDrop(dragNodePath, "");
+
+    
+    openCollectionPath("html_files", DOUBLE_CLICK);
+    PAUSE(2);   
+    
+    
+    
+    //changeUserMode("librarian");
+    //loadCollection("smallhtm");
     
     switchToPane(CREATE_PANE);
-    buildCollection();
-    previewCollectionWhenReady(MAX_BUILD_TIMEOUT);
+    PAUSE(2);
+    //buildCollection();
+    //previewCollectionWhenReady(MAX_BUILD_TIMEOUT);
+    buildCollectionTillReady(MAX_BUILD_TIMEOUT);    
+    //closePopup("Collection Creation Result", "OK", DO_NOT_TICK_CHECKBOX);
+    //closePopup(OPTIONAL, Dictionary.get("CollectionBuilt.Title"), Dictionary.get("General.OK"), TICK_CHECKBOX);
+    closePopup(Dictionary.get("CollectionBuilt.Title"), Dictionary.get("General.OK"), TICK_CHECKBOX);   
+    previewCollection();
+    
+    //window = getGLIApplicationWindow(robot());
+    
+    switchToPane(ENRICH_PANE);  
+    closeCollection();
+    
+
+    String path = openWorkspacePath(WKS_TOP_FOLDER_LOCAL, props.get("samplefiles.path").toString(), RIGHT_CLICK);
+    //workspaceRightClickOption(dragNodePath, );
+    PAUSE(2);
+    selectContextMenu(Dictionary.get("MappingPrompt.Map")); // Create Shortcut
+    closePopup(Dictionary.get("MappingPrompt.Title"), Dictionary.get("General.OK")); // accept shortcut name
+
+    collapseWorkspacePath(WKS_TOP_FOLDER_LOCAL);
     PAUSE(4);
+    
     }
 

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

@@ -5 +5 @@
 import java.util.regex.*;
 import java.awt.Component;
+import javax.swing.*;
 
 // only JUnit and JAssert-Swing, no Selenium in this class
@@ -26 +27 @@
 import org.assertj.swing.edt.GuiActionRunner;
 import org.assertj.swing.core.Robot;
+import org.assertj.swing.core.GenericTypeMatcher;
+// https://joel-costigliola.github.io/assertj/assertj-swing-lookup.html
+// https://joel-costigliola.github.io/assertj/swing/api/org/assertj/swing/core/matcher/FrameMatcher.html
+//import static org.assertj.swing.core.matcher.DialogMatcher.withTitle
+import org.assertj.swing.core.matcher.*;
+//import org.assertj.swing.core.matcher.DialogMatcher; // withTitle
+//import org.assertj.swing.core.matcher.FrameMatcher; // withTitle
 
 
@@ -48 +56 @@
 {
     public static FrameFixture window = null;
+    public static String storedMode = null; // librarian/expert etc
+    // prefix for building buttons in librarian mode (or less). Expert mode lacks the prefix
+    public static String modeButtonPrefix = "simple_";
     
     public static final boolean PAUSE_ON = true;
@@ -73 +84 @@
     public static final int RIGHT_CLICK = 3;
     public static final int SELECT = 4;
+
+    public static final boolean TICK_CHECKBOX = true;
+    public static final boolean DO_NOT_TICK_CHECKBOX = false;
+
+    public static final boolean OPTIONAL = true;
+    public static final boolean COMPULSORY = true;
     
     public static Robot robot = null;
@@ -205 +222 @@
     }
     }
+
+    public static void closePopup(String winTitle, String buttonLabel) {
+    closePopup(winTitle, buttonLabel, DO_NOT_TICK_CHECKBOX);
+    }
+    
+    public static void closePopup(String winTitle, String buttonLabel, boolean tickCheck) {
+    /*DialogFixture popup = findDialog(new GenericTypeMatcher<JDialog>(JDialog.class) {
+        @Override
+        protected boolean isMatching(JDialog dlg) {
+            return winTitle.equals(dlg.getTitle());
+        }
+        }).using(robot);
+    */
+    // https://joel-costigliola.github.io/assertj/swing/api/org/assertj/swing/core/matcher/FrameMatcher.html
+    System.err.println("# Looking for popup with title " + winTitle + " by clicking button " + buttonLabel);
+    DialogFixture popup = findDialog(DialogMatcher.withTitle(winTitle)).using(robot);
+    // Do any checkbox ticking Before closing the popup with OK click!  
+
+    if(tickCheck == TICK_CHECKBOX) {
+        System.err.println("# Looking for a checkbox to tick");
+        popup.checkBox().check();
+        //PAUSE(4);
+    }   
+    System.err.println("# Closing popup by clicking button " + buttonLabel);
+    PAUSE(1);
+    popup.button(JButtonMatcher.withText(buttonLabel)).click();
+    
+    }
+    
+    // set tickCheck to false either if there's no checkbox, or if you don't want it ticked
+    public static void closePopup(boolean optional, String winTitle,
+                  String buttonLabel, boolean tickCheck)
+    {
+    if(optional == OPTIONAL) {
+        try {
+        closePopup(winTitle, buttonLabel, tickCheck);
+        } catch(Exception e) {
+        System.err.println("@ Optional popup did not appear.");
+        }
+    } else {//fatal if no popup or it doesn't have a matching title and label (and a checkbox)
+        closePopup(winTitle, buttonLabel, tickCheck);
+    }
+    }
+
+    public static void selectContextMenu(String label) {
+    JMenuItemFixture menuOption
+        = window.menuItem(new GenericTypeMatcher<JMenuItem>(JMenuItem.class) {
+        @Override
+        protected boolean isMatching(JMenuItem menu) {
+            /*
+            System.err.println("### Considering match with menu: " + menu.getText());
+            if (menu.getText().matches(label)) {
+            System.err.println("### Matched");
+            }
+            */
+            return (menu.getText().matches(label));
+        }
+        });
+    
+    
+    menuOption.click();
+    
+    }
     
     // e.g. pane = Enrich,view=collection; pane = Gather, view = workspace (or collection)
@@ -221 +301 @@
      */
     public static void changeUserMode(String toMode) {
+    storedMode = toMode;
+        
     openMenuItem("file", "options"); // click MenuBar.file -> MenuBar.file_options
 
@@ -240 +322 @@
     dialog.button("Preferences.apply_button").click();
     dialog.button("Preferences.ok_button").click();
+
+    modeButtonPrefix = toMode.equals("expert") ? "" : "simple_";
     }
 
@@ -398 +482 @@
     //while(!previewButton.isEnabled()) {}
     
-    JButtonFixture previewButtonTester = window.button("CreatePane.preview_button");
+    JButtonFixture previewButtonTester
+        = window.button("CreatePane."+modeButtonPrefix+ "preview_button");
     javax.swing.JButton previewButton = previewButtonTester.target();
     Pause.pause(new Condition("Preview button to be enabled") {
@@ -411 +496 @@
         //txtArea.requireText("************** Build Finished **************");
         //txtArea.requireText(java.util.regex.Pattern.compile("Build Finished|buildcol.pl> Command complete"));
+        //txtArea.requireText(Pattern.compile("^\\s*(\\*+ Build Finished \\*+|buildcol\\.pl> Command complete)", Pattern.MULTILINE)); //https://stackoverflow.com/questions/3651725/match-multiline-text-using-regular-expression
+
+        //txtArea.requireText(Pattern.compile(".* (\\*+ Build Finished \\*+|buildcol\\.pl> Command complete) .*", Pattern.DOTALL)); //https://stackoverflow.com/questions/3651725/match-multiline-text-using-regular-expression
+
+        // WORKED:
+        //txtArea.requireText(Pattern.compile(".* Build Finished .*", Pattern.DOTALL)); //https://stackoverflow.com/questions/3651725/match-multiline-text-using-regular-expression
+        txtArea.requireText(Pattern.compile(".*^(\\*+ Build Finished \\*+|buildcol\\.pl> Command complete).*", Pattern.DOTALL|Pattern.MULTILINE)); //https://stackoverflow.com/questions/3651725/match-multiline-text-using-regular-expression
+        
         //System.err.println("@@@@ text: " + txtArea.text());
     }
@@ -417 +510 @@
     }
     public static void buildCollection() {
-    window.button("CreatePane.build_button").click();
-    }
+    /*
+    JButtonFixture buildButton = window.button(new GenericTypeMatcher<JButton>(JButton.class) {
+        @Override
+        protected boolean isMatching(JButton button) {
+            //if("CreatePane.build_button".equals(button.getName())) {
+        //  return true;
+          //  }
+            //else return "CreatePane.simple_build_button".equals(button.getName());
+            
+            //return button.getName().matches("CreatePane.(simple_)?build_button");
+            
+            //return button.getName().equals("CreatePane.simple_build_button"); // NPE: not all buttons have names
+            //return (button.getName() != null && button.getName().equals("CreatePane.simple_build_button"));
+            return (button.getName() != null && button.getName().matches("CreatePane.(simple_)?build_button")); // NPE: not all buttons have names
+        }
+        });
+*/  
+    //JButtonFixture buildButton
+    //    = window.button(JButtonMatcher.withName("CreatePane.simple_build_button"));
+
+
+    /*
+    JButtonFixture buildButton
+        = window.button(JButtonMatcher
+                .withName(Pattern.compile("CreatePane\\.(simple_?)build_button"))
+                .andShowing());
+    */
+
+
+    window.button("CreatePane."+modeButtonPrefix+ "build_button").click();
+    }
+
+    public static boolean buttonNameMatches(JButton button, String regex) {
+    return (button.getName() != null && button.getName().matches(regex));
+    }
+    
     public static void buildCollectionTillReady(int maxWaitSeconds) {
     buildCollection();
@@ -431 +558 @@
     }
     }
-    public static void previewCollection() {    
-    window.button("CreatePane.preview_button").click();
+    public static void previewCollection() {
+    window.button("CreatePane."+modeButtonPrefix+ "preview_button").click();
     }
 
@@ -462 +589 @@
     public static void createCollectionSubfolder() {}
     
-    public static void dragNDrop(String workspacePath, String collPath) {
+    public static String dragNDrop(String workspacePath, String collPath) {
     JTreeFixture workspaceTree = window.tree("GatherPane.workspace_tree");
 
@@ -473 +600 @@
         collTree.drop(collPath); // call a JTreeFixture.drop() method
     }
-    System.err.println("@@@ New collPath: " + collPath);
+    //System.err.println("@@@ New collPath: " + collPath);
     String newPath = workspacePath.substring(workspacePath.lastIndexOf("/")+1);
-    collPath = (collPath==null || collPath.equals("")) ? newPath : (collPath + "/" + newPath);
-    openCollectionPath(collPath, SELECT);
-    System.err.println("@@@ New collPath: " + collPath);
-    }
-
+    collPath = (collPath==null || collPath.equals("")) ? newPath : (collPath + "/" + newPath);  
+    //System.err.println("@@@ New collPath: " + collPath);
+    return collPath;
+    }
+
+    public static void collapseWorkspacePath(String path) { 
+    JTreeFixture workspaceTree = window.tree("GatherPane.workspace_tree");
+    workspaceTree.collapsePath(path);
+    }
+    public static void collapseCollectionPath(String path) {        
+    JTreeFixture collTree = null;
+    try {
+        collTree = window.tree("EnrichPane.collection_tree");
+    } catch(Exception e) {
+        collTree = window.tree("GatherPane.collection_tree");
+    }
+    collTree.collapsePath(path);
+    }
 
     public static String openWorkspacePath(String topGLIFolder, String workspacePath, int mouseAction) {
@@ -485 +625 @@
         workspacePath = workspacePath.substring(1);
     }
+    /*if(workspacePath.endsWith("/")) {
+        workspacePath = workspacePath.substring(0, workspacePath.length()-1);
+        }*/
     
     //JTabbedPaneFixture gatherPane = switchToPane(GATHER_PANE);
@@ -517 +660 @@
         nodes[i] = prevNode + "/" + nodes[i];       
         System.err.println("\t" + nodes[i]);
-        if(i < nodes.length) {
+        if(i < (nodes.length-1)) {
         wks_ptr = workspaceTree.expandPath(nodes[i]);
+        System.err.println("\tExpanded node: " + nodes[i]);
         } else { // final node
+        System.err.println("\tFinal node: " + nodes[i]);
         /*switch(leafNodeAction) {
         case EXPAND:
@@ -568 +713 @@
             break;
         case RIGHT_CLICK:
+            System.err.println("### Rightclicking at " + node);
             tree_ptr = tree.rightClickPath(node);
             break;
@@ -591 +737 @@
     JTreeFixture collTree = null;
     try {
+        collTree = window.tree("EnrichPane.collection_tree");       
+    } catch(Exception e) {
         collTree = window.tree("GatherPane.collection_tree");
-    } catch(Exception e) {
-        collTree = window.tree("EnrichPane.collection_tree");
     }
     if(collPath != "") {
@@ -607 +753 @@
         
         System.err.println("\t" + nodes[i]);
-        if(i < nodes.length) {
+        if(i < (nodes.length-1)) {
             collTree = collTree.expandPath(nodes[i]);
         } else {