Difference between revisions of "Branch Coverage Cheat Sheet"
m (→Switch Statements) |
m (→Markers/Colors) |
||
| (18 intermediate revisions by the same user not shown) | |||
| Line 9: | Line 9: | ||
=== Markers/Colors === | === Markers/Colors === | ||
| − | A source line with no line count (no color / no marker) is either a line with no object code and can be ignored | + | A source line with no line count (no color / no marker) is either a line with no object code and can be ignored or it is part of a subprogram for which coverage was not requested. |
| − | [[file:BCCS_1.jpeg| | + | [[file:BCCS_1.jpeg|1200px]] |
A source line with a positive line count (no marker / green color) is OK (has been executed). | A source line with a positive line count (no marker / green color) is OK (has been executed). | ||
| − | [[file:BCCS_2.jpeg| | + | [[file:BCCS_2.jpeg|1200px]] |
A source line with a zero line count (+ marker / yellow color) needs attention (has not been executed). | A source line with a zero line count (+ marker / yellow color) needs attention (has not been executed). | ||
| − | [[file:BCCS_3.jpeg| | + | [[file:BCCS_3.jpeg|1200px]] |
A source line with a zero line count (* marker / red color) needs attention (has not been instrumented). | A source line with a zero line count (* marker / red color) needs attention (has not been instrumented). | ||
| − | [[file:BCCS_4.jpeg| | + | [[file:BCCS_4.jpeg|1200px]] |
A branch with positive count (green color) is OK (has been executed). | A branch with positive count (green color) is OK (has been executed). | ||
| − | [[file:BCCS_5.jpeg| | + | [[file:BCCS_5.jpeg|1200px]] |
A branch with a zero count (+ marker / yellow color) need attention (has not been executed). | A branch with a zero count (+ marker / yellow color) need attention (has not been executed). | ||
| − | [[file:BCCS_6.jpeg| | + | [[file:BCCS_6.jpeg|1200px]] |
A branch with a zero count (+ marker / red color) need attention (has not been instrumented). | A branch with a zero count (+ marker / red color) need attention (has not been instrumented). | ||
| − | [[file:BCCS_7.jpeg| | + | [[file:BCCS_7.jpeg|1200px]] |
=== Multiple Branches Per Line === | === Multiple Branches Per Line === | ||
| Line 41: | Line 41: | ||
Lines with multiple branches may be easier to work with if the source code is modified to put one decision per line. | Lines with multiple branches may be easier to work with if the source code is modified to put one decision per line. | ||
| − | [[file:BCCS_8.jpeg| | + | [[file:BCCS_8.jpeg|1200px]] |
versus | versus | ||
| − | [[file:BCCS_9.jpeg| | + | [[file:BCCS_9.jpeg|1200px]] |
== C/x86 == | == C/x86 == | ||
| Line 59: | Line 59: | ||
In a for loop, the index bounds test is completed at the top of the loop. If the branch associated with the for loop in not taken, then the body of the loop will not have been executed (line counts should be 0). | In a for loop, the index bounds test is completed at the top of the loop. If the branch associated with the for loop in not taken, then the body of the loop will not have been executed (line counts should be 0). | ||
| − | [[file:BCCS_10.jpeg| | + | [[file:BCCS_10.jpeg|1200px]] |
In a for loop, the index bounds test is completed at the top of the loop. The line count of the for loop should be greater than the branch count of the for loop because the final bounds check will fail and not branch back to the loop body. | In a for loop, the index bounds test is completed at the top of the loop. The line count of the for loop should be greater than the branch count of the for loop because the final bounds check will fail and not branch back to the loop body. | ||
| − | [[file:BCCS_11.jpeg| | + | [[file:BCCS_11.jpeg|1200px]] |
In a while loop, the while test is completed at the top of the loop. If the branch associated with the while loop in not taken, then the body of the loop will not have been executed (line counts should be 0). | In a while loop, the while test is completed at the top of the loop. If the branch associated with the while loop in not taken, then the body of the loop will not have been executed (line counts should be 0). | ||
| − | [[file:BCCS_12.jpeg| | + | [[file:BCCS_12.jpeg|1200px]] |
In a while loop, the while test is completed at the bottom of the loop. The line count of the while loop should be greater than the branch count of the for loop because the final while test will fail and not branch back to the loop body. | In a while loop, the while test is completed at the bottom of the loop. The line count of the while loop should be greater than the branch count of the for loop because the final while test will fail and not branch back to the loop body. | ||
| − | [[file:BCCS_13.jpeg| | + | [[file:BCCS_13.jpeg|1200px]] |
In a do-while loop, the while test is completed at the bottom of the loop. The line count of the do-while loop should be greater than the branch count of the for loop because the final while test will fail and not branch back to the loop body. | In a do-while loop, the while test is completed at the bottom of the loop. The line count of the do-while loop should be greater than the branch count of the for loop because the final while test will fail and not branch back to the loop body. | ||
| − | [[file:BCCS_14.jpeg| | + | [[file:BCCS_14.jpeg|1200px]] |
=== Conditional Operator (?) === | === Conditional Operator (?) === | ||
| Line 83: | Line 83: | ||
Conditional operators on a single line will include a branch to the same line which is for the FALSE condition. If the branch is not taken then the TRUE conditional has not been executed. If the branch is executed fewer times than the line count then both conditions have been executed. | Conditional operators on a single line will include a branch to the same line which is for the FALSE condition. If the branch is not taken then the TRUE conditional has not been executed. If the branch is executed fewer times than the line count then both conditions have been executed. | ||
| − | [[file:BCCS_15.jpeg| | + | [[file:BCCS_15.jpeg|1200px]] |
Conditional operator expressions spanning multiple source lines allow for easier (not easy) determination of decisions tested. | Conditional operator expressions spanning multiple source lines allow for easier (not easy) determination of decisions tested. | ||
| − | [[file:BCCS_16.jpeg| | + | [[file:BCCS_16.jpeg|1200px]] |
versus | versus | ||
| − | [[file:BCCS_17.jpeg| | + | [[file:BCCS_17.jpeg|1200px]] |
=== Switch Statements === | === Switch Statements === | ||
| Line 97: | Line 97: | ||
Switch statements with a default case will have a single branch to the default case and use a jump table for the rest. Line counts will indicate which cases have been executed. | Switch statements with a default case will have a single branch to the default case and use a jump table for the rest. Line counts will indicate which cases have been executed. | ||
| − | [[file:BCCS_18.jpeg| | + | [[file:BCCS_18.jpeg|1200px]] |
Switch statements without a default will have branches for each case. Line counts will indicate which cases have been executed. There will also be a branch to the same line as the switch expression (which represents the default case) which is executed when no explicit cases are executed. | Switch statements without a default will have branches for each case. Line counts will indicate which cases have been executed. There will also be a branch to the same line as the switch expression (which represents the default case) which is executed when no explicit cases are executed. | ||
| − | [[file:BCCS_19.jpeg| | + | [[file:BCCS_19.jpeg|1200px]] |
Switch statements with null or no statements will have branches to the next statement following the switch statement. If the switch statement is at the end of a loop, the next statement may be the loop condition test, whose source line number may/will be at the top of the loop. | Switch statements with null or no statements will have branches to the next statement following the switch statement. If the switch statement is at the end of a loop, the next statement may be the loop condition test, whose source line number may/will be at the top of the loop. | ||
| − | [[file:BCCS_20.jpeg| | + | [[file:BCCS_20.jpeg|1200px]] |
=== If Statements === | === If Statements === | ||
| − | + | If statements will include (at least) one branch for the condition of each leg. If the branch count is not the same as the line count then both paths of the decision have been tested. | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | + | [[file:BCCS_21.jpeg|1200px]] | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
If statements with null/empty legs...TBD | If statements with null/empty legs...TBD | ||
| − | + | [[file:BCCS_21a.jpeg|1200px]] | |
| − | |||
| − | |||
| − | |||
If statement conditions with multiple boolean operators will have one branch associated with the whole condition. If the boolean operands are spread on separate source lines they will all have the same line count. (See short circuit operators.) | If statement conditions with multiple boolean operators will have one branch associated with the whole condition. If the boolean operands are spread on separate source lines they will all have the same line count. (See short circuit operators.) | ||
| − | + | [[file:BCCS_22.jpeg|1200px]] | |
| − | |||
| − | |||
If statement conditions with short circuit operators will have one branch for each operand of the short circuit operator. If a branch has a count of 0 then that path has not been executed. If the boolean operands are spread on separate source lines they will have separate line counts which will indicate if each operand was executed. | If statement conditions with short circuit operators will have one branch for each operand of the short circuit operator. If a branch has a count of 0 then that path has not been executed. If the boolean operands are spread on separate source lines they will have separate line counts which will indicate if each operand was executed. | ||
| − | + | [[file:BCCS_23.jpeg|1200px]] | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
== GNAT Ada/x86 == | == GNAT Ada/x86 == | ||
| Line 192: | Line 131: | ||
Straight-line code will often include exception checks for ranges and bounds. If straight-line code contains branches to the same line then these are exception checks. If the branch counts are the same as the line counts then the exception checks passed and an exception was not raised. | Straight-line code will often include exception checks for ranges and bounds. If straight-line code contains branches to the same line then these are exception checks. If the branch counts are the same as the line counts then the exception checks passed and an exception was not raised. | ||
| − | + | [[file:BCCS_24.jpeg|1200px]] | |
| − | |||
=== Loops === | === Loops === | ||
| Line 199: | Line 137: | ||
All for loops will include a branch for the loop range check at the top. The normal loop range check should have a line count greater than the line count of the body statements to indicate the loop reached completion and the branch count should be non-zero to indicate the exit was taken. Testing for 0, 1, and multiple loop executions should be achieved with separate test runs. | All for loops will include a branch for the loop range check at the top. The normal loop range check should have a line count greater than the line count of the body statements to indicate the loop reached completion and the branch count should be non-zero to indicate the exit was taken. Testing for 0, 1, and multiple loop executions should be achieved with separate test runs. | ||
| − | + | [[file:BCCS_25.jpeg|1200px]] | |
For loops with dynamic bounds will test for a null loop range at the top of the loop and contain a branch to the next statement which is taken when the loop range is null. | For loops with dynamic bounds will test for a null loop range at the top of the loop and contain a branch to the next statement which is taken when the loop range is null. | ||
| − | + | [[file:BCCS_26.jpeg|1200px]] | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
While loops will test loop exit condition at the top of the loop and contain a branch to the next statement which is taken when the loop exit is taken. The loop exit condition should have a line count greater than the line count of the body statements to indicate the loop reached completion. Using short circuits operators in the loop exit condition will increase the number of branches, and each should be executed for complete coverage. Testing for 0, 1, and multiple loop executions should be achieved with separate test runs. | While loops will test loop exit condition at the top of the loop and contain a branch to the next statement which is taken when the loop exit is taken. The loop exit condition should have a line count greater than the line count of the body statements to indicate the loop reached completion. Using short circuits operators in the loop exit condition will increase the number of branches, and each should be executed for complete coverage. Testing for 0, 1, and multiple loop executions should be achieved with separate test runs. | ||
| − | + | [[file:BCCS_27.jpeg|1200px]] | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
=== Exit Statements === | === Exit Statements === | ||
| − | |||
| − | |||
Loop exit statements will include a branch which is taken when the exit is taken. The branch count should be less than the line count to indicate that both paths of the decision are taken. Using short circuits operators in the loop exit condition will increase the number of branches, and each should be executed for complete coverage. | Loop exit statements will include a branch which is taken when the exit is taken. The branch count should be less than the line count to indicate that both paths of the decision are taken. Using short circuits operators in the loop exit condition will increase the number of branches, and each should be executed for complete coverage. | ||
| − | + | [[file:BCCS_28.jpeg|1200px]] | |
| − | |||
| − | |||
=== Case Statements === | === Case Statements === | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
Case statements will have a single branch at the top to handle the others case. Coverage of the when alternatives can be confirmed by line counts. | Case statements will have a single branch at the top to handle the others case. Coverage of the when alternatives can be confirmed by line counts. | ||
| − | + | [[file:BCCS_29.jpeg|1200px]] | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
=== If Statements === | === If Statements === | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
If statements will include (at least) one branch for the condition of each leg. If the branch count is greater than zero but less than the line count then both paths of the decision have been tested. | If statements will include (at least) one branch for the condition of each leg. If the branch count is greater than zero but less than the line count then both paths of the decision have been tested. | ||
| − | + | [[file:BCCS_30.jpeg|1200px]] | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
If statements conditions with multiple boolean operators will have one branch associated with the whole condition. If the boolean operands are spread on separate source lines they will all have the same line count. (See short circuit operators.) | If statements conditions with multiple boolean operators will have one branch associated with the whole condition. If the boolean operands are spread on separate source lines they will all have the same line count. (See short circuit operators.) | ||
| − | + | [[file:BCCS_31.jpeg|1200px]] | |
| − | |||
If statement conditions with short circuit operators will have one branch for each operand of the short circuit operator. If a branch has a count of 0 then that path has not been executed. If the boolean operands are spread on separate source lines they will have separate line counts which will indicate if each operand was executed. | If statement conditions with short circuit operators will have one branch for each operand of the short circuit operator. If a branch has a count of 0 then that path has not been executed. If the boolean operands are spread on separate source lines they will have separate line counts which will indicate if each operand was executed. | ||
| − | + | [[file:BCCS_32.jpeg|1200px]] | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
== XLC/PPC == | == XLC/PPC == | ||
| Line 322: | Line 185: | ||
In a for loop, an index bounds test is completed at the top and bottom of the loop. The branches generated for those tests are associated with the first line of | In a for loop, an index bounds test is completed at the top and bottom of the loop. The branches generated for those tests are associated with the first line of | ||
the loop, and the first is from the top of the loop and the second is from the bottom of the loop. test, the loop body was not executed (the difference of the counts). | the loop, and the first is from the top of the loop and the second is from the bottom of the loop. test, the loop body was not executed (the difference of the counts). | ||
| − | If the first branch count is less than the line count of the loop | + | If the first branch count is less than the line count of the loop test, the loop body was not executed (the difference of the counts). |
| − | + | [[file:BCCS_33.jpeg|1200px]] | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
In a while loop, an loop exit test is completed at the top and bottom of the loop. The branches generated for those tests are associated with the first line of | In a while loop, an loop exit test is completed at the top and bottom of the loop. The branches generated for those tests are associated with the first line of | ||
the loop, and the first is from the top of the loop and the second is from the bottom of the loop. test, the loop body was not executed (the difference of the counts). | the loop, and the first is from the top of the loop and the second is from the bottom of the loop. test, the loop body was not executed (the difference of the counts). | ||
| − | + | [[file:BCCS_34.jpeg|1200px]] | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
In a do-while loop, an loop exit test is completed at the bottom of the loop. The branch generated for that test is associated with the last line of the loop. The loop body will have been executed one more time then the branch count, as confirmed by loop body line counts. | In a do-while loop, an loop exit test is completed at the bottom of the loop. The branch generated for that test is associated with the last line of the loop. The loop body will have been executed one more time then the branch count, as confirmed by loop body line counts. | ||
| − | + | [[file:BCCS_35.jpeg|1200px]] | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
=== Conditional Operator (?) === | === Conditional Operator (?) === | ||
| Line 371: | Line 202: | ||
Conditional operator expressions will generate one branch for each conditional operator (?). Conditional operators on a single line will include a branch to the same line which is for the FALSE condition. If the branch is not taken then the TRUE conditional has not been executed. If the branch is executed fewer times than the line count then both conditions have been executed. | Conditional operator expressions will generate one branch for each conditional operator (?). Conditional operators on a single line will include a branch to the same line which is for the FALSE condition. If the branch is not taken then the TRUE conditional has not been executed. If the branch is executed fewer times than the line count then both conditions have been executed. | ||
| − | + | [[file:BCCS_36.jpeg|1200px]] | |
Conditional operator expressions spanning multiple source lines allow for easier (not easy) determination of decisions tested. | Conditional operator expressions spanning multiple source lines allow for easier (not easy) determination of decisions tested. | ||
| − | + | [[file:BCCS_37.jpeg|1200px]] | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | + | === Switch Statements === | |
| − | + | Switch statements with a default case will have a single branch to the default case which shows up as a branch to the top of the switch statement. (This is a conditional branch to an unconditional branch to the default case.) Line counts will indicate which cases have been executed. | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | + | [[file:BCCS_38.jpeg|1200px]] | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
Switch statements without a default will have branches for each case. Line counts will indicate which cases have been executed. | Switch statements without a default will have branches for each case. Line counts will indicate which cases have been executed. | ||
| − | + | [[file:BCCS_39.jpeg|1200px]] | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
Switch statements with null or no statements will not have branches to those cases. For multiple cases with the same statements, each case will have a branch to the same source line. | Switch statements with null or no statements will not have branches to those cases. For multiple cases with the same statements, each case will have a branch to the same source line. | ||
| − | + | [[file:BCCS_40.jpeg|1200px]] | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | If Statements | + | === If Statements === |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
If statements will include (at least) one branch for the condition of each leg. If the branch count is not the same as the line count then both paths of the decision have been tested. | If statements will include (at least) one branch for the condition of each leg. If the branch count is not the same as the line count then both paths of the decision have been tested. | ||
| − | + | [[file:BCCS_41.jpeg|1200px]] | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
If statements with null/empty legs...TBD | If statements with null/empty legs...TBD | ||
| − | + | [[file:BCCS_42.jpeg|1200px]] | |
| − | : | ||
| − | |||
If statement conditions with multiple boolean operators will have one branch associated with the whole condition. If the boolean operands are spread on separate source lines they will all have the same line count. (See short circuit operators.) | If statement conditions with multiple boolean operators will have one branch associated with the whole condition. If the boolean operands are spread on separate source lines they will all have the same line count. (See short circuit operators.) | ||
| − | + | [[file:BCCS_43.jpeg|1200px]] | |
| − | |||
| − | |||
If statement conditions with short circuit operators will have one branch for each operand of the short circuit operator. If a branch has a count of 0 then that path has not been executed. If the boolean operands are spread on separate source lines they will have separate line counts which will indicate if each operand was executed. | If statement conditions with short circuit operators will have one branch for each operand of the short circuit operator. If a branch has a count of 0 then that path has not been executed. If the boolean operands are spread on separate source lines they will have separate line counts which will indicate if each operand was executed. | ||
| − | + | [[file:BCCS_44.jpeg|1200px]] | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
== PowerAda/PPC == | == PowerAda/PPC == | ||
| Line 547: | Line 248: | ||
Straight-line code will often include exception checks for ranges and bounds. If straight-line code contains branches to the end of a subprogram then these are exception checks. Branch counts will indicate how many time the exception was raised. | Straight-line code will often include exception checks for ranges and bounds. If straight-line code contains branches to the end of a subprogram then these are exception checks. Branch counts will indicate how many time the exception was raised. | ||
| − | + | [[file:BCCS_45.jpeg|1200px]] | |
=== Loops === | === Loops === | ||
| Line 553: | Line 254: | ||
All for loops will include a branch for the loop range check at the bottom. The normal loop range check should have a branch count less than the line count of the body statements to indicate the loop reached completion. Testing for 0, 1, and multiple loop executions should be achieved with separate test runs. | All for loops will include a branch for the loop range check at the bottom. The normal loop range check should have a branch count less than the line count of the body statements to indicate the loop reached completion. Testing for 0, 1, and multiple loop executions should be achieved with separate test runs. | ||
| − | + | [[file:BCCS_46.jpeg|1200px]] | |
For loops with dynamic bounds will test for a null loop range at the top of the loop and contain a branch to the next statement which is taken when the loop range is null. | For loops with dynamic bounds will test for a null loop range at the top of the loop and contain a branch to the next statement which is taken when the loop range is null. | ||
| − | + | [[file:BCCS_47.jpeg|1200px]] | |
| − | |||
While loops will test the loop exit condition at the top of the loop and contain a branch to the next statement which is taken when the loop exit is taken. While loops will test the loop exit condition at the bottom of the loop too and contain a branch to the top of the loop which is taken when the loop continues. The loop exit condition should have a line count greater than the line count of the body statements to indicate the loop reached completion. Using short circuits operators in the loop exit condition will increase the number of branches, and each should be executed for complete coverage. Testing for 0, 1, and multiple loop executions should be achieved with separate test runs. | While loops will test the loop exit condition at the top of the loop and contain a branch to the next statement which is taken when the loop exit is taken. While loops will test the loop exit condition at the bottom of the loop too and contain a branch to the top of the loop which is taken when the loop continues. The loop exit condition should have a line count greater than the line count of the body statements to indicate the loop reached completion. Using short circuits operators in the loop exit condition will increase the number of branches, and each should be executed for complete coverage. Testing for 0, 1, and multiple loop executions should be achieved with separate test runs. | ||
| − | + | [[file:BCCS_48.jpeg|1200px]] | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
=== Exit Statements === | === Exit Statements === | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
Loop exit statements will include a branch which is taken when the exit is taken. The branch count should be less than the line count to indicate that both paths of the decision are taken. Using short circuits operators in the loop exit condition will increase the number of branches, and each should be executed for complete coverage. | Loop exit statements will include a branch which is taken when the exit is taken. The branch count should be less than the line count to indicate that both paths of the decision are taken. Using short circuits operators in the loop exit condition will increase the number of branches, and each should be executed for complete coverage. | ||
| − | + | [[file:BCCS_49.jpeg|1200px]] | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
=== Case Statements === | === Case Statements === | ||
| Line 614: | Line 274: | ||
Case statements will have a branch for each alternative listed. The others alternative will have branches associated with values not handled by the specified alternatives, including values below the range, above the range, and values in between. Coverage of the when alternatives can be confirmed by line counts. Coverage of out of bound values can be confirmed by the branch counts. | Case statements will have a branch for each alternative listed. The others alternative will have branches associated with values not handled by the specified alternatives, including values below the range, above the range, and values in between. Coverage of the when alternatives can be confirmed by line counts. Coverage of out of bound values can be confirmed by the branch counts. | ||
| − | + | [[file:BCCS_50.jpeg|1200px]] | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
=== If Statements === | === If Statements === | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
If statements will include (at least) one branch for the condition of each leg. If the branch count is greater than zero but less than the line count then both paths of the decision have been tested. | If statements will include (at least) one branch for the condition of each leg. If the branch count is greater than zero but less than the line count then both paths of the decision have been tested. | ||
| − | + | [[file:BCCS_51.jpeg|1200px]] | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
If statements conditions with multiple boolean operators will have one branch associated with the whole condition. If the boolean operands are spread on separate source lines they will all have the same line count. (See short circuit operators.) | If statements conditions with multiple boolean operators will have one branch associated with the whole condition. If the boolean operands are spread on separate source lines they will all have the same line count. (See short circuit operators.) | ||
| − | + | [[file:BCCS_52.jpeg|1200px]] | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
If statement conditions with short circuit operators will have one branch for each operand of the short circuit operator. If a branch has a count of 0 then that path has not been executed. If the boolean operands are spread on separate source lines they will have separate line counts which will indicate if each operand was executed. | If statement conditions with short circuit operators will have one branch for each operand of the short circuit operator. If a branch has a count of 0 then that path has not been executed. If the boolean operands are spread on separate source lines they will have separate line counts which will indicate if each operand was executed. | ||
| − | + | [[file:BCCS_53.jpeg|1200px]] | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
Latest revision as of 22:22, 16 July 2018
Contents
Branch Coverage Cheat Sheet
This document provides information about interpreting the Branch Coverage Reports produced from data collected by the predefined probes coverage,ual (and brcov.ual) and the tool abrmerge. There are sections providing general guidance and sections for target-specific and compiler-specific guidance.
General Guidance
This section provides guidance applicable to all target ins compilers.
Markers/Colors
A source line with no line count (no color / no marker) is either a line with no object code and can be ignored or it is part of a subprogram for which coverage was not requested.
A source line with a positive line count (no marker / green color) is OK (has been executed).
A source line with a zero line count (+ marker / yellow color) needs attention (has not been executed).
A source line with a zero line count (* marker / red color) needs attention (has not been instrumented).
A branch with positive count (green color) is OK (has been executed).
A branch with a zero count (+ marker / yellow color) need attention (has not been executed).
A branch with a zero count (+ marker / red color) need attention (has not been instrumented).
Multiple Branches Per Line
Lines with multiple branches may be easier to work with if the source code is modified to put one decision per line.
versus
C/x86
This section provides guidance for GNU C compiler (gcc) on x86.
Functions
At the end of a function the closing brace may have a line count of 0 due to a patching problem. This is fixed in ap.4.4.63/7. Otherwise, the 0 line count can be ignored.
Loops
In a for loop, the index bounds test is completed at the top of the loop. If the branch associated with the for loop in not taken, then the body of the loop will not have been executed (line counts should be 0).
In a for loop, the index bounds test is completed at the top of the loop. The line count of the for loop should be greater than the branch count of the for loop because the final bounds check will fail and not branch back to the loop body.
In a while loop, the while test is completed at the top of the loop. If the branch associated with the while loop in not taken, then the body of the loop will not have been executed (line counts should be 0).
In a while loop, the while test is completed at the bottom of the loop. The line count of the while loop should be greater than the branch count of the for loop because the final while test will fail and not branch back to the loop body.
In a do-while loop, the while test is completed at the bottom of the loop. The line count of the do-while loop should be greater than the branch count of the for loop because the final while test will fail and not branch back to the loop body.
Conditional Operator (?)
Conditional operator expressions will generate one branch for each conditional operator (?).
Conditional operators on a single line will include a branch to the same line which is for the FALSE condition. If the branch is not taken then the TRUE conditional has not been executed. If the branch is executed fewer times than the line count then both conditions have been executed.
Conditional operator expressions spanning multiple source lines allow for easier (not easy) determination of decisions tested.
versus
Switch Statements
Switch statements with a default case will have a single branch to the default case and use a jump table for the rest. Line counts will indicate which cases have been executed.
Switch statements without a default will have branches for each case. Line counts will indicate which cases have been executed. There will also be a branch to the same line as the switch expression (which represents the default case) which is executed when no explicit cases are executed.
Switch statements with null or no statements will have branches to the next statement following the switch statement. If the switch statement is at the end of a loop, the next statement may be the loop condition test, whose source line number may/will be at the top of the loop.
If Statements
If statements will include (at least) one branch for the condition of each leg. If the branch count is not the same as the line count then both paths of the decision have been tested.
If statements with null/empty legs...TBD
If statement conditions with multiple boolean operators will have one branch associated with the whole condition. If the boolean operands are spread on separate source lines they will all have the same line count. (See short circuit operators.)
If statement conditions with short circuit operators will have one branch for each operand of the short circuit operator. If a branch has a count of 0 then that path has not been executed. If the boolean operands are spread on separate source lines they will have separate line counts which will indicate if each operand was executed.
GNAT Ada/x86
Exception Checks
Straight-line code will often include exception checks for ranges and bounds. If straight-line code contains branches to the same line then these are exception checks. If the branch counts are the same as the line counts then the exception checks passed and an exception was not raised.
Loops
All for loops will include a branch for the loop range check at the top. The normal loop range check should have a line count greater than the line count of the body statements to indicate the loop reached completion and the branch count should be non-zero to indicate the exit was taken. Testing for 0, 1, and multiple loop executions should be achieved with separate test runs.
For loops with dynamic bounds will test for a null loop range at the top of the loop and contain a branch to the next statement which is taken when the loop range is null.
While loops will test loop exit condition at the top of the loop and contain a branch to the next statement which is taken when the loop exit is taken. The loop exit condition should have a line count greater than the line count of the body statements to indicate the loop reached completion. Using short circuits operators in the loop exit condition will increase the number of branches, and each should be executed for complete coverage. Testing for 0, 1, and multiple loop executions should be achieved with separate test runs.
Exit Statements
Loop exit statements will include a branch which is taken when the exit is taken. The branch count should be less than the line count to indicate that both paths of the decision are taken. Using short circuits operators in the loop exit condition will increase the number of branches, and each should be executed for complete coverage.
Case Statements
Case statements will have a single branch at the top to handle the others case. Coverage of the when alternatives can be confirmed by line counts.
If Statements
If statements will include (at least) one branch for the condition of each leg. If the branch count is greater than zero but less than the line count then both paths of the decision have been tested.
If statements conditions with multiple boolean operators will have one branch associated with the whole condition. If the boolean operands are spread on separate source lines they will all have the same line count. (See short circuit operators.)
If statement conditions with short circuit operators will have one branch for each operand of the short circuit operator. If a branch has a count of 0 then that path has not been executed. If the boolean operands are spread on separate source lines they will have separate line counts which will indicate if each operand was executed.
XLC/PPC
This section covers the IBM XLC compiler on AIX PPC targets.
Functions
At the end of a function the closing brace may have a line count of 0. This can be safely ignored.
Loops
In a for loop, an index bounds test is completed at the top and bottom of the loop. The branches generated for those tests are associated with the first line of the loop, and the first is from the top of the loop and the second is from the bottom of the loop. test, the loop body was not executed (the difference of the counts). If the first branch count is less than the line count of the loop test, the loop body was not executed (the difference of the counts).
In a while loop, an loop exit test is completed at the top and bottom of the loop. The branches generated for those tests are associated with the first line of the loop, and the first is from the top of the loop and the second is from the bottom of the loop. test, the loop body was not executed (the difference of the counts).
In a do-while loop, an loop exit test is completed at the bottom of the loop. The branch generated for that test is associated with the last line of the loop. The loop body will have been executed one more time then the branch count, as confirmed by loop body line counts.
Conditional Operator (?)
Conditional operator expressions will generate one branch for each conditional operator (?). Conditional operators on a single line will include a branch to the same line which is for the FALSE condition. If the branch is not taken then the TRUE conditional has not been executed. If the branch is executed fewer times than the line count then both conditions have been executed.
Conditional operator expressions spanning multiple source lines allow for easier (not easy) determination of decisions tested.
Switch Statements
Switch statements with a default case will have a single branch to the default case which shows up as a branch to the top of the switch statement. (This is a conditional branch to an unconditional branch to the default case.) Line counts will indicate which cases have been executed.
Switch statements without a default will have branches for each case. Line counts will indicate which cases have been executed.
Switch statements with null or no statements will not have branches to those cases. For multiple cases with the same statements, each case will have a branch to the same source line.
If Statements
If statements will include (at least) one branch for the condition of each leg. If the branch count is not the same as the line count then both paths of the decision have been tested.
If statements with null/empty legs...TBD
If statement conditions with multiple boolean operators will have one branch associated with the whole condition. If the boolean operands are spread on separate source lines they will all have the same line count. (See short circuit operators.)
If statement conditions with short circuit operators will have one branch for each operand of the short circuit operator. If a branch has a count of 0 then that path has not been executed. If the boolean operands are spread on separate source lines they will have separate line counts which will indicate if each operand was executed.
PowerAda/PPC
This section covers the OCS PowerAda compiler for the PPC target.
Exception Checks
Straight-line code will often include exception checks for ranges and bounds. If straight-line code contains branches to the end of a subprogram then these are exception checks. Branch counts will indicate how many time the exception was raised.
Loops
All for loops will include a branch for the loop range check at the bottom. The normal loop range check should have a branch count less than the line count of the body statements to indicate the loop reached completion. Testing for 0, 1, and multiple loop executions should be achieved with separate test runs.
For loops with dynamic bounds will test for a null loop range at the top of the loop and contain a branch to the next statement which is taken when the loop range is null.
While loops will test the loop exit condition at the top of the loop and contain a branch to the next statement which is taken when the loop exit is taken. While loops will test the loop exit condition at the bottom of the loop too and contain a branch to the top of the loop which is taken when the loop continues. The loop exit condition should have a line count greater than the line count of the body statements to indicate the loop reached completion. Using short circuits operators in the loop exit condition will increase the number of branches, and each should be executed for complete coverage. Testing for 0, 1, and multiple loop executions should be achieved with separate test runs.
Exit Statements
Loop exit statements will include a branch which is taken when the exit is taken. The branch count should be less than the line count to indicate that both paths of the decision are taken. Using short circuits operators in the loop exit condition will increase the number of branches, and each should be executed for complete coverage.
Case Statements
Case statements will have a branch for each alternative listed. The others alternative will have branches associated with values not handled by the specified alternatives, including values below the range, above the range, and values in between. Coverage of the when alternatives can be confirmed by line counts. Coverage of out of bound values can be confirmed by the branch counts.
If Statements
If statements will include (at least) one branch for the condition of each leg. If the branch count is greater than zero but less than the line count then both paths of the decision have been tested.
If statements conditions with multiple boolean operators will have one branch associated with the whole condition. If the boolean operands are spread on separate source lines they will all have the same line count. (See short circuit operators.)
If statement conditions with short circuit operators will have one branch for each operand of the short circuit operator. If a branch has a count of 0 then that path has not been executed. If the boolean operands are spread on separate source lines they will have separate line counts which will indicate if each operand was executed.
