fix: add/update/fix acceptance tests (#16)

Author: SignalRichard

.github/workflows/test.yml

@@ -0,0 +1,43 @@
+name: test
+
+on:
+  pull_request:
+  push:
+    branches:
+    - "*"
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+defaults:
+  run:
+    shell: pwsh
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout
+      uses: actions/checkout@ac593985615ec2ede58e132d2e21d2b1cbd6127c # v3.3.0
+    - name: Unshallow
+      run: git fetch --prune --unshallow
+    - name: Setup Go
+      uses: actions/setup-go@6edd4406fa81c3da01a34fa6f6343087c207a568 # v3.5.0
+      with:
+        go-version-file: 'go.mod'
+        cache: true
+    - id: terraform_version
+      name: Terraform Version
+      run: ./build/scripts/Get-TerraformVersion.ps1
+    - name: Setup Terraform
+      uses: hashicorp/setup-terraform@v3
+      with:
+        terraform_version: ${{ steps.terraform_version.outputs.value }}
+    - name: Run Acceptance Tests
+      run: |
+        $env:TF_ACC = 1
+        go test -v ./...
+      env:
+        STACK_OVERFLOW_ACCESS_TOKEN: ${{ secrets.STACK_OVERFLOW_ACCESS_TOKEN }}
+        STACK_OVERFLOW_API_URL: ${{ secrets.STACK_OVERFLOW_API_URL }}

.terraform-version

@@ -0,0 +1 @@
+1.12.2

CONTRIBUTING.md

@@ -0,0 +1,60 @@
+# Overview
+
+This file will detail instructions on how to develop the Stack Overflow Terraform provider plugin locally.
+
+The original [legacy] documentation used for building custom Terraform providers can be found here:
+
+[https://www.hashicorp.com/en/blog/writing-custom-terraform-providers](https://www.hashicorp.com/en/blog/writing-custom-terraform-providers)
+
+## Getting started
+
+Install Go, ensure that the version you are using meets or exceeds the version listed in the [go.mod](./go.mod) file.
+
+**Build:**
+
+> Test the built executable after building to ensure that it runs correctly.
+
+*Windows:*
+
+```
+go build -o terraform-provider-stackoverflow.exe
+./terraform-provider-stackoverflow.exe
+```
+
+*Linux*
+
+```
+go build -o terraform-provider-stackoverflow
+./terraform-provider-stackoverflow
+```
+
+## Local Development Override
+
+To use the locally built provider, override the `terraform.rc` (Windows) or `.terraformrc` (Linux) file with the following:
+
+`terraform.rc`:
+```
+provider_installation {
+  dev_overrides {
+    "StackExchange/stackoverflow" = "~/source/GitHub/StackExchange/terraform-provider-stackoverflow"
+  }
+
+  direct {}
+}
+```
+
+> Note, make sure the provider path matches where your actual repository is located.
+> The `terraform.rc` file is located in the user's `%APPDATA%` directory on Windows and `.terraformrc` file is located in the user's home directory (`~`) on Linux
+
+Once you have updated the `terraform.rc` file, you can setup a local testing repository and reference the Stack Overflow Terraform provider.  You _DO NOT_ need to run `terraform init` when using local development provider overrides!  Also, if you encounter any errors, ensure that you remove your `.terraform` folder and `.terraform.lock.hcl` to prevent any version conflicts.
+
+## Acceptance Tests
+
+Acceptence tests (or integration tests) are automatically run from the [test.yml](./github/workflows/test.yml) GitHub Actions Workflow for all pushes and pull requests against a developmentment Stack Overflow Enterprise (SOE) instance.  This instance needs to have the following configurations applied to ensure that the tests do not fail quality control checks that prevent duplicated content.
+
+* Disable content length checking, `QualityChecks.Questions.Rejections.QualityThreshold`: `1`
+* Disable duplicate content checking, `Questions.Testing.EnableDuplicateCheckForQuestions`: `False`
+
+SOE site settings can be accessed via the `/developer/site-settings` route.  Additional details can be found on the documentation help site: [https://stackoverflowteams.help/en/articles/9859814-question-quality-and-duplicate-checks](https://stackoverflowteams.help/en/articles/9859814-question-quality-and-duplicate-checks)
+
+> For details on setting up authentication, check the [docs/index.md#authentication-and-configuration](./docs/index.md#authentication-and-configuration) section.

build/scripts/Get-TerraformVersion.ps1

@@ -0,0 +1,5 @@
+$terraformVersion = (Get-Content -Path '.terraform-version').Trim()
+
+if ($null -ne $env:CI) {
+    Write-Output -InputObject "value=$terraformVersion" >> $env:GITHUB_OUTPUT
+}

docs/index.md

@@ -98,3 +98,4 @@ The migration steps should be as follows:
 1. Remove all usage of the `filter` field from resources
 1. Remove usage of the `default_tags` field from the provider (users may opt to use a local variable with default tags and then subsequently merge that list with each resource's tag values)
 1. Remove usage of the `team_name` field from the provider.  Users should set the `base_url` field or set the `STACK_OVERFLOW_API_URL` environment variable instead.  For example, if the previous configuration only set the `team_name` field to the value `myteam`, the `base_url` field should now be set to `https://api.stackoverflowteams.com/v3/teams/myteam/`
+1. Update all `stackoveflow_article` `article_type` fields to one of the following: [`knowledgeArticle`, `announcement`, `policy`, `howToGuide`]

stackoverflow/client/model_answer.go

@@ -9,4 +9,5 @@ type Answer[T string | Tag] struct {
 	QuestionID   int    `json:"questionId"`
 	Title        string `json:"title"`
 	Tags         []T    `json:"tags"`
+	IsDeleted    bool   `json:"isDeleted"`
 }

stackoverflow/client/model_article.go

@@ -7,4 +7,5 @@ type Article[T string | Tag] struct {
 	BodyMarkdown string `json:"bodyMarkdown"`
 	Title        string `json:"title"`
 	Tags         []T    `json:"tags"`
+	IsDeleted    bool   `json:"isDeleted"`
 }

stackoverflow/client/model_collection.go

@@ -6,4 +6,5 @@ type Collection struct {
 	ContentIds  []int               `json:"contentIds"`
 	Description string              `json:"description"`
 	Title       string              `json:"title"`
+	IsDeleted   bool                `json:"isDeleted"`
 }

stackoverflow/client/model_question.go

@@ -7,4 +7,5 @@ type Question[T string | Tag] struct {
 	Preview      bool   `json:"preview"`
 	Title        string `json:"title"`
 	Tags         []T    `json:"tags"`
+	IsDeleted    bool   `json:"isDeleted"`
 }

stackoverflow/resource_answer_test.go

@@ -10,56 +10,82 @@ import (
 	"github.com/hashicorp/terraform-plugin-sdk/v2/terraform"
 )
 
-func TestStackOverflowAnswer(t *testing.T) {
+func TestAccStackOverflowAnswer(t *testing.T) {
+	resourceType := "stackoverflow_answer"
+	resourceName := "test"
+	resourceIdentifier := fmt.Sprintf("%s.%s", resourceType, resourceName)
+
 	resource.Test(t, resource.TestCase{
-		PreCheck:  func() { testAccPreCheck(t) },
-		Providers: testAccProviders,
+		PreCheck:     func() { testAccPreCheck(t) },
+		Providers:    testAccProviders,
+		CheckDestroy: testAccStackOverflowAnswerCheckDestroy(resourceIdentifier),
 		Steps: []resource.TestStep{
 			{
-				Config: testStackOverflowAnswerConfig(),
+				Config: testAccStackOverflowAnswerConfig(resourceType, resourceName, ""),
+				Check: resource.ComposeTestCheckFunc(
+					testAccStackOverflowAnswerCheckExists(resourceIdentifier),
+				),
+			},
+			{
+				Config: testAccStackOverflowAnswerConfig(resourceType, resourceName, " Updated"),
 				Check: resource.ComposeTestCheckFunc(
-					testStackOverflowAnswerExists("stackoverflow_answer.test"),
+					testAccStackOverflowAnswerCheckExists(resourceIdentifier),
 				),
 			},
 		},
 	})
 }
 
-func testStackOverflowAnswerConfig() string {
-	return `resource "stackoverflow_answer" "test" {
-		question_id = 58
-		body_markdown = "Unit test."
-	}`
+func testAccStackOverflowAnswerConfig(resourceType, resourceName, update string) string {
+	return fmt.Sprintf(`resource "stackoverflow_question" "test" {
+		title = "How do I run the Terraform Provider Acceptance Tests?"
+		body_markdown = "I want to run the Terraform Provider for Stack Overflow acceptance tests, how do I do that?"
+		tags = ["test"]
+	}
+	resource "%s" "%s" {
+		question_id = stackoverflow_question.test.id
+		body_markdown = "Unit test%s."
+	}`, resourceType, resourceName, update)
 }
 
-func testStackOverflowAnswerDestroy(s *terraform.State) error {
-	c := testAccProvider.Meta().(*so.Client)
+func testAccStackOverflowAnswerCheckDestroy(resourceIdentifier string) resource.TestCheckFunc {
+	return func(s *terraform.State) error {
+		resourceState, found := s.RootModule().Resources[resourceIdentifier]
 
-	for _, resource := range s.RootModule().Resources {
-		if resource.Type != "stackoverflow_answer" {
-			continue
+		if !found {
+			return fmt.Errorf("No resource found with id %s", resourceIdentifier)
 		}
 
-		answerID, err := strconv.Atoi(resource.Primary.ID)
+		if resourceState.Primary.ID == "" {
+			return fmt.Errorf("Resource with ID is empty for %s", resourceIdentifier)
+		}
+
+		answerID, err := strconv.Atoi(resourceState.Primary.ID)
 		if err != nil {
 			return err
 		}
 
-		questionID, err := strconv.Atoi(resource.Primary.Attributes["question_id"])
+		questionID, err := strconv.Atoi(resourceState.Primary.Attributes["question_id"])
 		if err != nil {
 			return err
 		}
 
-		err = c.DeleteAnswer(questionID, answerID)
+		c := testAccProvider.Meta().(*so.Client)
+		answer, err := c.GetAnswer(&questionID, &answerID)
+
 		if err != nil {
 			return err
 		}
-	}
 
-	return nil
+		if answer != nil && !answer.IsDeleted {
+			return fmt.Errorf("Resource still exists for %s", resourceIdentifier)
+		}
+
+		return nil
+	}
 }
 
-func testStackOverflowAnswerExists(n string) resource.TestCheckFunc {
+func testAccStackOverflowAnswerCheckExists(n string) resource.TestCheckFunc {
 	return func(s *terraform.State) error {
 		resource, ok := s.RootModule().Resources[n]