Java: Add dry-run optional paramteter to generator script.

michaelnebel · michaelnebel · commit 1ac988323a89 · 2022-03-23T10:35:31.000+01:00
diff --git a/java/ql/src/utils/model-generator/generate_flow_model.py b/java/ql/src/utils/model-generator/generate_flow_model.py
@@ -11,7 +11,7 @@
 
 def printHelp():
     print("""Usage:
-python3 GenerateFlowModel.py <library-database> <outputQll> [--with-sinks] [--with-sources] [--with-summaries]
+python3 GenerateFlowModel.py <library-database> <outputQll> [--with-sinks] [--with-sources] [--with-summaries] [--dry-run]
 
 This generates summary, source and sink models for the code in the database.
 The files will be placed in `java/ql/lib/semmle/code/java/frameworks/<outputQll>` where
@@ -24,6 +24,8 @@ def printHelp():
     --with-summaries
 If none of these flags are specified, all models are generated.
 
+    --dry-run: Only run the queries, but don't write to file.
+
 Example invocations:
 $ python3 GenerateFlowModel.py /tmp/dbs/apache_commons-codec_45649c8 "apache/Codec.qll"
 $ python3 GenerateFlowModel.py /tmp/dbs/jdk15_db "javase/jdk_sinks.qll" --with-sinks
@@ -39,6 +41,8 @@ def printHelp():
 generateSinks = False
 generateSources = False
 generateSummaries = False
+dryRun = False
+
 if "--with-sinks" in sys.argv:
     sys.argv.remove("--with-sinks")
     generateSinks = True
@@ -51,6 +55,10 @@ def printHelp():
     sys.argv.remove("--with-summaries")
     generateSummaries = True
 
+if "--dry-run" in sys.argv:
+    sys.argv.remove("--dry-run")
+    dryRun = True
+
 if not generateSinks and not generateSources and not generateSummaries:
     generateSinks = generateSources = generateSummaries = True
 
@@ -165,6 +173,10 @@ def asCsvModel(superclass, kind, rows):
 qllContents = qllTemplate.format(shortname, sinkCsv, sourceCsv, summaryCsv)
 
 
+if dryRun:
+    print("CSV Models generated, but not written to file.")
+    sys.exit(0)
+
 with open(frameworkTarget, "w") as frameworkQll:
     frameworkQll.write(qllContents)
 
