Merge pull request #167 from azaurus1/165-improve-users-to-allow-acl-in-body

added permissions and tables as optional fields in user struct

Author: azaurus1

example/main.go

@@ -76,7 +76,9 @@ func main() {
 	// demoGetSegmentTiers(client)
 	// demoGetSegmentCRC(client)
 	// demoGetSegmentMetadata(client)
-	demoGetSegmentZKMetadata(client)
+	// demoGetSegmentZKMetadata(client)
+	// demoUpdateSegmentZKTimeInterval(client)
+	demoCreateUserWithACL(client)
 
 }
 
@@ -1262,6 +1264,18 @@ func demoGetSegmentZKMetadata(client *pinot.PinotAPIClient) {
 
 }
 
+func demoUpdateSegmentZKTimeInterval(client *pinot.PinotAPIClient) {
+
+	updateSegmentZKTimeIntervalResp, err := client.UpdateSegmentZKTimeInterval("airlineStats_OFFLINE")
+	if err != nil {
+		log.Panic(err)
+	}
+
+	fmt.Println("Updating Segment ZK Interval Time:")
+	fmt.Println(updateSegmentZKTimeIntervalResp.Status)
+
+}
+
 func getOrDefault(defaultOption string, envKeys ...string) string {
 
 	for _, envKey := range envKeys {
@@ -1273,3 +1287,47 @@ func getOrDefault(defaultOption string, envKeys ...string) string {
 	return defaultOption
 
 }
+
+func demoCreateUserWithACL(client *pinot.PinotAPIClient) {
+
+	user := pinotModel.User{
+		Username:    "liam_with_permissions",
+		Password:    "password",
+		Component:   "BROKER",
+		Role:        "admin",
+		Permissions: &[]string{"READ"},
+		Tables:      &[]string{"my_table_Offline"},
+	}
+
+	userBytes, err := json.Marshal(user)
+	if err != nil {
+		log.Panic(err)
+	}
+
+	// Create User
+	createResp, err := client.CreateUser(userBytes)
+	if err != nil {
+		fmt.Println(err)
+	}
+
+	fmt.Println(createResp.Status)
+
+	// Read User
+	getUserResp, err := client.GetUser(user.Username, user.Component)
+	if err != nil {
+		log.Panic(err)
+	}
+
+	fmt.Println("Reading User:")
+	fmt.Println(getUserResp.Permissions)
+
+	// Read User
+	getUserResp, err = client.GetUser("liam_with_admin", "BROKER")
+	if err != nil {
+		log.Panic(err)
+	}
+
+	fmt.Println("Reading User:")
+	fmt.Println(getUserResp.Permissions)
+
+}

go-pinot-api.go

@@ -129,13 +129,22 @@ func (c *PinotAPIClient) CreateObject(endpoint string, body []byte, result any)
 
 	fullURL := prepareRequestURL(c, endpoint)
 
-	req, err := http.NewRequest(http.MethodPost, fullURL.String(), bytes.NewBuffer(body))
+	var req *http.Request
+	var err error
+
+	if body == nil {
+		c.log.Debug("body is nil")
+		req, err = http.NewRequest(http.MethodPost, fullURL.String(), nil)
+		req.Header.Set("Content-Type", "application/json")
+	} else {
+		req, err = http.NewRequest(http.MethodPost, fullURL.String(), bytes.NewBuffer(body))
+		req.Header.Set("Content-Type", "application/json")
+	}
+
 	if err != nil {
 		return fmt.Errorf("client: could not create request: %w", err)
 	}
 
-	req.Header.Set("Content-Type", "application/json")
-
 	c.log.Debug(fmt.Sprintf("attempting POST %s", fullURL))
 
 	res, err := c.pinotHttp.Do(req)
@@ -782,6 +791,12 @@ func (c *PinotAPIClient) GetSegmentZKMetadata(tableName string) (*model.GetSegme
 	return &result, err
 }
 
+func (c *PinotAPIClient) UpdateSegmentZKTimeInterval(tableNameWithType string) (*model.UserActionResponse, error) {
+	var result model.UserActionResponse
+	err := c.CreateObject(fmt.Sprintf("/segments/%s/updateZkTimeInterval", tableNameWithType), nil, &result)
+	return &result, err
+}
+
 // Cluster
 
 func (c *PinotAPIClient) GetClusterInfo() (*model.GetClusterResponse, error) {

go-pinot-api_test.go

@@ -3938,10 +3938,12 @@ func TestCreateUser(t *testing.T) {
 	client := createPinotClient(server)
 
 	user := model.User{
-		Username:  "testUser",
-		Password:  "test",
-		Component: "BROKER",
-		Role:      "ADMIN",
+		Username:    "testUser",
+		Password:    "test",
+		Component:   "BROKER",
+		Role:        "ADMIN",
+		Permissions: &[]string{"READ"},
+		Tables:      &[]string{"my_table_OFFLINE"},
 	}
 
 	userBytes, err := json.Marshal(user)

model/User.go

@@ -1,9 +1,11 @@
 package model
 
 type User struct {
-	Username              string `json:"username"`
-	Password              string `json:"password"`
-	Component             string `json:"component"`
-	Role                  string `json:"role"`
-	UsernameWithComponent string `json:"usernameWithComponent"`
+	Username              string    `json:"username"`
+	Password              string    `json:"password"`
+	Component             string    `json:"component"`
+	Role                  string    `json:"role"`
+	UsernameWithComponent string    `json:"usernameWithComponent"`
+	Permissions           *[]string `json:"permissions,omitempty"` // optional for adding permissions etc
+	Tables                *[]string `json:"tables,omitempty"`
 }