如何确保错误代码不会构建在 CI 进程中？

Question

我正在编写一些 C++ 库，并且我已经使用了一些 CI（持续集成）流程，以确保这些功能正常工作。构建是基于 makefile 的，因此 CI 脚本包含 make test 行。该目标将运行自动化测试（例如，使用 Catch），并且仅在成功时构建通过。

最佳实践要求用户代码对库的错误使用最好触发编译错误，而不是运行时错误。所以我包括了很多静态检查。

但是，我想在我的自动化测试过程中确保确实如此（错误地使用该库的用户代码将无法构建）。

所以我建立了一个包含几个 .cpp 文件的文件夹，每个文件都展示了库的错误用法，因此每个文件都应该无法构建。

我的问题是，如果我在我的 makefile 中添加一个新目标来构建它们，它将在第一次失败后 return。

我想做的是确保所有这些文件都无法构建，并且return只有在那种情况下才为0。

如何编写执行此操作的目标？

一些（不工作的）代码，在第一次失败后会 return。

SRC_FILES := $(wildcard *.cpp)
OBJ_FILES := $(patsubst %.cpp, %.o, $(SRC_FILES))

all: $(OBJ_FILES)
    @echo "done"

%.o: %.cpp
    $(CXX) -o $@ -c $<

如果我基本上忽略失败（在行前加上 -），我将无法检查所有文件是否正确。

Answer 1

如果您想使用相同的模式规则，唯一的方法是通过递归 make 并传递 -k 标志 (--keep-going)，如下所示：

TEST_SRCS := bad1.cpp bad2.cpp bad3.cpp

.PHONY: test_compile
test_compile:
          $(MAKE) -k $(TEST_SRCS:%.cpp=%.o)

另一种选择是在单个配方中循环编译它们：

test_compile:
         ok=true; \
         for src in $(TEST_SRCS); do \
           $(CXX) -o $${src%.cpp}.o -c $$src || ok=false; \
         done; \
         $$ok

Answer 2

srcs := fail1.cpp fail2.cpp fail3.cpp
failed := ${srcs:.cpp=.failed}

PHONY: test
test: ${failed} ; : $@ Success

${failed}: %.failed: %.cpp
    ! gcc blah blah $< -o ${@:.failed=.o}
    touch $@

这里发生的是，当你想要构建 test 时，make 首先尝试构建 fail1.failed.

如果编译成功，make 失败并报错。

OTOH 如果编译失败，将创建输出文件 fail1.failed。

顺便说一句，make 知道 fail1.failed 依赖于 fail1.cpp。如果 .failed 比 .cpp 更新，测试甚至不会运行。不错

fail2.failed 和 fail3.failed 相同。并行安全，如果你的依赖关系正确，只有需要运行的测试才能得到运行。 的全部要点真的。

Answer 3

接受@MadScientist 的回答，但为了记录，似乎也可以通过这种方式完成：

SRC_FILES := $(wildcard *.cpp)
OBJ_FILES := $(patsubst %.cpp, %.o, $(SRC_FILES))

all: $(OBJ_FILES)
    @echo "done"

%.o: %.cpp
    ! $(CXX) -o $@ -c $<

只需从编译 shell 命令中反转 return 值：如果单个文件成功，则 make 将立即退出并返回 "error" return 值。

如何确保错误代码不会构建在 CI 进程中？

How do I make sure erroneous code does not build in a CI process?

c++

testing

continuous-integration

makefile

gnu-make