Skip to content

TESTING.md

Latest commit

 

History

History
91 lines (60 loc) · 1.95 KB

TESTING.md

File metadata and controls

91 lines (60 loc) · 1.95 KB

Testing Fuzzy Bear

Overview

  • Ideally switch this to use pytest this is a temporary test engine

Setting Up A Test

  1. Open test_fuzzybear
  2. Add a new command line argument for your test
# ... #

parser.add_argument('-P', '--your-test',
                    dest = 'test-name',
                    action='store_true',
                    help = 'what is your test for'
                    )


## Add command line args for your test ^
  1. Define a function for your test
########################## :: [DEFINE TESTS] :: ##########################

# test desc
def test_name():
    TEST_DIR = './tests/'
    TEST_FILE = f'{TEST_DIR}/target-bins/<binary>'
    TEST_SAMPLE = f'{TEST_DIR}/target-ins/<codec>'

    print(f"""
        [>>] Running test against {TEST_FILE.split('/')[-1]} with {TEST_SAMPLE.split('/')[-1]}
    """)

    # >-> test body <-<
  1. Import any required files
## <name> Test ##
from fuzzybear.<subdir> import <file/class>

## ADD TEST IMPORT ## ^
  1. Use it in your test body like
# >-> test body <-<
csv_worker = CSV.CSV(TEST_FILE)

Running A Test

./test_fuzzybear -h



          ____    _____ _____ ____ _____   _____ _   _ ____________   __
          \ \ \  |_   _| ____/ ___|_   _| |  ___| | | |__  /__  /\ \ / /
           \ \ \   | | |  _| \___ \ | |   | |_  | | | | / /  / /  \ V /
           / / /   | | | |___ ___) || |   |  _| | |_| |/ /_ / /_   | |
          /_/_/    |_| |_____|____/ |_|   |_|    \___//____/____|  |_|

          ____  _____    _    ____
         | __ )| ____|  / \  |  _ \
         |  _ \|  _|   / _ \ | |_) |
         | |_) | |___ / ___ \|  _ <
         |____/|_____/_/   \_\_| \_

usage: test_fuzzybear [-h] [-H] [-CSV]

optional arguments:
  -h, --help         show this help message and exit
  -H, --harness      test harness
  -CSV, --CSV-codec  test the csv codec binaries
  • To run the CSV test for example
    • ./test_fuzzybear -CSV