-
Notifications
You must be signed in to change notification settings - Fork 725
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
config, api: Add Service Config (#4869)
ref #4480 add service config Signed-off-by: Cabinfever_B <cabinfeveroier@gmail.com> Co-authored-by: Ti Chi Robot <ti-community-prow-bot@tidb.io>
- Loading branch information
1 parent
3e95051
commit dac3836
Showing
16 changed files
with
498 additions
and
70 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,131 @@ | ||
| // Copyright 2022 TiKV Project Authors. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package api | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
| "fmt" | ||
| "io" | ||
| "net/http" | ||
| "reflect" | ||
| "strings" | ||
|
|
||
| "github.com/pingcap/errors" | ||
| "github.com/tikv/pd/pkg/reflectutil" | ||
| "github.com/tikv/pd/server" | ||
| "github.com/tikv/pd/server/config" | ||
|
|
||
| "github.com/unrolled/render" | ||
| ) | ||
|
|
||
| type serviceMiddlewareHandler struct { | ||
| svr *server.Server | ||
| rd *render.Render | ||
| } | ||
|
|
||
| func newServiceMiddlewareHandler(svr *server.Server, rd *render.Render) *serviceMiddlewareHandler { | ||
| return &serviceMiddlewareHandler{ | ||
| svr: svr, | ||
| rd: rd, | ||
| } | ||
| } | ||
|
|
||
| // @Tags service_middleware | ||
| // @Summary Get Service Middleware config. | ||
| // @Produce json | ||
| // @Success 200 {object} config.Config | ||
| // @Router /service-middleware/config [get] | ||
| func (h *serviceMiddlewareHandler) GetServiceMiddlewareConfig(w http.ResponseWriter, r *http.Request) { | ||
| h.rd.JSON(w, http.StatusOK, h.svr.GetServiceMiddlewareConfig()) | ||
| } | ||
|
|
||
| // @Tags service_middleware | ||
| // @Summary Update some service-middleware's config items. | ||
| // @Accept json | ||
| // @Param body body object false "json params" | ||
| // @Produce json | ||
| // @Success 200 {string} string "The config is updated." | ||
| // @Failure 400 {string} string "The input is invalid." | ||
| // @Failure 500 {string} string "PD server failed to proceed the request." | ||
| // @Router /service-middleware/config [post] | ||
| func (h *serviceMiddlewareHandler) SetServiceMiddlewareConfig(w http.ResponseWriter, r *http.Request) { | ||
| cfg := h.svr.GetServiceMiddlewareConfig() | ||
| data, err := io.ReadAll(r.Body) | ||
| r.Body.Close() | ||
| if err != nil { | ||
| h.rd.JSON(w, http.StatusInternalServerError, err.Error()) | ||
| return | ||
| } | ||
|
|
||
| conf := make(map[string]interface{}) | ||
| if err := json.Unmarshal(data, &conf); err != nil { | ||
| h.rd.JSON(w, http.StatusBadRequest, err.Error()) | ||
| return | ||
| } | ||
|
|
||
| if len(conf) == 0 { | ||
| h.rd.JSON(w, http.StatusOK, "The input is empty.") | ||
| } | ||
|
|
||
| for k, v := range conf { | ||
| if s := strings.Split(k, "."); len(s) > 1 { | ||
| if err := h.updateServiceMiddlewareConfig(cfg, k, v); err != nil { | ||
| h.rd.JSON(w, http.StatusBadRequest, err.Error()) | ||
| return | ||
| } | ||
| continue | ||
| } | ||
| key := reflectutil.FindJSONFullTagByChildTag(reflect.TypeOf(config.ServiceMiddlewareConfig{}), k) | ||
| if key == "" { | ||
| h.rd.JSON(w, http.StatusBadRequest, fmt.Sprintf("config item %s not found", k)) | ||
| return | ||
| } | ||
| if err := h.updateServiceMiddlewareConfig(cfg, key, v); err != nil { | ||
| h.rd.JSON(w, http.StatusBadRequest, err.Error()) | ||
| return | ||
| } | ||
| } | ||
|
|
||
| h.rd.JSON(w, http.StatusOK, "The service-middleware config is updated.") | ||
| } | ||
|
|
||
| func (h *serviceMiddlewareHandler) updateServiceMiddlewareConfig(cfg *config.ServiceMiddlewareConfig, key string, value interface{}) error { | ||
| kp := strings.Split(key, ".") | ||
| if kp[0] == "audit" { | ||
| return h.updateAudit(cfg, kp[len(kp)-1], value) | ||
| } | ||
| return errors.Errorf("config prefix %s not found", kp[0]) | ||
| } | ||
|
|
||
| func (h *serviceMiddlewareHandler) updateAudit(config *config.ServiceMiddlewareConfig, key string, value interface{}) error { | ||
| data, err := json.Marshal(map[string]interface{}{key: value}) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| updated, found, err := mergeConfig(&config.AuditConfig, data) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| if !found { | ||
| return errors.Errorf("config item %s not found", key) | ||
| } | ||
|
|
||
| if updated { | ||
| err = h.svr.SetAuditConfig(config.AuditConfig) | ||
| } | ||
| return err | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,100 @@ | ||
| // Copyright 2022 TiKV Project Authors. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package api | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
| "fmt" | ||
| "net/http" | ||
|
|
||
| . "github.com/pingcap/check" | ||
| "github.com/pingcap/failpoint" | ||
| tu "github.com/tikv/pd/pkg/testutil" | ||
| "github.com/tikv/pd/server" | ||
| "github.com/tikv/pd/server/config" | ||
| ) | ||
|
|
||
| var _ = Suite(&testServiceMiddlewareSuite{}) | ||
|
|
||
| type testServiceMiddlewareSuite struct { | ||
| svr *server.Server | ||
| cleanup cleanUpFunc | ||
| urlPrefix string | ||
| } | ||
|
|
||
| func (s *testServiceMiddlewareSuite) SetUpSuite(c *C) { | ||
| s.svr, s.cleanup = mustNewServer(c, func(cfg *config.Config) { | ||
| cfg.Replication.EnablePlacementRules = false | ||
| }) | ||
| mustWaitLeader(c, []*server.Server{s.svr}) | ||
|
|
||
| addr := s.svr.GetAddr() | ||
| s.urlPrefix = fmt.Sprintf("%s%s/api/v1", addr, apiPrefix) | ||
| } | ||
|
|
||
| func (s *testServiceMiddlewareSuite) TearDownSuite(c *C) { | ||
| s.cleanup() | ||
| } | ||
|
|
||
| func (s *testServiceMiddlewareSuite) TestConfigAudit(c *C) { | ||
| addr := fmt.Sprintf("%s/service-middleware/config", s.urlPrefix) | ||
| ms := map[string]interface{}{ | ||
| "enable-audit": "true", | ||
| } | ||
| postData, err := json.Marshal(ms) | ||
| c.Assert(err, IsNil) | ||
| c.Assert(tu.CheckPostJSON(testDialClient, addr, postData, tu.StatusOK(c)), IsNil) | ||
| sc := &config.ServiceMiddlewareConfig{} | ||
| c.Assert(tu.ReadGetJSON(c, testDialClient, addr, sc), IsNil) | ||
| c.Assert(sc.EnableAudit, Equals, true) | ||
| ms = map[string]interface{}{ | ||
| "audit.enable-audit": "false", | ||
| } | ||
| postData, err = json.Marshal(ms) | ||
| c.Assert(err, IsNil) | ||
| c.Assert(tu.CheckPostJSON(testDialClient, addr, postData, tu.StatusOK(c)), IsNil) | ||
| sc = &config.ServiceMiddlewareConfig{} | ||
| c.Assert(tu.ReadGetJSON(c, testDialClient, addr, sc), IsNil) | ||
| c.Assert(sc.EnableAudit, Equals, false) | ||
|
|
||
| // test empty | ||
| ms = map[string]interface{}{} | ||
| postData, err = json.Marshal(ms) | ||
| c.Assert(err, IsNil) | ||
| c.Assert(tu.CheckPostJSON(testDialClient, addr, postData, tu.StatusOK(c), tu.StringContain(c, "The input is empty.")), IsNil) | ||
|
|
||
| ms = map[string]interface{}{ | ||
| "audit": "false", | ||
| } | ||
| postData, err = json.Marshal(ms) | ||
| c.Assert(err, IsNil) | ||
| c.Assert(tu.CheckPostJSON(testDialClient, addr, postData, tu.Status(c, http.StatusBadRequest), tu.StringEqual(c, "config item audit not found")), IsNil) | ||
|
|
||
| c.Assert(failpoint.Enable("github.com/tikv/pd/server/config/persistServiceMiddlewareFail", "return(true)"), IsNil) | ||
| ms = map[string]interface{}{ | ||
| "audit.enable-audit": "true", | ||
| } | ||
| postData, err = json.Marshal(ms) | ||
| c.Assert(err, IsNil) | ||
| c.Assert(tu.CheckPostJSON(testDialClient, addr, postData, tu.Status(c, http.StatusBadRequest)), IsNil) | ||
| c.Assert(failpoint.Disable("github.com/tikv/pd/server/config/persistServiceMiddlewareFail"), IsNil) | ||
|
|
||
| ms = map[string]interface{}{ | ||
| "audit.audit": "false", | ||
| } | ||
| postData, err = json.Marshal(ms) | ||
| c.Assert(err, IsNil) | ||
| c.Assert(tu.CheckPostJSON(testDialClient, addr, postData, tu.Status(c, http.StatusBadRequest), tu.StringEqual(c, "config item audit not found")), IsNil) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.