学习使用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

相关文章

vue使用docxtemplater导出word

《vue使用docxtemplater导出word》docxtemplater是一种邮件合并工具,以编程方式使用并处理条件、循环,并且可以扩展以插入任何内容,下面我们来看看如何使用docxtempl... 目录docxtemplatervue使用docxtemplater导出word安装常用语法 封装导出方

Linux换行符的使用方法详解

《Linux换行符的使用方法详解》本文介绍了Linux中常用的换行符LF及其在文件中的表示,展示了如何使用sed命令替换换行符,并列举了与换行符处理相关的Linux命令,通过代码讲解的非常详细,需要的... 目录简介检测文件中的换行符使用 cat -A 查看换行符使用 od -c 检查字符换行符格式转换将

使用Jackson进行JSON生成与解析的新手指南

《使用Jackson进行JSON生成与解析的新手指南》这篇文章主要为大家详细介绍了如何使用Jackson进行JSON生成与解析处理,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录1. 核心依赖2. 基础用法2.1 对象转 jsON(序列化)2.2 JSON 转对象(反序列化)3.

使用Python实现快速搭建本地HTTP服务器

《使用Python实现快速搭建本地HTTP服务器》:本文主要介绍如何使用Python快速搭建本地HTTP服务器,轻松实现一键HTTP文件共享,同时结合二维码技术,让访问更简单,感兴趣的小伙伴可以了... 目录1. 概述2. 快速搭建 HTTP 文件共享服务2.1 核心思路2.2 代码实现2.3 代码解读3.

Elasticsearch 在 Java 中的使用教程

《Elasticsearch在Java中的使用教程》Elasticsearch是一个分布式搜索和分析引擎,基于ApacheLucene构建,能够实现实时数据的存储、搜索、和分析,它广泛应用于全文... 目录1. Elasticsearch 简介2. 环境准备2.1 安装 Elasticsearch2.2 J

使用C#代码在PDF文档中添加、删除和替换图片

《使用C#代码在PDF文档中添加、删除和替换图片》在当今数字化文档处理场景中,动态操作PDF文档中的图像已成为企业级应用开发的核心需求之一,本文将介绍如何在.NET平台使用C#代码在PDF文档中添加、... 目录引言用C#添加图片到PDF文档用C#删除PDF文档中的图片用C#替换PDF文档中的图片引言在当

Java中List的contains()方法的使用小结

《Java中List的contains()方法的使用小结》List的contains()方法用于检查列表中是否包含指定的元素,借助equals()方法进行判断,下面就来介绍Java中List的c... 目录详细展开1. 方法签名2. 工作原理3. 使用示例4. 注意事项总结结论:List 的 contain

C#使用SQLite进行大数据量高效处理的代码示例

《C#使用SQLite进行大数据量高效处理的代码示例》在软件开发中,高效处理大数据量是一个常见且具有挑战性的任务,SQLite因其零配置、嵌入式、跨平台的特性,成为许多开发者的首选数据库,本文将深入探... 目录前言准备工作数据实体核心技术批量插入:从乌龟到猎豹的蜕变分页查询:加载百万数据异步处理:拒绝界面

Android中Dialog的使用详解

《Android中Dialog的使用详解》Dialog(对话框)是Android中常用的UI组件,用于临时显示重要信息或获取用户输入,本文给大家介绍Android中Dialog的使用,感兴趣的朋友一起... 目录android中Dialog的使用详解1. 基本Dialog类型1.1 AlertDialog(

Python使用自带的base64库进行base64编码和解码

《Python使用自带的base64库进行base64编码和解码》在Python中,处理数据的编码和解码是数据传输和存储中非常普遍的需求,其中,Base64是一种常用的编码方案,本文我将详细介绍如何使... 目录引言使用python的base64库进行编码和解码编码函数解码函数Base64编码的应用场景注意