Skip to content
New issue

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

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

Already on GitHub? # to your account

Add Bazel CI #153

Merged
merged 4 commits into from
Oct 8, 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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions .bazelrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
common --enable_bzlmod
common --lockfile_mode=off

# Add C++17 compiler flags.
build --cxxopt=-std=c++17
build --host_cxxopt=-std=c++17

build --force_pic
build --strip=never
build --strict_system_includes
build --fission=dbg
build --features=per_object_debug_info
1 change: 1 addition & 0 deletions .bazelversion
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
7.3.1
24 changes: 24 additions & 0 deletions .github/workflows/bazel.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
name: Bazel CI
on:
push:
branches: [gz-utils3, main]
pull_request:
branches: [gz-utils3, main]

concurrency:
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
cancel-in-progress: true

jobs:
test:
uses: bazel-contrib/.github/.github/workflows/bazel.yaml@v6
with:
folders: |
[
".",
]
exclude: |
[
{"bazelversion": "6.4.0"}
{"bazelversion": "5.4.0"},
]
15 changes: 15 additions & 0 deletions .github/workflows/ci.bazelrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# This file contains Bazel settings to apply on CI only.
# It is referenced with a --bazelrc option in the call to bazel in ci.yaml

# Debug where options came from
build --announce_rc
# This directory is configured in GitHub actions to be persisted between runs.
# We do not enable the repository cache to cache downloaded external artifacts
# as these are generally faster to download again than to fetch them from the
# GitHub actions cache.
build --disk_cache=~/.cache/bazel
# Don't rely on test logs being easily accessible from the test runner,
# though it makes the log noisier.
test --test_output=errors
# Allows tests to run bazelisk-in-bazel, since this is the cache folder used
test --test_env=XDG_CACHE_HOME
6 changes: 6 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,9 @@ build_*
# OS generated files
.DS_Store
*.swp

# Bazel generated files
bazel-bin/
bazel-out/
bazel-testlogs/
bazel-*
168 changes: 100 additions & 68 deletions BUILD.bazel
Original file line number Diff line number Diff line change
@@ -1,70 +1,99 @@
load(
"@gz//bazel/skylark:build_defs.bzl",
"GZ_FEATURES",
"GZ_ROOT",
"GZ_VISIBILITY",
"gz_configure_header",
"gz_export_header",
"gz_include_header",
)
load("@buildifier_prebuilt//:rules.bzl", "buildifier", "buildifier_test")
load("@rules_gazebo//gazebo:headers.bzl", "gz_configure_header", "gz_export_header")
load("@rules_license//rules:license.bzl", "license")

package(
default_applicable_licenses = [GZ_ROOT + "utils:license"],
default_visibility = GZ_VISIBILITY,
features = GZ_FEATURES,
default_applicable_licenses = [":license"],
default_visibility = ["__subpackages__"],
features = ["layering_check"],
)

license(
name = "license",
package_name = "gz-utils",
)

licenses(["notice"])
exports_files([
"LICENSE",
"MODULE.bazel",
])

exports_files(["LICENSE"])
gz_export_header(
name = "Export",
out = "include/gz/utils/Export.hh",
export_base = "GZ_UTILS",
lib_name = "gz-utils",
)

gz_configure_header(
name = "config",
name = "Config",
src = "include/gz/utils/config.hh.in",
cmakelists = ["CMakeLists.txt"],
package = "utils",
package_xml = "package.xml",
)

