Python-10-Testing-your-program.rest

   1 **What is testing?**
   2
   3 Software testing is a process by which one or more expected behaviors and results from a piece of software are exercised and confirmed. Well chosen tests will confirm expected code behavior for the extreme boundaries of the input domains, output ranges, parametric combinations, and other behavioral edge cases.
   4
   5
   6 **Why test?**
   7
   8 Unless you write flawless, bug-free, perfectly accurate, fully precise, and predictable code every time, you must test your code in order to trust it enough to answer in the affirmative to at least a few of the following questions:
   9
  10 Does your code work?
  11
  12 Always?
  13
  14 Does it do what you think it does?
  15
  16 Does it continue to work after changes are made?
  17
  18 Does it continue to work after system configurations or libraries are upgraded?
  19
  20 Does it respond properly for a full range of input parameters?
  21
  22 What about edge or corner cases?
  23
  24 What’s the limit on that input parameter?
  25
  26
  27 **Verification**
  28
  29 Verification is the process of asking, “Have we built the software correctly?” That is, is the code bug free, precise, accurate, and repeatable?
  30
  31 **Validation**
  32
  33 Validation is the process of asking, “Have we built the right software?” That is, is the code designed in such a way as to produce the answers we’re interested in, data we want, etc.
  34
  35 Where are tests ?
  36 Say we have an averaging function:
  37
  38 ::
  39
  40   def mean(numlist):
  41      total = sum(numlist)
  42      length = len(numlist)
  43      return total/length
  44
  45 The test could be runtime exceptions in the function.
  46
  47 ::
  48
  49   def mean(numlist):
  50      try :
  51          total = sum(numlist)
  52          length = len(numlist)
  53      except ValueError :
  54          print "The number list was not a list of numbers."
  55      except :
  56          print "There was a problem evaluating the number list."
  57      return total/length
  58
  59
  60 Sometimes they’re alongside the function definitions they’re testing.
  61
  62 ::
  63
  64  def mean(numlist):
  65     try :
  66         total = sum(numlist)
  67         length = len(numlist)
  68     except ValueError :
  69         print "The number list was not a list of numbers."
  70     except :
  71         print "There was a problem evaluating the number list."
  72     return total/length
  73
  74  class TestClass:
  75     def test_mean(self):
  76         assert(mean([0,0,0,0])==0)
  77         assert(mean([0,200])==100)
  78         assert(mean([0,-200]) == -100)
  79         assert(mean([0]) == 0)
  80     def test_floating_mean(self):
  81         assert(mean([1,2])==1.5)
  82
  83 Sometimes they’re in an executable independent of the main executable.
  84
  85
  86 ::
  87
  88  def mean(numlist):
  89     try :
  90         total = sum(numlist)
  91         length = len(numlist)
  92     except ValueError :
  93         print "The number list was not a list of numbers."
  94     except :
  95         print "There was a problem evaluating the number list."
  96     return total/length
  97
  98 Where, in a different file exists a test module:
  99
 100
 101 ::
 102
 103   import mean
 104   class TestClass:
 105       def test_mean(self):
 106           assert(mean([0,0,0,0])==0)
 107           assert(mean([0,200])==100)
 108           assert(mean([0,-200]) == -100)
 109           assert(mean([0]) == 0)
 110       def test_floating_mean(self):
 111           assert(mean([1,2])==1.5)
 112
 113
 114 **When should we test?**
 115
 116 The short answer is all the time. The long answer is that testing either before or after your software is written will improve your code, but testing after your program is used for something important is too late.
 117
 118 If we have a robust set of tests, we can run them before adding something new and after adding something new. If the tests give the same results (as appropriate), we can have some assurance that we didn’t break anything. The same idea applies to making changes in your system configuration, updating support codes, etc.
 119
 120 Another important feature of testing is that it helps you remember what all the parts of your code do. If you are working on a large project over three years and you end up with 200 classes, it may be hard to remember what the widget class does in detail. If you have a test that checks all of the widget’s functionality, you can look at the test to remember what it’s supposed to do.
 121
 122 **Who tests?**
 123 In a collaborative coding environment, where many developers contribute to the same code, developers should be responsible individually for testing the functions they create and collectively for testing the code as a whole.
 124
 125 Professionals invariably test their code, and take pride in test coverage, the percent of their functions that they feel confident are comprehensively tested.
 126
 127 **How does one test?**
 128
 129 The type of tests you’ll write is determined by the testing framework you adopt.
 130
 131 **Types of Tests:**
 132 *Exceptions*
 133 Exceptions can be thought of as type of runttime test. They alert the user to exceptional behavior in the code. Often, exceptions are related to functions that depend on input that is unknown at compile time. Checks that occur within the code to handle exceptional behavior that results from this type of input are called Exceptions.
 134
 135 *Unit Tests*
 136
 137 Unit tests are a type of test which test the fundametal units a program’s functionality. Often, this is on the class or function level of detail.
 138
 139 To test functions and classes, we want to test the interfaces, rather than the implmentation. Treating the implementation as a ‘black box’, we can probe the expected behavior with boundary cases for the inputs.
 140
 141 In the case of our fix_missing function, we need to test the expected behavior by providing lines and files that do and do not have missing entries. We should also test the behavior for empty lines and files as well. These are boundary cases.
 142
 143 *System Tests*
 144
 145 System level tests are intended to test the code as a whole. As opposed to unit tests, system tests ask for the behavior as a whole. This sort of testing involves comparison with other validated codes, analytical solutions, etc.
 146
 147 *Regression Tests*
 148
 149 A regression test ensures that new code does change anything. If you change the default answer, for example, or add a new question, you’ll need to make sure that missing entries are still found and fixed.
 150
 151 *Integration Tests*
 152
 153 Integration tests query the ability of the code to integrate well with the system configuration and third party libraries and modules. This type of test is essential for codes that depend on libraries which might be updated independently of your code or when your code might be used by a number of users who may have various versions of libraries.
 154
 155 **Test Suites**
 156 Putting a series of unit tests into a suite creates, as you might imagine, a test suite.
 157
 158 **Elements of a Test**
 159
 160 **Behavior**
 161
 162 The behavior you want to test. For example, you might want to test the fun() function.
 163
 164 **Expected Result**
 165
 166 This might be a single number, a range of numbers, a new, fully defined object, a system state, an exception, etc.
 167
 168 When we run the fun function, we expect to generate some fun. If we don’t generate any fun, the fun() function should fail its test. Alternatively, if it does create some fun, the fun() function should pass this test.
 169
 170 **Assertions**
 171
 172 Require that some conditional be true. If the conditional is false, the test fails.
 173
 174 **Fixtures**
 175
 176 Sometimes you have to do some legwork to create the objects that are necessary to run one or many tests. These objects are called fixtures.
 177
 178 For example, since fun varies a lot between people, the fun() function is a member function of the Person class. In order to check the fun function, then, we need to create an appropriate Person object on which to run fun().
 179
 180 **Setup and teardown**
 181
 182 Creating fixtures is often done in a call to a setup function. Deleting them and other cleanup is done in a teardown function.
 183
 184 **The Big Picture**
 185 Putting all this together, the testing algorithm is often:
 186
 187 ::
 188
 189   setUp
 190   test
 191   tearDown
 192
 193
 194 But, sometimes it’s the case that your tests change the fixtures. If so, it’s better for the setup and teardown functions to occur on either side of each test. In that case, the testing algorithm should be:
 195
 196 ::
 197
 198   setUp
 199   test1
 200   tearDown
 201   setUp
 202   test2
 203   tearDown
 204   setUp
 205   test3
 206   tearDown
 207
 208 ----------------------------------------------------------
 209 Python Nose
 210 ----------------------------------------------------------
 211
 212 The testing framework we’ll discuss today is called nose, and comes packaged with the enthought python distribution that you’ve installed.
 213
 214 **Where is a nose test?**
 215
 216 Nose tests are files that begin with Test-, Test_, test-, or test_. Specifically, these satisfy the testMatch regular expression [Tt]est[-_]. (You can also teach nose to find tests by declaring them in the unittest.TestCase subclasses chat you create in your code. You can also create test functions which are not unittest.TestCase subclasses if they are named with the configured testMatch regular expression.)
 217
 218 Nose Test Syntax
 219 To write a nose test, we make assertions.
 220
 221 ::
 222
 223     assert (ShouldBeTrue())
 224     assert (not ShouldNotBeTrue())
 225
 226
 227 In addition to assertions, in many test frameworks, there are expectations, etc.
 228
 229 **Add a test to our work**
 230
 231 There are a few tests for the mean function that we listed in this lesson. What are some tests that should fail? Add at least three test cases to this set.
 232
 233 *Hint: think about what form your input could take and what you should do to handle it. Also, think about the type of the elements in the list. What should be done if you pass a list of integers? What if you pass a list of strings?*
 234
 235 **Test Driven Development**
 236
 237 Some people develop code by writing the tests first.
 238
 239 If you write your tests comprehensively enough, the expected behaviors that you define in your tests will be the necessary and sufficient set of behaviors your code must perform. Thus, if you write the tests first and program until the tests pass, you will have written exactly enough code to perform the behavior your want and no more. Furthermore, you will have been forced to write your code in a modular enough way to make testing easy now. This will translate into easier testing well into the future.