implemented PR suggestions

Author: Matin Gohar Far

server/src/api/votings.go

@@ -87,6 +87,16 @@ func (s *Server) updateVoting(w http.ResponseWriter, r *http.Request) {
 	board := ctx.Value(identifiers.BoardIdentifier).(uuid.UUID)
 	id := ctx.Value(identifiers.VotingIdentifier).(uuid.UUID)
 
+	var body votings.VotingCloseRequest
+	if err := render.Decode(r, &body); err != nil {
+		span.SetStatus(codes.Error, "unable to decode body")
+		span.RecordError(err)
+		common.Throw(w, r, common.BadRequestError(err))
+		return
+	}
+	body.ID = id
+	body.Board = board
+
 	notes, err := s.notes.GetAll(ctx, board)
 	if err != nil {
 		span.SetStatus(codes.Error, "failed to get notes")
@@ -110,25 +120,7 @@ func (s *Server) updateVoting(w http.ResponseWriter, r *http.Request) {
 		})
 	}
 
-	var body votings.VotingCloseRequest
-
-	if r.ContentLength != 0 {
-		if err := render.Decode(r, &body); err != nil {
-			span.SetStatus(codes.Error, "unable to decode body")
-			span.RecordError(err)
-			common.Throw(w, r, common.BadRequestError(err))
-			return
-		}
-	}
-	body.ID = id
-	body.Board = board
-
-	var voting *votings.Voting
-	if body.Status == votings.Canceled {
-		voting, err = s.votings.Cancel(ctx, id, board, affectedNotes)
-	} else {
-		voting, err = s.votings.Close(ctx, id, board, affectedNotes)
-	}
+	voting, err := s.votings.Update(ctx, id, board, affectedNotes, body.Status)
 
 	if err != nil {
 		span.SetStatus(codes.Error, "failed to update voting")

server/src/api/votings_test.go

@@ -94,27 +94,28 @@ func (suite *VotingTestSuite) TestCloseVoting() {
 			s.votings = votingMock
 			s.notes = notesMock
 
-			req := technical_helper.NewTestRequestBuilder("PUT", "/", nil)
+			votingStatus := votings.Closed
+			req := technical_helper.NewTestRequestBuilder("PUT", "/", strings.NewReader(fmt.Sprintf(`{"status": "%s"}`, votingStatus)))
 			req.Req = logger.InitTestLoggerRequest(req.Request())
 			req.AddToContext(identifiers.BoardIdentifier, boardId).
 				AddToContext(identifiers.VotingIdentifier, votingId)
 			rr := httptest.NewRecorder()
 
 			notesMock.EXPECT().GetAll(mock.Anything, boardId).Return([]*notes.Note{}, nil)
 
-			votingMock.EXPECT().Close(mock.Anything, votingId, boardId, []votings.Note(nil)).
+			votingMock.EXPECT().Update(mock.Anything, votingId, boardId, []votings.Note(nil), votings.Closed).
 				Return(&votings.Voting{Status: votings.Closed}, tt.err)
 
 			s.updateVoting(rr, req.Request())
 			suite.Equal(tt.expectedCode, rr.Result().StatusCode)
 			votingMock.AssertExpectations(suite.T())
-			votingMock.AssertNumberOfCalls(suite.T(), "Close", 1)
+			votingMock.AssertNumberOfCalls(suite.T(), "Update", 1)
 		})
 	}
 
 }
 
