Added search by display_name to databricks_service_principal data source (#2963)

* Added search by `display_name` to `databricks_service_principal` data source

Allow to search not only by `application_id`, but also by the exact `display_name`.

This fixes #2959

* Address review comments

* More review comments

Author: alexott

docs/data-sources/service_principal.md

@@ -29,9 +29,10 @@ resource "databricks_group_member" "my_member_a" {
 
 ## Argument Reference
 
-Data source allows you to pick service principals by the following attributes
+Data source allows you to pick service principals by one of the following attributes (only one of them):
 
-- `application_id` - (Required) ID of the service principal. The service principal must exist before this resource can be retrieved.
+- `application_id` - (Required if `display_name` isn't used) ID of the service principal. The service principal must exist before this resource can be retrieved.
+- `display_name` - (Required if `application_id` isn't used) Exact display name of the service principal. The service principal must exist before this resource can be retrieved.  In case if there are several service principals with the same name, an error is thrown.
 
 ## Attribute Reference
 

scim/data_service_principal.go

@@ -24,15 +24,34 @@ func DataSourceServicePrincipal() *schema.Resource {
 	return common.DataResource(spnData{}, func(ctx context.Context, e any, c *common.DatabricksClient) error {
 		response := e.(*spnData)
 		spnAPI := NewServicePrincipalsAPI(ctx, c)
-		spList, err := spnAPI.Filter(fmt.Sprintf("applicationId eq '%s'", response.ApplicationID), true)
+		var spList []User
+		var err error
+		if response.ApplicationID != "" && response.DisplayName != "" {
+			return fmt.Errorf("please specify only one of application_id or display_name")
+		}
+		if response.ApplicationID != "" {
+			spList, err = spnAPI.Filter(fmt.Sprintf("applicationId eq '%s'", response.ApplicationID), true)
+		} else if response.DisplayName != "" {
+			spList, err = spnAPI.Filter(fmt.Sprintf("displayName eq '%s'", response.DisplayName), true)
+		} else {
+			return fmt.Errorf("please specify either application_id or display_name")
+		}
 		if err != nil {
 			return err
 		}
 		if len(spList) == 0 {
-			return fmt.Errorf("cannot find SP with ID %s", response.ApplicationID)
+			if response.ApplicationID != "" {
+				return fmt.Errorf("cannot find SP with ID %s", response.ApplicationID)
+			} else {
+				return fmt.Errorf("cannot find SP with name %s", response.DisplayName)
+			}
+		} else if len(spList) > 1 {
+			return fmt.Errorf("there are more than 1 service principal with name %s", response.DisplayName)
 		}
+
 		sp := spList[0]
 		response.DisplayName = sp.DisplayName
+		response.ApplicationID = sp.ApplicationID
 		response.Home = fmt.Sprintf("/Users/%s", sp.ApplicationID)
 		response.Repos = fmt.Sprintf("/Repos/%s", sp.ApplicationID)
 		response.AclPrincipalID = fmt.Sprintf("servicePrincipals/%s", sp.ApplicationID)

scim/data_service_principal_test.go

@@ -4,7 +4,7 @@ import (
 	"testing"
 
 	"github.com/databricks/terraform-provider-databricks/qa"
-	"github.com/stretchr/testify/require"
+	"github.com/stretchr/testify/assert"
 )
 
 func TestDataServicePrincipalReadByAppId(t *testing.T) {
@@ -52,8 +52,8 @@ func TestDataServicePrincipalReadByAppId(t *testing.T) {
 	})
 }
 
-func TestDataServicePrincipalReadNotFound(t *testing.T) {
-	_, err := qa.ResourceFixture{
+func TestDataServicePrincipalReadByIdNotFound(t *testing.T) {
+	qa.ResourceFixture{
 		Fixtures: []qa.HTTPFixture{
 			{
 				Method:   "GET",
@@ -66,8 +66,24 @@ func TestDataServicePrincipalReadNotFound(t *testing.T) {
 		Read:        true,
 		NonWritable: true,
 		ID:          "_",
-	}.Apply(t)
-	require.Error(t, err)
+	}.ExpectError(t, "cannot find SP with ID abc")
+}
+
+func TestDataServicePrincipalReadByNameNotFound(t *testing.T) {
+	qa.ResourceFixture{
+		Fixtures: []qa.HTTPFixture{
+			{
+				Method:   "GET",
+				Resource: "/api/2.0/preview/scim/v2/ServicePrincipals?excludedAttributes=roles&filter=displayName%20eq%20%27abc%27",
+				Response: UserList{},
+			},
+		},
+		Resource:    DataSourceServicePrincipal(),
+		HCL:         `display_name = "abc"`,
+		Read:        true,
+		NonWritable: true,
+		ID:          "_",
+	}.ExpectError(t, "cannot find SP with name abc")
 }
 
 func TestDataServicePrincipalReadError(t *testing.T) {
@@ -85,5 +101,58 @@ func TestDataServicePrincipalReadError(t *testing.T) {
 		NonWritable: true,
 		ID:          "_",
 	}.Apply(t)
-	require.Error(t, err)
+	assert.ErrorContains(t, err, "unexpected error handling request: unexpected end of JSON input")
+}
+
+func TestDataServicePrincipalReadByNameDuplicates(t *testing.T) {
+	qa.ResourceFixture{
+		Fixtures: []qa.HTTPFixture{
+			{
+				Method:   "GET",
+				Resource: "/api/2.0/preview/scim/v2/ServicePrincipals?excludedAttributes=roles&filter=displayName%20eq%20%27abc%27",
+				Response: UserList{
+					Resources: []User{
+						{
+							ID:            "abc1",
+							DisplayName:   "abc",
+							Active:        true,
+							ApplicationID: "abc1",
+						},
+						{
+							ID:            "abc2",
+							DisplayName:   "abc",
+							Active:        true,
+							ApplicationID: "abc2",
+						},
+					},
+				},
+			},
+		},
+		Resource:    DataSourceServicePrincipal(),
+		HCL:         `display_name = "abc"`,
+		Read:        true,
+		NonWritable: true,
+		ID:          "abc",
+	}.ExpectError(t, "there are more than 1 service principal with name abc")
+}
+
+func TestDataServicePrincipalReadNoParams(t *testing.T) {
+	qa.ResourceFixture{
+		Resource:    DataSourceServicePrincipal(),
+		HCL:         ``,
+		Read:        true,
+		NonWritable: true,
+		ID:          "_",
+	}.ExpectError(t, "please specify either application_id or display_name")
+}
+
+func TestDataServicePrincipalReadBothParams(t *testing.T) {
+	qa.ResourceFixture{
+		Resource: DataSourceServicePrincipal(),
+		HCL: `display_name = "abc"
+		application_id = "abc"`,
+		Read:        true,
+		NonWritable: true,
+		ID:          "_",
+	}.ExpectError(t, "please specify only one of application_id or display_name")
 }