Merge pull request #9 from TerraformInDepth/doc_updates

Update Docs, Copyright, Add Preserve on Destroy

Author: tedivm

LICENSE

@@ -1,9 +1,11 @@
-Copyright (c) 2021 HashiCorp, Inc.
+Original Template Copyright (c) 2021 HashiCorp, Inc.
+Mastodon Provider Copyright (c) 2024 Robert Hafner
 
 Mozilla Public License Version 2.0
 ==================================
 
 1. Definitions
+
 --------------
 
 1.1. "Contributor"
@@ -86,6 +88,7 @@ Mozilla Public License Version 2.0
     ownership of such entity.
 
 2. License Grants and Conditions
+
 --------------------------------
 
 2.1. Grants
@@ -157,6 +160,7 @@ Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
 in Section 2.1.
 
 3. Responsibilities
+
 -------------------
 
 3.1. Distribution of Source Form
@@ -219,6 +223,7 @@ disclaimers of warranty and limitations of liability specific to any
 jurisdiction.
 
 4. Inability to Comply Due to Statute or Regulation
+
 ---------------------------------------------------
 
 If it is impossible for You to comply with any of the terms of this
@@ -232,6 +237,7 @@ or regulation, such description must be sufficiently detailed for a
 recipient of ordinary skill to be able to understand it.
 
 5. Termination
+
 --------------
 
 5.1. The rights granted under this License will terminate automatically
@@ -261,48 +267,53 @@ have been validly granted by You or Your distributors under this License
 prior to termination shall survive termination.
 
 ************************************************************************
+
 *                                                                      *
-*  6. Disclaimer of Warranty                                           *
-*  -------------------------                                           *
+* 6. Disclaimer of Warranty                                           *
+* -------------------------                                           *
 *                                                                      *
-*  Covered Software is provided under this License on an "as is"       *
-*  basis, without warranty of any kind, either expressed, implied, or  *
-*  statutory, including, without limitation, warranties that the       *
-*  Covered Software is free of defects, merchantable, fit for a        *
-*  particular purpose or non-infringing. The entire risk as to the     *
-*  quality and performance of the Covered Software is with You.        *
-*  Should any Covered Software prove defective in any respect, You     *
-*  (not any Contributor) assume the cost of any necessary servicing,   *
-*  repair, or correction. This disclaimer of warranty constitutes an   *
-*  essential part of this License. No use of any Covered Software is   *
-*  authorized under this License except under this disclaimer.         *
+* Covered Software is provided under this License on an "as is"       *
+* basis, without warranty of any kind, either expressed, implied, or  *
+* statutory, including, without limitation, warranties that the       *
+* Covered Software is free of defects, merchantable, fit for a        *
+* particular purpose or non-infringing. The entire risk as to the     *
+* quality and performance of the Covered Software is with You.        *
+* Should any Covered Software prove defective in any respect, You     *
+* (not any Contributor) assume the cost of any necessary servicing,   *
+* repair, or correction. This disclaimer of warranty constitutes an   *
+* essential part of this License. No use of any Covered Software is   *
+* authorized under this License except under this disclaimer.         *
 *                                                                      *
+
 ************************************************************************
 
 ************************************************************************
+
 *                                                                      *
-*  7. Limitation of Liability                                          *
-*  --------------------------                                          *
+* 7. Limitation of Liability                                          *
+* --------------------------                                          *
 *                                                                      *
-*  Under no circumstances and under no legal theory, whether tort      *
-*  (including negligence), contract, or otherwise, shall any           *
-*  Contributor, or anyone who distributes Covered Software as          *
-*  permitted above, be liable to You for any direct, indirect,         *
-*  special, incidental, or consequential damages of any character      *
-*  including, without limitation, damages for lost profits, loss of    *
-*  goodwill, work stoppage, computer failure or malfunction, or any    *
-*  and all other commercial damages or losses, even if such party      *
-*  shall have been informed of the possibility of such damages. This   *
-*  limitation of liability shall not apply to liability for death or   *
-*  personal injury resulting from such party's negligence to the       *
-*  extent applicable law prohibits such limitation. Some               *
-*  jurisdictions do not allow the exclusion or limitation of           *
-*  incidental or consequential damages, so this exclusion and          *
-*  limitation may not apply to You.                                    *
+* Under no circumstances and under no legal theory, whether tort      *
+* (including negligence), contract, or otherwise, shall any           *
+* Contributor, or anyone who distributes Covered Software as          *
+* permitted above, be liable to You for any direct, indirect,         *
+* special, incidental, or consequential damages of any character      *
+* including, without limitation, damages for lost profits, loss of    *
+* goodwill, work stoppage, computer failure or malfunction, or any    *
+* and all other commercial damages or losses, even if such party      *
+* shall have been informed of the possibility of such damages. This   *
+* limitation of liability shall not apply to liability for death or   *
+* personal injury resulting from such party's negligence to the       *
+* extent applicable law prohibits such limitation. Some               *
+* jurisdictions do not allow the exclusion or limitation of           *
+* incidental or consequential damages, so this exclusion and          *
+* limitation may not apply to You.                                    *
 *                                                                      *
