学习使用meson+ninja构建C语言工程(含单元测试)

2024-08-24 15:12

本文主要是介绍学习使用meson+ninja构建C语言工程(含单元测试),希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

背景知识

Meson 是一个高效、易用且跨平台的构建系统,主要用于描述和管理项目的构建过程。Meson 使用简洁的配置语言来定义项目的构建规则,并生成 Ninja 构建文件以实际执行构建任务。

Ninja 是一个轻量级的构建工具,专注于快速并行构建。它通过构建任务的依赖关系图,实现高效的并行构建,从而加速项目的构建过程。

CMocka 则是一个适用于 C 语言的单元测试框架,用于编写和执行单元测试,验证代码的正确性。

将 Meson、Ninja 和 CMocka 结合使用,可以创建一个高效的构建和测试环境,有助于开发人员在 C 语言项目中实现自动化构建和单元测试。

以下是使用 Meson、Ninja 和 CMocka 的一般工作流程:

  • 在 Meson 中配置项目:使用 Meson 的简洁配置语言描述项目的构建过程,包括编译选项、依赖项等。在 Meson 配置中,可以指定 CMocka 作为项目的单元测试框架。
  • 生成 Ninja 构建文件:运行 Meson 配置,生成 Ninja 构建系统所需的构建文件。
  • 编写单元测试:使用 CMocka 编写针对 C 代码的单元测试,包括设置测试用例、断言等。
  • 执行单元测试:通过 Ninja 构建系统执行单元测试,验证代码的正确性。通常可以在构建过程中集成单元测试的运行。
  • 查看测试报告:查看单元测试的结果和报告,检查测试用例的覆盖率和执行情况。

通过结合 Meson、Ninja 和 CMocka,开发人员可以实现高效的构建和测试流程,帮助确保代码的质量和稳定性。这种组合提供了一种简单且强大的方式来管理 C 语言项目的构建和单元测试。

具体来说:项目开发中一般将 Meson 和 Ninja 配合使用,Meson 负责构建项目依赖关系,Ninja 负责编译代码。meson和make一样,需要写描述文件告诉meson要构建什么,这个描述文件
就是meson.build,meson根据meson.build中的定义生成具体的构建定义文件build.ninja,
ninja根据build.ninja完成具体构建。

实验环境

  • 系统版本使用Ubuntu22.04,自带python3.10
  • 安装cmocka和pkg-config
admin@pc:~$ sudo apt-get install libcmocka-dev pkg-config -yadmin@pc:~/my_project$ dpkg -l libcmocka-dev | grep libc
ii  libcmocka-dev:amd64 1.1.5-2      amd64        development files for the CMocka unit testing framework
admin@pc:~/my_project$ 
admin@pc:~/my_project$ dpkg -l pkg-config | grep pkg-config
ii  pkg-config     0.29.2-1ubun
  • 安装meson和ninja
admin@pc:~$ pip3 install meson ninjaadmin@pc:~$ pip3 freeze | grep meson
meson==1.5.1
admin@pc:~$ pip3 freeze | grep ninja
ninja==1.11.1.1
admin@pc:~$ 

项目构建

  • 项目的目录结构如下
admin@pc:~$ tree my_project/
my_project/
├── include
│   └── mylib.h
├── meson.build
├── src
│   ├── main.c
│   ├── meson.build
│   └── mylib.c
└── test├── meson.build└── test_mylib.c3 directories, 7 files
admin@pc:~$ 

源码分析

根目录

  • 包含meson.build文件和三个目录include/src/main
  • meson.build的源码如下:
admin@pc:~/my_project$ cat meson.build 
project('my_project', 'c')# 指定头文件目录
inc = include_directories('include')subdir('src')
subdir('test')
admin@pc:~/my_project$ 
  • project()指定项目名称和编程语言的类型
  • 创建一个变量inc,通过include_directories()命令用于引入头文件路径
  • subdir()命令将下级目录的meson.build文件包含进来,类似于CMake的add_subdirectory()

