test_framework.coverage Namespace Reference

Classes
class	AuthServiceProxyWrapper

Functions
def	get_filename (dirname, n_node)
def	write_all_rpc_commands (dirname, node)

Variables
string	REFERENCE_FILENAME = 'rpc_interface.txt'

Detailed Description

This module contains utilities for doing coverage analysis on the RPC
interface.

It provides a way to track which RPC commands are exercised during
testing.

Function Documentation

get_filename()

def test_framework.coverage.get_filename	(		dirname,
			n_node
	)

Get a filename unique to the test process ID and node.

This file will contain a list of RPC commands covered.

Definition at line 58 of file coverage.py.

write_all_rpc_commands()

def test_framework.coverage.write_all_rpc_commands	(		dirname,
			node
	)

Write out a list of all RPC functions available in `bitcoin-cli` for
coverage comparison. This will only happen once per coverage
directory.

Args:
    dirname (str): temporary test dir
    node (AuthServiceProxy): client

Returns:
    bool. if the RPC interface file was written.

Definition at line 69 of file coverage.py.

Variable Documentation

REFERENCE_FILENAME

string test_framework.coverage.REFERENCE_FILENAME = 'rpc_interface.txt'

Definition at line 12 of file coverage.py.