+
 ************************************************************************
 
 8. Litigation
+
 -------------
 
 Any litigation relating to this License may be brought only in the
@@ -313,6 +324,7 @@ Nothing in this Section shall prevent a party's ability to bring
 cross-claims or counter-claims.
 
 9. Miscellaneous
+
 ----------------
 
 This License represents the complete agreement concerning the subject
@@ -323,6 +335,7 @@ that the language of a contract shall be construed against the drafter
 shall not be used to construe this License against a Contributor.
 
 10. Versions of the License
+
 ---------------------------
 
 10.1. New Versions
@@ -359,7 +372,7 @@ Exhibit A - Source Code Form License Notice
 
   This Source Code Form is subject to the terms of the Mozilla Public
   License, v. 2.0. If a copy of the MPL was not distributed with this
-  file, You can obtain one at http://mozilla.org/MPL/2.0/.
+  file, You can obtain one at <http://mozilla.org/MPL/2.0/>.
 
 If it is not possible or desirable to put the notice in a particular
 file, then You may include the notice in a location (such as a LICENSE

docs/data-sources/account.md

@@ -23,12 +23,12 @@ data "mastodon_account" "example" {
 
 ### Required
 
-- `username` (String) Account configurable attribute
+- `username` (String) The username of the account to lookup. This should include the domain.
 
 ### Read-Only
 
-- `bot` (Boolean)
-- `display_name` (String)
-- `id` (String) Account identifier
-- `locked` (Boolean)
-- `note` (String)
+- `bot` (Boolean) Whether the account is a bot or not.
+- `display_name` (String) The account's display name.
+- `id` (String) A unique account identifier retrieved from the server.
+- `locked` (Boolean) Whether the account is locked or not.
+- `note` (String) The note or biography of the account.

docs/resources/post.md

@@ -17,15 +17,16 @@ Post resource
 
 ### Required
 
-- `content` (String) Post content
+- `content` (String) The content of the post.
 
 ### Optional
 
-- `sensitive` (Boolean) Post sensitive
-- `visibility` (String) Post visibility
+- `preserve_on_destroy` (Boolean) When destroyed, preserve the post on the server.
+- `sensitive` (Boolean) Whether the post contains sensitive content.
+- `visibility` (String) The post visibility: can be `public`, `unlisted`, `private`, or `direct`.
 
 ### Read-Only
 
 - `account` (String) Account that created the post
-- `created_at` (String) Post creation timestamp
-- `id` (String) Post identifier
+- `created_at` (String) Timestamp of when the post was created.
+- `id` (String) Unique identifier of the post.

internal/provider/account_data_source.go

@@ -1,6 +1,3 @@
-// Copyright (c) HashiCorp, Inc.
-// SPDX-License-Identifier: MPL-2.0
-
 package provider
 
 import (
@@ -47,36 +44,36 @@ func (d *AccountDataSource) Schema(ctx context.Context, req datasource.SchemaReq
 
 		Attributes: map[string]schema.Attribute{
 			"username": schema.StringAttribute{
-				MarkdownDescription: "Account configurable attribute",
+				MarkdownDescription: "The username of the account to lookup. This should include the domain.",
 				Optional:            false,
 				Required:            true,
 			},
 			"id": schema.StringAttribute{
-				MarkdownDescription: "Account identifier",
+				MarkdownDescription: "A unique account identifier retrieved from the server.",
 				Computed:            true,
 				Optional:            false,
 				Required:            false,
 			},
 			"display_name": schema.StringAttribute{
-				MarkdownDescription: "",
+				MarkdownDescription: "The account's display name.",
 				Computed:            true,
 				Optional:            false,
 				Required:            false,
 			},
 			"note": schema.StringAttribute{
-				MarkdownDescription: "",
+				MarkdownDescription: "The note or biography of the account.",
 				Computed:            true,
 				Optional:            false,
 				Required:            false,
 			},
 			"locked": schema.BoolAttribute{
-				MarkdownDescription: "",
+				MarkdownDescription: "Whether the account is locked or not.",
 				Computed:            true,
 				Optional:            false,
 				Required:            false,
 			},
 			"bot": schema.BoolAttribute{
-				MarkdownDescription: "",
+				MarkdownDescription: "Whether the account is a bot or not.",
 				Computed:            true,
 				Optional:            false,
 				Required:            false,

internal/provider/account_data_source_test.go

@@ -1,6 +1,3 @@
-// Copyright (c) HashiCorp, Inc.
-// SPDX-License-Identifier: MPL-2.0
-
 package provider
 
 import (

internal/provider/identity_function.go

@@ -1,6 +1,3 @@
-// Copyright (c) HashiCorp, Inc.
-// SPDX-License-Identifier: MPL-2.0
-
 package provider
 
 import (

internal/provider/identity_function_test.go

@@ -1,6 +1,3 @@
-// Copyright (c) HashiCorp, Inc.
-// SPDX-License-Identifier: MPL-2.0
-
 package provider
 
 import (

internal/provider/post_resource.go

@@ -1,6 +1,3 @@
-// Copyright (c) HashiCorp, Inc.
-// SPDX-License-Identifier: MPL-2.0
-
 package provider
 
 import (
@@ -35,12 +32,13 @@ type PostResource struct {
 
 // PostResourceModel describes the resource data model.
 type PostResourceModel struct {
-	Id         types.String `tfsdk:"id"`
-	CreatedAt  types.String `tfsdk:"created_at"`
-	Account    types.String `tfsdk:"account"`
-	Content    types.String `tfsdk:"content"`
-	Visibility types.String `tfsdk:"visibility"`
-	Sensitive  types.Bool   `tfsdk:"sensitive"`
+	Id                types.String `tfsdk:"id"`
+	CreatedAt         types.String `tfsdk:"created_at"`
+	Account           types.String `tfsdk:"account"`
+	Content           types.String `tfsdk:"content"`
+	Visibility        types.String `tfsdk:"visibility"`
+	Sensitive         types.Bool   `tfsdk:"sensitive"`
+	PreserveOnDestroy types.Bool   `tfsdk:"preserve_on_destroy"`
 }
 
 func (r *PostResource) Metadata(ctx context.Context, req resource.MetadataRequest, resp *resource.MetadataResponse) {
@@ -57,13 +55,13 @@ func (r *PostResource) Schema(ctx context.Context, req resource.SchemaRequest, r
 				Computed:            true,
 				Required:            false,
 				Optional:            false,
-				MarkdownDescription: "Post identifier",
+				MarkdownDescription: "Unique identifier of the post.",
 				PlanModifiers: []planmodifier.String{
 					stringplanmodifier.UseStateForUnknown(),
 				},
 			},
 			"created_at": schema.StringAttribute{
-				MarkdownDescription: "Post creation timestamp",
+				MarkdownDescription: "Timestamp of when the post was created.",
 				Computed:            true,
 				Required:            false,
 				Optional:            false,
@@ -81,17 +79,23 @@ func (r *PostResource) Schema(ctx context.Context, req resource.SchemaRequest, r
 				},
 			},
 			"content": schema.StringAttribute{
-				MarkdownDescription: "Post content",
+				MarkdownDescription: "The content of the post.",
 				Required:            true,
 			},
 			"visibility": schema.StringAttribute{
-				MarkdownDescription: "Post visibility",
+				MarkdownDescription: "The post visibility: can be `public`, `unlisted`, `private`, or `direct`.",
 				Optional:            true,
 				Computed:            true,
 				Default:             stringdefault.StaticString("public"),
 			},
 			"sensitive": schema.BoolAttribute{
-				MarkdownDescription: "Post sensitive",
+				MarkdownDescription: "Whether the post contains sensitive content.",
+				Optional:            true,
+				Computed:            true,
+				Default:             booldefault.StaticBool(false),
+			},
+			"preserve_on_destroy": schema.BoolAttribute{
+				MarkdownDescription: "When destroyed, preserve the post on the server.",
 				Optional:            true,
 				Computed:            true,
 				Default:             booldefault.StaticBool(false),
@@ -187,6 +191,11 @@ func (r *PostResource) Read(ctx context.Context, req resource.ReadRequest, resp
 	data.Visibility = types.StringValue(post.Visibility)
 	data.Sensitive = types.BoolValue(post.Sensitive)
 
+	// During imports the `preserve_on_destroy` attribute may not be set.
+	if data.PreserveOnDestroy.IsNull() {
+		data.PreserveOnDestroy = types.BoolValue(false)
+	}
+
 	// Save updated data into Terraform state
 	resp.Diagnostics.Append(resp.State.Set(ctx, &data)...)
 }
@@ -237,10 +246,15 @@ func (r *PostResource) Delete(ctx context.Context, req resource.DeleteRequest, r
 		return
 	}
 
+	if data.PreserveOnDestroy.ValueBool() {
+		tflog.Debug(ctx, "preserve_on_destroy is enabled: preserving post on server.")
+		return
+	}
+
 	err := r.client.DeleteStatus(context.Background(), mastodon.ID(data.Id.ValueString()))
 
 	if err != nil {
-		resp.Diagnostics.AddError("Client Error", fmt.Sprintf("Unable to create post, got error: %s", err))
+		resp.Diagnostics.AddError("Client Error", fmt.Sprintf("Unable to delete post, got error: %s", err))
 		return
 	}
 

internal/provider/post_resource_test.go

@@ -1,6 +1,3 @@
-// Copyright (c) HashiCorp, Inc.
-// SPDX-License-Identifier: MPL-2.0
-
 package provider
 
 import (

internal/provider/provider.go

@@ -1,6 +1,3 @@
-// Copyright (c) HashiCorp, Inc.
-// SPDX-License-Identifier: MPL-2.0
-
 package provider
 
 import (