include目录

  • 放置头文件,声明函数
admin@pc:~/my_project$ cat include/mylib.h 
#ifndef MYLIB_H
#define MYLIB_Hvoid greet(void);
int add(int a, int b);#endif // MYLIB_H
admin@pc:~/my_project$ 

src目录

  • 源码文件内容如下:
admin@pc:~/my_project$ cat src/mylib.c 
#include <stdio.h>
#include "mylib.h"void greet(void) {printf("Hello from mylib!\n");
}int add(int a, int b) {return a + b;
}
admin@pc:~/my_project$ 
admin@pc:~/my_project$ cat src/main.c 
#include "mylib.h"int main() {greet();return 0;
}
admin@pc:~/my_project$ 
  • meson.build文件如下
admin@pc:~/my_project$ cat src/meson.build 
# 编译库
libmylib = static_library('mylib', 'mylib.c', include_directories: inc)# 编译可执行文件并链接库
executable('my_project', 'main.c', link_with: libmylib, include_directories: inc)
admin@pc:~/my_project$ 
  • static_library()指定静态库文件的文件名和入口源文件
  • 'inc’在上一层meson.build已经定于
  • executable()创建可执行文件,'my_project’是最终可执行文件的名字,'main.c’是源文件,link_with指定lib库

test目录

  • 源码文件内容如下,故意构造了success的测试用例和fail测试用例:
admin@pc:~/my_project$ cat test/test_mylib.c 
#include <stdarg.h>
#include <stddef.h>
#include <setjmp.h>
#include <cmocka.h>
#include "mylib.h"static void test_add_success(void **state) {assert_int_equal(add(2, 3), 5);assert_int_equal(add(-1, 1), 0);
}static void test_add_fail(void **state) {assert_int_equal(add(2, 2), 5);
}int main(void) {const struct CMUnitTest tests[] = {cmocka_unit_test(test_add_success),cmocka_unit_test(test_add_fail),};return cmocka_run_group_tests(tests, NULL, NULL);
}
admin@pc:~/my_project$ 
  • meson.build文件如下
admin@pc:~/my_project$ cat test/meson.build 
# 依赖 CMocka
cmocka_dep = dependency('cmocka', required: true)# 编译测试可执行文件
test_executable = executable('test_mylib', 'test_mylib.c',dependencies: [cmocka_dep],include_directories: inc,link_with: libmylib)# 添加测试
test('mylib tests', test_executable)
admin@pc:~/my_project$ 

编译和执行

  • 构建
admin@pc:~/my_project$ meson setup builddir
  • 编译
admin@pc:~/my_project$ meson compile -C builddir/
  • 编出了两个可执行文件,都在builddir目录下
admin@pc:~/my_project$ find ./ -name my_project
./builddir/src/my_project
admin@pc:~/my_project$ 
admin@pc:~/my_project$ 
admin@pc:~/my_project$ find ./ -name test_mylib
./builddir/test/test_mylib
admin@pc:~/my_project$ 
  • 分别执行
admin@pc:~/my_project$ ./builddir/src/my_project
Hello from mylib!
admin@pc:~/my_project$ 
admin@pc:~/my_project$ 
admin@pc:~/my_project$ ./builddir/test/test_mylib
[==========] Running 2 test(s).
[ RUN      ] test_add_success
[       OK ] test_add_success
[ RUN      ] test_add_fail
[  ERROR   ] --- 0x4 != 0x5
[   LINE   ] --- ../test/test_mylib.c:13: error: Failure!
[  FAILED  ] test_add_fail
[==========] 2 test(s) run.
[  PASSED  ] 1 test(s).
[  FAILED  ] 1 test(s), listed below:
[  FAILED  ] test_add_fail1 FAILED TEST(S)
admin@pc:~/my_project$ 

清理

  • 只要删除了’builddir’目录,就清清静静了

这篇关于学习使用meson+ninja构建C语言工程(含单元测试)的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1102839

