Skip to content

Commit

Permalink
Added test instructions for readme
Browse files Browse the repository at this point in the history
  • Loading branch information
andrecsilva committed Apr 25, 2024
1 parent 3da62b4 commit 8fcdd88
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,11 @@ Many of the APIs provided are meant to be drop-in replacements that either offer
To install this package from PyPI, use the following command:

`pip install security`

## Running tests

DO NOT RUN TESTS LOCALLY WITHOUT A VM/CONTAINER.

Tests will try to run "dangerous" commands (i.e. curl, netcat, etc.) and try to access sensitive files (i.e. sudoers, passwd, etc.). We do so to test the our abilities to detect and filter these types of attacks.

While all these commands are devised as innocuous, it is still not a good idea to risk exposure. They also require a specific environment to pass. We recommend using something like [act](https://github.com/nektos/act) to run the github workflow locally within a container for local development.

0 comments on commit 8fcdd88

Please sign in to comment.