Merge pull request #1825 from edsonarios/checker

Added script to list all commands in slcli

Author: allmightyspiff

cliChecker/README.md

@@ -0,0 +1,10 @@
+## SLCLI Checker
+
+Script to list all commands in order to compare the changes
+
+From the softlayer-python root directory, do the following after making changes.
+
+```
+cd cliChecker
+py checker.py
+```

cliChecker/checker.py

@@ -0,0 +1,94 @@
+from SoftLayer.CLI import environment
+from click.testing import CliRunner
+from SoftLayer.CLI.core import cli
+
+runner = CliRunner()
+env = environment.Environment()
+env.load()
+TopLevelCommands = env.list_commands()
+
+
+def findHelp(Table):
+    for row in Table:
+        if '--help' in row:
+            return True
+    return False
+
+
+def findCorrectFlagTable(arrayCommandByLine):
+    cont = 0
+    arrayTable = []
+    for line in arrayCommandByLine:
+        if '─' in line:
+            cont += 1
+        if cont == 2:
+            if not findHelp(arrayTable):
+                arrayTable = []
+            cont = 0
+        if '│' in line:
+            arrayTable.append(line)
+    return arrayTable
+
+
+def getFlags(arrayCommandByLine):
+    flags = []
+    arrayFlagsTable = findCorrectFlagTable(arrayCommandByLine)
+
+    for line in arrayFlagsTable:
+        arrayFlags = line.split('│')
+        if arrayFlags[1].strip() != '':
+            flags.append('{},{}: {}'.format(arrayFlags[1].strip(), arrayFlags[2].strip(), arrayFlags[3].strip()))
+        else:
+            flags.append('{}: {}'.format(arrayFlags[2].strip(), arrayFlags[3].strip()))
+    return flags
+
+
+def findCommandNested(arrayCommandByLine):
+    commandNested = False
+    commands = []
+    for line in arrayCommandByLine:
+        if commandNested:
+            nestedCommand = line.split(' ')
+            commands.append(nestedCommand[2])
+        if 'Commands:' in line:
+            commandNested = True
+    return commands
+
+
+def printCommandName(TopLevelCommand, command, nestedCommandName=''):
+    if nestedCommandName != '':
+        f.write('slcli {} {} {}\n'.format(TopLevelCommand, command, nestedCommandName))
+    else:
+        f.write('slcli {} {}\n'.format(TopLevelCommand, command))
+
+
+def printBody(commandArray):
+    for flag in getFlags(commandArray):
+        f.write('\tFlag: {}\n'.format(flag))
+    f.write("\t--------------------------------\n")
+    f.write('\tDescription: {}\n'.format(commandArray[2].strip()))
+    f.write("\t--------------------------------\n")
+    f.write('\tUsage: {}\n'.format(commandArray[0]))
+    f.write("==============================================================\n")
+
+
+# Main Function
+with open('output.txt', "w", encoding="utf-8") as f:
+    f.write('SLCLI Command Directory\n')
+    f.write("==============================================================\n")
+
+    for TopLevelCommand in TopLevelCommands:
+        commands = env.list_commands(TopLevelCommand)
+        for command in commands:
+            result = runner.invoke(cli, [TopLevelCommand, command, '--help'])
+            commandArray = result.output.splitlines()
+            nestedCommands = findCommandNested(commandArray)
+            if len(nestedCommands) != 0:
+                for nestedCommand in nestedCommands:
+                    result = runner.invoke(cli, [TopLevelCommand, command, nestedCommand, '--help'])
+                    commandArray = result.output.splitlines()
+                    printCommandName(TopLevelCommand, command, nestedCommand)
+                    printBody(commandArray)
+            else:
+                printCommandName(TopLevelCommand, command)
+                printBody(commandArray)