datasource/gitlab_current_user: Separate global id from iid for interoperability with other resources

Author: timofurrer

docs/data-sources/current_user.md

@@ -25,10 +25,12 @@ data "gitlab_current_user" "example" {}
 ### 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. This is in the form of a GraphQL globally unique ID.
+- `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. This is in the form of a GraphQL globally unique ID.
+- `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.
 

internal/provider/data_source_gitlab_current_user.go

@@ -2,6 +2,7 @@ package provider
 
 import (
 	"context"
+	"fmt"
 	"log"
 
 	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
@@ -18,7 +19,12 @@ var _ = registerDataSource("gitlab_current_user", func() *schema.Resource {
 		ReadContext: dataSourceGitlabCurrentUserRead,
 		Schema: map[string]*schema.Schema{
 			"id": {
-				Description: "ID of the user. This is in the form of a GraphQL globally unique 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,
 			},
@@ -43,6 +49,11 @@ var _ = registerDataSource("gitlab_current_user", func() *schema.Resource {
 				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,
@@ -69,12 +80,24 @@ func dataSourceGitlabCurrentUserRead(ctx context.Context, d *schema.ResourceData
 		return diag.FromErr(err)
 	}
 
-	d.SetId(response.Data.CurrentUser.ID)
+	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", response.Data.CurrentUser.Namespace.ID)
+	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

internal/provider/data_source_gitlab_current_user_test.go

@@ -30,12 +30,14 @@ func TestAccDataSourceGitlabCurrentUser_basic(t *testing.T) {
 			{
 				Config: `data "gitlab_current_user" "this" {}`,
 				Check: resource.ComposeTestCheckFunc(
-					resource.TestCheckResourceAttr("data.gitlab_current_user.this", "id", "gid://gitlab/User/1"),
+					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", "gid://gitlab/Namespaces::UserNamespace/1"),
+					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", "[email protected]"),
 				),
 			},

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 {

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