p34709852
/
monkey
forked from p15670423/monkey
1
0
Fork 1
Code Issues Pull Requests Projects Releases Wiki Activity
monkey/envs/monkey_zoo/blackbox
History
Ilija Lazoroski cf0da5dc7d BB: Change internet services default config. 2021-07-30 06:17:46 -04:00
..
analyzers zoo: Remove unused import from zerologon_analyzer.py 2021-04-07 13:51:47 -04:00
config_templates BB: Change internet services default config. 2021-07-30 06:17:46 -04:00
island_client BB tests: added the ability for BB tests to "register". If they need registration to run monkeys, BB tests selects passwordless option 2021-05-20 16:47:00 +03:00
log_handlers Reformat all python with black v20.8b1 2021-04-06 09:20:18 -04:00
tests zoo: resolve E501 flake8 warnings in monkey zoo 2021-04-07 13:47:50 -04:00
utils Reverted back to fetching file directory first when resolving GCP keys. This is to make gcp key file relative to utils directory, not the current file. This will make it less confusing, because people usually navigate directories, not files. 2021-05-12 16:58:46 +03:00
README.md Update envs/monkey_zoo/blackbox/README.md 2021-05-17 14:39:30 +03:00
__init__.py Basic skeleton for blackbox script 2019-08-27 15:52:39 +03:00
conftest.py Changed --no-performance-tests to --run-performance-tests for convenience (skipping performance tests by default) and documented changes in CHANGELOG.md 2021-04-30 09:41:20 +03:00
pytest.ini Added module + filename + line number to logs output in Blackbox 2019-10-07 13:49:13 +03:00
test_blackbox.py Improve exception message, thrown when trying to establish connection to island in BB tests 2021-05-21 08:41:28 +03:00

README.md

Automatic blackbox tests

Prerequisites

  1. Download google sdk: https://cloud.google.com/sdk/docs/
  2. Download service account key for MonkeyZoo project (if you deployed MonkeyZoo via terraform scripts then you already have it). GCP console -> IAM -> service accounts(you can use the same key used to authenticate terraform scripts). Place the key in envs/monkey_zoo/gcp_keys/gcp_key.json.
  3. Deploy the relevant branch + complied executables to the Island machine on GCP.

Running the tests

In order to execute the entire test suite, you must know the external IP of the Island machine on GCP. You can find this information in the GCP Console Compute Engine/VM Instances under External IP.

Running in command line

Either run pytest from /monkey directory or set PYTHONPATH environment variable to /monkey directory so that blackbox tests can import other monkey code. Blackbox tests have following parameters:

  • --island=IP Sets island's IP
  • --no-gcp (Optional) Use for no interaction with the cloud (local test).
  • --quick-performance-tests (Optional) If enabled performance tests won't reset island and won't send telemetries, instead will just test performance of endpoints in already present island state.

Example run command:

monkey\monkey>python -m pytest -s --island=35.207.152.72:5000 ..\envs\monkey_zoo\blackbox\test_blackbox.py

Running in PyCharm

Configure a PyTest configuration with the additional arguments -s --island=35.207.152.72:5000, and to run from directory monkey\envs\monkey_zoo\blackbox.

Running telemetry performance test

Before running performance test make sure browser is not sending requests to island!

To run telemetry performance test follow these steps: 0. Set server_config.json to "standard" (no password protection) setting.

  1. Gather monkey telemetries.
    1. Enable "Export monkey telemetries" in Configuration -> Internal -> Tests if you don't have exported telemetries already.
    2. Run monkey and wait until infection is done.
    3. All telemetries are gathered in monkey/telem_sample
  2. Run telemetry performance test.
    1. Move directory monkey/test_telems to envs/monkey_zoo/blackbox/tests/performance/test_telems
    2. (Optional) Use envs/monkey_zoo/blackbox/tests/performance/utils/telem_parser.py to multiply telemetries gathered.
      1. Run telem_parser.py script with working directory set to monkey\envs\monkey_zoo\blackbox
      2. Pass integer to indicate the multiplier. For example running telem_parser.py 4 will replicate telemetries 4 times.
      3. If you're using pycharm check "Emulate terminal in output console" on debug/run configuraion.
    3. Performance test will run as part of BlackBox tests or you can run it separately by adding -k 'test_telem_performance' option.