From ccf34f7e45164cea70beccb4cf1b0791e6acde06 Mon Sep 17 00:00:00 2001
From: Mark DePristo <depristo@broadinstitute.org>
Date: Wed, 6 Jul 2011 21:57:22 -0400
Subject: [PATCH] (1) Added very useful helper class TestDataProvider to
 BaseTest that making creating data providers for TestNG far easier (2)
 DiffEngine now officially working with with summaries.  Extensive UnitTests
 all around!

---
 .../org/broadinstitute/sting/BaseTest.java    | 55 +++++++++++++++++++
 1 file changed, 55 insertions(+)

diff --git a/public/java/test/org/broadinstitute/sting/BaseTest.java b/public/java/test/org/broadinstitute/sting/BaseTest.java
index 61bb8b34b..b469c8a41 100755
--- a/public/java/test/org/broadinstitute/sting/BaseTest.java
+++ b/public/java/test/org/broadinstitute/sting/BaseTest.java
@@ -12,6 +12,10 @@ import java.io.*;
 import java.math.BigInteger;
 import java.security.MessageDigest;
 import java.security.NoSuchAlgorithmException;
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
 
 /**
  *
@@ -107,6 +111,57 @@ public abstract class BaseTest {
         }
     }
 
+    /**
+     * Simple generic utility class to creating TestNG data providers:
+     *
+     * 1: inherit this class, as in
+     *
+     *      private class SummarizeDifferenceTest extends TestDataProvider {
+     *         public SummarizeDifferenceTest() {
+     *           super(SummarizeDifferenceTest.class);
+     *         }
+     *         ...
+     *      }
+     *
+     * Provide a reference to your class to the TestDataProvider constructor.
+     *
+     * 2: Create instances of your subclass.  Return from it the call to getTests, providing
+     * the class type of your test
+     *
+     * @DataProvider(name = "summaries")
+     * public Object[][] createSummaries() {
+     *   new SummarizeDifferenceTest().addDiff("A", "A").addSummary("A:2");
+     *   new SummarizeDifferenceTest().addDiff("A", "B").addSummary("A:1", "B:1");
+     *   return SummarizeDifferenceTest.getTests(SummarizeDifferenceTest.class);
+     * }
+     *
+     * This class magically tracks created objects of this
+     */
+    public static class TestDataProvider {
+        private static final Map<Class, List<Object>> tests = new HashMap<Class, List<Object>>();
+
+        /**
+         * Create a new TestDataProvider instance bound to the class variable C
+         * @param c
+         */
+        public TestDataProvider(Class c) {
+            if ( ! tests.containsKey(c) )
+                tests.put(c, new ArrayList<Object>());
+            tests.get(c).add(this);
+        }
+
+        /**
+         * Return all of the data providers in the form expected by TestNG of type class C
+         * @param c
+         * @return
+         */
+        public static Object[][] getTests(Class c) {
+            List<Object[]> params2 = new ArrayList<Object[]>();
+            for ( Object x : tests.get(c) ) params2.add(new Object[]{x});
+            return params2.toArray(new Object[][]{});
+        }
+    }
+
     /**
      * test if the file exists
      *