Skip to content

Commit

Permalink
Align tftest syntax with tdoc
Browse files Browse the repository at this point in the history
This commit changes the token separator for inline examples from a
semicolon to a space
  • Loading branch information
juliocc committed Jan 28, 2022
1 parent b11367e commit cf42399
Show file tree
Hide file tree
Showing 45 changed files with 140 additions and 140 deletions.
2 changes: 1 addition & 1 deletion examples/factories/net-vpc-firewall-yaml/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ module "dev-firewall" {
"./common"
]
}
# tftest:skip
# tftest skip
```

### Configuration Structure
Expand Down
6 changes: 3 additions & 3 deletions modules/apigee-organization/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ module "apigee-organization" {
}
}
}
# tftest:modules=1:resources=6
# tftest modules=1 resources=6
```

### Apigee X Paid Organization
Expand Down Expand Up @@ -69,7 +69,7 @@ module "apigee-organization" {
}
}
}
# tftest:modules=1:resources=11
# tftest modules=1 resources=11
```

### Apigee hybrid Organization
Expand All @@ -96,7 +96,7 @@ module "apigee-organization" {
}
}
}
# tftest:modules=1:resources=6
# tftest modules=1 resources=6
```
<!-- BEGIN TFDOC -->

Expand Down
4 changes: 2 additions & 2 deletions modules/apigee-x-instance/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ module "apigee-x-instance" {
"eval2"
]
}
# tftest:modules=1:resources=3
# tftest modules=1 resources=3
```

### Apigee X Paid Instance
Expand All @@ -40,7 +40,7 @@ module "apigee-x-instance" {
"test2"
]
}
# tftest:modules=1:resources=5
# tftest modules=1 resources=5
```
<!-- BEGIN TFDOC -->

Expand Down
2 changes: 1 addition & 1 deletion modules/artifact-registry/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ module "docker_artifact_registry" {
"roles/artifactregistry.admin" = ["group:[email protected]"]
}
}
# tftest:modules=1:resources=2
# tftest modules=1 resources=2
```
<!-- BEGIN TFDOC -->

Expand Down
12 changes: 6 additions & 6 deletions modules/bigquery-dataset/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ module "bigquery-dataset" {
view_1 = "my-project|my-dataset|my-table"
}
}
# tftest:modules=1:resources=5
# tftest modules=1 resources=5
```

### IAM roles
Expand All @@ -51,7 +51,7 @@ module "bigquery-dataset" {
"roles/bigquery.dataOwner" = ["user:[email protected]"]
}
}
# tftest:modules=1:resources=2
# tftest modules=1 resources=2
```

roles/bigquery.dataOwner
Expand All @@ -71,7 +71,7 @@ module "bigquery-dataset" {
delete_contents_on_destroy = false
}
}
# tftest:modules=1:resources=1
# tftest modules=1 resources=1
```

### Tables and views
Expand Down Expand Up @@ -101,7 +101,7 @@ module "bigquery-dataset" {
}
}
}
# tftest:modules=1:resources=2
# tftest modules=1 resources=2
```

If partitioning is needed, populate the `partitioning` variable using either the `time` or `range` attribute.
Expand Down Expand Up @@ -133,7 +133,7 @@ module "bigquery-dataset" {
}
}
}
# tftest:modules=1:resources=2
# tftest modules=1 resources=2
```

To create views use the `view` variable. If you're querying a table created by the same module `terraform apply` will initially fail and eventually succeed once the underlying table has been created. You can probably also use the module's output in the view's query to create a dependency on the table.
Expand Down Expand Up @@ -171,7 +171,7 @@ module "bigquery-dataset" {
}
}
# tftest:modules=1:resources=3
# tftest modules=1 resources=3
```
<!-- BEGIN TFDOC -->

Expand Down
2 changes: 1 addition & 1 deletion modules/bigtable-instance/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ module "bigtable-instance" {
"roles/bigtable.user" = ["user:[email protected]"]
}
}
# tftest:modules=1:resources=4
# tftest modules=1 resources=4
```
<!-- BEGIN TFDOC -->

Expand Down
4 changes: 2 additions & 2 deletions modules/billing-budget/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ module "budget" {
emails = ["[email protected]"]
}
}
# tftest:modules=1:resources=2
# tftest modules=1 resources=2
```

### Pubsub notification
Expand All @@ -59,7 +59,7 @@ module "pubsub" {
name = "budget-topic"
}
# tftest:modules=2:resources=2
# tftest modules=2 resources=2
```
<!-- BEGIN TFDOC -->

Expand Down
14 changes: 7 additions & 7 deletions modules/cloud-function/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ module "cf-http" {
excludes = null
}
}
# tftest:skip
# tftest skip
```

### PubSub and non-HTTP triggers
Expand All @@ -50,7 +50,7 @@ module "cf-http" {
retry = null
}
}
# tftest:skip
# tftest skip
```

### Controlling HTTP access
Expand All @@ -72,7 +72,7 @@ module "cf-http" {
"roles/cloudfunctions.invoker" = ["allUsers"]
}
}
# tftest:skip
# tftest skip
```

### GCS bucket creation
Expand All @@ -95,7 +95,7 @@ module "cf-http" {
excludes = null
}
}
# tftest:skip
# tftest skip
```

