Author: lewismc
Date: Sat Sep 13 04:17:25 2014
New Revision: 1624695
URL: http://svn.apache.org/r1624695
Log:
Add documentation for Testing
Modified:
gora/site/trunk/content/current/index.md
Modified: gora/site/trunk/content/current/index.md
URL:
http://svn.apache.org/viewvc/gora/site/trunk/content/current/index.md?rev=1624695&r1=1624694&r2=1624695&view=diff
==============================================================================
--- gora/site/trunk/content/current/index.md (original)
+++ gora/site/trunk/content/current/index.md Sat Sep 13 04:17:25 2014
@@ -1,6 +1,9 @@
Title: Gora Module Overview
##Introduction
+
+[TOC]
+
This is the main entry point for Gora documentation. Here are some pointers
for further info:
* First if you haven't already done so, make sure to check the [quick start
guide](./quickstart.html).
@@ -33,3 +36,26 @@ following modules are currently implemen
* [gora-mongodb](./gora-mongodb.html): Module for
[MongoDB](http://www.mongodb.org/) backend and MongoStore implementation;
We currently have modules under development for [Oracle
NoSQL](http://www.oracle.com/technetwork/database/database-technologies/nosqldb/overview/index.html)
and [Apache Lucene](http://lucene.apache.org).
+
+##Gora Testing
+Gora currently has two testing mechanisms
+ * JUnit Tests: These are included for every module which provides a DataStore
within Gora.
+ * Integration Tests: A custom testing suite called GoraCI (Continuous
Ingestion) which stress tests Gora functionality at scale.
+
+###JUnit Tests
+Unit tests in Gora are implemented using the popular [JUnit](http://junit.org)
framework.
+Each module which implements the
[DataStore](https://builds.apache.org/view/All/job/gora-trunk/javadoc/index.html?org/apache/gora/store/DataStore.html)
+interface similarly implements a
[DataStoreTestBase](https://github.com/apache/gora/blob/master/gora-core/src/test/java/org/apache/gora/store/DataStoreTestBase.java)
API
+which test utilities for DataStores. The DataStoreTestBase class delegates
actual test execution
+to
[DataStoreTestUtil](https://github.com/apache/gora/blob/master/gora-core/src/test/java/org/apache/gora/store/DataStoreTestUtil.java).
+
+The tests begin in a fairly trivial fashion testing functionality like
datastore schema creation
+schema deletion, etc and continue in this manner getting progressively more
complex
+as we begin testing some more advanced features within the Gora API.
+In addition to the unit tests contained within this class, the best place to
look for
+API functionality is at the examples directories under various Gora modules.
Most
+modules contain a <code>/src/examples/</code> directory under which some
example
+classes can be found. Specifically, there are some classes that are used for
tests
+under
[gora-core/src/examples/](https://github.com/apache/gora/tree/master/gora-core/src/examples).
+
+###GoraCI Integration Testsing Suite
\ No newline at end of file
