Added username/password configuration options

Author: oyvindhagberg

CHANGELOG.md

@@ -1,3 +1,3 @@
-## 0.1.0 (Unreleased)
+## 0.1.1 (Unreleased)
 
 BACKWARDS INCOMPATIBILITIES / NOTES:

README.md

@@ -1,62 +1,5 @@
-# Terraform Provider Scaffolding
+# Terraform Provider for Mreg
 
-This repository is a *template* for a [Terraform](https://www.terraform.io) provider. It is intended as a starting point for creating Terraform providers, containing:
+This Terraform provider gives you a way to interact with [Mreg](https://github.com/unioslo/mreg/) through the API.
 
- - A resource, and a data source (`internal/provider/`),
- - Examples (`examples/`) and generated documentation (`docs/`),
- - Miscellaneous meta files.
- 
-These files contain boilerplate code that you will need to edit to create your own Terraform provider. A full guide to creating Terraform providers can be found at [Writing Custom Providers](https://www.terraform.io/docs/extend/writing-custom-providers.html).
-
-Please see the [GitHub template repository documentation](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template) for how to create a new repository from this template on GitHub.
-
-Once you've written your provider, you'll want to [publish it on the Terraform Registry](https://www.terraform.io/docs/registry/providers/publishing.html) so that others can use it.
-
-
-## Requirements
-
--	[Terraform](https://www.terraform.io/downloads.html) >= 0.13.x
--	[Go](https://golang.org/doc/install) >= 1.15
-
-## Building The Provider
-
-1. Clone the repository
-1. Enter the repository directory
-1. Build the provider using the Go `install` command: 
-```sh
-$ go install
-```
-
-## Adding Dependencies
-
-This provider uses [Go modules](https://github.com/golang/go/wiki/Modules).
-Please see the Go documentation for the most up to date information about using Go modules.
-
-To add a new dependency `github.com/author/dependency` to your Terraform provider:
-
-```
-go get github.com/author/dependency
-go mod tidy
-```
-
-Then commit the changes to `go.mod` and `go.sum`.
-
-## Using the provider
-
-Fill this in for each provider
-
-## Developing the Provider
-
-If you wish to work on the provider, you'll first need [Go](http://www.golang.org) installed on your machine (see [Requirements](#requirements) above).
-
-To compile the provider, run `go install`. This will build the provider and put the provider binary in the `$GOPATH/bin` directory.
-
-To generate or update documentation, run `go generate`.
-
-In order to run the full suite of Acceptance tests, run `make testacc`.
-
-*Note:* Acceptance tests create real resources, and often cost money to run.
-
-```sh
-$ make testacc
-```
+This repository is based on the [Terraform Provider Scaffolding](https://github.com/hashicorp/terraform-provider-scaffolding) repository.

docs/index.md

@@ -16,7 +16,20 @@ The Mreg provider provides resources to interact with [Mreg](https://github.com/
         token     = "1234567890ABCDEF"
     }
 
+#### Alternatively, supply a username and password:
+
+    provider "mreg" {
+        serverurl = "https://mreg.example.com/"
+        username  = "bob"
+        password  = "secret123"
+    }
+
 ### Required configuration options
 
 - **serverurl** (String)
+
+### Either a token or a username and password is required
+
 - **token** (String, Sensitive)
+- **username** (String, Sensitive)
+- **password** (String, Sensitive)

examples/main.tf

@@ -1,7 +1,7 @@
 terraform {
   required_providers {
     mreg = {
-      version = "0.1.0"
+      version = "0.1.1"
       source  = "uio.no/usit/mreg"
     }
   }

examples/run_example.sh

@@ -7,8 +7,8 @@ go get -v
 go build
 #TODO after the provider is added to the registry, there's no need to copy the file here
 rm -rf ~/.terraform.d/plugins/uio.no/usit/mreg/
-mkdir -p ~/.terraform.d/plugins/uio.no/usit/mreg/0.1.0/linux_amd64
-cp terraform-provider-mreg ~/.terraform.d/plugins/uio.no/usit/mreg/0.1.0/linux_amd64/
+mkdir -p ~/.terraform.d/plugins/uio.no/usit/mreg/0.1.1/linux_amd64
+cp terraform-provider-mreg ~/.terraform.d/plugins/uio.no/usit/mreg/0.1.1/linux_amd64/
 popd >/dev/null
 rm -rf .terraform .terraform.lock.hcl terraform.tfstate crash.log
 terraform init

internal/provider/utilities.go renamed to internal/provider/apiclient.go

@@ -7,11 +7,23 @@ import (
 	"io"
 	"io/ioutil"
 	"net/http"
+	"strings"
 
 	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
 )
 
-func httpRequest(method, urlPath string, requestBody map[string]interface{}, expectedStatus int, apiClient apiClient) (bodyText string, body interface{}, diags diag.Diagnostics) {
+type apiClient struct {
+	Serverurl string
+	Token     string
+	Username  string
+	Password  string
+}
+
+func (c apiClient) UrlWithoutSlash() string {
+	return strings.TrimSuffix(c.Serverurl, "/")
+}
+
+func (apiClient apiClient) httpRequest(method, urlPath string, requestBody map[string]interface{}, expectedStatus int) (bodyText string, body interface{}, diags diag.Diagnostics) {
 	// Turn the request body structure into JSON
 	var reqBodyReader io.Reader
 	if requestBody != nil {
@@ -30,10 +42,13 @@ func httpRequest(method, urlPath string, requestBody map[string]interface{}, exp
 		diags = diag.FromErr(err)
 		return
 	}
-	req.Header.Add("Authorization", "Token "+apiClient.Token)
+	if apiClient.Token != "" {
+		req.Header.Add("Authorization", "Token "+apiClient.Token)
+	}
 	if reqBodyReader != nil {
 		req.Header.Add("Content-Type", "application/json")
 	}
+	req.Header.Add("User-Agent", "Terraform provider for Mreg")
 
 	// Perform the request
 	response, err := http.DefaultClient.Do(req)
@@ -77,3 +92,22 @@ func httpRequest(method, urlPath string, requestBody map[string]interface{}, exp
 
 	return
 }
+
+func (c *apiClient) login() diag.Diagnostics {
+	bodyText, body, diags := c.httpRequest("POST", "/api/token-auth/", map[string]interface{}{
+		"username": c.Username,
+		"password": c.Password,
+	}, http.StatusOK)
+	if diags != nil {
+		return diags
+	}
+	data, ok := body.(map[string]interface{})
+	if !ok {
+		return diag.Errorf("The Mreg token-auth endpoint returned an unexpected result: %s", bodyText)
+	}
+	c.Token, ok = data["token"].(string)
+	if !ok {
+		return diag.Errorf("The Mreg token-auth endpoint returned an unexpected result: %s", bodyText)
+	}
+	return nil
+}

internal/provider/provider.go

@@ -2,7 +2,6 @@ package provider
 
 import (
 	"context"
-	"strings"
 
 	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
@@ -39,7 +38,17 @@ func New(version string) func() *schema.Provider {
 				},
 				"token": &schema.Schema{
 					Type:      schema.TypeString,
-					Required:  true,
+					Optional:  true,
+					Sensitive: true,
+				},
+				"username": &schema.Schema{
+					Type:      schema.TypeString,
+					Optional:  true,
+					Sensitive: true,
+				},
+				"password": &schema.Schema{
+					Type:      schema.TypeString,
+					Optional:  true,
 					Sensitive: true,
 				},
 			},
@@ -51,27 +60,17 @@ func New(version string) func() *schema.Provider {
 	}
 }
 
-type apiClient struct {
-	// Add whatever fields, client or connection info, etc. here
-	// you would need to setup to communicate with the upstream
-	// API.
-	Serverurl string
-	Token     string
-}
-
-func (c apiClient) UrlWithoutSlash() string {
-	return strings.TrimSuffix(c.Serverurl, "/")
-}
-
 func configure(version string, p *schema.Provider) func(context.Context, *schema.ResourceData) (interface{}, diag.Diagnostics) {
 	return func(c context.Context, d *schema.ResourceData) (interface{}, diag.Diagnostics) {
-		// Setup a User-Agent for your API client (replace the provider name for yours):
-		// userAgent := p.UserAgent("terraform-provider-scaffolding", version)
-		// TODO: myClient.UserAgent = userAgent
-
-		return apiClient{
+		client := apiClient{
 			Serverurl: d.Get("serverurl").(string),
 			Token:     d.Get("token").(string),
-		}, nil
+			Username:  d.Get("username").(string),
+			Password:  d.Get("password").(string),
+		}
+		if client.Username != "" {
+			client.login()
+		}
+		return client, nil
 	}
 }

internal/provider/resource_hosts.go

@@ -98,9 +98,9 @@ func resourceHostsCreate(ctx context.Context, d *schema.ResourceData, m interfac
 			ipaddress = manual_ip
 		} else {
 			// Find a free IP address in Mreg
-			body, _, diags := httpRequest(
+			body, _, diags := apiClient.httpRequest(
 				"GET", fmt.Sprintf("/api/v1/networks/%s/first_unused", url.QueryEscape(network)),
-				nil, http.StatusOK, apiClient)
+				nil, http.StatusOK)
 			if len(diags) > 0 {
 				return diags
 			}
@@ -115,7 +115,7 @@ func resourceHostsCreate(ctx context.Context, d *schema.ResourceData, m interfac
 			"contact":   contact,
 			"comment":   comment,
 		}
-		_, _, diags := httpRequest("POST", "/api/v1/hosts/", request, http.StatusCreated, apiClient)
+		_, _, diags := apiClient.httpRequest("POST", "/api/v1/hosts/", request, http.StatusCreated)
 		if len(diags) > 0 {
 			return diags
 		}
@@ -156,8 +156,8 @@ func resourceHostsRead(ctx context.Context, d *schema.ResourceData, m interface{
 		hostname := host["name"].(string)
 
 		// Read information about this host from Mreg
-		_, body, diags := httpRequest("GET", "/api/v1/hosts/"+url.QueryEscape(hostname),
-			nil, http.StatusOK, apiClient)
+		_, body, diags := apiClient.httpRequest("GET", "/api/v1/hosts/"+url.QueryEscape(hostname),
+			nil, http.StatusOK)
 		if len(diags) > 0 {
 			return diags
 		}
@@ -192,8 +192,8 @@ func resourceHostsDelete(ctx context.Context, d *schema.ResourceData, m interfac
 		hostname := host["name"].(string)
 
 		// Delete this host from Mreg
-		_, _, diags := httpRequest("DELETE", "/api/v1/hosts/"+url.QueryEscape(hostname),
-			nil, http.StatusNoContent, apiClient)
+		_, _, diags := apiClient.httpRequest("DELETE", "/api/v1/hosts/"+url.QueryEscape(hostname),
+			nil, http.StatusNoContent)
 		if len(diags) > 0 {
 			return diags
 		}

internal/provider/resource_srv.go

@@ -59,7 +59,7 @@ func resourceSRVCreate(ctx context.Context, d *schema.ResourceData, m interface{
 	apiClient := m.(apiClient)
 
 	// Find the host ID in Mreg by looking up the hostname
-	_, body, diags := httpRequest("GET", "/api/v1/hosts/"+url.QueryEscape(d.Get("target_host").(string)), nil, http.StatusOK, apiClient)
+	_, body, diags := apiClient.httpRequest("GET", "/api/v1/hosts/"+url.QueryEscape(d.Get("target_host").(string)), nil, http.StatusOK)
 	if len(diags) > 0 {
 		return diags
 	}
@@ -77,7 +77,7 @@ func resourceSRVCreate(ctx context.Context, d *schema.ResourceData, m interface{
 		"port":     d.Get("port"),
 		"host":     hostID,
 	}
-	_, _, diags = httpRequest("POST", "/api/v1/srvs/", postdata, http.StatusCreated, apiClient)
+	_, _, diags = apiClient.httpRequest("POST", "/api/v1/srvs/", postdata, http.StatusCreated)
 	if len(diags) > 0 {
 		return diags
 	}
@@ -97,15 +97,15 @@ func resourceSRVDelete(ctx context.Context, d *schema.ResourceData, m interface{
 	serviceProtoName := fmt.Sprintf("_%s._%s.%s.", d.Get("service").(string), d.Get("proto").(string), d.Get("name").(string))
 
 	// Find the host ID in Mreg by looking up the hostname
-	_, body, diags := httpRequest("GET", "/api/v1/hosts/"+url.QueryEscape(d.Get("target_host").(string)), nil, http.StatusOK, apiClient)
+	_, body, diags := apiClient.httpRequest("GET", "/api/v1/hosts/"+url.QueryEscape(d.Get("target_host").(string)), nil, http.StatusOK)
 	if len(diags) > 0 {
 		return diags
 	}
 	bodyMap := body.(map[string]interface{})
 	hostID := int(bodyMap["id"].(float64)) // Go always turns JSON numbers into float64 values
 
 	// Find all SRV records of that particular type, for that particular host
-	_, body, diags = httpRequest("GET", fmt.Sprintf("/api/v1/srvs/?host=%d&name=%s", hostID, url.QueryEscape(serviceProtoName)), nil, http.StatusOK, apiClient)
+	_, body, diags = apiClient.httpRequest("GET", fmt.Sprintf("/api/v1/srvs/?host=%d&name=%s", hostID, url.QueryEscape(serviceProtoName)), nil, http.StatusOK)
 	if len(diags) > 0 {
 		return diags
 	}
@@ -139,7 +139,7 @@ func resourceSRVDelete(ctx context.Context, d *schema.ResourceData, m interface{
 	}
 
 	// Delete the SRV record
-	_, _, diags = httpRequest("DELETE", fmt.Sprintf("/api/v1/srvs/%d", srvId), nil, http.StatusNoContent, apiClient)
+	_, _, diags = apiClient.httpRequest("DELETE", fmt.Sprintf("/api/v1/srvs/%d", srvId), nil, http.StatusNoContent)
 	if len(diags) > 0 {
 		return diags
 	}