Add tests for log frameworks

Author: Sauyon Lee

ql/test/library-tests/semmle/go/concepts/LoggerCall/LoggerCall.expected

@@ -0,0 +1,17 @@
+import go
+import TestUtilities.InlineExpectationsTest
+
+class LoggerTest extends InlineExpectationsTest {
+  LoggerTest() { this = "LoggerTest" }
+
+  override string getARelevantTag() { result = "logger" }
+
+  override predicate hasActualResult(string file, int line, string element, string tag, string value) {
+    exists(LoggerCall log |
+      log.hasLocationInfo(file, line, _, _, _) and
+      element = log.toString() and
+      value = log.getAMessageComponent().toString() and
+      tag = "logger"
+    )
+  }
+}

ql/test/library-tests/semmle/go/concepts/LoggerCall/LoggerCall.ql

@@ -0,0 +1,53 @@
+//go:generate depstubber -vendor github.com/golang/glog "" Error,ErrorDepth,Errorf,Errorln,Exit,ExitDepth,Exitf,Exitln,Fatal,FatalDepth,Fatalf,Fatalln,Info,InfoDepth,Infof,Infoln,Warning,WarningDepth,Warningf,Warningln
+//go:generate depstubber -vendor k8s.io/klog "" Error,ErrorDepth,Errorf,Errorln,Exit,ExitDepth,Exitf,Exitln,Fatal,FatalDepth,Fatalf,Fatalln,Info,InfoDepth,Infof,Infoln,Warning,WarningDepth,Warningf,Warningln
+
+package main
+
+import (
+	"github.com/golang/glog"
+	"k8s.io/klog"
+)
+
+func glogTest() {
+	glog.Error(text)           // $logger=text
+	glog.ErrorDepth(0, text)   // $f-:logger=text
+	glog.Errorf(fmt, text)     // $logger=fmt $logger=text
+	glog.Errorln(text)         // $logger=text
+	glog.Exit(text)            // $logger=text
+	glog.ExitDepth(0, text)    // $f-:logger=text
+	glog.Exitf(fmt, text)      // $logger=fmt $logger=text
+	glog.Exitln(text)          // $logger=text
+	glog.Fatal(text)           // $logger=text
+	glog.FatalDepth(0, text)   // $f-:logger=text
+	glog.Fatalf(fmt, text)     // $logger=fmt $logger=text
+	glog.Fatalln(text)         // $logger=text
+	glog.Info(text)            // $logger=text
+	glog.InfoDepth(0, text)    // $f-:logger=text
+	glog.Infof(fmt, text)      // $logger=fmt $logger=text
+	glog.Infoln(text)          // $logger=text
+	glog.Warning(text)         // $logger=text
+	glog.WarningDepth(0, text) // $f-:logger=text
+	glog.Warningf(fmt, text)   // $logger=fmt $logger=text
+	glog.Warningln(text)       // $logger=text
+
+	klog.Error(text)           // $logger=text
+	klog.ErrorDepth(0, text)   // $f-:logger=text
+	klog.Errorf(fmt, text)     // $logger=fmt $logger=text
+	klog.Errorln(text)         // $logger=text
+	klog.Exit(text)            // $logger=text
+	klog.ExitDepth(0, text)    // $f-:logger=text
+	klog.Exitf(fmt, text)      // $logger=fmt $logger=text
+	klog.Exitln(text)          // $logger=text
+	klog.Fatal(text)           // $logger=text
+	klog.FatalDepth(0, text)   // $f-:logger=text
+	klog.Fatalf(fmt, text)     // $logger=fmt $logger=text
+	klog.Fatalln(text)         // $logger=text
+	klog.Info(text)            // $logger=text
+	klog.InfoDepth(0, text)    // $f-:logger=text
+	klog.Infof(fmt, text)      // $logger=fmt $logger=text
+	klog.Infoln(text)          // $logger=text
+	klog.Warning(text)         // $logger=text
+	klog.WarningDepth(0, text) // $f-:logger=text
+	klog.Warningf(fmt, text)   // $logger=fmt $logger=text
+	klog.Warningln(text)       // $logger=text
+}

ql/test/library-tests/semmle/go/concepts/LoggerCall/glog.go

@@ -0,0 +1,9 @@
+module codeql-go-tests/concepts/loggercall
+
+go 1.15
+
+require (
+	github.com/golang/glog v0.0.0-20160126235308-23def4e6c14b
+	github.com/sirupsen/logrus v1.7.0
+	k8s.io/klog v1.0.0
+)

ql/test/library-tests/semmle/go/concepts/LoggerCall/go.mod

@@ -0,0 +1,34 @@
+//go:generate depstubber -vendor github.com/sirupsen/logrus Fields,LogFunction,Entry WithContext,WithError,WithFields,Error,Fatalf,Panicln,Infof,FatalFn
+
+package main
+
+import (
+	"context"
+	"errors"
+	"github.com/sirupsen/logrus"
+)
+
+func logSomething(entry *logrus.Entry) {
+	entry.Traceln(text) // $logger=text $f-:logger=fields
+}
+
+func logrusCalls() {
+	err := errors.New("Error")
+	var fields logrus.Fields = nil
+	var fn logrus.LogFunction = nil
+	var ctx context.Context
+	tmp := logrus.WithContext(ctx)  //
+	tmp.Debugf(fmt, text)           // $logger=ctx $logger=fmt $logger=text
+	tmp = logrus.WithError(err)     //
+	tmp.Warn(text)                  // $logger=err $logger=text
+	tmp = logrus.WithFields(fields) //
+	tmp.Infoln(text)                // $logger=fields $logger=text
+	tmp = logrus.WithFields(fields) //
+	logSomething(tmp)
+
+	logrus.Error(text)       // $logger=text
+	logrus.Fatalf(fmt, text) // $logger=fmt $logger=text
+	logrus.Panicln(text)     // $logger=text
+	logrus.Infof(fmt, text)  // $logger=fmt $logger=text
+	logrus.FatalFn(fn)       // $logger=fn
+}

ql/test/library-tests/semmle/go/concepts/LoggerCall/logrus.go

@@ -0,0 +1,8 @@
+package main
+
+const fmt = "formatted %s string"
+const text = "test"
+
+func main() {
+
+}

ql/test/library-tests/semmle/go/concepts/LoggerCall/main.go

@@ -0,0 +1,30 @@
+package main
+
+import (
+	"log"
+)
+
+func stdlib() {
+	var logger log.Logger
+	logger.SetPrefix("prefix: ")
+	logger.Fatal(text)       // $logger=text
+	logger.Fatalf(fmt, text) // $logger=fmt $logger=text
+	logger.Fatalln(text)     // $logger=text
+	logger.Panic(text)       // $logger=text
+	logger.Panicf(fmt, text) // $logger=fmt $logger=text
+	logger.Panicln(text)     // $logger=text
+	logger.Print(text)       // $logger=text
+	logger.Printf(fmt, text) // $logger=fmt $logger=text
+	logger.Println(text)     // $logger=text
+
+	log.SetPrefix("prefix: ")
+	log.Fatal(text)       // $logger=text
+	log.Fatalf(fmt, text) // $logger=fmt $logger=text
+	log.Fatalln(text)     // $logger=text
+	log.Panic(text)       // $logger=text
+	log.Panicf(fmt, text) // $logger=fmt $logger=text
+	log.Panicln(text)     // $logger=text
+	log.Print(text)       // $logger=text
+	log.Printf(fmt, text) // $logger=fmt $logger=text
+	log.Println(text)     // $logger=text
+}