mirrors/dendrite
1
0
Fork 0
mirror of https://github.com/matrix-org/dendrite.git synced 2026-01-20 04:23:09 -06:00
Code Issues Packages Projects Releases Wiki Activity

Update/fix upgrade tests

Browse source
This commit is contained in:
Till Faelligen 2023-02-14 12:02:29 +01:00
parent fbe58a17d1
commit ea9827c2a2
No known key found for this signature in database
GPG key ID: ACCDC9606D472758
2 changed files with 64 additions and 37 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

90
cmd/dendrite-upgrade-tests/main.go
View file

@ -45,6 +45,10 @@ var (
const HEAD = "HEAD" const HEAD = "HEAD"
// The binary was renamed after v0.11.1, so everything after that should use the new name
var binaryChangeVersion, _ = semver.NewVersion("v0.11.1")
var latest, _ = semver.NewVersion("v6.6.6") // Dummy version, used as "HEAD"
// Embed the Dockerfile to use when building dendrite versions. // Embed the Dockerfile to use when building dendrite versions.
// We cannot use the dockerfile associated with the repo with each version sadly due to changes in // We cannot use the dockerfile associated with the repo with each version sadly due to changes in
// Docker versions. Specifically, earlier Dendrite versions are incompatible with newer Docker clients // Docker versions. Specifically, earlier Dendrite versions are incompatible with newer Docker clients
@ -54,12 +58,13 @@ const HEAD = "HEAD"
const DockerfilePostgreSQL = `FROM golang:1.18-stretch as build const DockerfilePostgreSQL = `FROM golang:1.18-stretch as build
RUN apt-get update && apt-get install -y postgresql RUN apt-get update && apt-get install -y postgresql
WORKDIR /build WORKDIR /build
ARG BINARY
# Copy the build context to the repo as this is the right dendrite code. This is different to the # Copy the build context to the repo as this is the right dendrite code. This is different to the
# Complement Dockerfile which wgets a branch. # Complement Dockerfile which wgets a branch.
COPY . . COPY . .
RUN go build ./cmd/dendrite RUN go build ./cmd/${BINARY}
RUN go build ./cmd/generate-keys RUN go build ./cmd/generate-keys
RUN go build ./cmd/generate-config RUN go build ./cmd/generate-config
RUN go build ./cmd/create-account RUN go build ./cmd/create-account
@ -88,22 +93,24 @@ done \n\
\n\ \n\
sed -i "s/server_name: localhost/server_name: ${SERVER_NAME}/g" dendrite.yaml \n\ sed -i "s/server_name: localhost/server_name: ${SERVER_NAME}/g" dendrite.yaml \n\
PARAMS="--tls-cert server.crt --tls-key server.key --config dendrite.yaml" \n\ PARAMS="--tls-cert server.crt --tls-key server.key --config dendrite.yaml" \n\
./dendrite --really-enable-open-registration ${PARAMS} || ./dendrite ${PARAMS} \n\ ./${BINARY} --really-enable-open-registration ${PARAMS} || ./${BINARY} ${PARAMS} \n\
' > run_dendrite.sh && chmod +x run_dendrite.sh ' > run_dendrite.sh && chmod +x run_dendrite.sh
ENV SERVER_NAME=localhost ENV SERVER_NAME=localhost
ENV BINARY=dendrite
EXPOSE 8008 8448 EXPOSE 8008 8448
CMD /build/run_dendrite.sh ` CMD /build/run_dendrite.sh`
const DockerfileSQLite = `FROM golang:1.18-stretch as build const DockerfileSQLite = `FROM golang:1.18-stretch as build
RUN apt-get update && apt-get install -y postgresql RUN apt-get update && apt-get install -y postgresql
WORKDIR /build WORKDIR /build
ARG BINARY
# Copy the build context to the repo as this is the right dendrite code. This is different to the # Copy the build context to the repo as this is the right dendrite code. This is different to the
# Complement Dockerfile which wgets a branch. # Complement Dockerfile which wgets a branch.
COPY . . COPY . .
RUN go build ./cmd/dendrite RUN go build ./cmd/${BINARY}
RUN go build ./cmd/generate-keys RUN go build ./cmd/generate-keys
RUN go build ./cmd/generate-config RUN go build ./cmd/generate-config
RUN go build ./cmd/create-account RUN go build ./cmd/create-account
@ -118,10 +125,11 @@ RUN sed -i "s%connection_string:.file:%connection_string: file:\/var\/lib\/postg
RUN echo '\ RUN echo '\
sed -i "s/server_name: localhost/server_name: ${SERVER_NAME}/g" dendrite.yaml \n\ sed -i "s/server_name: localhost/server_name: ${SERVER_NAME}/g" dendrite.yaml \n\
PARAMS="--tls-cert server.crt --tls-key server.key --config dendrite.yaml" \n\ PARAMS="--tls-cert server.crt --tls-key server.key --config dendrite.yaml" \n\
./dendrite --really-enable-open-registration ${PARAMS} || ./dendrite ${PARAMS} \n\ ./${BINARY} --really-enable-open-registration ${PARAMS} || ./${BINARY} ${PARAMS} \n\
' > run_dendrite.sh && chmod +x run_dendrite.sh ' > run_dendrite.sh && chmod +x run_dendrite.sh
ENV SERVER_NAME=localhost ENV SERVER_NAME=localhost
ENV BINARY=dendrite
EXPOSE 8008 8448 EXPOSE 8008 8448
CMD /build/run_dendrite.sh ` CMD /build/run_dendrite.sh `
@ -182,7 +190,7 @@ func downloadArchive(cli *http.Client, tmpDir, archiveURL string, dockerfile []b
} }
// buildDendrite builds Dendrite on the branchOrTagName given. Returns the image ID or an error // buildDendrite builds Dendrite on the branchOrTagName given. Returns the image ID or an error
func buildDendrite(httpClient *http.Client, dockerClient *client.Client, tmpDir, branchOrTagName string) (string, error) { func buildDendrite(httpClient *http.Client, dockerClient *client.Client, tmpDir string, branchOrTagName, binary string) (string, error) {
var tarball *bytes.Buffer var tarball *bytes.Buffer
var err error var err error
// If a custom HEAD location is given, use that, else pull from github. Mostly useful for CI // If a custom HEAD location is given, use that, else pull from github. Mostly useful for CI
@ -216,6 +224,9 @@ func buildDendrite(httpClient *http.Client, dockerClient *client.Client, tmpDir,
log.Printf("%s: Building version %s\n", branchOrTagName, branchOrTagName) log.Printf("%s: Building version %s\n", branchOrTagName, branchOrTagName)
res, err := dockerClient.ImageBuild(context.Background(), tarball, types.ImageBuildOptions{ res, err := dockerClient.ImageBuild(context.Background(), tarball, types.ImageBuildOptions{
Tags: []string{"dendrite-upgrade"}, Tags: []string{"dendrite-upgrade"},
BuildArgs: map[string]*string{
"BINARY": &binary,
},
}) })
if err != nil { if err != nil {
return "", fmt.Errorf("failed to start building image: %s", err) return "", fmt.Errorf("failed to start building image: %s", err)
@ -272,7 +283,7 @@ func getAndSortVersionsFromGithub(httpClient *http.Client) (semVers []*semver.Ve
return semVers, nil return semVers, nil
} }
func calculateVersions(cli *http.Client, from, to string, direct bool) []string { func calculateVersions(cli *http.Client, from, to string, direct bool) ([]*semver.Version, bool) {
semvers, err := getAndSortVersionsFromGithub(cli) semvers, err := getAndSortVersionsFromGithub(cli)
if err != nil { if err != nil {
log.Fatalf("failed to collect semvers from github: %s", err) log.Fatalf("failed to collect semvers from github: %s", err)
@ -320,28 +331,25 @@ func calculateVersions(cli *http.Client, from, to string, direct bool) []string
} }
semvers = semvers[:i+1] semvers = semvers[:i+1]
} }
var versions []string
for _, sv := range semvers {
versions = append(versions, sv.Original())
}
if to == HEAD { if to == HEAD {
versions = append(versions, HEAD) semvers = append(semvers, latest)
} }
if direct { if direct {
versions = []string{versions[0], versions[len(versions)-1]} semvers = []*semver.Version{semvers[0], semvers[len(semvers)-1]}
} }
return versions return semvers, to == HEAD
} }
func buildDendriteImages(httpClient *http.Client, dockerClient *client.Client, baseTempDir string, concurrency int, branchOrTagNames []string) map[string]string { func buildDendriteImages(httpClient *http.Client, dockerClient *client.Client, baseTempDir string, concurrency int, versions []*semver.Version, wantLatest bool) map[string]string {
// concurrently build all versions, this can be done in any order. The mutex protects the map // concurrently build all versions, this can be done in any order. The mutex protects the map
branchToImageID := make(map[string]string) branchToImageID := make(map[string]string)
var mu sync.Mutex var mu sync.Mutex
var wg sync.WaitGroup var wg sync.WaitGroup
wg.Add(concurrency) wg.Add(concurrency)
ch := make(chan string, len(branchOrTagNames)) ch := make(chan *semver.Version, len(versions))
for _, branchName := range branchOrTagNames { for _, branchName := range versions {
ch <- branchName ch <- branchName
} }
close(ch) close(ch)
@ -349,11 +357,13 @@ func buildDendriteImages(httpClient *http.Client, dockerClient *client.Client, b
for i := 0; i < concurrency; i++ { for i := 0; i < concurrency; i++ {
go func() { go func() {
defer wg.Done() defer wg.Done()
for branchName := range ch { for version := range ch {
branchName, binary := versionToBranchAndBinary(version)
log.Printf("Building version %s with binary %s", branchName, binary)
tmpDir := baseTempDir + alphaNumerics.ReplaceAllString(branchName, "") tmpDir := baseTempDir + alphaNumerics.ReplaceAllString(branchName, "")
imgID, err := buildDendrite(httpClient, dockerClient, tmpDir, branchName) imgID, err := buildDendrite(httpClient, dockerClient, tmpDir, branchName, binary)
if err != nil { if err != nil {
log.Fatalf("%s: failed to build dendrite image: %s", branchName, err) log.Fatalf("%s: failed to build dendrite image: %s", version, err)
} }
mu.Lock() mu.Lock()
branchToImageID[branchName] = imgID branchToImageID[branchName] = imgID
@ -365,13 +375,14 @@ func buildDendriteImages(httpClient *http.Client, dockerClient *client.Client, b
return branchToImageID return branchToImageID
} }
func runImage(dockerClient *client.Client, volumeName, version, imageID string) (csAPIURL, containerID string, err error) { func runImage(dockerClient *client.Client, volumeName string, branchNameToImageID map[string]string, version *semver.Version) (csAPIURL, containerID string, err error) {
log.Printf("%s: running image %s\n", version, imageID) branchName, binary := versionToBranchAndBinary(version)
imageID := branchNameToImageID[branchName]
ctx, cancel := context.WithTimeout(context.Background(), 3*time.Minute) ctx, cancel := context.WithTimeout(context.Background(), 3*time.Minute)
defer cancel() defer cancel()
body, err := dockerClient.ContainerCreate(ctx, &container.Config{ body, err := dockerClient.ContainerCreate(ctx, &container.Config{
Image: imageID, Image: imageID,
Env: []string{"SERVER_NAME=hs1"}, Env: []string{"SERVER_NAME=hs1", fmt.Sprintf("BINARY=%s", binary)},
Labels: map[string]string{ Labels: map[string]string{
dendriteUpgradeTestLabel: "yes", dendriteUpgradeTestLabel: "yes",
}, },
@ -384,7 +395,7 @@ func runImage(dockerClient *client.Client, volumeName, version, imageID string)
Target: "/var/lib/postgresql/9.6/main", Target: "/var/lib/postgresql/9.6/main",
}, },
}, },
}, nil, nil, "dendrite_upgrade_test_"+version) }, nil, nil, "dendrite_upgrade_test_"+branchName)
if err != nil { if err != nil {
return "", "", fmt.Errorf("failed to ContainerCreate: %s", err) return "", "", fmt.Errorf("failed to ContainerCreate: %s", err)
} }
@ -451,8 +462,8 @@ func destroyContainer(dockerClient *client.Client, containerID string) {
} }
} }
func loadAndRunTests(dockerClient *client.Client, volumeName, v string, branchToImageID map[string]string) error { func loadAndRunTests(dockerClient *client.Client, volumeName string, v *semver.Version, branchToImageID map[string]string) error {
csAPIURL, containerID, err := runImage(dockerClient, volumeName, v, branchToImageID[v]) csAPIURL, containerID, err := runImage(dockerClient, volumeName, branchToImageID, v)
if err != nil { if err != nil {
return fmt.Errorf("failed to run container for branch %v: %v", v, err) return fmt.Errorf("failed to run container for branch %v: %v", v, err)
} }
@ -470,9 +481,10 @@ func loadAndRunTests(dockerClient *client.Client, volumeName, v string, branchTo
} }
// test that create-account is working // test that create-account is working
func testCreateAccount(dockerClient *client.Client, v string, containerID string) error { func testCreateAccount(dockerClient *client.Client, version *semver.Version, containerID string) error {
createUser := strings.ToLower("createaccountuser-" + v) branchName, _ := versionToBranchAndBinary(version)
log.Printf("%s: Creating account %s with create-account\n", v, createUser) createUser := strings.ToLower("createaccountuser-" + branchName)
log.Printf("%s: Creating account %s with create-account\n", branchName, createUser)
respID, err := dockerClient.ContainerExecCreate(context.Background(), containerID, types.ExecConfig{ respID, err := dockerClient.ContainerExecCreate(context.Background(), containerID, types.ExecConfig{
AttachStderr: true, AttachStderr: true,
@ -504,9 +516,21 @@ func testCreateAccount(dockerClient *client.Client, v string, containerID string
return nil return nil
} }
func verifyTests(dockerClient *client.Client, volumeName string, versions []string, branchToImageID map[string]string) error { func versionToBranchAndBinary(version *semver.Version) (branchName, binary string) {
binary = "dendrite-monolith-server"
branchName = version.Original()
if version.GreaterThan(binaryChangeVersion) {
binary = "dendrite"
if version.Equal(latest) {
branchName = HEAD
}
}
return
}
func verifyTests(dockerClient *client.Client, volumeName string, versions []*semver.Version, branchToImageID map[string]string) error {
lastVer := versions[len(versions)-1] lastVer := versions[len(versions)-1]
csAPIURL, containerID, err := runImage(dockerClient, volumeName, lastVer, branchToImageID[lastVer]) csAPIURL, containerID, err := runImage(dockerClient, volumeName, branchToImageID, lastVer)
if err != nil { if err != nil {
return fmt.Errorf("failed to run container for branch %v: %v", lastVer, err) return fmt.Errorf("failed to run container for branch %v: %v", lastVer, err)
} }
@ -552,10 +576,10 @@ func main() {
os.Exit(1) os.Exit(1)
} }
cleanup(dockerClient) cleanup(dockerClient)
versions := calculateVersions(httpClient, *flagFrom, *flagTo, *flagDirect) versions, wantLatest := calculateVersions(httpClient, *flagFrom, *flagTo, *flagDirect)
log.Printf("Testing dendrite versions: %v\n", versions) log.Printf("Testing dendrite versions: %v\n", versions)
branchToImageID := buildDendriteImages(httpClient, dockerClient, *flagTempDir, *flagBuildConcurrency, versions) branchToImageID := buildDendriteImages(httpClient, dockerClient, *flagTempDir, *flagBuildConcurrency, versions, wantLatest)
// make a shared postgres volume // make a shared postgres volume
volume, err := dockerClient.VolumeCreate(context.Background(), volume.VolumeCreateBody{ volume, err := dockerClient.VolumeCreate(context.Background(), volume.VolumeCreateBody{

11
cmd/dendrite-upgrade-tests/tests.go
View file

@ -6,6 +6,7 @@ import (
"strings" "strings"
"time" "time"
"github.com/Masterminds/semver/v3"
"github.com/matrix-org/gomatrix" "github.com/matrix-org/gomatrix"
"github.com/matrix-org/gomatrixserverlib" "github.com/matrix-org/gomatrixserverlib"
) )
@ -22,7 +23,8 @@ type user struct {
// - register alice and bob with branch name muxed into the localpart // - register alice and bob with branch name muxed into the localpart
// - create a DM room for the 2 users and exchange messages // - create a DM room for the 2 users and exchange messages
// - create/join a public #global room and exchange messages // - create/join a public #global room and exchange messages
func runTests(baseURL, branchName string) error { func runTests(baseURL string, v *semver.Version) error {
branchName, _ := versionToBranchAndBinary(v)
// register 2 users // register 2 users
users := []user{ users := []user{
{ {
@ -164,15 +166,16 @@ func runTests(baseURL, branchName string) error {
} }
// verifyTestsRan checks that the HS has the right rooms/messages // verifyTestsRan checks that the HS has the right rooms/messages
func verifyTestsRan(baseURL string, branchNames []string) error { func verifyTestsRan(baseURL string, versions []*semver.Version) error {
log.Println("Verifying tests....") log.Println("Verifying tests....")
// check we can login as all users // check we can login as all users
var resp *gomatrix.RespLogin var resp *gomatrix.RespLogin
for _, branchName := range branchNames { for _, version := range versions {
client, err := gomatrix.NewClient(baseURL, "", "") client, err := gomatrix.NewClient(baseURL, "", "")
if err != nil { if err != nil {
return err return err
} }
branchName, _ := versionToBranchAndBinary(version)
userLocalparts := []string{ userLocalparts := []string{
"alice" + branchName, "alice" + branchName,
"bob" + branchName, "bob" + branchName,
@ -224,7 +227,7 @@ func verifyTestsRan(baseURL string, branchNames []string) error {
msgCount += 1 msgCount += 1
} }
} }
wantMsgCount := len(branchNames) * 4 wantMsgCount := len(versions) * 4
if msgCount != wantMsgCount { if msgCount != wantMsgCount {
return fmt.Errorf("got %d messages in global room, want %d", msgCount, wantMsgCount) return fmt.Errorf("got %d messages in global room, want %d", msgCount, wantMsgCount)
} }