Java: Ignore char array based closeables for CloseReader.ql and CloseWriter.ql

Marcono1234 · Marcono1234 · commit 2e098f050e07 · 2021-05-10T18:33:07.000+02:00
diff --git a/java/ql/src/Likely Bugs/Resource Leaks/CloseReader.qhelp b/java/ql/src/Likely Bugs/Resource Leaks/CloseReader.qhelp
@@ -14,7 +14,7 @@ but not closed may cause a resource leak.
 
 <p>Ensure that the resource is always closed to avoid a resource leak. Note that, because of exceptions,
 it is safest to close a resource in a <code>finally</code> block. (However, this is unnecessary for
-subclasses of <code>StringReader</code> and <code>ByteArrayInputStream</code>.)
+subclasses of <code>CharArrayReader</code>, <code>StringReader</code> and <code>ByteArrayInputStream</code>.)
 </p>
 
 <p>For Java 7 or later, the recommended way to close resources that implement <code>java.lang.AutoCloseable</code>
diff --git a/java/ql/src/Likely Bugs/Resource Leaks/CloseReader.ql b/java/ql/src/Likely Bugs/Resource Leaks/CloseReader.ql
@@ -17,17 +17,14 @@ import CloseType
 
 predicate readerType(RefType t) {
   exists(RefType sup | sup = t.getASupertype*() |
-    sup.hasName("Reader") or
-    sup.hasName("InputStream") or
+    sup.hasName(["Reader", "InputStream"]) or
     sup.hasQualifiedName("java.util.zip", "ZipFile")
   )
 }
 
 predicate safeReaderType(RefType t) {
   exists(RefType sup | sup = t.getASupertype*() |
-    sup.hasName("StringReader") or
-    sup.hasName("ByteArrayInputStream") or
-    sup.hasName("StringInputStream")
+    sup.hasName(["CharArrayReader", "StringReader", "ByteArrayInputStream"])
   )
 }
 
diff --git a/java/ql/src/Likely Bugs/Resource Leaks/CloseWriter.qhelp b/java/ql/src/Likely Bugs/Resource Leaks/CloseWriter.qhelp
@@ -14,7 +14,7 @@ but not properly closed later may cause a resource leak.
 
 <p>Ensure that the resource is always closed to avoid a resource leak. Note that, because of exceptions,
 it is safest to close a resource properly in a <code>finally</code> block. (However, this is unnecessary for
-subclasses of <code>StringWriter</code> and <code>ByteArrayOutputStream</code>.)</p>
+subclasses of <code>CharArrayWriter</code>, <code>StringWriter</code> and <code>ByteArrayOutputStream</code>.)</p>
 
 <p>For Java 7 or later, the recommended way to close resources that implement <code>java.lang.AutoCloseable</code>
 is to declare them within a <code>try-with-resources</code> statement, so that they are closed implicitly.</p>
diff --git a/java/ql/src/Likely Bugs/Resource Leaks/CloseWriter.ql b/java/ql/src/Likely Bugs/Resource Leaks/CloseWriter.ql
@@ -16,16 +16,12 @@
 import CloseType
 
 predicate writerType(RefType t) {
-  exists(RefType sup | sup = t.getASupertype*() |
-    sup.hasName("Writer") or
-    sup.hasName("OutputStream")
-  )
+  exists(RefType sup | sup = t.getASupertype*() | sup.hasName(["Writer", "OutputStream"]))
 }
 
 predicate safeWriterType(RefType t) {
   exists(RefType sup | sup = t.getASupertype*() |
-    sup.hasName("StringWriter") or
-    sup.hasName("ByteArrayOutputStream")
+    sup.hasName(["CharArrayWriter", "StringWriter", "ByteArrayOutputStream"])
   )
 }
 

Original file line number	Diff line number	Diff line change
`@@ -17,17 +17,14 @@ import CloseType`
`17`	`17`
`18`	`18`	`predicate readerType(RefType t) {`
`19`	`19`	`exists(RefType sup \| sup = t.getASupertype*() \|`
`20`		`- sup.hasName("Reader") or`
`21`		`- sup.hasName("InputStream") or`
	`20`	`+ sup.hasName(["Reader", "InputStream"]) or`
`22`	`21`	`sup.hasQualifiedName("java.util.zip", "ZipFile")`
`23`	`22`	`)`
`24`	`23`	`}`
`25`	`24`
`26`	`25`	`predicate safeReaderType(RefType t) {`
`27`	`26`	`exists(RefType sup \| sup = t.getASupertype*() \|`
`28`		`- sup.hasName("StringReader") or`
`29`		`- sup.hasName("ByteArrayInputStream") or`
`30`		`- sup.hasName("StringInputStream")`
	`27`	`+ sup.hasName(["CharArrayReader", "StringReader", "ByteArrayInputStream"])`
`31`	`28`	`)`
`32`	`29`	`}`
`33`	`30`
Original file line number	Diff line number	Diff line change
`@@ -16,16 +16,12 @@`
`16`	`16`	`import CloseType`
`17`	`17`
`18`	`18`	`predicate writerType(RefType t) {`
`19`		`- exists(RefType sup \| sup = t.getASupertype*() \|`
`20`		`- sup.hasName("Writer") or`
`21`		`- sup.hasName("OutputStream")`
`22`		`- )`
	`19`	`+ exists(RefType sup \| sup = t.getASupertype*() \| sup.hasName(["Writer", "OutputStream"]))`
`23`	`20`	`}`
`24`	`21`
`25`	`22`	`predicate safeWriterType(RefType t) {`
`26`	`23`	`exists(RefType sup \| sup = t.getASupertype*() \|`
`27`		`- sup.hasName("StringWriter") or`
`28`		`- sup.hasName("ByteArrayOutputStream")`
	`24`	`+ sup.hasName(["CharArrayWriter", "StringWriter", "ByteArrayOutputStream"])`
`29`	`25`	`)`
`30`	`26`	`}`
`31`	`27`