Skip to content

Commit

Permalink
refactor: command names matching REST endpoints
Browse files Browse the repository at this point in the history 
- closes hyperledger-archives#1334

Signed-off-by: sudesh.shetty <sudesh.shetty@securekey.com>
  • Loading branch information
@sudeshrshetty
sudeshrshetty committed Feb 24, 2020
1 parent 0c0cf3e commit 417b6d7
Show file tree
Hide file tree
Showing 7 changed files with 88 additions and 88 deletions.
48 changes: 24 additions & 24 deletions pkg/controller/command/messaging/command.go
View file
Expand Up @@ -45,12 +45,12 @@ const (
errMsgIDEmpty = "empty message ID"

// command methods
registeredServicesCommandMethod = "RegisteredServices"
registerMessageServiceCommandMethod = "RegisterMessageService"
unregisterMessageServiceCommandMethod = "UnregisterMessageService"
registerHTTPMessageServiceCommandMethod = "RegisterHTTPMessageService"
sendNewMessageCommandMethod = "SendNewMessage"
sendReplyMessageCommandMethod = "SendReplyMessage"
registeredServicesCommandMethod = "Services"
registerMessageServiceCommandMethod = "RegisterService"
unregisterMessageServiceCommandMethod = "UnregisterService"
registerHTTPMessageServiceCommandMethod = "RegisterHTTPService"
sendNewMessageCommandMethod = "Send"
sendReplyMessageCommandMethod = "Reply"

// log constants
connectionIDString = "connectionID"
Expand Down Expand Up @@ -113,17 +113,17 @@ func New(ctx provider, registrar command.MessageHandler, notifier webhook.Notifi
// GetHandlers returns list of all commands supported by this controller command
func (o *Command) GetHandlers() []command.Handler {
return []command.Handler{
cmdutil.NewCommandHandler(commandName, registeredServicesCommandMethod, o.RegisteredServices),
cmdutil.NewCommandHandler(commandName, registerMessageServiceCommandMethod, o.RegisterMessageService),
cmdutil.NewCommandHandler(commandName, unregisterMessageServiceCommandMethod, o.UnregisterMessageService),
cmdutil.NewCommandHandler(commandName, registerHTTPMessageServiceCommandMethod, o.RegisterHTTPMessageService),
cmdutil.NewCommandHandler(commandName, sendNewMessageCommandMethod, o.SendNewMessage),
cmdutil.NewCommandHandler(commandName, sendReplyMessageCommandMethod, o.SendReplyMessage),
cmdutil.NewCommandHandler(commandName, registeredServicesCommandMethod, o.Services),
cmdutil.NewCommandHandler(commandName, registerMessageServiceCommandMethod, o.RegisterService),
cmdutil.NewCommandHandler(commandName, unregisterMessageServiceCommandMethod, o.UnregisterService),
cmdutil.NewCommandHandler(commandName, registerHTTPMessageServiceCommandMethod, o.RegisterHTTPService),
cmdutil.NewCommandHandler(commandName, sendNewMessageCommandMethod, o.Send),
cmdutil.NewCommandHandler(commandName, sendReplyMessageCommandMethod, o.Reply),
}
}

// RegisterMessageService registers new message service to message handler registrar
func (o *Command) RegisterMessageService(rw io.Writer, req io.Reader) command.Error {
// RegisterService registers new message service to message handler registrar
func (o *Command) RegisterService(rw io.Writer, req io.Reader) command.Error {
var request RegisterMsgSvcArgs

err := json.NewDecoder(req).Decode(&request)
Expand All @@ -135,8 +135,8 @@ func (o *Command) RegisterMessageService(rw io.Writer, req io.Reader) command.Er
return o.registerMessageService(&request)
}

// UnregisterMessageService unregisters given message service handler registrar
func (o *Command) UnregisterMessageService(rw io.Writer, req io.Reader) command.Error {
// UnregisterService unregisters given message service handler registrar
func (o *Command) UnregisterService(rw io.Writer, req io.Reader) command.Error {
var request UnregisterMsgSvcArgs

err := json.NewDecoder(req).Decode(&request)
Expand Down Expand Up @@ -164,8 +164,8 @@ func (o *Command) UnregisterMessageService(rw io.Writer, req io.Reader) command.
return nil
}

// RegisteredServices returns list of registered service names
func (o *Command) RegisteredServices(rw io.Writer, req io.Reader) command.Error {
// Services returns list of registered service names
func (o *Command) Services(rw io.Writer, req io.Reader) command.Error {
names := []string{}
for _, svc := range o.msgRegistrar.Services() {
names = append(names, svc.Name())
Expand All @@ -178,8 +178,8 @@ func (o *Command) RegisteredServices(rw io.Writer, req io.Reader) command.Error
return nil
}

// SendNewMessage sends new message to destination provided
func (o *Command) SendNewMessage(rw io.Writer, req io.Reader) command.Error {
// Send sends new message to destination provided
func (o *Command) Send(rw io.Writer, req io.Reader) command.Error {
var request SendNewMessageArgs

err := json.NewDecoder(req).Decode(&request)
Expand Down Expand Up @@ -224,8 +224,8 @@ func (o *Command) SendNewMessage(rw io.Writer, req io.Reader) command.Error {
return o.sendMessageToDestination(request.MessageBody, request.ServiceEndpointDestination)
}

// SendReplyMessage sends reply to existing message
func (o *Command) SendReplyMessage(rw io.Writer, req io.Reader) command.Error {
// Reply sends reply to existing message
func (o *Command) Reply(rw io.Writer, req io.Reader) command.Error {
var request SendReplyMessageArgs

err := json.NewDecoder(req).Decode(&request)
Expand All @@ -249,8 +249,8 @@ func (o *Command) SendReplyMessage(rw io.Writer, req io.Reader) command.Error {
return command.NewExecuteError(SendMsgReplyError, fmt.Errorf("to be implemented"))
}

// RegisterHTTPMessageService registers new http over didcomm service to message handler registrar
func (o *Command) RegisterHTTPMessageService(rw io.Writer, req io.Reader) command.Error {
// RegisterHTTPService registers new http over didcomm service to message handler registrar
func (o *Command) RegisterHTTPService(rw io.Writer, req io.Reader) command.Error {
var request RegisterHTTPMsgSvcArgs

err := json.NewDecoder(req).Decode(&request)
Expand Down
46 changes: 23 additions & 23 deletions pkg/controller/command/messaging/command_test.go
View file
Expand Up @@ -50,7 +50,7 @@ func TestNew(t *testing.T) {
})
}

func TestCommand_RegisterMessageService(t *testing.T) {
func TestCommand_RegisterService(t *testing.T) {
t.Run("Successful Register Message Service", func(t *testing.T) {
msgRegistrar := msghandler.NewMockMsgServiceProvider()
cmd, err := New(&protocol.MockProvider{}, msgRegistrar, webhook.NewMockWebhookNotifier())
Expand All @@ -64,7 +64,7 @@ func TestCommand_RegisterMessageService(t *testing.T) {
}`

var b bytes.Buffer
cmdErr := cmd.RegisterMessageService(&b, bytes.NewBufferString(jsonStr))
cmdErr := cmd.RegisterService(&b, bytes.NewBufferString(jsonStr))
require.NoError(t, cmdErr)
require.Empty(t, b.String())

Expand Down Expand Up @@ -114,7 +114,7 @@ func TestCommand_RegisterMessageService(t *testing.T) {
require.NotNil(t, cmd)

var b bytes.Buffer
cmdErr := cmd.RegisterMessageService(&b, bytes.NewBufferString(tc.json))
cmdErr := cmd.RegisterService(&b, bytes.NewBufferString(tc.json))
require.Error(t, cmdErr)
require.Empty(t, b.String())
require.Equal(t, cmdErr.Type(), command.ValidationError)
Expand All @@ -140,7 +140,7 @@ func TestCommand_RegisterMessageService(t *testing.T) {
}`

var b bytes.Buffer
cmdErr := cmd.RegisterMessageService(&b, bytes.NewBufferString(jsonStr))
cmdErr := cmd.RegisterService(&b, bytes.NewBufferString(jsonStr))
require.Error(t, cmdErr)
require.Empty(t, b.String())
require.Equal(t, cmdErr.Type(), command.ExecuteError)
Expand All @@ -149,7 +149,7 @@ func TestCommand_RegisterMessageService(t *testing.T) {
})
}

func TestCommand_RegisterHTTPMessageService(t *testing.T) {
func TestCommand_RegisterHTTPService(t *testing.T) {
t.Run("Successful Register HTTP Message Service", func(t *testing.T) {
msgRegistrar := msghandler.NewMockMsgServiceProvider()
cmd, err := New(&protocol.MockProvider{}, msgRegistrar, webhook.NewMockWebhookNotifier())
Expand All @@ -162,7 +162,7 @@ func TestCommand_RegisterHTTPMessageService(t *testing.T) {
}`

var b bytes.Buffer
cmdErr := cmd.RegisterHTTPMessageService(&b, bytes.NewBufferString(jsonStr))
cmdErr := cmd.RegisterHTTPService(&b, bytes.NewBufferString(jsonStr))
require.NoError(t, cmdErr)

// verify if new service is registered
Expand Down Expand Up @@ -205,7 +205,7 @@ func TestCommand_RegisterHTTPMessageService(t *testing.T) {
require.NotNil(t, cmd)

var b bytes.Buffer
cmdErr := cmd.RegisterHTTPMessageService(&b, bytes.NewBufferString(tc.json))
cmdErr := cmd.RegisterHTTPService(&b, bytes.NewBufferString(tc.json))
require.Error(t, cmdErr)
require.Empty(t, b.String())
require.Equal(t, cmdErr.Type(), command.ValidationError)
Expand All @@ -230,7 +230,7 @@ func TestCommand_RegisterHTTPMessageService(t *testing.T) {
}`

var b bytes.Buffer
cmdErr := cmd.RegisterHTTPMessageService(&b, bytes.NewBufferString(jsonStr))
cmdErr := cmd.RegisterHTTPService(&b, bytes.NewBufferString(jsonStr))
require.Error(t, cmdErr)
require.Empty(t, b.String())
require.Equal(t, cmdErr.Type(), command.ExecuteError)
Expand All @@ -239,7 +239,7 @@ func TestCommand_RegisterHTTPMessageService(t *testing.T) {
})
}

func TestCommand_UnregisterMessageService(t *testing.T) {
func TestCommand_UnregisterService(t *testing.T) {
t.Run("Unregistering non existing message service", func(t *testing.T) {
cmd, err := New(&protocol.MockProvider{}, msghandler.NewMockMsgServiceProvider(), webhook.NewMockWebhookNotifier())
require.NoError(t, err)
Expand All @@ -248,7 +248,7 @@ func TestCommand_UnregisterMessageService(t *testing.T) {
var jsonStr = `{"name":"json-msg-01"}`

var b bytes.Buffer
cmdErr := cmd.UnregisterMessageService(&b, bytes.NewBufferString(jsonStr))
cmdErr := cmd.UnregisterService(&b, bytes.NewBufferString(jsonStr))
require.Error(t, cmdErr)
require.Empty(t, b.String())
require.Equal(t, cmdErr.Type(), command.ExecuteError)
Expand All @@ -262,7 +262,7 @@ func TestCommand_UnregisterMessageService(t *testing.T) {
require.NotNil(t, cmd)

var b bytes.Buffer
cmdErr := cmd.UnregisterMessageService(&b, bytes.NewBufferString(`{"name":""}`))
cmdErr := cmd.UnregisterService(&b, bytes.NewBufferString(`{"name":""}`))
require.Error(t, cmdErr)
require.Empty(t, b.String())
require.Equal(t, cmdErr.Type(), command.ValidationError)
Expand All @@ -287,7 +287,7 @@ func TestCommand_UnregisterMessageService(t *testing.T) {
const jsonStr = `{"name":"%s"}`
for _, svcName := range svcNames {
var b bytes.Buffer
cmdErr := cmd.UnregisterMessageService(&b, bytes.NewBufferString(fmt.Sprintf(jsonStr, svcName)))
cmdErr := cmd.UnregisterService(&b, bytes.NewBufferString(fmt.Sprintf(jsonStr, svcName)))
require.NoError(t, cmdErr)
require.Empty(t, b.String())
}
Expand All @@ -301,7 +301,7 @@ func TestCommand_UnregisterMessageService(t *testing.T) {
require.NotNil(t, cmd)

var b bytes.Buffer
cmdErr := cmd.UnregisterMessageService(&b, bytes.NewBufferString(`{--`))
cmdErr := cmd.UnregisterService(&b, bytes.NewBufferString(`{--`))
require.Error(t, cmdErr)
require.Empty(t, b.String())
require.Equal(t, cmdErr.Type(), command.ValidationError)
Expand All @@ -310,7 +310,7 @@ func TestCommand_UnregisterMessageService(t *testing.T) {
})
}

func TestCommand_RegisteredServices(t *testing.T) {
func TestCommand_Services(t *testing.T) {
msgRegistrar := msghandler.NewMockMsgServiceProvider()
cmd, err := New(&protocol.MockProvider{}, msgRegistrar, webhook.NewMockWebhookNotifier())
require.NoError(t, err)
Expand All @@ -326,7 +326,7 @@ func TestCommand_RegisteredServices(t *testing.T) {
}

var b bytes.Buffer
cmdErr := cmd.RegisteredServices(&b, bytes.NewBufferString(``))
cmdErr := cmd.Services(&b, bytes.NewBufferString(``))
require.NoError(t, cmdErr)
verifyResponse(&b, 0)

Expand All @@ -341,12 +341,12 @@ func TestCommand_RegisteredServices(t *testing.T) {
require.NoError(t, err)

b.Reset()
cmdErr = cmd.RegisteredServices(&b, bytes.NewBufferString(``))
cmdErr = cmd.Services(&b, bytes.NewBufferString(``))
require.NoError(t, cmdErr)
verifyResponse(&b, len(testMsgSvcs))
}

func TestCommand_SendNewMessage(t *testing.T) {
func TestCommand_Send(t *testing.T) {
t.Run("Test input args validation", func(t *testing.T) {
tests := []struct {
name string
Expand Down Expand Up @@ -402,7 +402,7 @@ func TestCommand_SendNewMessage(t *testing.T) {
require.NotNil(t, cmd)

var b bytes.Buffer
cmdErr := cmd.SendNewMessage(&b, bytes.NewBufferString(tc.requestJSON))
cmdErr := cmd.Send(&b, bytes.NewBufferString(tc.requestJSON))
require.Error(t, cmdErr)
require.Empty(t, b.String())
require.Equal(t, cmdErr.Type(), command.ValidationError)
Expand Down Expand Up @@ -455,7 +455,7 @@ func TestCommand_SendNewMessage(t *testing.T) {
require.NotNil(t, cmd)

var b bytes.Buffer
cmdErr := cmd.SendNewMessage(&b, bytes.NewBufferString(tc.requestJSON))
cmdErr := cmd.Send(&b, bytes.NewBufferString(tc.requestJSON))
require.NoError(t, cmdErr)
require.Empty(t, b.String())
})
Expand Down Expand Up @@ -542,7 +542,7 @@ func TestCommand_SendNewMessage(t *testing.T) {
require.NotNil(t, cmd)

var b bytes.Buffer
cmdErr := cmd.SendNewMessage(&b, bytes.NewBufferString(tc.requestJSON))
cmdErr := cmd.Send(&b, bytes.NewBufferString(tc.requestJSON))
require.Error(t, cmdErr)
require.Empty(t, b.String())
require.Equal(t, cmdErr.Type(), command.ExecuteError)
Expand All @@ -553,7 +553,7 @@ func TestCommand_SendNewMessage(t *testing.T) {
})
}

func TestOperation_SendReplyMessage(t *testing.T) {
func TestOperation_Reply(t *testing.T) {
t.Run("Test input args validation", func(t *testing.T) {
tests := []struct {
name string
Expand Down Expand Up @@ -597,7 +597,7 @@ func TestOperation_SendReplyMessage(t *testing.T) {
require.NotNil(t, cmd)

var b bytes.Buffer
cmdErr := cmd.SendReplyMessage(&b, bytes.NewBufferString(tc.requestJSON))
cmdErr := cmd.Reply(&b, bytes.NewBufferString(tc.requestJSON))
require.Error(t, cmdErr)
require.Empty(t, b.String())
require.Equal(t, cmdErr.Type(), command.ValidationError)
Expand All @@ -614,7 +614,7 @@ func TestOperation_SendReplyMessage(t *testing.T) {
require.NotNil(t, cmd)

var b bytes.Buffer
cmdErr := cmd.SendReplyMessage(&b, bytes.NewBufferString(jsonMsg))
cmdErr := cmd.Reply(&b, bytes.NewBufferString(jsonMsg))
require.Error(t, cmdErr)
require.Empty(t, b.String())
require.Equal(t, cmdErr.Type(), command.ExecuteError)
Expand Down
10 changes: 5 additions & 5 deletions pkg/controller/command/route/command.go
View file
Expand Up @@ -35,7 +35,7 @@ const (
// UnregisterRouterErrorCode for unregister router error
UnregisterRouterErrorCode

// GetConnection for get connection id error
// Connection for get connection id error
GetConnectionIDErrorCode
)

Expand All @@ -46,7 +46,7 @@ const (
// command methods
registerCommandMethod = "Register"
unregisterCommandMethod = "Unregister"
getConnectionIDCommandMethod = "GetConnection"
getConnectionIDCommandMethod = "Connection"

// log constants
connectionID = "connectionID"
Expand Down Expand Up @@ -80,7 +80,7 @@ func (o *Command) GetHandlers() []command.Handler {
return []command.Handler{
cmdutil.NewCommandHandler(commandName, registerCommandMethod, o.Register),
cmdutil.NewCommandHandler(commandName, unregisterCommandMethod, o.Unregister),
cmdutil.NewCommandHandler(commandName, getConnectionIDCommandMethod, o.GetConnection),
cmdutil.NewCommandHandler(commandName, getConnectionIDCommandMethod, o.Connection),
}
}

Expand Down Expand Up @@ -130,8 +130,8 @@ func (o *Command) Unregister(rw io.Writer, req io.Reader) command.Error {
return nil
}

// GetConnection returns the connectionID of the router.
func (o *Command) GetConnection(rw io.Writer, req io.Reader) command.Error {
// Connection returns the connectionID of the router.
func (o *Command) Connection(rw io.Writer, req io.Reader) command.Error {
connectionID, err := o.routeClient.GetConnection()
if err != nil {
logutil.LogError(logger, commandName, getConnectionIDCommandMethod, err.Error())
Expand Down
4 changes: 2 additions & 2 deletions pkg/controller/command/route/command_test.go
View file
Expand Up @@ -158,7 +158,7 @@ func TestGetConnectionID(t *testing.T) {
require.NotNil(t, cmd)

var b bytes.Buffer
err = cmd.GetConnection(&b, nil)
err = cmd.Connection(&b, nil)
require.NoError(t, err)

response := RegisterRoute{}
Expand All @@ -179,7 +179,7 @@ func TestGetConnectionID(t *testing.T) {
require.NotNil(t, cmd)

var b bytes.Buffer
err = cmd.GetConnection(&b, nil)
err = cmd.Connection(&b, nil)
require.Error(t, err)
require.Contains(t, err.Error(), "get router connectionID")
})
Expand Down

0 comments on commit 417b6d7

Please sign in to comment.