HtmlUnit / Feature Requests / #255 Testing with external file and console.log()

Java GUI-Less browser, supporting JavaScript, to run against web pages

#255 Testing with external file and console.log()

Milestone: Latest SVN

Status: open

Owner: nobody

Labels: None

Priority: 1

Updated: 2018-08-14

Created: 2018-08-14

Creator: Atsushi Nakagawa

Private: No

There's currently a WebDriverTestCase.loadPageWithAlerts2(String html) that tests behaviour of the passed html string for against expected alert()s.

This feature request is for a similar method, say WebDriverTestCase.loadPageWithJsLogs(Class<?> testClass, String resourceFileName), that tests behaviour of specified the html resource file against expected console.log()s.

Possible structure of test files is as follows:

src/test/java/com/gargoylesoftware/htmlunit/javascript/SomeEngineTest.java
src/test/resources/WebDriverTestCase/javascript/SomeEngineTest/someBehaviour.html

Motivation

It's less burdensome writing HTML in text editors then inline Java strings, making hacking up tests easier
It's easier to verify behaviour in actual browsers if there are physical html files lying about, and they console.log() instead of alert().

Likely contents of test files

src/test/java/com/gargoylesoftware/htmlunit/javascript/SomeEngineTest.java

package com.gargoylesoftware.htmlunit.javascript;

@RunWith(BrowserRunner.class)
public class SomeEngineTest {

    @Test
    @JsLogs({"foo", "bar"})
    public void someBehaviour() throws Exception {
        loadPageWithJsLogs("someBehaviour.html");
    }
}

src/test/resources/WebDriverTestCase/javascript/SomeEngineTest/someBehaviour.html

<!DOCTYPE html>
<html>
<head>
<script>
// "onload" property of <body> also attaches to this window
// see https://www.w3.org/TR/uievents/#event-type-load
window.addEventListener("load", function () { console.log('foo') })
</script>
</head>
<body onload="console.log('bar')">
</body>
</html>

Possible implementation

protected final WebDriver loadPageWithJsLogs(String resourceFileName) {
    // testClass is the implementing test class
    return loadPageWithJsLogs(getClass(), resourceFileName);
}

protected final WebDriver loadPageWithJsLogs(Class<?> testClass, String resourceFileName) {
    String testClassName = testClass.getName();

    // This removes the excess "com.gargoylesoftware.htmlunit." prefix
    String commonPrefix = StringUtils.getCommonPrefix(WebDriverTestCase.class.getName(), testClassName);
    if (!commonPrefix.isEmpty()) {
        testClassName = StringUtils.removeStart(testClassName, commonPrefix);
    }

    // Method classes get a '$' delimiter, change them to '.' (why? not strictly necessary)
    String path = WebDriverTestCase.class.getSimpleName() + "/" + testClassName.replace('.', '/').replace('$', '.');

    try (InputStream in = WebDriverTestCase.class.getClassLoader().getResourceAsStream(path)) {
        String html = ...;
    }

    // take html and perform voodoo, use WebConsoleLogCapturer and capture console.log(), send WebConsoleLogCapturer.captured() to implemetation of @JsLogs
}

WebConsoleLogCapturer attached. ("INFO: " prefixing could be removed for beverity.)

1 Attachments

WebConsoleLogCapturer.java

Discussion

Atsushi Nakagawa - 2018-08-14

send WebConsoleLogCapturer.captured() to implemetation of @JsLogs

e.g.

assertEquals(jsLogs.stream() .map(s -> "INFO: " + s) .collect(Collectors.joining("\n")), String.join("\n", cc.captured()));

Last edit: Atsushi Nakagawa 2018-08-14
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:

Testing with external file and console.log()