go-sql-driver/mysql

Logger interface compatible with testing package

Open

#593 opened on May 16, 2017

View on GitHub
 (4 comments) (1 reaction) (0 assignees)Go (9,946 stars) (1,789 forks)batch import
help wanted

Description

Issue description

It would be convenient if the Logger interface was compatible with the testing logger (Logf).

Example code

func TestMyTest(t *testing.T) {
// start mysql in a test with a container for instance
// test polls mysql waiting for the connection to come up
// meanwhile go-sql-driver/mysql dumps errors into the testing package
  someCodeSucceeds
// testing does not report log statements
}

Error log

mysql dumps messages into the terminal regardless of testing success or failure
[mysql] 2017/05/16 15:46:20 packets.go:33: unexpected EOF
[mysql] 2017/05/16 15:46:20 packets.go:33: unexpected EOF
[mysql] 2017/05/16 15:46:20 packets.go:33: unexpected EOF
[mysql] 2017/05/16 15:46:21 packets.go:33: unexpected EOF
[mysql] 2017/05/16 15:46:21 packets.go:33: unexpected EOF
[mysql] 2017/05/16 15:46:21 packets.go:33: unexpected EOF
[mysql] 2017/05/16 15:46:22 packets.go:33: unexpected EOF
[mysql] 2017/05/16 15:46:22 packets.go:33: unexpected EOF
[mysql] 2017/05/16 15:46:22 packets.go:33: unexpected EOF

Configuration

Driver version (or git SHA): 1.3.0 Go version: run go version in your console 1.8.1 Server version: E.g. MySQL 5.6, MariaDB 10.0.20 MySQL 5.6 Server OS: E.g. Debian 8.1 (Jessie), Windows 10 Oracle Linux 7

Contributor guide

Tech stack
go
Domain
testingdeveloper experience
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Go programming languagefamiliarity with testing packageunderstanding of current Logger interface
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Examine the current Logger interface in the go sql driver/mysql repository, typically defined in a file like 'log.go'. Understand how the driver currently logs messages and how the testing package's Logf method is used. The issue requests compatibility so that log output is captured during tests. Research the existing logger implementation and propose a change that allows the logger to be set to a testing.TB's Logf method, similar to how other Go libraries integrate with testing. Look at comments in the issue for any additional context or preferences.