Skip to main content

A Python unit testing library

Project description

Pest Control

A Python Unit Testing Library

Usage

Test Functions:

  • assertEquals(actual, expected, msg) - Test if actual = expected, if test fails, print out includes msg
  • assertTrue(actual, msg) - Test if actual = True, if test fails, print out includes msg
  • assertFalse(actual, msg) - Test if actual = False, if test fails, print out includes msg

How to

Start by importing the library. Assuming file is in same directory as the PestControl library directory: for example for the test script "basic_test.py", use the following folder structure for this example:

/
|- pestcontrol/
|	- pest_control.py
|- basic_test.py
import pestcontrol

Then make a class that extends PestCase to be the unit test class (class name can be anything, "BasicTestCase" is used here)

class BasicTestCase(pestcontrol.PestCase):

Then write one or more functions for the actual test. NOTE: "test" MUST be somewhere in the function name. For example, add_test(), addTest(), addTesting(), add_Tester(), add_tester(), will all run, but add(), will not run.

class BasicTestCase(PestCase):
    def add_test(self):
        self.assertEquals(1+1, 2, "simple add test")

Now just add the main() funciton call

if __name__ == "__main__":
    BasicTestCase().main()

That's it! Your unit test will run and print to the console the results. Note: any errors that occur from a call to an assert function, ie errors caused by the code being tested, will be caught and logged as a failed test (divide by zero error for example).

Full Example:

import pestcontrol
class BasicTestCase(pestcontrol.PestCase):
    def add_test(self):
        self.assertEquals(1+1, 2, "simple add test")

if __name__ == "__main__":
    BasicTestCase().main()

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pestcontrol-1.0.5.tar.gz (3.9 kB view hashes)

Uploaded Source

Built Distribution

pestcontrol-1.0.5-py3-none-any.whl (4.5 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page