Search icon CANCEL
Subscription
0
Cart icon
Your Cart (0 item)
Close icon
You have no products in your basket yet
Save more on your purchases now! discount-offer-chevron-icon
Savings automatically calculated. No voucher code required.
Arrow left icon
Explore Products
Best Sellers
New Releases
Books
Videos
Audiobooks
Learning Hub
Conferences
Free Learning
Arrow right icon
PhantomJS Cookbook
PhantomJS Cookbook

PhantomJS Cookbook: Over 70 recipes to help boost the productivity of your applications using real-world testing with PhantomJS

eBook
€18.99 €27.99
Paperback
€34.99
Subscription
Free Trial
Renews at €18.99p/m

What do you get with eBook?

Product feature icon Instant access to your Digital eBook purchase
Product feature icon Download this book in EPUB and PDF formats
Product feature icon Access this title in our online reader with advanced features
Product feature icon DRM FREE - Read whenever, wherever and however you want
Table of content icon View table of contents Preview book icon Preview Book

PhantomJS Cookbook

Chapter 2. PhantomJS Core Modules

In this chapter, we will cover:

  • Inspecting the version at runtime
  • Managing cookies with the phantom object
  • Specifying a path for external scripts
  • Setting up a global PhantomJS error handler
  • Controlling the exit status of a PhantomJS script
  • Inspecting command-line arguments
  • Inspecting system environment variables
  • Saving a file from a PhantomJS script
  • Reading a file from PhantomJS
  • Creating a custom module for PhantomJS
  • Loading custom modules in PhantomJS

Introduction

PhantomJS exposes several core APIs to work with the headless browser and with the operating system that hosts the runtime. For example, we can get information about PhantomJS, inspect our host environment for values assigned to variables, and read from or write to the filesystem with the help of these APIs.

The recipes in this chapter will focus on those APIs that are considered part of the PhantomJS core. Specifically, we will introduce and discuss the global phantom object, the system and fs modules, and how to create and load our own CommonJS-compatible modules.

Inspecting the version at runtime

This recipe will introduce the global phantom object in PhantomJS and discuss how we can inspect the version at runtime using the version property.

Getting ready

To run this recipe, we will need a script that accesses phantom.version. The script in this recipe is available in the downloadable code repository as recipe01.js under chapter02. If we run the provided example script, we must change to the root directory for the book's sample code.

How to do it…

Consider the following script:

console.log('PhantomJS');
console.log('  - major version: ' + phantom.version.major);
console.log('  - minor version: ' + phantom.version.minor);
console.log('  - patch version: ' + phantom.version.patch);
phantom.exit();

Given the preceding script, enter the following at the command line:

phantomjs chapter02/recipe01.js

Our output should look like the following:

PhantomJS
  - major version: 1
  - minor version: 9
  - patch version...

Managing cookies with the phantom object

In this recipe, we will discuss how to work with cookies in PhantomJS. The phantom object exposes two properties (cookies and cookiesEnabled) and three methods (addCookie, clearCookie, and deleteCookie) that we can use to inspect and manipulate cookies at runtime.

Getting ready

To run this recipe, we may wish to run PhantomJS with persistent cookies using the cookies-file command-line argument.

The script in this recipe is available in the downloadable code repository as recipe02.js under chapter02. If we run the provided example script, we must change to the root directory for the book's sample code.

Lastly, the script in this recipe runs against the demo site that is included with the cookbook's sample code repository. To run the demo site, we must have Node.js installed. In a separate terminal, change to the phantomjs-sandbox directory (in the sample code's directory) and start the app with the following command:

node app.js

How to do...

Specifying a path for external scripts

In this recipe, we will introduce the libraryPath property on the phantom object and discuss how to use it to control the source of scripts that are loaded in the runtime via injectJs.

Getting ready

To run this recipe, we will need at least one injectable script and the script that we want to run.

The script in this recipe is available in the downloadable code repository as recipe03.js under chapter02. If we run the provided example script, we must change to the root directory for the book's sample code.

How to do it…

Consider the following script:

console.log('Initial libraryPath: ' + phantom.libraryPath);

phantom.libraryPath = phantom.libraryPath.replace(/chapter02$/,
  'lib');

console.log('Updated libraryPath: ' + phantom.libraryPath);

