Implement test for ListProvisionedSCIMUsers

Author: elminster-aom

github/enterprise_scim.go

@@ -167,12 +167,12 @@ func (s *EnterpriseService) ListProvisionedSCIMGroups(ctx context.Context, enter
 	return groups, resp, nil
 }
 
-// ListSCIMProvisionedUsers lists provisioned SCIM enterprise users.
+// ListProvisionedSCIMUsers lists provisioned SCIM enterprise users.
 //
 // GitHub API docs: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#list-scim-provisioned-identities-for-an-enterprise
 //
 //meta:operation GET /scim/v2/enterprises/{enterprise}/Users
-func (s *EnterpriseService) ListSCIMProvisionedUsers(ctx context.Context, enterprise string, opts *ListProvisionedSCIMUsersEnterpriseOptions) (*SCIMEnterpriseUsers, *Response, error) {
+func (s *EnterpriseService) ListProvisionedSCIMUsers(ctx context.Context, enterprise string, opts *ListProvisionedSCIMUsersEnterpriseOptions) (*SCIMEnterpriseUsers, *Response, error) {
 	u := fmt.Sprintf("scim/v2/enterprises/%v/Users", enterprise)
 	u, err := addOptions(u, opts)
 	if err != nil {
@@ -183,6 +183,7 @@ func (s *EnterpriseService) ListSCIMProvisionedUsers(ctx context.Context, enterp
 	if err != nil {
 		return nil, nil, err
 	}
+	req.Header.Set("Accept", mediaTypeSCIM)
 
 	users := new(SCIMEnterpriseUsers)
 	resp, err := s.client.Do(ctx, req, users)

github/enterprise_scim_test.go

@@ -333,3 +333,108 @@ func TestEnterpriseService_ListProvisionedSCIMGroups(t *testing.T) {
 		return r, err
 	})
 }
+
+func TestEnterpriseService_ListProvisionedSCIMUsers(t *testing.T) {
+	t.Parallel()
+	client, mux, _ := setup(t)
+
+	mux.HandleFunc("/scim/v2/enterprises/octo-org/Users", func(w http.ResponseWriter, r *http.Request) {
+		testMethod(t, r, "GET")
+		testHeader(t, r, "Accept", mediaTypeSCIM)
+		testFormValues(t, r, values{
+			"startIndex": "1",
+			"count":      "3",
+			"filter":     `userName eq "[email protected]"`,
+		})
+		w.WriteHeader(http.StatusOK)
+		_, _ = w.Write([]byte(`{
+            "schemas": ["` + SCIMSchemasURINamespacesListResponse + `"],
+            "totalResults": 1,
+            "itemsPerPage": 1,
+            "startIndex": 1,
+            "Resources": [
+              {
+                "schemas": ["` + SCIMSchemasURINamespacesUser + `"],
+                "id": "5fc0",
+                "externalId": "00u1",
+                "userName": "[email protected]",
+                "displayName": "Mona Octocat",
+                "name": {
+                  "givenName": "Mona",
+                  "familyName": "Octocat",
+                  "formatted": "Mona Octocat"
+                },
+                "emails": [
+                  {
+                    "value": "[email protected]",
+                    "primary": true
+                  }
+                ],
+                "active": true,
+                "meta": {
+                  "resourceType": "User",
+                  "created": ` + referenceTimeStr + `,
+                  "lastModified": ` + referenceTimeStr + `,
+                  "location": "https://api.github.com/scim/v2/organizations/octo-org/Users/5fc0"
+                }
+              }
+            ]
+        }`))
+	})
+
+	ctx := t.Context()
+	opts := &ListProvisionedSCIMUsersEnterpriseOptions{
+		StartIndex: 1,
+		Count:      3,
+		Filter:     `userName eq "[email protected]"`,
+	}
+	users, _, err := client.Enterprise.ListProvisionedSCIMUsers(ctx, "octo-org", opts)
+	if err != nil {
+		t.Fatalf("Enterprise.ListProvisionedSCIMUsers returned unexpected error: %v", err)
+	}
+
+	want := SCIMEnterpriseUsers{
+		Schemas:      []string{SCIMSchemasURINamespacesListResponse},
+		TotalResults: Ptr(1),
+		ItemsPerPage: Ptr(1),
+		StartIndex:   Ptr(1),
+		Resources: []*SCIMEnterpriseUserAttributes{{
+			Schemas:     []string{SCIMSchemasURINamespacesUser},
+			ID:          Ptr("5fc0"),
+			ExternalID:  "00u1",
+			UserName:    "[email protected]",
+			DisplayName: "Mona Octocat",
+			Name: &SCIMEnterpriseUserName{
+				GivenName:  "Mona",
+				FamilyName: "Octocat",
+				Formatted:  Ptr("Mona Octocat"),
+			},
+			Emails: []*SCIMEnterpriseUserEmail{{
+				Value:   "[email protected]",
+				Primary: true,
+			}},
+			Active: true,
+			Meta: &SCIMEnterpriseMeta{
+				ResourceType: "User",
+				Created:      &Timestamp{referenceTime},
+				LastModified: &Timestamp{referenceTime},
+				Location:     Ptr("https://api.github.com/scim/v2/organizations/octo-org/Users/5fc0"),
+			},
+		}},
+	}
+
+	if diff := cmp.Diff(want, *users); diff != "" {
+		t.Errorf("Enterprise.ListProvisionedSCIMUsers diff mismatch (-want +got):\n%v", diff)
+	}
+
+	const methodName = "ListProvisionedSCIMUsers"
+	testBadOptions(t, methodName, func() (err error) {
+		_, _, err = client.Enterprise.ListProvisionedSCIMUsers(ctx, "\n", opts)
+		return err
+	})
+
+	testNewRequestAndDoFailure(t, methodName, client, func() (*Response, error) {
+		_, r, err := client.Enterprise.ListProvisionedSCIMUsers(ctx, "o", opts)
+		return r, err
+	})
+}