Skip to content

Commit 3f00213

Browse files
committed
Added tests section in pyintelowl
Signed-off-by: aryan <[email protected]>
1 parent 3e27e5d commit 3f00213

File tree

4 files changed

+50
-5
lines changed

4 files changed

+50
-5
lines changed

docs/GreedyBear/Introduction.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ The project goal is to extract data of the attacks detected by a [TPOT](https://
1010

1111
There are public feeds provided by The Honeynet Project in this site: greedybear.honeynet.org. [Example](https://greedybear.honeynet.org/api/feeds/log4j/all/recent.txt)
1212

13-
To check all the available feeds, Please refer to our [usage guide](https://greedybear.readthedocs.io/en/latest/Usage.html)
13+
To check all the available feeds, Please refer to our [usage guide](https://intelowlproject.github.io/docs/GreedyBear/Usage/)
1414

1515
Please do not perform too many requests to extract feeds or you will be banned.
1616

docs/IntelOwl/installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -212,7 +212,7 @@ There are 3 options to execute the web server:
212212

213213
Then you should call the `./start` script with the parameter `--https` to leverage the right Docker Compose file for HTTPS.
214214

215-
Plus, if you use [Flower](https://intelowlproject.github.io/docs/IntelOwl//advanced_configuration/#queue-customization), you should change in the `docker/flower.override.yml` the `flower_http.conf` with `flower_https.conf`.
215+
Plus, if you use [Flower](https://intelowlproject.github.io/docs/IntelOwl/advanced_configuration/#queue-customization), you should change in the `docker/flower.override.yml` the `flower_http.conf` with `flower_https.conf`.
216216

217217
- **HTTPS with Let's Encrypt**
218218

docs/pyintelowl/Tests.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
Tests
2+
======================================
3+
4+
Configuration
5+
--------------------------------------
6+
7+
Some tests require file samples, which can be found in the encrypted folder ``tests/test_files.zip`` (password: "infected").
8+
Unzip the archive in ``tests/test_files`` folder before running the tests.
9+
10+
**Please remember that these are dangerous malware! They come encrypted and locked for a reason!
11+
Do NOT run them unless you are absolutely sure of what you are doing!
12+
They are to be used only for launching specific tests that require them** (``__send_analysis_request``)
13+
14+
* With the following constants in ``__init__.py``, you can customize your tests:
15+
16+
* **MOCKING_CONNECTIONS:** Mock connections to external API to test functions without a real connection or a valid API Key.
17+
18+
* If you prefer to use custom inputs for tests, you can change the following constants:
19+
20+
* **TEST_JOB_ID**
21+
* **TEST_HASH**
22+
* **TEST_URL**
23+
* **TEST_IP**
24+
* **TEST_DOMAIN**
25+
* **TEST_GENERIC**
26+
* **TEST_FILE**
27+
* **TEST_FILE_HASH**
28+
29+
Launch Tests
30+
-------------------------------------
31+
32+
* The test requirements are specified in the ``test-requirements.txt`` file. Install them using,
33+
34+
.. code-block:: bash
35+
36+
$ pip3 install -r test-requirements.txt
37+
38+
* Launch the tests using ``tox``:
39+
40+
.. code-block:: bash
41+
42+
$ tox

mkdocs.yml

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,12 @@ nav:
2626
- API docs: "GreedyBear/Api-docs.md"
2727
- PyIntelOwl:
2828
- Quickstart: "pyintelowl/index.md"
29-
- Modules:
30-
- IntelOwlClass: "pyintelowl/IntelOwlClass.md"
31-
- IntelOwlClientException: "pyintelowl/IntelOwlClientException.md"
29+
- Usage:
30+
- Modules:
31+
- IntelOwlClass: "pyintelowl/IntelOwlClass.md"
32+
- IntelOwlClientException: "pyintelowl/IntelOwlClientException.md"
33+
- Development:
34+
- Tests: "pyintelowl/Tests.md"
3235
- GoIntelOwl:
3336
- index: "GoIntelOwl/index.md"
3437
- Guides:

0 commit comments

Comments
 (0)