Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

build,compose: build libgeos for compose tests #123971

Merged
merged 1 commit into from
May 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
10 changes: 3 additions & 7 deletions build/teamcity/cockroach/nightlies/compose.sh
Original file line number Diff line number Diff line change
Expand Up @@ -6,22 +6,17 @@ dir="$(dirname $(dirname $(dirname $(dirname "${0}"))))"
source "$dir/teamcity-support.sh"
source "$dir/teamcity-bazel-support.sh"

# The test failures generated by TestComposeCompare are not necessarily
# failures per se. They're cases of behavioral divergences from Postgres. While
# our compatibility guarantees are not 100%, it's better to treat failures as
# information to occasionally review.
export SKIP_LABEL_TEST_FAILURE=1

tc_start_block "Run compose tests"

bazel build //pkg/cmd/bazci --config=ci
BAZEL_BIN=$(bazel info bazel-bin --config=ci)
BAZCI=$BAZEL_BIN/pkg/cmd/bazci/bazci_/bazci

bazel build //pkg/cmd/cockroach //pkg/compose/compare/compare:compare_test --config=ci --config=crosslinux --config=test
bazel build //pkg/cmd/cockroach //pkg/compose/compare/compare:compare_test //c-deps:libgeos --config=ci --config=crosslinux --config=test
CROSSBIN=$(bazel info bazel-bin --config=ci --config=crosslinux --config=test)
COCKROACH=$CROSSBIN/pkg/cmd/cockroach/cockroach_/cockroach
COMPAREBIN=$CROSSBIN/pkg/compose/compare/compare/compare_test_/compare_test
LIBGEOSDIR=$(bazel info execution_root --config=crosslinux --config=ci --config=test)/external/archived_cdep_libgeos_linux/lib/
ARTIFACTS_DIR=$PWD/artifacts
mkdir -p $ARTIFACTS_DIR

Expand All @@ -35,6 +30,7 @@ $BAZCI --artifacts_dir=$ARTIFACTS_DIR -- \
--test_env=COCKROACH_RUN_COMPOSE=true \
--test_arg -cockroach --test_arg $COCKROACH \
--test_arg -compare --test_arg $COMPAREBIN \
--test_arg -libgeosdir --test_arg $LIBGEOSDIR \
--test_timeout=1800 || exit_status=$?

tc_end_block "Run compose tests"
Expand Down
2 changes: 1 addition & 1 deletion dev
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ fi
set -euo pipefail

# Bump this counter to force rebuilding `dev` on all machines.
DEV_VERSION=94
DEV_VERSION=95

THIS_DIR=$(cd "$(dirname "$0")" && pwd)
BINARY_DIR=$THIS_DIR/bin/dev-versions
Expand Down
36 changes: 33 additions & 3 deletions pkg/cmd/dev/compose.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,15 @@ package main

import (
"fmt"
"os"
"path/filepath"
"time"

"github.com/spf13/cobra"
)

const eachFlag = "each"