相关文章

postgresql使用UUID函数的方法

《postgresql使用UUID函数的方法》本文给大家介绍postgresql使用UUID函数的方法,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考下吧... 目录PostgreSQL有两种生成uuid的方法。可以先通过sql查看是否已安装扩展函数,和可以安装的扩展函数

Spring Boot Maven 插件如何构建可执行 JAR 的核心配置

《SpringBootMaven插件如何构建可执行JAR的核心配置》SpringBoot核心Maven插件,用于生成可执行JAR/WAR,内置服务器简化部署,支持热部署、多环境配置及依赖管理... 目录前言一、插件的核心功能与目标1.1 插件的定位1.2 插件的 Goals(目标)1.3 插件定位1.4 核

如何使用Lombok进行spring 注入

《如何使用Lombok进行spring注入》本文介绍如何用Lombok简化Spring注入,推荐优先使用setter注入,通过注解自动生成getter/setter及构造器,减少冗余代码,提升开发效... Lombok为了开发环境简化代码,好处不用多说。spring 注入方式为2种,构造器注入和setter

MySQL中比较运算符的具体使用

《MySQL中比较运算符的具体使用》本文介绍了SQL中常用的符号类型和非符号类型运算符,符号类型运算符包括等于(=)、安全等于(=)、不等于(/!=)、大小比较(,=,,=)等,感兴趣的可以了解一下... 目录符号类型运算符1. 等于运算符=2. 安全等于运算符<=>3. 不等于运算符<>或!=4. 小于运

使用zip4j实现Java中的ZIP文件加密压缩的操作方法

《使用zip4j实现Java中的ZIP文件加密压缩的操作方法》本文介绍如何通过Maven集成zip4j1.3.2库创建带密码保护的ZIP文件,涵盖依赖配置、代码示例及加密原理,确保数据安全性,感兴趣的... 目录1. zip4j库介绍和版本1.1 zip4j库概述1.2 zip4j的版本演变1.3 zip4

Python 字典 (Dictionary)使用详解

《Python字典(Dictionary)使用详解》字典是python中最重要,最常用的数据结构之一,它提供了高效的键值对存储和查找能力,:本文主要介绍Python字典(Dictionary)... 目录字典1.基本特性2.创建字典3.访问元素4.修改字典5.删除元素6.字典遍历7.字典的高级特性默认字典

使用Python构建一个高效的日志处理系统

《使用Python构建一个高效的日志处理系统》这篇文章主要为大家详细讲解了如何使用Python开发一个专业的日志分析工具,能够自动化处理、分析和可视化各类日志文件,大幅提升运维效率,需要的可以了解下... 目录环境准备工具功能概述完整代码实现代码深度解析1. 类设计与初始化2. 日志解析核心逻辑3. 文件处

一文详解如何使用Java获取PDF页面信息

《一文详解如何使用Java获取PDF页面信息》了解PDF页面属性是我们在处理文档、内容提取、打印设置或页面重组等任务时不可或缺的一环,下面我们就来看看如何使用Java语言获取这些信息吧... 目录引言一、安装和引入PDF处理库引入依赖二、获取 PDF 页数三、获取页面尺寸(宽高)四、获取页面旋转角度五、判断

C++中assign函数的使用

《C++中assign函数的使用》在C++标准模板库中,std::list等容器都提供了assign成员函数,它比操作符更灵活,支持多种初始化方式,下面就来介绍一下assign的用法,具有一定的参考价... 目录​1.assign的基本功能​​语法​2. 具体用法示例​​​(1) 填充n个相同值​​(2)

Spring StateMachine实现状态机使用示例详解

《SpringStateMachine实现状态机使用示例详解》本文介绍SpringStateMachine实现状态机的步骤,包括依赖导入、枚举定义、状态转移规则配置、上下文管理及服务调用示例,重点解... 目录什么是状态机使用示例什么是状态机状态机是计算机科学中的​​核心建模工具​​,用于描述对象在其生命