mirrors/pipewire
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pipewire/pipewire.git synced 2026-05-06 06:46:29 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions
pipewire/test/pwtest-implementation.h

125 lines
3.5 KiB
C
Raw Normal View History

treewide: use SPDX tags to specify copyright information SPDX tags make the licensing information easy to understand and clear, and they are machine parseable. See https://spdx.dev for more information.
2023-02-08 18:12:00 +01:00
/* PipeWire */
/* SPDX-FileCopyrightText: Copyright © 2021 Red Hat, Inc. */
/* SPDX-License-Identifier: MIT */
test: add the pwtest test framework Heavily inspired by libinput's litest framework (built around check), this is a from-scratch framework that simplifies adding tests for various parts of pipewire. See the pwtest.h documentation for details but the basics are: - PW_TEST() and PWTEST_SUITE() specify the tests to be run - Test are run in forked processes, any errors/signals are caught and printed to the log - Tests have a custom pipewire daemon started on demand to talk to [1]. The daemon's log is available in the test output. - Output is YAML to be processed into whatever format needed [1] There are limits here, since we can't emulate devices yet there is only so much we can rely on with the daemon.
2021-05-27 10:05:19 +10:00
#ifndef PWTEST_IMPLEMENTATION_H
#define PWTEST_IMPLEMENTATION_H
#include <math.h>
/* This header should never be included on its own, it merely exists to make
* the user-visible pwtest.h header more readable */
test: move SPA_NORETURN attributes to header Otherwise, when building with fortify-headers, I get an error because the compiler doesn't know pwtest_ptr_notnull will not return if the passed pointer is null, so it doesn't know the pointer subsequently passed to memmove via pw_array_remove will be non-null. In file included from ../spa/include/spa/utils/defs.h:11, from ../spa/include/spa/utils/string.h:15, from ../test/pwtest.h:15, from ../test/test-array.c:7: In function ‘memmove’, inlined from ‘array_test’ at ../test/test-array.c:66:2: /nix/store/9031y56lsf4mq177s68ql1axsf241r7j-fortify-headers-3.0.1/include/string.h:77:16: error: argument 1 is null but the corresponding size argument 3 value is [8, 18446744073709551615] [-Werror=nonnull] 77 | return __orig_memmove(__d, __s, __n); | ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~ /nix/store/9031y56lsf4mq177s68ql1axsf241r7j-fortify-headers-3.0.1/include/string.h:77:16: warning: ‘__orig_memmove’ reading 8 or more bytes from a region of size 0 [-Wstringop-overread] In function ‘array_test’: cc1: note: source object is likely at address zero In file included from /nix/store/9031y56lsf4mq177s68ql1axsf241r7j-fortify-headers-3.0.1/include/stdlib.h:33, from ../spa/include/spa/utils/string.h:11: /nix/store/9031y56lsf4mq177s68ql1axsf241r7j-fortify-headers-3.0.1/include/string.h:69:1: note: in a call to function ‘__orig_memmove’ declared with attribute ‘access (read_only, 2, 3)’ 69 | _FORTIFY_FN(memmove) void *memmove(void * _FORTIFY_POS0 __d, | ^~~~~~~~~~~
2026-05-04 17:43:44 +02:00
SPA_NORETURN
test: add the pwtest test framework Heavily inspired by libinput's litest framework (built around check), this is a from-scratch framework that simplifies adding tests for various parts of pipewire. See the pwtest.h documentation for details but the basics are: - PW_TEST() and PWTEST_SUITE() specify the tests to be run - Test are run in forked processes, any errors/signals are caught and printed to the log - Tests have a custom pipewire daemon started on demand to talk to [1]. The daemon's log is available in the test output. - Output is YAML to be processed into whatever format needed [1] There are limits here, since we can't emulate devices yet there is only so much we can rely on with the daemon.
2021-05-27 10:05:19 +10:00
void
_pwtest_fail_condition(int exitstatus, const char *file, int line, const char *func,
const char *condition, const char *message, ...);
test: move SPA_NORETURN attributes to header Otherwise, when building with fortify-headers, I get an error because the compiler doesn't know pwtest_ptr_notnull will not return if the passed pointer is null, so it doesn't know the pointer subsequently passed to memmove via pw_array_remove will be non-null. In file included from ../spa/include/spa/utils/defs.h:11, from ../spa/include/spa/utils/string.h:15, from ../test/pwtest.h:15, from ../test/test-array.c:7: In function ‘memmove’, inlined from ‘array_test’ at ../test/test-array.c:66:2: /nix/store/9031y56lsf4mq177s68ql1axsf241r7j-fortify-headers-3.0.1/include/string.h:77:16: error: argument 1 is null but the corresponding size argument 3 value is [8, 18446744073709551615] [-Werror=nonnull] 77 | return __orig_memmove(__d, __s, __n); | ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~ /nix/store/9031y56lsf4mq177s68ql1axsf241r7j-fortify-headers-3.0.1/include/string.h:77:16: warning: ‘__orig_memmove’ reading 8 or more bytes from a region of size 0 [-Wstringop-overread] In function ‘array_test’: cc1: note: source object is likely at address zero In file included from /nix/store/9031y56lsf4mq177s68ql1axsf241r7j-fortify-headers-3.0.1/include/stdlib.h:33, from ../spa/include/spa/utils/string.h:11: /nix/store/9031y56lsf4mq177s68ql1axsf241r7j-fortify-headers-3.0.1/include/string.h:69:1: note: in a call to function ‘__orig_memmove’ declared with attribute ‘access (read_only, 2, 3)’ 69 | _FORTIFY_FN(memmove) void *memmove(void * _FORTIFY_POS0 __d, | ^~~~~~~~~~~
2026-05-04 17:43:44 +02:00
SPA_NORETURN
test: add the pwtest test framework Heavily inspired by libinput's litest framework (built around check), this is a from-scratch framework that simplifies adding tests for various parts of pipewire. See the pwtest.h documentation for details but the basics are: - PW_TEST() and PWTEST_SUITE() specify the tests to be run - Test are run in forked processes, any errors/signals are caught and printed to the log - Tests have a custom pipewire daemon started on demand to talk to [1]. The daemon's log is available in the test output. - Output is YAML to be processed into whatever format needed [1] There are limits here, since we can't emulate devices yet there is only so much we can rely on with the daemon.
2021-05-27 10:05:19 +10:00
void
_pwtest_fail_comparison_int(const char *file, int line, const char *func,
const char *operator, int a, int b,
const char *astr, const char *bstr);
test: move SPA_NORETURN attributes to header Otherwise, when building with fortify-headers, I get an error because the compiler doesn't know pwtest_ptr_notnull will not return if the passed pointer is null, so it doesn't know the pointer subsequently passed to memmove via pw_array_remove will be non-null. In file included from ../spa/include/spa/utils/defs.h:11, from ../spa/include/spa/utils/string.h:15, from ../test/pwtest.h:15, from ../test/test-array.c:7: In function ‘memmove’, inlined from ‘array_test’ at ../test/test-array.c:66:2: /nix/store/9031y56lsf4mq177s68ql1axsf241r7j-fortify-headers-3.0.1/include/string.h:77:16: error: argument 1 is null but the corresponding size argument 3 value is [8, 18446744073709551615] [-Werror=nonnull] 77 | return __orig_memmove(__d, __s, __n); | ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~ /nix/store/9031y56lsf4mq177s68ql1axsf241r7j-fortify-headers-3.0.1/include/string.h:77:16: warning: ‘__orig_memmove’ reading 8 or more bytes from a region of size 0 [-Wstringop-overread] In function ‘array_test’: cc1: note: source object is likely at address zero In file included from /nix/store/9031y56lsf4mq177s68ql1axsf241r7j-fortify-headers-3.0.1/include/stdlib.h:33, from ../spa/include/spa/utils/string.h:11: /nix/store/9031y56lsf4mq177s68ql1axsf241r7j-fortify-headers-3.0.1/include/string.h:69:1: note: in a call to function ‘__orig_memmove’ declared with attribute ‘access (read_only, 2, 3)’ 69 | _FORTIFY_FN(memmove) void *memmove(void * _FORTIFY_POS0 __d, | ^~~~~~~~~~~
2026-05-04 17:43:44 +02:00
SPA_NORETURN
test: add the pwtest test framework Heavily inspired by libinput's litest framework (built around check), this is a from-scratch framework that simplifies adding tests for various parts of pipewire. See the pwtest.h documentation for details but the basics are: - PW_TEST() and PWTEST_SUITE() specify the tests to be run - Test are run in forked processes, any errors/signals are caught and printed to the log - Tests have a custom pipewire daemon started on demand to talk to [1]. The daemon's log is available in the test output. - Output is YAML to be processed into whatever format needed [1] There are limits here, since we can't emulate devices yet there is only so much we can rely on with the daemon.
2021-05-27 10:05:19 +10:00
void
_pwtest_fail_comparison_double(const char *file, int line, const char *func,
const char *operator, double a, double b,
const char *astr, const char *bstr);
test: move SPA_NORETURN attributes to header Otherwise, when building with fortify-headers, I get an error because the compiler doesn't know pwtest_ptr_notnull will not return if the passed pointer is null, so it doesn't know the pointer subsequently passed to memmove via pw_array_remove will be non-null. In file included from ../spa/include/spa/utils/defs.h:11, from ../spa/include/spa/utils/string.h:15, from ../test/pwtest.h:15, from ../test/test-array.c:7: In function ‘memmove’, inlined from ‘array_test’ at ../test/test-array.c:66:2: /nix/store/9031y56lsf4mq177s68ql1axsf241r7j-fortify-headers-3.0.1/include/string.h:77:16: error: argument 1 is null but the corresponding size argument 3 value is [8, 18446744073709551615] [-Werror=nonnull] 77 | return __orig_memmove(__d, __s, __n); | ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~ /nix/store/9031y56lsf4mq177s68ql1axsf241r7j-fortify-headers-3.0.1/include/string.h:77:16: warning: ‘__orig_memmove’ reading 8 or more bytes from a region of size 0 [-Wstringop-overread] In function ‘array_test’: cc1: note: source object is likely at address zero In file included from /nix/store/9031y56lsf4mq177s68ql1axsf241r7j-fortify-headers-3.0.1/include/stdlib.h:33, from ../spa/include/spa/utils/string.h:11: /nix/store/9031y56lsf4mq177s68ql1axsf241r7j-fortify-headers-3.0.1/include/string.h:69:1: note: in a call to function ‘__orig_memmove’ declared with attribute ‘access (read_only, 2, 3)’ 69 | _FORTIFY_FN(memmove) void *memmove(void * _FORTIFY_POS0 __d, | ^~~~~~~~~~~
2026-05-04 17:43:44 +02:00
SPA_NORETURN
test: add the pwtest test framework Heavily inspired by libinput's litest framework (built around check), this is a from-scratch framework that simplifies adding tests for various parts of pipewire. See the pwtest.h documentation for details but the basics are: - PW_TEST() and PWTEST_SUITE() specify the tests to be run - Test are run in forked processes, any errors/signals are caught and printed to the log - Tests have a custom pipewire daemon started on demand to talk to [1]. The daemon's log is available in the test output. - Output is YAML to be processed into whatever format needed [1] There are limits here, since we can't emulate devices yet there is only so much we can rely on with the daemon.
2021-05-27 10:05:19 +10:00
void
_pwtest_fail_comparison_ptr(const char *file, int line, const char *func,
const char *comparison);
test: move SPA_NORETURN attributes to header Otherwise, when building with fortify-headers, I get an error because the compiler doesn't know pwtest_ptr_notnull will not return if the passed pointer is null, so it doesn't know the pointer subsequently passed to memmove via pw_array_remove will be non-null. In file included from ../spa/include/spa/utils/defs.h:11, from ../spa/include/spa/utils/string.h:15, from ../test/pwtest.h:15, from ../test/test-array.c:7: In function ‘memmove’, inlined from ‘array_test’ at ../test/test-array.c:66:2: /nix/store/9031y56lsf4mq177s68ql1axsf241r7j-fortify-headers-3.0.1/include/string.h:77:16: error: argument 1 is null but the corresponding size argument 3 value is [8, 18446744073709551615] [-Werror=nonnull] 77 | return __orig_memmove(__d, __s, __n); | ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~ /nix/store/9031y56lsf4mq177s68ql1axsf241r7j-fortify-headers-3.0.1/include/string.h:77:16: warning: ‘__orig_memmove’ reading 8 or more bytes from a region of size 0 [-Wstringop-overread] In function ‘array_test’: cc1: note: source object is likely at address zero In file included from /nix/store/9031y56lsf4mq177s68ql1axsf241r7j-fortify-headers-3.0.1/include/stdlib.h:33, from ../spa/include/spa/utils/string.h:11: /nix/store/9031y56lsf4mq177s68ql1axsf241r7j-fortify-headers-3.0.1/include/string.h:69:1: note: in a call to function ‘__orig_memmove’ declared with attribute ‘access (read_only, 2, 3)’ 69 | _FORTIFY_FN(memmove) void *memmove(void * _FORTIFY_POS0 __d, | ^~~~~~~~~~~
2026-05-04 17:43:44 +02:00
SPA_NORETURN
test: add the pwtest test framework Heavily inspired by libinput's litest framework (built around check), this is a from-scratch framework that simplifies adding tests for various parts of pipewire. See the pwtest.h documentation for details but the basics are: - PW_TEST() and PWTEST_SUITE() specify the tests to be run - Test are run in forked processes, any errors/signals are caught and printed to the log - Tests have a custom pipewire daemon started on demand to talk to [1]. The daemon's log is available in the test output. - Output is YAML to be processed into whatever format needed [1] There are limits here, since we can't emulate devices yet there is only so much we can rely on with the daemon.
2021-05-27 10:05:19 +10:00
void
_pwtest_fail_comparison_str(const char *file, int line, const char *func,
const char *comparison, const char *a, const char *b);
test: move SPA_NORETURN attributes to header Otherwise, when building with fortify-headers, I get an error because the compiler doesn't know pwtest_ptr_notnull will not return if the passed pointer is null, so it doesn't know the pointer subsequently passed to memmove via pw_array_remove will be non-null. In file included from ../spa/include/spa/utils/defs.h:11, from ../spa/include/spa/utils/string.h:15, from ../test/pwtest.h:15, from ../test/test-array.c:7: In function ‘memmove’, inlined from ‘array_test’ at ../test/test-array.c:66:2: /nix/store/9031y56lsf4mq177s68ql1axsf241r7j-fortify-headers-3.0.1/include/string.h:77:16: error: argument 1 is null but the corresponding size argument 3 value is [8, 18446744073709551615] [-Werror=nonnull] 77 | return __orig_memmove(__d, __s, __n); | ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~ /nix/store/9031y56lsf4mq177s68ql1axsf241r7j-fortify-headers-3.0.1/include/string.h:77:16: warning: ‘__orig_memmove’ reading 8 or more bytes from a region of size 0 [-Wstringop-overread] In function ‘array_test’: cc1: note: source object is likely at address zero In file included from /nix/store/9031y56lsf4mq177s68ql1axsf241r7j-fortify-headers-3.0.1/include/stdlib.h:33, from ../spa/include/spa/utils/string.h:11: /nix/store/9031y56lsf4mq177s68ql1axsf241r7j-fortify-headers-3.0.1/include/string.h:69:1: note: in a call to function ‘__orig_memmove’ declared with attribute ‘access (read_only, 2, 3)’ 69 | _FORTIFY_FN(memmove) void *memmove(void * _FORTIFY_POS0 __d, | ^~~~~~~~~~~
2026-05-04 17:43:44 +02:00
SPA_NORETURN
test: add the pwtest test framework Heavily inspired by libinput's litest framework (built around check), this is a from-scratch framework that simplifies adding tests for various parts of pipewire. See the pwtest.h documentation for details but the basics are: - PW_TEST() and PWTEST_SUITE() specify the tests to be run - Test are run in forked processes, any errors/signals are caught and printed to the log - Tests have a custom pipewire daemon started on demand to talk to [1]. The daemon's log is available in the test output. - Output is YAML to be processed into whatever format needed [1] There are limits here, since we can't emulate devices yet there is only so much we can rely on with the daemon.
2021-05-27 10:05:19 +10:00
void
_pwtest_fail_comparison_bool(const char *file, int line, const char *func,
const char *operator, bool a, bool b,
const char *astr, const char *bstr);
test: move SPA_NORETURN attributes to header Otherwise, when building with fortify-headers, I get an error because the compiler doesn't know pwtest_ptr_notnull will not return if the passed pointer is null, so it doesn't know the pointer subsequently passed to memmove via pw_array_remove will be non-null. In file included from ../spa/include/spa/utils/defs.h:11, from ../spa/include/spa/utils/string.h:15, from ../test/pwtest.h:15, from ../test/test-array.c:7: In function ‘memmove’, inlined from ‘array_test’ at ../test/test-array.c:66:2: /nix/store/9031y56lsf4mq177s68ql1axsf241r7j-fortify-headers-3.0.1/include/string.h:77:16: error: argument 1 is null but the corresponding size argument 3 value is [8, 18446744073709551615] [-Werror=nonnull] 77 | return __orig_memmove(__d, __s, __n); | ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~ /nix/store/9031y56lsf4mq177s68ql1axsf241r7j-fortify-headers-3.0.1/include/string.h:77:16: warning: ‘__orig_memmove’ reading 8 or more bytes from a region of size 0 [-Wstringop-overread] In function ‘array_test’: cc1: note: source object is likely at address zero In file included from /nix/store/9031y56lsf4mq177s68ql1axsf241r7j-fortify-headers-3.0.1/include/stdlib.h:33, from ../spa/include/spa/utils/string.h:11: /nix/store/9031y56lsf4mq177s68ql1axsf241r7j-fortify-headers-3.0.1/include/string.h:69:1: note: in a call to function ‘__orig_memmove’ declared with attribute ‘access (read_only, 2, 3)’ 69 | _FORTIFY_FN(memmove) void *memmove(void * _FORTIFY_POS0 __d, | ^~~~~~~~~~~
2026-05-04 17:43:44 +02:00
SPA_NORETURN
test: add errno check macros
2021-06-04 15:23:51 +10:00
void
_pwtest_fail_errno(const char *file, int line, const char *func,
int expected, int err_no);
#define pwtest_errno_check(r_, errno_) \
do { \
int _r = r_; \
int _e = errno_; \
if (_e == 0) { \
if (_r == -1) \
_pwtest_fail_errno(__FILE__, __LINE__, __func__, _e, errno); \
} else { \
if (_r != -1 || errno != _e) \
_pwtest_fail_errno(__FILE__, __LINE__, __func__, _e, errno); \
} \
} while(0)
#define pwtest_neg_errno_check(r_, errno_) \
do { \
int _r = r_; \
int _e = errno_; \
if (_e == 0) { \
if (_r < 0) \
_pwtest_fail_errno(__FILE__, __LINE__, __func__, _e, -_r); \
} else { \
if (_r >= 0 || _r != _e) \
_pwtest_fail_errno(__FILE__, __LINE__, __func__, -_e, _r >= 0 ? 0 : -_r); \
} \
} while(0)
test: add the pwtest test framework Heavily inspired by libinput's litest framework (built around check), this is a from-scratch framework that simplifies adding tests for various parts of pipewire. See the pwtest.h documentation for details but the basics are: - PW_TEST() and PWTEST_SUITE() specify the tests to be run - Test are run in forked processes, any errors/signals are caught and printed to the log - Tests have a custom pipewire daemon started on demand to talk to [1]. The daemon's log is available in the test output. - Output is YAML to be processed into whatever format needed [1] There are limits here, since we can't emulate devices yet there is only so much we can rely on with the daemon.
2021-05-27 10:05:19 +10:00
#define pwtest_comparison_bool_(a_, op_, b_) \
do { \
bool _a = !!(a_); \
bool _b = !!(b_); \
if (!(_a op_ _b)) \
_pwtest_fail_comparison_bool(__FILE__, __LINE__, __func__,\
#op_, _a, _b, #a_, #b_); \
} while(0)
#define pwtest_comparison_int_(a_, op_, b_) \
do { \
__typeof__(a_) _a = a_; \
__typeof__(b_) _b = b_; \
if (trunc(_a) != _a || trunc(_b) != _b) \
pwtest_error_with_msg("pwtest_int_* used for non-integer value\n"); \
if (!((_a) op_ (_b))) \
_pwtest_fail_comparison_int(__FILE__, __LINE__, __func__,\
#op_, _a, _b, #a_, #b_); \
} while(0)
#define pwtest_comparison_ptr_(a_, op_, b_) \
do { \
__typeof__(a_) _a = a_; \
__typeof__(b_) _b = b_; \
if (!((_a) op_ (_b))) \
_pwtest_fail_comparison_ptr(__FILE__, __LINE__, __func__,\
#a_ " " #op_ " " #b_); \
} while(0)
#define pwtest_comparison_double_(a_, op_, b_) \
do { \
const double EPSILON = 1.0/256; \
__typeof__(a_) _a = a_; \
__typeof__(b_) _b = b_; \
if (!((_a) op_ (_b)) && fabs((_a) - (_b)) > EPSILON) \
_pwtest_fail_comparison_double(__FILE__, __LINE__, __func__,\
#op_, _a, _b, #a_, #b_); \
} while(0)
void _pwtest_add(struct pwtest_context *ctx,
struct pwtest_suite *suite,
const char *funcname, const void *func,
...) SPA_SENTINEL;
struct pwtest_suite_decl {
const char *name;
enum pwtest_result (*setup)(struct pwtest_context *, struct pwtest_suite *);
treewide: retain sections to prevent linker garbage collection The linker may remove sections that are actually used when "--gc-sections" and "-z start-stop-gc" is set. Add the `retain` attribute to prevent that. Furthermore, fix the alignment for `pwtest_suite_decl` objects. See: #2292 See: https://lld.llvm.org/ELF/start-stop-gc.html See: https://github.com/systemd/systemd/issues/21847 See: https://github.com/systemd/systemd/pull/21855
2022-04-13 18:13:12 +02:00
};
test: add the pwtest test framework Heavily inspired by libinput's litest framework (built around check), this is a from-scratch framework that simplifies adding tests for various parts of pipewire. See the pwtest.h documentation for details but the basics are: - PW_TEST() and PWTEST_SUITE() specify the tests to be run - Test are run in forked processes, any errors/signals are caught and printed to the log - Tests have a custom pipewire daemon started on demand to talk to [1]. The daemon's log is available in the test output. - Output is YAML to be processed into whatever format needed [1] There are limits here, since we can't emulate devices yet there is only so much we can rely on with the daemon.
2021-05-27 10:05:19 +10:00
#endif /* PWTEST_IMPLEMENTATION_H */
Reference in a new issue Copy permalink