webdriver-js-devgnode v1.2.10

seleniumJs

Little framework webdriver in javascript.

This framework has been written in javascript ES2020

Prerequisites

For use this package you should to install nodeJs on your platform

• nodeJs >= 12.14.1
• phoenixnap.com/kb/install-node-js-npm-on-windows
• nodejs.org/en/

Branch

• release : lastest stable version
• develop : Repo to clone ( replace master )
• test-integration : Branch for push unit test(s) file(s)

installation

Import from npm repository package

$ npm i webdriver-js-devgnode

Exportable objects :

Webdrivers

WebDriver( capabilities [, driverOptions ] )

• Capabilities

• driverOptions : override configuration → see

  • String loggerParser : Log string parser.
  • String loggerOutputDir : Full path of log directory.
  • Boolean saveLog : save stdout in file log.
  • Boolean logStdout : Display in console error message.
  • Array logLevel : ALL,INFO,DEBUG,WARN,ERROR or void array meaning log OFF.
  • Object bin :
    • String firefox : binary path
    • String chrome : binary path
    • String opera : binary path
    • String msedge : binary path
  • Object webdriver
    • String remoteHost : hostname
    • int remotePort : port
      • Object gecko, chrome, opera, msedge
        • Array args
        • String bin : webdriver executable
        • String logLevel : webDriver logLevel

Example :

const {GeckoDriver}     = require("webdriver-js-devgnode");
const {ChromeDriver}    = require("webdriver-js-devgnode");

new GeckoDriver( );
new ChromeDriver();

Locator

Example :

const {By}     = require("webdriver-js-devgnode");

driver.findElement(By.cssSelector(".class tagname"));
driver.findElement(By.xpath("//input"));

Capabilities

Example :

const {FirefoxOptions,ChromeOptions}  = require("webdriver-js-devgnode");

let ffcap = new FirefoxOptions( )
            .setBinary("/Path/to/my/binary/firefox-esr")
            .setAcceptSslCerts(true)
            .setImplicitTimeout(1000);

let crcap = new ChromeOptions()
            .setAcceptSslCerts(true)
            .setHeadless(true)
            .setEnabledAutomationArgs();

Waiter

• Waiter

ExpectedConditions

• ExpectedConditions

Others Basic POJO

• Cookie
• Dimension
• Point
• Rect

• Proxy

Configuration file

Path : ./config

name : configuration.json

This configuration file contains some necessaries attributes for proper operation listed below :

• screenOutputDir : String Define path of screenshots directory default : "target/screenshots"
• loggerParser : String parser defined
  • %time : unix timestamps
  • %type : ALL,DEBUG,ERROR,INFO,LOG,WARN
  • %error : Error message to displayed
• loggerOutputDir : Define path of logs directory. default : "target/logs"
• logStdout : Boolean show message in console default : true
• saveLog : Boolean save log default : true
• logLevel : Array : void (, ALL,DEBUG,ERROR,INFO,LOG,WARN ) default : "ALL"
• bin : Object Define the full path of web browser binary ( can be rewrite in capability properties )
• remoteHost : Web driver remote host
• remotePort : Web driver remote port
• webdriver
  • argv : List of arguments who will be launched with the web driver.
  • bin : Define the full path of web driver binary.
  • logLevel : Define log type ALL, DEBUG, INFO, WARNING, SEVERE, OFF.

it's possible to override these properties when you instantiate the web driver simply passing these Options in the arguments of webDriver

Template :

{
	"screenOutputDir": "target/screenshots",

	"loggerParser":     "%time\t%name\t: %type :\t%error",
	"loggerOutputDir":  "target/logs",
	"saveLog":          true,
	"logStdout":        true,
	"logLevel":         ["ALL"],

	"bin":{
		"firefox":    null,
		"chrome":     null,
		"opera":      null,
		"msedge":     null

	},

	"webDriver":{

		"remoteHost":"127.0.0.1",
		"remotePort":4444,

		"gecko":{
			"argv":["-vv"],
			"bin":null,
			"logLevel":null
		},
		"chrome":{
			"argv":["--whitelisted-ips","--log-level=ALL"],
			"bin":null,
			"logLevel":"ALL"
		},
		"opera":{
			"argv":["--whitelisted-ips","--log-level=ALL"],
			"bin":null,
			"logLevel":"ALL"
		},
		"msedge":{
			"argv":["--whitelisted-ips"],
			"bin":null,
			"logLevel":null
		}
	}

}

From git clone ( localhost )

$ git clone https://github.com/devGnode/seleniumJs.git

