https://github.com/stephenafamo/fakedb

fakedb registers a fake database driver named test for... testing.
https://github.com/stephenafamo/fakedb

database fake faker go golang sql test testing testing-tools

Last synced: about 1 month ago
JSON representation

fakedb registers a fake database driver named test for... testing.

• Host: GitHub
• URL: https://github.com/stephenafamo/fakedb
• Owner: stephenafamo
• License: mit
• Created: 2022-08-05T12:03:59.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-12-30T08:20:02.000Z (almost 2 years ago)
• Last Synced: 2024-06-21T17:58:29.217Z (5 months ago)
• Topics: database, fake, faker, go, golang, sql, test, testing, testing-tools
• Language: Go
• Homepage:
• Size: 22.5 KB
• Stars: 6
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# FakeDB

This is copied from 

It registers a fake database driver named `test`, just for testing.

It speaks a query language that's semantically similar to but

syntactically different and simpler than SQL.

## Query Methods

The query syntax is as follows

        WIPE

        CREATE||=,=,...

        INSERT||col=val,col2=val2,col3=?

        SELECT||projectcol1,projectcol2|filtercol=?,filtercol2=?

        SELECT||projectcol1,projectcol2|filtercol=?param1,filtercol2=?param2

* WIPE: Wipes all data in the database, including table information

        WIPE

* CREATE: Creates a new table

        CREATE|tableName|columnName1=columnType1,columnName2=columnType2

* DROP: Drops a table

        DROP|tableName

* INSERT: Inserts a row into a table

        INSERT|tableName|column1=?,column2=?

* SELECT: Queries the table. If the column list is empty, all columns are selected.

        SELECT|tableName|column1,column2|where=?,where2=?named

Any of these can be preceded by `PANIC||`, to cause the

named method on fakeStmt to panic.

Any of these can be proceeded by `WAIT||`, to cause the

named method on fakeStmt to sleep for the specified duration.

Multiple of these can be combined when separated with a semicolon.

When opening a fakeDriver's database, it starts empty with no

tables. All tables and data are stored in memory only.

## Placeholders

In any query, `?` is used to denote a positional placeholder, and `?name` for a named placeholder

## Allowed types

* bool

* string

* byte

* int16

* int32

* in64

* float64

* datetime

* any

> **NOTE:** Every type can be nullable using nulltype. E.g nullstring for a nullable string

## Usage

As seen on [fakedb_test.go](fakedb_test.go)

```go

package fakedb_test

import (

    "context"

    "database/sql"

    "testing"

    _ "github.com/stephenafamo/fakedb"

)

func TestQuery(t *testing.T) {

    ctx := context.Background()

    db, err := sql.Open("test", "identifier")

    if err != nil {

        t.Fatalf("Error opening testdb %v", err)

    }

    exec(t, db, "CREATE|users|id=int64,name=string")

    exec(t, db, "INSERT|users|id=?,name=?", 1, "foo")

    exec(t, db, "INSERT|users|id=?,name=?", 2, "bar")

    rows, err := db.QueryContext(ctx, "SELECT|users|id,name|")

    if err != nil {

        t.Fatal(err)

    }

    users := []string{"foo", "bar"}

    for rows.Next() {

        var id int

        var name string

        rows.Scan(&id, &name)

        expectedName := users[id-1]

        if name != users[id-1] {

            t.Fatalf("User %d should have name %q but had %q", id, expectedName, name)

        }

    }

}

func exec(tb testing.TB, exec *sql.DB, query string, args ...interface{}) sql.Result {

    tb.Helper()

    result, err := exec.ExecContext(context.Background(), query, args...)

    if err != nil {

        tb.Fatalf("Exec of %q: %v", query, err)

    }

    return result

}

```