mirror of
https://github.com/gitpod-io/gitpod.git
synced 2025-12-08 17:36:30 +00:00
03d6f19013
Add a minimal Stripe event payload for an `invoice.finalized` event. Ensure all tests send event payloads. The only event type of interest for the webhook is `invoice.finalized` so other event types can have empty payloads.
130 lines
2.9 KiB
Go
130 lines
2.9 KiB
Go
// Copyright (c) 2022 Gitpod GmbH. All rights reserved.
|
|
// Licensed under the GNU Affero General Public License (AGPL).
|
|
// See License-AGPL.txt in the project root for license information.
|
|
|
|
package webhooks
|
|
|
|
import (
|
|
"fmt"
|
|
"io"
|
|
"net/http"
|
|
"strings"
|
|
"testing"
|
|
|
|
"github.com/gitpod-io/gitpod/common-go/baseserver"
|
|
"github.com/stretchr/testify/require"
|
|
)
|
|
|
|
// https://stripe.com/docs/api/events/types
|
|
const (
|
|
invoiceUpdatedEventType = "invoice.updated"
|
|
invoiceFinalizedEventType = "invoice.finalized"
|
|
customerCreatedEventType = "customer.created"
|
|
)
|
|
|
|
func TestWebhookAcceptsPostRequests(t *testing.T) {
|
|
scenarios := []struct {
|
|
HttpMethod string
|
|
ExpectedStatusCode int
|
|
}{
|
|
{
|
|
HttpMethod: http.MethodPost,
|
|
ExpectedStatusCode: http.StatusOK,
|
|
},
|
|
{
|
|
HttpMethod: http.MethodGet,
|
|
ExpectedStatusCode: http.StatusBadRequest,
|
|
},
|
|
{
|
|
HttpMethod: http.MethodPut,
|
|
ExpectedStatusCode: http.StatusBadRequest,
|
|
},
|
|
}
|
|
|
|
srv := baseServerWithStripeWebhook(t)
|
|
|
|
payload := payloadForStripeEvent(t, invoiceFinalizedEventType)
|
|
|
|
url := fmt.Sprintf("%s%s", srv.HTTPAddress(), "/webhook")
|
|
|
|
for _, scenario := range scenarios {
|
|
t.Run(scenario.HttpMethod, func(t *testing.T) {
|
|
req, err := http.NewRequest(scenario.HttpMethod, url, payload)
|
|
require.NoError(t, err)
|
|
|
|
resp, err := http.DefaultClient.Do(req)
|
|
require.NoError(t, err)
|
|
|
|
require.Equal(t, scenario.ExpectedStatusCode, resp.StatusCode)
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestWebhookIgnoresIrrelevantEvents(t *testing.T) {
|
|
scenarios := []struct {
|
|
EventType string
|
|
ExpectedStatusCode int
|
|
}{
|
|
{
|
|
EventType: invoiceFinalizedEventType,
|
|
ExpectedStatusCode: http.StatusOK,
|
|
},
|
|
{
|
|
EventType: invoiceUpdatedEventType,
|
|
ExpectedStatusCode: http.StatusBadRequest,
|
|
},
|
|
{
|
|
EventType: customerCreatedEventType,
|
|
ExpectedStatusCode: http.StatusBadRequest,
|
|
},
|
|
}
|
|
|
|
srv := baseServerWithStripeWebhook(t)
|
|
|
|
url := fmt.Sprintf("%s%s", srv.HTTPAddress(), "/webhook")
|
|
|
|
for _, scenario := range scenarios {
|
|
t.Run(scenario.EventType, func(t *testing.T) {
|
|
payload := payloadForStripeEvent(t, scenario.EventType)
|
|
req, err := http.NewRequest(http.MethodPost, url, payload)
|
|
require.NoError(t, err)
|
|
|
|
resp, err := http.DefaultClient.Do(req)
|
|
require.NoError(t, err)
|
|
|
|
require.Equal(t, scenario.ExpectedStatusCode, resp.StatusCode)
|
|
})
|
|
}
|
|
}
|
|
|
|
func baseServerWithStripeWebhook(t *testing.T) *baseserver.Server {
|
|
t.Helper()
|
|
|
|
srv := baseserver.NewForTests(t,
|
|
baseserver.WithHTTP(baseserver.MustUseRandomLocalAddress(t)),
|
|
)
|
|
baseserver.StartServerForTests(t, srv)
|
|
|
|
srv.HTTPMux().Handle("/webhook", NewStripeWebhookHandler())
|
|
|
|
return srv
|
|
}
|
|
|
|
func payloadForStripeEvent(t *testing.T, eventType string) io.Reader {
|
|
t.Helper()
|
|
|
|
if eventType != invoiceFinalizedEventType {
|
|
return strings.NewReader(`{}`)
|
|
}
|
|
return strings.NewReader(`
|
|
{
|
|
"data": {
|
|
"object": {
|
|
"id": "in_1LUQi7GadRXm50o36jWK7ehs"
|
|
}
|
|
},
|
|
"type": "invoice.finalized"
|
|
}
|
|
`)
|
|
}
|