java inline expectations prototype with tests

Author: ginsbach

java/ql/test/TestUtilities/JavaInlineExpectations.ql

@@ -0,0 +1,88 @@
+import java
+
+externalpredicatequeryResults(stringrelation,introw,intcolumn,stringdata);
+
+stringactualLines(){
+exists(inti|
+queryResults("#select",i, _, _)and
+result=
+" | "+
+concat(intj,stringcell|queryResults("#select",i,j,cell)|cell," | "orderbyj)+
+" | "
+)
+}
+
+predicateparsedExpectedResults(stringfilename,intline,stringcontent){
+exists(Javadocdoc|
+isEolComment(doc)and
+filename=doc.getLocation().getFile().getBaseName()and
+line=doc.getLocation().getStartLine()and
+line=doc.getLocation().getEndLine()and
+content=doc.getChild(0).getText().trim()
+)
+}
+
+predicateexpectError(stringfilename,intline){
+exists(stringcontent|
+parsedExpectedResults(filename,line,content)andcontent.indexOf("NOT OK")=0
+)
+}
+
+predicateexpectPass(stringfilename,intline){
+exists(stringcontent|
+parsedExpectedResults(filename,line,content)andcontent.indexOf("OK")=0
+)
+}
+
+predicateparsedActualResults(stringfilename,intline,intcolStart,intcolEnd,stringcontent){
+exists(strings,stringposString,stringlineString|
+s=actualLines()and
+posString=s.substring(s.indexOf("|",0,0)+1,s.indexOf("|",1,0)).trim()and
+filename=posString.substring(0,posString.indexOf(":",0,0))and
+lineString=posString.substring(posString.indexOf(":",0,0)+1,posString.indexOf(":",1,0))and
+lineString=posString.substring(posString.indexOf(":",2,0)+1,posString.indexOf(":",3,0))and
+colStart=
+posString.substring(posString.indexOf(":",1,0)+1,posString.indexOf(":",2,0)).toInt()and
+colEnd=posString.substring(posString.indexOf(":",3,0)+1,posString.length()).toInt()and
+line=lineString.toInt()and
+content=s.substring(s.indexOf("|",2,0)+1,s.indexOf("|",3,0))
+)
+}
+
+predicateactualExpectedDiff(stringtype,stringposition,stringerror){
+exists(stringfilename,intline,intcolStart,intcolEnd|
+parsedActualResults(filename,line,colStart,colEnd,error)and
+expectPass(filename,line)and
+type="unexpected alert"and
+position=filename+":"+line+":"+colStart+":"+line+":"+colEnd
+)
+or
+exists(stringfilename,intline|
+expectError(filename,line)and
+notparsedActualResults(filename,line, _, _, _)and
+type="expected alert"and
+position=filename+":"+lineand
+parsedExpectedResults(filename,line,error)
+)
+or
+exists(stringfilename,intline,stringcontent|
+parsedExpectedResults(filename,line,content)and
+notexpectPass(filename,line)and
+notexpectError(filename,line)and
+type="invalid inline expectation"and
+position=filename+":"+lineand
+error=content
+)
+}
+
+fromintline,stringposition,intcolumn,stringcontent
+where
+position=rank[line](stringp|actualExpectedDiff(_,p, _)|p)and
+(
+column=0andcontent=position
+or
+column=1andactualExpectedDiff(content,position, _)
+or
+column=2andactualExpectedDiff(_,position,content)
+)
+select"#select",line,column,content

java/ql/test/TestUtilities/ProblematicJavaInlineExpectations1.ql

@@ -0,0 +1 @@
+querypredicateresultRelations(stringname){name="#select"}

java/ql/test/TestUtilities/ProblematicJavaInlineExpectations2.ql

@@ -0,0 +1,3 @@
+querypredicatelearnEdits(stringname){none()}
+
+select"#select",1,1,"foo"

java/ql/test/TestUtilities/ProblematicJavaInlineExpectations3.ql

@@ -0,0 +1,3 @@
+querypredicateextraQuery(stringname){none()}
+
+select"#select",1,1,"foo"

java/ql/test/TestUtilities/ProblematicJavaInlineExpectations4.ql

@@ -0,0 +1,3 @@
+querypredicateresultRelations(stringname,intarity){name="#select"andarity=5}
+
+select"#select",1,1,"foo"

java/ql/test/TestUtilities/ProblematicJavaInlineExpectations5.ql

@@ -0,0 +1 @@
+select"#select","1",1,"foo"

java/ql/test/TestUtilities/ProblematicJavaInlineExpectations6.ql

@@ -0,0 +1 @@
+select"#select",1,1,["foo","bar"]

java/ql/test/TestUtilities/ProblematicJavaInlineExpectations7.ql

@@ -0,0 +1,6 @@
+frominti,intj
+where
+iin[1,2]and
+jin[1,2]and
+not(i=2andj=2)
+select"#select",i,j,"foo"

java/ql/test/query-tests/Postprocessing/failing/OverlyLargeRangeQuery.expected

@@ -0,0 +1,2 @@
+query: Security/CWE/CWE-020/OverlyLargeRange.ql
+postprocess: TestUtilities/JavaInlineExpectations.ql