Skip to content

Latest commit

 

History

History
71 lines (50 loc) · 1.78 KB

README.md

File metadata and controls

71 lines (50 loc) · 1.78 KB
Raw

Running the unit test

go test -v ./internal/provider/

Running the acceptance test

Note: Acceptance tests may create real resources, and often cost money to run.

Requirements

  • Go: The most recent stable version.
  • Terraform CLI: Version 0.12.26 or later.

Auth

You need to set API Key with environment before all the tests

export TIDBCLOUD_PUBLIC_KEY=${public_key}
export TIDBCLOUD_PRIVATE_KEY=${private_key}

Test With Project

The tests need project are put into the /internal/provide/testwithproject path.

some tests like cluster_resource_test may cause cost, make sure you have enough balance

Here are the steps to test them:

  1. create a new project for test in tidb cloud (You can also use the default project, but it is not recommended)

  2. set projectId with environment

export TIDBCLOUD_PROJECT_ID=${your_project_id}
  1. test
TF_ACC=1 go test -v ./internal/provider/testwithproject

Cost

Some tests may generate costs and will not be tested by default. To run them, you need to set the environment variable TIDBCLOUD_ENABLE_COST to true.

export TIDBCLOUD_ENABLE_COST=true

Test With Cluster

The tests need pre-created TiDB cluster are put into the /internal/provider/testwithcluster path

Here are the steps to test them:

  1. Create a dedicated cluster and wait for it is ready. You can create it with tidb cloud or terraform

  2. set projectId and clusterId with environment

export TIDBCLOUD_PROJECT_ID=${your_project_id}
export TIDBCLOUD_CLUSTER_ID=${your_cluster_id}
  1. test
TF_ACC=1 go test -v ./internal/provider/testwithcluster

Test Manually

The tests can't be tested directly are put into the /internal/provider/testmanually path

You need to test them manually following the code annotation in every test.