<返回更多

构建C语言开发环境

2023-08-18  51CTO  
加入收藏

有些C/C++项目开发周期极长。在处理此类项目过程中,构建开发环境就像施展魔法一样:测试框架被巧妙集成在一起,CI/CD流程将开发者从繁琐重复的工作中解脱出来。

作为程序员,在开发过程中,我只有一个简单的愿望:在当前的开发环境中将C库简化为少数几个文件。

在本文中,我们将介绍如何为C语言项目构建容器化开发环境,也将介绍如何使用CMake设置构建系统、使用Unity设置测试环境以及如何在CI流水线中构建容器化环境。

一、现代化开发环境

接下来,我们将展示如何为C项目构建完整的、容器化的开发环境:

在本文中,我将使用Docker命令行接口。如果你不明白为什么需要某些参数,建议参考在线文档。你也可以直接打开GitHub上的示例项目。

二、在Docker中运行程序 

有时,使用嵌入式系统C/C++需要安装大量专用工具编译器。如果你正在同时处理不同的项目,版本之间很容易发生冲突。因此,我更倾向于在Docker容器中运行所有程序。

你可以使用Dockerfiles,这能避免在本地安装工具,任何人都能通过预构建镜像本地镜像加入项目。

1.为什么是Docker?存在哪些陷阱?

如果你是Docker新手,需注意以下几点:

鉴于此,建议你不要将“赌注”“押”在同一项技术上,并且你需要随时做好切换的准备。

2.让我们这样做 

让我们从零开始,构建空存储库

图片

确保安装Dockor并顺利运行,在项目的根目录中创建如下内容:builder.Dockerfile

图片

这个Dockerifle指定了基本镜像并安装了一些包,便于在后续步骤中使用。我不会详细介绍每一个软件包:在创建镜像时,你很快就能注意到缺少了什么,可以扩展软件包列表,重要的是以下几点:

如果不使用vscode,也可以指定不同的镜像。在本文中,我们将使用vscode,也将坚持使用Dev容器所支持的镜像。

镜像是用如下的命令构建出来的,执行起来可能需要一点时间:

图片

3.详细命令行调用的快捷方式 

Docker命令非常冗长,因此,我通常将常用命令放在makefile项目根目录中。假设安装make后可进行如下操作:

图片

现在,执行如下操作重建镜像:

图片

让我们从图像中旋转容器并进行测试:

图片

当使用apt时,已安装的工具版本取决于基础镜像,也取决于包注册表。如果需要安装特定的版本,可以通过执行自定义的RUN命令。

三、Visual Studio代码开发容器 

没有在本地安装所有工具的缺点是:你选择的IDE无法利用这些工具,例如,当使用vscode时,如果没有安装编译器,你将无法正确设置智能提示或任何其它的辅助程序

vscode允许你在开发容器中运行编辑器。这也是我们选择将mcr.microsoft.com/vscode/devcontAIners/base当作基础图像的原因:我们可以在容器中链接到vscode,因此所有工具都将被安装在Docker镜像中。

值得注意的是,vscode实例与本地vscode安装不匹配,与远程实例非常相似。

通过创建.devcontainer/devcontainer.json文件,我们可以让vscode使用新构建的图像作为开发容器,还可以在vscode实例中安装3个扩展,通过使用 customizations.extensions字段中的devcontainer.json配置文件:

图片

如果你从现在开始重新加载窗口或重新打开vscode,vscode应该会询问你是否需要使用检测到的开发容器。

图片

需要一段时间为vscode设置你的容器安装扩展,并用vscode连接到Linux容器

图片

四、系统架构 

我们将使用CMake构建单独的.c和.h对。

图片

图片

CMakeLists.txt简单定义了名为“Dummy”的库,并将相应的文件添加到库中。

重要的是:这已在开发容器和vscode中被构建出来了!在你的远程实例中打开集成终端并执行CMake,如下所示:

图片

五、安装clang工具:格式化和静态代码分析

C和C++的灵活性也伴随着大量“footguns”的出现;因此,我尝试在项目中添加至少一个最小的静态代码分析任务,这有助于发现最明显的错误。市面上有很多工具,但到目前为止,我个人更偏爱clang-tidy。

另外,在代码库上进行协作时,格式化器极好;当我们在安装clang-tidy时,不妨继续安装clang-format。

你需要将两个配置文件clang-format和.clang-tidy放置到项目根目录中,以便任何IDE都能自动拾取它们:

图片

六、添加单元测试框架

我们已经能够构建并分析库,还提供了格式化功能。在开发环境中,我们还需要一个单元测试框架

在本文中,我选择了Unity测试框架,通过Ceedling在主机上执行。顺便说一句,使用这个框架便于嵌入式系统在目标硬件上执行任务。

1.安装Unity和Ceedling 

在构建者镜像的第一步中,我们已经安装了ruby,所以,安装单元测试工具变得更加简单:

图片

重建镜像后,我们就可以开始了!

图片

 

2.配置Unity和运行单元测试 

简而言之,你需要在一个专门的unity_config.h文件中将配置开关设置为Unity并配置Ceedling与project.yml. Ceedling,为你生成所有的测试运行程序。

你需要做的就是添加你的测试文件,然后“告诉”Ceedling如何检测它们:

图片

然后,我们可以创建第一个单元测试tests/unittest/test/test_dummy.c:

图片

七、结论

到这里,所有的工作就都完成了,包括库的构建等,报告也可以使用了。神奇的是,所有这些操作都不会使计算机因工具而“堵塞”

图片

最后,值得一提的是:有了Docker桌面,你不仅可以轻松检查图像漏洞,还能检查Dockerfile中的每一步:

图片

现在,你已具备在GitHub上用CI设置容器化C/C++项目的所有技能。有了这项技能,你能轻松地在文档中添加特定编译器清理设置CI时出现的所有错误

关键词:C语言      点击(9)
声明:本站部分内容来自互联网,如有版权侵犯或其他问题请与我们联系,我们将立即删除或处理。
▍相关推荐
更多C语言相关>>>