sql

README

Venom - Executor SQL

Step to execute SQL queries into databases:

• MySQL
• PostgreSQL
• Oracle
• Sqlite

It use the package sqlx under the hood: https://github.com/jmoiron/sqlx to retrieve rows as a list of map[string]interface{}

Input

In your yaml file, you declare your step like this

  - driver mandatory [mysql/postgres/oracle/sqlite]
  - dsn mandatory
  - commands optional
  - file optional

• commands is a list of SQL queries.
• file parameter is only used as a fallback if commands is not used.

Example usage (mysql, oracle, SQLServer):

name: Title of TestSuite
testcases:

  - name: Query database
    steps:
      - type: sql
        driver: mysql
        dsn: user:password@(localhost:3306)/venom
        commands:
          - "SELECT * FROM employee;"
          - "SELECT * FROM person;"
        assertions:
          - result.queries.__Len__ ShouldEqual 2
          - result.queries.queries0.rows.rows0.name ShouldEqual Jack
          - result.queries.queries1.rows.rows0.age ShouldEqual 21

  - name: Oracle
    steps:
      - type: sql
        driver: oracle
        dsn: "oracle://system:oracle@localhost:49161/XE"
        commands:
          - select * from v$version

Example with a query file:

name: Title of TestSuite
testcases:

  - name: Query database
    steps:
      - type: sql
        database: mysql
        dsn: user:password@(localhost:3306)/venom
        file: ./test.sql
        assertions:
          - result.queries ShouldHaveLength 1

*note: in the example above, the results of each command is stored in the results array

SQL drivers

This executor uses the following SQL drivers:

• MySQL: https://github.com/go-sql-driver/mysql
• PostgreSQL: https://github.com/lib/pq
• Oracle: https://github.com/sijms/go-ora
• Sqlite: https://pkg.go.dev/modernc.org/sqlite

Documentation

Index

• Constants
• func New() venom.Executor
• type Executor
  • func (e Executor) GetDefaultAssertions() venom.StepAssertions
  • func (e Executor) Run(ctx context.Context, step venom.TestStep) (interface{}, error)
  • func (Executor) ZeroValueResult() interface{}
• type QueryResult
• type Result
• type Row
• type Rows

Constants

const Name = "sql"

Name of the executor.

Functions

func New

func New() venom.Executor

New returns a new executor that can execute SQL queries

Types

type Executor

type Executor struct {
	File     string   `json:"file,omitempty" yaml:"file,omitempty"`
	Commands []string `json:"commands,omitempty" yaml:"commands,omitempty"`
	Driver   string   `json:"driver" yaml:"driver"`
	DSN      string   `json:"dsn" yaml:"dsn"`
}

Executor is a venom executor can execute SQL queries

func (Executor) GetDefaultAssertions

func (e Executor) GetDefaultAssertions() venom.StepAssertions

GetDefaultAssertions return the default assertions of the executor.

func (Executor) Run

func (e Executor) Run(ctx context.Context, step venom.TestStep) (interface{}, error)

Run implements the venom.Executor interface for Executor.

func (Executor) ZeroValueResult

func (Executor) ZeroValueResult() interface{}

ZeroValueResult return an empty implementation of this executor result

type QueryResult

type QueryResult struct {
	Rows Rows `json:"rows,omitempty" yaml:"rows,omitempty"`
}

QueryResult represents a rows return by a SQL query execution.

type Result

type Result struct {
	Queries []QueryResult `json:"queries,omitempty" yaml:"queries,omitempty"`
}

Result represents a step result.

type Row

type Row map[string]interface{}

Row represents a row return by a SQL query.

type Rows

type Rows []Row

Rows represents an array of Row