README
¶
Mock BigQuery Emulator
Provide a mock BigQuery Emulator instance and optionally a mock BigQuery client for testing purposes. This library is built so you can mock BigQuery using the bigquery-emulator project. You will need to have Docker running on your local machine or within your CI environment.
This library is built on top of testcontainers.
Usage
Creating a mock instance for creating a customer connection.
func TestXXX(t *testing.T) {
ctx := context.Background()
const projectID = "test-project"
const datasetID = "test-dataset"
mock, err := mockbigquery.NewInstance(ctx, t, projectID, datasetID)
if err != nil {
t.Fatalf("creating the instance: %v", err)
return
}
// close the mock
defer mock.Close(ctx)
// ... my test code
}
Creating a mock redis client for interacting with Redis.
func TestXXX(t *testing.T) {
ctx := context.Background()
const projectID = "test-project"
const datasetID = "test-dataset"
mock, err := mockbigquery.NewClient(ctx, t, projectID, datasetID)
if err != nil {
t.Fatalf("creating the client: %v", err)
return
}
// close the mock
defer mock.Close(ctx)
bqClient := mock.Client()
// ... my test code
}
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client wraps the Redis client and the underlying instance for testing. It provides helper methods for accessing the client, closing the client, and closing the instance.
func NewClient ¶
func NewClient(ctx context.Context, t *testing.T, projectID string, datasetID string) (*Client, error)
NewClient creates a new BigQuery client that connects to an underlying emulator instance for testing.
type Instance ¶
type Instance struct {
// contains filtered or unexported fields
}
Instance represents the underlying container that is running the mock redis instance.
func NewInstance ¶
func NewInstance(ctx context.Context, t *testing.T, project string, dataset string) (*Instance, error)
NewInstance creates a new BigQuery Emulator container. It will exponentially backoff until the container is ready to accept connections so that you can handle throttling within CI environments
Source Files