-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathcomponent---src-docs-cpp-home-md-977e15f0372e6be6a9a0.js
2 lines (2 loc) · 5.52 KB
/
component---src-docs-cpp-home-md-977e15f0372e6be6a9a0.js
1
2
"use strict";(self.webpackChunkunittestbot_web=self.webpackChunkunittestbot_web||[]).push([[42],{40771:function(e,t,n){n.r(t),n.d(t,{_frontmatter:function(){return l},default:function(){return u}});var a=n(87462),o=n(63366),r=(n(15007),n(64983)),s=n(23017),i=(n(13879),["components"]),l={};void 0!==l&&l&&l===Object(l)&&Object.isExtensible(l)&&!Object.prototype.hasOwnProperty.call(l,"__filemeta")&&Object.defineProperty(l,"__filemeta",{configurable:!0,value:{name:"_frontmatter",filename:"src/docs/cpp/Home.md"}});var c={_frontmatter:l},p=s.Z;function u(e){var t=e.components,n=(0,o.Z)(e,i);return(0,r.kt)(p,(0,a.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h1",{id:"introduction"},"Introduction"),(0,r.kt)("h2",{id:"what-is-unittestbot"},"What is UnitTestBot?"),(0,r.kt)("p",null,"UnitTestBot (aka UTBot) tool provides engineers with a simple 1-mouse-click way to automatically generate unit tests and\nvisualize coverage for projects written in C and C++ Programming Languages. It is an IDE extension (the client) paired\nwith server application."),(0,r.kt)("p",null,"The tool uses ",(0,r.kt)("a",{parentName:"p",href:"https://en.wikipedia.org/wiki/Symbolic_execution"},"symbolic execution")," for test cases generation. UTBot\nuses KLEE Symbolic Virtual Machine enchanced with a new advanced bidirectional symbolic execution algorithm developed by\nResearch Group from Saint Petersburg State University. Tests are generated in form\nof ",(0,r.kt)("a",{parentName:"p",href:"https://github.com/google/googletest"},"Google Test Framework"),"."),(0,r.kt)("h2",{id:"tests-generation-regression-suite"},"Tests Generation: Regression Suite"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"UnitTestBot")," generates test cases by code, trying to cover maximum statements and execution paths. We treat source\ncode as ",(0,r.kt)("em",{parentName:"p"},"source of truth")," assuming that behavior is correct (corresponds to initial user demand). Generated tests are\nplaced in the so-called ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("em",{parentName:"strong"},"regression suite")),". Thus, we ",(0,r.kt)("em",{parentName:"p"},"fixate")," current behavior by test cases."),(0,r.kt)("p",null,"What is the purpose? You obtain ",(0,r.kt)("strong",{parentName:"p"},"full control")," of future code changes. Any code change now ",(0,r.kt)("strong",{parentName:"p"},"can't break behavior\nsilently"),". If developer changes the code, then some tests will fall on CI. Then, ther are two possible scenarios:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"Initial behavior was ",(0,r.kt)("span",{style:{color:"green"}},(0,r.kt)("b",null,"correct"))," but developer ",(0,r.kt)("i",null,"broke")," it. And, as a result,\ngenerated test helped to find a bug."),(0,r.kt)("li",{parentName:"ul"},"Initial behavior was ",(0,r.kt)("span",{style:{color:"red"}},(0,r.kt)("b",null,"incorrect"))," and developer ",(0,r.kt)("i",null,"fixed")," it. Then, test must\nbe manually updated to fixate new behavior.")),(0,r.kt)("p",null,"UTBot provides dramatic code quality improvement in the long term: after tests are generated no change can break\nbehavior without an alarm."),(0,r.kt)("h2",{id:"test-generation-errors-detection"},"Test Generation: Errors Detection"),(0,r.kt)("p",null,"UnitTestBot is not only able to fixate the behavior in an existing code, but it also helps to find real bugs in your\nproject. Some code fragments might be invalid, while developers don't know about it. For example, buffer overflows,\nassertion failures, segmentation faults, and so on. If UTBot finds an execution path leading to such a situation, it\ncreates a special test case that is added to the so-called ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("em",{parentName:"strong"},"error suite")),"."),(0,r.kt)("p",null,"While all tests from ",(0,r.kt)("em",{parentName:"p"},"regression suite")," are ",(0,r.kt)("em",{parentName:"p"},"green")," right after generation, tests from ",(0,r.kt)("em",{parentName:"p"},"error suite")," are ",(0,r.kt)("em",{parentName:"p"},"red")," (they\nfail if you run them). Such tests generated by UnitTestBot are a convenient way to discover critical problems as soon as\npossible. After developer fixes a bug, tests can be rerun to verify the problem is gone."),(0,r.kt)("h2",{id:"code-coverage"},"Code Coverage"),(0,r.kt)("p",null,"UTBot tries to generate test cases that:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"maximize ",(0,r.kt)("a",{href:"https://en.wikipedia.org/wiki/Code_coverage"},"code coverage")," (by statements and branches);"),(0,r.kt)("li",{parentName:"ul"},"minimize number of tests, i.e. if you drop any test case from generated suite, your code coverage decreases.")),(0,r.kt)("p",null,"Of course, in an ideal world we would like to test ",(0,r.kt)("strong",{parentName:"p"},"every")," execution path of the program (so-called ",(0,r.kt)("em",{parentName:"p"},"path coverage"),"),\nbut the number of such paths is often infinite due to loops and recursion. UnitTestBot aims to maximize other types of\ncoverages: ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("em",{parentName:"strong"},"statement coverage")),"\nand ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("em",{parentName:"strong"},"branch coverage")),", most commonly used as metrics for coverage quality assessment tools."))}u&&u===Object(u)&&Object.isExtensible(u)&&!Object.prototype.hasOwnProperty.call(u,"__filemeta")&&Object.defineProperty(u,"__filemeta",{configurable:!0,value:{name:"MDXContent",filename:"src/docs/cpp/Home.md"}}),u.isMDXComponent=!0}}]);
//# sourceMappingURL=component---src-docs-cpp-home-md-977e15f0372e6be6a9a0.js.map