check-doc.py raw

   1  #!/usr/bin/env python3
   2  # Copyright (c) 2015-2022 The Limenka developers
   3  # Distributed under the MIT software license, see the accompanying
   4  # file COPYING or http://www.opensource.org/licenses/mit-license.php.
   5  
   6  '''
   7  This checks if all command line args are documented.
   8  Return value is 0 to indicate no error.
   9  
  10  Author: @MarcoFalke
  11  '''
  12  
  13  from subprocess import check_output
  14  import re
  15  
  16  FOLDER_GREP = 'src'
  17  FOLDER_TEST = 'src/test/'
  18  REGEX_ARG = r'\b(?:GetArg|GetArgs|GetBoolArg|GetIntArg|GetFixedPointArg|GetPathArg|IsArgSet|get_net)\("(-[^"]+)"'
  19  REGEX_DOC = r'AddArg\("(-[^"=]+?)(?:=|")'
  20  CMD_ROOT_DIR = '$(git rev-parse --show-toplevel)/{}'.format(FOLDER_GREP)
  21  CMD_GREP_ARGS = r"git grep --perl-regexp '{}' -- {} ':(exclude){}'".format(REGEX_ARG, CMD_ROOT_DIR, FOLDER_TEST)
  22  CMD_GREP_WALLET_ARGS = r"git grep --function-context 'void WalletInit::AddWalletOptions' -- {} | grep AddArg".format(CMD_ROOT_DIR)
  23  CMD_GREP_WALLET_HIDDEN_ARGS = r"git grep --function-context 'void DummyWalletInit::AddWalletOptions' -- {}".format(CMD_ROOT_DIR)
  24  CMD_GREP_DOCS = r"git grep --perl-regexp '{}' {}".format(REGEX_DOC, CMD_ROOT_DIR)
  25  # list unsupported, deprecated and duplicate args as they need no documentation
  26  SET_DOC_OPTIONAL = set(['-h', '-?', '-dbcrashratio', '-forcecompactdb'])
  27  
  28  
  29  def lint_missing_argument_documentation():
  30      used = check_output(CMD_GREP_ARGS, shell=True).decode('utf8').strip()
  31      docd = check_output(CMD_GREP_DOCS, shell=True).decode('utf8').strip()
  32  
  33      args_used = set(re.findall(re.compile(REGEX_ARG), used))
  34      args_docd = set(re.findall(re.compile(REGEX_DOC), docd)).union(SET_DOC_OPTIONAL)
  35      args_need_doc = args_used.difference(args_docd)
  36      args_unknown = args_docd.difference(args_used)
  37  
  38      print("Args used        : {}".format(len(args_used)))
  39      print("Args documented  : {}".format(len(args_docd)))
  40      print("Args undocumented: {}".format(len(args_need_doc)))
  41      print(args_need_doc)
  42      print("Args unknown     : {}".format(len(args_unknown)))
  43      print(args_unknown)
  44  
  45      assert 0 == len(args_need_doc), "Please document the following arguments: {}".format(args_need_doc)
  46  
  47  
  48  def lint_missing_hidden_wallet_args():
  49      wallet_args = check_output(CMD_GREP_WALLET_ARGS, shell=True).decode('utf8').strip()
  50      wallet_hidden_args = check_output(CMD_GREP_WALLET_HIDDEN_ARGS, shell=True).decode('utf8').strip()
  51  
  52      wallet_args = set(re.findall(re.compile(REGEX_DOC), wallet_args))
  53      wallet_hidden_args = set(re.findall(re.compile(r'    "([^"=]+)'), wallet_hidden_args))
  54  
  55      hidden_missing = wallet_args.difference(wallet_hidden_args)
  56      if hidden_missing:
  57          assert 0, "Please add {} to the hidden args in DummyWalletInit::AddWalletOptions".format(hidden_missing)
  58  
  59  
  60  def main():
  61      lint_missing_argument_documentation()
  62      lint_missing_hidden_wallet_args()
  63  
  64  
  65  if __name__ == "__main__":
  66      main()
  67