org.wuokko.robot.restlib

Class JsonPathLibrary

java.lang.Object

org.wuokko.robot.restlib.JsonPathLibrary

public class JsonPathLibrary
extends Object

Robot Framework REST Library is a library for testing REST APIs in JSON format. It uses Javalib Core (https://github.com/robotframework/JavalibCore) as framework. The source for the JSON to test can be given either as URI (file or http) or as the full JSON content itself. = Runtime options = There is possibility to cache the URI results into a simple in-memory cache with system property "use.uri.cache". The cache works within a single test case only. Example: mvn robotframework:run -Duse.uri.cache=true = Properties = Also you can use properties file to set few options. The file named 'robot-rest-lib.properties' is looked from the classpath. The options are: | *Property* | *Type* | *Default* | | connection.timeout | int | 1000 | | use.uri.cache | boolean | false |

Constructor Summary

Constructors

Constructor and Description
JsonPathLibrary() Default constructor with no arguments.
JsonPathLibrary(String propertiesFile) Instantiates a library with custom named properties file.

Method Summary

Methods

Modifier and Type	Method and Description
Object	findJsonElement(String source, String jsonPath) Find JSON element by `jsonPath` from the `source` and return its value if found.
List<Object>	findJsonElementList(String source, String jsonPath) Find JSON element list by `jsonPath` from the `source` and return its value if found.
boolean	jsonElementShouldMatch(String source, String jsonPath, Object value) Checks if the given value matches the one found by the `jsonPath` from the `source`.
boolean	jsonShouldBeEqual(String from, String to) Checks if the given JSON contents are equal.
boolean	jsonShouldBeEqual(String from, String to, boolean useExactMatch) Checks if the given JSON contents are equal.
boolean	jsonShouldHaveElementCount(String source, String jsonPath, Integer count) Find JSON element by `jsonPath` from the `source` and check if the amount of found elements matches the given `count`.
protected void	loadProperties(String propertiesFile)
protected String	loadURI(URI uri)
protected String	readSource(String source)

Methods inherited from class java.lang.Object

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

Constructor Detail

JsonPathLibrary

public JsonPathLibrary()

Default constructor with no arguments. Instantiates a library using the default 'robot-rest-lib.properties' properties file.

JsonPathLibrary

public JsonPathLibrary(String propertiesFile)

Instantiates a library with custom named properties file. Pass the properties file name as an argument to the library.

Method Detail

loadProperties

protected void loadProperties(String propertiesFile)

jsonElementShouldMatch

public boolean jsonElementShouldMatch(String source,
                             String jsonPath,
                             Object value)
                               throws Exception

Checks if the given value matches the one found by the `jsonPath` from the `source`. Source can be either URI or the actual JSON content Example: | Json Element Should Match | http://example.com/test.json | $.element.param | hello | | Json Element Should Match | { element: { param:hello } } | $.element.param | hello |

Throws:

Exception

jsonShouldBeEqual

public boolean jsonShouldBeEqual(String from,
                        String to)
                          throws Exception

Checks if the given JSON contents are equal. See `Json Should Be Equal` for more details `from` and `to` can be either URI or the actual JSON content. Example: | Json Should Be Equal | http://example.com/test.json | http://foobar.com/test.json | | Json Should Be Equal | { element: { param:hello } } | { element: { param:hello } } |

Throws:

Exception

jsonShouldBeEqual

public boolean jsonShouldBeEqual(String from,
                        String to,
                        boolean useExactMatch)
                          throws Exception

Checks if the given JSON contents are equal. The third parameter specifies whether exact string match should be used or diffing by the JSON objects ie. the order of the attributes does not matter. `from` and `to` can be either URI or the actual JSON content. Example: | Json Should Be Equal | http://example.com/test.json | http://foobar.com/test.json | true | | Json Should Be Equal | { element: { param:hello, foo:bar } } | { element: { foo:bar, param:hello } } | true |

Throws:

Exception

findJsonElement

public Object findJsonElement(String source,
                     String jsonPath)
                       throws Exception

Find JSON element by `jsonPath` from the `source` and return its value if found. `source` can be either URI or the actual JSON content. Example: | Find Json Element | http://example.com/test.json | $.foo.bar | | Find Json Element | {element: { param:hello, foo:bar } } | $.element.foo |

Throws:

Exception

findJsonElementList

public List<Object> findJsonElementList(String source,
                               String jsonPath)
                                 throws Exception

Find JSON element list by `jsonPath` from the `source` and return its value if found. `source` can be either URI or the actual JSON content. Example: | Find Json Element | http://example.com/test.json | $.foo[*] | | Find Json Element | {element: [ {param:hello}, {foo:bar} ] } | $.element[*] |

Throws:

Exception

jsonShouldHaveElementCount

public boolean jsonShouldHaveElementCount(String source,
                                 String jsonPath,
                                 Integer count)
                                   throws Exception

Find JSON element by `jsonPath` from the `source` and check if the amount of found elements matches the given `count`. `source` can be either URI or the actual JSON content. Example: | Json Should Have Element Count | http://example.com/test.json | $.foo[*] | 3 | | Json Should Have Element Count | {element: [ {param:hello}, {foo:bar} ] } | $.element[*] | 2 |

Throws:

Exception

readSource

protected String readSource(String source)

loadURI

protected String loadURI(URI uri)