esp-idf/components/esp_rom/host_test/rom_test/README.md

| Supported Targets | Linux |
| ----------------- | ----- |

# Simplest rom test on Linux target

This unit test tests only if some of the supplied Linux functions seem to work correctly. The test framework is CATCH.

## Requirements

* A Linux system
* The usual IDF requirements for Linux system, as described in the [Getting Started Guides](../../../../docs/en/get-started/index.rst).
* The host's gcc/g++

This application has been tested on Ubuntu 20.04 with `gcc` version *9.3.0*.

## Build

First, make sure that the target is set to Linux. Run `idf.py --preview set-target linux` if you are not sure. Then do a normal IDF build: `idf.py build`.

## Run

IDF monitor doesn't work yet for Linux. You have to run the app manually: 

```bash
./build/test_rom_host.elf
```

## Example Output

Ideally, all tests pass, which is indicated by "All tests passed" in the last line:

```bash
$ ./build/test_rom_host.elf 
test
===============================================================================
All tests passed (8 assertions in 6 test cases)
```
[esp_rom]: Partially buildable for linux The following files have been ported: * esp_rom_crc.h * esp_rom_sys.h * esp_rom_efuse.h (mostly no-ops) * esp_rom_md5.h Integrated Linux-based rom implementation into log and NVS component. Added brief host tests for ROM to ensure basic consistency on Linux. Added ROM printf host unit tests. Temporarily added reset reason for Linux in ROM. 2021-06-02 23:59:00 -04:00			`\| Supported Targets \| Linux \|`
			`\| ----------------- \| ----- \|`

			`# Simplest rom test on Linux target`

			`This unit test tests only if some of the supplied Linux functions seem to work correctly. The test framework is CATCH.`

			`## Requirements`

			`* A Linux system`
			`* The usual IDF requirements for Linux system, as described in the [Getting Started Guides](../../../../docs/en/get-started/index.rst).`
			`* The host's gcc/g++`

			This application has been tested on Ubuntu 20.04 with `gcc` version 9.3.0.

			`## Build`

			First, make sure that the target is set to Linux. Run `idf.py --preview set-target linux` if you are not sure. Then do a normal IDF build: `idf.py build`.

			`## Run`

			`IDF monitor doesn't work yet for Linux. You have to run the app manually:`

			```bash
			`./build/test_rom_host.elf`
			```

			`## Example Output`

			`Ideally, all tests pass, which is indicated by "All tests passed" in the last line:`

			```bash
			`$ ./build/test_rom_host.elf`
			`test`
			`===============================================================================`
			`All tests passed (8 assertions in 6 test cases)`
			```