Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added support to search via Lucene query for auth0_user data-source #1141

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Added support to search via Lucene query for auth0_user data-source #1141

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion docs/data-sources/user.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,24 @@ Data source to retrieve a specific Auth0 user by `user_id`.
data "auth0_user" "my_user" {
user_id = "auth0|34fdr23fdsfdfsf"
}

# An Auth0 User loaded through Lucene query.
data "auth0_user" "my_user" {
query = "email:[email protected]"
}

# An Auth0 User loaded through Lucene query.
data "auth0_user" "my_user" {
query = "username:johndoe"
}
```

<!-- schema generated by tfplugindocs -->
## Schema

### Required
### Optional

- `query` (String) Lucene Query for retrieving a user.
- `user_id` (String) ID of the user.

### Read-Only
Expand Down
10 changes: 10 additions & 0 deletions examples/data-sources/auth0_user/data-source.tf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,13 @@
data "auth0_user" "my_user" {
user_id = "auth0|34fdr23fdsfdfsf"
}

# An Auth0 User loaded through Lucene query.
data "auth0_user" "my_user" {
query = "email:[email protected]"
}

# An Auth0 User loaded through Lucene query.
data "auth0_user" "my_user" {
query = "username:johndoe"
}
40 changes: 31 additions & 9 deletions internal/auth0/user/data_source.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,17 @@ func dataSourceSchema() map[string]*schema.Schema {
dataSourceSchema := internalSchema.TransformResourceToDataSource(internalSchema.Clone(NewResource().Schema))

dataSourceSchema["user_id"] = &schema.Schema{
Type: schema.TypeString,
Required: true,
Description: "ID of the user.",
Type: schema.TypeString,
Optional: true,
Description: "ID of the user.",
AtLeastOneOf: []string{"user_id", "query"},
}

dataSourceSchema["query"] = &schema.Schema{
Type: schema.TypeString,
Optional: true,
Description: "Lucene Query for retrieving a user.",
AtLeastOneOf: []string{"user_id", "query"},
}

dataSourceSchema["permissions"] = &schema.Schema{
Expand Down Expand Up @@ -73,16 +81,30 @@ func dataSourceSchema() map[string]*schema.Schema {

func readUserForDataSource(ctx context.Context, data *schema.ResourceData, meta interface{}) diag.Diagnostics {
api := meta.(*config.Config).GetAPI()
var user *management.User

userID := data.Get("user_id").(string)

user, err := api.User.Read(ctx, userID)
if err != nil {
return diag.FromErr(err)
if userID != "" {
u, err := api.User.Read(ctx, userID)
if err != nil {
return diag.FromErr(err)
}
user = u
data.SetId(user.GetID())
} else {
query := data.Get("query").(string)
users, err := api.User.List(ctx, management.Parameter("q", query))
if err != nil {
return diag.FromErr(err)
}
if users.Length == 1 {
user = users.Users[0]
data.SetId(users.Users[0].GetID())
} else {
return diag.Errorf("Further improve the query to retrieve a single user from the query")
}
}

data.SetId(user.GetID())

var roles []*management.Role
var rolesPage int
for {
Expand Down
56 changes: 53 additions & 3 deletions internal/auth0/user/data_source_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ data "auth0_user" "user" {
}
`

