Github user ghelmling commented on a diff in the pull request:
https://github.com/apache/incubator-twill/pull/33#discussion_r30763394
--- Diff: twill-yarn/src/test/java/org/apache/twill/yarn/TwillTester.java
---
@@ -37,67 +38,61 @@
import java.io.File;
import java.io.IOException;
import java.util.List;
-import java.util.concurrent.TimeUnit;
-import java.util.concurrent.atomic.AtomicBoolean;
/**
- * Utilities for testing YARN.
+ * A TwillTester rule allows creation of mini Yarn cluster and {@link
TwillRunner} used for testing that is
+ * guaranteed to be teared down when tests are done.
+ *
+ * <pre>
+ * public class TwillTest {
+ * @ClassRule
+ * public static final TwillTester TWILL_TESTER = new TwillTester();
+ *
+ * @Test
+ * public void test() {
+ * TwillRunner twillRunner = TWILL_TESTER.getTwillRunner();
+ * twillRunner.prepare(...).start();
+ * }
+ * }
+ * </pre>
*/
-public final class YarnTestUtils {
--- End diff --
Is YarnTestUtils likely to be used by any current Twill users? Is so, it
would be better to deprecate it, and add TwillTest as a new class. This would
allow any potential users time to transition.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at [email protected] or file a JIRA ticket
with INFRA.
---
