Merge pull request #3 from seanson/add_confluence_server_support

Add confluence server support

Author: DrFaust92

CHANGELOG.md

@@ -1,5 +1,13 @@
-## To be released
+## 0.2.0
 
 FEATURES:
 
-* **New Resource:** `confluence_content`
+- **Experimental:** Support for Confluence Server
+- Added additional parameters for public and api sites and schemes for Confluence Server
+- Fix: Fixed index error when creating resources without a parent
+
+## 0.1.0
+
+FEATURES:
+
+- **New Resource:** `confluence_content`

VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

confluence/attachment.go

@@ -26,13 +26,13 @@ type Metadata struct {
 
 // AttachmentLinks is part of Content
 type AttachmentLinks struct {
-	Context  string `json:"context,omitempty"`  // "/wiki"
+	Context  string `json:"context,omitempty"`  // ""
 	Download string `json:"download,omitempty"` // prefix with Context
 }
 
 func (c *Client) CreateAttachment(attachment *Attachment, data, pageId string) (*Attachment, error) {
 	var response AttachmentResults
-	path := fmt.Sprintf("/wiki/rest/api/content/%s/child/attachment", pageId)
+	path := fmt.Sprintf("/rest/api/content/%s/child/attachment", pageId)
 	if err := c.PostForm(path, attachment.Title, data, &response); err != nil {
 		return nil, err
 	}
@@ -45,7 +45,7 @@ func (c *Client) CreateAttachment(attachment *Attachment, data, pageId string) (
 func (c *Client) UpdateAttachment(attachment *Attachment, data, pageId string) (*Attachment, error) {
 	var response AttachmentResults
 	attachment.Version.Number++
-	path := fmt.Sprintf("/wiki/rest/api/content/%s/child/attachment/%s", pageId, attachment.Id)
+	path := fmt.Sprintf("/rest/api/content/%s/child/attachment/%s", pageId, attachment.Id)
 	if err := c.PutForm(path, attachment.Title, data, &response); err != nil {
 		return nil, err
 	}
@@ -57,24 +57,23 @@ func (c *Client) UpdateAttachment(attachment *Attachment, data, pageId string) (
 
 func (c *Client) GetAttachment(id string) (*Attachment, error) {
 	var response Attachment
-	path := fmt.Sprintf("/wiki/rest/api/content/%s?expand=version", id)
+	path := fmt.Sprintf("/rest/api/content/%s?expand=version", id)
 	if err := c.Get(path, &response); err != nil {
 		return nil, err
 	}
 	return &response, nil
 }
 
 func (c *Client) GetAttachmentBody(attachment *Attachment) (string, error) {
-	path := attachment.Links.Context + attachment.Links.Download
-	result, err := c.GetString(path)
+	result, err := c.GetString(attachment.Links.Download)
 	if err != nil {
 		return "", err
 	}
 	return result, nil
 }
 
 func (c *Client) DeleteAttachment(id, pageId string) error {
-	path := fmt.Sprintf("/wiki/rest/api/content/%s", id)
+	path := fmt.Sprintf("/rest/api/content/%s", id)
 	if err := c.Delete(path); err != nil {
 		return err
 	}

confluence/client.go

@@ -16,14 +16,19 @@ import (
 type Client struct {
 	client    *http.Client
 	baseURL   *url.URL
+	basePath  string
 	publicURL *url.URL
 }
 
 // NewClientInput provides information to connect to the Confluence API
 type NewClientInput struct {
-	site  string
-	user  string
-	token string
+	site             string
+	siteScheme       string
+	publicSite       string
+	publicSiteScheme string
+	context          string
+	user             string
+	token            string
 }
 
 // ErrorResponse describes why a request failed
@@ -41,16 +46,30 @@ type ErrorResponse struct {
 // NewClient returns an authenticated client ready to use
 func NewClient(input *NewClientInput) *Client {
 	publicURL := url.URL{
-		Scheme: "https",
-		Host:   input.site + ".atlassian.net",
+		Scheme: input.publicSiteScheme,
+		Host:   input.site,
+	}
+	if input.publicSite != "" {
+		publicURL.Host = input.publicSite
+	}
+
+	basePath := input.context
+
+	// Default to /wiki if using Confluence Cloud`
+	if strings.HasSuffix(input.site, ".atlassian.net") {
+		basePath = "/wiki"
+	}
+	baseURL := url.URL{
+		Scheme: input.siteScheme,
+		Host:   input.site,
 	}
-	baseURL := publicURL
 	baseURL.User = url.UserPassword(input.user, input.token)
 	return &Client{
 		client: &http.Client{
 			Timeout: time.Second * 10,
 		},
 		baseURL:   &baseURL,
+		basePath:  basePath,
 		publicURL: &publicURL,
 	}
 }
@@ -159,7 +178,8 @@ func (c *Client) do(method, path, contentType string, body *bytes.Buffer, result
 
 // do uses the client to send a specified request
 func (c *Client) doRaw(method, path, contentType string, body *bytes.Buffer) (*bytes.Buffer, error) {
-	u, err := c.baseURL.Parse(path)
+	fullPath := c.basePath + path
+	u, err := c.baseURL.Parse(fullPath)
 	if err != nil {
 		return nil, err
 	}
@@ -193,7 +213,7 @@ func (c *Client) doRaw(method, path, contentType string, body *bytes.Buffer) (*b
 		}
 		s := body.String()
 		return nil, fmt.Errorf("%s\n\n%s %s\n%s\n\n%s",
-			resp.Status, method, path, s, responseBody)
+			resp.Status, method, fullPath, s, responseBody)
 	}
 	result := new(bytes.Buffer)
 	_, err = result.ReadFrom(resp.Body)

confluence/content.go

@@ -45,15 +45,15 @@ type Version struct {
 
 func (c *Client) CreateContent(content *Content) (*Content, error) {
 	var response Content
-	if err := c.Post("/wiki/rest/api/content", content, &response); err != nil {
+	if err := c.Post("/rest/api/content", content, &response); err != nil {
 		return nil, err
 	}
 	return &response, nil
 }
 
 func (c *Client) GetContent(id string) (*Content, error) {
 	var response Content
-	path := fmt.Sprintf("/wiki/rest/api/content/%s?expand=space,body.storage,version,ancestors", id)
+	path := fmt.Sprintf("/rest/api/content/%s?expand=space,body.storage,version,ancestors", id)
 	if err := c.Get(path, &response); err != nil {
 		return nil, err
 	}
@@ -63,15 +63,15 @@ func (c *Client) GetContent(id string) (*Content, error) {
 func (c *Client) UpdateContent(content *Content) (*Content, error) {
 	var response Content
 	content.Version.Number++
-	path := fmt.Sprintf("/wiki/rest/api/content/%s", content.Id)
+	path := fmt.Sprintf("/rest/api/content/%s", content.Id)
 	if err := c.Put(path, content, &response); err != nil {
 		return nil, err
 	}
 	return &response, nil
 }
 
 func (c *Client) DeleteContent(id string) error {
-	path := fmt.Sprintf("/wiki/rest/api/content/%s", id)
+	path := fmt.Sprintf("/rest/api/content/%s", id)
 	if err := c.Delete(path); err != nil {
 		return err
 	}

confluence/provider.go

@@ -11,19 +11,43 @@ func Provider() *schema.Provider {
 			"site": {
 				Type:        schema.TypeString,
 				Required:    true,
-				Description: "Cloud Confluence Site Name (the name before atlassian.net)",
+				Description: "Confluence hostname (<name>.atlassian.net if using Cloud Confluence, otherwise hostname)",
 				DefaultFunc: schema.EnvDefaultFunc("CONFLUENCE_SITE", nil),
 			},
+			"site_scheme": {
+				Type:        schema.TypeString,
+				Required:    true,
+				Description: "Optional https or http scheme to use for API calls",
+				DefaultFunc: schema.EnvDefaultFunc("CONFLUENCE_SITE_SCHEME", "https"),
+			},
+			"public_site": {
+				Type:        schema.TypeString,
+				Required:    true,
+				Description: "Optional public Confluence Server hostname if different than API hostname",
+				DefaultFunc: schema.EnvDefaultFunc("CONFLUENCE_PUBLIC_SITE", ""),
+			},
+			"public_site_scheme": {
+				Type:        schema.TypeString,
+				Required:    true,
+				Description: "Optional https or http scheme to use for public site URLs",
+				DefaultFunc: schema.EnvDefaultFunc("CONFLUENCE_PUBLIC_SITE_SCHEME", "https"),
+			},
+			"context": {
+				Type:        schema.TypeString,
+				Required:    true,
+				Description: "Confluence path context (Will default to /wiki if using an atlassian.net hostname)",
+				DefaultFunc: schema.EnvDefaultFunc("CONFLUENCE_CONTEXT", ""),
+			},
 			"user": {
 				Type:        schema.TypeString,
 				Required:    true,
-				Description: "User's email address",
+				Description: "User's email address for Cloud Confluence or username for Confluence Server",
 				DefaultFunc: schema.EnvDefaultFunc("CONFLUENCE_USER", nil),
 			},
 			"token": {
 				Type:        schema.TypeString,
 				Required:    true,
-				Description: "Confluence API Token for user",
+				Description: "Confluence API Token for Cloud Confluence or password for Confluence Server",
 				DefaultFunc: schema.EnvDefaultFunc("CONFLUENCE_TOKEN", nil),
 			},
 		},
@@ -38,8 +62,12 @@ func Provider() *schema.Provider {
 
 func providerConfigure(d *schema.ResourceData) (interface{}, error) {
 	return NewClient(&NewClientInput{
-		site:  d.Get("site").(string),
-		token: d.Get("token").(string),
-		user:  d.Get("user").(string),
+		site:             d.Get("site").(string),
+		siteScheme:       d.Get("site_scheme").(string),
+		publicSite:       d.Get("public_site").(string),
+		publicSiteScheme: d.Get("public_site_scheme").(string),
+		context:          d.Get("context").(string),
+		token:            d.Get("token").(string),
+		user:             d.Get("user").(string),
 	}), nil
 }

confluence/resource_content.go

@@ -139,7 +139,9 @@ func updateResourceDataFromContent(d *schema.ResourceData, content *Content, cli
 		"title":   content.Title,
 		"version": content.Version.Number,
 		"url":     client.URL(content.Links.Context + content.Links.WebUI),
-		"parent":  content.Ancestors[len(content.Ancestors)-1].Id, // the last ancestor is the parent
+	}
+	if len(content.Ancestors) > 1 {
+		m["parent"] = content.Ancestors[len(content.Ancestors)-1].Id
 	}
 	for k, v := range m {
 		err := d.Set(k, v)

docs/index.md

@@ -3,14 +3,14 @@ layout: "confluence"
 page_title: "Provider: Confluence"
 sidebar_current: "docs-confluence-index"
 description: |-
-  The Confluence provider is used to interact with Cloud Confluence.
+  The Confluence provider is used to interact with Confluence.
   It can automate the publishing of content and is often used to publish
   information about other resources created in terraform.
 ---
 
 # Confluence Provider
 
-The Confluence provider is used to interact with the Cloud Confluence. The
+The Confluence provider is used to interact with the Confluence. The
 provider needs to be configured with the proper credentials before it can be
 used.
 
@@ -20,7 +20,7 @@ Use the navigation to the left to read about the available data sources.
 
 ```hcl
 provider "confluence" {
-  site  = "my-site"
+  site  = "my-site.atlassian.net"
   user  = "my-user"
   token = "my-token"
 }
@@ -38,14 +38,31 @@ Static credentials must be passed to the provider block.
 
 ## Argument Reference
 
-* `site` - (Required) The site is the name of the site and appears in your wiki
-  URL (https://*my-site*.atlassian.net/wiki/spaces/my-space/). This can also be
-  set via the `CONFLUENCE_SITE` environment variable.
+- `site` - (Required) For Confluence Cloud: The site is the name of the site
+  and appears in your wiki URL (https://_my-site.atlassian.net_/wiki/spaces/my-space/).
+  For Confluence Server users this should be the hostname of your Confluence
+  instance that can receive `/rest/api` requests. This can also be set via the
+  `CONFLUENCE_SITE` environment variable.
 
-* `user` - (Required) The user is your user's email address. This can also be
-  set via the `CONFLUENCE_USER` environment variable.
+- `site_schema` - (Optional) Set the schema for connecting to the REST API.
+  Defaults to `https`. This can also be set via the `CONFLUENCE_SITE_SCHEMA`
+  environment variable.
 
-* `token` - (Required) The token is a secret every user can generate. It is
-  similar to a password and should be treated as such. This can also be set via
-  the `CONFLUENCE_TOKEN` environment variable. See [Manage your
-  account](https://id.atlassian.com/manage/api-tokens).
+- `public_site` - (Optional) For Confluence Server instances where your
+  Confluence site URL is different than the hostname that serves REST API
+  requests. Defaults to `site` if not set. This can also be set via the
+  `CONFLUENCE_PUBLIC_SITE` environment variable.
+
+- `public_site_schema` - (Optional) Set the schema for generated public URLs.
+  Defaults to `https`. This can also be set via the `CONFLUENCE_PUBLIC_SITE_SCHEMA`
+  environment variable.
+
+- `user` - (Required) For Confluence Cloud the user is your user's email
+  address. For Confluence Server this is the username of the user to login.
+  This can also be set via the `CONFLUENCE_USER` environment variable.
+
+- `token` - (Required) For Confluence Cloud the token is a secret every user
+  can generate. It is similar to a password and should be treated as such. For
+  Confluence Server, this is the password of the user. This can also be set via
+  the `CONFLUENCE_TOKEN` environment variable. For Cloud token details, see
+  [Manage your account](https://id.atlassian.com/manage/api-tokens).