Differences

This shows you the differences between two versions of the page.

--- documentation:software:whiterabbit:test_framework [2017/08/17 13:11] – schuemie
+++ documentation:software:whiterabbit:test_framework [2020/02/18 14:13] (current) – maximmoinat
@@ Line 1: / Line 1: @@
 ====== Rabbit-In-a-Hat testing framework ======
+**NOTICE FEB 2020:** the current documentation can be found on Github
+http://ohdsi.github.io/WhiteRabbit/riah_test_framework.html
 Rabbit-In-a-Hat can generate a framework for creating a set of [[https://en.wikipedia.org/wiki/Unit_testing|unit tests]]. The framework consists of a set of R functions tailored to the source and target schema in your ETL. These functions can then be used to define the unit tests.
@@ Line 75: / Line 79: @@
 After we have defined all our tests we need to run
 <code>
-insertSql <- generateInsertSql()
+insertSql <- generateInsertSql(databaseSchema = "nativeTestSchema")
+testSql <- generateTestSql(databaseSchema = "cdmTestSchema")
 </code>
-to generate the SQL for inserting the test data in the database. The SQL assumes that the data schema already exists, and will first remove any records that might be in the tables. We can execute the SQL in any SQL client, or we can use OHDSI's [[https://github.com/OHDSI/DatabaseConnector|DatabaseConnector package]]. For example:
+to generate the SQL for inserting the test data in the database (insertSql), and for running the tests on the ETL-ed data (testSql). The insertion SQL assumes that the data schema already exists in ''nativeTestSchema'', and will first remove any records that might be in the tables. We can execute the SQL in any SQL client, or we can use OHDSI's [[https://github.com/OHDSI/DatabaseConnector|DatabaseConnector package]]. For example:
 <code>
@@ Line 87: / Line 92: @@
 connection <- connect(connectionDetails)
-executeSql(connection, "USE source_schema")
 executeSql(connection, paste(insertSql, collapse = "\n"))
 </code>
@@ Line 93: / Line 97: @@
 ==== Run your ETL on the test data ====
-Now that the test source data is populated. You can run the ETL process you would like to test.
+Now that the test source data is populated. You can run the ETL process you would like to test. The ETL should transform the data in ''nativeTestSchema'' to CDM data in ''cdmTestSchema''.
 ==== Test whether the CDM data meets expectations ====
-Automatically a variable called ''%%testSql%%'' was created when we defined our tests. It contains SQL that will create a table called ''%%test_results%%'' in your CDM schema, and populate it with the results of the tests. (If the table already exists it will first be dropped). Again, we could use any SQL client to run this SQL, or we could use DatabaseConnector:
+The test SQL will create a table called ''%%test_results%%'' in ''cdmTestSchema'', and populate it with the results of the tests. (If the table already exists it will first be dropped). Again, we could use any SQL client to run this SQL, or we could use DatabaseConnector:
 <code>
-executeSql(connection, "USE cdm_schema")
 executeSql(connection, paste(testSql, collapse = "\n"))
 </code>