detective.core

Class Detective

java.lang.Object

detective.core.Detective

public class Detective
extends Object

The Factory / Entry Point class for Detective Framework

Author:

James Luo

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Detective.LogLevel

Field Summary

Fields

Modifier and Type	Field and Description
static String	PARAMETER_NAME_USER_MESSAGES

Constructor Summary

Constructors

Constructor and Description
Detective()

Method Summary

Modifier and Type	Method and Description
static geb.Browser	_browser(geb.Browser browser, groovy.lang.Closure script)
static geb.Browser	_browser(groovy.lang.Closure script) Creates a new browser object via the default constructor and executes the closure with the browser instance as the closure's delegate.
static <T> org.hamcrest.Matcher<T>	allOf(org.hamcrest.Matcher<? super T>... matchers) Creates a matcher that matches if the examined object matches ALL of the specified matchers.
static <T> org.hamcrest.Matcher<T>	anyOf(org.hamcrest.Matcher<? super T>... matchers) Creates a matcher that matches if the examined object matches Any of the specified matchers.
static <T> void	assertThat(String reason, T actual, org.hamcrest.Matcher<T> matcher) Asserts that actual satisfies the condition specified by matcher.
static <T> void	assertThat(T actual, org.hamcrest.Matcher<T> matcher) Asserts that actual satisfies the condition specified by matcher.
static TraceRecord	debug(String message)
static EchoTask	echoTask()
static <T> org.hamcrest.Matcher<T>	equalTo(T operand)
static TraceRecord	error(String message)
static TraceRecord	error(String message, Throwable e)
static DslBuilder	feature()
static com.typesafe.config.Config	getConfig()
static List<String>	getUserMessage(Parameters params)
static HttpClientTask	httpclientTask()
static TraceRecord	info(String message)
static groovy.json.JsonBuilder	jsonBuilder()
static groovy.json.JsonBuilder	jsonBuilder(groovy.lang.Closure c)
static Object	jsonParser(String json)
static void	logUserMessage(Parameters params, String msg) The message is not only print into console, but aslo added into the output result section
static void	logUserMessageAsTable(Parameters params, String title, Object table)
static geb.Browser	newBrowser() The browser is the centre of Geb.
static <T> org.hamcrest.Matcher<T>	not(T value)
static String	randomId()
static TraceRecord	record(TraceRecord record)
static TraceRecord	recordLog(Detective.LogLevel level, String message)
static DslBuilder	story()
static <T> org.hamcrest.Matcher<T>	subsetOf(T operand)
static groovy.xml.MarkupBuilder	xmlBuilder(groovy.lang.Closure c)
static Object	xmlParser(String xml)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PARAMETER_NAME_USER_MESSAGES

public static final String PARAMETER_NAME_USER_MESSAGES

See Also:

Constant Field Values

Constructor Detail

Detective

public Detective()

Method Detail

story

public static DslBuilder story()

feature

public static DslBuilder feature()

jsonBuilder

public static groovy.json.JsonBuilder jsonBuilder()

jsonBuilder

public static groovy.json.JsonBuilder jsonBuilder(groovy.lang.Closure c)

jsonParser

public static Object jsonParser(String json)

xmlBuilder

public static groovy.xml.MarkupBuilder xmlBuilder(groovy.lang.Closure c)

xmlParser

public static Object xmlParser(String xml)

record

public static TraceRecord record(TraceRecord record)

recordLog

public static TraceRecord recordLog(Detective.LogLevel level,
                                    String message)

info

public static TraceRecord info(String message)

error

public static TraceRecord error(String message)

error

public static TraceRecord error(String message,
                                Throwable e)

debug

public static TraceRecord debug(String message)

logUserMessage

public static void logUserMessage(Parameters params,
                                  String msg)

The message is not only print into console, but aslo added into the output result section

logUserMessageAsTable

public static void logUserMessageAsTable(Parameters params,
                                         String title,
                                         Object table)

getUserMessage

public static List<String> getUserMessage(Parameters params)

echoTask

public static EchoTask echoTask()

httpclientTask

public static HttpClientTask httpclientTask()

equalTo

public static <T> org.hamcrest.Matcher<T> equalTo(T operand)

subsetOf

public static <T> org.hamcrest.Matcher<T> subsetOf(T operand)

not

public static <T> org.hamcrest.Matcher<T> not(T value)

allOf

public static <T> org.hamcrest.Matcher<T> allOf(org.hamcrest.Matcher<? super T>... matchers)

Creates a matcher that matches if the examined object matches ALL of the specified matchers.

For example:

assertThat("myValue", allOf(startsWith("my"), containsString("Val")))

anyOf

public static <T> org.hamcrest.Matcher<T> anyOf(org.hamcrest.Matcher<? super T>... matchers)

Creates a matcher that matches if the examined object matches Any of the specified matchers.

For example:

assertThat("myValue", anyOf(startsWith("my"), containsString("Val")))

assertThat

public static <T> void assertThat(T actual,
                                  org.hamcrest.Matcher<T> matcher)

Asserts that actual satisfies the condition specified by matcher. If not, an AssertionError is thrown with information about the matcher and failing value. Example:

   assertThat(0, is(1)); // fails:
     // failure message:
     // expected: is <1> 
     // got value: <0>
   assertThat(0, is(not(1))) // passes
 

Type Parameters:

T - the static type accepted by the matcher (this can flag obvious compile-time problems such as assertThat(1, is("a"))

Parameters:

actual - the computed value being compared

matcher - an expression, built of Matchers, specifying allowed values

See Also:

CoreMatchers, org.junit.matchers.JUnitMatchers

assertThat

public static <T> void assertThat(String reason,
                                  T actual,
                                  org.hamcrest.Matcher<T> matcher)

Asserts that actual satisfies the condition specified by matcher. If not, an AssertionError is thrown with the reason and information about the matcher and failing value. Example:

 :
   assertThat("Help! Integers don't work", 0, is(1)); // fails:
     // failure message:
     // Help! Integers don't work
     // expected: is <1> 
     // got value: <0>
   assertThat("Zero is one", 0, is(not(1))) // passes
 

Type Parameters:

T - the static type accepted by the matcher (this can flag obvious compile-time problems such as assertThat(1, is("a"))

Parameters:

reason - additional information about the error

actual - the computed value being compared

matcher - an expression, built of Matchers, specifying allowed values

See Also:

CoreMatchers, org.junit.matchers.JUnitMatchers

randomId

public static String randomId()

getConfig

public static com.typesafe.config.Config getConfig()

newBrowser

public static geb.Browser newBrowser()

The browser is the centre of Geb. It encapsulates a WebDriver implementation and references a Page object that provides access to the content.

Browser objects dynamically delegate all method calls and property read/writes that it doesn't implement to the current page instance via propertyMissing() and methodMissing(). If a call come from This class, it resolved first Then get.Browser Then currentPage

Returns:

See Also:

Browser

_browser

public static geb.Browser _browser(groovy.lang.Closure script)

Creates a new browser object via the default constructor and executes the closure with the browser instance as the closure's delegate.

Returns:

the created browser

_browser

public static geb.Browser _browser(geb.Browser browser,
                                   groovy.lang.Closure script)