-func (suite *VotingTestSuite) TestCancelVoting() {
+func (suite *VotingTestSuite) TestAbortVoting() {
 
 	testParameterBundles := *TestParameterBundles{}.
 		Append("all ok", http.StatusOK, nil, false, false, nil).
@@ -123,7 +124,6 @@ func (suite *VotingTestSuite) TestCancelVoting() {
 	for _, tt := range testParameterBundles {
 		suite.Run(tt.name, func() {
 			s := new(Server)
-			//s.basePath = "/"
 			votingMock := votings.NewMockVotingService(suite.T())
 			notesMock := notes.NewMockNotesService(suite.T())
 
@@ -132,21 +132,22 @@ func (suite *VotingTestSuite) TestCancelVoting() {
 			s.votings = votingMock
 			s.notes = notesMock
 
-			req := technical_helper.NewTestRequestBuilder("PUT", "/", strings.NewReader(`{"status": "ABORTED"}`))
+			votingStatus := votings.Aborted
+			req := technical_helper.NewTestRequestBuilder("PUT", "/", strings.NewReader(fmt.Sprintf(`{"status": "%s"}`, votingStatus)))
 			req.Req = logger.InitTestLoggerRequest(req.Request())
 			req.AddToContext(identifiers.BoardIdentifier, boardId).
 				AddToContext(identifiers.VotingIdentifier, votingId)
 
 			notesMock.EXPECT().GetAll(mock.Anything, boardId).Return([]*notes.Note{}, nil)
 
-			votingMock.EXPECT().Cancel(mock.Anything, votingId, boardId, []votings.Note(nil)).
-				Return(&votings.Voting{Status: votings.Canceled}, tt.err)
+			votingMock.EXPECT().Update(mock.Anything, votingId, boardId, []votings.Note(nil), votings.Aborted).
+				Return(&votings.Voting{Status: votings.Aborted}, tt.err)
 
 			rr := httptest.NewRecorder()
 			s.updateVoting(rr, req.Request())
 			suite.Equal(tt.expectedCode, rr.Result().StatusCode)
 			votingMock.AssertExpectations(suite.T())
-			votingMock.AssertNumberOfCalls(suite.T(), "Cancel", 1)
+			votingMock.AssertNumberOfCalls(suite.T(), "Update", 1)
 		})
 	}
 }

server/src/votings/api.go

@@ -14,8 +14,7 @@ type VotingService interface {
 	GetVotes(ctx context.Context, board uuid.UUID, f VoteFilter) ([]*Vote, error)
 	AddVote(ctx context.Context, req VoteRequest) (*Vote, error)
 	RemoveVote(ctx context.Context, req VoteRequest) error
-	Close(ctx context.Context, id uuid.UUID, board uuid.UUID, affectedNotes []Note) (*Voting, error)
-	Cancel(ctx context.Context, id uuid.UUID, board uuid.UUID, affectedNotes []Note) (*Voting, error)
+	Update(ctx context.Context, id uuid.UUID, board uuid.UUID, affectedNotes []Note, votingStatus VotingStatus) (*Voting, error)
 }
 
 type VotingApi struct {

server/src/votings/database.go

@@ -29,7 +29,7 @@ func (d *DB) Create(ctx context.Context, insert DatabaseVotingInsert) (DatabaseV
 	return voting, err
 }
 
-func (d *DB) Close(ctx context.Context, update DatabaseVotingUpdate) (DatabaseVoting, error) {
+func (d *DB) Update(ctx context.Context, update DatabaseVotingUpdate) (DatabaseVoting, error) {
 	var voting DatabaseVoting
 
 	if update.Status == Closed {

server/src/votings/database_test.go

@@ -78,7 +78,7 @@ func (suite *DatabaseVotingTestSuite) Test_Database_Close() {
 	votingId := suite.baseData.Votings["Update"].ID
 	boardId := suite.baseData.Boards["Update"].ID
 
-	dbVoting, err := database.Close(context.Background(),
+	dbVoting, err := database.Update(context.Background(),
 		DatabaseVotingUpdate{
 			ID:     votingId,
 			Board:  boardId,
@@ -290,18 +290,18 @@ func (suite *DatabaseVotingTestSuite) Test_Database_Cancel() {
 	votingId := suite.baseData.Votings["Update"].ID
 	boardId := suite.baseData.Boards["Update"].ID
 
-	dbVoting, err := database.Close(context.Background(),
+	dbVoting, err := database.Update(context.Background(),
 		DatabaseVotingUpdate{
 			ID:     votingId,
 			Board:  boardId,
-			Status: Canceled,
+			Status: Aborted,
 		},
 	)
 
 	assert.Nil(t, err)
 	assert.Equal(t, votingId, dbVoting.ID)
 	assert.Equal(t, boardId, dbVoting.Board)
-	assert.Equal(t, Canceled, dbVoting.Status)
+	assert.Equal(t, Aborted, dbVoting.Status)
 	assert.Equal(t, 7, dbVoting.VoteLimit)
 	assert.True(t, dbVoting.AllowMultipleVotes)
 	assert.False(t, dbVoting.ShowVotesOfOthers)

server/src/votings/dto.go

@@ -49,9 +49,9 @@ type VotingCreateRequest struct {
 
 // VotingCloseRequest represents the request to update a voting session.
 type VotingCloseRequest struct {
-	ID    uuid.UUID   `json:"-"`
-	Board uuid.UUID  `json:"-"`
-	Status VotingStatus `json:"status,omitempty"`
+	ID     uuid.UUID    `json:"-"`
+	Board  uuid.UUID    `json:"-"`
+	Status VotingStatus `json:"status"`
 }
 
 // Voting is the response for all voting requests.