Repository: reef Updated Branches: refs/heads/master ba080587f -> 7e2b1e0d5
[REEF-532] Add missing Javadoc/triage TODOs in Java: reef-tests JIRA: [REEF-532](https://issues.apache.org/jira/browse/REEF-532) Pull request: This closes #790 Project: http://git-wip-us.apache.org/repos/asf/reef/repo Commit: http://git-wip-us.apache.org/repos/asf/reef/commit/7e2b1e0d Tree: http://git-wip-us.apache.org/repos/asf/reef/tree/7e2b1e0d Diff: http://git-wip-us.apache.org/repos/asf/reef/diff/7e2b1e0d Branch: refs/heads/master Commit: 7e2b1e0d5794302b93a55b648fae7e75310b84c3 Parents: ba08058 Author: Mariia Mykhailova <[email protected]> Authored: Mon Jan 25 11:23:48 2016 -0800 Committer: Dongjoon Hyun <[email protected]> Committed: Mon Jan 25 12:43:56 2016 -0800 ---------------------------------------------------------------------- lang/java/reef-tests/pom.xml | 11 +++++++ .../driver/RuntimeNameTestConfiguration.java | 6 ++++ .../tests/fail/driver/DriverFailOnFail.java | 12 ++++++++ .../reef/tests/fail/driver/FailDriver.java | 10 ++++++- .../tests/fail/driver/FailDriverDelayedMsg.java | 18 ++++++++++++ .../apache/reef/tests/fail/driver/NoopTask.java | 12 ++++++++ .../org/apache/reef/tests/fail/task/Driver.java | 3 ++ .../reef/tests/fail/task/FailTaskStop.java | 3 ++ .../tests/messaging/driver/DriverMessaging.java | 3 ++ .../messaging/task/TaskMessagingDriver.java | 12 ++++++++ .../tests/messaging/task/TaskMessagingTask.java | 3 ++ .../tests/rack/awareness/RackNameParameter.java | 3 ++ .../apache/reef/tests/statepassing/Counter.java | 3 ++ .../tests/statepassing/StatePassingDriver.java | 3 ++ .../tests/statepassing/StatePassingTask.java | 5 ++-- .../tests/watcher/FailedContextHandler.java | 3 ++ .../tests/watcher/FailedTaskStartHandler.java | 3 ++ .../reef/tests/watcher/IsTaskSuspended.java | 3 ++ .../reef/tests/watcher/TestEventStream.java | 3 ++ .../reef/tests/watcher/WatcherTestDriver.java | 30 ++++++++++++++++++++ .../reef/tests/watcher/WatcherTestTask.java | 6 ++++ .../reef/tests/yarn/failure/FailureDriver.java | 3 ++ .../reef/tests/yarn/failure/FailureREEF.java | 6 ++++ .../org/apache/reef/tests/AllTestsSuite.java | 3 ++ .../java/org/apache/reef/tests/FailureTest.java | 3 ++ .../java/org/apache/reef/tests/TestUtils.java | 3 ++ .../applications/ApplicationTestSuite.java | 3 ++ .../applications/vortex/VortexTestSuite.java | 3 ++ .../EvaluatorSizeTestConfiguration.java | 6 ++++ .../tests/evaluatorsize/MemorySizeTask.java | 2 +- .../apache/reef/tests/fail/FailTestSuite.java | 3 ++ .../FileResourceTestDriverConfiguration.java | 6 ++++ .../FileResourceTestTaskConfiguration.java | 5 +++- .../reef/tests/group/GroupCommTestSuite.java | 3 ++ .../messaging/driver/DriverMessagingTest.java | 3 ++ .../apache/reef/tests/watcher/WatcherTest.java | 3 ++ 36 files changed, 205 insertions(+), 5 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/reef/blob/7e2b1e0d/lang/java/reef-tests/pom.xml ---------------------------------------------------------------------- diff --git a/lang/java/reef-tests/pom.xml b/lang/java/reef-tests/pom.xml index ac4a016..c38bc80 100644 --- a/lang/java/reef-tests/pom.xml +++ b/lang/java/reef-tests/pom.xml @@ -120,6 +120,17 @@ under the License. </executions> </plugin> </plugins> + <pluginManagement> + <plugins> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-checkstyle-plugin</artifactId> + <configuration> + <configLocation>lang/java/reef-common/src/main/resources/checkstyle-strict.xml</configLocation> + </configuration> + </plugin> + </plugins> + </pluginManagement> </build> http://git-wip-us.apache.org/repos/asf/reef/blob/7e2b1e0d/lang/java/reef-tests/src/main/java/org/apache/reef/tests/driver/RuntimeNameTestConfiguration.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-tests/src/main/java/org/apache/reef/tests/driver/RuntimeNameTestConfiguration.java b/lang/java/reef-tests/src/main/java/org/apache/reef/tests/driver/RuntimeNameTestConfiguration.java index 127b54a..4bdba6c 100644 --- a/lang/java/reef-tests/src/main/java/org/apache/reef/tests/driver/RuntimeNameTestConfiguration.java +++ b/lang/java/reef-tests/src/main/java/org/apache/reef/tests/driver/RuntimeNameTestConfiguration.java @@ -24,6 +24,9 @@ import org.apache.reef.tang.formats.ConfigurationModule; import org.apache.reef.tang.formats.ConfigurationModuleBuilder; import org.apache.reef.tang.formats.RequiredParameter; +/** + * Configuration for RuntimeNameTest. + */ public final class RuntimeNameTestConfiguration extends ConfigurationModuleBuilder { public static final RequiredParameter<String> RUNTIME_NAME = new RequiredParameter<>(); @@ -31,6 +34,9 @@ public final class RuntimeNameTestConfiguration extends ConfigurationModuleBuild .bindNamedParameter(RuntimeName.class, RUNTIME_NAME) .build(); + /** + * The runtime name. + */ @NamedParameter(doc = "The runtime name") public static class RuntimeName implements Name<String> { } http://git-wip-us.apache.org/repos/asf/reef/blob/7e2b1e0d/lang/java/reef-tests/src/main/java/org/apache/reef/tests/fail/driver/DriverFailOnFail.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-tests/src/main/java/org/apache/reef/tests/fail/driver/DriverFailOnFail.java b/lang/java/reef-tests/src/main/java/org/apache/reef/tests/fail/driver/DriverFailOnFail.java index 17a6495..a21caf9 100644 --- a/lang/java/reef-tests/src/main/java/org/apache/reef/tests/fail/driver/DriverFailOnFail.java +++ b/lang/java/reef-tests/src/main/java/org/apache/reef/tests/fail/driver/DriverFailOnFail.java @@ -37,6 +37,9 @@ import javax.inject.Inject; import java.util.logging.Level; import java.util.logging.Logger; +/** + * Driver which fails on FailedTask event. + */ @Unit public final class DriverFailOnFail { @@ -51,6 +54,9 @@ public final class DriverFailOnFail { this.requestor = requestor; } + /** + * Handler for AllocatedEvaluator. + */ public final class AllocatedEvaluatorHandler implements EventHandler<AllocatedEvaluator> { @Override public void onNext(final AllocatedEvaluator eval) { @@ -77,6 +83,9 @@ public final class DriverFailOnFail { } } + /** + * Handler for FailedTask. + */ public final class FailedTaskHandler implements EventHandler<FailedTask> { @Override public void onNext(final FailedTask task) throws SimulatedDriverFailure { @@ -87,6 +96,9 @@ public final class DriverFailOnFail { } } + /** + * Handler for StartTime. + */ public final class StartHandler implements EventHandler<StartTime> { @Override public void onNext(final StartTime time) { http://git-wip-us.apache.org/repos/asf/reef/blob/7e2b1e0d/lang/java/reef-tests/src/main/java/org/apache/reef/tests/fail/driver/FailDriver.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-tests/src/main/java/org/apache/reef/tests/fail/driver/FailDriver.java b/lang/java/reef-tests/src/main/java/org/apache/reef/tests/fail/driver/FailDriver.java index 71847b5..c0e6412 100644 --- a/lang/java/reef-tests/src/main/java/org/apache/reef/tests/fail/driver/FailDriver.java +++ b/lang/java/reef-tests/src/main/java/org/apache/reef/tests/fail/driver/FailDriver.java @@ -44,6 +44,9 @@ import java.util.logging.Logger; import static org.apache.reef.tests.fail.driver.FailDriver.ExpectedMessage.RequiredFlag.OPTIONAL; import static org.apache.reef.tests.fail.driver.FailDriver.ExpectedMessage.RequiredFlag.REQUIRED; +/** + * Driver which fails on receiving certain message class. + */ @Unit public final class FailDriver { @@ -155,6 +158,9 @@ public final class FailDriver { public static final class FailMsgClassName implements Name<String> { } + /** + * Expected message class. + */ public static final class ExpectedMessage { private final transient Class<?> msgClass; @@ -172,6 +178,9 @@ public final class FailDriver { return this.repr; } + /** + * "Required" flag for message class. + */ public enum RequiredFlag {OPTIONAL, REQUIRED} } @@ -249,7 +258,6 @@ public final class FailDriver { public void onNext(final FailedContext context) { LOG.log(Level.WARNING, "Context failed: " + context.getId(), context.getReason().orElse(null)); checkMsgOrder(context); - // TODO: notify client? // if (context.getParentContext().isPresent()) { // context.getParentContext().get().close(); http://git-wip-us.apache.org/repos/asf/reef/blob/7e2b1e0d/lang/java/reef-tests/src/main/java/org/apache/reef/tests/fail/driver/FailDriverDelayedMsg.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-tests/src/main/java/org/apache/reef/tests/fail/driver/FailDriverDelayedMsg.java b/lang/java/reef-tests/src/main/java/org/apache/reef/tests/fail/driver/FailDriverDelayedMsg.java index 0294da5..ea32745 100644 --- a/lang/java/reef-tests/src/main/java/org/apache/reef/tests/fail/driver/FailDriverDelayedMsg.java +++ b/lang/java/reef-tests/src/main/java/org/apache/reef/tests/fail/driver/FailDriverDelayedMsg.java @@ -39,6 +39,9 @@ import java.util.Arrays; import java.util.logging.Level; import java.util.logging.Logger; +/** + * Driver which fails due to delayed message. + */ @Unit public final class FailDriverDelayedMsg { @@ -57,6 +60,9 @@ public final class FailDriverDelayedMsg { this.clock = clock; } + /** + * Handler for AllocatedEvaluator. + */ public final class AllocatedEvaluatorHandler implements EventHandler<AllocatedEvaluator> { @Override public void onNext(final AllocatedEvaluator eval) { @@ -72,6 +78,9 @@ public final class FailDriverDelayedMsg { } } + /** + * Handler for ActiveContext. + */ public final class ActiveContextHandler implements EventHandler<ActiveContext> { @Override public void onNext(final ActiveContext context) { @@ -93,6 +102,9 @@ public final class FailDriverDelayedMsg { } } + /** + * Handler for RunningTask. + */ public final class RunningTaskHandler implements EventHandler<RunningTask> { @Override @SuppressWarnings("checkstyle:hiddenfield") @@ -109,6 +121,9 @@ public final class FailDriverDelayedMsg { } } + /** + * Handler for TaskMessage. + */ public final class TaskMessageHandler implements EventHandler<TaskMessage> { @Override public void onNext(final TaskMessage msg) { @@ -118,6 +133,9 @@ public final class FailDriverDelayedMsg { } } + /** + * Handler for StartTime. + */ public final class StartHandler implements EventHandler<StartTime> { @Override public void onNext(final StartTime time) { http://git-wip-us.apache.org/repos/asf/reef/blob/7e2b1e0d/lang/java/reef-tests/src/main/java/org/apache/reef/tests/fail/driver/NoopTask.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-tests/src/main/java/org/apache/reef/tests/fail/driver/NoopTask.java b/lang/java/reef-tests/src/main/java/org/apache/reef/tests/fail/driver/NoopTask.java index 69652f9..19781e8 100644 --- a/lang/java/reef-tests/src/main/java/org/apache/reef/tests/fail/driver/NoopTask.java +++ b/lang/java/reef-tests/src/main/java/org/apache/reef/tests/fail/driver/NoopTask.java @@ -80,6 +80,9 @@ public final class NoopTask implements Task, TaskMessageSource { this.notify(); } + /** + * Handler for SuspendEvent. + */ public class TaskSuspendHandler implements EventHandler<SuspendEvent> { @Override public void onNext(final SuspendEvent suspendEvent) { @@ -88,6 +91,9 @@ public final class NoopTask implements Task, TaskMessageSource { } } + /** + * Handler for TaskStop. + */ public class TaskStopHandler implements EventHandler<TaskStop> { @Override public void onNext(final TaskStop event) { @@ -96,6 +102,9 @@ public final class NoopTask implements Task, TaskMessageSource { } } + /** + * Handler for CloseEvent. + */ public class TaskCloseHandler implements EventHandler<CloseEvent> { @Override public void onNext(final CloseEvent closeEvent) { @@ -104,6 +113,9 @@ public final class NoopTask implements Task, TaskMessageSource { } } + /** + * Handler for DriverMessage. + */ public class DriverMessageHandler implements EventHandler<DriverMessage> { @Override public void onNext(final DriverMessage driverMessage) { http://git-wip-us.apache.org/repos/asf/reef/blob/7e2b1e0d/lang/java/reef-tests/src/main/java/org/apache/reef/tests/fail/task/Driver.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-tests/src/main/java/org/apache/reef/tests/fail/task/Driver.java b/lang/java/reef-tests/src/main/java/org/apache/reef/tests/fail/task/Driver.java index 5eb0f59..d8c9043 100644 --- a/lang/java/reef-tests/src/main/java/org/apache/reef/tests/fail/task/Driver.java +++ b/lang/java/reef-tests/src/main/java/org/apache/reef/tests/fail/task/Driver.java @@ -40,6 +40,9 @@ import javax.inject.Inject; import java.util.logging.Level; import java.util.logging.Logger; +/** + * Universal driver for the test REEF job that fails on different stages of execution. + */ @Unit public final class Driver { http://git-wip-us.apache.org/repos/asf/reef/blob/7e2b1e0d/lang/java/reef-tests/src/main/java/org/apache/reef/tests/fail/task/FailTaskStop.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-tests/src/main/java/org/apache/reef/tests/fail/task/FailTaskStop.java b/lang/java/reef-tests/src/main/java/org/apache/reef/tests/fail/task/FailTaskStop.java index a09da8c..0db1728 100644 --- a/lang/java/reef-tests/src/main/java/org/apache/reef/tests/fail/task/FailTaskStop.java +++ b/lang/java/reef-tests/src/main/java/org/apache/reef/tests/fail/task/FailTaskStop.java @@ -66,6 +66,9 @@ public final class FailTaskStop implements Task, EventHandler<TaskStop> { throw ex; } + /** + * Handler for CloseEvent. + */ public final class CloseEventHandler implements EventHandler<CloseEvent> { @Override public void onNext(final CloseEvent event) { http://git-wip-us.apache.org/repos/asf/reef/blob/7e2b1e0d/lang/java/reef-tests/src/main/java/org/apache/reef/tests/messaging/driver/DriverMessaging.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-tests/src/main/java/org/apache/reef/tests/messaging/driver/DriverMessaging.java b/lang/java/reef-tests/src/main/java/org/apache/reef/tests/messaging/driver/DriverMessaging.java index dfe350d..e126e78 100644 --- a/lang/java/reef-tests/src/main/java/org/apache/reef/tests/messaging/driver/DriverMessaging.java +++ b/lang/java/reef-tests/src/main/java/org/apache/reef/tests/messaging/driver/DriverMessaging.java @@ -33,6 +33,9 @@ import java.nio.charset.StandardCharsets; import java.util.logging.Level; import java.util.logging.Logger; +/** + * Runner for DriverMessagingTest. + */ @Unit public final class DriverMessaging { http://git-wip-us.apache.org/repos/asf/reef/blob/7e2b1e0d/lang/java/reef-tests/src/main/java/org/apache/reef/tests/messaging/task/TaskMessagingDriver.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-tests/src/main/java/org/apache/reef/tests/messaging/task/TaskMessagingDriver.java b/lang/java/reef-tests/src/main/java/org/apache/reef/tests/messaging/task/TaskMessagingDriver.java index ca84327..273a5f9 100644 --- a/lang/java/reef-tests/src/main/java/org/apache/reef/tests/messaging/task/TaskMessagingDriver.java +++ b/lang/java/reef-tests/src/main/java/org/apache/reef/tests/messaging/task/TaskMessagingDriver.java @@ -36,6 +36,9 @@ import java.util.Arrays; import java.util.logging.Level; import java.util.logging.Logger; +/** + * Driver for TaskMessagingTest. + */ @Unit public final class TaskMessagingDriver { @@ -53,6 +56,9 @@ public final class TaskMessagingDriver { this.clock = clock; } + /** + * Handler for AllocatedEvaluator. + */ public final class EvaluatorAllocatedHandler implements EventHandler<AllocatedEvaluator> { @Override @@ -70,6 +76,9 @@ public final class TaskMessagingDriver { } } + /** + * Handler for RunningTask. + */ public final class TaskRunningHandler implements EventHandler<RunningTask> { @Override public void onNext(final RunningTask task) { @@ -83,6 +92,9 @@ public final class TaskMessagingDriver { } } + /** + * Handler for TaskMessage. + */ public final class TaskMessageHandler implements EventHandler<TaskMessage> { @Override public void onNext(final TaskMessage msg) { http://git-wip-us.apache.org/repos/asf/reef/blob/7e2b1e0d/lang/java/reef-tests/src/main/java/org/apache/reef/tests/messaging/task/TaskMessagingTask.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-tests/src/main/java/org/apache/reef/tests/messaging/task/TaskMessagingTask.java b/lang/java/reef-tests/src/main/java/org/apache/reef/tests/messaging/task/TaskMessagingTask.java index 3895c97..841a514 100644 --- a/lang/java/reef-tests/src/main/java/org/apache/reef/tests/messaging/task/TaskMessagingTask.java +++ b/lang/java/reef-tests/src/main/java/org/apache/reef/tests/messaging/task/TaskMessagingTask.java @@ -72,6 +72,9 @@ public final class TaskMessagingTask implements Task, TaskMessageSource { return this.message; } + /** + * Handler for DriverMessage. + */ public class DriverMessageHandler implements EventHandler<DriverMessage> { @Override public void onNext(final DriverMessage driverMessage) { http://git-wip-us.apache.org/repos/asf/reef/blob/7e2b1e0d/lang/java/reef-tests/src/main/java/org/apache/reef/tests/rack/awareness/RackNameParameter.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-tests/src/main/java/org/apache/reef/tests/rack/awareness/RackNameParameter.java b/lang/java/reef-tests/src/main/java/org/apache/reef/tests/rack/awareness/RackNameParameter.java index e6504cd..7246729 100644 --- a/lang/java/reef-tests/src/main/java/org/apache/reef/tests/rack/awareness/RackNameParameter.java +++ b/lang/java/reef-tests/src/main/java/org/apache/reef/tests/rack/awareness/RackNameParameter.java @@ -22,6 +22,9 @@ import org.apache.reef.runtime.local.client.parameters.RackNames; import org.apache.reef.tang.annotations.Name; import org.apache.reef.tang.annotations.NamedParameter; +/** + * Rack name. + */ @NamedParameter(default_value = RackNames.DEFAULT_RACK_NAME, short_name = "rack") public class RackNameParameter implements Name<String> { } http://git-wip-us.apache.org/repos/asf/reef/blob/7e2b1e0d/lang/java/reef-tests/src/main/java/org/apache/reef/tests/statepassing/Counter.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-tests/src/main/java/org/apache/reef/tests/statepassing/Counter.java b/lang/java/reef-tests/src/main/java/org/apache/reef/tests/statepassing/Counter.java index 69e931e..cb9531b 100644 --- a/lang/java/reef-tests/src/main/java/org/apache/reef/tests/statepassing/Counter.java +++ b/lang/java/reef-tests/src/main/java/org/apache/reef/tests/statepassing/Counter.java @@ -20,6 +20,9 @@ package org.apache.reef.tests.statepassing; import javax.inject.Inject; +/** + * Simple counter. + */ public class Counter { private int value = 0; http://git-wip-us.apache.org/repos/asf/reef/blob/7e2b1e0d/lang/java/reef-tests/src/main/java/org/apache/reef/tests/statepassing/StatePassingDriver.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-tests/src/main/java/org/apache/reef/tests/statepassing/StatePassingDriver.java b/lang/java/reef-tests/src/main/java/org/apache/reef/tests/statepassing/StatePassingDriver.java index f87d9e8..bc0627d 100644 --- a/lang/java/reef-tests/src/main/java/org/apache/reef/tests/statepassing/StatePassingDriver.java +++ b/lang/java/reef-tests/src/main/java/org/apache/reef/tests/statepassing/StatePassingDriver.java @@ -34,6 +34,9 @@ import javax.inject.Inject; import java.util.logging.Level; import java.util.logging.Logger; +/** + * Driver for StatePassingTest. + */ @Unit public class StatePassingDriver { http://git-wip-us.apache.org/repos/asf/reef/blob/7e2b1e0d/lang/java/reef-tests/src/main/java/org/apache/reef/tests/statepassing/StatePassingTask.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-tests/src/main/java/org/apache/reef/tests/statepassing/StatePassingTask.java b/lang/java/reef-tests/src/main/java/org/apache/reef/tests/statepassing/StatePassingTask.java index b46bea7..1ef00e0 100644 --- a/lang/java/reef-tests/src/main/java/org/apache/reef/tests/statepassing/StatePassingTask.java +++ b/lang/java/reef-tests/src/main/java/org/apache/reef/tests/statepassing/StatePassingTask.java @@ -24,9 +24,11 @@ import org.apache.reef.task.Task; import javax.inject.Inject; import java.util.Arrays; +/** + * Task for StatePassingTest. + */ public class StatePassingTask implements Task { - private final Counter c; @Inject @@ -41,7 +43,6 @@ public class StatePassingTask implements Task { return result; } - @Override public byte[] call(final byte[] memento) throws Exception { this.c.increment(); http://git-wip-us.apache.org/repos/asf/reef/blob/7e2b1e0d/lang/java/reef-tests/src/main/java/org/apache/reef/tests/watcher/FailedContextHandler.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-tests/src/main/java/org/apache/reef/tests/watcher/FailedContextHandler.java b/lang/java/reef-tests/src/main/java/org/apache/reef/tests/watcher/FailedContextHandler.java index 808a7d8..0deebc8 100644 --- a/lang/java/reef-tests/src/main/java/org/apache/reef/tests/watcher/FailedContextHandler.java +++ b/lang/java/reef-tests/src/main/java/org/apache/reef/tests/watcher/FailedContextHandler.java @@ -23,6 +23,9 @@ import org.apache.reef.wake.EventHandler; import javax.inject.Inject; +/** + * Failing handler for ContextStart (throws exception upon start). + */ public final class FailedContextHandler implements EventHandler<ContextStart> { @Inject http://git-wip-us.apache.org/repos/asf/reef/blob/7e2b1e0d/lang/java/reef-tests/src/main/java/org/apache/reef/tests/watcher/FailedTaskStartHandler.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-tests/src/main/java/org/apache/reef/tests/watcher/FailedTaskStartHandler.java b/lang/java/reef-tests/src/main/java/org/apache/reef/tests/watcher/FailedTaskStartHandler.java index 633a76b..de5bf41 100644 --- a/lang/java/reef-tests/src/main/java/org/apache/reef/tests/watcher/FailedTaskStartHandler.java +++ b/lang/java/reef-tests/src/main/java/org/apache/reef/tests/watcher/FailedTaskStartHandler.java @@ -23,6 +23,9 @@ import org.apache.reef.wake.EventHandler; import javax.inject.Inject; +/** + * Failing handler for TaskStart (throws exception upon start). + */ public final class FailedTaskStartHandler implements EventHandler<TaskStart> { @Inject http://git-wip-us.apache.org/repos/asf/reef/blob/7e2b1e0d/lang/java/reef-tests/src/main/java/org/apache/reef/tests/watcher/IsTaskSuspended.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-tests/src/main/java/org/apache/reef/tests/watcher/IsTaskSuspended.java b/lang/java/reef-tests/src/main/java/org/apache/reef/tests/watcher/IsTaskSuspended.java index a40efb7..9fa6e5c 100644 --- a/lang/java/reef-tests/src/main/java/org/apache/reef/tests/watcher/IsTaskSuspended.java +++ b/lang/java/reef-tests/src/main/java/org/apache/reef/tests/watcher/IsTaskSuspended.java @@ -21,6 +21,9 @@ package org.apache.reef.tests.watcher; import org.apache.reef.tang.annotations.Name; import org.apache.reef.tang.annotations.NamedParameter; +/** + * Boolean value, true = task is suspended. + */ @NamedParameter(default_value = "false") public final class IsTaskSuspended implements Name<Boolean> { } http://git-wip-us.apache.org/repos/asf/reef/blob/7e2b1e0d/lang/java/reef-tests/src/main/java/org/apache/reef/tests/watcher/TestEventStream.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-tests/src/main/java/org/apache/reef/tests/watcher/TestEventStream.java b/lang/java/reef-tests/src/main/java/org/apache/reef/tests/watcher/TestEventStream.java index 8917e4b..3676f3a 100644 --- a/lang/java/reef-tests/src/main/java/org/apache/reef/tests/watcher/TestEventStream.java +++ b/lang/java/reef-tests/src/main/java/org/apache/reef/tests/watcher/TestEventStream.java @@ -26,6 +26,9 @@ import java.util.HashMap; import java.util.Map; import java.util.concurrent.atomic.AtomicInteger; +/** + * Count events in the stream. + */ public final class TestEventStream implements EventStream { private Map<EventType, AtomicInteger> eventCounter; http://git-wip-us.apache.org/repos/asf/reef/blob/7e2b1e0d/lang/java/reef-tests/src/main/java/org/apache/reef/tests/watcher/WatcherTestDriver.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-tests/src/main/java/org/apache/reef/tests/watcher/WatcherTestDriver.java b/lang/java/reef-tests/src/main/java/org/apache/reef/tests/watcher/WatcherTestDriver.java index 70059f7..7e9ab01 100644 --- a/lang/java/reef-tests/src/main/java/org/apache/reef/tests/watcher/WatcherTestDriver.java +++ b/lang/java/reef-tests/src/main/java/org/apache/reef/tests/watcher/WatcherTestDriver.java @@ -39,6 +39,9 @@ import org.apache.reef.wake.time.runtime.event.RuntimeStop; import javax.inject.Inject; import java.util.concurrent.atomic.AtomicBoolean; +/** + * Driver for WatcherTest. + */ @Unit public final class WatcherTestDriver { @@ -67,6 +70,9 @@ public final class WatcherTestDriver { this.isFirstTask = new AtomicBoolean(true); } + /** + * Handler for StartTime. + */ public final class DriverStartedHandler implements EventHandler<StartTime> { @Override @@ -80,6 +86,9 @@ public final class WatcherTestDriver { } } + /** + * Handler for AllocatedEvaluator. + */ public final class EvaluatorAllocatedHandler implements EventHandler<AllocatedEvaluator> { @Override @@ -94,6 +103,9 @@ public final class WatcherTestDriver { } } + /** + * Handler for FailedEvaluator. + */ public final class EvaluatorFailedHandler implements EventHandler<FailedEvaluator> { @Override @@ -102,6 +114,9 @@ public final class WatcherTestDriver { } } + /** + * Handler for ActiveContext. + */ public final class ContextActivatedHandler implements EventHandler<ActiveContext> { @Override @@ -116,6 +131,9 @@ public final class WatcherTestDriver { } } + /** + * Handler for FailedContext. + */ public final class ContextFailedHandler implements EventHandler<FailedContext> { @Override @@ -124,6 +142,9 @@ public final class WatcherTestDriver { } } + /** + * Handler for RunningTask. + */ public final class TaskRunningHandler implements EventHandler<RunningTask> { @Override @@ -134,6 +155,9 @@ public final class WatcherTestDriver { } } + /** + * Handler for FailedTask. + */ public final class TaskFailedHandler implements EventHandler<FailedTask> { @Override @@ -142,6 +166,9 @@ public final class WatcherTestDriver { } } + /** + * Handler for SuspendedTask. + */ public final class TaskSuspendedHandler implements EventHandler<SuspendedTask> { @Override @@ -150,6 +177,9 @@ public final class WatcherTestDriver { } } + /** + * Handler for RuntimeStop. + */ public final class RuntimeStopHandler implements EventHandler<RuntimeStop> { @Override http://git-wip-us.apache.org/repos/asf/reef/blob/7e2b1e0d/lang/java/reef-tests/src/main/java/org/apache/reef/tests/watcher/WatcherTestTask.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-tests/src/main/java/org/apache/reef/tests/watcher/WatcherTestTask.java b/lang/java/reef-tests/src/main/java/org/apache/reef/tests/watcher/WatcherTestTask.java index d581749..543449d 100644 --- a/lang/java/reef-tests/src/main/java/org/apache/reef/tests/watcher/WatcherTestTask.java +++ b/lang/java/reef-tests/src/main/java/org/apache/reef/tests/watcher/WatcherTestTask.java @@ -31,6 +31,9 @@ import org.apache.reef.wake.EventHandler; import javax.inject.Inject; import java.nio.charset.Charset; +/** + * Task for WatcherTest. + */ @Unit public final class WatcherTestTask implements Task, TaskMessageSource { @@ -68,6 +71,9 @@ public final class WatcherTestTask implements Task, TaskMessageSource { return Optional.of(taskMessage); } + /** + * Handler for SuspendEvent. + */ public final class TaskSuspendedHandler implements EventHandler<SuspendEvent> { @Override http://git-wip-us.apache.org/repos/asf/reef/blob/7e2b1e0d/lang/java/reef-tests/src/main/java/org/apache/reef/tests/yarn/failure/FailureDriver.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-tests/src/main/java/org/apache/reef/tests/yarn/failure/FailureDriver.java b/lang/java/reef-tests/src/main/java/org/apache/reef/tests/yarn/failure/FailureDriver.java index 57add74..037b2c2 100644 --- a/lang/java/reef-tests/src/main/java/org/apache/reef/tests/yarn/failure/FailureDriver.java +++ b/lang/java/reef-tests/src/main/java/org/apache/reef/tests/yarn/failure/FailureDriver.java @@ -34,6 +34,9 @@ import java.util.concurrent.atomic.AtomicInteger; import java.util.logging.Level; import java.util.logging.Logger; +/** + * Driver for failure test. + */ @Unit public class FailureDriver { http://git-wip-us.apache.org/repos/asf/reef/blob/7e2b1e0d/lang/java/reef-tests/src/main/java/org/apache/reef/tests/yarn/failure/FailureREEF.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-tests/src/main/java/org/apache/reef/tests/yarn/failure/FailureREEF.java b/lang/java/reef-tests/src/main/java/org/apache/reef/tests/yarn/failure/FailureREEF.java index 48c26d2..d056dad 100644 --- a/lang/java/reef-tests/src/main/java/org/apache/reef/tests/yarn/failure/FailureREEF.java +++ b/lang/java/reef-tests/src/main/java/org/apache/reef/tests/yarn/failure/FailureREEF.java @@ -38,6 +38,9 @@ import java.io.IOException; import java.util.logging.Level; import java.util.logging.Logger; +/** + * Entry point class for REEF failure test. + */ public final class FailureREEF { /** * The upper limit on the number of Evaluators that the local resourcemanager will hand out concurrently. @@ -121,6 +124,9 @@ public final class FailureREEF { public static final class Local implements Name<Boolean> { } + /** + * Number of minutes before timeout. + */ @NamedParameter(doc = "Number of minutes before timeout", short_name = "timeout", default_value = "2") public static final class TimeOut implements Name<Integer> { http://git-wip-us.apache.org/repos/asf/reef/blob/7e2b1e0d/lang/java/reef-tests/src/test/java/org/apache/reef/tests/AllTestsSuite.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-tests/src/test/java/org/apache/reef/tests/AllTestsSuite.java b/lang/java/reef-tests/src/test/java/org/apache/reef/tests/AllTestsSuite.java index baa2c74..11d3d3f 100644 --- a/lang/java/reef-tests/src/test/java/org/apache/reef/tests/AllTestsSuite.java +++ b/lang/java/reef-tests/src/test/java/org/apache/reef/tests/AllTestsSuite.java @@ -37,6 +37,9 @@ import org.apache.reef.tests.taskresubmit.TaskResubmitTest; import org.junit.runner.RunWith; import org.junit.runners.Suite; +/** + * Test suite of all integration tests. + */ @RunWith(Suite.class) @Suite.SuiteClasses({ DriverTest.class, http://git-wip-us.apache.org/repos/asf/reef/blob/7e2b1e0d/lang/java/reef-tests/src/test/java/org/apache/reef/tests/FailureTest.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-tests/src/test/java/org/apache/reef/tests/FailureTest.java b/lang/java/reef-tests/src/test/java/org/apache/reef/tests/FailureTest.java index 91ad776..a25a1bf 100644 --- a/lang/java/reef-tests/src/test/java/org/apache/reef/tests/FailureTest.java +++ b/lang/java/reef-tests/src/test/java/org/apache/reef/tests/FailureTest.java @@ -27,6 +27,9 @@ import org.junit.Assert; import org.junit.Before; import org.junit.Test; +/** + * REEF failure test. + */ public class FailureTest { private final TestEnvironment testEnvironment = TestEnvironmentFactory.getNewTestEnvironment(); http://git-wip-us.apache.org/repos/asf/reef/blob/7e2b1e0d/lang/java/reef-tests/src/test/java/org/apache/reef/tests/TestUtils.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-tests/src/test/java/org/apache/reef/tests/TestUtils.java b/lang/java/reef-tests/src/test/java/org/apache/reef/tests/TestUtils.java index c6f750a..c578238 100644 --- a/lang/java/reef-tests/src/test/java/org/apache/reef/tests/TestUtils.java +++ b/lang/java/reef-tests/src/test/java/org/apache/reef/tests/TestUtils.java @@ -24,6 +24,9 @@ import org.junit.Assert; import java.util.logging.Level; import java.util.logging.Logger; +/** + * Utilities used in tests. + */ public final class TestUtils { private static final Logger LOG = Logger.getLogger(TestUtils.class.getName()); http://git-wip-us.apache.org/repos/asf/reef/blob/7e2b1e0d/lang/java/reef-tests/src/test/java/org/apache/reef/tests/applications/ApplicationTestSuite.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-tests/src/test/java/org/apache/reef/tests/applications/ApplicationTestSuite.java b/lang/java/reef-tests/src/test/java/org/apache/reef/tests/applications/ApplicationTestSuite.java index ac302a1..fd724d8 100644 --- a/lang/java/reef-tests/src/test/java/org/apache/reef/tests/applications/ApplicationTestSuite.java +++ b/lang/java/reef-tests/src/test/java/org/apache/reef/tests/applications/ApplicationTestSuite.java @@ -22,6 +22,9 @@ import org.apache.reef.tests.applications.vortex.VortexTestSuite; import org.junit.runner.RunWith; import org.junit.runners.Suite; +/** + * Test suite of all application tests. + */ @RunWith(Suite.class) @Suite.SuiteClasses({ VortexTestSuite.class http://git-wip-us.apache.org/repos/asf/reef/blob/7e2b1e0d/lang/java/reef-tests/src/test/java/org/apache/reef/tests/applications/vortex/VortexTestSuite.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-tests/src/test/java/org/apache/reef/tests/applications/vortex/VortexTestSuite.java b/lang/java/reef-tests/src/test/java/org/apache/reef/tests/applications/vortex/VortexTestSuite.java index fca17f9..f97d559 100644 --- a/lang/java/reef-tests/src/test/java/org/apache/reef/tests/applications/vortex/VortexTestSuite.java +++ b/lang/java/reef-tests/src/test/java/org/apache/reef/tests/applications/vortex/VortexTestSuite.java @@ -24,6 +24,9 @@ import org.apache.reef.tests.applications.vortex.cancellation.TaskletCancellatio import org.junit.runner.RunWith; import org.junit.runners.Suite; +/** + * Test suite of Vortex tests. + */ @RunWith(Suite.class) @Suite.SuiteClasses({ AddOneTest.class, http://git-wip-us.apache.org/repos/asf/reef/blob/7e2b1e0d/lang/java/reef-tests/src/test/java/org/apache/reef/tests/evaluatorsize/EvaluatorSizeTestConfiguration.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-tests/src/test/java/org/apache/reef/tests/evaluatorsize/EvaluatorSizeTestConfiguration.java b/lang/java/reef-tests/src/test/java/org/apache/reef/tests/evaluatorsize/EvaluatorSizeTestConfiguration.java index 345e7cf..a9bc78d 100644 --- a/lang/java/reef-tests/src/test/java/org/apache/reef/tests/evaluatorsize/EvaluatorSizeTestConfiguration.java +++ b/lang/java/reef-tests/src/test/java/org/apache/reef/tests/evaluatorsize/EvaluatorSizeTestConfiguration.java @@ -24,6 +24,9 @@ import org.apache.reef.tang.formats.ConfigurationModule; import org.apache.reef.tang.formats.ConfigurationModuleBuilder; import org.apache.reef.tang.formats.RequiredParameter; +/** + * Configuration for EvaluatorSizeTest. + */ public final class EvaluatorSizeTestConfiguration extends ConfigurationModuleBuilder { public static final RequiredParameter<Integer> MEMORY_SIZE = new RequiredParameter<>(); @@ -31,6 +34,9 @@ public final class EvaluatorSizeTestConfiguration extends ConfigurationModuleBui .bindNamedParameter(MemorySize.class, MEMORY_SIZE) .build(); + /** + * The size of the Evaluator to test for. + */ @NamedParameter(doc = "The size of the Evaluator to test for") public static class MemorySize implements Name<Integer> { } http://git-wip-us.apache.org/repos/asf/reef/blob/7e2b1e0d/lang/java/reef-tests/src/test/java/org/apache/reef/tests/evaluatorsize/MemorySizeTask.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-tests/src/test/java/org/apache/reef/tests/evaluatorsize/MemorySizeTask.java b/lang/java/reef-tests/src/test/java/org/apache/reef/tests/evaluatorsize/MemorySizeTask.java index 6789900..912bab1 100644 --- a/lang/java/reef-tests/src/test/java/org/apache/reef/tests/evaluatorsize/MemorySizeTask.java +++ b/lang/java/reef-tests/src/test/java/org/apache/reef/tests/evaluatorsize/MemorySizeTask.java @@ -27,7 +27,7 @@ import javax.inject.Inject; final class MemorySizeTask implements Task { private static final int MEGA = 1048576; - private static final int ALLOWED_DELTA = 128; // TODO: This shouldn't be necessary. Could be the perm size we set. + private static final int ALLOWED_DELTA = 128; // This shouldn't be necessary. Could be the perm size we set. private final int memorySize; @Inject http://git-wip-us.apache.org/repos/asf/reef/blob/7e2b1e0d/lang/java/reef-tests/src/test/java/org/apache/reef/tests/fail/FailTestSuite.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-tests/src/test/java/org/apache/reef/tests/fail/FailTestSuite.java b/lang/java/reef-tests/src/test/java/org/apache/reef/tests/fail/FailTestSuite.java index d7eafb5..9967d9b 100644 --- a/lang/java/reef-tests/src/test/java/org/apache/reef/tests/fail/FailTestSuite.java +++ b/lang/java/reef-tests/src/test/java/org/apache/reef/tests/fail/FailTestSuite.java @@ -21,6 +21,9 @@ package org.apache.reef.tests.fail; import org.junit.runner.RunWith; import org.junit.runners.Suite; +/** + * Test suite of tests covering failure scenarios. + */ @RunWith(Suite.class) @Suite.SuiteClasses({ // FailTaskTest.class, http://git-wip-us.apache.org/repos/asf/reef/blob/7e2b1e0d/lang/java/reef-tests/src/test/java/org/apache/reef/tests/files/FileResourceTestDriverConfiguration.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-tests/src/test/java/org/apache/reef/tests/files/FileResourceTestDriverConfiguration.java b/lang/java/reef-tests/src/test/java/org/apache/reef/tests/files/FileResourceTestDriverConfiguration.java index ca7aaf4..0149a65 100644 --- a/lang/java/reef-tests/src/test/java/org/apache/reef/tests/files/FileResourceTestDriverConfiguration.java +++ b/lang/java/reef-tests/src/test/java/org/apache/reef/tests/files/FileResourceTestDriverConfiguration.java @@ -26,6 +26,9 @@ import org.apache.reef.tang.formats.RequiredParameter; import java.util.Set; +/** + * Configuration for FileResourceTest. + */ public final class FileResourceTestDriverConfiguration extends ConfigurationModuleBuilder { public static final RequiredParameter<String> EXPECTED_FILE_NAME = new RequiredParameter<>(); @@ -33,6 +36,9 @@ public final class FileResourceTestDriverConfiguration extends ConfigurationModu .bindSetEntry(FileNamesToExpect.class, EXPECTED_FILE_NAME) .build(); + /** + * The names of the files to expect in the local filesystem. + */ @NamedParameter(doc = "The names of the files to expect in the local filesystem.") public static final class FileNamesToExpect implements Name<Set<String>> { } http://git-wip-us.apache.org/repos/asf/reef/blob/7e2b1e0d/lang/java/reef-tests/src/test/java/org/apache/reef/tests/files/FileResourceTestTaskConfiguration.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-tests/src/test/java/org/apache/reef/tests/files/FileResourceTestTaskConfiguration.java b/lang/java/reef-tests/src/test/java/org/apache/reef/tests/files/FileResourceTestTaskConfiguration.java index 23397b6..a805166 100644 --- a/lang/java/reef-tests/src/test/java/org/apache/reef/tests/files/FileResourceTestTaskConfiguration.java +++ b/lang/java/reef-tests/src/test/java/org/apache/reef/tests/files/FileResourceTestTaskConfiguration.java @@ -31,13 +31,16 @@ import java.util.Set; */ public final class FileResourceTestTaskConfiguration extends ConfigurationModuleBuilder { /** - * the set of file names to expect present on the evaluator. + * The set of file names to expect present on the evaluator. */ public static final RequiredParameter<String> EXPECTED_FILE_NAME = new RequiredParameter<>(); public static final ConfigurationModule CONF = new FileResourceTestTaskConfiguration() .bindSetEntry(FileNamesToExpect.class, EXPECTED_FILE_NAME) .build(); + /** + * The names of the files to expect in the local filesystem. + */ @NamedParameter(doc = "The names of the files to expect in the local filesystem.") public static final class FileNamesToExpect implements Name<Set<String>> { } http://git-wip-us.apache.org/repos/asf/reef/blob/7e2b1e0d/lang/java/reef-tests/src/test/java/org/apache/reef/tests/group/GroupCommTestSuite.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-tests/src/test/java/org/apache/reef/tests/group/GroupCommTestSuite.java b/lang/java/reef-tests/src/test/java/org/apache/reef/tests/group/GroupCommTestSuite.java index 88e9fc1..c23430c 100644 --- a/lang/java/reef-tests/src/test/java/org/apache/reef/tests/group/GroupCommTestSuite.java +++ b/lang/java/reef-tests/src/test/java/org/apache/reef/tests/group/GroupCommTestSuite.java @@ -22,6 +22,9 @@ import org.apache.reef.tests.group.conf.TestGroupCommServiceInjection; import org.junit.runner.RunWith; import org.junit.runners.Suite; +/** + * Test suite of group communication tests. + */ @RunWith(Suite.class) @Suite.SuiteClasses({ TestMultipleCommGroups.class, http://git-wip-us.apache.org/repos/asf/reef/blob/7e2b1e0d/lang/java/reef-tests/src/test/java/org/apache/reef/tests/messaging/driver/DriverMessagingTest.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-tests/src/test/java/org/apache/reef/tests/messaging/driver/DriverMessagingTest.java b/lang/java/reef-tests/src/test/java/org/apache/reef/tests/messaging/driver/DriverMessagingTest.java index d953ae5..7acdf60 100644 --- a/lang/java/reef-tests/src/test/java/org/apache/reef/tests/messaging/driver/DriverMessagingTest.java +++ b/lang/java/reef-tests/src/test/java/org/apache/reef/tests/messaging/driver/DriverMessagingTest.java @@ -28,6 +28,9 @@ import org.junit.Assert; import org.junit.Before; import org.junit.Test; +/** + * Tests the messaging channel between client and driver. + */ public final class DriverMessagingTest { private final TestEnvironment testEnvironment = TestEnvironmentFactory.getNewTestEnvironment(); http://git-wip-us.apache.org/repos/asf/reef/blob/7e2b1e0d/lang/java/reef-tests/src/test/java/org/apache/reef/tests/watcher/WatcherTest.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-tests/src/test/java/org/apache/reef/tests/watcher/WatcherTest.java b/lang/java/reef-tests/src/test/java/org/apache/reef/tests/watcher/WatcherTest.java index 5cd79f2..f574d16 100644 --- a/lang/java/reef-tests/src/test/java/org/apache/reef/tests/watcher/WatcherTest.java +++ b/lang/java/reef-tests/src/test/java/org/apache/reef/tests/watcher/WatcherTest.java @@ -34,6 +34,9 @@ import org.junit.Assert; import org.junit.Before; import org.junit.Test; +/** + * Test reef.io.watcher. + */ public final class WatcherTest { private final TestEnvironment testEnvironment = TestEnvironmentFactory.getNewTestEnvironment();
