New Resource gitlab_project_issue

This is an initial version of this resource.
It mainly covers the most simple CRUD functions.

Additional issue API endpoints like subscriptions, todos, time
estimation, merge request and issue relations, ... are NOT yet
supported.

I believe that the state as-is in this change set already provides a
great set of value for potentially interested users.

I imagine that the main use case for this is to bootstrap a project with
some getting started / welcome issues and not to track time etc.

Refs #746

Author: timofurrer

docs/resources/project_issue.md

@@ -0,0 +1,117 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "gitlab_project_issue Resource - terraform-provider-gitlab"
+subcategory: ""
+description: |-
+  This resource allows you to create and manage GitLab Project Issues.
+  During a terraform destroy this resource will close the issue.
+  Set the deleteondestroy flag to true to delete the issue instead of closing it.
+  Experimental: while the base functionality of this resource works, it may be subject to minor change.
+  Upstream API: GitLab API docs https://docs.gitlab.com/ee/api/issues.html
+---
+
+# gitlab_project_issue (Resource)
+
+This resource allows you to create and manage GitLab Project Issues.
+
+During a terraform destroy this resource will close the issue.
+Set the delete_on_destroy flag to true to delete the issue instead of closing it.
+
+**Experimental**: while the base functionality of this resource works, it may be subject to minor change.
+
+**Upstream API:** [GitLab API docs](https://docs.gitlab.com/ee/api/issues.html)
+
+## Example Usage
+
+```terraform
+resource "gitlab_project" "foo" {
+  name             = "example project"
+  description      = "Lorem Ipsum"
+  visibility_level = "public"
+}
+
+resource "gitlab_project_issue" "welcome_issue" {
+  project           = gitlab_project.foo.id
+  title             = "Welcome!"
+  description       = <<EOT
+  Welcome to the ${gitlab_project.foo.name} project!
+
+  EOT
+  discussion_locked = true
+}
+
+output "welcome_issue_web_url" {
+  value = data.gitlab_project_issue.web_url
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- **project** (String) The name or ID of the project.
+- **title** (String) The title of the issue.
+
+### Optional
+
+- **assignee_ids** (Set of Number) The IDs of the users to assign the issue to.
+- **closed_at** (String) When the issue was closed. Date time string, ISO 8601 formatted, for example 2016-03-11T03:45:40Z.
+- **closed_by_user_id** (Number) The ID of the user that closed the issue. Use `gitlab_user` data source to get more information about the user.
+- **confidential** (Boolean) Set an issue to be confidential.
+- **created_at** (String) When the issue was created. Date time string, ISO 8601 formatted, for example 2016-03-11T03:45:40Z. Requires administrator or project/group owner rights.
+- **delete_on_destroy** (Boolean) Whether the issue is deleted instead of closed during destroy.
+- **description** (String) The description of an issue. Limited to 1,048,576 characters.
+- **discussion_locked** (Boolean) Whether the issue is locked for discussions or not.
+- **discussion_to_resolve** (String) The ID of a discussion to resolve. This fills out the issue with a default description and mark the discussion as resolved. Use in combination with merge_request_to_resolve_discussions_of.
+- **due_date** (String) The due date. Date time string in the format YYYY-MM-DD, for example 2016-03-11.
+**Note:** removing a due date is currently not supported, see https://github.com/xanzy/go-gitlab/issues/1384 for details.
+- **epic_issue_id** (Number) The ID of the epic issue.
+- **human_time_estimate** (String) The human-readable time estimate of the issue.
+- **human_total_time_spent** (String) The human-readable total time spent of the issue.
+- **id** (String) The ID of this resource.
+- **iid** (Number) The internal ID of the project's issue.
+- **issue_type** (String) The type of issue. Valid values are: `issue`, `incident`, `test_case`.
+- **labels** (Set of String) The labels of an issue.
+- **links** (Map of String) The links of the issue.
+- **merge_request_to_resolve_discussions_of** (Number) The IID of a merge request in which to resolve all issues. This fills out the issue with a default description and mark all discussions as resolved. When passing a description or title, these values take precedence over the default values.
+- **milestone_id** (Number) The global ID of a milestone to assign issue. To find the milestone_id associated with a milestone, view an issue with the milestone assigned and use the API to retrieve the issue's details.
+- **references** (Map of String) The references of the issue.
+- **state** (String) The state of the issue. Valid values are: `opened`, `closed`.
+- **task_completion_status** (Block List, Max: 1) The task completion status. It's always a one element list. (see [below for nested schema](#nestedblock--task_completion_status))
+- **time_estimate** (Number) The time estimate of the issue.
+- **total_time_spent** (Number) The total time spent of the issue.
+- **updated_at** (String) When the issue was updated. Date time string, ISO 8601 formatted, for example 2016-03-11T03:45:40Z.
+- **weight** (Number) The weight of the issue. Valid values are greater than or equal to 0.
+
+### Read-Only
+
+- **author_id** (Number) The ID of the author of the issue. Use `gitlab_user` data source to get more information about the user.
+- **downvotes** (Number) The number of downvotes the issue has received.
+- **epic_id** (Number) ID of the epic to add the issue to. Valid values are greater than or equal to 0.
+- **external_id** (String) The external ID of the issue.
+- **issue_id** (Number) The instance-wide ID of the issue.
+- **issue_link_id** (Number) The ID of the issue link.
+- **merge_requests_count** (Number) The number of merge requests associated with the issue.
+- **moved_to_id** (Number) The ID of the issue that was moved to.
+- **subscribed** (Boolean) Whether the authenticated user is subscribed to the issue or not.
+- **upvotes** (Number) The number of upvotes the issue has received.
+- **user_notes_count** (Number) The number of user notes on the issue.
+- **web_url** (String) The web URL of the issue.
+
+<a id="nestedblock--task_completion_status"></a>
+### Nested Schema for `task_completion_status`
+
+Optional:
+
+- **completed_count** (Number) The number of tasks that are completed.
+- **count** (Number) The number of tasks.
+
+## Import
+
+Import is supported using the following syntax:
+
+```shell
+# You can import this resource with an id made up of `{project-id}:{issue-id}`, e.g.
+terraform import gitlab_project_issue.welcome_issue 42:1
+```

examples/resources/gitlab_project_issue/import.sh

@@ -0,0 +1,2 @@
+# You can import this resource with an id made up of `{project-id}:{issue-id}`, e.g.
+terraform import gitlab_project_issue.welcome_issue 42:1

examples/resources/gitlab_project_issue/resource.tf

@@ -0,0 +1,19 @@
+resource "gitlab_project" "foo" {
+  name             = "example project"
+  description      = "Lorem Ipsum"
+  visibility_level = "public"
+}
+
+resource "gitlab_project_issue" "welcome_issue" {
+  project           = gitlab_project.foo.id
+  title             = "Welcome!"
+  description       = <<EOT
+  Welcome to the ${gitlab_project.foo.name} project!
+
+  EOT
+  discussion_locked = true
+}
+
+output "welcome_issue_web_url" {
+  value = data.gitlab_project_issue.web_url
+}

internal/provider/helper_test.go

@@ -5,10 +5,12 @@ import (
 	"os"
 	"strings"
 	"testing"
+	"time"
 
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/acctest"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/terraform"
 	"github.com/onsi/gomega"
 	"github.com/xanzy/go-gitlab"
 )
@@ -240,6 +242,25 @@ func testAccAddProjectMembers(t *testing.T, pid interface{}, users []*gitlab.Use
 	}
 }
 
+func testAccCreateProjectIssues(t *testing.T, pid interface{}, n int) []*gitlab.Issue {
+	t.Helper()
+
+	dueDate := gitlab.ISOTime(time.Now().Add(time.Hour))
+	var issues []*gitlab.Issue
+	for i := 0; i < n; i++ {
+		issue, _, err := testGitlabClient.Issues.CreateIssue(pid, &gitlab.CreateIssueOptions{
+			Title:       gitlab.String(fmt.Sprintf("Issue %d", i)),
+			Description: gitlab.String(fmt.Sprintf("Description %d", i)),
+			DueDate:     &dueDate,
+		})
+		if err != nil {
+			t.Fatalf("could not create test issue: %v", err)
+		}
+		issues = append(issues, issue)
+	}
+	return issues
+}
+
 // testAccAddGroupMembers is a test helper for adding users as members of a group.
 // It assumes the group will be destroyed at the end of the test and will not cleanup members.
 func testAccAddGroupMembers(t *testing.T, gid interface{}, users []*gitlab.User) {
@@ -256,6 +277,22 @@ func testAccAddGroupMembers(t *testing.T, gid interface{}, users []*gitlab.User)
 	}
 }
 
+func testAccAddProjectMilestone(t *testing.T, pid interface{}) *gitlab.Milestone {
+	t.Helper()
+
+	milestone, _, err := testGitlabClient.Milestones.CreateMilestone(pid, &gitlab.CreateMilestoneOptions{Title: gitlab.String("Test Milestone")})
+	if err != nil {
+		t.Fatalf("failed to create milestone during test for project %v: %v", pid, err)
+	}
+	t.Cleanup(func() {
+		_, err := testGitlabClient.Milestones.DeleteMilestone(pid, milestone.ID)
+		if err != nil {
+			t.Fatalf("failed to delete milestone %d during test for project %v: %v", milestone.ID, pid, err)
+		}
+	})
+	return milestone
+}
+
 // testAccGitlabProjectContext encapsulates a GitLab client and test project to be used during an
 // acceptance test.
 type testAccGitlabProjectContext struct {
@@ -292,3 +329,11 @@ func testAccGitlabProjectStart(t *testing.T) testAccGitlabProjectContext {
 		project: project,
 	}
 }
+
+// testCheckResourceAttrLazy works like resource.TestCheckResourceAttr, but lazy evaluates the value parameter.
+// See also: resource.TestCheckResourceAttrPtr.
+func testCheckResourceAttrLazy(name string, key string, value func() string) resource.TestCheckFunc {
+	return func(s *terraform.State) error {
+		return resource.TestCheckResourceAttr(name, key, value())(s)
+	}
+}