SeDriver.java

/*
    ==============================================================================
      Author: Zoltán Hrabovszki <zh@openkeyword.de>
 
      Copyright © 2012 - 2019 IT-Beratung Hrabovszki
      www.OpenKeyWord.de
    ============================================================================== 
 
    This file is part of OpenKeyWord.
 
    OpenKeyWord is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.
 
    OpenKeyWord is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.
 
    You should have received a copy of the GNU General Public License
    along with OpenKeyWord.  If not, see <http://www.gnu.org/licenses/>.
 
    Diese Datei ist Teil von OpenKeyWord.
 
    OpenKeyWord ist Freie Software: Sie können es unter den Bedingungen
    der GNU General Public License, wie von der Free Software Foundation,
    Version 3 der Lizenz oder (nach Ihrer Wahl) jeder späteren
    veröffentlichten Version, weiterverbreiten und/oder modifizieren.
 
    OpenKeyWord wird in der Hoffnung, dass es nützlich sein wird, aber
    OHNE JEDE GEWÄHRLEISTUNG, bereitgestellt; sogar ohne die implizite
    Gewährleistung der MARKTFÄHIGKEIT oder EIGNUNG FÜR EINEN BESTIMMTEN ZWECK.
    Siehe die GNU General Public License für weitere Details.
 
    Sie sollten eine Kopie der GNU General Public License zusammen mit 
    OpenKeyWord erhalten haben. Wenn nicht, siehe <http://www.gnu.org/licenses/>.
*/
 
package okw.gui.adapter.selenium.webdriver;
 
import java.util.ArrayList;
import java.util.List;
 
import org.openqa.selenium.By;
import org.openqa.selenium.NoSuchFrameException;
import org.openqa.selenium.WebDriver;
import org.openqa.selenium.WebElement;
import org.openqa.selenium.chrome.ChromeDriver;
import org.openqa.selenium.firefox.FirefoxDriver;
import org.openqa.selenium.htmlunit.HtmlUnitDriver;
 
import okw.exceptions.OKWGUIObjectNotFoundException;
import okw.exceptions.OKWGUIObjectNotUniqueException;
import okw.log.Logger_Sngltn;
 
public class SeDriver
{
 
    // Get the instance of Logger_Sngltn
    protected Logger_Sngltn MyLogger        = Logger_Sngltn.getInstance();
 
    private WebDriver        driver = null;
 
    private String          currentiframeID = "";
 
    public String getCurrentiframeID()
    {
        return currentiframeID;
    }
 
    private static SeDriver instance = new SeDriver();
 
    private SeDriver()
    {
    }
 
    public static SeDriver getInstance()
    {
        return instance;
    }
 
    public void setDriver( WebDriver fpDriver )
    {
        this.driver = fpDriver;
    }
 
    public WebDriver getDriver( )
    {
        return this.driver;
    }
 
    
    public void __DriveChrome()
    {
        this.driver = new ChromeDriver();
    }
 
    public void __DriveFireFox()
    {
        this.driver = new FirefoxDriver();
    }
 
    /*public void DriveInternetExplorer()
    {
        this.driver = new InternetExplorerDriver();
    }*/
 
    public void __DriveUnitDriver()
    {
        try
        {
            this.driver = new HtmlUnitDriver( true );
        }
        catch (Exception e)
        {
 
            System.out.println( e.getStackTrace() );
        }
    }
 
