\n| \n file=test\/coverage_helper_test.dart
\n<\/em>printf “\/\/ Helper file to make coverage work for all dart files\\n” > $file
\n<\/em>printf “\/\/ **************************************************************************\\n” >> $file
\n<\/em>printf “\/\/ Because of this: https:\/\/github.com\/flutter\/flutter\/issues\/27997#issue-410722816\\n” >> $file
\n<\/em>printf “\/\/ DO NOT EDIT THIS FILE USE: sh scripts\/import_files_coverage.sh YOUR_PACKAGE_NAME\\n” >> $file
\n<\/em>printf “\/\/ **************************************************************************\\n” >> $file
\n<\/em>printf “\\n” >> $file
\n<\/em>printf “\/\/ ignore_for_file: unused_import\\n” >> $file
\n<\/em>find lib \\
\n<\/em>‘!’ -path ‘*generated*\/*’ \\
\n<\/em>‘!’ -iname ‘*.g.dart’ \\
\n<\/em>‘!’ -iname ‘*.freezed.dart’ \\
\n<\/em>‘!’ -iname ‘*.part.dart’ \\
\n<\/em>‘!’ -iname ‘generated_plugin_registrant.dart’ \\
\n<\/em>-iname ‘*.dart’ \\
\n<\/em>| cut -c4- | awk -v package=”${1}” ‘{printf “import ‘\\”package:%s%s’\\”;\\n”, package, $1}’ >> $file
\n<\/em>printf “\\nvoid main(){}” >> $file<\/em><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\nThis file (import_file_coverage.sh<\/em><\/strong>)<\/em> needs a package name as parameter. We add the package name and run command as follows:<\/p>\nsh import_file_coverage.sh your_package_name<\/span><\/em><\/strong><\/p>\nThis will generate coverage_helper_test.dart<\/strong> <\/span>file under test folder and add all these files in lcov.info<\/span> to generate report against all these files.<\/p>\nNow our next task is to create readable test coverage report out of lcove.info<\/span> file. To do this we will take help of genhtml<\/strong> command which will generate readable html file that would open in your default browser:<\/p>\n![\"\"](\"\/blog\/wp-ttn-blog\/uploads\/2022\/06\/Screenshot-2022-05-14-at-12.37.08-PM.png\") <\/p>\n
Bravo, now we have line coverage of each folder and file!\u00a0<\/span><\/p>\nWhen we click on any of the file in the above image, it will take us to a detailed coverage of MyHomePage.dart<\/strong><\/em> file like below:<\/p>\n![\"\"](\"\/blog\/wp-ttn-blog\/uploads\/2022\/06\/Screenshot-2022-05-14-at-1.27.44-PM-1024x520.png\") <\/p>\n
In the above files the blue lines means lines covered and red means non tested lines. As we can see in MyHomePage.dart<\/strong> file we have covered 93.3%, with two line remain untested. We can also cover these lines by writing tests for these lines.<\/p>\n![\"\"](\"\/blog\/wp-ttn-blog\/uploads\/2022\/06\/Screenshot-2022-05-16-at-2.55.17-PM.png\") <\/p>\n
But there is one challenge here. In models we see there is only 70.8% coverage (top right in red colored cell). This is because it has also covered the generated files for which we cannot write test case. Thus, we will remove all *.g.dart<\/strong> files and other generated files from our generated lcove file. Here is the command to remove generated files:<\/p>\n\n\n\n| \n lcov –remove coverage\/lcov.base.info \\
\n<\/em>\u00a0<\/span>‘lib\/main.dart’ \\
\n<\/em>‘lib\/*\/*.freezed.dart’ \\
\n<\/em>‘lib\/*\/*.g.dart’ \\
\n<\/em>‘lib\/*\/*.part.dart’ \\
\n<\/em>‘**\/generated\/*.dart’ \\
\n<\/em>‘**\/generated\/*\/*.dart’ \\
\n<\/em>‘**\/gen\/*.dart’ \\
\n<\/em>‘**\/gen\/*\/*.dart’ \\
\n<\/em>-o coverage\/lcov.base.info<\/span><\/em><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\nNow, the whole script will look like this:<\/p>\n File<\/span> create_clean_lcov_and_generate_html.sh<\/strong><\/em><\/p>\n\n\n\n| \n #!\/bin\/bash
\n<\/em>set -e
\n<\/em>flutter pub get
\n<\/em>sh scripts\/import_files_coverage.sh your_package_name
\n<\/span><\/em>flutter test –coverage
\n<\/em>lcov –remove coverage\/lcov.base.info \\
\n<\/em>\u00a0 <\/span>‘lib\/main.dart’ \\
\n<\/em>\u00a0 <\/span>‘lib\/*\/*.freezed.dart’ \\
\n<\/em>\u00a0 <\/span>‘lib\/*\/*.g.dart’ \\
\n<\/em>\u00a0 <\/span>‘lib\/*\/*.part.dart’ \\
\n<\/em>\u00a0 <\/span>‘**\/generated\/*.dart’ \\
\n<\/em>\u00a0 <\/span>‘**\/generated\/*\/*.dart’ \\
\n<\/em>\u00a0 <\/span>‘**\/gen\/*.dart’ \\
\n<\/em>\u00a0 <\/span>‘**\/gen\/*\/*.dart’ \\
\n<\/em>\u00a0 <\/span>-o coverage\/lcov.base.info
\n<\/span> genhtml coverage\/lcov.info -o coverage<\/em> <\/span>\/\/ will generate readable html file from lcov.info<\/span> file<\/em>
\nopen coverage\/index.html<\/em><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\nAnd finally we need to extract total test coverage percentage from lcov.info<\/span> file that is covered, for that we will write following command:<\/p>\ncoverageRate=$(lcov –summary “coverage\/lcov.base.info” | grep “lines……” | cut -d ‘ ‘ -f 4 | cut -d ‘%’ -f 1)<\/strong><\/em><\/p>\nREQUIRED_COVERAGE_PERC=80<\/span> \/\/ You can define the percentage you want to cover, in this case we defined 80%\u00a0<\/em><\/p>\nAfter getting the percentage we can use this in any CI to exit the build process if it is not meeting our minimum code coverage criteria or percentage. Here is the following code to do the same:<\/p>\n \n\n\n| \n coverageRate=$(lcov –summary “coverage\/lcov.base.info” | grep “lines……” | cut -d ‘ ‘ -f 4 | cut -d ‘%’ -f 1)
\n<\/strong>REQUIRED_COVERAGE_PERC=80<\/span> \/\/ You can define the percentage you want to cover, in this case we defined 80%\u00a0<\/em>
\nif [ “$(echo “${coverageRate} < $REQUIRED_COVERAGE_PERC” | bc)” -eq 1 ]; then<\/em>
\n\u00a0 \u00a0 <\/span>printf “coverage is too low, We required ${REQUIRED_COVERAGE_PERC}% and have ${coverageRate}%.\\n”<\/em>
\n\u00a0 \u00a0 <\/span>exit 1<\/em>
\nelse<\/em>
\n\u00a0 \u00a0 <\/span>printf “Coverage rate is up to mark.\\n”<\/em>
\nfi<\/em><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\nI hope this blog helps you understand how you can measure flutter code coverage and if it meets our minimum coverage criteria.<\/p>\n Stay tuned for Part 2 of this blog that will cover “How to test sub-packages of flutter project”.<\/p>\n <\/div>","protected":false},"excerpt":{"rendered":" As a good practice we should always write unit tests while writing the code for a software. Next, it is important to measure that the test we write is enough for our code or not, as per our coverage criteria. We leverage a few tools, discussed below, that check which lines of the codes are […]<\/p>\n","protected":false},"author":1462,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"iawp_total_views":70},"categories":[4687,1772,1816],"tags":[1593,4969,4968,4972,4973,4970,4971],"aioseo_notices":[],"_links":{"self":[{"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/posts\/55017"}],"collection":[{"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/users\/1462"}],"replies":[{"embeddable":true,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/comments?post=55017"}],"version-history":[{"count":4,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/posts\/55017\/revisions"}],"predecessor-version":[{"id":55117,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/posts\/55017\/revisions\/55117"}],"wp:attachment":[{"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/media?parent=55017"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/categories?post=55017"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/tags?post=55017"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}} | | | |