gz_export_header(
name = "include/gz/utils/Export.hh",
export_base = "GZ_UTILS",
lib_name = "gz-utils",
visibility = ["//visibility:private"],
cc_library(
name = "Environment",
srcs = ["src/Environment.cc"],
hdrs = ["include/gz/utils/Environment.hh"],
includes = ["include"],
deps = [
":Config",
":Export",
],
)

public_headers_no_gen = glob([
"include/gz/utils/*.hh",
"include/gz/utils/detail/*.hh",
"include/gz/utils/detail/*.h",
])

gz_include_header(
name = "utilshh_genrule",
out = "include/gz/utils.hh",
hdrs = public_headers_no_gen + [
"include/gz/utils/Export.hh",
"include/gz/utils/config.hh",
cc_library(
name = "ImplPtr",
hdrs = [
"include/gz/utils/ImplPtr.hh",
"include/gz/utils/detail/DefaultOps.hh",
"include/gz/utils/detail/ImplPtr.hh",
],
includes = ["include"],
visibility = ["//visibility:public"],
deps = [
":Export",
":SuppressWarning",
],
)

public_headers = public_headers_no_gen + [
"include/gz/utils/config.hh",
"include/gz/utils/Export.hh",
"include/gz/utils.hh",
]
cc_library(
name = "NeverDestroyed",
hdrs = ["include/gz/utils/NeverDestroyed.hh"],
includes = ["include"],
visibility = ["//visibility:public"],
)

cc_library(
name = "utils",
srcs = ["src/Environment.cc"],
hdrs = public_headers,
copts = ["-fexceptions"],
name = "SuppressWarning",
hdrs = [
"include/gz/utils/SuppressWarning.hh",
"include/gz/utils/detail/SuppressWarning.hh",
],
includes = ["include"],
visibility = ["//visibility:public"],
)

cc_library(
name = "Subprocess",
hdrs = [
"include/gz/utils/Subprocess.hh",
"include/gz/utils/detail/subprocess.h",
],
includes = ["include"],
visibility = ["//visibility:public"],
)

cc_library(
name = "gz-utils",
visibility = ["//visibility:public"],
deps = [
":Environment",
":ImplPtr",
":NeverDestroyed",
":Subprocess",
":SuppressWarning",
],
)

# Tests
Expand All @@ -77,7 +106,7 @@ cc_library(
"test/integration/implptr/implptr_test_classes.hh",
],
includes = ["test/integration/implptr"],
deps = [":utils"],
deps = [":ImplPtr"],
)

cc_test(
Expand All @@ -86,48 +115,51 @@ cc_test(
srcs = ["test/integration/implptr/ImplPtr_TEST.cc"],
deps = [
":implptr_test_classes",
"@gtest",
"@gtest//:gtest_main",
"@googletest//:gtest_main",
],
)

cc_test(
name = "Environment_TEST",
srcs = ["src/Environment_TEST.cc"],
deps = [
":utils",
"@gtest",
"@gtest//:gtest_main",
":Environment",
"@googletest//:gtest_main",
],
)

cc_test(
name = "NeverDestroyed_TEST",
srcs = ["src/NeverDestroyed_TEST.cc"],
copts = ["-fexceptions"],
cc_binary(
name = "subprocess_main",
srcs = ["test/integration/subprocess/subprocess_main.cc"],
deps = [
":utils",
"@gtest",
"@gtest//:gtest_main",
":Environment",
"//cli",
],
)

cc_binary(
name = "subprocess_main",
srcs = ["test/integration/subprocess/subprocess_main.cc"],
deps = [
GZ_ROOT + "utils/cli",
]
)

cc_test(
name = "subprocess_TEST",
srcs = ["test/integration/subprocess_TEST.cc"],
local_defines = ['SUBPROCESS_EXECUTABLE_PATH=\\"subprocess_main\\"'],
deps = [
":utils",
":gz-utils",
":subprocess_main",
"@gtest",
"@gtest//:gtest_main",
"@googletest//:gtest_main",
],
local_defines = ['SUBPROCESS_EXECUTABLE_PATH=\\"utils/subprocess_main\\"'],
)

buildifier(
name = "buildifier.fix",
exclude_patterns = ["./.git/*"],
lint_mode = "fix",
mode = "fix",
)

buildifier_test(
name = "buildifier.test",
exclude_patterns = ["./.git/*"],
lint_mode = "warn",
mode = "diff",
no_sandbox = True,
workspace = "//:MODULE.bazel",
)
12 changes: 12 additions & 0 deletions MODULE.bazel
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
"gz-utils"

module(
name = "gz-utils",
repo_name = "org_gazebosim_gz-utils",
)

bazel_dep(name = "buildifier_prebuilt", version = "7.3.1")
bazel_dep(name = "googletest", version = "1.14.0")
bazel_dep(name = "rules_gazebo", version = "0.0.2")
bazel_dep(name = "rules_license", version = "1.0.0")
bazel_dep(name = "spdlog", version = "1.14.1")
Empty file added WORKSPACE
Empty file.
49 changes: 30 additions & 19 deletions cli/BUILD.bazel
Original file line number Diff line number Diff line change
@@ -1,36 +1,47 @@
load(
"@gz//bazel/skylark:build_defs.bzl",
"GZ_ROOT",
"GZ_VISIBILITY",
)
load("@rules_license//rules:license.bzl", "license")

package(
default_applicable_licenses = [GZ_ROOT + "utils/cli:license"],
default_applicable_licenses = ["//:license"],
)

license(
name = "license",
package_name = "gz-utils-cli",
)

public_headers = [
"include/gz/utils/cli/GzFormatter.hpp",
] + glob([
"include/external-cli/gz/utils/cli/*.hpp",
])
cc_library(
name = "cli11",
hdrs = glob([
"include/vendored-cli/gz/utils/cli/*.hpp",
]),
includes = ["include/vendored-cli"],
)

cc_library(
name = "GzFormatter",
hdrs = [
"include/gz/utils/cli/GzFormatter.hpp",
],
includes = ["include"],
deps = [
"//:Export",
],
)

cc_library(
name = "cli",
hdrs = public_headers,
copts = ["-fexceptions"],
includes = [
"include",
"include/external-cli",
visibility = ["//visibility:public"],
deps = [
":GzFormatter",
":cli11",
],
visibility = GZ_VISIBILITY,
)

cc_test(
name = "cli_TEST",
srcs = ["src/cli_TEST.cc"],
deps = [
GZ_ROOT + "utils:utils",
"@cli11"
":cli",
"@googletest//:gtest_main",
],
)
14 changes: 7 additions & 7 deletions include/gz/utils/config.hh.in
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,15 @@
#define GZ_UTILS_CONFIG_HH_

/* Version number */
#define GZ_UTILS_MAJOR_VERSION ${PROJECT_VERSION_MAJOR}
#define GZ_UTILS_MINOR_VERSION ${PROJECT_VERSION_MINOR}
#define GZ_UTILS_PATCH_VERSION ${PROJECT_VERSION_PATCH}
#define GZ_UTILS_MAJOR_VERSION @PROJECT_VERSION_MAJOR@
#define GZ_UTILS_MINOR_VERSION @PROJECT_VERSION_MINOR@
#define GZ_UTILS_PATCH_VERSION @PROJECT_VERSION_PATCH@

#define GZ_UTILS_VERSION "${PROJECT_VERSION}"
#define GZ_UTILS_VERSION_FULL "${PROJECT_VERSION_FULL}"
#define GZ_UTILS_VERSION "@PROJECT_VERSION@"
#define GZ_UTILS_VERSION_FULL "@PROJECT_VERSION_FULL@"

#define GZ_UTILS_VERSION_NAMESPACE v${PROJECT_VERSION_MAJOR}
#define GZ_UTILS_VERSION_NAMESPACE v@PROJECT_VERSION_MAJOR@

#define GZ_UTILS_VERSION_HEADER "Gazebo Utils, version ${PROJECT_VERSION_FULL}\nCopyright (C) 2020 Open Source Robotics Foundation.\nReleased under the Apache 2.0 License.\n\n"
#define GZ_UTILS_VERSION_HEADER "Gazebo Utils, version @PROJECT_VERSION_FULL@\nCopyright (C) 2020 Open Source Robotics Foundation.\nReleased under the Apache 2.0 License.\n\n"

#endif
Loading