testutils/

README

YugabyteDB Test Kit

YugabyteDB for embedding in go tests. Depends on Docker.

Usage

Individual packages contain tests showing exact usage patterns for your own tests.

Example

Run three masters with three TServers inside of the test and query YSQL on one of the TServers:

package myprogram

import (
    "testing"
    "time"

    "github.com/hashicorp/go-hclog"
    "github.com/radekg/yugabyte-db-go-client/testutils/common"
    "github.com/radekg/yugabyte-db-go-client/testutils/master"
    "github.com/radekg/yugabyte-db-go-client/testutils/tserver"
    "github.com/radekg/yugabyte-db-go-client/client/implementation"
    "github.com/radekg/yugabyte-db-go-client/configs"

    // Postgres library:
    _ "github.com/lib/pq"
)

func TestClusterIntegration(t *testing.T) {

    masterTestCtx := master.SetupMasters(t, &common.TestMasterConfiguration{
        ReplicationFactor: 3,
        MasterPrefix:      "mytest",
    })
    defer masterTestCtx.Cleanup()

    client, err := implementation.MasterLeaderConnectedClient(&configs.CliConfig{
        MasterHostPort: masterTestCtx.MasterExternalAddresses(),
        OpTimeout:      time.Duration(time.Second * 5),
    }, hclog.Default())

    if err != nil {
        t.Fatal(err)
    }
    defer client.Close()

    common.Eventually(t, 15, func() error {
        listMastersPb, err := client.ListMasters()
        if err != nil {
            return err
        }
        t.Log(" ==> Received master list", listMastersPb)
        return nil
    })

    // start a TServer:
    tserver1Ctx := tserver.SetupTServer(t, masterTestCtx, &common.TestTServerConfiguration{
        TServerID: "my-tserver-1",
    })
    defer tserver1Ctx.Cleanup()

    // start a TServer:
    tserver2Ctx := tserver.SetupTServer(t, masterTestCtx, &common.TestTServerConfiguration{
        TServerID: "my-tserver-2",
    })
    defer tserver2Ctx.Cleanup()

    // start a TServer:
    tserver3Ctx := tserver.SetupTServer(t, masterTestCtx, &common.TestTServerConfiguration{
        TServerID: "my-tserver-3",
    })
    defer tserver3Ctx.Cleanup()

    common.Eventually(t, 15, func() error {
        listTServersPb, err := client.ListTabletServers(&configs.OpListTabletServersConfig{})
        if err != nil {
            return err
        }
        t.Log(" ==> Received TServer list", listTServersPb)
        return nil
    })

    // try YSQL connection:
    t.Logf("connecting to YSQL at 127.0.0.1:%s", tserver1Ctx.TServerExternalYSQLPort())
    db, sqlOpenErr := sql.Open("postgres", fmt.Sprintf("host=127.0.0.1 port=%s user=%s password=%s dbname=%s sslmode=disable",
        tserver1Ctx.TServerExternalYSQLPort(), "yugabyte", "yugabyte", "yugabyte"))
    if sqlOpenErr != nil {
        t.Fatal("failed connecting to YSQL, reason:", sqlOpenErr)
    }
    defer db.Close()
    t.Log("connected to YSQL")

    common.Eventually(t, 15, func() error {
        rows, sqlQueryErr := db.Query("select table_name from information_schema.tables")
        if sqlQueryErr != nil {
            return sqlQueryErr
        }
        nRows := 0
        for {
            if !rows.Next() {
                break
            }
            nRows = nRows + 1
        }
        t.Log("selected", nRows, " rows from YSQL")
        return nil
    })

}