ROX-28460: New option to build a Builder image with debug symbols and sources. (#2056)

Author: ovalenti

Makefile

@@ -25,10 +25,11 @@ container-dockerfile-dev:
 builder:
 ifneq ($(BUILD_BUILDER_IMAGE), false)
 	docker buildx build --load --platform ${PLATFORM} \
+		--build-arg COLLECTOR_BUILDER_DEBUG=$(COLLECTOR_BUILDER_DEBUG) \
 		-t quay.io/stackrox-io/collector-builder:$(COLLECTOR_BUILDER_TAG) \
 		-f "$(CURDIR)/builder/Dockerfile" \
 		"$(CURDIR)/builder"
-else
+else ifeq ($(COLLECTOR_BUILDER_DEBUG),)
 	docker pull --platform ${PLATFORM} \
 		quay.io/stackrox-io/collector-builder:$(COLLECTOR_BUILDER_TAG)
 endif

Makefile-constants.mk

@@ -2,6 +2,10 @@ ifeq ($(COLLECTOR_BUILDER_TAG),)
 COLLECTOR_BUILDER_TAG=master
 endif
 
+ifneq ($(COLLECTOR_BUILDER_DEBUG),)
+COLLECTOR_BUILDER_TAG:=$(COLLECTOR_BUILDER_TAG)-debug
+endif
+
 ifeq ($(COLLECTOR_TAG),)
 COLLECTOR_TAG=$(shell git describe --tags --abbrev=10 --dirty)
 endif

builder/Dockerfile

@@ -1,6 +1,7 @@
 FROM quay.io/centos/centos:stream9
 
 ARG BUILD_DIR=/install-tmp
+ARG COLLECTOR_BUILDER_DEBUG
 
 USER root
 
@@ -53,9 +54,8 @@ WORKDIR ${BUILD_DIR}
 COPY install builder/install
 COPY third_party third_party
 
-RUN "builder/install/install-dependencies.sh" && \
-    rm -rf ${BUILD_DIR} && \
-    echo -e '/usr/local/lib\n/usr/local/lib64' > /etc/ld.so.conf.d/usrlocallib.conf && ldconfig
+RUN "builder/install/install-dependencies.sh" && if [ -z "${COLLECTOR_BUILDER_DEBUG}" ]; then rm -rf ${BUILD_DIR}; fi
+RUN echo -e '/usr/local/lib\n/usr/local/lib64' > /etc/ld.so.conf.d/usrlocallib.conf && ldconfig
 
 # Set up ssh for remote development with IDE
 RUN ssh-keygen -A \

builder/install/05-abseil.sh

@@ -9,7 +9,7 @@ cp LICENSE "${LICENSE_DIR}/Abseil-${ABSEIL_VERSION}"
 mkdir cmake-build
 cd cmake-build
 cmake .. \
-    -DCMAKE_BUILD_TYPE=Release \
+    -DCMAKE_BUILD_TYPE="${CMAKE_BUILD_TYPE}" \
     -DCMAKE_INSTALL_PREFIX=/usr/local \
     -DCMAKE_POSITION_INDEPENDENT_CODE=ON \
     -DCMAKE_CXX_STANDARD=17 \

builder/install/10-gperftools.sh

@@ -6,6 +6,6 @@ cd third_party/gperftools
 cp COPYING "${LICENSE_DIR}/gperftools-${GPERFTOOLS_VERSION}"
 
 ./autogen.sh
-./configure --enable-shared=no --prefix=/usr/local
+CXXFLAGS=${EXTRA_CFLAGS_DEBUG} CFLAGS=${EXTRA_CFLAGS_DEBUG} ./configure --enable-shared=no --prefix=/usr/local
 make ${NPROCS:+-j ${NPROCS}}
 make install

builder/install/10-protobuf.sh

@@ -7,7 +7,7 @@ cp LICENSE "${LICENSE_DIR}/protobuf-${PROTOBUF_VERSION}"
 
 mkdir -p cmake-build && cd cmake-build
 cmake -S ../ \
-    -DCMAKE_BUILD_TYPE=Release \
+    -DCMAKE_BUILD_TYPE="${CMAKE_BUILD_TYPE}" \
     -DCMAKE_INSTALL_PREFIX=/usr/local \
     -DBUILD_SHARED_LIBS=OFF \
     -Dprotobuf_BUILD_TESTS=OFF \

builder/install/10-yaml-cpp.sh

@@ -6,6 +6,7 @@ cd third_party/yaml-cpp
 cp LICENSE "${LICENSE_DIR}/yaml-cpp-${YAMLCPP_VERSION}"
 
 cmake -B build/ \
+    -DCMAKE_BUILD_TYPE="${CMAKE_BUILD_TYPE}" \
     -DYAML_CPP_BUILD_CONTRIB=OFF \
     -DYAML_CPP_BUILD_TOOLS=OFF \
     -DYAML_BUILD_SHARED_LIBS=OFF \

builder/install/20-googletest.sh

@@ -6,5 +6,5 @@ cd third_party/googletest
 cp LICENSE "${LICENSE_DIR}/googletest-${GOOGLETEST_REVISION}"
 mkdir cmake-build
 cd cmake-build
-cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/usr/local ..
+cmake -DCMAKE_BUILD_TYPE="${CMAKE_BUILD_TYPE}" -DCMAKE_INSTALL_PREFIX=/usr/local ..
 cmake --build . --target install ${NPROCS:+-j ${NPROCS}}

builder/install/30-cares.sh

@@ -12,7 +12,7 @@ cp LICENSE.md "${LICENSE_DIR}/c-ares-${CARES_VERSION}"
 
 mkdir cmake-build
 cd cmake-build
-cmake -DCMAKE_BUILD_TYPE=Release \
+cmake -DCMAKE_BUILD_TYPE="${CMAKE_BUILD_TYPE}" \
     -DCARES_INSTALL=ON \
     -DCMAKE_INSTALL_PREFIX=/usr/local \
     -DCARES_SHARED=OFF \

builder/install/35-re2.sh

@@ -8,7 +8,7 @@ cp LICENSE "${LICENSE_DIR}/re2-${RE2_VERSION}"
 
 mkdir cmake-build && cd cmake-build
 cmake .. \
-    -DCMAKE_BUILD_TYPE=Release \
+    -DCMAKE_BUILD_TYPE="${CMAKE_BUILD_TYPE}" \
     -DCMAKE_INSTALL_PREFIX=/usr/local \
     -DCMAKE_POSITION_INDEPENDENT_CODE=ON \
     -DBUILD_SHARED_LIBS=OFF

builder/install/40-civetweb.sh

@@ -8,7 +8,7 @@ cp LICENSE.md "${LICENSE_DIR}/CivetWeb-${CIVETWEB_VERSION}"
 
 mkdir cmake-build
 cd cmake-build
-cmake -DCMAKE_BUILD_TYPE=Release \
+cmake -DCMAKE_BUILD_TYPE="${CMAKE_BUILD_TYPE}" \
     -DCMAKE_INSTALL_PREFIX=/usr/local \
     -DCIVETWEB_ENABLE_CXX=ON \
     -DBUILD_SHARED_LIBS:BOOL=NO \

builder/install/40-grpc.sh

@@ -23,7 +23,7 @@ cmake \
     -DgRPC_BUILD_GRPC_PHP_PLUGIN=OFF \
     -DgRPC_BUILD_GRPC_PYTHON_PLUGIN=OFF \
     -DgRPC_BUILD_GRPC_RUBY_PLUGIN=OFF \
-    -DCMAKE_BUILD_TYPE=Release \
+    -DCMAKE_BUILD_TYPE="${CMAKE_BUILD_TYPE}" \
     -DgRPC_DOWNLOAD_ARCHIVES=OFF \
     -DgRPC_INSTALL=ON \
     -DCMAKE_INSTALL_PREFIX=/usr/local \

builder/install/50-libb64.sh

@@ -6,7 +6,7 @@ cd third_party/libb64
 
 cat AUTHORS LICENSE > "${LICENSE_DIR}/libb64-${B64_VERSION}"
 
-CFLAGS=-fPIC make all_base64
+CFLAGS="-fPIC ${EXTRA_CFLAGS_DEBUG}" make all_base64
 
 cp src/libb64.a /usr/local/lib/
 cp -r include/b64 /usr/local/include/

builder/install/50-prometheus.sh

@@ -8,5 +8,5 @@ cat LICENSE > "${LICENSE_DIR}/prometheus-${PROMETHEUS_CPP_REVISION}"
 
 mkdir cmake-build
 cd cmake-build
-cmake -DENABLE_TESTING=OFF -DUSE_THIRDPARTY_LIBRARIES=NO -DCMAKE_INSTALL_PREFIX=/usr/local -DCMAKE_BUILD_TYPE=Release ../
+cmake -DENABLE_TESTING=OFF -DUSE_THIRDPARTY_LIBRARIES=NO -DCMAKE_INSTALL_PREFIX=/usr/local -DCMAKE_BUILD_TYPE="${CMAKE_BUILD_TYPE}" ../
 cmake --build . --target install ${NPROCS:+-j ${NPROCS}}

builder/install/60-jsoncpp.sh

@@ -9,7 +9,7 @@ cp LICENSE "${LICENSE_DIR}/jsoncpp-${JSONCPP_REVISION}"
 mkdir cmake-build
 cd cmake-build
 cmake -DCMAKE_INSTALL_PREFIX=/usr/local \
-    -DCMAKE_BUILD_TYPE=Release \
+    -DCMAKE_BUILD_TYPE="${CMAKE_BUILD_TYPE}" \
     -DCMAKE_CXX_FLAGS=-fPIC \
     -DJSONCPP_WITH_TESTS=OFF \
     -DJSONCPP_WITH_POST_BUILD_UNITTEST=OFF \

builder/install/60-tbb.sh

@@ -10,7 +10,7 @@ fi
 cd third_party/tbb
 cp LICENSE.txt "${LICENSE_DIR}/tbb-${TBB_VERSION}"
 cmake -B cmake-build -S . \
-    -DCMAKE_BUILD_TYPE=Release \
+    -DCMAKE_BUILD_TYPE="${CMAKE_BUILD_TYPE}" \
     -DCMAKE_INSTALL_PREFIX=/usr/local \
     -DBUILD_SHARED_LIBS=OFF \
     -DTBB_TEST=OFF \

builder/install/70-valijson.sh

@@ -7,7 +7,7 @@ cp LICENSE "${LICENSE_DIR}/valijson-${VALIJSON_VERSION}"
 
 mkdir cmake-build && cd cmake-build
 cmake \
-    -DCMAKE_BUILD_TYPE=Release \
+    -DCMAKE_BUILD_TYPE="${CMAKE_BUILD_TYPE}" \
     -DCMAKE_INSTALL_PREFIX=/usr/local \
     -Dvalijson_BUILD_TESTS=OFF \
     ..

builder/install/80-libbpf.sh

@@ -7,5 +7,5 @@ cd third_party/libbpf
 cp LICENSE "${LICENSE_DIR}/libbpf-${LIBBPF_VERSION}"
 
 mkdir src/build
-make BUILD_STATIC_ONLY=y OBJDIR=build "LDFLAGS=-Wl,-Bstatic" "CFLAGS=-fPIC" \
+make BUILD_STATIC_ONLY=y OBJDIR=build "LDFLAGS=-Wl,-Bstatic" "CFLAGS=-fPIC ${EXTRA_CFLAGS_DEBUG}" \
      ${NPROCS:+-j ${NPROCS}} -C src install install_uapi_headers

builder/install/install-dependencies.sh

@@ -9,6 +9,14 @@ mkdir -p "${LICENSE_DIR}"
 export NPROCS
 NPROCS="${NPROCS:-$(nproc)}"
 
+export CMAKE_BUILD_TYPE
+CMAKE_BUILD_TYPE=Release
+export EXTRA_CFLAGS_DEBUG
+if [ -n "${COLLECTOR_BUILDER_DEBUG}" ]; then
+    CMAKE_BUILD_TYPE=RelWithDebInfo
+    EXTRA_CFLAGS_DEBUG=-g
+fi
+
 # shellcheck source=SCRIPTDIR/versions.sh
 source builder/install/versions.sh
 for f in builder/install/[0-9][0-9]-*.sh; do