Merge pull request #1118 from PatrickRice-KSC/add_current_user_data_source

timofurrer · web-flow · commit 8be3fdeacc95 · 2022-06-11T18:42:02.000+02:00
Add current_user data source
diff --git a/docs/data-sources/current_user.md b/docs/data-sources/current_user.md
@@ -0,0 +1,37 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "gitlab_current_user Data Source - terraform-provider-gitlab"
+subcategory: ""
+description: |-
+  The gitlab_current_user data source allows details of the current user (determined by token provider attribute) to be retrieved.
+  Upstream API: GitLab GraphQL API docs https://docs.gitlab.com/ee/api/graphql/reference/index.html#querycurrentuser
+---
+
+# gitlab_current_user (Data Source)
+
+The `gitlab_current_user` data source allows details of the current user (determined by `token` provider attribute) to be retrieved.
+
+**Upstream API**: [GitLab GraphQL API docs](https://docs.gitlab.com/ee/api/graphql/reference/index.html#querycurrentuser)
+
+## Example Usage
+
+```terraform
+data "gitlab_current_user" "example" {}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Read-Only
+
+- `bot` (Boolean) Indicates if the user is a bot.
+- `global_id` (String) Global ID of the user. This is in the form of a GraphQL globally unique ID.
+- `global_namespace_id` (String) Personal namespace of the user. This is in the form of a GraphQL globally unique ID.
+- `group_count` (Number) Group count for the user.
+- `id` (String) ID of the user.
+- `name` (String) Human-readable name of the user. Returns **** if the user is a project bot and the requester does not have permission to view the project.
+- `namespace_id` (String) Personal namespace of the user.
+- `public_email` (String) User’s public email.
+- `username` (String) Username of the user. Unique within this instance of GitLab.
+
+
diff --git a/examples/data-sources/gitlab_current_user/data-source.tf b/examples/data-sources/gitlab_current_user/data-source.tf
@@ -0,0 +1 @@
+data "gitlab_current_user" "example" {}
diff --git a/internal/provider/data_source_gitlab_current_user.go b/internal/provider/data_source_gitlab_current_user.go
@@ -0,0 +1,123 @@
+package provider
+
+import (
+	"context"
+	"fmt"
+	"log"
+
+	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
+	"github.com/xanzy/go-gitlab"
+)
+
+var _ = registerDataSource("gitlab_current_user", func() *schema.Resource {
+	return &schema.Resource{
+		Description: `The ` + "`gitlab_current_user`" + ` data source allows details of the current user (determined by ` + "`token`" + ` provider attribute) to be retrieved.
+
+**Upstream API**: [GitLab GraphQL API docs](https://docs.gitlab.com/ee/api/graphql/reference/index.html#querycurrentuser)`,
+
+		ReadContext: dataSourceGitlabCurrentUserRead,
+		Schema: map[string]*schema.Schema{
+			"id": {
+				Description: "ID of the user.",
+				Type:        schema.TypeString,
+				Computed:    true,
+			},
+			"global_id": {
+				Description: "Global ID of the user. This is in the form of a GraphQL globally unique ID.",
+				Type:        schema.TypeString,
+				Computed:    true,
+			},
+			"username": {
+				Description: "Username of the user. Unique within this instance of GitLab.",
+				Type:        schema.TypeString,
+				Computed:    true,
+			},
+			"name": {
+				Description: "Human-readable name of the user. Returns **** if the user is a project bot and the requester does not have permission to view the project.",
+				Type:        schema.TypeString,
+				Computed:    true,
+			},
+			"bot": {
+				Description: "Indicates if the user is a bot.",
+				Type:        schema.TypeBool,
+				Computed:    true,
+			},
+			"group_count": {
+				Description: "Group count for the user.",
+				Type:        schema.TypeInt,
+				Computed:    true,
+			},
+			"namespace_id": {
+				Description: "Personal namespace of the user.",
+				Type:        schema.TypeString,
+				Computed:    true,
+			},
+			"global_namespace_id": {
+				Description: "Personal namespace of the user. This is in the form of a GraphQL globally unique ID.",
+				Type:        schema.TypeString,
+				Computed:    true,
+			},
+			"public_email": {
+				Description: "User’s public email.",
+				Type:        schema.TypeString,
+				Computed:    true,
+			},
+		},
+	}
+})
+
+func dataSourceGitlabCurrentUserRead(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
+	client := meta.(*gitlab.Client)
+
+	query := GraphQLQuery{
+		`query {currentUser {name, bot, groupCount, id, namespace{id}, publicEmail, username}}`,
+	}
+	log.Printf("[DEBUG] executing GraphQL Query %s to retrieve current user", query.Query)
+
+	var response CurrentUserResponse
+	if _, err := SendGraphQLRequest(ctx, client, query, &response); err != nil {
+		return diag.FromErr(err)
+	}
+
+	userID, err := extractIIDFromGlobalID(response.Data.CurrentUser.ID)
+	if err != nil {
+		return diag.FromErr(err)
+	}
+
+	namespaceID, err := extractIIDFromGlobalID(response.Data.CurrentUser.Namespace.ID)
+	if err != nil {
+		return diag.FromErr(err)
+	}
+
+	d.SetId(fmt.Sprintf("%d", userID))
+	d.Set("global_id", response.Data.CurrentUser.ID)
+	d.Set("username", response.Data.CurrentUser.Username)
+	d.Set("name", response.Data.CurrentUser.Name)
+	d.Set("bot", response.Data.CurrentUser.Bot)
+	d.Set("group_count", response.Data.CurrentUser.GroupCount)
+	d.Set("namespace_id", fmt.Sprintf("%d", namespaceID))
+	d.Set("global_namespace_id", response.Data.CurrentUser.Namespace.ID)
+	d.Set("public_email", response.Data.CurrentUser.PublicEmail)
+
+	return nil
+}
+
+// Struct representing current user based on the input API token
+type CurrentUserResponse struct {
+	Data struct {
+		CurrentUser GraphQLUser `json:"currentUser"`
+	} `json:"data"`
+}
+
+type GraphQLUser struct {
+	Name       string `json:"name"`
+	Bot        bool   `json:"bot"`
+	GroupCount int    `json:"groupCount"`
+	ID         string `json:"id"` // This is purposefully a string, as in some APIs it comes back as a globally unique ID
+	Namespace  struct {
+		ID string `json:"id"`
+	} `json:"namespace"`
+	PublicEmail string `json:"publicEmail"`
+	Username    string `json:"username"`
+}
diff --git a/internal/provider/data_source_gitlab_current_user_test.go b/internal/provider/data_source_gitlab_current_user_test.go
@@ -0,0 +1,46 @@
+//go:build acceptance
+// +build acceptance
+
+package provider
+
+import (
+	"testing"
+
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource"
+	"github.com/xanzy/go-gitlab"
+)
+
+func TestAccDataSourceGitlabCurrentUser_basic(t *testing.T) {
+	//The root user has no public email by default, set the public email so it shows up properly.
+	_, _, _ = testGitlabClient.Users.ModifyUser(1, &gitlab.ModifyUserOptions{
+		// The public email MUST match an email on record for the user, or it gets a bad request.
+		PublicEmail: gitlab.String("admin@example.com"),
+	})
+
+	t.Cleanup(func() {
+		_, _, _ = testGitlabClient.Users.ModifyUser(1, &gitlab.ModifyUserOptions{
+			//Set back to the empty state on test completion.
+			PublicEmail: gitlab.String(""),
+		})
+	})
+
+	resource.Test(t, resource.TestCase{
+		ProviderFactories: providerFactories,
+		Steps: []resource.TestStep{
+			{
+				Config: `data "gitlab_current_user" "this" {}`,
+				Check: resource.ComposeTestCheckFunc(
+					resource.TestCheckResourceAttr("data.gitlab_current_user.this", "id", "1"),
+					resource.TestCheckResourceAttr("data.gitlab_current_user.this", "global_id", "gid://gitlab/User/1"),
+					resource.TestCheckResourceAttr("data.gitlab_current_user.this", "name", "Administrator"),
+					resource.TestCheckResourceAttr("data.gitlab_current_user.this", "username", "root"),
+					resource.TestCheckResourceAttr("data.gitlab_current_user.this", "bot", "false"),
+					resource.TestCheckResourceAttr("data.gitlab_current_user.this", "group_count", "2"),
+					resource.TestCheckResourceAttr("data.gitlab_current_user.this", "namespace_id", "1"),
+					resource.TestCheckResourceAttr("data.gitlab_current_user.this", "global_namespace_id", "gid://gitlab/Namespaces::UserNamespace/1"),
+					resource.TestCheckResourceAttr("data.gitlab_current_user.this", "public_email", "admin@example.com"),
+				),
+			},
+		},
+	})
+}
diff --git a/internal/provider/graphql_helper.go b/internal/provider/graphql_helper.go
@@ -0,0 +1,26 @@
+package provider
+
+import (
+	"context"
+
+	"github.com/xanzy/go-gitlab"
+)
+
+// Helper method for modifying client requests appropriately for sending a GraphQL call instead of a REST call.
+func SendGraphQLRequest(ctx context.Context, client *gitlab.Client, query GraphQLQuery, response interface{}) (interface{}, error) {
+	request, err := client.NewRequest("POST", "", query, nil)
+	if err != nil {
+		return nil, err
+	}
+	// Overwrite the path of the existing request, as otherwise the go-gitlab client appends /api/v4 instead.
+	request.URL.Path = "/api/graphql"
+	if _, err = client.Do(request, response); err != nil {
+		return nil, err
+	}
+	return response, nil
+}
+
+// Represents a GraphQL call to the API. All GraphQL calls are a string passed to the "query" parameter, so they should be included here.
+type GraphQLQuery struct {
+	Query string `json:"query"`
+}
diff --git a/internal/provider/graphql_helper_test.go b/internal/provider/graphql_helper_test.go
@@ -0,0 +1,28 @@
+//go:build acceptance
+// +build acceptance
+
+package provider
+
+import (
+	"context"
+	"log"
+	"testing"
+)
+
+func TestAcc_GraphQL_basic(t *testing.T) {
+
+	query := GraphQLQuery{
+		`query {currentUser {name, bot, gitpodEnabled, groupCount, id, namespace{id}, publicEmail, username}}`,
+	}
+
+	var response CurrentUserResponse
+	_, err := SendGraphQLRequest(context.Background(), testGitlabClient, query, &response)
+	if err != nil {
+		log.Println(err)
+		t.Fail()
+	}
+
+	if response.Data.CurrentUser.Name != "Administrator" {
+		t.Fail()
+	}
+}
diff --git a/internal/provider/util.go b/internal/provider/util.go
@@ -15,6 +15,20 @@ import (
 	"github.com/xanzy/go-gitlab"
 )
 
