llvm-project/libc/docs/dev/api_test.rst

.. _api_test:

========
API Test
========

.. warning::
  This page is severely out of date. Much of the information it contains may be
  incorrect. Please only remove this warning once the page has been updated.

The implementation of libc-project is unique because our public C header files
are generated using information from ground truth captured in TableGen files.
Unit tests only exercise the internal C++ implementations and don't ensure the
headers were generated by the build system and that the generated header files
contain the expected declarations and definitions. A simple solution is to have
contributors write an integration test for each individual function as a C
program; however, this would place a large burden on contributors and duplicates
some effort from the unit tests.

Instead we automate the generation of what we call as an API test. This API test
ensures that public facing symbols are visible, that the header files are
generated as expected, and that each libc function has the correct function
prototype as specified by the standards. The API test cmake rules are located in
``test/src/CMakeLists.txt``. The source file for the API test is generated in
``<build directory>/projects/libc/test/src/public_api_test.cpp``
[libc][docs] Move links to internal developer guides out of the main side bar. The links are all now from a "Developer Guides" page which is linked from the main side bar. 2022-11-04 12:53:24 -07:00			`.. _api_test:`

			`========`
[libc] Rename libc-integration-test to libc-api-test. Reviewed By: jeffbailey, michaelrj Differential Revision: https://reviews.llvm.org/D122272 2022-03-22 23:42:01 +00:00			`API Test`
[libc][docs] Move links to internal developer guides out of the main side bar. The links are all now from a "Developer Guides" page which is linked from the main side bar. 2022-11-04 12:53:24 -07:00			`========`
[libc][docs] Update implementation docs (#73590) Some of the files in the docs/ directory are from 2019 and haven't been updated since. This patch updates implementation_standard.rst, source_tree_layout.rst, and has some minor fixes for strings.rst. It also marks the most severely out of date files with a warning. These files will be updated in a later patch. 2023-11-28 10:14:12 -08:00
			`.. warning::`
			`This page is severely out of date. Much of the information it contains may be`
			`incorrect. Please only remove this warning once the page has been updated.`

[libc] Rename libc-integration-test to libc-api-test. Reviewed By: jeffbailey, michaelrj Differential Revision: https://reviews.llvm.org/D122272 2022-03-22 23:42:01 +00:00			`The implementation of libc-project is unique because our public C header files`
			`are generated using information from ground truth captured in TableGen files.`
			`Unit tests only exercise the internal C++ implementations and don't ensure the`
			`headers were generated by the build system and that the generated header files`
[libc] Fix typos in documentation 2023-04-24 23:31:48 -07:00			`contain the expected declarations and definitions. A simple solution is to have`
[libc] Rename libc-integration-test to libc-api-test. Reviewed By: jeffbailey, michaelrj Differential Revision: https://reviews.llvm.org/D122272 2022-03-22 23:42:01 +00:00			`contributors write an integration test for each individual function as a C`
			`program; however, this would place a large burden on contributors and duplicates`
			`some effort from the unit tests.`

			`Instead we automate the generation of what we call as an API test. This API test`
			`ensures that public facing symbols are visible, that the header files are`
			`generated as expected, and that each libc function has the correct function`
			`prototype as specified by the standards. The API test cmake rules are located in`
			``test/src/CMakeLists.txt``. The source file for the API test is generated in
			``<build directory>/projects/libc/test/src/public_api_test.cpp``