mirror of
https://github.com/etcd-io/etcd.git
synced 2024-09-27 06:25:44 +00:00
d89fa131ab
This commits adds test coverage for all the error and non-error cases described below, but only the behavior of the 403, 404 and 412 cases are changing in this commit. When setting a key results in a new resource, we asset an HTTP status code of 201 (aka "Created"). When attempting to get a resource that doesn't exist, we assert an HTTP status code of 404 (aka "Not Found"). When attempting to delete a directory without dir=true, or a non-empty directory without recursive=true, but the request is otherwise valid, we assert an HTTP status code of 403 (aka "Forbidden"). When a precondition (e.g. specified by prevIndex, or prevValue) is not met, but the request is otherwise syntactically valid, we assert an HTTP status code of 412 (aka "Precondition Failed"). However, prevExist is handled slightly differently. If prevExist=false fails, then this is treated like a failed precondition, so it should use PreconditionFailed. But, if prevExist=true fails, then this is treated like other requests that require the existence of the resource, and uses NotFound if the resource doesn't exist. We continue to assert an HTTP status code of 400 when the request is syntactically invalid (e.g. when prevIndex=bad_index).
332 lines
12 KiB
Go
332 lines
12 KiB
Go
package v2
|
|
|
|
import (
|
|
"fmt"
|
|
"net/http"
|
|
"net/url"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/coreos/etcd/server"
|
|
"github.com/coreos/etcd/tests"
|
|
"github.com/stretchr/testify/assert"
|
|
)
|
|
|
|
// Ensures that a key is set to a given value.
|
|
//
|
|
// $ curl -X PUT localhost:4001/v2/keys/foo/bar -d value=XXX
|
|
//
|
|
func TestV2SetKey(t *testing.T) {
|
|
tests.RunServer(func(s *server.Server) {
|
|
v := url.Values{}
|
|
v.Set("value", "XXX")
|
|
resp, err := tests.PutForm(fmt.Sprintf("%s%s", s.URL(), "/v2/keys/foo/bar"), v)
|
|
assert.Equal(t, resp.StatusCode, http.StatusCreated)
|
|
body := tests.ReadBody(resp)
|
|
assert.Nil(t, err, "")
|
|
assert.Equal(t, string(body), `{"action":"set","node":{"key":"/foo/bar","value":"XXX","modifiedIndex":2,"createdIndex":2}}`, "")
|
|
})
|
|
}
|
|
|
|
// Ensures that a directory is created
|
|
//
|
|
// $ curl -X PUT localhost:4001/v2/keys/foo/bar?dir=true
|
|
//
|
|
func TestV2SetDirectory(t *testing.T) {
|
|
tests.RunServer(func(s *server.Server) {
|
|
resp, err := tests.PutForm(fmt.Sprintf("%s%s", s.URL(), "/v2/keys/foo?dir=true"), url.Values{})
|
|
assert.Equal(t, resp.StatusCode, http.StatusCreated)
|
|
body := tests.ReadBody(resp)
|
|
assert.Nil(t, err, "")
|
|
assert.Equal(t, string(body), `{"action":"set","node":{"key":"/foo","dir":true,"modifiedIndex":2,"createdIndex":2}}`, "")
|
|
})
|
|
}
|
|
|
|
// Ensures that a time-to-live is added to a key.
|
|
//
|
|
// $ curl -X PUT localhost:4001/v2/keys/foo/bar -d value=XXX -d ttl=20
|
|
//
|
|
func TestV2SetKeyWithTTL(t *testing.T) {
|
|
tests.RunServer(func(s *server.Server) {
|
|
t0 := time.Now()
|
|
v := url.Values{}
|
|
v.Set("value", "XXX")
|
|
v.Set("ttl", "20")
|
|
resp, _ := tests.PutForm(fmt.Sprintf("%s%s", s.URL(), "/v2/keys/foo/bar"), v)
|
|
assert.Equal(t, resp.StatusCode, http.StatusCreated)
|
|
body := tests.ReadBodyJSON(resp)
|
|
node := body["node"].(map[string]interface{})
|
|
assert.Equal(t, node["ttl"], 20, "")
|
|
|
|
// Make sure the expiration date is correct.
|
|
expiration, _ := time.Parse(time.RFC3339Nano, node["expiration"].(string))
|
|
assert.Equal(t, expiration.Sub(t0)/time.Second, 20, "")
|
|
})
|
|
}
|
|
|
|
// Ensures that an invalid time-to-live is returned as an error.
|
|
//
|
|
// $ curl -X PUT localhost:4001/v2/keys/foo/bar -d value=XXX -d ttl=bad_ttl
|
|
//
|
|
func TestV2SetKeyWithBadTTL(t *testing.T) {
|
|
tests.RunServer(func(s *server.Server) {
|
|
v := url.Values{}
|
|
v.Set("value", "XXX")
|
|
v.Set("ttl", "bad_ttl")
|
|
resp, _ := tests.PutForm(fmt.Sprintf("%s%s", s.URL(), "/v2/keys/foo/bar"), v)
|
|
assert.Equal(t, resp.StatusCode, http.StatusBadRequest)
|
|
body := tests.ReadBodyJSON(resp)
|
|
assert.Equal(t, body["errorCode"], 202, "")
|
|
assert.Equal(t, body["message"], "The given TTL in POST form is not a number", "")
|
|
assert.Equal(t, body["cause"], "Update", "")
|
|
})
|
|
}
|
|
|
|
// Ensures that a key is conditionally set if it previously did not exist.
|
|
//
|
|
// $ curl -X PUT localhost:4001/v2/keys/foo/bar -d value=XXX -d prevExist=false
|
|
//
|
|
func TestV2CreateKeySuccess(t *testing.T) {
|
|
tests.RunServer(func(s *server.Server) {
|
|
v := url.Values{}
|
|
v.Set("value", "XXX")
|
|
v.Set("prevExist", "false")
|
|
resp, _ := tests.PutForm(fmt.Sprintf("%s%s", s.URL(), "/v2/keys/foo/bar"), v)
|
|
assert.Equal(t, resp.StatusCode, http.StatusCreated)
|
|
body := tests.ReadBodyJSON(resp)
|
|
node := body["node"].(map[string]interface{})
|
|
assert.Equal(t, node["value"], "XXX", "")
|
|
})
|
|
}
|
|
|
|
// Ensures that a key is not conditionally set because it previously existed.
|
|
//
|
|
// $ curl -X PUT localhost:4001/v2/keys/foo/bar -d value=XXX -d prevExist=false
|
|
// $ curl -X PUT localhost:4001/v2/keys/foo/bar -d value=XXX -d prevExist=false -> fail
|
|
//
|
|
func TestV2CreateKeyFail(t *testing.T) {
|
|
tests.RunServer(func(s *server.Server) {
|
|
v := url.Values{}
|
|
v.Set("value", "XXX")
|
|
v.Set("prevExist", "false")
|
|
fullURL := fmt.Sprintf("%s%s", s.URL(), "/v2/keys/foo/bar")
|
|
resp, _ := tests.PutForm(fullURL, v)
|
|
assert.Equal(t, resp.StatusCode, http.StatusCreated)
|
|
tests.ReadBody(resp)
|
|
resp, _ = tests.PutForm(fullURL, v)
|
|
assert.Equal(t, resp.StatusCode, http.StatusPreconditionFailed)
|
|
body := tests.ReadBodyJSON(resp)
|
|
assert.Equal(t, body["errorCode"], 105, "")
|
|
assert.Equal(t, body["message"], "Key already exists", "")
|
|
assert.Equal(t, body["cause"], "/foo/bar", "")
|
|
})
|
|
}
|
|
|
|
// Ensures that a key is conditionally set only if it previously did exist.
|
|
//
|
|
// $ curl -X PUT localhost:4001/v2/keys/foo/bar -d value=XXX
|
|
// $ curl -X PUT localhost:4001/v2/keys/foo/bar -d value=YYY -d prevExist=true
|
|
//
|
|
func TestV2UpdateKeySuccess(t *testing.T) {
|
|
tests.RunServer(func(s *server.Server) {
|
|
v := url.Values{}
|
|
|
|
v.Set("value", "XXX")
|
|
fullURL := fmt.Sprintf("%s%s", s.URL(), "/v2/keys/foo/bar")
|
|
resp, _ := tests.PutForm(fullURL, v)
|
|
assert.Equal(t, resp.StatusCode, http.StatusCreated)
|
|
tests.ReadBody(resp)
|
|
|
|
v.Set("value", "YYY")
|
|
v.Set("prevExist", "true")
|
|
resp, _ = tests.PutForm(fullURL, v)
|
|
assert.Equal(t, resp.StatusCode, http.StatusOK)
|
|
body := tests.ReadBodyJSON(resp)
|
|
assert.Equal(t, body["action"], "update", "")
|
|
})
|
|
}
|
|
|
|
// Ensures that a key is not conditionally set if it previously did not exist.
|
|
//
|
|
// $ curl -X PUT localhost:4001/v2/keys/foo?dir=true
|
|
// $ curl -X PUT localhost:4001/v2/keys/foo/bar -d value=XXX -d prevExist=true
|
|
//
|
|
func TestV2UpdateKeyFailOnValue(t *testing.T) {
|
|
tests.RunServer(func(s *server.Server) {
|
|
v := url.Values{}
|
|
resp, _ := tests.PutForm(fmt.Sprintf("%s%s", s.URL(), "/v2/keys/foo?dir=true"), v)
|
|
|
|
assert.Equal(t, resp.StatusCode, http.StatusCreated)
|
|
v.Set("value", "YYY")
|
|
v.Set("prevExist", "true")
|
|
resp, _ = tests.PutForm(fmt.Sprintf("%s%s", s.URL(), "/v2/keys/foo/bar"), v)
|
|
assert.Equal(t, resp.StatusCode, http.StatusNotFound)
|
|
body := tests.ReadBodyJSON(resp)
|
|
assert.Equal(t, body["errorCode"], 100, "")
|
|
assert.Equal(t, body["message"], "Key not found", "")
|
|
assert.Equal(t, body["cause"], "/foo/bar", "")
|
|
})
|
|
}
|
|
|
|
// Ensures that a key is not conditionally set if it previously did not exist.
|
|
//
|
|
// $ curl -X PUT localhost:4001/v2/keys/foo -d value=YYY -d prevExist=true -> fail
|
|
// $ curl -X PUT localhost:4001/v2/keys/foo/bar -d value=YYY -d prevExist=true -> fail
|
|
//
|
|
func TestV2UpdateKeyFailOnMissingDirectory(t *testing.T) {
|
|
tests.RunServer(func(s *server.Server) {
|
|
v := url.Values{}
|
|
v.Set("value", "YYY")
|
|
v.Set("prevExist", "true")
|
|
resp, _ := tests.PutForm(fmt.Sprintf("%s%s", s.URL(), "/v2/keys/foo"), v)
|
|
assert.Equal(t, resp.StatusCode, http.StatusNotFound)
|
|
body := tests.ReadBodyJSON(resp)
|
|
assert.Equal(t, body["errorCode"], 100, "")
|
|
assert.Equal(t, body["message"], "Key not found", "")
|
|
assert.Equal(t, body["cause"], "/foo", "")
|
|
|
|
resp, _ = tests.PutForm(fmt.Sprintf("%s%s", s.URL(), "/v2/keys/foo/bar"), v)
|
|
assert.Equal(t, resp.StatusCode, http.StatusNotFound)
|
|
body = tests.ReadBodyJSON(resp)
|
|
assert.Equal(t, body["errorCode"], 100, "")
|
|
assert.Equal(t, body["message"], "Key not found", "")
|
|
assert.Equal(t, body["cause"], "/foo", "")
|
|
})
|
|
}
|
|
|
|
// Ensures that a key is set only if the previous index matches.
|
|
//
|
|
// $ curl -X PUT localhost:4001/v2/keys/foo/bar -d value=XXX
|
|
// $ curl -X PUT localhost:4001/v2/keys/foo/bar -d value=YYY -d prevIndex=1
|
|
//
|
|
func TestV2SetKeyCASOnIndexSuccess(t *testing.T) {
|
|
tests.RunServer(func(s *server.Server) {
|
|
v := url.Values{}
|
|
v.Set("value", "XXX")
|
|
fullURL := fmt.Sprintf("%s%s", s.URL(), "/v2/keys/foo/bar")
|
|
resp, _ := tests.PutForm(fullURL, v)
|
|
assert.Equal(t, resp.StatusCode, http.StatusCreated)
|
|
tests.ReadBody(resp)
|
|
v.Set("value", "YYY")
|
|
v.Set("prevIndex", "2")
|
|
resp, _ = tests.PutForm(fullURL, v)
|
|
assert.Equal(t, resp.StatusCode, http.StatusOK)
|
|
body := tests.ReadBodyJSON(resp)
|
|
assert.Equal(t, body["action"], "compareAndSwap", "")
|
|
node := body["node"].(map[string]interface{})
|
|
assert.Equal(t, node["value"], "YYY", "")
|
|
assert.Equal(t, node["modifiedIndex"], 3, "")
|
|
})
|
|
}
|
|
|
|
// Ensures that a key is not set if the previous index does not match.
|
|
//
|
|
// $ curl -X PUT localhost:4001/v2/keys/foo/bar -d value=XXX
|
|
// $ curl -X PUT localhost:4001/v2/keys/foo/bar -d value=YYY -d prevIndex=10
|
|
//
|
|
func TestV2SetKeyCASOnIndexFail(t *testing.T) {
|
|
tests.RunServer(func(s *server.Server) {
|
|
v := url.Values{}
|
|
v.Set("value", "XXX")
|
|
fullURL := fmt.Sprintf("%s%s", s.URL(), "/v2/keys/foo/bar")
|
|
resp, _ := tests.PutForm(fullURL, v)
|
|
assert.Equal(t, resp.StatusCode, http.StatusCreated)
|
|
tests.ReadBody(resp)
|
|
v.Set("value", "YYY")
|
|
v.Set("prevIndex", "10")
|
|
resp, _ = tests.PutForm(fullURL, v)
|
|
assert.Equal(t, resp.StatusCode, http.StatusPreconditionFailed)
|
|
body := tests.ReadBodyJSON(resp)
|
|
assert.Equal(t, body["errorCode"], 101, "")
|
|
assert.Equal(t, body["message"], "Compare failed", "")
|
|
assert.Equal(t, body["cause"], "[ != XXX] [10 != 2]", "")
|
|
assert.Equal(t, body["index"], 2, "")
|
|
})
|
|
}
|
|
|
|
// Ensures that an error is thrown if an invalid previous index is provided.
|
|
//
|
|
// $ curl -X PUT localhost:4001/v2/keys/foo/bar -d value=YYY -d prevIndex=bad_index
|
|
//
|
|
func TestV2SetKeyCASWithInvalidIndex(t *testing.T) {
|
|
tests.RunServer(func(s *server.Server) {
|
|
v := url.Values{}
|
|
v.Set("value", "YYY")
|
|
v.Set("prevIndex", "bad_index")
|
|
resp, _ := tests.PutForm(fmt.Sprintf("%s%s", s.URL(), "/v2/keys/foo/bar"), v)
|
|
assert.Equal(t, resp.StatusCode, http.StatusBadRequest)
|
|
body := tests.ReadBodyJSON(resp)
|
|
assert.Equal(t, body["errorCode"], 203, "")
|
|
assert.Equal(t, body["message"], "The given index in POST form is not a number", "")
|
|
assert.Equal(t, body["cause"], "CompareAndSwap", "")
|
|
})
|
|
}
|
|
|
|
// Ensures that a key is set only if the previous value matches.
|
|
//
|
|
// $ curl -X PUT localhost:4001/v2/keys/foo/bar -d value=XXX
|
|
// $ curl -X PUT localhost:4001/v2/keys/foo/bar -d value=YYY -d prevValue=XXX
|
|
//
|
|
func TestV2SetKeyCASOnValueSuccess(t *testing.T) {
|
|
tests.RunServer(func(s *server.Server) {
|
|
v := url.Values{}
|
|
v.Set("value", "XXX")
|
|
fullURL := fmt.Sprintf("%s%s", s.URL(), "/v2/keys/foo/bar")
|
|
resp, _ := tests.PutForm(fullURL, v)
|
|
assert.Equal(t, resp.StatusCode, http.StatusCreated)
|
|
tests.ReadBody(resp)
|
|
v.Set("value", "YYY")
|
|
v.Set("prevValue", "XXX")
|
|
resp, _ = tests.PutForm(fullURL, v)
|
|
assert.Equal(t, resp.StatusCode, http.StatusOK)
|
|
body := tests.ReadBodyJSON(resp)
|
|
assert.Equal(t, body["action"], "compareAndSwap", "")
|
|
node := body["node"].(map[string]interface{})
|
|
assert.Equal(t, node["value"], "YYY", "")
|
|
assert.Equal(t, node["modifiedIndex"], 3, "")
|
|
})
|
|
}
|
|
|
|
// Ensures that a key is not set if the previous value does not match.
|
|
//
|
|
// $ curl -X PUT localhost:4001/v2/keys/foo/bar -d value=XXX
|
|
// $ curl -X PUT localhost:4001/v2/keys/foo/bar -d value=YYY -d prevValue=AAA
|
|
//
|
|
func TestV2SetKeyCASOnValueFail(t *testing.T) {
|
|
tests.RunServer(func(s *server.Server) {
|
|
v := url.Values{}
|
|
v.Set("value", "XXX")
|
|
fullURL := fmt.Sprintf("%s%s", s.URL(), "/v2/keys/foo/bar")
|
|
resp, _ := tests.PutForm(fullURL, v)
|
|
assert.Equal(t, resp.StatusCode, http.StatusCreated)
|
|
tests.ReadBody(resp)
|
|
v.Set("value", "YYY")
|
|
v.Set("prevValue", "AAA")
|
|
resp, _ = tests.PutForm(fullURL, v)
|
|
assert.Equal(t, resp.StatusCode, http.StatusPreconditionFailed)
|
|
body := tests.ReadBodyJSON(resp)
|
|
assert.Equal(t, body["errorCode"], 101, "")
|
|
assert.Equal(t, body["message"], "Compare failed", "")
|
|
assert.Equal(t, body["cause"], "[AAA != XXX] [0 != 2]", "")
|
|
assert.Equal(t, body["index"], 2, "")
|
|
})
|
|
}
|
|
|
|
// Ensures that an error is returned if a blank prevValue is set.
|
|
//
|
|
// $ curl -X PUT localhost:4001/v2/keys/foo/bar -d value=XXX -d prevValue=
|
|
//
|
|
func TestV2SetKeyCASWithMissingValueFails(t *testing.T) {
|
|
tests.RunServer(func(s *server.Server) {
|
|
v := url.Values{}
|
|
v.Set("value", "XXX")
|
|
v.Set("prevValue", "")
|
|
resp, _ := tests.PutForm(fmt.Sprintf("%s%s", s.URL(), "/v2/keys/foo/bar"), v)
|
|
assert.Equal(t, resp.StatusCode, http.StatusBadRequest)
|
|
body := tests.ReadBodyJSON(resp)
|
|
assert.Equal(t, body["errorCode"], 201, "")
|
|
assert.Equal(t, body["message"], "PrevValue is Required in POST form", "")
|
|
assert.Equal(t, body["cause"], "CompareAndSwap", "")
|
|
})
|
|
}
|