Package com.mysql.cj.jdbc.util

Class BaseBugReport

java.lang.Object
com.mysql.cj.jdbc.util.BaseBugReport
public abstract class BaseBugReport
extends java.lang.Object
Base class to help file bug reports for Connector/J.

MySQL AB, 2008 Sun Microsystems, 2009 Oracle Corporation really appreciates repeatable testcases when reporting bugs, so we're giving you this class to make that job a bit easier (and standarized).

To create a testcase, create a class that inherits from this class (com.mysql.cj.jdbc.util.BaseBugReport), and override the methods 'setUp', 'tearDown' and 'runTest'.

In the 'setUp' method, create code that creates your tables, and populates them with any data needed to demonstrate the bug.

In the 'runTest' method, create code that demonstrates the bug using the tables and data you created in the 'setUp' method.

In the 'tearDown' method, drop any tables you created in the 'setUp' method.

In any of the above three methods, you should use one of the variants of the 'getConnection' method to create a JDBC connection to MySQL, which will use the default JDBC URL of 'jdbc:mysql:///test'.

If you need to use a JDBC URL that is different than 'jdbc:mysql:///test', then override the method 'getUrl' as well.

Use the 'assertTrue' methods to create conditions that must be met in your testcase demonstrating the behavior you are expecting (vs. the behavior you are observing, which is why you are most likely filing a bug report).

Finally, create a 'main' method that creates a new instance of your testcase, and calls the 'run' method: 

 public static void main(String[] args) throws Exception {
     new MyBugReport().run();
 }

When filing a potential bug with MySQL Connector/J at http://bugs.mysql.com/ or on the bugs mailing list, please include the code that you have just written using this class.

  • Constructor Summary

    Constructors 
    Constructor Description
    BaseBugReport()
    Constructor for this BugReport, sets up JDBC driver used to create connections.

  • Method Summary

    Modifier and Type Method Description
    protected void assertTrue​(boolean condition)
    Throws an exception if condition evalutates to 'false'.
    protected void assertTrue​(java.lang.String message, boolean condition)
    Throws an exception with the given message if condition evalutates to 'false'.
    java.sql.Connection getConnection()
    Provides a connection to the JDBC URL specified in getUrl().
    java.sql.Connection getConnection​(java.lang.String url)
    Returns a connection using the given URL.
    java.sql.Connection getConnection​(java.lang.String url, java.util.Properties props)
    Returns a connection using the given URL and properties.
    java.sql.Connection getNewConnection()
    Use this if you need to get a new connection for your bug report (i.e.
    java.lang.String getUrl()
    Provides the JDBC URL to use to demonstrate the bug.
    void run()
    Runs the testcase by calling the setUp(), runTest() and tearDown() methods.
    abstract void runTest()
    Override this method with code that demonstrates the bug.
    abstract void setUp()
    Override this method with code that sets up the testcase for demonstrating your bug (creating tables, populating data, etc).
    abstract void tearDown()
    Override this method with code that cleans up anything created in the setUp() method.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • BaseBugReport

      public BaseBugReport()
      Constructor for this BugReport, sets up JDBC driver used to create connections.

  • Method Details

    • setUp

      public abstract void setUp() throws java.lang.Exception
      Override this method with code that sets up the testcase for demonstrating your bug (creating tables, populating data, etc).
      Throws:
      java.lang.Exception - if an error occurs during the 'setUp' phase.

    • tearDown

      public abstract void tearDown() throws java.lang.Exception
      Override this method with code that cleans up anything created in the setUp() method.
      Throws:
      java.lang.Exception - if an error occurs during the 'tearDown' phase.

    • runTest

      public abstract void runTest() throws java.lang.Exception
      Override this method with code that demonstrates the bug. This method will be called after setUp(), and before tearDown().
      Throws:
      java.lang.Exception - if an error occurs during your test run.

    • run

      public final void run() throws java.lang.Exception
      Runs the testcase by calling the setUp(), runTest() and tearDown() methods. The tearDown() method is run regardless of any errors occuring in the other methods.
      Throws:
      java.lang.Exception - if an error occurs in any of the aforementioned methods.

    • assertTrue

      protected final void assertTrue​(java.lang.String message, boolean condition) throws java.lang.Exception
      Throws an exception with the given message if condition evalutates to 'false'.
      Parameters:
      message - the message to use in the exception
      condition - the condition to test for
      Throws:
      java.lang.Exception - if !condition

    • assertTrue

      protected final void assertTrue​(boolean condition) throws java.lang.Exception
      Throws an exception if condition evalutates to 'false'.
      Parameters:
      condition - the condition to test for
      Throws:
      java.lang.Exception - if !condition

    • getUrl

      public java.lang.String getUrl()
      Provides the JDBC URL to use to demonstrate the bug. The java.sql.Connection that you use to demonstrate this bug will be provided by the getConnection() method using this URL. The default value is 'jdbc:mysql:aws:///test'
      Returns:
      URL

    • getConnection

      public final java.sql.Connection getConnection() throws java.sql.SQLException
      Provides a connection to the JDBC URL specified in getUrl(). If a connection already exists, that connection is returned. Otherwise a new connection is created.
      Returns:
      a connection to the JDBC URL specified in getUrl().
      Throws:
      java.sql.SQLException - if an error is caused while creating the connection.

    • getNewConnection

      public final java.sql.Connection getNewConnection() throws java.sql.SQLException
      Use this if you need to get a new connection for your bug report (i.e. there's more than one connection involved).
      Returns:
      a new connection to the JDBC URL specified in getUrl().
      Throws:
      java.sql.SQLException - if an error is caused while creating the connection.

    • getConnection

      public final java.sql.Connection getConnection​(java.lang.String url) throws java.sql.SQLException
      Returns a connection using the given URL.
      Parameters:
      url - the JDBC URL to use
      Returns:
      a new java.sql.Connection to the JDBC URL.
      Throws:
      java.sql.SQLException - if an error occurs getting the connection.

    • getConnection

      public final java.sql.Connection getConnection​(java.lang.String url, java.util.Properties props) throws java.sql.SQLException
      Returns a connection using the given URL and properties.
      Parameters:
      url - the JDBC URL to use
      props - the JDBC properties to use
      Returns:
      a new java.sql.Connection to the JDBC URL.
      Throws:
      java.sql.SQLException - if an error occurs getting the connection.