vitalif
/
etcd
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Merge pull request #1381 from jonboulle/members 

/v2/admin/members API should use JSON containers in response
release-2.0
Jonathan Boulle 2014-10-24 13:20:10 -07:00
parent 49a68adcf1 543e12074a
commit d7f9228133
5 changed files with 56 additions and 97 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

73
Documentation/0.5/admin_api.md
View File

@ -1,30 +1,7 @@
## Admin API ## Admin API
### GET /v2/admin/members/:id
Returns an HTTP 200 OK response code and a representation of the requested member; returns a 404 status code and an error message if the id does not exist.
```
Example Request: GET
http://localhost:2379/v2/admin/members/272e204152
Response formats: JSON
Example Response:
```
```json
[
{
"ID":"272e204152",
"Name":"node1",
"PeerURLs":[
"http://10.0.0.10:2379"
],
"ClientURLs":[
"http://10.0.0.10:2380"
]
},
]
```
### GET /v2/admin/members/ ### GET /v2/admin/members/
Return an HTTP 200 OK response code and a representation of all the members; Return an HTTP 200 OK response code and a representation of all members in the etcd cluster:
``` ```
Example Request: GET Example Request: GET
http://localhost:2379/v2/admin/members/ http://localhost:2379/v2/admin/members/
@ -32,28 +9,30 @@ Return an HTTP 200 OK response code and a representation of all the members;
Example Response: Example Response:
``` ```
```json ```json
[ {
{ "members": [
"ID":"272e204152", {
"Name":"node1", "id":"272e204152",
"PeerURLs":[ "name":"node1",
"http://10.0.0.10:2379" "peerURLs":[
], "http://10.0.0.10:2379"
"ClientURLs":[ ],
"http://10.0.0.10:2380" "clientURLs":[
] "http://10.0.0.10:2380"
}, ]
{ },
"ID":"2225373f43", {
"Name":"node2", "id":"2225373f43",
"PeerURLs":[ "name":"node2",
"http://127.0.0.11:2379" "peerURLs":[
], "http://127.0.0.11:2379"
"ClientURLs":[ ],
"http://127.0.0.11:2380" "clientURLs":[
] "http://127.0.0.11:2380"
}, ]
] },
]
}
``` ```
### POST /v2/admin/members/ ### POST /v2/admin/members/
@ -73,7 +52,7 @@ If the POST body is malformed an HTTP 400 will be returned. If the member exists
[ [
{ {
"id":"3777296169", "id":"3777296169",
"PeerURLs":[ "peerURLs":[
"http://10.0.0.10:2379" "http://10.0.0.10:2379"
], ],
}, },

18
etcdserver/cluster_test.go
View File

@ -381,19 +381,19 @@ func TestNodeToMemberBad(t *testing.T) {
{Key: "/1234/dynamic", Value: stringp("garbage")}, {Key: "/1234/dynamic", Value: stringp("garbage")},
}}, }},
{Key: "/1234", Nodes: []*store.NodeExtern{ {Key: "/1234", Nodes: []*store.NodeExtern{
{Key: "/1234/dynamic", Value: stringp(`{"PeerURLs":null}`)}, {Key: "/1234/dynamic", Value: stringp(`{"peerURLs":null}`)},
}}, }},
{Key: "/1234", Nodes: []*store.NodeExtern{ {Key: "/1234", Nodes: []*store.NodeExtern{
{Key: "/1234/dynamic", Value: stringp(`{"PeerURLs":null}`)}, {Key: "/1234/dynamic", Value: stringp(`{"peerURLs":null}`)},
{Key: "/1234/strange"}, {Key: "/1234/strange"},
}}, }},
{Key: "/1234", Nodes: []*store.NodeExtern{ {Key: "/1234", Nodes: []*store.NodeExtern{
{Key: "/1234/dynamic", Value: stringp(`{"PeerURLs":null}`)}, {Key: "/1234/dynamic", Value: stringp(`{"peerURLs":null}`)},
{Key: "/1234/static", Value: stringp("garbage")}, {Key: "/1234/static", Value: stringp("garbage")},
}}, }},
{Key: "/1234", Nodes: []*store.NodeExtern{ {Key: "/1234", Nodes: []*store.NodeExtern{
{Key: "/1234/dynamic", Value: stringp(`{"PeerURLs":null}`)}, {Key: "/1234/dynamic", Value: stringp(`{"peerURLs":null}`)},
{Key: "/1234/static", Value: stringp(`{"Name":"node1","ClientURLs":null}`)}, {Key: "/1234/static", Value: stringp(`{"name":"node1","clientURLs":null}`)},
{Key: "/1234/strange"}, {Key: "/1234/strange"},
}}, }},
} }
@ -416,7 +416,7 @@ func TestClusterAddMember(t *testing.T) {
params: []interface{}{ params: []interface{}{
path.Join(storeMembersPrefix, "1", "raftAttributes"), path.Join(storeMembersPrefix, "1", "raftAttributes"),
false, false,
`{"PeerURLs":null}`, `{"peerURLs":null}`,
false, false,
store.Permanent, store.Permanent,
}, },
@ -426,7 +426,7 @@ func TestClusterAddMember(t *testing.T) {
params: []interface{}{ params: []interface{}{
path.Join(storeMembersPrefix, "1", "attributes"), path.Join(storeMembersPrefix, "1", "attributes"),
false, false,
`{"Name":"node1"}`, `{"name":"node1"}`,
false, false,
store.Permanent, store.Permanent,
}, },
@ -519,8 +519,8 @@ func TestClusterRemoveMember(t *testing.T) {
func TestNodeToMember(t *testing.T) { func TestNodeToMember(t *testing.T) {
n := &store.NodeExtern{Key: "/1234", Nodes: []*store.NodeExtern{ n := &store.NodeExtern{Key: "/1234", Nodes: []*store.NodeExtern{
{Key: "/1234/attributes", Value: stringp(`{"Name":"node1","ClientURLs":null}`)}, {Key: "/1234/attributes", Value: stringp(`{"name":"node1","clientURLs":null}`)},
{Key: "/1234/raftAttributes", Value: stringp(`{"PeerURLs":null}`)}, {Key: "/1234/raftAttributes", Value: stringp(`{"peerURLs":null}`)},
}} }}
wm := &Member{ID: 0x1234, RaftAttributes: RaftAttributes{}, Attributes: Attributes{Name: "node1"}} wm := &Member{ID: 0x1234, RaftAttributes: RaftAttributes{}, Attributes: Attributes{Name: "node1"}}
m, err := nodeToMember(n) m, err := nodeToMember(n)

25
etcdserver/etcdhttp/http.go
View File

@ -161,30 +161,19 @@ func (h serverHandler) serveAdminMembers(w http.ResponseWriter, r *http.Request)
switch r.Method { switch r.Method {
case "GET": case "GET":
idStr := strings.TrimPrefix(r.URL.Path, adminMembersPrefix) if s := strings.TrimPrefix(r.URL.Path, adminMembersPrefix); s != "" {
if idStr == "" { http.NotFound(w, r)
ms := h.clusterInfo.Members()
w.Header().Set("Content-Type", "application/json")
if err := json.NewEncoder(w).Encode(ms); err != nil {
log.Printf("etcdhttp: %v", err)
}
return return
} }
id, err := strconv.ParseUint(idStr, 16, 64) ms := struct {
if err != nil { Members []*etcdserver.Member `json:"members"`
http.Error(w, err.Error(), http.StatusBadRequest) }{
return Members: h.clusterInfo.Members(),
}
m := h.clusterInfo.Member(id)
if m == nil {
http.Error(w, "member not found", http.StatusNotFound)
return
} }
w.Header().Set("Content-Type", "application/json") w.Header().Set("Content-Type", "application/json")
if err := json.NewEncoder(w).Encode(m); err != nil { if err := json.NewEncoder(w).Encode(ms); err != nil {
log.Printf("etcdhttp: %v", err) log.Printf("etcdhttp: %v", err)
} }
return
case "POST": case "POST":
ctype := r.Header.Get("Content-Type") ctype := r.Header.Get("Content-Type")
if ctype != "application/json" { if ctype != "application/json" {

29
etcdserver/etcdhttp/http_test.go
View File

@ -1563,16 +1563,6 @@ func TestServeAdminMembersFail(t *testing.T) {
http.StatusInternalServerError, http.StatusInternalServerError,
}, },
{
// etcdserver.GetMember bad id
&http.Request{
URL: mustNewURL(t, path.Join(adminMembersPrefix, "badid")),
Method: "GET",
},
&errServer{},
http.StatusBadRequest,
},
} }
for i, tt := range tests { for i, tt := range tests {
h := &serverHandler{ h := &serverHandler{
@ -1627,16 +1617,17 @@ func TestServeAdminMembers(t *testing.T) {
clusterInfo: cluster, clusterInfo: cluster,
} }
msb, err := json.Marshal([]etcdserver.Member{memb1, memb2}) msb, err := json.Marshal(
struct {
Members []etcdserver.Member `json:"members"`
}{
Members: []etcdserver.Member{memb1, memb2},
},
)
if err != nil { if err != nil {
t.Fatal(err) t.Fatal(err)
} }
wms := string(msb) + "\n" wms := string(msb) + "\n"
mb, err := json.Marshal(memb1)
if err != nil {
t.Fatal(err)
}
wm := string(mb) + "\n"
tests := []struct { tests := []struct {
path string path string
@ -1645,8 +1636,8 @@ func TestServeAdminMembers(t *testing.T) {
wbody string wbody string
}{ }{
{adminMembersPrefix, http.StatusOK, "application/json", wms}, {adminMembersPrefix, http.StatusOK, "application/json", wms},
{path.Join(adminMembersPrefix, "1"), http.StatusOK, "application/json", wm}, {path.Join(adminMembersPrefix, "100"), http.StatusNotFound, "text/plain; charset=utf-8", "404 page not found\n"},
{path.Join(adminMembersPrefix, "100"), http.StatusNotFound, "text/plain; charset=utf-8", "member not found\n"}, {path.Join(adminMembersPrefix, "foobar"), http.StatusNotFound, "text/plain; charset=utf-8", "404 page not found\n"},
} }
for i, tt := range tests { for i, tt := range tests {
@ -1664,7 +1655,7 @@ func TestServeAdminMembers(t *testing.T) {
t.Errorf("#%d: content-type = %s, want %s", i, gct, tt.wct) t.Errorf("#%d: content-type = %s, want %s", i, gct, tt.wct)
} }
if rw.Body.String() != tt.wbody { if rw.Body.String() != tt.wbody {
t.Errorf("#%d: body = %s, want %s", i, rw.Body.String(), tt.wbody) t.Errorf("#%d: body = %q, want %q", i, rw.Body.String(), tt.wbody)
} }
} }
} }

8
etcdserver/member.go
View File

@ -33,17 +33,17 @@ import (
// RaftAttributes represents the raft related attributes of an etcd member. // RaftAttributes represents the raft related attributes of an etcd member.
type RaftAttributes struct { type RaftAttributes struct {
// TODO(philips): ensure these are URLs // TODO(philips): ensure these are URLs
PeerURLs []string PeerURLs []string `json:"peerURLs"`
} }
// Attributes represents all the non-raft related attributes of an etcd member. // Attributes represents all the non-raft related attributes of an etcd member.
type Attributes struct { type Attributes struct {
Name string `json:",omitempty"` Name string `json:"name,omitempty"`
ClientURLs []string `json:",omitempty"` ClientURLs []string `json:"clientURLs,omitempty"`
} }
type Member struct { type Member struct {
ID uint64 ID uint64 `json:"id"`
RaftAttributes RaftAttributes
Attributes Attributes
} }