Function test_generate_examples

tests/autogenerate-rpc-examples.py:2055–2124

Re-generates examples for doc/schema/lightning-*.json files

(node_factory, bitcoind, executor)

@unittest.skipIf(not GENERATE_EXAMPLES, 'Generates examples for doc/schema/lightning-*.json files.')
def test_generate_examples(node_factory, bitcoind, executor):
    """Re-generates examples for doc/schema/lightning-*.json files"""
    try:
        global ALL_RPC_EXAMPLES, REGENERATING_RPCS

        def list_all_examples():
            """list all methods used in 'update_example' calls to ensure that all methods are covered"""
            try:
                methods = []
                file_path = os.path.abspath(__file__)

                # Parse and traverse this file's content to list all methods & file names
                with open(file_path, "r") as file:
                    file_content = file.read()
                tree = ast.parse(file_content)
                for node in ast.walk(tree):
                    if isinstance(node, ast.Call) and isinstance(node.func, ast.Name) and node.func.id == 'update_example':
                        for keyword in node.keywords:
                            if (keyword.arg == 'method' and isinstance(keyword.value, ast.Constant)):
                                if keyword.value.value not in methods:
                                    methods.append(keyword.value.value)
                return methods
            except Exception as e:
                logger.error(f'Error in listing all examples: {e}')
                raise

        def list_missing_examples():
            """Checks for missing example & log an error if missing."""
            try:
                missing_examples = ''
                for file_name in os.listdir('doc/schemas'):
                    if not file_name.endswith('.json'):
                        continue
                    file_name_str = str(file_name).replace('.json', '')
                    # Log an error if the method is not in the list
                    if file_name_str not in ALL_RPC_EXAMPLES and file_name_str not in IGNORE_RPCS_LIST:
                        missing_examples = missing_examples + f"'{file_name_str}', "
                if missing_examples != '':
                    raise MissingExampleError(f"Missing {missing_examples.count(', ')} Examples For: [{missing_examples.rstrip(', ')}]")
            except MissingExampleError:
                raise
            except Exception as e:
                logger.error(f'Error in listing missing examples: {e}')
                raise

        ALL_RPC_EXAMPLES = list_all_examples()
        logger.info(f'This test can reproduce examples for {len(ALL_RPC_EXAMPLES)} methods: {ALL_RPC_EXAMPLES}')
        logger.warning(f'This test ignores {len(IGNORE_RPCS_LIST)} rpc methods: {IGNORE_RPCS_LIST}')
        REGENERATING_RPCS = [rpc.strip() for rpc in os.getenv("REGENERATE").split(', ')] if os.getenv("REGENERATE") else ALL_RPC_EXAMPLES
        list_missing_examples()
        l1, l2, l3, l4, l5, l6, c12, c23, c25 = setup_test_nodes(node_factory, bitcoind)
        c23_2, c23res2, c34_2, inv_l11, inv_l21, inv_l22, inv_l31, inv_l32, inv_l34 = generate_transactions_examples(l1, l2, l3, l4, l5, c25, bitcoind)
        rune_l21 = generate_runes_examples(l1, l2, l3)
        generate_datastore_examples(l2)
        generate_coinmvt_examples(l2)
        generate_bookkeeper_examples(l2, l3, c23res2['channel_id'])
        offer_l23, inv_req_l1_l22 = generate_offers_renepay_examples(l1, l2, inv_l21, inv_l34)
        generate_askrene_examples(l1, l2, l3, c12, c23_2)