/concordion-screenshot-extension-markdown-demo

Primary LanguageJavaOtherNOASSERTION

Introduction

This project demonstrates the usage of the Concordion Screenshot Extension with Selenium WebDriver.

Example output is shown here.

Running the tests

The tests use Selenium's FirefoxDriver, so you'll need to have Firefox installed (or you could change the code to use a different driver).

The download includes support to run the tests with either Gradle or Maven.

Using Gradle

  1. Download and install Gradle (this has been tested with 2.1)
  2. From a command line opened at the location to which this package has been unzipped, run gradle clean test
  3. View the Concordion output under the subfolder build/reports/spec/org/concordion/ext/demo/selenium/

Using Maven

  1. Download and install maven (this has been tested with 3.0.3)
  2. From a command line opened at the location to which this package has been unzipped, run mvn test
  3. View the Concordion output under the subfolder target/concordion/org/concordion/ext/demo/selenium/

Running from your IDE

Import as a Gradle or as a Maven project. This may require additional plugins to be installed to support Gradle or Maven.

Under the src/test/java folder, find the ScreenshotDemo class in the org.concordion.ext.demo.selenium package and run as a JUnit test. The location of the Concordion output is shown on the standard output console.

What you should see

The tests will open a Firefox browser and perform a Google search.

JUnit output

The test should pass successfully, though the console output will show a failure with the message:

<-- Note: This test has been marked as EXPECTED_TO_FAIL

This test deliberately fails in order to demonstrate the extension. It uses Concordion's @ExpectedToFail annotation to keep the JUnit passing (you'd normally only use this when you have a partially implemented feature).

Concordion output

The output folder should contain the following specification. (You can see an example of it here).

ScreenshotDemo.html

This should show a failing example (red). Hovering the mouse over the failing example will show a screenshot taken when the failure occurred. Clicking on the failure will open the screenshot.

The screenshot extension is configured with a custom SeleniumScreenshotTaker class that uses Selenium's TakesScreenshot interface to take a screenshot of the web page. The extension has a number of configuration options, for example to also take screenshots on successful examples and to set the image width.

It can also be used to explicitly add screenshots to the Concordion output.

Potential Issues

Proxy

If you are behind a HTTP proxy server, you may need to configure the proxy to allow access to www.google.com

The easiest way to do this may be to add the following lines to the Site() constructor:

    System.setProperty("http.proxyHost", "<proxy.host>");
    System.setProperty("http.proxyPort", "<proxy.port>");

replacing <proxy.host> with the host name of the proxy server, and <proxy.port> with the port number.

If your proxy requires authentication, you will also need to set the properties http.ProxyUser and http.proxyPassword.

Additional Gradle Files

dev.gradle is only needed if you want to run against snapshot or local builds of the concordion-screenshot-extension. publish.gradle is only needed if you want to publish the output to Github pages.

If copying the project for your own use, you probably won't want either of these files.

Mailing List

Feel free to discuss this demo project on the Concordion mailing list.