    public void swichToFrame( String iframeID )
    {
 
        // Nur etwas Unternehmen wenn iframeID sich geändert hat
        if ( !currentiframeID.equalsIgnoreCase( iframeID ) )
        {
            // first reset to default
            driver.switchTo().defaultContent();
 
            // then set to yor iframe if not null or empty!
            if ( !okw.OKW_Helper.isStringNullOrEmpty( iframeID ) )
            {
                try
                {
                    driver.switchTo().frame( iframeID );
 
                    // Neuenwert merken wenn Fehlerfrei ge-Switchto wurde... 
                    currentiframeID = iframeID;
 
                }
                catch (NoSuchFrameException e)
                {
                    System.out.println( "Unable to locate frame with id " + iframeID + e.getStackTrace() );
                }
                catch (Exception e)
                {
                    System.out.println( "Unable to navigate to frame with id " + iframeID + e.getStackTrace() );
                }
            }
        }
    }
 
    
    public String getFrameID4Locator( String fpsLocator )
    {
        String return_iFrame = null;
        WebElement myWebElement = null;
        
        // Merkt sich die "gefundenen" Ausnahme in der Schleife
        // und löst diesen ggf. nach der schleife aus.
        Exception ExceptionFound = null;
 
        MyLogger.LogFunctionStartDebug( "SeDriver.getFrameID4Locator", "fpsLocator", fpsLocator );
        
        // Liste der Frame-ID´s ermitteln, die sich im aktuellen Fenster befinden
        ArrayList<String> iframeIDs = new ArrayList<String>();
 
        iframeIDs.add( currentiframeID );
        iframeIDs.addAll( getIframesID() );
 
        MyLogger.LogPrintDebug( "Number of iFrames found: " + ((Integer)iframeIDs.size()).toString() );
        
        // iframes(ID) jeweils nach dem GUI-Objekt durchsuchen.
        for ( String iframeID : iframeIDs )
        {
            try
            {
                myWebElement = this.getElement( iframeID, fpsLocator );
 
                if ( myWebElement != null )
                {
                    return_iFrame = currentiframeID;
                    break;
                }
            }
            catch ( OKWGUIObjectNotFoundException e )
            {
                ExceptionFound = e;
                continue;
            }
            catch ( OKWGUIObjectNotUniqueException e )
            {   // Hier wird z.B. abgefangen wenn zwei Locatoren
                ExceptionFound = e;
                break;
            }            
            catch ( Exception e )
            {   // Other exceptions...
                
                ExceptionFound = e;
                break;
            }            
        }
 
        if ( ExceptionFound instanceof OKWGUIObjectNotFoundException )
        {
            MyLogger.LogPrintDebug( "Object not found." );
            MyLogger.LogFunctionEndDebug( );
            throw new OKWGUIObjectNotFoundException( ExceptionFound.getMessage() );
        }
        else if ( ExceptionFound instanceof OKWGUIObjectNotUniqueException )
        {
            MyLogger.LogPrintDebug( "More than one Object found." );
            MyLogger.LogFunctionEndDebug( );
            throw new OKWGUIObjectNotUniqueException( ExceptionFound.getMessage() );
        }
        else if ( ExceptionFound != null )
        {
            MyLogger.LogPrintDebug( "Unknown Exception." );
            MyLogger.LogFunctionEndDebug( );
            throw new RuntimeException( ExceptionFound );
        }
        else
        {
            MyLogger.LogFunctionEndDebug( "iFrame: '" + return_iFrame + "'");            
        }        
        return return_iFrame;
    }
    
    
    public ArrayList<String> getIframesID( )
    {
        
        ArrayList<String> lvReturn = new ArrayList<String>();
 
        MyLogger.LogFunctionStartDebug( "SeDriver.getIframesID");
 
        //final
        List<WebElement> iframes = this.driver.findElements(By.tagName("iframe"));
        
        MyLogger.ResOpenListDebug( "iFrames..." );
        
        for (WebElement iframe : iframes)
        {
            String myID = iframe.getAttribute("id");
            
            if ( ! okw.OKW_Helper.isStringNullOrEmpty( myID ) )
            {
                lvReturn.add( myID );
                MyLogger.LogPrintDebug( "ID='" + myID + "'" );            }
            else
            {
                myID = iframe.getAttribute("name");
                
                if ( ! okw.OKW_Helper.isStringNullOrEmpty( myID ) )
                {
                    lvReturn.add( myID );
                    MyLogger.LogPrintDebug( "name='" + myID + "'" );
                }
                else
                {
                    MyLogger.LogWarning( "iFrame has neither ID nor Name:" + iframe.toString() );
                }
            }
        }
 
        MyLogger.ResCloseListDebug( );
        MyLogger.LogFunctionEndDebug( lvReturn );
        
        return lvReturn;
    }
    
    public WebElement getElement( String fpsFrameID, String fpsLocator )
    {
        WebElement me = null;
        List<WebElement> meme = null;
 
        try
        {
            this.MyLogger.LogFunctionStartDebug( "SeDriver.getElement", "fpsFrameID", fpsFrameID, "fpsLocator", fpsLocator );
 
            // 1. ggf Auf das richtige frame Setzen oder zurück auf default. 
            this.swichToFrame( fpsFrameID );
 
            // Element ggf. des richtigen Frames Holen.
            meme = this.driver.findElements( By.xpath( fpsLocator ) );
 
            if ( meme.size() == 0 )
            {
                String lvsPrintMe = "GUI-Objekt nicht gefunden! IFrame: '" + fpsFrameID + "' Locator: '" + fpsLocator + "'";
                this.MyLogger.LogPrint( lvsPrintMe );
 
                throw new OKWGUIObjectNotFoundException( lvsPrintMe );
            }
            else if ( meme.size() > 1 )
            {
                String lvsPrintMe = "Locator ist nicht eindeutig! IFrame: '" + fpsFrameID + "' Locator: '" + fpsLocator + "'";
 
                this.MyLogger.LogWarning( lvsPrintMe );
 
                throw new OKWGUIObjectNotUniqueException( lvsPrintMe );
            }
            else
            {
                String lvsPrintMe = "GUI-Objekt gefunden IFrame: '" + fpsFrameID + "' Locator: '" + fpsLocator + "'";
                this.MyLogger.LogPrintDebug( lvsPrintMe );
                me = meme.get( 0 );
            }
        }
        finally
        {
            // Logfunction schliessen...
            if (me != null)
               this.MyLogger.LogFunctionEndDebug( me.toString() );
            else
                this.MyLogger.LogFunctionEndDebug( );       
        }
        
        return me;
    }
 
    public List<WebElement> getElements( String fpsFrameID, String fpsLocator )
    {
        List<WebElement> meme = null;
        
        this.MyLogger.LogFunctionStartDebug( "SeDriver.getElement", "fpsFrameID", fpsFrameID, "fpsLocator", fpsLocator );
 
        try
        {
            // 1. Auf das richtige frame Setzen oder zurück auf default. 
            this.swichToFrame( fpsFrameID );
 
            // 2. Element im Frame finden.
            meme = this.driver.findElements( By.xpath( fpsLocator ) );
        }
        finally
        {
            this.MyLogger.LogFunctionEndDebug(); ;    
        }
        return meme;
    }
 
    /*
}