Awesome

Datastore Testibility (dsunit)

This library is compatible with Go 1.10+

Please refer to CHANGELOG.md if you encounter breaking changes.

• Introduction
• Motivation
• API Documentaion
• Examples
• License
• Credits and Acknowledgements

<a name="Introduction"></a>

Introduction

Data focused testing belongs to blackbox group, where the main interest goes down to the initial and final state of the datastore.

To set the initial state of ta datastore, this framework provies utilities to either create empty datastore, or to prepare it with dataset data to test that application works correctly.

The final state testing focuses on checking that a dataset data matches an expected set of values after application logic run. In this case this library has ability to verify either complete or snapshot state of a datastore. While the first approach will be comparing all tables data with expected set of values, the latter will reduced verification to the range provided by expected dataset.

<a name="Motivation"></a>

Motivation

This library has been design to provide easy and unified way of testing any datastore (SQL, NoSSQL,file logs) on any platform, language and on the cloud. It simplifies test organization by dataset auto discovery used for datastore preparation and verification. Dataset data can be loaded from various sources like: memory, local or remote csv, json files. All dataset support macro expression to dynamically evaluate value of data i.e <ds:sql ["SELECT CURRENT_DATE()"]> On top of that expected data, can also use predicate expressions to delegate verification of the data values i.e. <ds:between [11301, 11303]>. Finally a dataset like a view can be used to store data for many datastore sources in in just one dataset file.

Datastore initialization and dataset data verification can by managed locally or remotely on remote data store unit test server.

<a name="Usage"></a>

Usage

Data setup and verification

1. With dedicated expected data folder

   
   import (
       "testing"
       "github.com/viant/dsunit"
       _ "github.com/go-sql-driver/mysql"
   )
   
   
   func Test_Usecase(t *testing.T) {
       parent := toolbox.CallerDirectory(3)
       if !dsunit.InitFromURL(t, path.Join(parent, "test", "config.yaml")) {
           return
       }
       
           ... business test logic comes here
   
       
       expectURL := path.Join(parent, "test/case1/data/expect")
       expectedData := dsunit.NewDatasetResource("db1", expectURL , "", "")
       dsunit.Expect(t, dsunit.NewExpectRequest(dsunit.FullTableDatasetCheckPolicy, expectedData))
   
   }
   

2. With shared expected data folder

   func Test_Usecase(t *testing.T) {
       parent := toolbox.CallerDirectory(3)
       if !dsunit.InitFromURL(t, path.Join(parent, "test", "config.yaml")) {
           return
       }
       
       
       ... business test logic comes here
   
   
       baseDir := path.Join(parent, "test", "data")
       dsunit.ExpectFor(t, "db1", dsunit.FullTableDatasetCheckPolicy, baseDir, "use_case_1")
   }
   

Forcing table truncation before loading data

@table_x.json

[ {},
    {"id":1,"name":"name 1"},
    {"id":2,"name":"name 2"}
]

When pre-seeding table with data, if the first element is empty map, dsunit deletes all record from a table before inserting supplied dataset.

@table_x.json

[]

Empty array will with prepare method removes all record from a table.

Reverse engineer data setup and verification

	registerResponse := service.Register(dsunit.NewRegisterRequest("db1",
			&dsc.Config{
				DriverName: "sqlite3",
				Descriptor: "[url]",
				Parameters: map[string]interface{}{
					"url": filename,
				},
			}))
	if registerResponse.Stats != "ok" {
		log.Fatal(registerResponse.Error)
	}
    
	response := service.Freeze(&dsunit.FreezeRequest{
			Datastore:"db1",
			DestURL:"/tmp/dn1/expect/users.json",
			SQL:"SELECT * FROM users",
    })
	

Tester methods

Validation

This library uses assertly as the underlying validation mechanism

Macros

The macro is an expression with parameters that expands original text value. The general format of macro: <ds:MACRO_NAME [json formated array of parameters]>

The following macro are build-in:

Predicates

Predicate allows expected value to be evaluated with actual dataset value using custom predicate logic.

Directives

Data preparation

Most SQL drivers provide meta data about autoincrement, primary key, however if this is not available or partial verification with SQL is used, the following directive come handy.

@autoincrement@

Allows specifying autoincrement field

[
  {"@autoincrement@":"id"},
  {"id":1, "username":"Dudi", "active":true, "salary":12400, "comments":"abc","last_access_time": "2016-03-01 03:10:00"},
  {"id":2, "username":"Rudi", "active":true, "salary":12600, "comments":"def","last_access_time": "2016-03-01 05:10:00"}
]

@indexBy@

(see also asserly indexBy directive usage, for nested data structe validation)

Allows specifying pk fields

[
  {"@indexBy@":["id"]},
  {"id":1, "username":"Dudi", "active":true, "salary":12400, "comments":"abc","last_access_time": "2016-03-01 03:10:00"},
  {"id":2, "username":"Rudi", "active":true, "salary":12600, "comments":"def","last_access_time": "2016-03-01 05:10:00"}
]

Data validation.

@fromQuery@

Allows specified query to fetch actual dataset to be validated against expected dataset

users.json

[
  {"@fromQuery@":"SELECT *  FROM users where id <= 2 ORDER BY id"},
  {"id":1, "username":"Dudi", "active":true, "salary":12400, "comments":"abc","last_access_time": "2016-03-01 03:10:00"},
  {"id":2, "username":"Rudi", "active":true, "salary":12600, "comments":"def","last_access_time": "2016-03-01 05:10:00"}
]

<a name="API-Documentation"></a>

API Documentation

API documentation is available in the docs directory.

GoCover

<a name="examples"></a>

Examples

This project provide a various datasore dsunit integration examples (some with docker vi endly).

RDBMS

• Big Query
• MySQL
• Oracle
• Postgres

NoSQL

• Aerospike
• MongoDB
• Casandra
• Firebase
• DynamoDB

External projects::

• Simple CRUD app with dsunit

<a name="License"></a>

License

The source code is made available under the terms of the Apache License, Version 2, as stated in the file LICENSE.

Individual files may be made available under their own specific license, all compatible with Apache License, Version 2. Please see individual files for details.

<a name="Credits-and-Acknowledgements"></a>

Credits and Acknowledgements

Library Author: Adrian Witas

Contributors: Sudhakaran Dharmaraj