mirror of
https://codeberg.org/forgejo/forgejo.git
synced 2024-09-21 19:20:11 +00:00
138942c09e
- Go's deadcode eliminator is quite simple, if you put a public function in a package `aa/bb` that is used only by tests, it would still be built if package `aa/bb` was imported. This means that if such functions use libraries relevant only to tests that those libraries would still be be built and increase the binary size of a Go binary. - This is also the case with Forgejo, `models/migrations/base/tests.go` contained functions exclusively used by tests which (skipping some steps here) imports https://github.com/ClickHouse/clickhouse-go, which is 2MiB. The `code.gitea.io/gitea/models/migrations/base` package is imported by `cmd/doctor` and thus the code of the clickhouse library is also built and included in the Forgejo binary, although entirely unused and not reachable. - This patch moves the test-related functions to their own package, so Go's deadcode eliminator knows not to build the test-related functions and thus reduces the size of the Forgejo binary. - It is not possible to move this to a `_test.go` file because Go does not allow importing functions from such files, so any test helper function must be in a non-test package and file. - Reduction of size (built with `TAGS="sqlite sqlite_unlock_notify" make build`): - Before: 95912040 bytes (92M) - After: 92306888 bytes (89M)
87 lines
2.5 KiB
Go
87 lines
2.5 KiB
Go
// Copyright 2022 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package v1_19 //nolint
|
|
|
|
import (
|
|
"testing"
|
|
|
|
migration_tests "code.gitea.io/gitea/models/migrations/test"
|
|
"code.gitea.io/gitea/modules/json"
|
|
"code.gitea.io/gitea/modules/secret"
|
|
"code.gitea.io/gitea/modules/setting"
|
|
webhook_module "code.gitea.io/gitea/modules/webhook"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
)
|
|
|
|
func Test_AddHeaderAuthorizationEncryptedColWebhook(t *testing.T) {
|
|
// Create Webhook table
|
|
type Webhook struct {
|
|
ID int64 `xorm:"pk autoincr"`
|
|
Type webhook_module.HookType `xorm:"VARCHAR(16) 'type'"`
|
|
Meta string `xorm:"TEXT"` // store hook-specific attributes
|
|
|
|
// HeaderAuthorizationEncrypted should be accessed using HeaderAuthorization() and SetHeaderAuthorization()
|
|
HeaderAuthorizationEncrypted string `xorm:"TEXT"`
|
|
}
|
|
|
|
type ExpectedWebhook struct {
|
|
ID int64 `xorm:"pk autoincr"`
|
|
Meta string
|
|
HeaderAuthorization string
|
|
}
|
|
|
|
type HookTask struct {
|
|
ID int64 `xorm:"pk autoincr"`
|
|
HookID int64
|
|
PayloadContent string `xorm:"LONGTEXT"`
|
|
}
|
|
|
|
// Prepare and load the testing database
|
|
x, deferable := migration_tests.PrepareTestEnv(t, 0, new(Webhook), new(ExpectedWebhook), new(HookTask))
|
|
defer deferable()
|
|
if x == nil || t.Failed() {
|
|
return
|
|
}
|
|
|
|
if err := AddHeaderAuthorizationEncryptedColWebhook(x); err != nil {
|
|
assert.NoError(t, err)
|
|
return
|
|
}
|
|
|
|
expected := []ExpectedWebhook{}
|
|
if err := x.Table("expected_webhook").Asc("id").Find(&expected); !assert.NoError(t, err) {
|
|
return
|
|
}
|
|
|
|
got := []Webhook{}
|
|
if err := x.Table("webhook").Select("id, meta, header_authorization_encrypted").Asc("id").Find(&got); !assert.NoError(t, err) {
|
|
return
|
|
}
|
|
|
|
for i, e := range expected {
|
|
assert.Equal(t, e.Meta, got[i].Meta)
|
|
|
|
if e.HeaderAuthorization == "" {
|
|
assert.Equal(t, "", got[i].HeaderAuthorizationEncrypted)
|
|
} else {
|
|
cipherhex := got[i].HeaderAuthorizationEncrypted
|
|
cleartext, err := secret.DecryptSecret(setting.SecretKey, cipherhex)
|
|
assert.NoError(t, err)
|
|
assert.Equal(t, e.HeaderAuthorization, cleartext)
|
|
}
|
|
}
|
|
|
|
// ensure that no hook_task has some remaining "access_token"
|
|
hookTasks := []HookTask{}
|
|
if err := x.Table("hook_task").Select("id, payload_content").Asc("id").Find(&hookTasks); !assert.NoError(t, err) {
|
|
return
|
|
}
|
|
for _, h := range hookTasks {
|
|
var m map[string]any
|
|
err := json.Unmarshal([]byte(h.PayloadContent), &m)
|
|
assert.NoError(t, err)
|
|
assert.Nil(t, m["access_token"])
|
|
}
|
|
}
|