mirror of
https://codeberg.org/forgejo/forgejo
synced 2024-11-25 11:16:11 +01:00
320ab7ed7f
This commit allows the `forgejo-cli actions register` command to change an existing runner's secret, as discussed in #4610. It refactors `RegisterRunner` to extract the code that hashes the token, moving this code to a method called `UpdateSecret` on `ActionRunner`. A test for the method has been added. The `RegisterRunner` function is updated so that: - it relies on `ActionRunner.UpdateSecret` when creating new runners, - it checks whether an existing runner's secret still matches the one passed on the command line, - it updates the runner's secret if it wasn't created and it no longer matches. A test has been added for the new behaviour.
179 lines
6.9 KiB
Go
179 lines
6.9 KiB
Go
// SPDX-License-Identifier: MIT
|
|
|
|
package actions
|
|
|
|
import (
|
|
"crypto/subtle"
|
|
"testing"
|
|
|
|
auth_model "code.gitea.io/gitea/models/auth"
|
|
"code.gitea.io/gitea/models/db"
|
|
"code.gitea.io/gitea/models/unittest"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
)
|
|
|
|
func TestActions_RegisterRunner_Token(t *testing.T) {
|
|
assert.NoError(t, unittest.PrepareTestDatabase())
|
|
ownerID := int64(0)
|
|
repoID := int64(0)
|
|
token := "0123456789012345678901234567890123456789"
|
|
labels := []string{}
|
|
name := "runner"
|
|
version := "v1.2.3"
|
|
runner, err := RegisterRunner(db.DefaultContext, ownerID, repoID, token, &labels, name, version)
|
|
assert.NoError(t, err)
|
|
assert.EqualValues(t, name, runner.Name)
|
|
|
|
assert.EqualValues(t, 1, subtle.ConstantTimeCompare([]byte(runner.TokenHash), []byte(auth_model.HashToken(token, runner.TokenSalt))), "the token cannot be verified with the same method as routers/api/actions/runner/interceptor.go as of 8228751c55d6a4263f0fec2932ca16181c09c97d")
|
|
}
|
|
|
|
// TestActions_RegisterRunner_TokenUpdate tests that a token's secret is updated
|
|
// when a runner already exists and RegisterRunner is called with a token
|
|
// parameter whose first 16 bytes match that record but where the last 24 bytes
|
|
// do not match.
|
|
func TestActions_RegisterRunner_TokenUpdate(t *testing.T) {
|
|
const recordID = 12345678
|
|
oldToken := "7e577e577e577e57feedfacefeedfacefeedface"
|
|
newToken := "7e577e577e577e57deadbeefdeadbeefdeadbeef"
|
|
assert.NoError(t, unittest.PrepareTestDatabase())
|
|
before := unittest.AssertExistsAndLoadBean(t, &ActionRunner{ID: recordID})
|
|
require.Equal(t,
|
|
before.TokenHash, auth_model.HashToken(oldToken, before.TokenSalt),
|
|
"the initial token should match the runner's secret",
|
|
)
|
|
|
|
RegisterRunner(db.DefaultContext, before.OwnerID, before.RepoID, newToken, nil, before.Name, before.Version)
|
|
|
|
after := unittest.AssertExistsAndLoadBean(t, &ActionRunner{ID: recordID})
|
|
|
|
assert.Equal(t, before.UUID, after.UUID)
|
|
assert.NotEqual(t,
|
|
after.TokenHash, auth_model.HashToken(oldToken, after.TokenSalt),
|
|
"the old token can still be verified",
|
|
)
|
|
assert.Equal(t,
|
|
after.TokenHash, auth_model.HashToken(newToken, after.TokenSalt),
|
|
"the new token cannot be verified",
|
|
)
|
|
}
|
|
|
|
func TestActions_RegisterRunner_CreateWithLabels(t *testing.T) {
|
|
assert.NoError(t, unittest.PrepareTestDatabase())
|
|
ownerID := int64(0)
|
|
repoID := int64(0)
|
|
token := "0123456789012345678901234567890123456789"
|
|
name := "runner"
|
|
version := "v1.2.3"
|
|
labels := []string{"woop", "doop"}
|
|
labelsCopy := labels // labels may be affected by the tested function so we copy them
|
|
|
|
runner, err := RegisterRunner(db.DefaultContext, ownerID, repoID, token, &labels, name, version)
|
|
assert.NoError(t, err)
|
|
|
|
// Check that the returned record has been updated, except for the labels
|
|
assert.EqualValues(t, ownerID, runner.OwnerID)
|
|
assert.EqualValues(t, repoID, runner.RepoID)
|
|
assert.EqualValues(t, name, runner.Name)
|
|
assert.EqualValues(t, version, runner.Version)
|
|
assert.EqualValues(t, labelsCopy, runner.AgentLabels)
|
|
|
|
// Check that whatever is in the DB has been updated, except for the labels
|
|
after := unittest.AssertExistsAndLoadBean(t, &ActionRunner{ID: runner.ID})
|
|
assert.EqualValues(t, ownerID, after.OwnerID)
|
|
assert.EqualValues(t, repoID, after.RepoID)
|
|
assert.EqualValues(t, name, after.Name)
|
|
assert.EqualValues(t, version, after.Version)
|
|
assert.EqualValues(t, labelsCopy, after.AgentLabels)
|
|
}
|
|
|
|
func TestActions_RegisterRunner_CreateWithoutLabels(t *testing.T) {
|
|
assert.NoError(t, unittest.PrepareTestDatabase())
|
|
ownerID := int64(0)
|
|
repoID := int64(0)
|
|
token := "0123456789012345678901234567890123456789"
|
|
name := "runner"
|
|
version := "v1.2.3"
|
|
|
|
runner, err := RegisterRunner(db.DefaultContext, ownerID, repoID, token, nil, name, version)
|
|
assert.NoError(t, err)
|
|
|
|
// Check that the returned record has been updated, except for the labels
|
|
assert.EqualValues(t, ownerID, runner.OwnerID)
|
|
assert.EqualValues(t, repoID, runner.RepoID)
|
|
assert.EqualValues(t, name, runner.Name)
|
|
assert.EqualValues(t, version, runner.Version)
|
|
assert.EqualValues(t, []string{}, runner.AgentLabels)
|
|
|
|
// Check that whatever is in the DB has been updated, except for the labels
|
|
after := unittest.AssertExistsAndLoadBean(t, &ActionRunner{ID: runner.ID})
|
|
assert.EqualValues(t, ownerID, after.OwnerID)
|
|
assert.EqualValues(t, repoID, after.RepoID)
|
|
assert.EqualValues(t, name, after.Name)
|
|
assert.EqualValues(t, version, after.Version)
|
|
assert.EqualValues(t, []string{}, after.AgentLabels)
|
|
}
|
|
|
|
func TestActions_RegisterRunner_UpdateWithLabels(t *testing.T) {
|
|
const recordID = 12345678
|
|
token := "7e577e577e577e57feedfacefeedfacefeedface"
|
|
assert.NoError(t, unittest.PrepareTestDatabase())
|
|
unittest.AssertExistsAndLoadBean(t, &ActionRunner{ID: recordID})
|
|
|
|
newOwnerID := int64(1)
|
|
newRepoID := int64(1)
|
|
newName := "rennur"
|
|
newVersion := "v4.5.6"
|
|
newLabels := []string{"warp", "darp"}
|
|
labelsCopy := newLabels // labels may be affected by the tested function so we copy them
|
|
|
|
runner, err := RegisterRunner(db.DefaultContext, newOwnerID, newRepoID, token, &newLabels, newName, newVersion)
|
|
assert.NoError(t, err)
|
|
|
|
// Check that the returned record has been updated
|
|
assert.EqualValues(t, newOwnerID, runner.OwnerID)
|
|
assert.EqualValues(t, newRepoID, runner.RepoID)
|
|
assert.EqualValues(t, newName, runner.Name)
|
|
assert.EqualValues(t, newVersion, runner.Version)
|
|
assert.EqualValues(t, labelsCopy, runner.AgentLabels)
|
|
|
|
// Check that whatever is in the DB has been updated
|
|
after := unittest.AssertExistsAndLoadBean(t, &ActionRunner{ID: recordID})
|
|
assert.EqualValues(t, newOwnerID, after.OwnerID)
|
|
assert.EqualValues(t, newRepoID, after.RepoID)
|
|
assert.EqualValues(t, newName, after.Name)
|
|
assert.EqualValues(t, newVersion, after.Version)
|
|
assert.EqualValues(t, labelsCopy, after.AgentLabels)
|
|
}
|
|
|
|
func TestActions_RegisterRunner_UpdateWithoutLabels(t *testing.T) {
|
|
const recordID = 12345678
|
|
token := "7e577e577e577e57feedfacefeedfacefeedface"
|
|
assert.NoError(t, unittest.PrepareTestDatabase())
|
|
before := unittest.AssertExistsAndLoadBean(t, &ActionRunner{ID: recordID})
|
|
|
|
newOwnerID := int64(1)
|
|
newRepoID := int64(1)
|
|
newName := "rennur"
|
|
newVersion := "v4.5.6"
|
|
|
|
runner, err := RegisterRunner(db.DefaultContext, newOwnerID, newRepoID, token, nil, newName, newVersion)
|
|
assert.NoError(t, err)
|
|
|
|
// Check that the returned record has been updated, except for the labels
|
|
assert.EqualValues(t, newOwnerID, runner.OwnerID)
|
|
assert.EqualValues(t, newRepoID, runner.RepoID)
|
|
assert.EqualValues(t, newName, runner.Name)
|
|
assert.EqualValues(t, newVersion, runner.Version)
|
|
assert.EqualValues(t, before.AgentLabels, runner.AgentLabels)
|
|
|
|
// Check that whatever is in the DB has been updated, except for the labels
|
|
after := unittest.AssertExistsAndLoadBean(t, &ActionRunner{ID: recordID})
|
|
assert.EqualValues(t, newOwnerID, after.OwnerID)
|
|
assert.EqualValues(t, newRepoID, after.RepoID)
|
|
assert.EqualValues(t, newName, after.Name)
|
|
assert.EqualValues(t, newVersion, after.Version)
|
|
assert.EqualValues(t, before.AgentLabels, after.AgentLabels)
|
|
}
|