### Service account management
Expand All @@ -115,7 +115,7 @@ module "cf-http" {
}
service_account_create = true
}
# tftest:skip
# tftest skip
```

To use an externally managed service account, pass its email in `service_account` and leave `service_account_create` to `false` (the default).
Expand All @@ -133,7 +133,7 @@ module "cf-http" {
}
service_account = local.service_account_email
}
# tftest:skip
# tftest skip
```

### Custom bundle config
Expand All @@ -152,7 +152,7 @@ module "cf-http" {
excludes = ["__pycache__"]
}
}
# tftest:skip
# tftest skip
```
<!-- BEGIN TFDOC -->

Expand Down
2 changes: 1 addition & 1 deletion modules/cloud-identity-group/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ module "group" {
"[email protected]"
]
}
# tftest:modules=1:resources=4
# tftest modules=1 resources=4
```
<!-- BEGIN TFDOC -->

Expand Down
16 changes: 8 additions & 8 deletions modules/cloud-run/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ module "cloud_run" {
volume_mounts = null
}]
}
# tftest:modules=1:resources=1
# tftest modules=1 resources=1
```

### Environment variables (value read from secret)
Expand Down Expand Up @@ -57,7 +57,7 @@ module "cloud_run" {
volume_mounts = null
}]
}
# tftest:modules=1:resources=1
# tftest modules=1 resources=1
```

### Secret mounted as volume
Expand Down Expand Up @@ -89,7 +89,7 @@ module "cloud_run" {
}
]
}
# tftest:modules=1:resources=1
# tftest modules=1 resources=1
```

### Traffic split
Expand All @@ -114,7 +114,7 @@ module "cloud_run" {
"green" = 75
}
}
# tftest:modules=1:resources=1
# tftest modules=1 resources=1
```

### Eventarc trigger (Pub/Sub)
Expand All @@ -138,7 +138,7 @@ module "cloud_run" {
"topic2"
]
}
# tftest:modules=1:resources=3
# tftest modules=1 resources=3
```

### Eventarc trigger (Audit logs)
Expand All @@ -164,7 +164,7 @@ module "cloud_run" {
}
]
}
# tftest:modules=1:resources=2
# tftest modules=1 resources=2
```

### Service account management
Expand All @@ -185,7 +185,7 @@ module "cloud_run" {
}]
service_account_create = true
}
# tftest:modules=1:resources=2
# tftest modules=1 resources=2
```

To use an externally managed service account, pass its email in `service_account` and leave `service_account_create` to `false` (the default).
Expand All @@ -204,7 +204,7 @@ module "cloud_run" {
}]
service_account = "[email protected]"
}
# tftest:modules=1:resources=1
# tftest modules=1 resources=1
```
<!-- BEGIN TFDOC -->

Expand Down
6 changes: 3 additions & 3 deletions modules/cloudsql-instance/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ module "db" {
database_version = "POSTGRES_13"
tier = "db-g1-small"
}
# tftest:modules=3:resources=6
# tftest modules=3 resources=6
```

## Cross-regional read replica
Expand All @@ -57,7 +57,7 @@ module "db" {
replica2 = "us-central1"
}
}
# tftest:modules=1:resources=3
# tftest modules=1 resources=3
```

## Custom flags, databases and users
Expand Down Expand Up @@ -88,7 +88,7 @@ module "db" {
user2 = "mypassword"
}
}
# tftest:modules=1:resources=6
# tftest modules=1 resources=6
```
<!-- BEGIN TFDOC -->

Expand Down
14 changes: 7 additions & 7 deletions modules/compute-mig/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ module "nginx-mig" {
name = "default"
}
}
# tftest:modules=2:resources=2
# tftest modules=2 resources=2
```

### Multiple versions
Expand Down Expand Up @@ -102,7 +102,7 @@ module "nginx-mig" {
}
}
}
# tftest:modules=2:resources=2
# tftest modules=2 resources=2
```

### Health check and autohealing policies
Expand Down Expand Up @@ -158,7 +158,7 @@ module "nginx-mig" {
logging = true
}
}
# tftest:modules=2:resources=3
# tftest modules=2 resources=3
```

### Autoscaling
Expand Down Expand Up @@ -212,7 +212,7 @@ module "nginx-mig" {
metric = null
}
}
# tftest:modules=2:resources=3
# tftest modules=2 resources=3
```

### Update policy
Expand Down Expand Up @@ -265,7 +265,7 @@ module "nginx-mig" {
max_unavailable = null
}
}
# tftest:modules=2:resources=2
# tftest modules=2 resources=2
```

### Stateful MIGs - MIG Config
Expand Down Expand Up @@ -347,7 +347,7 @@ module "nginx-mig" {
}
}
}
# tftest:modules=2:resources=3
# tftest modules=2 resources=3
```

Expand Down Expand Up @@ -440,7 +440,7 @@ module "nginx-mig" {
}
}
}
# tftest:modules=2:resources=4
# tftest modules=2 resources=4
```
<!-- BEGIN TFDOC -->
Expand Down
Loading

0 comments on commit cf42399

Please sign in to comment.