reckless: add listconfig command

Requested by @ShahanaFarooqui while accessing reckless via rpc
in order to find out where the plugins are installed and
enabled.

Author: endothermicdev

tests/test_reckless.py

@@ -3,6 +3,7 @@
 from pathlib import PosixPath, Path
 import socket
 from pyln.testing.utils import VALGRIND, SLOW_MACHINE
+import json
 import pytest
 import os
 import re
@@ -170,16 +171,30 @@ def test_basic_help():
     assert r.search_stdout("options:") or r.search_stdout("optional arguments:")
 
 
-def test_version():
+def test_reckless_version(node_factory):
     '''Version should be reported without loading config and should advance
-    with lightningd'''
-    r = reckless(["-V", "-v", "--json"])
+    with lightningd.'''
+    node = get_reckless_node(node_factory)
+    r = reckless(["-V", "-v", "--json"], dir=node.lightning_dir)
     assert r.returncode == 0
-    import json
     json_out = ''.join(r.stdout)
     with open('.version', 'r') as f:
         version = f.readlines()[0].strip()
         assert json.loads(json_out)['result'][0] == version
+    assert not r.search_stdout('config file not found')
+
+    # reckless listconfig should report the reckless version as well.
+    NETWORK = os.environ.get('TEST_NETWORK')
+    if not NETWORK:
+        NETWORK='regtest'
+    r = reckless(['listconfig', f'--network={NETWORK}', '--json'],
+                 dir=node.lightning_dir)
+    assert r.returncode == 0
+    result = json.loads(''.join(r.stdout))['result']
+    assert result['network'] == NETWORK
+    assert result['reckless_dir'] == str(node.lightning_dir / 'reckless')
+    assert result['lightning_conf'] == str(node.lightning_dir / NETWORK / 'config')
+    assert result['version'] == version
 
 
 def test_contextual_help(node_factory):

tools/reckless

@@ -99,10 +99,13 @@ class Logger:
 
     def reply_json(self):
         """json output to stdout with accumulated result."""
-        if len(log.json_output["result"]) == 1 and \
-           isinstance(log.json_output["result"][0], list):
-            # unpack sources output
-            log.json_output["result"] = log.json_output["result"][0]
+        if len(log.json_output["result"]) == 1:
+            if isinstance(log.json_output["result"][0], list):
+                # unpack sources output
+                log.json_output["result"] = log.json_output["result"][0]
+            elif isinstance(log.json_output['result'][0], dict):
+                # If result is only a single dict, unpack it from the result list
+                log.json_output['result'] = log.json_output['result'][0]
         output = json.dumps(log.json_output, indent=3) + '\n'
         ratelimit_output(output)
 
@@ -846,6 +849,8 @@ class RecklessConfig(Config):
             )
         Config.__init__(self, path=str(path), default_text=default_text)
         self.reckless_dir = Path(path).parent
+        # Which lightning config needs to inherit the reckless config?
+        self.lightning_conf = None
 
 
 class LightningBitcoinConfig(Config):
@@ -1817,6 +1822,7 @@ def load_config(reckless_dir: Union[str, None] = None,
         reckless_abort('Error: could not load or create the network specific lightningd'
                        ' config (default .lightning/bitcoin)')
     net_conf.editConfigFile(f'include {reckless_conf.conf_fp}', None)
+    reckless_conf.lightning_conf = network_path
     return reckless_conf
 
 
@@ -2118,6 +2124,31 @@ def available_plugins() -> list:
     return candidates
 
 
+def listconfig() -> dict:
+    """Useful for checking options passed through the reckless-rpc."""
+    config = {}
+
+    log.info(f'requested lightning config: {LIGHTNING_CONFIG}')
+    config.update({'requested_lightning_conf': LIGHTNING_CONFIG})
+
+    log.info(f'lightning config in use: {RECKLESS_CONFIG.lightning_conf}')
+    config.update({'lightning_conf': str(RECKLESS_CONFIG.lightning_conf)})
+
+    log.info(f'lightning directory: {LIGHTNING_DIR}')
+    config.update({'lightning_dir': str(LIGHTNING_DIR)})
+
+    log.info(f'reckless directory: {RECKLESS_CONFIG.reckless_dir}')
+    config.update({'reckless_dir': str(RECKLESS_CONFIG.reckless_dir)})
+
+    log.info(f'network: {NETWORK}')
+    config.update({'network': NETWORK})
+
+    log.info(f'reckless version: {__VERSION__}')
+    config.update({'version': __VERSION__})
+
+    return config
+
+
 def report_version() -> str:
     """return reckless version"""
     log.info(__VERSION__)
@@ -2132,7 +2163,7 @@ def unpack_json_arg(json_target: str) -> list:
         return None
     if isinstance(targets, list):
         return targets
-    log.warning(f'input {target_list} is not a json array')
+    log.warning(f'input {json_target} is not a json array')
     return None
 
 
@@ -2231,10 +2262,12 @@ if __name__ == '__main__':
     parser.add_argument('-V', '--version',
                         action=StoreTrueIdempotent, const=None,
                         help='print version and exit')
+    listconfig_cmd = cmd1.add_parser('listconfig', help='list options passed to reckless')
+    listconfig_cmd.set_defaults(func=listconfig)
 
     all_parsers = [parser, install_cmd, uninstall_cmd, search_cmd, enable_cmd,
                    disable_cmd, list_parse, source_add, source_rem, help_cmd,
-                   update, list_cmd, available_cmd]
+                   update, list_cmd, available_cmd, listconfig_cmd]
     for p in all_parsers:
         # This default depends on the .lightning directory
         p.add_argument('-d', '--reckless-dir', action=StoreIdempotent,