From f225df376c2c30d90e3fd04ebabf9433915f04bc Mon Sep 17 00:00:00 2001 From: Ammar Khaku Date: Thu, 24 May 2018 09:42:30 -0700 Subject: [PATCH] Add a note about testing jar --- docs/testing.md | 14 ++++++++++++++ mkdocs.yml | 1 + 2 files changed, 15 insertions(+) create mode 100644 docs/testing.md diff --git a/docs/testing.md b/docs/testing.md new file mode 100644 index 0000000000..19bad0e2c4 --- /dev/null +++ b/docs/testing.md @@ -0,0 +1,14 @@ +# Unit testing with Hollow objects + +Hollow provides a `hollow-test` jar that contains some testing utilities to facilitate unit testing with Hollow objects. + +### HollowReadStateEngineBuilder + +This class allows easy creation of `HollowReadStateEngine` objects for use in unit tests. + +```java +HollowReadStateEngine engine = new HollowReadStateEngineBuilder() + .add(new Movie("foo")) + .add(new Actor("bar")) + .build() +``` diff --git a/mkdocs.yml b/mkdocs.yml index e1f8e66516..d2c32fac0b 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -15,6 +15,7 @@ pages: - Interacting with a Hollow Dataset: 'interacting-with-a-dataset.md' - Data Ingestion: 'data-ingestion.md' - Advanced Topics: 'advanced-topics.md' + - Testing: 'testing.md' - Glossary: 'glossary.md' - Community: 'community.md' - Acknowledgements: 'acknowledgements.md'