[chore/bugfix/horror] Allow expires_in and poll choices to be parsed from strings (#2346)

This commit is contained in:
tobi 2023-11-10 17:42:48 +01:00 committed by GitHub
commit c7ecab9e6f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
14 changed files with 579 additions and 194 deletions

View file

@ -0,0 +1,102 @@
// GoToSocial
// Copyright (C) GoToSocial Authors admin@gotosocial.org
// SPDX-License-Identifier: AGPL-3.0-or-later
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program 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 Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
package polls_test
import (
"github.com/stretchr/testify/suite"
"github.com/superseriousbusiness/gotosocial/internal/api/client/polls"
"github.com/superseriousbusiness/gotosocial/internal/db"
"github.com/superseriousbusiness/gotosocial/internal/email"
"github.com/superseriousbusiness/gotosocial/internal/federation"
"github.com/superseriousbusiness/gotosocial/internal/gtsmodel"
"github.com/superseriousbusiness/gotosocial/internal/media"
"github.com/superseriousbusiness/gotosocial/internal/processing"
"github.com/superseriousbusiness/gotosocial/internal/state"
"github.com/superseriousbusiness/gotosocial/internal/storage"
"github.com/superseriousbusiness/gotosocial/internal/typeutils"
"github.com/superseriousbusiness/gotosocial/internal/visibility"
"github.com/superseriousbusiness/gotosocial/testrig"
)
type PollsStandardTestSuite struct {
suite.Suite
db db.DB
storage *storage.Driver
mediaManager *media.Manager
federator *federation.Federator
processor *processing.Processor
emailSender email.Sender
sentEmails map[string]string
state state.State
// standard suite models
testTokens map[string]*gtsmodel.Token
testClients map[string]*gtsmodel.Client
testApplications map[string]*gtsmodel.Application
testUsers map[string]*gtsmodel.User
testAccounts map[string]*gtsmodel.Account
testStatuses map[string]*gtsmodel.Status
testPolls map[string]*gtsmodel.Poll
// module being tested
pollsModule *polls.Module
}
func (suite *PollsStandardTestSuite) SetupSuite() {
suite.testTokens = testrig.NewTestTokens()
suite.testClients = testrig.NewTestClients()
suite.testApplications = testrig.NewTestApplications()
suite.testUsers = testrig.NewTestUsers()
suite.testAccounts = testrig.NewTestAccounts()
suite.testStatuses = testrig.NewTestStatuses()
suite.testPolls = testrig.NewTestPolls()
}
func (suite *PollsStandardTestSuite) SetupTest() {
suite.state.Caches.Init()
testrig.StartWorkers(&suite.state)
testrig.InitTestConfig()
testrig.InitTestLog()
suite.db = testrig.NewTestDB(&suite.state)
suite.state.DB = suite.db
suite.storage = testrig.NewInMemoryStorage()
suite.state.Storage = suite.storage
testrig.StartTimelines(
&suite.state,
visibility.NewFilter(&suite.state),
typeutils.NewConverter(&suite.state),
)
suite.mediaManager = testrig.NewTestMediaManager(&suite.state)
suite.federator = testrig.NewTestFederator(&suite.state, testrig.NewTestTransportController(&suite.state, testrig.NewMockHTTPClient(nil, "../../../../testrig/media")), suite.mediaManager)
suite.sentEmails = make(map[string]string)
suite.emailSender = testrig.NewEmailSender("../../../../web/template/", suite.sentEmails)
suite.processor = testrig.NewTestProcessor(&suite.state, suite.federator, suite.emailSender, suite.mediaManager)
suite.pollsModule = polls.New(suite.processor)
testrig.StandardDBSetup(suite.db, nil)
testrig.StandardStorageSetup(suite.storage, "../../../../testrig/media")
}
func (suite *PollsStandardTestSuite) TearDownTest() {
testrig.StandardDBTeardown(suite.db)
testrig.StandardStorageTeardown(suite.storage)
testrig.StopWorkers(&suite.state)
}

View file

@ -18,7 +18,9 @@
package polls
import (
"fmt"
"net/http"
"strconv"
"github.com/gin-gonic/gin"
apimodel "github.com/superseriousbusiness/gotosocial/internal/api/model"
@ -97,9 +99,8 @@ func (m *Module) PollVotePOSTHandler(c *gin.Context) {
return
}
var form apimodel.PollVoteRequest
if err := c.ShouldBind(&form); err != nil {
choices, err := bindChoices(c)
if err != nil {
errWithCode := gtserror.NewErrorBadRequest(err, err.Error())
apiutil.ErrorHandler(c, errWithCode, m.processor.InstanceGetV1)
return
@ -109,7 +110,7 @@ func (m *Module) PollVotePOSTHandler(c *gin.Context) {
c.Request.Context(),
authed.Account,
pollID,
form.Choices,
choices,
)
if errWithCode != nil {
apiutil.ErrorHandler(c, errWithCode, m.processor.InstanceGetV1)
@ -118,3 +119,51 @@ func (m *Module) PollVotePOSTHandler(c *gin.Context) {
c.JSON(http.StatusOK, poll)
}
func bindChoices(c *gin.Context) ([]int, error) {
var form apimodel.PollVoteRequest
if err := c.ShouldBind(&form); err != nil {
return nil, err
}
if form.Choices != nil {
// Easiest option: we parsed
// from a form successfully.
return form.Choices, nil
}
// More difficult option: we
// parsed choices from json.
//
// Convert submitted choices
// into the ints we need.
choices := make([]int, 0, len(form.ChoicesI))
for _, choiceI := range form.ChoicesI {
switch i := choiceI.(type) {
// JSON numbers normally
// parse into float64.
//
// This is the most likely
// option so try it first.
case float64:
choices = append(choices, int(i))
// Fallback option for funky
// clients (pinafore, semaphore).
case string:
choice, err := strconv.Atoi(i)
if err != nil {
return nil, err
}
choices = append(choices, choice)
default:
// Nothing else will do.
return nil, fmt.Errorf("could not parse json poll choice %T to integer", choiceI)
}
}
return choices, nil
}

View file

@ -0,0 +1,189 @@
// GoToSocial
// Copyright (C) GoToSocial Authors admin@gotosocial.org
// SPDX-License-Identifier: AGPL-3.0-or-later
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program 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 Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
package polls_test
import (
"bytes"
"encoding/json"
"io"
"net/http"
"net/http/httptest"
"strconv"
"testing"
"github.com/stretchr/testify/suite"
"github.com/superseriousbusiness/gotosocial/internal/api/client/polls"
apimodel "github.com/superseriousbusiness/gotosocial/internal/api/model"
"github.com/superseriousbusiness/gotosocial/internal/config"
"github.com/superseriousbusiness/gotosocial/internal/gtserror"
"github.com/superseriousbusiness/gotosocial/internal/oauth"
"github.com/superseriousbusiness/gotosocial/testrig"
)
type PollCreateTestSuite struct {
PollsStandardTestSuite
}
func (suite *PollCreateTestSuite) voteInPoll(
pollID string,
contentType string,
body io.Reader,
expectedHTTPStatus int,
expectedBody string,
) (*apimodel.Poll, error) {
// instantiate recorder + test context
recorder := httptest.NewRecorder()
ctx, _ := testrig.CreateGinTestContext(recorder, nil)
ctx.Set(oauth.SessionAuthorizedAccount, suite.testAccounts["admin_account"])
ctx.Set(oauth.SessionAuthorizedToken, oauth.DBTokenToToken(suite.testTokens["admin_account"]))
ctx.Set(oauth.SessionAuthorizedApplication, suite.testApplications["application_1"])
ctx.Set(oauth.SessionAuthorizedUser, suite.testUsers["admin_account"])
// create the request
ctx.Request = httptest.NewRequest(http.MethodPost, config.GetProtocol()+"://"+config.GetHost()+"/api/"+polls.BasePath+"/"+pollID, body)
ctx.Request.Header.Set("accept", "application/json")
ctx.Request.Header.Set("content-type", contentType)
ctx.AddParam("id", pollID)
// trigger the handler
suite.pollsModule.PollVotePOSTHandler(ctx)
// read the response
result := recorder.Result()
defer result.Body.Close()
b, err := io.ReadAll(result.Body)
if err != nil {
return nil, err
}
errs := gtserror.NewMultiError(2)
// check code + body
if resultCode := recorder.Code; expectedHTTPStatus != resultCode {
errs.Appendf("expected %d got %d", expectedHTTPStatus, resultCode)
}
// if we got an expected body, return early
if expectedBody != "" {
if string(b) != expectedBody {
errs.Appendf("expected %s got %s", expectedBody, string(b))
}
return nil, errs.Combine()
}
resp := &apimodel.Poll{}
if err := json.Unmarshal(b, resp); err != nil {
return nil, err
}
return resp, nil
}
func (suite *PollCreateTestSuite) formVoteInPoll(
pollID string,
choices []int,
expectedHTTPStatus int,
expectedBody string,
) (*apimodel.Poll, error) {
choicesStrs := make([]string, 0, len(choices))
for _, choice := range choices {
choicesStrs = append(choicesStrs, strconv.Itoa(choice))
}
body, w, err := testrig.CreateMultipartFormData("", "", map[string][]string{
"choices[]": choicesStrs,
})
if err != nil {
suite.FailNow(err.Error())
}
b := body.Bytes()
suite.T().Log(string(b))
return suite.voteInPoll(
pollID,
w.FormDataContentType(),
bytes.NewReader(b),
expectedHTTPStatus,
expectedBody,
)
}
func (suite *PollCreateTestSuite) jsonVoteInPoll(
pollID string,
choices []interface{},
expectedHTTPStatus int,
expectedBody string,
) (*apimodel.Poll, error) {
form := apimodel.PollVoteRequest{ChoicesI: choices}
b, err := json.Marshal(&form)
if err != nil {
suite.FailNow(err.Error())
}
suite.T().Log(string(b))
return suite.voteInPoll(
pollID,
"application/json",
bytes.NewReader(b),
expectedHTTPStatus,
expectedBody,
)
}
func (suite *PollCreateTestSuite) TestPollVoteForm() {
targetPoll := suite.testPolls["local_account_1_status_6_poll"]
poll, err := suite.formVoteInPoll(targetPoll.ID, []int{2}, http.StatusOK, "")
if err != nil {
suite.FailNow(err.Error())
}
suite.NotEmpty(poll)
}
func (suite *PollCreateTestSuite) TestPollVoteJSONInt() {
targetPoll := suite.testPolls["local_account_1_status_6_poll"]
poll, err := suite.jsonVoteInPoll(targetPoll.ID, []interface{}{2}, http.StatusOK, "")
if err != nil {
suite.FailNow(err.Error())
}
suite.NotEmpty(poll)
}
func (suite *PollCreateTestSuite) TestPollVoteJSONStr() {
targetPoll := suite.testPolls["local_account_1_status_6_poll"]
poll, err := suite.jsonVoteInPoll(targetPoll.ID, []interface{}{"2"}, http.StatusOK, "")
if err != nil {
suite.FailNow(err.Error())
}
suite.NotEmpty(poll)
}
func TestPollCreateTestSuite(t *testing.T) {
suite.Run(t, &PollCreateTestSuite{})
}