func makeComposeCmd(runE func(cmd *cobra.Command, args []string) error) *cobra.Command {
composeCmd := &cobra.Command{
Use: "compose",
Expand All @@ -30,6 +34,7 @@ func makeComposeCmd(runE func(cmd *cobra.Command, args []string) error) *cobra.C
addCommonTestFlags(composeCmd)
composeCmd.Flags().Bool(noRebuildCockroachFlag, false, "set if it is unnecessary to rebuild cockroach (artifacts/cockroach must already exist, e.g. after being created by a previous `dev compose` run)")
composeCmd.Flags().String(volumeFlag, "bzlhome", "the Docker volume to use as the container home directory (only used for cross builds)")
composeCmd.Flags().Duration(eachFlag, 10*time.Minute, "individual test timeout")
return composeCmd
}

Expand All @@ -40,10 +45,11 @@ func (d *dev) compose(cmd *cobra.Command, _ []string) error {
noRebuildCockroach = mustGetFlagBool(cmd, noRebuildCockroachFlag)
short = mustGetFlagBool(cmd, shortFlag)
timeout = mustGetFlagDuration(cmd, timeoutFlag)
each = mustGetFlagDuration(cmd, eachFlag)
)

if !noRebuildCockroach {
crossArgs, targets, err := d.getBasicBuildArgs(ctx, []string{"//pkg/cmd/cockroach:cockroach", "//pkg/compose/compare/compare:compare_test"})
crossArgs, targets, err := d.getBasicBuildArgs(ctx, []string{"//pkg/cmd/cockroach:cockroach", "//pkg/compose/compare/compare:compare_test", "//c-deps:libgeos"})
if err != nil {
return err
}
Expand All @@ -58,8 +64,26 @@ func (d *dev) compose(cmd *cobra.Command, _ []string) error {
if err != nil {
return err
}
cockroachBin := filepath.Join(workspace, "artifacts", "cockroach")
compareBin := filepath.Join(workspace, "artifacts", "compare_test")
artifactsDir := filepath.Join(workspace, "artifacts")
cockroachBin := filepath.Join(artifactsDir, "cockroach")
compareBin := filepath.Join(artifactsDir, "compare_test")

// Copy libgeos files to a temporary directory, since the compose tests expect
// libgeos files to be in their own directory.
libGeosDir, err := os.MkdirTemp("", "lib")
if err != nil {
return err
}
defer func() {
_ = os.RemoveAll(libGeosDir)
}()
for _, geoLib := range []string{"libgeos.so", "libgeos_c.so"} {
src := filepath.Join(artifactsDir, geoLib)
dst := filepath.Join(libGeosDir, geoLib)
if err := d.os.CopyFile(src, dst); err != nil {
return err
}
}

var args []string
args = append(args, "test", "//pkg/compose:compose_test")
Expand All @@ -75,9 +99,15 @@ func (d *dev) compose(cmd *cobra.Command, _ []string) error {
if timeout > 0 {
args = append(args, fmt.Sprintf("--test_timeout=%d", int(timeout.Seconds())))
}
if each > 0 {
args = append(args, "--test_arg", "-each", "--test_arg", each.String())
}

args = append(args, "--test_arg", "-cockroach", "--test_arg", cockroachBin)
args = append(args, "--test_arg", "-libgeosdir", "--test_arg", libGeosDir)
args = append(args, "--test_arg", "-compare", "--test_arg", compareBin)
args = append(args, "--test_arg", "-test.v")
args = append(args, "--test_output", "all")
args = append(args, "--test_env", "COCKROACH_DEV_LICENSE")
args = append(args, "--test_env", "COCKROACH_RUN_COMPOSE=true")

Expand Down
6 changes: 5 additions & 1 deletion pkg/compose/compare/docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,23 +7,27 @@ services:
command: /cockroach/cockroach start-single-node --insecure --listen-addr cockroach1
volumes:
- "${COCKROACH_PATH}:/cockroach/cockroach"
- "${LIBGEOS_DIR_PATH}:/cockroach/lib"
cockroach2:
# We use a docker image mirror to avoid pulling from 3rd party repos, which sometimes have reliability issues.
# See https://cockroachlabs.atlassian.net/wiki/spaces/devinf/pages/3462594561/Docker+image+sync for the details.
image: us-east1-docker.pkg.dev/crl-docker-sync/docker-mirror/docker.io/library/ubuntu:xenial-20170214
command: /cockroach/cockroach start-single-node --insecure --listen-addr cockroach2
volumes:
- "${COCKROACH_PATH}:/cockroach/cockroach"
- "${LIBGEOS_DIR_PATH}:/cockroach/lib"
test:
# We use a docker image mirror to avoid pulling from 3rd party repos, which sometimes have reliability issues.
# See https://cockroachlabs.atlassian.net/wiki/spaces/devinf/pages/3462594561/Docker+image+sync for the details.
image: us-east1-docker.pkg.dev/crl-docker-sync/docker-mirror/docker.io/library/ubuntu:xenial-20170214
environment:
- COCKROACH_DEV_LICENSE=$COCKROACH_DEV_LICENSE
- COCKROACH_RUN_COMPOSE_COMPARE=${COCKROACH_RUN_COMPOSE_COMPARE}
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am unsure how these tests were running at all before this change. Do you know @rickystewart?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, it looks like this is something I missed in 156d9c9c9050df77f38db04a0187503e2edf5cbe. So the thing has been effectively skipped since last week. Thanks for catching this.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That means this has to be backported to release-24.1.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was planning to backport anyway, since the "missing libgeos library" error is/was happening on all active branches

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This change won't backport cleanly to release-23.2 or prior, the basic idea should still apply though.

# compare.test is a binary built by the pkg/compose/prepare.sh in non-bazel builds
command: /compare/compare.test -each ${EACH} -test.run ${TESTS} -artifacts ${ARTIFACTS}
command: /compare/compare.test -test.v -each ${EACH} -test.run ${TESTS} -artifacts ${ARTIFACTS}
depends_on:
- cockroach1
- cockroach2
volumes:
- "${COMPARE_DIR_PATH}:/compare"
- "${LIBGEOS_DIR_PATH}:/compare/lib"
40 changes: 29 additions & 11 deletions pkg/compose/compose_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,12 @@ import (
var (
// flagEach controls how long we are going to run each compose test. Ensure bazel BUILD file
// of compose tests has a longer timeout.
flagEach = flag.Duration("each", 10*time.Minute, "individual test timeout")
flagTests = flag.String("tests", ".", "tests within docker compose to run")
flagArtifacts = flag.String("artifacts", "", "artifact directory")
flagCockroach = flag.String("cockroach", "", "path to the cockroach executable")
flagCompare = flag.String("compare", "", "path to the compare test (only valid for bazel-driven test)")
flagEach = flag.Duration("each", 10*time.Minute, "individual test timeout")
flagTests = flag.String("tests", ".", "tests within docker compose to run")
flagArtifacts = flag.String("artifacts", "", "artifact directory")
flagCockroach = flag.String("cockroach", "", "path to the cockroach executable")
flagLibGeosDir = flag.String("libgeosdir", "", "path to the libgeos directory (only valid for bazel-driven test)")
flagCompare = flag.String("compare", "", "path to the compare test (only valid for bazel-driven test)")
)

func copyBin(src, dst string) error {
Expand All @@ -55,7 +56,7 @@ func TestComposeCompare(t *testing.T) {
if os.Getenv("COCKROACH_RUN_COMPOSE") == "" {
skip.IgnoreLint(t, "COCKROACH_RUN_COMPOSE not set")
}
var cockroachBin, compareDir, dockerComposeYml string
var cockroachBin, libGeosDir, compareDir, dockerComposeYml string
if bazel.BuiltWithBazel() {
var err error
dockerComposeYml, err = bazel.Runfile("pkg/compose/compare/docker-compose.yml")
Expand All @@ -65,6 +66,9 @@ func TestComposeCompare(t *testing.T) {
if *flagCockroach == "" {
t.Fatal("-cockroach not set")
}
if *flagLibGeosDir == "" {
t.Fatal("-libgeosdir not set")
}
if *flagCompare == "" {
t.Fatal("-compare not set")
}
Expand All @@ -75,12 +79,21 @@ func TestComposeCompare(t *testing.T) {
composeBinsDir := t.TempDir()
compareDir = composeBinsDir
cockroachBin = filepath.Join(composeBinsDir, "cockroach")
err = copyBin(*flagCockroach, cockroachBin)
if err != nil {
libGeosDir = filepath.Join(composeBinsDir, "lib")
if err = os.MkdirAll(libGeosDir, 0755); err != nil {
t.Fatal(err)
}
err = copyBin(*flagCompare, filepath.Join(composeBinsDir, "compare.test"))
if err != nil {
if err := copyBin(*flagCockroach, cockroachBin); err != nil {
t.Fatal(err)
}
for _, geoLib := range []string{"libgeos.so", "libgeos_c.so"} {
src := filepath.Join(*flagLibGeosDir, geoLib)
dst := filepath.Join(libGeosDir, geoLib)
if err := copyBin(src, dst); err != nil {
t.Fatal(err)
}
}
if err = copyBin(*flagCompare, filepath.Join(composeBinsDir, "compare.test")); err != nil {
t.Fatal(err)
}
if *flagArtifacts == "" {
Expand All @@ -94,6 +107,10 @@ func TestComposeCompare(t *testing.T) {
if cockroachBin == "" {
cockroachBin = "../../../cockroach-linux-2.6.32-gnu-amd64"
}
libGeosDir = *flagLibGeosDir
if libGeosDir == "" {
libGeosDir = "../../../lib"
}
compareDir = "./compare"
dockerComposeYml = filepath.Join("compare", "docker-compose.yml")
if *flagArtifacts == "" {
Expand All @@ -112,15 +129,16 @@ func TestComposeCompare(t *testing.T) {
fmt.Sprintf("EACH=%s", *flagEach),
fmt.Sprintf("TESTS=%s", *flagTests),
fmt.Sprintf("COCKROACH_PATH=%s", cockroachBin),
fmt.Sprintf("LIBGEOS_DIR_PATH=%s", libGeosDir),
fmt.Sprintf("COMPARE_DIR_PATH=%s", compareDir),
fmt.Sprintf("ARTIFACTS=%s", *flagArtifacts),
fmt.Sprintf("COCKROACH_DEV_LICENSE=%s", envutil.EnvOrDefaultString("COCKROACH_DEV_LICENSE", "")),
fmt.Sprintf("PATH=%s", os.Getenv("PATH")),
"COCKROACH_RUN_COMPOSE_COMPARE=true",
}
out, err := cmd.CombinedOutput()
t.Log(string(out))
if err != nil {
t.Log(string(out))
t.Fatal(err)
}
}