Skip to content

Commit 641cd53

Browse files
lackeyjblackeyjb
authored
Adds acceptance tests for datasources for HVN, Consul and Vault clusters (#135)
* Adds acceptance tests for data sources HVNs, Consul clusters, and Vault clusters * Move datasource tests to resource tests to decrease test time * Add comments to explain steps in acc tests with datasources added * Relocate comments
1 parent 20e2643 commit 641cd53

File tree

4 files changed

+173
-79
lines changed

4 files changed

+173
-79
lines changed

‎contributing/writing-tests.md

+72-65
Original file line numberDiff line numberDiff line change
@@ -110,56 +110,56 @@ When executing the test, the following steps are taken for each `TestStep`:
110110
`hcp_hvn` is required. This results in configuration which
111111
looks like this:
112112

113-
```hcl
114-
resource "hcp_hvn" "test" {
115-
hvn_id = "test-hvn"
116-
cloud_provider = "aws"
117-
region = "us-west-2"
118-
}
119-
120-
resource "hcp_consul_cluster" "test" {
121-
cluster_id = "test-consul-cluster"
122-
hvn_id = hcp_hvn.test.hvn_id
123-
tier = "development"
124-
}
125-
```
113+
```hcl
114+
resource "hcp_hvn" "test" {
115+
hvn_id = "test-hvn"
116+
cloud_provider = "aws"
117+
region = "us-west-2"
118+
}
119+
120+
resource "hcp_consul_cluster" "test" {
121+
cluster_id = "test-consul-cluster"
122+
hvn_id = hcp_hvn.test.hvn_id
123+
tier = "development"
124+
}
125+
```
126126

127127
1. Assertions are run using the provider API. These use the provider API
128128
directly rather than asserting against the resource state. For example, to
129129
verify that the `hcp_consul_cluster` described above was created
130130
successfully, a test function like this is used:
131131

132-
```go
133-
func testAccCheckConsulClusterExists(name string) resource.TestCheckFunc {
134-
return func(s *terraform.State) error {
135-
rs, ok := s.RootModule().Resources[name]
136-
if !ok {
137-
return fmt.Errorf("not found: %s", name)
138-
}
132+
```go
133+
func testAccCheckConsulClusterExists(name string) resource.TestCheckFunc {
134+
return func(s *terraform.State) error {
135+
rs, ok := s.RootModule().Resources[name]
136+
if !ok {
137+
return fmt.Errorf("not found: %s", name)
138+
}
139139

140-
id := rs.Primary.ID
141-
if id == "" {
142-
return fmt.Errorf("no ID is set")
143-
}
140+
id := rs.Primary.ID
141+
if id == "" {
142+
return fmt.Errorf("no ID is set")
143+
}
144144

145-
client := testAccProvider.Meta().(*clients.Client)
145+
client := testAccProvider.Meta().(*clients.Client)
146146

147-
link, err := buildLinkFromURL(id, ConsulClusterResourceType, client.Config.OrganizationID)
148-
if err != nil {
149-
return fmt.Errorf("unable to build link for %q: %v", id, err)
150-
}
147+
link, err := buildLinkFromURL(id, ConsulClusterResourceType, client.Config.OrganizationID)
148+
if err != nil {
149+
return fmt.Errorf("unable to build link for %q: %v", id, err)
150+
}
151151

152-
clusterID := link.ID
153-
loc := link.Location
152+
clusterID := link.ID
153+
loc := link.Location
154154

155-
if _, err := clients.GetConsulClusterByID(context.Background(), client, loc, clusterID); err != nil {
156-
return fmt.Errorf("unable to read Consul cluster %q: %v", id, err)
157-
}
155+
if _, err := clients.GetConsulClusterByID(context.Background(), client, loc, clusterID); err != nil {
156+
return fmt.Errorf("unable to read Consul cluster %q: %v", id, err)
157+
}
158158

159-
return nil
160-
}
161-
}
162-
```
159+
return nil
160+
}
161+
}
162+
```
163163

164164
Notice that the only information used from the Terraform state is the ID of
165165
the resource - though in this case it is necessary to split the ID into
@@ -168,9 +168,9 @@ When executing the test, the following steps are taken for each `TestStep`:
168168
expected value if possible. The testing framework provides helper functions
169169
for several common types of check - for example:
170170

171-
```go
172-
resource.TestCheckResourceAttr(resourceName, "cluster_id", "test-consul-cluster"),
173-
```
171+
```go
172+
resource.TestCheckResourceAttr(resourceName, "cluster_id", "test-consul-cluster"),
173+
```
174174

175175
1. The resources created by the test are destroyed. This step happens
176176
automatically, and is the equivalent of calling `terraform destroy`.
@@ -180,34 +180,41 @@ When executing the test, the following steps are taken for each `TestStep`:
180180
"dangling resources". The code to ensure that the `hcp_consul_cluster` shown
181181
above is removed looks like this:
182182

183-
```go
184-
func testAccCheckConsulClusterDestroy(s *terraform.State) error {
185-
client := testAccProvider.Meta().(*clients.Client)
183+
```go
184+
func testAccCheckConsulClusterDestroy(s *terraform.State) error {
185+
client := testAccProvider.Meta().(*clients.Client)
186186

187-
for _, rs := range s.RootModule().Resources {
188-
switch rs.Type {
189-
case "hcp_consul_cluster":
190-
id := rs.Primary.ID
187+
for _, rs := range s.RootModule().Resources {
188+
switch rs.Type {
189+
case "hcp_consul_cluster":
190+
id := rs.Primary.ID
191191

192-
link, err := buildLinkFromURL(id, ConsulClusterResourceType, client.Config.OrganizationID)
193-
if err != nil {
194-
return fmt.Errorf("unable to build link for %q: %v", id, err)
195-
}
192+
link, err := buildLinkFromURL(id, ConsulClusterResourceType, client.Config.OrganizationID)
193+
if err != nil {
194+
return fmt.Errorf("unable to build link for %q: %v", id, err)
195+
}
196196

197-
clusterID := link.ID
198-
loc := link.Location
197+
clusterID := link.ID
198+
loc := link.Location
199199

200-
_, err = clients.GetConsulClusterByID(context.Background(), client, loc, clusterID)
201-
if err == nil || !clients.IsResponseCodeNotFound(err) {
202-
return fmt.Errorf("didn't get a 404 when reading destroyed Consul cluster %q: %v", id, err)
203-
}
200+
_, err = clients.GetConsulClusterByID(context.Background(), client, loc, clusterID)
201+
if err == nil || !clients.IsResponseCodeNotFound(err) {
202+
return fmt.Errorf("didn't get a 404 when reading destroyed Consul cluster %q: %v", id, err)
203+
}
204204

205-
default:
206-
continue
207-
}
208-
}
209-
return nil
210-
}
211-
```
205+
default:
206+
continue
207+
}
208+
}
209+
return nil
210+
}
211+
```
212212

213213
These functions usually test only for the resource directly under test.
214+
215+
## Test Time and Consolidation
216+
217+
Because of the increased length of time it takes to run acceptance tests, efforts
218+
should be made to not create multiples of the same resource for testing purposes. For
219+
example, datasource tests have been consolidated into their corresponding resource
220+
tests so that resources may be reused.

‎internal/provider/resource_consul_cluster_test.go

+42-5
Original file line numberDiff line numberDiff line change
@@ -10,29 +10,36 @@ import (
1010
"github.com/hashicorp/terraform-provider-hcp/internal/clients"
1111
)
1212

13-
var (
14-
testAccConsulClusterConfig = fmt.Sprintf(`
13+
var testAccConsulClusterConfig = `
1514
resource "hcp_hvn" "test" {
1615
hvn_id = "test-hvn"
1716
cloud_provider = "aws"
1817
region = "us-west-2"
1918
}
20-
19+
2120
resource "hcp_consul_cluster" "test" {
2221
cluster_id = "test-consul-cluster"
2322
hvn_id = hcp_hvn.test.hvn_id
2423
tier = "development"
25-
}`)
26-
)
24+
}
25+
26+
data "hcp_consul_cluster" "test" {
27+
cluster_id = hcp_consul_cluster.test.cluster_id
28+
}
29+
`
2730

31+
// This includes tests against both the resource and the corresponding datasource
32+
// to shorten testing time.
2833
func TestAccConsulCluster(t *testing.T) {
2934
resourceName := "hcp_consul_cluster.test"
35+
dataSourceName := "data.hcp_consul_cluster.test"
3036

3137
resource.Test(t, resource.TestCase{
3238
PreCheck: func() { testAccPreCheck(t, false) },
3339
ProviderFactories: providerFactories,
3440
CheckDestroy: testAccCheckConsulClusterDestroy,
3541
Steps: []resource.TestStep{
42+
// Tests create
3643
{
3744
Config: testConfig(testAccConsulClusterConfig),
3845
Check: resource.ComposeTestCheckFunc(
@@ -62,6 +69,7 @@ func TestAccConsulCluster(t *testing.T) {
6269
resource.TestCheckResourceAttrSet(resourceName, "size"),
6370
),
6471
},
72+
// Tests import
6573
{
6674
ResourceName: resourceName,
6775
ImportState: true,
@@ -76,6 +84,7 @@ func TestAccConsulCluster(t *testing.T) {
7684
ImportStateVerify: true,
7785
ImportStateVerifyIgnore: []string{"consul_root_token_accessor_id", "consul_root_token_secret_id"},
7886
},
87+
// Tests read
7988
{
8089
Config: testConfig(testAccConsulClusterConfig),
8190
Check: resource.ComposeTestCheckFunc(
@@ -105,6 +114,34 @@ func TestAccConsulCluster(t *testing.T) {
105114
resource.TestCheckResourceAttrSet(resourceName, "size"),
106115
),
107116
},
117+
// Tests datasource
118+
{
119+
Config: testConfig(testAccConsulClusterConfig),
120+
Check: resource.ComposeTestCheckFunc(
121+
resource.TestCheckResourceAttrPair(resourceName, "cluster_id", dataSourceName, "cluster_id"),
122+
resource.TestCheckResourceAttrPair(resourceName, "project_id", dataSourceName, "project_id"),
123+
resource.TestCheckResourceAttrPair(resourceName, "organization_id", dataSourceName, "organization_id"),
124+
resource.TestCheckResourceAttrPair(resourceName, "hvn_id", dataSourceName, "hvn_id"),
125+
resource.TestCheckResourceAttrPair(resourceName, "cloud_provider", dataSourceName, "cloud_provider"),
126+
resource.TestCheckResourceAttrPair(resourceName, "region", dataSourceName, "region"),
127+
resource.TestCheckResourceAttrPair(resourceName, "public_endpoint", dataSourceName, "public_endpoint"),
128+
resource.TestCheckResourceAttrPair(resourceName, "datacenter", dataSourceName, "datacenter"),
129+
resource.TestCheckResourceAttrPair(resourceName, "connect_enabled", dataSourceName, "connect_enabled"),
130+
resource.TestCheckResourceAttrPair(resourceName, "consul_automatic_upgrades", dataSourceName, "consul_automatic_upgrades"),
131+
resource.TestCheckResourceAttrPair(resourceName, "consul_snapshot_interval", dataSourceName, "consul_snapshot_interval"),
132+
resource.TestCheckResourceAttrPair(resourceName, "consul_snapshot_retention", dataSourceName, "consul_snapshot_retention"),
133+
resource.TestCheckResourceAttrPair(resourceName, "consul_config_file", dataSourceName, "consul_config_file"),
134+
resource.TestCheckResourceAttrPair(resourceName, "consul_ca_file", dataSourceName, "consul_ca_file"),
135+
resource.TestCheckResourceAttrPair(resourceName, "consul_version", dataSourceName, "consul_version"),
136+
resource.TestCheckResourceAttrPair(resourceName, "consul_public_endpoint_url", dataSourceName, "consul_public_endpoint_url"),
137+
resource.TestCheckResourceAttrPair(resourceName, "consul_private_endpoint_url", dataSourceName, "consul_private_endpoint_url"),
138+
resource.TestCheckResourceAttrPair(resourceName, "scale", dataSourceName, "scale"),
139+
resource.TestCheckResourceAttrPair(resourceName, "tier", dataSourceName, "tier"),
140+
resource.TestCheckResourceAttrPair(resourceName, "size", dataSourceName, "size"),
141+
resource.TestCheckResourceAttrPair(resourceName, "self_link", dataSourceName, "self_link"),
142+
resource.TestCheckResourceAttrPair(resourceName, "primary_link", dataSourceName, "primary_link"),
143+
),
144+
},
108145
},
109146
})
110147
}

‎internal/provider/resource_hvn_test.go

+28-4
Original file line numberDiff line numberDiff line change
@@ -12,23 +12,30 @@ import (
1212
"github.com/hashicorp/terraform-provider-hcp/internal/clients"
1313
)
1414

15-
var (
16-
testAccHvnConfig = fmt.Sprintf(`
15+
var testAccHvnConfig = `
1716
resource "hcp_hvn" "test" {
1817
hvn_id = "test-hvn"
1918
cloud_provider = "aws"
2019
region = "us-west-2"
21-
}`)
22-
)
20+
}
2321
22+
data "hcp_hvn" "test" {
23+
hvn_id = hcp_hvn.test.hvn_id
24+
}
25+
`
26+
27+
// This includes tests against both the resource and the corresponding datasource
28+
// to shorten testing time.
2429
func TestAccHvn(t *testing.T) {
2530
resourceName := "hcp_hvn.test"
31+
dataSourceName := "data.hcp_hvn.test"
2632

2733
resource.Test(t, resource.TestCase{
2834
PreCheck: func() { testAccPreCheck(t, false) },
2935
ProviderFactories: providerFactories,
3036
CheckDestroy: testAccCheckHvnDestroy,
3137
Steps: []resource.TestStep{
38+
// Tests create
3239
{
3340
Config: testConfig(testAccHvnConfig),
3441
Check: resource.ComposeTestCheckFunc(
@@ -44,6 +51,7 @@ func TestAccHvn(t *testing.T) {
4451
testLink(resourceName, "self_link", "test-hvn", HvnResourceType, resourceName),
4552
),
4653
},
54+
// Tests import
4755
{
4856
ResourceName: resourceName,
4957
ImportState: true,
@@ -57,6 +65,7 @@ func TestAccHvn(t *testing.T) {
5765
},
5866
ImportStateVerify: true,
5967
},
68+
// Tests read
6069
{
6170
Config: testConfig(testAccHvnConfig),
6271
Check: resource.ComposeTestCheckFunc(
@@ -72,6 +81,21 @@ func TestAccHvn(t *testing.T) {
7281
testLink(resourceName, "self_link", "test-hvn", HvnResourceType, resourceName),
7382
),
7483
},
84+
// Tests datasource
85+
{
86+
Config: testConfig(testAccHvnConfig),
87+
Check: resource.ComposeTestCheckFunc(
88+
resource.TestCheckResourceAttrPair(resourceName, "hvn_id", dataSourceName, "hvn_id"),
89+
resource.TestCheckResourceAttrPair(resourceName, "cloud_provider", dataSourceName, "cloud_provider"),
90+
resource.TestCheckResourceAttrPair(resourceName, "region", dataSourceName, "region"),
91+
resource.TestCheckResourceAttrPair(resourceName, "cidr_block", dataSourceName, "cidr_block"),
92+
resource.TestCheckResourceAttrPair(resourceName, "organization_id", dataSourceName, "organization_id"),
93+
resource.TestCheckResourceAttrPair(resourceName, "project_id", dataSourceName, "project_id"),
94+
resource.TestCheckResourceAttrPair(resourceName, "provider_account_id", dataSourceName, "provider_account_id"),
95+
resource.TestCheckResourceAttrPair(resourceName, "created_at", dataSourceName, "created_at"),
96+
resource.TestCheckResourceAttrPair(resourceName, "self_link", dataSourceName, "self_link"),
97+
),
98+
},
7599
},
76100
})
77101
}

0 commit comments

Comments
 (0)