var isInjected = phantom.injectJs('hemingway.js');

if (isInjected) {
  console.log('Script was successfully injected.');
  console.log('Give me some...

Setting up a global PhantomJS error handler

This recipe introduces the onError callback and demonstrates how we can use it to catch and handle errors in the PhantomJS runtime. As this onError callback is attached to the phantom object, we can use it to handle errors that are not otherwise handled by try-catch statements in our PhantomJS scripts or by onError handlers attached to webpage objects.

Getting ready

To run this recipe, we will need a script that we believe has a tendency to fail.

The script in this recipe is available in the downloadable code repository as recipe04.js under chapter02. If we run the provided example script, we must change to the root directory for the book's sample code.

How to do it…

Consider the following script:

phantom.onError = function(message, trace) {
  console.error('[PHANTOMJS ERROR] ' + message);
  trace.forEach(function(t) {
    console.error('  >> [' + t.line + '] ' +
      (t.function ? '[' + t.function...

Introduction


PhantomJS exposes several core APIs to work with the headless browser and with the operating system that hosts the runtime. For example, we can get information about PhantomJS, inspect our host environment for values assigned to variables, and read from or write to the filesystem with the help of these APIs.

The recipes in this chapter will focus on those APIs that are considered part of the PhantomJS core. Specifically, we will introduce and discuss the global phantom object, the system and fs modules, and how to create and load our own CommonJS-compatible modules.

Inspecting the version at runtime


This recipe will introduce the global phantom object in PhantomJS and discuss how we can inspect the version at runtime using the version property.

Getting ready

To run this recipe, we will need a script that accesses phantom.version. The script in this recipe is available in the downloadable code repository as recipe01.js under chapter02. If we run the provided example script, we must change to the root directory for the book's sample code.

How to do it…

Consider the following script:

console.log('PhantomJS');
console.log('  - major version: ' + phantom.version.major);
console.log('  - minor version: ' + phantom.version.minor);
console.log('  - patch version: ' + phantom.version.patch);
phantom.exit();

Given the preceding script, enter the following at the command line:

phantomjs chapter02/recipe01.js

Our output should look like the following:

PhantomJS
  - major version: 1
  - minor version: 9
  - patch version: 2

How it works…

Our script operates by accessing...

Managing cookies with the phantom object


In this recipe, we will discuss how to work with cookies in PhantomJS. The phantom object exposes two properties (cookies and cookiesEnabled) and three methods (addCookie, clearCookie, and deleteCookie) that we can use to inspect and manipulate cookies at runtime.

Getting ready

To run this recipe, we may wish to run PhantomJS with persistent cookies using the cookies-file command-line argument.

The script in this recipe is available in the downloadable code repository as recipe02.js under chapter02. If we run the provided example script, we must change to the root directory for the book's sample code.

Lastly, the script in this recipe runs against the demo site that is included with the cookbook's sample code repository. To run the demo site, we must have Node.js installed. In a separate terminal, change to the phantomjs-sandbox directory (in the sample code's directory) and start the app with the following command:

node app.js

How to do it…

Consider the...

Specifying a path for external scripts


In this recipe, we will introduce the libraryPath property on the phantom object and discuss how to use it to control the source of scripts that are loaded in the runtime via injectJs.

Getting ready

To run this recipe, we will need at least one injectable script and the script that we want to run.

The script in this recipe is available in the downloadable code repository as recipe03.js under chapter02. If we run the provided example script, we must change to the root directory for the book's sample code.

How to do it…

Consider the following script:

console.log('Initial libraryPath: ' + phantom.libraryPath);

phantom.libraryPath = phantom.libraryPath.replace(/chapter02$/,
  'lib');

console.log('Updated libraryPath: ' + phantom.libraryPath);

var isInjected = phantom.injectJs('hemingway.js');

if (isInjected) {
  console.log('Script was successfully injected.');
  console.log('Give me some Fibonacci numbers! ' +
    fibonacci(Math.round(Math.random() * 10...

Setting up a global PhantomJS error handler


This recipe introduces the onError callback and demonstrates how we can use it to catch and handle errors in the PhantomJS runtime. As this onError callback is attached to the phantom object, we can use it to handle errors that are not otherwise handled by try-catch statements in our PhantomJS scripts or by onError handlers attached to webpage objects.

Getting ready

To run this recipe, we will need a script that we believe has a tendency to fail.

The script in this recipe is available in the downloadable code repository as recipe04.js under chapter02. If we run the provided example script, we must change to the root directory for the book's sample code.

How to do it…

Consider the following script:

phantom.onError = function(message, trace) {
  console.error('[PHANTOMJS ERROR] ' + message);
  trace.forEach(function(t) {
    console.error('  >> [' + t.line + '] ' +
      (t.function ? '[' + t.function + '] ' : '') +
      t.file || t.sourceURL);...

Controlling the exit status of a PhantomJS script


Although we have seen and used phantom.exit in all of our previous examples, we will now discuss it explicitly and learn in detail how it is used. In this recipe, we will learn how to control the exit status of the PhantomJS application.

Getting ready

To run this recipe, we require a script where we need to control the exit status.

The script in this recipe is available in the downloadable code repository as recipe05.js under chapter02. If we run the provided example script, we must change to the root directory for the book's sample code.

How to do it…

Consider the following script:

console.log('Running the PhantomJS exit demo...');

if (Math.floor(Math.random() * 10) % 2 === 0) {
  console.log('Exiting cleanly from PhantomJS!');
  phantom.exit();
} else {
  console.log('Exiting with an error status.');
  phantom.exit(1);
}

Given the preceding script, enter the following at the command line:

phantomjs chapter02/recipe05.js

If the script makes a...

Inspecting command-line arguments


In this recipe, we introduce the system module and discuss how to inspect arguments that are passed to the PhantomJS runtime environment from the command line. The system module is the bridge between PhantomJS, its host operating system, and the process it runs in.

Getting ready

To run this recipe, we will need a script that accepts arguments from the command line.

The script in this recipe is available in the downloadable code repository as recipe06.js under chapter02. If we run the provided example script, we must change to the root directory for the book's sample code.

How to do it…

Consider the following script:

var system = require('system'),
    args   = system.args;

console.log('script name is: ' + args[0]);

if (args.length > 1) {
  var restArgs = args.slice(1);
  restArgs.forEach(function(arg, i) {
    console.log('[' + (i + 1) + '] ' + arg);
  });
} else {
  console.log('No arguments were passed.');
}

phantom.exit();

Given the preceding script, enter...

Left arrow icon Right arrow icon

Description

A task-based guide that provides solutions to real-world test automation problems. This book is intended for web development professionals who want to integrate PhantomJS into their development and testing workflows. If you are a web developer looking to run automated unit tests while you work, or perhaps you are a QA engineer looking for a fast test automation utility, then this book is perfect for you. Some prior knowledge of JavaScript would be helpful.

What you will learn

  • Develop your own PhantomJS core modules
  • Learn sophisticated strategies for interacting with web page contents and how to capture those interactions
  • Create a frontend continuous integration (CI) strategy with PhantomJS
  • Perform unit testing with frameworks such as Jasmine, Mocha, and QUnit
  • Implement functional and endtoend testing with PhantomJS using tools such as Selenium, Capybara, and CasperJS
  • Automate performance analysis with libraries such as Confess.js and YSlow
  • Automate the generation of images and PDFs of your web content

Product Details

Country selected
Publication date, Length, Edition, Language, ISBN-13
Publication date : Jun 12, 2014
Length: 304 pages
Edition : 1st
Language : English
ISBN-13 : 9781783981939
Languages :
Concepts :
Tools :

What do you get with eBook?

Product feature icon Instant access to your Digital eBook purchase
Product feature icon Download this book in EPUB and PDF formats
Product feature icon Access this title in our online reader with advanced features
Product feature icon DRM FREE - Read whenever, wherever and however you want

Product Details

Publication date : Jun 12, 2014
Length: 304 pages
Edition : 1st
Language : English
ISBN-13 : 9781783981939
Languages :
Concepts :
Tools :

Packt Subscriptions

See our plans and pricing
Modal Close icon
€18.99 billed monthly
Feature tick icon Unlimited access to Packt's library of 7,000+ practical books and videos
Feature tick icon Constantly refreshed with 50+ new titles a month
Feature tick icon Exclusive Early access to books as they're written
Feature tick icon Solve problems while you work with advanced search and reference features
Feature tick icon Offline reading on the mobile app
Feature tick icon Simple pricing, no contract
€189.99 billed annually
Feature tick icon Unlimited access to Packt's library of 7,000+ practical books and videos
Feature tick icon Constantly refreshed with 50+ new titles a month
Feature tick icon Exclusive Early access to books as they're written
Feature tick icon Solve problems while you work with advanced search and reference features
Feature tick icon Offline reading on the mobile app
Feature tick icon Choose a DRM-free eBook or Video every month to keep
Feature tick icon PLUS own as many other DRM-free eBooks or Videos as you like for just €5 each
Feature tick icon Exclusive print discounts
€264.99 billed in 18 months
Feature tick icon Unlimited access to Packt's library of 7,000+ practical books and videos
Feature tick icon Constantly refreshed with 50+ new titles a month
Feature tick icon Exclusive Early access to books as they're written
Feature tick icon Solve problems while you work with advanced search and reference features
Feature tick icon Offline reading on the mobile app
Feature tick icon Choose a DRM-free eBook or Video every month to keep
Feature tick icon PLUS own as many other DRM-free eBooks or Videos as you like for just €5 each
Feature tick icon Exclusive print discounts

Frequently bought together


Stars icon
Total 105.97
Getting Started with PhantomJS
€24.99
Mastering D3.js
€45.99
PhantomJS Cookbook
€34.99
Total 105.97 Stars icon

Table of Contents

9 Chapters
1. Getting Started with PhantomJS Chevron down icon Chevron up icon
2. PhantomJS Core Modules Chevron down icon Chevron up icon
3. Working with webpage Objects Chevron down icon Chevron up icon
4. Unit Testing with PhantomJS Chevron down icon Chevron up icon
5. Functional and End-to-end Testing with PhantomJS Chevron down icon Chevron up icon
6. Network Monitoring and Performance Analysis Chevron down icon Chevron up icon
7. Generating Images and Documents with PhantomJS Chevron down icon Chevron up icon
8. Continuous Integration with PhantomJS Chevron down icon Chevron up icon
Index Chevron down icon Chevron up icon

Customer reviews

Rating distribution
Full star icon Full star icon Full star icon Full star icon Half star icon 4.2
(5 Ratings)
5 star 40%
4 star 40%
3 star 20%
2 star 0%
1 star 0%
G.Lorrig Mar 14, 2018
Full star icon Full star icon Full star icon Empty star icon Empty star icon 3
Die Einführung in Phantomjs ist gut geschrieben, mit vielen leicht nachvollziehbaren Beispielen.Leider haben sich einige Dinge inzwischen verändert, manche Methoden sind nun in anderen Klassen verfügbar, was beim Nachvollziehen der Beispiele dann schon mal zu Frusterlebnissen führt.Eine aktualisierte Neuauflage wäre wünschenswert. Aber sie käme zu spät, ich habe das Buch schon gekauft. :D
Amazon Verified review Amazon
Jeffrey Pierce Oct 22, 2015
Full star icon Full star icon Full star icon Full star icon Full star icon 5
This book is exactly what you want in a cookbook. It is informative, concise and practical. Testing is usually an afterthought when it comes to JavaScript. This book, with its straight forward writing style, gives you many actionable ways to create a suite of tools which makes testing code not only easier, but enjoyable. I HIGHLY recommend this book to anyone who has an interest in learning more about analyzing and creating performant JavaScript applications.
Amazon Verified review Amazon
Angus Oct 30, 2014
Full star icon Full star icon Full star icon Full star icon Full star icon 5
This is much more than a cookbook, it's pretty much the bible of Phantom JS development.PhantomJS is remarkably thorough (a subtitle might be "no use-case left behind") and yet it's not at all intimidating. In fact the first two chapters are squarely aimed at the beginner. We're introduced to PhantomJS and its core modules with no assumptions re. experience, other than a basic command of JavaScript.From there Friesel takes us through unit testing (all mainstream frameworks are covered), integration testing, CI, using test data for performance metrics and rendering page content.Friesel's writing is clear and straightforward throughout. If you only get one PhantomJS book, get this one.
Amazon Verified review Amazon
Amazon Customer Jul 27, 2014
Full star icon Full star icon Full star icon Full star icon Empty star icon 4
I read one of the books’ recipes Automating performance analysis with YSlow and PhantomJS on the Packt website, and was thrilled when given the opportunity to review it.The first three chapters of this book explain how to get Phantom installed, use its core modules and begin working with webpages. The next four chapters cover specific use cases: unit, functional and performance testing and generating screenshots and documents. The final chapter describes how to setup Jenkins (the continuous integration server) to run your PhantomJS code.A couple of things stood out in this book:This book is not designed to be read straight through from cover to cover – like I did. Each of the recipes is designed to be self-contained (though this does lead to several paragraphs being repeated in most recipes – how to start the books demo site and run the example script). Making it easy to cherry pick the recipes that fit your needs and ignore those that don’t (i.e., the unit testing chapter contains recipes for running QUnit, Mocha and Jasmine tests – I doubt anyone is using all of these).The author clearly understands Phantom, both its strengths and weaknesses, at a very deep level. Several times he pointed out functions that lack documentation or where the documentation is incorrect. This type of information can save countless hours of debugging and frustration. Likewise, he clearly states where the use of an additional library (i.e., Casper) can make things simpler. When the reader may be left questioning how or why to use a specific recipe (i.e., Preventing CSS from downloading) he provides a clear and simple use case (to view the site when styles are disabled).The book makes the most of its cross references and external links. When a topic is introduced, but is outside the book’s scope the author provides a link to additional information (i.e., how to install Jenkins). Likewise, each recipe contains a “See also” section that references other recipes from the book, though in the eBook version not all of these were hyperlinked to the corresponding section. This was made worse by the fact that the table of contents only lists the chapter titles, not individual recipes, resulting in a lot of swiping to find the correct page.I did see a few minor issues:Deprecated code is not treated consistantly. In one instance (Running a PhantomJS script with arguments) phantom.args and phantom.scriptName provide the main functionality. The author notes that these functions are deprecated and their use therefore discouraged, and adding “Although using them for quick one-off exploratory scripts is fine, neither of these properties should go into any library that we intend to maintain or distribute. He also mentions the now preferred method of getting the same info using the system module. Which left me with several questions – why explore code using a method not suited to production? Why include the deprecated functions at all? Why not just rewrite the example to use the system module? However, when discussing the WebPage constructor he includes an example of the now deprecated form of the constructor noting that it should not be used, but was included because the reader may see it in older code. In my opinion this was a much better method of dealing with the issues presented by deprecated code.In the testing chapters I would have liked to have seen the results of the non-happy path (not all tests pass every time - if yours do your doing it wrong). What happens when the tests fail? Where can I get help interpreting the failure message? Are there online resources I can turn to like StackOverflow, a mailing list or IRC?I found it curious that when using Selenium the author chose to use the JAVA bindings and not the JS bindings – this may be a case of the author being more familiar with the java bindings, but since the book is based on a JS lib I would have thought that a better choice.In one recipe he suggests solving an error by deleting and reinstalling the node modules – but includes no discussion of why or how this solves the problem. While this will likely have no negative effects I still like to know why I am doing something.As I have said the recipes in this book are designed to be self-contained, in a handful of cases the author breaks from his pattern, most notably when using the confess.js library. He only discusses the config file after using it/mentioning it several times, making this information much harder to find.Overall the good far outweighs the bad in this book. For me the chapters on performance testing and continuous integration easily repaid the time invested in reading this book and implementing several of the book’s recipes.Since this book is not designed to be read from cover to cover, the question of value is a little harder to answer; but in the end, if you’re already using Phantom JS and are trying to maximize your return on investment, implementing only a couple of the book’s recipes should make it a worthwhile investment.
Amazon Verified review Amazon
Rodrigo Martin Jul 20, 2014
Full star icon Full star icon Full star icon Full star icon Empty star icon 4
http://www.packtpub.com/phantomjs-cookbook/book?utm_source=Mention.com&utm_medium=Blog%2FSM&utm_campaign=MarketingThe PhantomJS Cookbook starts explaining the basics of PhantomJS.Later on, a set of recipes explains the core modules.How to interact with webpage objects comes next, including http actions, injecting js into the browser, simulationuf user input actions, web sockets and an interesting way of blocking css from downloading, amongst others.Then we are presented with how to drive unit tests usign PhantomJS as the main driver, with recipes for a wideset of technologies: jasmine, karma, qunit, grunt for tasks automation. It also presents how to integrate with codecoverage reports tool like Istanbul.The reading continues with Functional and end-to-end testing recipes, with Selenium, GhostDriver, Poltergeist, CapybaraCasper JS, just to name some of them. I've found the ideas for the recipes on how to perform visual regressions usingPhantomCSS very useful.The latest chapters provides good examples for Network monitoring and Performance Analysis, generation of images anddocuments for the reporting part of your testing and development efforts, and finally how to seamessly integratePhantomJS with your CI server.I would recommend this book to readers who wants to dig in how to integrate headless testing to your currentbattery of automated tests. It also explains other concepts, besides PhantomJS, that adds value to the overall proposalof this publication.One little note, though, is the repetition on all the chapters of how to start the example application. Please refactor! :P
Amazon Verified review Amazon
Get free access to Packt library with over 7500+ books and video courses for 7 days!
Start Free Trial

FAQs

How do I buy and download an eBook? Chevron down icon Chevron up icon

Where there is an eBook version of a title available, you can buy it from the book details for that title. Add either the standalone eBook or the eBook and print book bundle to your shopping cart. Your eBook will show in your cart as a product on its own. After completing checkout and payment in the normal way, you will receive your receipt on the screen containing a link to a personalised PDF download file. This link will remain active for 30 days. You can download backup copies of the file by logging in to your account at any time.

If you already have Adobe reader installed, then clicking on the link will download and open the PDF file directly. If you don't, then save the PDF file on your machine and download the Reader to view it.

Please Note: Packt eBooks are non-returnable and non-refundable.

Packt eBook and Licensing When you buy an eBook from Packt Publishing, completing your purchase means you accept the terms of our licence agreement. Please read the full text of the agreement. In it we have tried to balance the need for the ebook to be usable for you the reader with our needs to protect the rights of us as Publishers and of our authors. In summary, the agreement says:

  • You may make copies of your eBook for your own use onto any machine
  • You may not pass copies of the eBook on to anyone else
How can I make a purchase on your website? Chevron down icon Chevron up icon

If you want to purchase a video course, eBook or Bundle (Print+eBook) please follow below steps:

  1. Register on our website using your email address and the password.
  2. Search for the title by name or ISBN using the search option.
  3. Select the title you want to purchase.
  4. Choose the format you wish to purchase the title in; if you order the Print Book, you get a free eBook copy of the same title. 
  5. Proceed with the checkout process (payment to be made using Credit Card, Debit Cart, or PayPal)
Where can I access support around an eBook? Chevron down icon Chevron up icon
  • If you experience a problem with using or installing Adobe Reader, the contact Adobe directly.
  • To view the errata for the book, see www.packtpub.com/support and view the pages for the title you have.
  • To view your account details or to download a new copy of the book go to www.packtpub.com/account
  • To contact us directly if a problem is not resolved, use www.packtpub.com/contact-us
What eBook formats do Packt support? Chevron down icon Chevron up icon

Our eBooks are currently available in a variety of formats such as PDF and ePubs. In the future, this may well change with trends and development in technology, but please note that our PDFs are not Adobe eBook Reader format, which has greater restrictions on security.

You will need to use Adobe Reader v9 or later in order to read Packt's PDF eBooks.

What are the benefits of eBooks? Chevron down icon Chevron up icon
  • You can get the information you need immediately
  • You can easily take them with you on a laptop
  • You can download them an unlimited number of times
  • You can print them out
  • They are copy-paste enabled
  • They are searchable
  • There is no password protection
  • They are lower price than print
  • They save resources and space
What is an eBook? Chevron down icon Chevron up icon

Packt eBooks are a complete electronic version of the print edition, available in PDF and ePub formats. Every piece of content down to the page numbering is the same. Because we save the costs of printing and shipping the book to you, we are able to offer eBooks at a lower cost than print editions.

When you have purchased an eBook, simply login to your account and click on the link in Your Download Area. We recommend you saving the file to your hard drive before opening it.

For optimal viewing of our eBooks, we recommend you download and install the free Adobe Reader version 9.