node package manager
We need your input. Help make JavaScript better: Take the 2017 JavaScript Ecosystem survey »


Astrolabe Build Status

Astrolabe is an extension for protractor that adds page objects to your functional/e2e tests.


via npm (node package manager)

$ npm install astrolabe


Example signInPage.js

var Page = require('astrolabe').Page;
module.exports = Page.create({
    url: { value: '' },
    username: { get: function() { return this.findElement('username')); } }, // finds an input element with the name 'username' 
    submit:   { get: function() { return this.findElement('submit')); } }       // finds an element with the id 'submit' 

adding to tests:

var signInPage = require('./path/to/signInPage');


signInPage.go(); // will send browser to '' 
signInPage.go('some', 'path'); // will send browser to '' 
signInPage.go('some/path');    // will send browser to '' 
signInPage.go({ some: 'query' }); // will send browser to '' 

interacting: (See Protractor API Docs for more info on available api methods)

signInPage.username.sendKeys('a username'); // will fill the username input with the text 'a username'; // will click on the submit element 
signInPage.username.getAttribute('value'); // will return a promise that is resolved with the value of the text field, in this case 'a username' 
// this can be used within an expectation 
expect(signInPage.username.getAttribute('value')).toBe('a username');

It is possible to create convenience methods to wrap up common logic.

Example signInPage.js

var Page = require('astrolabe').Page;
module.exports = Page.create({
    url: { value: '' },
    username: { get: function() { return this.findElement('username')); } },
    password: { get: function() { return this.findElement('password')); } },
    submit:   { get: function() { return this.findElement('submit')); } },
    invalid:  { get: function() { return this.findElement('incorrectLogin')); } },
    InvalidLoginException: { get: function() { return this.exception('Invalid Login'); } },
    // Adds a signIn method to the page object. 
    signIn:   { value: function(username, password) {
        var page = this;
        return this.invalid.isDisplayed().then(function (wrongLogin) {
            if (wrongLogin) {
                page.InvalidLoginException.thro(username + '' + password + ' is not valid');
    } }

can be used in your tests:

var signInPage = require('./path/to/signInPage');
signInPage.signIn('test user', 'testpassword'); // will navigate to sign in page, enter username and password then click submit. 

Cloning and running Astrolabe's tests

Clone the github repository.

git clone
cd astrolabe
npm install

npm test

Running Astrolabe's example protractor test

Install protractor with.

npm install protractor

Start up a selenium server (See the appendix below for help with this). By default, the tests expect the selenium server to be running at http://localhost:4444/wd/hub.

The example folder contains a simple test suite which runs against It is a port of the simple test suite included with protractor.

Currently only the protractor runner is supported. The runner accepts a configuration file, which runs the tests at example/onProtractorRunner.js.

node_modules/.bin/protractor examples/protractor.conf.js

Setting up a standalone selenium server

See Appendix A of protractor's installation instructions