+// extractIIDFromGlobalID extracts the internal model ID from a global GraphQL ID.
+//
+// e.g. 'gid://gitlab/User/1' -> 1 or 'gid://gitlab/Project/42' -> 42
+//
+// see https://docs.gitlab.com/ee/development/api_graphql_styleguide.html#global-ids
+func extractIIDFromGlobalID(globalID string) (int, error) {
+	parts := strings.Split(globalID, "/")
+	iid, err := strconv.Atoi(parts[len(parts)-1])
+	if err != nil {
+		return 0, fmt.Errorf("unable to extract iid from global id %q. Was looking for an integer after the last slash (/).", globalID)
+	}
+	return iid, nil
+}
+
 func renderValueListForDocs(values []string) string {
 	inlineCodeValues := make([]string, 0, len(values))
 	for _, v := range values {
diff --git a/internal/provider/util_test.go b/internal/provider/util_test.go
@@ -6,6 +6,56 @@ import (
 	gitlab "github.com/xanzy/go-gitlab"
 )
 
+func TestGitlab_extractIIDFromGlobalID(t *testing.T) {
+	cases := []struct {
+		GlobalID string
+		IID      int
+	}{
+		{
+			GlobalID: "gid://gitlab/User/1",
+			IID:      1,
+		},
+		{
+			GlobalID: "gid://gitlab/Namespaces::UserNamespace/1000",
+			IID:      1000,
+		},
+	}
+
+	for _, tc := range cases {
+		iid, err := extractIIDFromGlobalID(tc.GlobalID)
+		if err != nil {
+			t.Fatalf("expected valid global id, got %q: %v", tc.GlobalID, err)
+		}
+
+		if iid != tc.IID {
+			t.Fatalf("got %v expected %v", iid, tc.IID)
+		}
+	}
+}
+
+func TestGitlab_extractIIDFromGlobalID_invalidGlobalID(t *testing.T) {
+	cases := []struct {
+		GlobalID string
+	}{
+		{
+			GlobalID: "",
+		},
+		{
+			GlobalID: "gid://gitlab/User/",
+		},
+		{
+			GlobalID: "gid://gitlab/Namespaces::UserNamespace",
+		},
+	}
+
+	for _, tc := range cases {
+		iid, err := extractIIDFromGlobalID(tc.GlobalID)
+		if err == nil {
+			t.Fatalf("expected invalid global id, got id %q instead from global id %q", iid, tc.GlobalID)
+		}
+	}
+}
+
 func TestGitlab_visbilityHelpers(t *testing.T) {
 	cases := []struct {
 		String string

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+data "gitlab_current_user" "example" {}`