WebdriverNode

The nodeJS implementation of the selenium2 jsonWireProtocol.

However, webdriverNode is first forked from webdriverjs, But as we use webdriverNode for our own project F2ETEST, it became very different from the webdriverjs. So we let webdriverNode become an independent project.

Thanks webdriverjs and its author @Camme!

Attention!

Note that I am rewrite webdriverNode with branch [Reconstruction](https://github.com/neekey/webdriverNode/tree/Reconstruction), which will be much more powerful and stable.

Please checkout branch Reconstruction if you are intersted.

install

npm install webdriverNode

usage

启动Selenium server

java -jar selenium-server-standalone-2.11.0.jar

简单的测试用例

var webdriverNode = require("webdriverNode");
var client = webdriverNode.remote();
/* 
或者通过指定ip，来操控远端的selenium server
var client = webdriverNode.remote({
    host: "xx.xx.xx.xx"
    });
另外也可以指定进行测试的浏览器
var client = webdriverNode.remote({desiredCapabilities:{browserName:"chrome"}});
*/

client
    .init()
    .url("https://github.com/")
    .getElementSize("id", "header", function(result){ console.log(result);  })
    .getTitle(function(title) { console.log(title) })
    .getElementCssProperty("id", "header", "color", function(result){ console.log(result);  })
    .end(); 

异步方法同步顺序执行

webdriverNode中提供的所有方法都是异步的。为什么是异步？因为每次操作的原理都是：

webdriverNode --> selsenium server --> webdriver( Browser ) --> Selenium Server --> webdriverNode

如果使用异步的方式写测试用例，势必会让人奔溃，因此webdriverNode使用模块SyncRun来实现异步方法的同步执行。利用SyncRun的封装， 这些方法本身是异步，但是他们会按照被调用的顺序，同步执行。举个栗子：

Client.a()
    .b(function(){
        
    	this.c();
    	this.d({
    		this.e();
    	});
    })
    .f();

上面这段代码的执行顺序是 a -> b -> c -> d -> e -> f, 表明webdriverNode中的方法是支持嵌套的。具体的原理和细节，可以参考SyncRun.

Jasmine式的测试方法

Selenium2 虽然提供了webdriver来操控浏览器，但是并没有提供与测试相关的方法，因此webdriverNode模仿目前比较流行的前端测试框架Jasmine进行了简单的扩展。

一个简单的测试用例：

client.url("http://www.google.com", function(){
    
    this.describe( 'this is describe', function(){

        this.it( 'title Test', function (){

            this.getTitle(function ( title ){

                this.expect( title ).toBe( 'Google' );

                this.setValue("#lst-ib", "webdriver")
                    .getValue( '#lst-ib', function ( value ){

                        this.expect( value ).toBe( 'webdriver' );
                    })
                    .submitForm("#tsf");
            }) ;
        });
    });
})
.end(function( logs, testResult ){});

其写法和jasmine类似，也支持describe的嵌套，并支持一定数量的expect方法。测试结果将在end方法的回调中返回。

WebdriverNode相对webdriverjs的变化

• 独立出了异步方法顺序执行的模块SyncRun，提供更加自由和强大的顺序执行。
• 添加了log方法，用于让用户自定义输出（本身是一个用于和异步方法一起顺序执行的方法）
• 添加了jasmine式的测试方法
• 记录每个顺序执行的操作过程和结果，并在end方法的回调中作为第一个参数返回（所有的信息，包括用户自定义log）
• 强调一下，webdriverNode和webdriverjs在实际使用中没有区别。webdriverjs的examples可以直接用webdriverNode来运行

文档

webdriverNode支持的方法可以查看docs/index.html，文档内容来自各个方法文件开头注释，要更新文档，请执行：

node docs/generate.js

License

(The MIT License)

Copyright (c) 2011-2012 Neekey (倪云建) <ni184775761@gmail.com>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.