Skip to content

Commit

Permalink
artifacts check tool: update readme file (#293)
Browse files Browse the repository at this point in the history
  • Loading branch information
RoyBenMoshe authored and udi-speedb committed Dec 3, 2023
1 parent 44f9b14 commit c176363
Showing 1 changed file with 19 additions and 2 deletions.
21 changes: 19 additions & 2 deletions tools/artifacts_check/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,28 @@

As part of our release process, we need to test the .a and .so artifacts. our QA tools (unit, stress, and fuzz tests) are all testing the source code and compiling it to be tested. Those tools are unable to test either static or dynamic artifacts.
We would like to create primary testing tools, able to import .a / .so artifact, verify compilation, and no corruption.

## Overview

Sanity check for .a / .so artifact.

## Usage
make check_shared / make check_static while the artifact is in speedb folder.

### Building the test

### make commands
make clean - clean check_shared/check_static binaries from current dir.
make check_shared - for shared lib
make check static - for static lib

An example command to build the test:
```shell
cd speedb/tools/artifacts_check
make check_static
```
### Running the test

```shell
cd speedb/tools/artifacts_check
./check_shared
```

0 comments on commit c176363

Please sign in to comment.