Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

provider: Use real Terraform version in UA header #437

Merged
merged 1 commit into from
Aug 24, 2019
Merged

provider: Use real Terraform version in UA header #437

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 28 additions & 21 deletions cloudflare/provider.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ import (
"fmt"
"log"
"os"
"strings"

"github.com/cloudflare/cloudflare-go"
"github.com/hashicorp/go-cleanhttp"
Expand All @@ -17,72 +16,72 @@ import (

// Provider returns a terraform.ResourceProvider.
func Provider() terraform.ResourceProvider {
return &schema.Provider{
provider := &schema.Provider{
Schema: map[string]*schema.Schema{
"email": &schema.Schema{
"email": {
Type: schema.TypeString,
Optional: true,
DefaultFunc: schema.EnvDefaultFunc("CLOUDFLARE_EMAIL", nil),
Description: "A registered Cloudflare email address.",
},

"token": &schema.Schema{
"token": {
Type: schema.TypeString,
Optional: true,
DefaultFunc: schema.EnvDefaultFunc("CLOUDFLARE_TOKEN", nil),
Description: "The API key for operations.",
},

"api_token": &schema.Schema{
"api_token": {
Type: schema.TypeString,
Optional: true,
DefaultFunc: schema.EnvDefaultFunc("CLOUDFLARE_API_TOKEN", nil),
Description: "The API Token for operations.",
},

"rps": &schema.Schema{
"rps": {
Type: schema.TypeInt,
Optional: true,
DefaultFunc: schema.EnvDefaultFunc("CLOUDFLARE_RPS", 4),
Description: "RPS limit to apply when making calls to the API",
},

"retries": &schema.Schema{
"retries": {
Type: schema.TypeInt,
Optional: true,
DefaultFunc: schema.EnvDefaultFunc("CLOUDFLARE_RETRIES", 3),
Description: "Maximum number of retries to perform when an API request fails",
},

"min_backoff": &schema.Schema{
"min_backoff": {
Type: schema.TypeInt,
Optional: true,
DefaultFunc: schema.EnvDefaultFunc("CLOUDFLARE_MIN_BACKOFF", 1),
Description: "Minimum backoff period in seconds after failed API calls",
},

"max_backoff": &schema.Schema{
"max_backoff": {
Type: schema.TypeInt,
Optional: true,
DefaultFunc: schema.EnvDefaultFunc("CLOUDFLARE_MAX_BACKOFF", 30),
Description: "Maximum backoff period in seconds after failed API calls",
},

"api_client_logging": &schema.Schema{
"api_client_logging": {
Type: schema.TypeBool,
Optional: true,
DefaultFunc: schema.EnvDefaultFunc("CLOUDFLARE_API_CLIENT_LOGGING", false),
Description: "Whether to print logs from the API client (using the default log library logger)",
},

"use_org_from_zone": &schema.Schema{
"use_org_from_zone": {
Type: schema.TypeString,
Optional: true,
DefaultFunc: schema.EnvDefaultFunc("CLOUDFLARE_ORG_ZONE", nil),
Description: "If specified zone is owned by an organization, configure API client to always use that organization",
},

"org_id": &schema.Schema{
"org_id": {
Type: schema.TypeString,
Optional: true,
DefaultFunc: schema.EnvDefaultFunc("CLOUDFLARE_ORG_ID", nil),
Expand Down Expand Up @@ -120,12 +119,22 @@ func Provider() terraform.ResourceProvider {
"cloudflare_zone_settings_override": resourceCloudflareZoneSettingsOverride(),
"cloudflare_zone": resourceCloudflareZone(),
},
}

ConfigureFunc: providerConfigure,
provider.ConfigureFunc = func(d *schema.ResourceData) (interface{}, error) {
terraformVersion := provider.TerraformVersion
if terraformVersion == "" {
// Terraform 0.12 introduced this field to the protocol
// We can therefore assume that if it's missing it's 0.10 or 0.11
terraformVersion = "0.11+compatible"
}
return providerConfigure(d, terraformVersion)
}

return provider
}

func providerConfigure(d *schema.ResourceData) (interface{}, error) {
func providerConfigure(d *schema.ResourceData, terraformVersion string) (interface{}, error) {
limitOpt := cloudflare.UsingRateLimit(float64(d.Get("rps").(int)))
retryOpt := cloudflare.UsingRetryPolicy(d.Get("retries").(int), d.Get("min_backoff").(int), d.Get("max_backoff").(int))
options := []cloudflare.Option{limitOpt, retryOpt}
Expand All @@ -138,6 +147,11 @@ func providerConfigure(d *schema.ResourceData) (interface{}, error) {
c.Transport = logging.NewTransport("Cloudflare", c.Transport)
options = append(options, cloudflare.HTTPClient(c))

tfUserAgent := httpclient.TerraformUserAgent(terraformVersion)
providerUserAgent := fmt.Sprintf("terraform-provider-cloudflare/%s", version.ProviderVersion)
ua := fmt.Sprintf("%s %s", tfUserAgent, providerUserAgent)
options = append(options, cloudflare.UserAgent(ua))

config := Config{Options: options}

if v, ok := d.GetOk("api_token"); ok {
Expand Down Expand Up @@ -194,13 +208,6 @@ func providerConfigure(d *schema.ResourceData) (interface{}, error) {
return client, err
}

// TODO: This is the SDK version not the CLI version, once we are on 0.12, should revisit
tfUserAgent := httpclient.UserAgentString()

pv := version.ProviderVersion
providerUserAgent := fmt.Sprintf("%s terraform-provider-cloudflare/%s", tfUserAgent, pv)
options = append(options, cloudflare.UserAgent(strings.TrimSpace(fmt.Sprintf("%s %s", client.UserAgent, providerUserAgent))))

config.Options = options

client, err = config.Client()
Expand Down