-
Notifications
You must be signed in to change notification settings - Fork 0
/
apiMessageHandler.go
269 lines (240 loc) · 12.8 KB
/
apiMessageHandler.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
// Copyright 2015 ThoughtWorks, Inc.
// This file is part of Gauge.
// Gauge is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
// Gauge is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
// You should have received a copy of the GNU General Public License
// along with Gauge. If not, see <http://www.gnu.org/licenses/>.
package api
import (
"net"
"path/filepath"
"github.com/getgauge/common"
"github.com/getgauge/gauge/api/infoGatherer"
"github.com/getgauge/gauge/conceptExtractor"
"github.com/getgauge/gauge/config"
"github.com/getgauge/gauge/conn"
"github.com/getgauge/gauge/formatter"
"github.com/getgauge/gauge/gauge"
"github.com/getgauge/gauge/gauge_messages"
"github.com/getgauge/gauge/logger"
"github.com/getgauge/gauge/parser"
"github.com/getgauge/gauge/plugin"
"github.com/getgauge/gauge/refactor"
"github.com/getgauge/gauge/runner"
"github.com/getgauge/gauge/util"
"github.com/golang/protobuf/proto"
)
type gaugeAPIMessageHandler struct {
specInfoGatherer *infoGatherer.SpecInfoGatherer
Runner runner.Runner
}
func (handler *gaugeAPIMessageHandler) MessageBytesReceived(bytesRead []byte, connection net.Conn) {
apiMessage := &gauge_messages.APIMessage{}
var responseMessage *gauge_messages.APIMessage
err := proto.Unmarshal(bytesRead, apiMessage)
if err != nil {
logger.Errorf(false, "Failed to read API proto message: %s\n", err.Error())
responseMessage = handler.getErrorMessage(err)
} else {
logger.Debugf(false, "Api Request Received: %s", apiMessage)
messageType := apiMessage.GetMessageType()
switch messageType {
case gauge_messages.APIMessage_GetProjectRootRequest:
responseMessage = handler.projectRootRequestResponse(apiMessage)
break
case gauge_messages.APIMessage_GetInstallationRootRequest:
responseMessage = handler.installationRootRequestResponse(apiMessage)
break
case gauge_messages.APIMessage_GetAllStepsRequest:
responseMessage = handler.getAllStepsRequestResponse(apiMessage)
break
case gauge_messages.APIMessage_SpecsRequest:
responseMessage = handler.getSpecsRequestResponse(apiMessage)
break
case gauge_messages.APIMessage_GetStepValueRequest:
responseMessage = handler.getStepValueRequestResponse(apiMessage)
break
case gauge_messages.APIMessage_GetLanguagePluginLibPathRequest:
responseMessage = handler.getLanguagePluginLibPath(apiMessage)
break
case gauge_messages.APIMessage_GetAllConceptsRequest:
responseMessage = handler.getAllConceptsRequestResponse(apiMessage)
break
case gauge_messages.APIMessage_PerformRefactoringRequest:
responseMessage = handler.performRefactoring(apiMessage)
handler.performRefresh(responseMessage.PerformRefactoringResponse.FilesChanged)
break
case gauge_messages.APIMessage_ExtractConceptRequest:
responseMessage = handler.extractConcept(apiMessage)
break
case gauge_messages.APIMessage_FormatSpecsRequest:
responseMessage = handler.formatSpecs(apiMessage)
break
default:
responseMessage = handler.createUnsupportedAPIMessageResponse(apiMessage)
}
}
handler.sendMessage(responseMessage, connection)
}
func (handler *gaugeAPIMessageHandler) sendMessage(message *gauge_messages.APIMessage, connection net.Conn) {
logger.Debugf(false, "Sending API response: %s", message)
dataBytes, err := proto.Marshal(message)
if err != nil {
logger.Errorf(false, "Failed to respond to API request. Could not Marshal response %s\n", err.Error())
}
if err := conn.Write(connection, dataBytes); err != nil {
logger.Errorf(false, "Failed to respond to API request. Could not write response %s\n", err.Error())
}
}
func (handler *gaugeAPIMessageHandler) projectRootRequestResponse(message *gauge_messages.APIMessage) *gauge_messages.APIMessage {
projectRootResponse := &gauge_messages.GetProjectRootResponse{ProjectRoot: config.ProjectRoot}
return &gauge_messages.APIMessage{MessageType: gauge_messages.APIMessage_GetProjectRootResponse, MessageId: message.MessageId, ProjectRootResponse: projectRootResponse}
}
func (handler *gaugeAPIMessageHandler) installationRootRequestResponse(message *gauge_messages.APIMessage) *gauge_messages.APIMessage {
root, err := common.GetInstallationPrefix()
if err != nil {
logger.Errorf(false, "Failed to find installation root while responding to API request. %s\n", err.Error())
root = ""
}
installationRootResponse := &gauge_messages.GetInstallationRootResponse{InstallationRoot: root}
return &gauge_messages.APIMessage{MessageType: gauge_messages.APIMessage_GetInstallationRootResponse, MessageId: message.MessageId, InstallationRootResponse: installationRootResponse}
}
func (handler *gaugeAPIMessageHandler) getAllStepsRequestResponse(message *gauge_messages.APIMessage) *gauge_messages.APIMessage {
steps := handler.specInfoGatherer.Steps(true)
var stepValueResponses []*gauge_messages.ProtoStepValue
for _, step := range steps {
stepValue := parser.CreateStepValue(step)
stepValueResponses = append(stepValueResponses, gauge.ConvertToProtoStepValue(&stepValue))
}
getAllStepsResponse := &gauge_messages.GetAllStepsResponse{AllSteps: stepValueResponses}
return &gauge_messages.APIMessage{MessageType: gauge_messages.APIMessage_GetAllStepResponse, MessageId: message.MessageId, AllStepsResponse: getAllStepsResponse}
}
func (handler *gaugeAPIMessageHandler) getSpecsRequestResponse(message *gauge_messages.APIMessage) *gauge_messages.APIMessage {
getAllSpecsResponse := handler.createSpecsResponseMessageFor(handler.specInfoGatherer.GetAvailableSpecDetails(message.SpecsRequest.Specs))
return &gauge_messages.APIMessage{MessageType: gauge_messages.APIMessage_SpecsResponse, MessageId: message.MessageId, SpecsResponse: getAllSpecsResponse}
}
func (handler *gaugeAPIMessageHandler) getStepValueRequestResponse(message *gauge_messages.APIMessage) *gauge_messages.APIMessage {
request := message.GetStepValueRequest()
stepText := request.GetStepText()
hasInlineTable := request.GetHasInlineTable()
stepValue, err := parser.ExtractStepValueAndParams(stepText, hasInlineTable)
if err != nil {
return handler.getErrorResponse(message, err)
}
stepValueResponse := &gauge_messages.GetStepValueResponse{StepValue: gauge.ConvertToProtoStepValue(stepValue)}
return &gauge_messages.APIMessage{MessageType: gauge_messages.APIMessage_GetStepValueResponse, MessageId: message.MessageId, StepValueResponse: stepValueResponse}
}
func (handler *gaugeAPIMessageHandler) getAllConceptsRequestResponse(message *gauge_messages.APIMessage) *gauge_messages.APIMessage {
allConceptsResponse := handler.createGetAllConceptsResponseMessageFor(handler.specInfoGatherer.Concepts())
return &gauge_messages.APIMessage{MessageType: gauge_messages.APIMessage_GetAllConceptsResponse, MessageId: message.MessageId, AllConceptsResponse: allConceptsResponse}
}
func (handler *gaugeAPIMessageHandler) getLanguagePluginLibPath(message *gauge_messages.APIMessage) *gauge_messages.APIMessage {
libPathRequest := message.GetLibPathRequest()
language := libPathRequest.GetLanguage()
languageInstallDir, err := plugin.GetInstallDir(language, "")
if err != nil {
return handler.getErrorMessage(err)
}
runnerInfo, err := runner.GetRunnerInfo(language)
if err != nil {
return handler.getErrorMessage(err)
}
relativeLibPath := runnerInfo.Lib
libPath := filepath.Join(languageInstallDir, relativeLibPath)
response := &gauge_messages.GetLanguagePluginLibPathResponse{Path: libPath}
return &gauge_messages.APIMessage{MessageType: gauge_messages.APIMessage_GetLanguagePluginLibPathResponse, MessageId: message.MessageId, LibPathResponse: response}
}
func (handler *gaugeAPIMessageHandler) getErrorResponse(message *gauge_messages.APIMessage, err error) *gauge_messages.APIMessage {
errorResponse := &gauge_messages.ErrorResponse{Error: err.Error()}
return &gauge_messages.APIMessage{MessageType: gauge_messages.APIMessage_ErrorResponse, MessageId: message.MessageId, Error: errorResponse}
}
func (handler *gaugeAPIMessageHandler) getErrorMessage(err error) *gauge_messages.APIMessage {
id := common.GetUniqueID()
errorResponse := &gauge_messages.ErrorResponse{Error: err.Error()}
return &gauge_messages.APIMessage{MessageType: gauge_messages.APIMessage_ErrorResponse, MessageId: id, Error: errorResponse}
}
func (handler *gaugeAPIMessageHandler) createSpecsResponseMessageFor(details []*infoGatherer.SpecDetail) *gauge_messages.SpecsResponse {
specDetails := make([]*gauge_messages.SpecsResponse_SpecDetail, 0)
for _, d := range details {
detail := &gauge_messages.SpecsResponse_SpecDetail{}
if d.HasSpec() {
detail.Spec = gauge.ConvertToProtoSpec(d.Spec)
}
for _, e := range d.Errs {
detail.ParseErrors = append(detail.ParseErrors, &gauge_messages.Error{Type: gauge_messages.Error_PARSE_ERROR, Filename: e.FileName, Message: e.Message, LineNumber: int32(e.LineNo)})
}
specDetails = append(specDetails, detail)
}
return &gauge_messages.SpecsResponse{Details: specDetails}
}
func (handler *gaugeAPIMessageHandler) createGetAllConceptsResponseMessageFor(conceptInfos []*gauge_messages.ConceptInfo) *gauge_messages.GetAllConceptsResponse {
return &gauge_messages.GetAllConceptsResponse{Concepts: conceptInfos}
}
func (handler *gaugeAPIMessageHandler) performRefactoring(message *gauge_messages.APIMessage) *gauge_messages.APIMessage {
refactoringRequest := message.PerformRefactoringRequest
outFile, err := util.OpenFile(logger.ActiveLogFile)
if err != nil {
response := &gauge_messages.PerformRefactoringResponse{Success: false, Errors: []string{err.Error()}}
return &gauge_messages.APIMessage{MessageId: message.MessageId, MessageType: gauge_messages.APIMessage_PerformRefactoringResponse, PerformRefactoringResponse: response}
}
startChan := StartAPI(false, outFile)
refactoringResult := refactor.PerformRephraseRefactoring(refactoringRequest.GetOldStep(), refactoringRequest.GetNewStep(), startChan, handler.specInfoGatherer.SpecDirs)
if refactoringResult.Success {
logger.Infof(false, "%s", refactoringResult.String())
} else {
logger.Errorf(false, "Refactoring response from gauge. Errors : %s", refactoringResult.Errors)
}
response := &gauge_messages.PerformRefactoringResponse{Success: refactoringResult.Success, Errors: refactoringResult.Errors, FilesChanged: refactoringResult.AllFilesChanged()}
return &gauge_messages.APIMessage{MessageId: message.MessageId, MessageType: gauge_messages.APIMessage_PerformRefactoringResponse, PerformRefactoringResponse: response}
}
func (handler *gaugeAPIMessageHandler) performRefresh(files []string) {
for _, file := range files {
if util.IsConcept(file) {
handler.specInfoGatherer.OnConceptFileModify(file)
}
}
for _, file := range files {
if util.IsSpec(file) {
handler.specInfoGatherer.OnSpecFileModify(file)
}
}
}
func (handler *gaugeAPIMessageHandler) extractConcept(message *gauge_messages.APIMessage) *gauge_messages.APIMessage {
request := message.GetExtractConceptRequest()
success, err, filesChanged := conceptExtractor.ExtractConcept(request.GetConceptName(), request.GetSteps(), request.GetConceptFileName(), request.GetChangeAcrossProject(), request.GetSelectedTextInfo())
response := &gauge_messages.ExtractConceptResponse{IsSuccess: success, Error: err.Error(), FilesChanged: filesChanged}
return &gauge_messages.APIMessage{MessageId: message.MessageId, MessageType: gauge_messages.APIMessage_ExtractConceptResponse, ExtractConceptResponse: response}
}
func (handler *gaugeAPIMessageHandler) formatSpecs(message *gauge_messages.APIMessage) *gauge_messages.APIMessage {
request := message.GetFormatSpecsRequest()
results := formatter.FormatSpecFiles(request.GetSpecs()...)
var warnings []string
var errors []string
for _, result := range results {
if result.ParseErrors != nil {
for _, err := range result.ParseErrors {
errors = append(errors, err.Error())
}
}
if result.Warnings != nil {
var warningTexts []string
for _, warning := range result.Warnings {
warningTexts = append(warningTexts, warning.String())
}
warnings = append(warnings, warningTexts...)
}
}
formatResponse := &gauge_messages.FormatSpecsResponse{Errors: errors, Warnings: warnings}
return &gauge_messages.APIMessage{MessageId: message.MessageId, MessageType: gauge_messages.APIMessage_FormatSpecsResponse, FormatSpecsResponse: formatResponse}
}
func (handler *gaugeAPIMessageHandler) createUnsupportedAPIMessageResponse(message *gauge_messages.APIMessage) *gauge_messages.APIMessage {
return &gauge_messages.APIMessage{MessageId: message.MessageId,
MessageType: gauge_messages.APIMessage_UnsupportedApiMessageResponse,
UnsupportedApiMessageResponse: &gauge_messages.UnsupportedApiMessageResponse{}}
}