Rename GetAll* methods to List* (#291)

This commit is contained in:
Zachary Wasserman 2016-10-07 10:26:48 -07:00 committed by GitHub
parent db57aaa1fc
commit 24bb68b910
17 changed files with 69 additions and 66 deletions

View file

@ -18,7 +18,7 @@ type HostStore interface {
}
type HostService interface {
GetAllHosts(ctx context.Context) ([]*Host, error)
ListHosts(ctx context.Context) ([]*Host, error)
GetHost(ctx context.Context, id uint) (*Host, error)
DeleteHost(ctx context.Context, id uint) error
}

View file

@ -32,7 +32,7 @@ type LabelStore interface {
}
type LabelService interface {
GetAllLabels(ctx context.Context) ([]*Label, error)
ListLabels(ctx context.Context) ([]*Label, error)
GetLabel(ctx context.Context, id uint) (*Label, error)
NewLabel(ctx context.Context, p LabelPayload) (*Label, error)
ModifyLabel(ctx context.Context, id uint, p LabelPayload) (*Label, error)

View file

@ -29,7 +29,7 @@ type PackStore interface {
}
type PackService interface {
GetAllPacks(ctx context.Context) ([]*Pack, error)
ListPacks(ctx context.Context) ([]*Pack, error)
GetPack(ctx context.Context, id uint) (*Pack, error)
NewPack(ctx context.Context, p PackPayload) (*Pack, error)
ModifyPack(ctx context.Context, id uint, p PackPayload) (*Pack, error)

View file

@ -16,7 +16,7 @@ type QueryStore interface {
}
type QueryService interface {
GetAllQueries(ctx context.Context) ([]*Query, error)
ListQueries(ctx context.Context) ([]*Query, error)
GetQuery(ctx context.Context, id uint) (*Query, error)
NewQuery(ctx context.Context, p QueryPayload) (*Query, error)
ModifyQuery(ctx context.Context, id uint, p QueryPayload) (*Query, error)

View file

@ -36,21 +36,21 @@ func makeGetHostEndpoint(svc kolide.Service) endpoint.Endpoint {
// List Hosts
////////////////////////////////////////////////////////////////////////////////
type getAllHostsResponse struct {
type listHostsResponse struct {
Hosts []kolide.Host `json:"hosts"`
Err error `json:"error,omitempty"`
}
func (r getAllHostsResponse) error() error { return r.Err }
func (r listHostsResponse) error() error { return r.Err }
func makeGetAllHostsEndpoint(svc kolide.Service) endpoint.Endpoint {
func makeListHostsEndpoint(svc kolide.Service) endpoint.Endpoint {
return func(ctx context.Context, request interface{}) (interface{}, error) {
hosts, err := svc.GetAllHosts(ctx)
hosts, err := svc.ListHosts(ctx)
if err != nil {
return getAllHostsResponse{Err: err}, nil
return listHostsResponse{Err: err}, nil
}
resp := getAllHostsResponse{Hosts: []kolide.Host{}}
resp := listHostsResponse{Hosts: []kolide.Host{}}
for _, host := range hosts {
resp.Hosts = append(resp.Hosts, *host)
}

View file

@ -39,23 +39,24 @@ func makeGetLabelEndpoint(svc kolide.Service) endpoint.Endpoint {
}
////////////////////////////////////////////////////////////////////////////////
// Get All Labels
// List Labels
////////////////////////////////////////////////////////////////////////////////
type getAllLabelsResponse struct {
type listLabelsResponse struct {
Labels []getLabelResponse `json:"labels"`
Err error `json:"error,omitempty"`
}
func (r getAllLabelsResponse) error() error { return r.Err }
func (r listLabelsResponse) error() error { return r.Err }
func makeGetAllLabelsEndpoint(svc kolide.Service) endpoint.Endpoint {
func makeListLabelsEndpoint(svc kolide.Service) endpoint.Endpoint {
return func(ctx context.Context, request interface{}) (interface{}, error) {
labels, err := svc.GetAllLabels(ctx)
labels, err := svc.ListLabels(ctx)
if err != nil {
return getAllLabelsResponse{Err: err}, nil
return listLabelsResponse{Err: err}, nil
}
resp := getAllLabelsResponse{Labels: []getLabelResponse{}}
resp := listLabelsResponse{Labels: []getLabelResponse{}}
for _, label := range labels {
resp.Labels = append(resp.Labels, getLabelResponse{
ID: label.ID,

View file

@ -39,23 +39,24 @@ func makeGetPackEndpoint(svc kolide.Service) endpoint.Endpoint {
}
////////////////////////////////////////////////////////////////////////////////
// Get All Packs
// List Packs
////////////////////////////////////////////////////////////////////////////////
type getAllPacksResponse struct {
type listPacksResponse struct {
Packs []getPackResponse `json:"packs"`
Err error `json:"error,omitempty"`
}
func (r getAllPacksResponse) error() error { return r.Err }
func (r listPacksResponse) error() error { return r.Err }
func makeGetAllPacksEndpoint(svc kolide.Service) endpoint.Endpoint {
func makeListPacksEndpoint(svc kolide.Service) endpoint.Endpoint {
return func(ctx context.Context, request interface{}) (interface{}, error) {
packs, err := svc.GetAllPacks(ctx)
packs, err := svc.ListPacks(ctx)
if err != nil {
return getPackResponse{Err: err}, nil
}
resp := getAllPacksResponse{Packs: []getPackResponse{}}
resp := listPacksResponse{Packs: []getPackResponse{}}
for _, pack := range packs {
resp.Packs = append(resp.Packs, getPackResponse{
ID: pack.ID,

View file

@ -49,23 +49,24 @@ func makeGetQueryEndpoint(svc kolide.Service) endpoint.Endpoint {
}
////////////////////////////////////////////////////////////////////////////////
// Get All Queries
// List Queries
////////////////////////////////////////////////////////////////////////////////
type getAllQueriesResponse struct {
type listQueriesResponse struct {
Queries []getQueryResponse `json:"queries"`
Err error `json:"error,omitempty"`
}
func (r getAllQueriesResponse) error() error { return r.Err }
func (r listQueriesResponse) error() error { return r.Err }
func makeGetAllQueriesEndpoint(svc kolide.Service) endpoint.Endpoint {
func makeListQueriesEndpoint(svc kolide.Service) endpoint.Endpoint {
return func(ctx context.Context, request interface{}) (interface{}, error) {
queries, err := svc.GetAllQueries(ctx)
queries, err := svc.ListQueries(ctx)
if err != nil {
return getAllQueriesResponse{Err: err}, nil
return listQueriesResponse{Err: err}, nil
}
resp := getAllQueriesResponse{Queries: []getQueryResponse{}}
resp := listQueriesResponse{Queries: []getQueryResponse{}}
for _, query := range queries {
resp.Queries = append(resp.Queries, getQueryResponse{
ID: query.ID,

View file

@ -32,12 +32,12 @@ type KolideEndpoints struct {
ListInvites endpoint.Endpoint
DeleteInvite endpoint.Endpoint
GetQuery endpoint.Endpoint
GetAllQueries endpoint.Endpoint
ListQueries endpoint.Endpoint
CreateQuery endpoint.Endpoint
ModifyQuery endpoint.Endpoint
DeleteQuery endpoint.Endpoint
GetPack endpoint.Endpoint
GetAllPacks endpoint.Endpoint
ListPacks endpoint.Endpoint
CreatePack endpoint.Endpoint
ModifyPack endpoint.Endpoint
DeletePack endpoint.Endpoint
@ -50,7 +50,7 @@ type KolideEndpoints struct {
SubmitDistributedQueryResults endpoint.Endpoint
SubmitLogs endpoint.Endpoint
GetLabel endpoint.Endpoint
GetAllLabels endpoint.Endpoint
ListLabels endpoint.Endpoint
CreateLabel endpoint.Endpoint
ModifyLabel endpoint.Endpoint
DeleteLabel endpoint.Endpoint
@ -59,7 +59,7 @@ type KolideEndpoints struct {
DeleteLabelFromPack endpoint.Endpoint
GetHost endpoint.Endpoint
DeleteHost endpoint.Endpoint
GetAllHosts endpoint.Endpoint
ListHosts endpoint.Endpoint
}
// MakeKolideServerEndpoints creates the Kolide API endpoints.
@ -86,12 +86,12 @@ func MakeKolideServerEndpoints(svc kolide.Service, jwtKey string) KolideEndpoint
ListInvites: authenticatedUser(jwtKey, svc, mustBeAdmin(makeListInvitesEndpoint(svc))),
DeleteInvite: authenticatedUser(jwtKey, svc, mustBeAdmin(makeDeleteInviteEndpoint(svc))),
GetQuery: authenticatedUser(jwtKey, svc, makeGetQueryEndpoint(svc)),
GetAllQueries: authenticatedUser(jwtKey, svc, makeGetAllQueriesEndpoint(svc)),
ListQueries: authenticatedUser(jwtKey, svc, makeListQueriesEndpoint(svc)),
CreateQuery: authenticatedUser(jwtKey, svc, makeCreateQueryEndpoint(svc)),
ModifyQuery: authenticatedUser(jwtKey, svc, makeModifyQueryEndpoint(svc)),
DeleteQuery: authenticatedUser(jwtKey, svc, makeDeleteQueryEndpoint(svc)),
GetPack: authenticatedUser(jwtKey, svc, makeGetPackEndpoint(svc)),
GetAllPacks: authenticatedUser(jwtKey, svc, makeGetAllPacksEndpoint(svc)),
ListPacks: authenticatedUser(jwtKey, svc, makeListPacksEndpoint(svc)),
CreatePack: authenticatedUser(jwtKey, svc, makeCreatePackEndpoint(svc)),
ModifyPack: authenticatedUser(jwtKey, svc, makeModifyPackEndpoint(svc)),
DeletePack: authenticatedUser(jwtKey, svc, makeDeletePackEndpoint(svc)),
@ -99,7 +99,7 @@ func MakeKolideServerEndpoints(svc kolide.Service, jwtKey string) KolideEndpoint
GetQueriesInPack: authenticatedUser(jwtKey, svc, makeGetQueriesInPackEndpoint(svc)),
DeleteQueryFromPack: authenticatedUser(jwtKey, svc, makeDeleteQueryFromPackEndpoint(svc)),
GetHost: authenticatedUser(jwtKey, svc, makeGetHostEndpoint(svc)),
GetAllHosts: authenticatedUser(jwtKey, svc, makeGetAllHostsEndpoint(svc)),
ListHosts: authenticatedUser(jwtKey, svc, makeListHostsEndpoint(svc)),
DeleteHost: authenticatedUser(jwtKey, svc, makeDeleteHostEndpoint(svc)),
// Osquery endpoints
@ -109,7 +109,7 @@ func MakeKolideServerEndpoints(svc kolide.Service, jwtKey string) KolideEndpoint
SubmitDistributedQueryResults: authenticatedHost(svc, makeSubmitDistributedQueryResultsEndpoint(svc)),
SubmitLogs: authenticatedHost(svc, makeSubmitLogsEndpoint(svc)),
GetLabel: authenticatedUser(jwtKey, svc, makeGetLabelEndpoint(svc)),
GetAllLabels: authenticatedUser(jwtKey, svc, makeGetAllLabelsEndpoint(svc)),
ListLabels: authenticatedUser(jwtKey, svc, makeListLabelsEndpoint(svc)),
CreateLabel: authenticatedUser(jwtKey, svc, makeCreateLabelEndpoint(svc)),
ModifyLabel: authenticatedUser(jwtKey, svc, makeModifyLabelEndpoint(svc)),
DeleteLabel: authenticatedUser(jwtKey, svc, makeDeleteLabelEndpoint(svc)),
@ -139,12 +139,12 @@ type kolideHandlers struct {
ListInvites *kithttp.Server
DeleteInvite *kithttp.Server
GetQuery *kithttp.Server
GetAllQueries *kithttp.Server
ListQueries *kithttp.Server
CreateQuery *kithttp.Server
ModifyQuery *kithttp.Server
DeleteQuery *kithttp.Server
GetPack *kithttp.Server
GetAllPacks *kithttp.Server
ListPacks *kithttp.Server
CreatePack *kithttp.Server
ModifyPack *kithttp.Server
DeletePack *kithttp.Server
@ -157,7 +157,7 @@ type kolideHandlers struct {
SubmitDistributedQueryResults *kithttp.Server
SubmitLogs *kithttp.Server
GetLabel *kithttp.Server
GetAllLabels *kithttp.Server
ListLabels *kithttp.Server
CreateLabel *kithttp.Server
ModifyLabel *kithttp.Server
DeleteLabel *kithttp.Server
@ -166,7 +166,7 @@ type kolideHandlers struct {
DeleteLabelFromPack *kithttp.Server
GetHost *kithttp.Server
DeleteHost *kithttp.Server
GetAllHosts *kithttp.Server
ListHosts *kithttp.Server
}
func makeKolideKitHandlers(ctx context.Context, e KolideEndpoints, opts []kithttp.ServerOption) kolideHandlers {
@ -193,12 +193,12 @@ func makeKolideKitHandlers(ctx context.Context, e KolideEndpoints, opts []kithtt
ListInvites: newServer(e.ListInvites, decodeNoParamsRequest),
DeleteInvite: newServer(e.DeleteInvite, decodeDeleteInviteRequest),
GetQuery: newServer(e.GetQuery, decodeGetQueryRequest),
GetAllQueries: newServer(e.GetAllQueries, decodeNoParamsRequest),
ListQueries: newServer(e.ListQueries, decodeNoParamsRequest),
CreateQuery: newServer(e.CreateQuery, decodeCreateQueryRequest),
ModifyQuery: newServer(e.ModifyQuery, decodeModifyQueryRequest),
DeleteQuery: newServer(e.DeleteQuery, decodeDeleteQueryRequest),
GetPack: newServer(e.GetPack, decodeGetPackRequest),
GetAllPacks: newServer(e.GetAllPacks, decodeNoParamsRequest),
ListPacks: newServer(e.ListPacks, decodeNoParamsRequest),
CreatePack: newServer(e.CreatePack, decodeCreatePackRequest),
ModifyPack: newServer(e.ModifyPack, decodeModifyPackRequest),
DeletePack: newServer(e.DeletePack, decodeDeletePackRequest),
@ -211,7 +211,7 @@ func makeKolideKitHandlers(ctx context.Context, e KolideEndpoints, opts []kithtt
SubmitDistributedQueryResults: newServer(e.SubmitDistributedQueryResults, decodeSubmitDistributedQueryResultsRequest),
SubmitLogs: newServer(e.SubmitLogs, decodeSubmitLogsRequest),
GetLabel: newServer(e.GetLabel, decodeGetLabelRequest),
GetAllLabels: newServer(e.GetAllLabels, decodeNoParamsRequest),
ListLabels: newServer(e.ListLabels, decodeNoParamsRequest),
CreateLabel: newServer(e.CreateLabel, decodeCreateLabelRequest),
ModifyLabel: newServer(e.ModifyLabel, decodeModifyLabelRequest),
DeleteLabel: newServer(e.DeleteLabel, decodeDeleteLabelRequest),
@ -220,7 +220,7 @@ func makeKolideKitHandlers(ctx context.Context, e KolideEndpoints, opts []kithtt
DeleteLabelFromPack: newServer(e.DeleteLabelFromPack, decodeDeleteLabelFromPackRequest),
GetHost: newServer(e.GetHost, decodeGetHostRequest),
DeleteHost: newServer(e.DeleteHost, decodeDeleteHostRequest),
GetAllHosts: newServer(e.GetAllHosts, decodeNoParamsRequest),
ListHosts: newServer(e.ListHosts, decodeNoParamsRequest),
}
}
@ -270,13 +270,13 @@ func attachKolideAPIRoutes(r *mux.Router, h kolideHandlers) {
r.Handle("/api/v1/kolide/invites/{id}", h.DeleteInvite).Methods("DELETE")
r.Handle("/api/v1/kolide/queries/{id}", h.GetQuery).Methods("GET")
r.Handle("/api/v1/kolide/queries", h.GetAllQueries).Methods("GET")
r.Handle("/api/v1/kolide/queries", h.ListQueries).Methods("GET")
r.Handle("/api/v1/kolide/queries", h.CreateQuery).Methods("POST")
r.Handle("/api/v1/kolide/queries/{id}", h.ModifyQuery).Methods("PATCH")
r.Handle("/api/v1/kolide/queries/{id}", h.DeleteQuery).Methods("DELETE")
r.Handle("/api/v1/kolide/packs/{id}", h.GetPack).Methods("GET")
r.Handle("/api/v1/kolide/packs", h.GetAllPacks).Methods("GET")
r.Handle("/api/v1/kolide/packs", h.ListPacks).Methods("GET")
r.Handle("/api/v1/kolide/packs", h.CreatePack).Methods("POST")
r.Handle("/api/v1/kolide/packs/{id}", h.ModifyPack).Methods("PATCH")
r.Handle("/api/v1/kolide/packs/{id}", h.DeletePack).Methods("DELETE")
@ -284,7 +284,7 @@ func attachKolideAPIRoutes(r *mux.Router, h kolideHandlers) {
r.Handle("/api/v1/kolide/packs/{id}/queries", h.GetQueriesInPack).Methods("GET")
r.Handle("/api/v1/kolide/packs/{pid}/queries/{qid}", h.DeleteQueryFromPack).Methods("DELETE")
r.Handle("/api/v1/kolide/labels/{id}", h.GetLabel).Methods("GET")
r.Handle("/api/v1/kolide/labels", h.GetAllLabels).Methods("GET")
r.Handle("/api/v1/kolide/labels", h.ListLabels).Methods("GET")
r.Handle("/api/v1/kolide/labels", h.CreateLabel).Methods("POST")
r.Handle("/api/v1/kolide/labels/{id}", h.ModifyLabel).Methods("PATCH")
r.Handle("/api/v1/kolide/labels/{id}", h.DeleteLabel).Methods("DELETE")
@ -292,7 +292,7 @@ func attachKolideAPIRoutes(r *mux.Router, h kolideHandlers) {
r.Handle("/api/v1/kolide/packs/{pid}/labels", h.GetLabelsForPack).Methods("GET")
r.Handle("/api/v1/kolide/packs/{pid}/labels/{lid}", h.DeleteLabelFromPack).Methods("DELETE")
r.Handle("/api/v1/kolide/hosts", h.GetAllHosts).Methods("GET")
r.Handle("/api/v1/kolide/hosts", h.ListHosts).Methods("GET")
r.Handle("/api/v1/kolide/hosts/{id}", h.GetHost).Methods("GET")
r.Handle("/api/v1/kolide/hosts/{id}", h.DeleteHost).Methods("DELETE")

View file

@ -5,7 +5,7 @@ import (
"golang.org/x/net/context"
)
func (svc service) GetAllHosts(ctx context.Context) ([]*kolide.Host, error) {
func (svc service) ListHosts(ctx context.Context) ([]*kolide.Host, error) {
return svc.ds.Hosts()
}

View file

@ -9,7 +9,7 @@ import (
"golang.org/x/net/context"
)
func TestGetAllHosts(t *testing.T) {
func TestListHosts(t *testing.T) {
ds, err := datastore.New("gorm-sqlite3", ":memory:")
assert.Nil(t, err)
@ -18,7 +18,7 @@ func TestGetAllHosts(t *testing.T) {
ctx := context.Background()
hosts, err := svc.GetAllHosts(ctx)
hosts, err := svc.ListHosts(ctx)
assert.Nil(t, err)
assert.Len(t, hosts, 0)
@ -27,7 +27,7 @@ func TestGetAllHosts(t *testing.T) {
})
assert.Nil(t, err)
hosts, err = svc.GetAllHosts(ctx)
hosts, err = svc.ListHosts(ctx)
assert.Nil(t, err)
assert.Len(t, hosts, 1)
}

View file

@ -5,7 +5,7 @@ import (
"golang.org/x/net/context"
)
func (svc service) GetAllLabels(ctx context.Context) ([]*kolide.Label, error) {
func (svc service) ListLabels(ctx context.Context) ([]*kolide.Label, error) {
return svc.ds.Labels()
}

View file

@ -9,7 +9,7 @@ import (
"golang.org/x/net/context"
)
func TestGetAllLabels(t *testing.T) {
func TestListLabels(t *testing.T) {
ds, err := datastore.New("gorm-sqlite3", ":memory:")
assert.Nil(t, err)
@ -18,7 +18,7 @@ func TestGetAllLabels(t *testing.T) {
ctx := context.Background()
labels, err := svc.GetAllLabels(ctx)
labels, err := svc.ListLabels(ctx)
assert.Nil(t, err)
assert.Len(t, labels, 0)
@ -28,7 +28,7 @@ func TestGetAllLabels(t *testing.T) {
})
assert.Nil(t, err)
labels, err = svc.GetAllLabels(ctx)
labels, err = svc.ListLabels(ctx)
assert.Nil(t, err)
assert.Len(t, labels, 1)
assert.Equal(t, "foo", labels[0].Name)

View file

@ -5,7 +5,7 @@ import (
"golang.org/x/net/context"
)
func (svc service) GetAllPacks(ctx context.Context) ([]*kolide.Pack, error) {
func (svc service) ListPacks(ctx context.Context) ([]*kolide.Pack, error) {
return svc.ds.Packs()
}

View file

@ -9,7 +9,7 @@ import (
"golang.org/x/net/context"
)
func TestGetAllPacks(t *testing.T) {
func TestListPacks(t *testing.T) {
ds, err := datastore.New("gorm-sqlite3", ":memory:")
assert.Nil(t, err)
@ -18,7 +18,7 @@ func TestGetAllPacks(t *testing.T) {
ctx := context.Background()
queries, err := svc.GetAllPacks(ctx)
queries, err := svc.ListPacks(ctx)
assert.Nil(t, err)
assert.Len(t, queries, 0)
@ -27,7 +27,7 @@ func TestGetAllPacks(t *testing.T) {
})
assert.Nil(t, err)
queries, err = svc.GetAllPacks(ctx)
queries, err = svc.ListPacks(ctx)
assert.Nil(t, err)
assert.Len(t, queries, 1)
}

View file

@ -5,7 +5,7 @@ import (
"golang.org/x/net/context"
)
func (svc service) GetAllQueries(ctx context.Context) ([]*kolide.Query, error) {
func (svc service) ListQueries(ctx context.Context) ([]*kolide.Query, error) {
return svc.ds.Queries()
}

View file

@ -9,7 +9,7 @@ import (
"golang.org/x/net/context"
)
func TestGetAllQueries(t *testing.T) {
func TestListQueries(t *testing.T) {
ds, err := datastore.New("gorm-sqlite3", ":memory:")
assert.Nil(t, err)
@ -18,7 +18,7 @@ func TestGetAllQueries(t *testing.T) {
ctx := context.Background()
queries, err := svc.GetAllQueries(ctx)
queries, err := svc.ListQueries(ctx)
assert.Nil(t, err)
assert.Len(t, queries, 0)
@ -28,7 +28,7 @@ func TestGetAllQueries(t *testing.T) {
})
assert.Nil(t, err)
queries, err = svc.GetAllQueries(ctx)
queries, err = svc.ListQueries(ctx)
assert.Nil(t, err)
assert.Len(t, queries, 1)
}