mirror of
https://github.com/empayre/fleet.git
synced 2024-11-06 08:55:24 +00:00
3757aace08
#8129 Apart from fixing the issue in #8129, this change also introduces UUIDs to Fleet errors. To be able to match a returned error from the API to a error in the Fleet logs. See https://fleetdm.slack.com/archives/C019WG4GH0A/p1677780622769939 for more context. Samples with the changes in this PR: ``` curl -k -H "Authorization: Bearer $TEST_TOKEN" -H 'Content-Type:application/json' "https://localhost:8080/api/v1/fleet/sso" -d '' { "message": "Bad request", "errors": [ { "name": "base", "reason": "Expected JSON Body" } ], "uuid": "a01f6e10-354c-4ff0-b96e-1f64adb500b0" } ``` ``` curl -k -H "Authorization: Bearer $TEST_TOKEN" -H 'Content-Type:application/json' "https://localhost:8080/api/v1/fleet/sso" -d 'asd' { "message": "Bad request", "errors": [ { "name": "base", "reason": "json decoder error" } ], "uuid": "5f716a64-7550-464b-a1dd-e6a505a9f89d" } ``` ``` curl -k -X GET -H "Authorization: Bearer badtoken" "https://localhost:8080/api/latest/fleet/teams" { "message": "Authentication required", "errors": [ { "name": "base", "reason": "Authentication required" } ], "uuid": "efe45bc0-f956-4bf9-ba4f-aa9020a9aaaf" } ``` ``` curl -k -X PATCH -H "Authorization: Bearer $TEST_TOKEN" "https://localhost:8080/api/latest/fleet/users/14" -d '{"name": "Manuel2", "password": "what", "new_password": "p4ssw0rd.12345"}' { "message": "Authorization header required", "errors": [ { "name": "base", "reason": "Authorization header required" } ], "uuid": "57f78cd0-4559-464f-9df7-36c9ef7c89b3" } ``` ``` curl -k -X PATCH -H "Authorization: Bearer $TEST_TOKEN" "https://localhost:8080/api/latest/fleet/users/14" -d '{"name": "Manuel2", "password": "what", "new_password": "p4ssw0rd.12345"}' { "message": "Permission Denied", "uuid": "7f0220ad-6de7-4faf-8b6c-8d7ff9d2ca06" } ``` - [X] Changes file added for user-visible changes in `changes/` or `orbit/changes/`. See [Changes files](https://fleetdm.com/docs/contributing/committing-changes#changes-files) for more information. - [X] Documented any API changes (docs/Using-Fleet/REST-API.md or docs/Contributing/API-for-contributors.md) - ~[ ] Documented any permissions changes~ - ~[ ] Input data is properly validated, `SELECT *` is avoided, SQL injection is prevented (using placeholders for values in statements)~ - ~[ ] Added support on fleet's osquery simulator `cmd/osquery-perf` for new osquery data ingestion features.~ - [X] Added/updated tests - [X] Manual QA for all new/changed functionality - For Orbit and Fleet Desktop changes: - [X] Manual QA must be performed in the three main OSs, macOS, Windows and Linux. - ~[ ] Auto-update manual QA, from released version of component to new version (see [tools/tuf/test](../tools/tuf/test/README.md)).~
93 lines
1.7 KiB
Go
93 lines
1.7 KiB
Go
package service
|
|
|
|
import (
|
|
"context"
|
|
"net/http"
|
|
"net/http/httptest"
|
|
"testing"
|
|
|
|
"github.com/fleetdm/fleet/v4/server/fleet"
|
|
"github.com/stretchr/testify/assert"
|
|
)
|
|
|
|
type foreignKeyError struct{}
|
|
|
|
func (foreignKeyError) IsForeignKey() bool { return true }
|
|
func (foreignKeyError) Error() string { return "" }
|
|
|
|
type alreadyExists struct{}
|
|
|
|
func (alreadyExists) IsExists() bool { return false }
|
|
func (alreadyExists) Error() string { return "" }
|
|
|
|
type newAndExciting struct{}
|
|
|
|
func (newAndExciting) Error() string { return "" }
|
|
|
|
func TestHandlesErrorsCode(t *testing.T) {
|
|
errorTests := []struct {
|
|
name string
|
|
err error
|
|
code int
|
|
}{
|
|
{
|
|
"validation",
|
|
fleet.NewInvalidArgumentError("a", "b"),
|
|
http.StatusUnprocessableEntity,
|
|
},
|
|
{
|
|
"permission",
|
|
fleet.NewPermissionError("a"),
|
|
http.StatusForbidden,
|
|
},
|
|
{
|
|
"foreign key",
|
|
foreignKeyError{},
|
|
http.StatusUnprocessableEntity,
|
|
},
|
|
{
|
|
"mail error",
|
|
mailError{},
|
|
http.StatusInternalServerError,
|
|
},
|
|
{
|
|
"osquery error - invalid node",
|
|
&osqueryError{nodeInvalid: true},
|
|
http.StatusUnauthorized,
|
|
},
|
|
{
|
|
"osquery error - valid node",
|
|
&osqueryError{},
|
|
http.StatusInternalServerError,
|
|
},
|
|
{
|
|
"data not found",
|
|
¬FoundError{},
|
|
http.StatusNotFound,
|
|
},
|
|
{
|
|
"already exists",
|
|
alreadyExists{},
|
|
http.StatusConflict,
|
|
},
|
|
{
|
|
"status coder",
|
|
fleet.NewAuthFailedError(""),
|
|
http.StatusUnauthorized,
|
|
},
|
|
{
|
|
"default",
|
|
newAndExciting{},
|
|
http.StatusInternalServerError,
|
|
},
|
|
}
|
|
|
|
for _, tt := range errorTests {
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
recorder := httptest.NewRecorder()
|
|
encodeError(context.Background(), tt.err, recorder)
|
|
assert.Equal(t, recorder.Code, tt.code)
|
|
})
|
|
}
|
|
}
|