Refactoring the CloudFlare provider

With this refactor the CloudFlare provider is updated to use the
schema.Provider approach released with TF 0.2.
This commit is contained in:
Sander van Harmelen 2014-11-17 12:01:22 +01:00
parent 66c0558f8d
commit a270bc9771
9 changed files with 206 additions and 329 deletions

View File

@ -3,13 +3,10 @@ package main
import ( import (
"github.com/hashicorp/terraform/builtin/providers/cloudflare" "github.com/hashicorp/terraform/builtin/providers/cloudflare"
"github.com/hashicorp/terraform/plugin" "github.com/hashicorp/terraform/plugin"
"github.com/hashicorp/terraform/terraform"
) )
func main() { func main() {
plugin.Serve(&plugin.ServeOpts{ plugin.Serve(&plugin.ServeOpts{
ProviderFunc: func() terraform.ResourceProvider { ProviderFunc: cloudflare.Provider,
return new(cloudflare.ResourceProvider)
},
}) })
} }

View File

@ -8,12 +8,11 @@ import (
) )
type Config struct { type Config struct {
Token string `mapstructure:"token"`
Email string `mapstructure:"email"` Email string `mapstructure:"email"`
Token string `mapstructure:"token"`
} }
// Client() returns a new client for accessing cloudflare. // Client() returns a new client for accessing cloudflare.
//
func (c *Config) Client() (*cloudflare.Client, error) { func (c *Config) Client() (*cloudflare.Client, error) {
client, err := cloudflare.NewClient(c.Email, c.Token) client, err := cloudflare.NewClient(c.Email, c.Token)

View File

@ -0,0 +1,54 @@
package cloudflare
import (
"os"
"github.com/hashicorp/terraform/helper/schema"
"github.com/hashicorp/terraform/terraform"
)
// Provider returns a terraform.ResourceProvider.
func Provider() terraform.ResourceProvider {
return &schema.Provider{
Schema: map[string]*schema.Schema{
"email": &schema.Schema{
Type: schema.TypeString,
Required: true,
DefaultFunc: envDefaultFunc("CLOUDFLARE_EMAIL"),
Description: "A registered CloudFlare email address.",
},
"token": &schema.Schema{
Type: schema.TypeString,
Required: true,
DefaultFunc: envDefaultFunc("CLOUDFLARE_TOKEN"),
Description: "The token key for API operations.",
},
},
ResourcesMap: map[string]*schema.Resource{
"cloudflare_record": resourceCloudFlareRecord(),
},
ConfigureFunc: providerConfigure,
}
}
func envDefaultFunc(k string) schema.SchemaDefaultFunc {
return func() (interface{}, error) {
if v := os.Getenv(k); v != "" {
return v, nil
}
return nil, nil
}
}
func providerConfigure(d *schema.ResourceData) (interface{}, error) {
config := Config{
Email: d.Get("email").(string),
Token: d.Get("token").(string),
}
return config.Client()
}

View File

@ -0,0 +1,43 @@
package cloudflare
import (
"os"
"testing"
"github.com/hashicorp/terraform/helper/schema"
"github.com/hashicorp/terraform/terraform"
)
var testAccProviders map[string]terraform.ResourceProvider
var testAccProvider *schema.Provider
func init() {
testAccProvider = Provider().(*schema.Provider)
testAccProviders = map[string]terraform.ResourceProvider{
"cloudflare": testAccProvider,
}
}
func TestProvider(t *testing.T) {
if err := Provider().(*schema.Provider).InternalValidate(); err != nil {
t.Fatalf("err: %s", err)
}
}
func TestProvider_impl(t *testing.T) {
var _ terraform.ResourceProvider = Provider()
}
func testAccPreCheck(t *testing.T) {
if v := os.Getenv("CLOUDFLARE_EMAIL"); v == "" {
t.Fatal("CLOUDFLARE_EMAIL must be set for acceptance tests")
}
if v := os.Getenv("CLOUDFLARE_TOKEN"); v == "" {
t.Fatal("CLOUDFLARE_TOKEN must be set for acceptance tests")
}
if v := os.Getenv("CLOUDFLARE_DOMAIN"); v == "" {
t.Fatal("CLOUDFLARE_DOMAIN must be set for acceptance tests. The domain is used to ` and destroy record against.")
}
}

View File

@ -4,96 +4,140 @@ import (
"fmt" "fmt"
"log" "log"
"github.com/hashicorp/terraform/helper/config" "github.com/hashicorp/terraform/helper/schema"
"github.com/hashicorp/terraform/helper/diff"
"github.com/hashicorp/terraform/terraform"
"github.com/pearkes/cloudflare" "github.com/pearkes/cloudflare"
) )
func resource_cloudflare_record_create( func resourceCloudFlareRecord() *schema.Resource {
s *terraform.InstanceState, return &schema.Resource{
d *terraform.InstanceDiff, Create: resourceCloudFlareRecordCreate,
meta interface{}) (*terraform.InstanceState, error) { Read: resourceCloudFlareRecordRead,
p := meta.(*ResourceProvider) Update: resourceCloudFlareRecordUpdate,
client := p.client Delete: resourceCloudFlareRecordDelete,
// Merge the diff into the state so that we have all the attributes Schema: map[string]*schema.Schema{
// properly. "domain": &schema.Schema{
rs := s.MergeDiff(d) Type: schema.TypeString,
Required: true,
},
var err error "name": &schema.Schema{
Type: schema.TypeString,
Required: true,
},
newRecord := cloudflare.CreateRecord{ "hostname": &schema.Schema{
Name: rs.Attributes["name"], Type: schema.TypeString,
Priority: rs.Attributes["priority"], Computed: true,
Type: rs.Attributes["type"], },
Content: rs.Attributes["value"],
Ttl: rs.Attributes["ttl"], "type": &schema.Schema{
Type: schema.TypeString,
Required: true,
},
"value": &schema.Schema{
Type: schema.TypeString,
Required: true,
},
"ttl": &schema.Schema{
Type: schema.TypeString,
Optional: true,
},
"priority": &schema.Schema{
Type: schema.TypeString,
Optional: true,
},
},
}
}
func resourceCloudFlareRecordCreate(d *schema.ResourceData, meta interface{}) error {
client := meta.(*cloudflare.Client)
// Create the new record
newRecord := &cloudflare.CreateRecord{
Name: d.Get("name").(string),
Type: d.Get("type").(string),
Content: d.Get("value").(string),
}
if ttl, ok := d.GetOk("ttl"); ok {
newRecord.Ttl = ttl.(string)
}
if priority, ok := d.GetOk("priority"); ok {
newRecord.Priority = priority.(string)
} }
log.Printf("[DEBUG] record create configuration: %#v", newRecord) log.Printf("[DEBUG] record create configuration: %#v", newRecord)
rec, err := client.CreateRecord(rs.Attributes["domain"], &newRecord) rec, err := client.CreateRecord(d.Get("domain").(string), newRecord)
if err != nil { if err != nil {
return nil, fmt.Errorf("Failed to create record: %s", err) return fmt.Errorf("Failed to create record: %s", err)
} }
rs.ID = rec.Id d.SetId(rec.Id)
log.Printf("[INFO] record ID: %s", rs.ID) log.Printf("[INFO] record ID: %s", d.Id())
record, err := resource_cloudflare_record_retrieve(rs.Attributes["domain"], rs.ID, client) return resourceCloudFlareRecordRead(d, meta)
if err != nil {
return nil, fmt.Errorf("Couldn't find record: %s", err)
}
return resource_cloudflare_record_update_state(rs, record)
} }
func resource_cloudflare_record_update( func resourceCloudFlareRecordRead(d *schema.ResourceData, meta interface{}) error {
s *terraform.InstanceState, client := meta.(*cloudflare.Client)
d *terraform.InstanceDiff,
meta interface{}) (*terraform.InstanceState, error) {
p := meta.(*ResourceProvider)
client := p.client
rs := s.MergeDiff(d)
// Cloudflare requires we send all values rec, err := client.RetrieveRecord(d.Get("domain").(string), d.Id())
// for an update request, so we just if err != nil {
// merge out diff and send the current return fmt.Errorf("Couldn't find record: %s", err)
// state of affairs to them }
updateRecord := cloudflare.UpdateRecord{
Name: rs.Attributes["name"], d.Set("name", rec.Name)
Content: rs.Attributes["value"], d.Set("hostname", rec.FullName)
Type: rs.Attributes["type"], d.Set("type", rec.Type)
Ttl: rs.Attributes["ttl"], d.Set("value", rec.Value)
Priority: rs.Attributes["priority"], d.Set("ttl", rec.Ttl)
d.Set("priority", rec.Priority)
return nil
}
func resourceCloudFlareRecordUpdate(d *schema.ResourceData, meta interface{}) error {
client := meta.(*cloudflare.Client)
// CloudFlare requires we send all values for an update request
updateRecord := &cloudflare.UpdateRecord{
Name: d.Get("name").(string),
Type: d.Get("type").(string),
Content: d.Get("value").(string),
}
if ttl, ok := d.GetOk("ttl"); ok {
updateRecord.Ttl = ttl.(string)
}
if priority, ok := d.GetOk("priority"); ok {
updateRecord.Priority = priority.(string)
} }
log.Printf("[DEBUG] record update configuration: %#v", updateRecord) log.Printf("[DEBUG] record update configuration: %#v", updateRecord)
err := client.UpdateRecord(rs.Attributes["domain"], rs.ID, &updateRecord) err := client.UpdateRecord(d.Get("domain").(string), d.Id(), updateRecord)
if err != nil { if err != nil {
return rs, fmt.Errorf("Failed to update record: %s", err) return fmt.Errorf("Failed to update record: %s", err)
} }
record, err := resource_cloudflare_record_retrieve(rs.Attributes["domain"], rs.ID, client) return resourceCloudFlareRecordRead(d, meta)
if err != nil {
return rs, fmt.Errorf("Couldn't find record: %s", err)
}
return resource_cloudflare_record_update_state(rs, record)
} }
func resource_cloudflare_record_destroy( func resourceCloudFlareRecordDelete(d *schema.ResourceData, meta interface{}) error {
s *terraform.InstanceState, client := meta.(*cloudflare.Client)
meta interface{}) error {
p := meta.(*ResourceProvider)
client := p.client
log.Printf("[INFO] Deleting record: %s, %s", s.Attributes["domain"], s.ID) log.Printf("[INFO] Deleting record: %s, %s", d.Get("domain").(string), d.Id())
err := client.DestroyRecord(s.Attributes["domain"], s.ID) err := client.DestroyRecord(d.Get("domain").(string), d.Id())
if err != nil { if err != nil {
return fmt.Errorf("Error deleting record: %s", err) return fmt.Errorf("Error deleting record: %s", err)
@ -101,82 +145,3 @@ func resource_cloudflare_record_destroy(
return nil return nil
} }
func resource_cloudflare_record_refresh(
s *terraform.InstanceState,
meta interface{}) (*terraform.InstanceState, error) {
p := meta.(*ResourceProvider)
client := p.client
rec, err := resource_cloudflare_record_retrieve(s.Attributes["domain"], s.ID, client)
if err != nil {
return nil, err
}
return resource_cloudflare_record_update_state(s, rec)
}
func resource_cloudflare_record_diff(
s *terraform.InstanceState,
c *terraform.ResourceConfig,
meta interface{}) (*terraform.InstanceDiff, error) {
b := &diff.ResourceBuilder{
Attrs: map[string]diff.AttrType{
"domain": diff.AttrTypeCreate,
"name": diff.AttrTypeUpdate,
"value": diff.AttrTypeUpdate,
"ttl": diff.AttrTypeUpdate,
"type": diff.AttrTypeUpdate,
"priority": diff.AttrTypeUpdate,
},
ComputedAttrs: []string{
"priority",
"ttl",
"hostname",
},
ComputedAttrsUpdate: []string{},
}
return b.Diff(s, c)
}
func resource_cloudflare_record_update_state(
s *terraform.InstanceState,
rec *cloudflare.Record) (*terraform.InstanceState, error) {
s.Attributes["name"] = rec.Name
s.Attributes["value"] = rec.Value
s.Attributes["type"] = rec.Type
s.Attributes["ttl"] = rec.Ttl
s.Attributes["priority"] = rec.Priority
s.Attributes["hostname"] = rec.FullName
return s, nil
}
func resource_cloudflare_record_retrieve(domain string, id string, client *cloudflare.Client) (*cloudflare.Record, error) {
record, err := client.RetrieveRecord(domain, id)
if err != nil {
return nil, err
}
return record, nil
}
func resource_cloudflare_record_validation() *config.Validator {
return &config.Validator{
Required: []string{
"domain",
"name",
"value",
"type",
},
Optional: []string{
"ttl",
"priority",
},
}
}

View File

@ -76,7 +76,7 @@ func TestAccCLOudflareRecord_Updated(t *testing.T) {
} }
func testAccCheckCLOudflareRecordDestroy(s *terraform.State) error { func testAccCheckCLOudflareRecordDestroy(s *terraform.State) error {
client := testAccProvider.client client := testAccProvider.Meta().(*cloudflare.Client)
for _, rs := range s.RootModule().Resources { for _, rs := range s.RootModule().Resources {
if rs.Type != "cloudflare_record" { if rs.Type != "cloudflare_record" {
@ -127,7 +127,7 @@ func testAccCheckCLOudflareRecordExists(n string, record *cloudflare.Record) res
return fmt.Errorf("No Record ID is set") return fmt.Errorf("No Record ID is set")
} }
client := testAccProvider.client client := testAccProvider.Meta().(*cloudflare.Client)
foundRecord, err := client.RetrieveRecord(rs.Primary.Attributes["domain"], rs.Primary.ID) foundRecord, err := client.RetrieveRecord(rs.Primary.Attributes["domain"], rs.Primary.ID)

View File

@ -1,77 +0,0 @@
package cloudflare
import (
"log"
"github.com/hashicorp/terraform/helper/config"
"github.com/hashicorp/terraform/terraform"
"github.com/pearkes/cloudflare"
)
type ResourceProvider struct {
Config Config
client *cloudflare.Client
}
func (p *ResourceProvider) Input(
input terraform.UIInput,
c *terraform.ResourceConfig) (*terraform.ResourceConfig, error) {
return c, nil
}
func (p *ResourceProvider) Validate(c *terraform.ResourceConfig) ([]string, []error) {
v := &config.Validator{
Required: []string{
"token",
"email",
},
}
return v.Validate(c)
}
func (p *ResourceProvider) ValidateResource(
t string, c *terraform.ResourceConfig) ([]string, []error) {
return resourceMap.Validate(t, c)
}
func (p *ResourceProvider) Configure(c *terraform.ResourceConfig) error {
if _, err := config.Decode(&p.Config, c.Config); err != nil {
return err
}
log.Println("[INFO] Initializing CloudFlare client")
var err error
p.client, err = p.Config.Client()
if err != nil {
return err
}
return nil
}
func (p *ResourceProvider) Apply(
info *terraform.InstanceInfo,
s *terraform.InstanceState,
d *terraform.InstanceDiff) (*terraform.InstanceState, error) {
return resourceMap.Apply(info, s, d, p)
}
func (p *ResourceProvider) Diff(
info *terraform.InstanceInfo,
s *terraform.InstanceState,
c *terraform.ResourceConfig) (*terraform.InstanceDiff, error) {
return resourceMap.Diff(info, s, c, p)
}
func (p *ResourceProvider) Refresh(
info *terraform.InstanceInfo,
s *terraform.InstanceState) (*terraform.InstanceState, error) {
return resourceMap.Refresh(info, s, p)
}
func (p *ResourceProvider) Resources() []terraform.ResourceType {
return resourceMap.Resources()
}

View File

@ -1,80 +0,0 @@
package cloudflare
import (
"os"
"reflect"
"testing"
"github.com/hashicorp/terraform/config"
"github.com/hashicorp/terraform/terraform"
)
var testAccProviders map[string]terraform.ResourceProvider
var testAccProvider *ResourceProvider
func init() {
testAccProvider = new(ResourceProvider)
testAccProviders = map[string]terraform.ResourceProvider{
"cloudflare": testAccProvider,
}
}
func TestResourceProvider_impl(t *testing.T) {
var _ terraform.ResourceProvider = new(ResourceProvider)
}
func TestResourceProvider_Configure(t *testing.T) {
rp := new(ResourceProvider)
var expectedToken string
var expectedEmail string
if v := os.Getenv("CLOUDFLARE_EMAIL"); v != "" {
expectedEmail = v
} else {
expectedEmail = "foo"
}
if v := os.Getenv("CLOUDFLARE_TOKEN"); v != "" {
expectedToken = v
} else {
expectedToken = "foo"
}
raw := map[string]interface{}{
"token": expectedToken,
"email": expectedEmail,
}
rawConfig, err := config.NewRawConfig(raw)
if err != nil {
t.Fatalf("err: %s", err)
}
err = rp.Configure(terraform.NewResourceConfig(rawConfig))
if err != nil {
t.Fatalf("err: %s", err)
}
expected := Config{
Token: expectedToken,
Email: expectedEmail,
}
if !reflect.DeepEqual(rp.Config, expected) {
t.Fatalf("bad: %#v", rp.Config)
}
}
func testAccPreCheck(t *testing.T) {
if v := os.Getenv("CLOUDFLARE_EMAIL"); v == "" {
t.Fatal("CLOUDFLARE_EMAIL must be set for acceptance tests")
}
if v := os.Getenv("CLOUDFLARE_TOKEN"); v == "" {
t.Fatal("CLOUDFLARE_TOKEN must be set for acceptance tests")
}
if v := os.Getenv("CLOUDFLARE_DOMAIN"); v == "" {
t.Fatal("CLOUDFLARE_DOMAIN must be set for acceptance tests. The domain is used to ` and destroy record against.")
}
}

View File

@ -1,24 +0,0 @@
package cloudflare
import (
"github.com/hashicorp/terraform/helper/resource"
)
// resourceMap is the mapping of resources we support to their basic
// operations. This makes it easy to implement new resource types.
var resourceMap *resource.Map
func init() {
resourceMap = &resource.Map{
Mapping: map[string]resource.Resource{
"cloudflare_record": resource.Resource{
ConfigValidator: resource_cloudflare_record_validation(),
Create: resource_cloudflare_record_create,
Destroy: resource_cloudflare_record_destroy,
Diff: resource_cloudflare_record_diff,
Update: resource_cloudflare_record_update,
Refresh: resource_cloudflare_record_refresh,
},
},
}
}