const testAccDataSourceUser = `
const testAccDataSourceUserTemplate = `
resource "auth0_resource_server" "resource_server" {
name = "Acceptance Test - {{.testName}}"
identifier = "https://uat.api.terraform-provider-auth0.com/{{.testName}}"
Expand Down Expand Up @@ -97,12 +97,26 @@ resource "auth0_user_roles" "user_roles" {

user_id = auth0_user.user.id
roles = [ auth0_role.owner.id, auth0_role.admin.id ]
}`

const testAccDataSourceUserWithID = testAccDataSourceUserTemplate + `
data "auth0_user" "test" {
depends_on = [ auth0_user_roles.user_roles ]
user_id = auth0_user.user.id
}
`

const testAccDataSourceUserWithQueryUsername = testAccDataSourceUserTemplate + `
data "auth0_user" "test" {
depends_on = [ auth0_user_roles.user_roles ]
query = "username:{{.testName}}"
}
`

user_id = auth0_user.user.id
const testAccDataSourceUserWithQueryEmail = testAccDataSourceUserTemplate + `
data "auth0_user" "test" {
depends_on = [ auth0_user_roles.user_roles ]
query = "email:{{.testName}}@acceptance.test.com"
}
`

Expand All @@ -116,7 +130,43 @@ func TestAccDataSourceUser(t *testing.T) {
ExpectError: regexp.MustCompile(`Error: 404 Not Found: The user does not exist.`),
},
{
Config: acctest.ParseTestName(testAccDataSourceUser, testName),
Config: acctest.ParseTestName(testAccDataSourceUserWithID, testName),
Check: resource.ComposeTestCheckFunc(
resource.TestCheckResourceAttr("data.auth0_user.test", "email", fmt.Sprintf("%[email protected]", testName)),
resource.TestCheckResourceAttr("data.auth0_user.test", "user_id", fmt.Sprintf("auth0|%s", testName)),
resource.TestCheckResourceAttr("data.auth0_user.test", "username", testName),
resource.TestCheckResourceAttr("data.auth0_user.test", "email", fmt.Sprintf("%[email protected]", testName)),
resource.TestCheckResourceAttr("data.auth0_user.test", "name", "Firstname Lastname"),
resource.TestCheckResourceAttr("data.auth0_user.test", "given_name", "Firstname"),
resource.TestCheckResourceAttr("data.auth0_user.test", "family_name", "Lastname"),
resource.TestCheckResourceAttr("data.auth0_user.test", "nickname", testName),
resource.TestCheckResourceAttr("data.auth0_user.test", "picture", "https://www.example.com/picture.jpg"),
resource.TestCheckResourceAttr("data.auth0_user.test", "roles.#", "2"),
resource.TestCheckResourceAttr("data.auth0_user.test", "permissions.#", "2"),
resource.TestCheckResourceAttr("data.auth0_user.test", "user_metadata", `{"baz":"qux","foo":"bar"}`),
resource.TestCheckResourceAttr("data.auth0_user.test", "app_metadata", `{"baz":"qux","foo":"bar"}`),
),
},
{
Config: acctest.ParseTestName(testAccDataSourceUserWithQueryUsername, testName),
Check: resource.ComposeTestCheckFunc(
resource.TestCheckResourceAttr("data.auth0_user.test", "email", fmt.Sprintf("%[email protected]", testName)),
resource.TestCheckResourceAttr("data.auth0_user.test", "user_id", fmt.Sprintf("auth0|%s", testName)),
resource.TestCheckResourceAttr("data.auth0_user.test", "username", testName),
resource.TestCheckResourceAttr("data.auth0_user.test", "email", fmt.Sprintf("%[email protected]", testName)),
resource.TestCheckResourceAttr("data.auth0_user.test", "name", "Firstname Lastname"),
resource.TestCheckResourceAttr("data.auth0_user.test", "given_name", "Firstname"),
resource.TestCheckResourceAttr("data.auth0_user.test", "family_name", "Lastname"),
resource.TestCheckResourceAttr("data.auth0_user.test", "nickname", testName),
resource.TestCheckResourceAttr("data.auth0_user.test", "picture", "https://www.example.com/picture.jpg"),
resource.TestCheckResourceAttr("data.auth0_user.test", "roles.#", "2"),
resource.TestCheckResourceAttr("data.auth0_user.test", "permissions.#", "2"),
resource.TestCheckResourceAttr("data.auth0_user.test", "user_metadata", `{"baz":"qux","foo":"bar"}`),
resource.TestCheckResourceAttr("data.auth0_user.test", "app_metadata", `{"baz":"qux","foo":"bar"}`),
),
},
{
Config: acctest.ParseTestName(testAccDataSourceUserWithQueryEmail, testName),
Check: resource.ComposeTestCheckFunc(
resource.TestCheckResourceAttr("data.auth0_user.test", "email", fmt.Sprintf("%[email protected]", testName)),
resource.TestCheckResourceAttr("data.auth0_user.test", "user_id", fmt.Sprintf("auth0|%s", testName)),
Expand Down
Loading
Loading