Use dotnet format to format the output stub file

tamasvajk · tamasvajk · commit cda285de18fb · 2021-06-23T09:26:53.000+02:00
diff --git a/csharp/ql/src/Stubs/make_stubs_nuget.py b/csharp/ql/src/Stubs/make_stubs_nuget.py
@@ -2,10 +2,10 @@
 import os
 import helpers
 
-
-print('Script to generate stub.cs file from a nuget package')
-print('Usage: python ' + sys.argv[0] +
+print('Script to generate stub file from a nuget package')
+print(' Usage: python ' + sys.argv[0] +
       ' NUGET_PACKAGE_NAME [VERSION=latest] [WORK_DIR=tempDir] [OUTPUT_NAME=stub]')
+print(' The script uses the dotnet cli, codeql cli, and dotnet format global tool')
 
 if len(sys.argv) < 2:
     print("\nPlease supply a nuget package name.")
@@ -16,35 +16,42 @@
 nuget = sys.argv[1]
 
 workDir = os.path.abspath(helpers.get_argv(3, "tempDir"))
-projectName = "proj"
-projectDir = os.path.join(workDir, projectName)
+projectNameIn = "input"
+projectDirIn = os.path.join(workDir, projectNameIn)
+
+projectNameOut = "output"
+projectDirOut = os.path.join(workDir, projectNameOut)
 dbName = 'db'
 dbDir = os.path.join(workDir, dbName)
 outputName = helpers.get_argv(4, "stub")
-outputFile = os.path.join(workDir, outputName + '.cs')
-bqrsFile = os.path.join(workDir, outputName + '.bqrs')
+outputFile = os.path.join(projectDirOut, outputName + '.cs')
+bqrsFile = os.path.join(projectDirOut, outputName + '.bqrs')
 version = helpers.get_argv(2, "latest")
 
-print("\nCreating new project")
+print("\n* Creating new input project")
 helpers.run_cmd(['dotnet', 'new', 'classlib', "--language", "C#", '--name',
-                 projectName, '--output', projectDir])
+                 projectNameIn, '--output', projectDirIn])
 
-print("\nAdding reference")
-cmd = ['dotnet', 'add', projectDir, 'package', nuget]
+print("\n* Adding reference to package: " + nuget)
+cmd = ['dotnet', 'add', projectDirIn, 'package', nuget]
 if (version != "latest"):
     cmd.append('--version')
     cmd.append(version)
 helpers.run_cmd(cmd)
 
-print("\nCreating DB")
+print("\n* Creating DB")
 helpers.run_cmd(['codeql', 'database', 'create', dbDir, '--language=csharp',
-                 '--command', 'dotnet build /t:rebuild ' + projectDir])
+                 '--command', 'dotnet build /t:rebuild ' + projectDirIn])
 
 if not os.path.isdir(dbDir):
     print("Expected database directory " + dbDir + " not found.")
     exit(1)
 
-print("\nRunning query")
+print("\n* Creating new output project")
+helpers.run_cmd(['dotnet', 'new', 'classlib', "--language", "C#", '--name',
+                 projectNameOut, '--output', projectDirOut])
+
+print("\n* Running stubbing CodeQL query")
 helpers.run_cmd(['codeql', 'query', 'run', os.path.join(
     thisDir, 'AllStubsFromReference.ql'), '--database', dbDir, '--output', bqrsFile])
 
@@ -53,5 +60,15 @@
 
 helpers.trim_output_file(outputFile)
 
-print("\nOutput: " + outputFile)
+print("\n --> Generated output file: " + outputFile)
+
+print("\n* Formatting file")
+helpers.run_cmd(['dotnet', 'format', projectDirOut,
+                '--include', outputName + '.cs'])
+
+print("\n* Building output project")
+helpers.run_cmd(['dotnet', 'build', '/t:rebuild', projectDirOut],
+                'ERR: Build failed. Script failed to generate a stub that builds')
+
+print("\n --> Generated output file: " + outputFile)
 exit(0)
