From 2d594a9355b7658562acda2a62df7d0fb99cdc4e Mon Sep 17 00:00:00 2001 From: dgomez04 Date: Tue, 17 Sep 2024 15:57:19 -0600 Subject: [PATCH] #3468: added 'user_name_contains' attribute to data_users.go to allow filtering by userName, and added additional test cases on data_users_test.go --- scim/data_users.go | 17 ++++- scim/data_users_test.go | 136 ++++++++++++++++++++++++++++++++++++++-- 2 files changed, 147 insertions(+), 6 deletions(-) diff --git a/scim/data_users.go b/scim/data_users.go index 576ed2ebb8..9c1b3783cf 100755 --- a/scim/data_users.go +++ b/scim/data_users.go @@ -19,6 +19,7 @@ func DataSourceDataUsers() common.Resource { type DataUsers struct { DisplayNameContains string `json:"display_name_contains,omitempty" tf:"computed"` + UserNameContains string `json:"user_name_contains,omitempty" tf:"computed"` Users []UserInfo `json:"users,omitempty" tf:"computed"` } @@ -27,7 +28,13 @@ func DataSourceDataUsers() common.Resource { Attributes: "id,userName,displayName", } - if data.DisplayNameContains != "" { + if data.DisplayNameContains != "" && data.UserNameContains != "" { + return fmt.Errorf("exactly one of display_name_contains or user_name_contains should be specified, not both") + } + + if data.UserNameContains != "" { + listRequest.Filter = fmt.Sprintf("userName co \"%s\"", data.UserNameContains) + } else if data.DisplayNameContains != "" { listRequest.Filter = fmt.Sprintf("displayName co \"%s\"", data.DisplayNameContains) } @@ -38,7 +45,13 @@ func DataSourceDataUsers() common.Resource { } if len(userList) == 0 { - return fmt.Errorf("cannot find users with display name containing %s", data.DisplayNameContains) + if data.DisplayNameContains != "" { + return fmt.Errorf("cannot find users with display name containing %s", data.DisplayNameContains) + } else if data.UserNameContains != "" { + return fmt.Errorf("cannot find users with username containing %s", data.UserNameContains) + } else { + return fmt.Errorf("no users found") + } } var users []UserInfo diff --git a/scim/data_users_test.go b/scim/data_users_test.go index 13fecdc47e..5c19f8342c 100755 --- a/scim/data_users_test.go +++ b/scim/data_users_test.go @@ -1,6 +1,7 @@ package scim import ( + "fmt" "testing" "github.com/databricks/databricks-sdk-go/experimental/mocks" @@ -9,7 +10,7 @@ import ( "github.com/stretchr/testify/mock" ) -func TestDataSourceDataUsers(t *testing.T) { +func TestDataSourceDataUsers_DisplayNameContains(t *testing.T) { qa.ResourceFixture{ MockAccountClientFunc: func(m *mocks.MockAccountClient) { e := m.GetMockAccountUsersAPI() @@ -49,12 +50,139 @@ func TestDataSourceDataUsers(t *testing.T) { }) } -func TestCatalogsData_Error(t *testing.T) { +func TestDataSourceDataUsers_UserNameContains(t *testing.T) { qa.ResourceFixture{ - Fixtures: qa.HTTPFailures, + MockAccountClientFunc: func(m *mocks.MockAccountClient) { + e := m.GetMockAccountUsersAPI() + e.On("ListAll", + mock.Anything, + mock.MatchedBy(func(req iam.ListAccountUsersRequest) bool { + return req.Filter == `userName co "testuser"` && + req.Attributes == "id,userName,displayName" + })).Return([]iam.User{ + { + Id: "123", + UserName: "testuser@example.com", + DisplayName: "testuser", + }, + { + Id: "456", + UserName: "testuser2@example.com", + DisplayName: "testuser2", + }, + }, nil) + }, + Resource: DataSourceDataUsers(), + Read: true, + NonWritable: true, + ID: "_", + HCL: ` + user_name_contains = "testuser" + `, + }.ApplyAndExpectData(t, map[string]any{ + "users.#": 2, + "users.0.id": "123", + "users.0.user_name": "testuser@example.com", + "users.0.display_name": "testuser", + "users.1.id": "456", + "users.1.user_name": "testuser2@example.com", + "users.1.display_name": "testuser2", + }) +} + +func TestDataSourceDataUsers_BothFiltersSpecified(t *testing.T) { + qa.ResourceFixture{ + Resource: DataSourceDataUsers(), + Read: true, + NonWritable: true, + ID: "_", + HCL: ` + display_name_contains = "user" + user_name_contains = "example.com" + `, + }.ExpectError(t, "exactly one of display_name_contains or user_name_contains should be specified, not both") +} + +func TestDataSourceDataUsersNoUsers(t *testing.T) { + qa.ResourceFixture{ + MockAccountClientFunc: func(m *mocks.MockAccountClient) { + e := m.GetMockAccountUsersAPI() + e.On("ListAll", + mock.Anything, + mock.MatchedBy(func(req iam.ListAccountUsersRequest) bool { + return req.Filter == `displayName co "testuser"` && + req.Attributes == "id,userName,displayName" + })).Return([]iam.User{}, nil) + }, Resource: DataSourceDataUsers(), Read: true, NonWritable: true, ID: "_", - }.ExpectError(t, "i'm a teapot") + HCL: ` + display_name_contains = "testuser" + `, + }.ExpectError(t, "cannot find users with display name containing testuser") +} + +func TestDataSourceDataUsersNoFilter(t *testing.T) { + qa.ResourceFixture{ + MockAccountClientFunc: func(m *mocks.MockAccountClient) { + e := m.GetMockAccountUsersAPI() + e.On("ListAll", + mock.Anything, + mock.MatchedBy(func(req iam.ListAccountUsersRequest) bool { + return req.Attributes == "id,userName,displayName" + })).Return([]iam.User{ + { + Id: "123", + UserName: "testuser@example.com", + DisplayName: "testuser", + }, + { + Id: "456", + UserName: "testuser2@example.com", + DisplayName: "testuser2", + }, + { + Id: "789", + UserName: "testuser3@example.com", + DisplayName: "testuser3", + }, + }, nil) + }, + Resource: DataSourceDataUsers(), + Read: true, + NonWritable: true, + ID: "_", + }.ApplyAndExpectData(t, map[string]any{ + "users.#": 3, + "users.0.id": "123", + "users.0.user_name": "testuser@example.com", + "users.0.display_name": "testuser", + "users.1.id": "456", + "users.1.user_name": "testuser2@example.com", + "users.1.display_name": "testuser2", + "users.2.id": "789", + "users.2.user_name": "testuser3@example.com", + "users.2.display_name": "testuser3", + }) +} + +func TestDataSourceDataUsers_APIError(t *testing.T) { + qa.ResourceFixture{ + MockAccountClientFunc: func(m *mocks.MockAccountClient) { + usersAPI := m.GetMockAccountUsersAPI() + usersAPI.On("ListAll", + mock.Anything, + mock.Anything, + ).Return(nil, fmt.Errorf("api error")) + }, + Resource: DataSourceDataUsers(), + Read: true, + NonWritable: true, + ID: "_", + HCL: ` + display_name_contains = "testuser" + `, + }.ExpectError(t, "api error") }