const {GeckoDriver,ChromeDriver,Proxy} = require("./webdriver-js-devgnode.js");

Import Object

WebDriver :

import path : ./import/

• GeckoDriver
• ChromeDriver
• OperaDriver
• EdgesDriver
• Waiter

const {GeckoDriver} = require("./import/GeckoDriver.js");

let driver = new GeckoDriver();

Options ( desired capabilities ) :

import path : ./import/options

• GeckoOptions
• ChromeOptions
• OperaOptions
• EdgesOptions

const {GeckoDriver}  = require("./import/GeckoDriver.js");
const {GeckoOptions} = require("./import/options/GeckoOptions.js");

var desiredCapabilities = (new GeckoOptions())
        .setBrowserName("firefox")
        .setAcceptUntrustedCertificates(true)
        .setCapability("acceptSslCerts",true);

let driver = new GeckoDriver(desiredCapabilities);

Options with proxy :

import path : ./lib/import

• Proxy

const {GeckoDriver}  = require("./import/GeckoDriver.js");
const {GeckoOptions} = require("./import/options/GeckoOptions.js");
const {Proxy}        = require("./Proxy.js");

var desiredCapabilities = (new GeckoOptions())
        .setBrowserName("firefox")
        .setAcceptUntrustedCertificates(true)
        .setCapability("acceptSslCerts",true)
        .setProxy( (new Proxy()).setFtpProxy("0.0.0.0:8080").setHttpProxy("0.0.0.0:8080").setSslProxy("0.0.0.0:8080") );

let driver = new GeckoDriver(desiredCapabilities);

DomElement selector :

import path : ./import/locator

• By

const {GeckoDriver}  = require("./import/GeckoDriver.js");
const {GeckoOptions} = require("./import/options/GeckoOptions.js");
const {By}           = require("./import/locator/By.js");

(async()=>{

var desiredCapabilities = (new GeckoOptions())
        .setBrowserName("firefox")
        .setAcceptUntrustedCertificates(true)
        .setCapability("acceptSslCerts",true);

let driver = new GeckoDriver(desiredCapabilities);
await driver.open();
await driver.get("https://google.uk");

let input        = await driver.findElement(By.className("q"));
let searchButton = await driver.findElement(By.xpath("//input[contains(@value,'Recherche Google') and @type='submit']"));

await input.sendKeys("Send message");
await searchButton.click();

driver.close();

})();

Waiter

import path : ./import/

const {GeckoDriver}  = require("./import/GeckoDriver.js");
const {GeckoOptions} = require("./import/options/GeckoOptions.js");
const {By}           = require("./import/locator/By.js");
const {Waiter}       = require("./import/Waiter.js");

(async()=>{

var desiredCapabilities = (new GeckoOptions())
        .setBrowserName("firefox")
        .setAcceptUntrustedCertificates(true)
        .setCapability("acceptSslCerts",true);

let driver      = new GeckoDriver(desiredCapabilities);
let shortWait   = new Waiter(driver,10);

await driver.open();
await driver.get("https://google.uk");

let input        = await driver.findElement(By.className("q"));
let searchButton = shortWait.until(async driver=>{
    try{
        return await driver.findElement(By.xpath("//input[contains(@value,'Recherche Google') and @type='submit']"));
    }catch (e) {
      return false;
    }

}).sendKeys("Send message");

await searchButton.click();

driver.close();

})();

looger

getLogger : String message , args ...

• log
• info
• warn
• debug
• error

driver.getLogger().log("message");
driver.getLogger().log("message %s :: %s", "params",125);

1581273071079	EdgeDriver	: DEBUG :	webDriver has ben launched pid = 24460
1581273071098	EdgeDriver	: LOG :	webDriver session id = d0a82e65f565878005ead66fc288a9f0
1581273074148	EdgeDriver	: LOG :	webDriver go to = https://google.com
1581273075997	EdgeDriver	: LOG :	webDriver go to = https://google.com/search?q=mdr

Stream

 var elts = await driver.findElements(By.cssSelector("a"));
    elts.stream()
    .limit(1)
    .filter(webelement=>webelement.getText()==="i'm a link")
    .get()[0]
    .click();

var elts = await driver.findElements(By.cssSelector("li"));
    elts.stream()
    .allMatch(webelement=>webelement.getClassName().split(/\s*/).indexOf("class")>-1);

implemented

version : 1.1.0

• Screenshot : WebDriver / WebElement
• Manage Cookie : add / get / delete
• Stream
• Logger

Not implemented yet

• Action Object.
• Window Handle / create new window / frame

Issue

• When an Exception is raised, the process of webdriver isn't killed correctly the port stay opened