$ coverage report -m
\nName Stmts Miss Cover Missing
\n--------------------------------------------------------
\npygnmi\/__init__.py 1 0 100%
\npygnmi\/client.py 589 288 51% 54-55, 57, 75-77, 81-88, 95-97, 109-111, 132-134, 139-141, 159, 161, 177-186, 225-232, 237-244, 248-249, 253-255, 260-261, 267-269, 274-276, 317-345, 353-362, 394-395, 402-408, 419-434, 445-460, 466-468, 473-475, 502, 512, 521-532, 538-547, 552, 557, 562, 566, 571-576, 585, 594, 598, 603, 617, 624, 628, 633, 639, 643, 648, 651, 658, 672, 675-682, 685-698, 704-706, 711-714, 717-720, 723-726, 766-782, 791-800, 803, 812-816, 819-828, 831, 834, 840, 852-855, 861, 869-870, 883-884, 887-891, 907, 919-920, 930-932, 942-955, 977, 981, 984, 989-1011, 1017-1025
\npygnmi\/path_generator.py 36 0 100%
\n--------------------------------------------------------
\nTOTAL 626 288 54%<\/div><\/td><\/tr><\/tbody><\/table><\/div>\n\n<\/pre>\n\n\n\n
Now we see only Python modules we have created ourselves, which are the heart of pygnmi<\/strong>. Some of them have 100% coverage<\/strong> by our unit tests with pytest<\/strong>, whilst the main client is just 51%. How can we improve that number?<\/p>\n\n\n\nStep #3. Increasing Coverage<\/h3>\n\n\n\n
Let’s carefully analyse the output above. You may see the column Missing<\/strong>, which contains lines of code, which were not executed. The more lines you have, which are not executed, the less your coverage is. How can you increase amount of code executed? The answer is straightforward:<\/p>\n\n\n\n- Either you add more logic to your existing unit tests<\/li>
- Or you create more new tests to cover those missing lines<\/li><\/ul>\n\n\n\n
We will show you here the second approach. Let’s take a look on missing lines 54-55 and 57 from pygnmi\/client.py<\/strong>:<\/p>\n\n\n\n\n\n1 2 3 4 5 <\/div><\/td> 53 if re.match('unix:.*', target[0]): \n54 self.__target = target \n55 self.__target_path = target[0] \n56 elif re.match('.*:.*', target[0]): \n57 self.__target = (f'[{target[0]}]', target[1])<\/div><\/td><\/tr><\/tbody><\/table><\/div>\n\n<\/pre>\n\n\n\n Those ones are related to various type of how the name connectivity date (IPv4\/IPv6 address or FQDN and port). They are not being executed, as in our case for testing we provide the connectivity data as FQDN and parts for UNIX-socket or IPv6 aren’t used. Let’s fix IPv6 part.<\/p>\n\n\n\n In our .env<\/em> file, which stores connectivity data we add a new variables. Current state:<\/p>\n\n\n\n\n\n1 2 <\/div><\/td> $ cat .env | grep PYGNMI_HOST \nPYGNMI_HOST="EOS1"<\/div><\/td><\/tr><\/tbody><\/table><\/div>\n\n<\/pre>\n\n\n\n Modified state of .env<\/em> file:<\/p>\n\n\n\n\n\n1 2 3 4 <\/div><\/td> $ cat .env | grep PYGNMI_HOST \nPYGNMI_HOST="EOS425" \nPYGNMI_HOST_2="169.254.255.10" \nPYGNMI_HOST_3="fc00:169:254:255::A"<\/div><\/td><\/tr><\/tbody><\/table><\/div>\n\n<\/pre>\n\n\n\n So we have created 2 new variables, and we will create a new file with unit tests to utilise those variables:<\/p>\n\n\n\n \n\n1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 <\/div><\/td> $ cat tests\/test_address_types.py \n#!\/usr\/bin\/env python \n \n# Modules \nfrom pygnmi.client import gNMIclient \nfrom dotenv import load_dotenv \nimport os \n \n \n# User-defined functions (Tests) \ndef test_fqdn_address(): \n load_dotenv() \n username_str = os.getenv("PYGNMI_USER") \n password_str = os.getenv("PYGNMI_PASS") \n hostname_str = os.getenv("PYGNMI_HOST") \n port_str = os.getenv("PYGNMI_PORT") \n path_cert_str = os.getenv("PYGNMI_CERT") \n \n gc = gNMIclient(target=(hostname_str, port_str), username=username_str, password=password_str, path_cert=path_cert_str) \n gc.connect() \n \n result = gc.capabilities() \n \n gc.close() \n \n assert "supported_models" in result \n assert "supported_encodings" in result \n assert "gnmi_version" in result \n \n \ndef test_ipv4_address_override(): \n load_dotenv() \n username_str = os.getenv("PYGNMI_USER") \n password_str = os.getenv("PYGNMI_PASS") \n hostname_str = os.getenv("PYGNMI_HOST_2") \n port_str = os.getenv("PYGNMI_PORT") \n path_cert_str = os.getenv("PYGNMI_CERT") \n \n gc = gNMIclient(target=(hostname_str, port_str), username=username_str, password=password_str, path_cert=path_cert_str, override="EOS425") \n gc.connect() \n \n result = gc.capabilities() \n \n gc.close() \n \n assert "supported_models" in result \n assert "supported_encodings" in result \n assert "gnmi_version" in result \n \n \ndef test_ipv6_address_override(): \n load_dotenv() \n username_str = os.getenv("PYGNMI_USER") \n password_str = os.getenv("PYGNMI_PASS") \n hostname_str = os.getenv("PYGNMI_HOST_3") \n port_str = os.getenv("PYGNMI_PORT") \n path_cert_str = os.getenv("PYGNMI_CERT") \n \n gc = gNMIclient(target=(hostname_str, port_str), username=username_str, password=password_str, path_cert=path_cert_str, override="EOS425") \n gc.connect() \n \n result = gc.capabilities() \n \n gc.close() \n \n assert "supported_models" in result \n assert "supported_encodings" in result \n assert "gnmi_version" in result<\/div><\/td><\/tr><\/tbody><\/table><\/div>\n\n<\/pre>\n\n\n\n As you see, tests are fairly identical:<\/p>\n\n\n\n | |
| |
| |
| |
![\"\"\/](\"https:\/\/karneliuk.com\/wp-content\/uploads\/2022\/08\/4_trainings.jpg\")
<\/a><\/p><\/div>\n\n\n\n\n![\"\"](\"https:\/\/karneliuk.com\/wp-content\/uploads\/2021\/01\/Karneliuk_com_pygnmi_topology-1024x576.png\")
<\/figure>\n\n\n\n