Repository: reef Updated Branches: refs/heads/master 01c0a89ee -> 766883f0c
[REEF-529] Add missing Javadoc comments/triage TODOs in reef-runtime-mesos JIRA: [REEF-529](https://issues.apache.org/jira/browse/REEF-529) Pull request: This closes #720 Project: http://git-wip-us.apache.org/repos/asf/reef/repo Commit: http://git-wip-us.apache.org/repos/asf/reef/commit/766883f0 Tree: http://git-wip-us.apache.org/repos/asf/reef/tree/766883f0 Diff: http://git-wip-us.apache.org/repos/asf/reef/diff/766883f0 Branch: refs/heads/master Commit: 766883f0c88358d27a875168ac6df6fb6fd3253d Parents: 01c0a89 Author: Mariia Mykhailova <[email protected]> Authored: Wed Dec 9 18:48:54 2015 -0800 Committer: Dongjoon Hyun <[email protected]> Committed: Thu Dec 10 16:50:33 2015 +0900 ---------------------------------------------------------------------- lang/java/reef-runtime-mesos/pom.xml | 11 +++++++++++ .../runtime/mesos/client/MesosJobSubmissionHandler.java | 2 +- .../reef/runtime/mesos/client/parameters/MasterIp.java | 3 +++ .../reef/runtime/mesos/client/parameters/RootFolder.java | 3 +++ .../runtime/mesos/driver/MesosResourceLaunchHandler.java | 2 +- .../mesos/driver/MesosSchedulerDriverExecutor.java | 3 +++ .../apache/reef/runtime/mesos/driver/REEFScheduler.java | 4 ++-- .../runtime/mesos/driver/parameters/MesosMasterIp.java | 3 +++ .../runtime/mesos/driver/parameters/MesosSlavePort.java | 3 +++ .../reef/runtime/mesos/evaluator/REEFExecutor.java | 5 ++++- .../mesos/evaluator/parameters/MesosExecutorId.java | 3 +++ .../runtime/mesos/util/HDFSConfigurationConstructor.java | 3 +++ .../reef/runtime/mesos/util/MesosErrorHandler.java | 2 +- .../reef/runtime/mesos/util/MesosRemoteManager.java | 2 +- .../reef/runtime/mesos/util/MesosRemoteManagerCodec.java | 3 +++ 15 files changed, 45 insertions(+), 7 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/reef/blob/766883f0/lang/java/reef-runtime-mesos/pom.xml ---------------------------------------------------------------------- diff --git a/lang/java/reef-runtime-mesos/pom.xml b/lang/java/reef-runtime-mesos/pom.xml index 780d233..f1cfef5 100644 --- a/lang/java/reef-runtime-mesos/pom.xml +++ b/lang/java/reef-runtime-mesos/pom.xml @@ -92,5 +92,16 @@ 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> </project> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/reef/blob/766883f0/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/client/MesosJobSubmissionHandler.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/client/MesosJobSubmissionHandler.java b/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/client/MesosJobSubmissionHandler.java index 7401f90..e48c6fd 100644 --- a/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/client/MesosJobSubmissionHandler.java +++ b/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/client/MesosJobSubmissionHandler.java @@ -44,7 +44,7 @@ import java.util.List; /** * The current implementation runs the driver as a local process, similar to reef-runtime-local. - * TODO: run the driver on a slave node in the cluster + * TODO[JIRA REEF-98]: run the driver on a slave node in the cluster */ @Private @ClientSide http://git-wip-us.apache.org/repos/asf/reef/blob/766883f0/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/client/parameters/MasterIp.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/client/parameters/MasterIp.java b/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/client/parameters/MasterIp.java index 1a9b46b..b46bd38 100644 --- a/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/client/parameters/MasterIp.java +++ b/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/client/parameters/MasterIp.java @@ -21,6 +21,9 @@ package org.apache.reef.runtime.mesos.client.parameters; import org.apache.reef.tang.annotations.Name; import org.apache.reef.tang.annotations.NamedParameter; +/** + * The ip address of Mesos Master. + */ @NamedParameter(doc = "The ip address of Mesos Master", short_name = "master_ip") public final class MasterIp implements Name<String> { } http://git-wip-us.apache.org/repos/asf/reef/blob/766883f0/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/client/parameters/RootFolder.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/client/parameters/RootFolder.java b/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/client/parameters/RootFolder.java index 65f55b9..c4b5340 100644 --- a/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/client/parameters/RootFolder.java +++ b/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/client/parameters/RootFolder.java @@ -21,6 +21,9 @@ package org.apache.reef.runtime.mesos.client.parameters; import org.apache.reef.tang.annotations.Name; import org.apache.reef.tang.annotations.NamedParameter; +/** + * The root folder where logs etc. will be stored. + */ @NamedParameter(doc = "The root folder where logs etc. will be stored.", default_value = "REEF_MESOS_RUNTIME") public final class RootFolder implements Name<String> { } http://git-wip-us.apache.org/repos/asf/reef/blob/766883f0/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/driver/MesosResourceLaunchHandler.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/driver/MesosResourceLaunchHandler.java b/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/driver/MesosResourceLaunchHandler.java index 2aa413e..f73ac62 100644 --- a/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/driver/MesosResourceLaunchHandler.java +++ b/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/driver/MesosResourceLaunchHandler.java @@ -98,7 +98,7 @@ final class MesosResourceLaunchHandler implements ResourceLaunchHandler { final Path hdfsFolder = new Path(fileSystem.getUri() + "/" + resourceLaunchEvent.getIdentifier() + "/"); FileUtil.copy(localStagingFolder, fileSystem, hdfsFolder, false, new org.apache.hadoop.conf.Configuration()); - // TODO: Replace REEFExecutor with a simple launch command (we only need to launch REEFExecutor) + // TODO[JIRA REEF-102]: Replace REEFExecutor with a simple launch command (we only need to launch REEFExecutor) final List<String> command = getLaunchCommand(resourceLaunchEvent, this.executors.getMemory(resourceLaunchEvent.getIdentifier())); this.executors.launchEvaluator( http://git-wip-us.apache.org/repos/asf/reef/blob/766883f0/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/driver/MesosSchedulerDriverExecutor.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/driver/MesosSchedulerDriverExecutor.java b/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/driver/MesosSchedulerDriverExecutor.java index d87c857..0f69148 100644 --- a/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/driver/MesosSchedulerDriverExecutor.java +++ b/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/driver/MesosSchedulerDriverExecutor.java @@ -26,6 +26,9 @@ import javax.inject.Inject; import java.util.logging.Level; import java.util.logging.Logger; +/** + * Handler for Mesos SchedulerDriver. + */ public class MesosSchedulerDriverExecutor implements EventHandler<SchedulerDriver> { private static final Logger LOG = Logger.getLogger(MesosSchedulerDriverExecutor.class.getName()); http://git-wip-us.apache.org/repos/asf/reef/blob/766883f0/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/driver/REEFScheduler.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/driver/REEFScheduler.java b/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/driver/REEFScheduler.java index ea039f3..9817f9b 100644 --- a/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/driver/REEFScheduler.java +++ b/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/driver/REEFScheduler.java @@ -211,7 +211,7 @@ final class REEFScheduler implements Scheduler { break; case TASK_FINISHED: if (taskStatus.getData().toStringUtf8().equals("eval_not_run")) { - // TODO: a hack to pass closeEvaluator test, replace this with a better interface + // TODO[JIRA REEF-102]: a hack to pass closeEvaluator test, replace this with a better interface return; } resourceStatus.setState(State.DONE); @@ -308,7 +308,7 @@ final class REEFScheduler implements Scheduler { /** * Greedily acquire resources by launching a Mesos Task(w/ our custom MesosExecutor) on REEF Evaluator request. * Either called from onResourceRequest(for a new request) or resourceOffers(for an outstanding request). - * TODO: reflect priority and rack/node locality specified in resourceRequestEvent. + * TODO[JIRA REEF-102]: reflect priority and rack/node locality specified in resourceRequestEvent. */ private synchronized void doResourceRequest(final ResourceRequestEvent resourceRequestEvent) { int tasksToLaunchCounter = resourceRequestEvent.getResourceCount(); http://git-wip-us.apache.org/repos/asf/reef/blob/766883f0/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/driver/parameters/MesosMasterIp.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/driver/parameters/MesosMasterIp.java b/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/driver/parameters/MesosMasterIp.java index 91b0dc1..4997e76 100644 --- a/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/driver/parameters/MesosMasterIp.java +++ b/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/driver/parameters/MesosMasterIp.java @@ -21,6 +21,9 @@ package org.apache.reef.runtime.mesos.driver.parameters; import org.apache.reef.tang.annotations.Name; import org.apache.reef.tang.annotations.NamedParameter; +/** + * The ip address of Mesos Master. + */ @NamedParameter(doc = "The ip address of Mesos Master") public final class MesosMasterIp implements Name<String> { } http://git-wip-us.apache.org/repos/asf/reef/blob/766883f0/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/driver/parameters/MesosSlavePort.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/driver/parameters/MesosSlavePort.java b/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/driver/parameters/MesosSlavePort.java index 811b178..ef81054 100644 --- a/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/driver/parameters/MesosSlavePort.java +++ b/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/driver/parameters/MesosSlavePort.java @@ -21,6 +21,9 @@ package org.apache.reef.runtime.mesos.driver.parameters; import org.apache.reef.tang.annotations.Name; import org.apache.reef.tang.annotations.NamedParameter; +/** + * The port number of Mesos Slave. + */ @NamedParameter(doc = "The port number of Mesos Slave", default_value="5051") public final class MesosSlavePort implements Name<Integer> { } http://git-wip-us.apache.org/repos/asf/reef/blob/766883f0/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/evaluator/REEFExecutor.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/evaluator/REEFExecutor.java b/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/evaluator/REEFExecutor.java index df0d928..83f4a66 100644 --- a/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/evaluator/REEFExecutor.java +++ b/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/evaluator/REEFExecutor.java @@ -56,6 +56,9 @@ import java.util.concurrent.Executors; import java.util.logging.Level; import java.util.logging.Logger; +/** + * REEF implementation of Mesos Executor. + */ public final class REEFExecutor implements Executor { private static final Logger LOG = Logger.getLogger(REEFExecutor.class.getName()); @@ -165,7 +168,7 @@ public final class REEFExecutor implements Executor { .build()) .setState(TaskState.TASK_FINISHED) .setData(ByteString.copyFromUtf8("eval_not_run")) - // TODO: a hack to pass closeEvaluator test, replace this with a better interface + // TODO[JIRA REEF-102]: a hack to pass closeEvaluator test, replace this with a better interface .setMessage("Evaluator Process exited with status " + String.valueOf(evaluatorProcessExitValue)) .build()); } http://git-wip-us.apache.org/repos/asf/reef/blob/766883f0/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/evaluator/parameters/MesosExecutorId.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/evaluator/parameters/MesosExecutorId.java b/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/evaluator/parameters/MesosExecutorId.java index 1ff1e4a..fdbb230 100644 --- a/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/evaluator/parameters/MesosExecutorId.java +++ b/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/evaluator/parameters/MesosExecutorId.java @@ -21,6 +21,9 @@ package org.apache.reef.runtime.mesos.evaluator.parameters; import org.apache.reef.tang.annotations.Name; import org.apache.reef.tang.annotations.NamedParameter; +/** + * Mesos Executor's id. + */ @NamedParameter(doc = "The Executor's id", short_name = "mesos_executor_id") public final class MesosExecutorId implements Name<String> { } http://git-wip-us.apache.org/repos/asf/reef/blob/766883f0/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/util/HDFSConfigurationConstructor.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/util/HDFSConfigurationConstructor.java b/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/util/HDFSConfigurationConstructor.java index 2fcb16b..6386442 100644 --- a/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/util/HDFSConfigurationConstructor.java +++ b/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/util/HDFSConfigurationConstructor.java @@ -23,6 +23,9 @@ import org.apache.reef.tang.ExternalConstructor; import javax.inject.Inject; +/** + * Configuration wrapper which allows it to be injected. + */ public final class HDFSConfigurationConstructor implements ExternalConstructor<Configuration> { @Inject HDFSConfigurationConstructor() { http://git-wip-us.apache.org/repos/asf/reef/blob/766883f0/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/util/MesosErrorHandler.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/util/MesosErrorHandler.java b/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/util/MesosErrorHandler.java index 4d3036a..889a054 100644 --- a/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/util/MesosErrorHandler.java +++ b/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/util/MesosErrorHandler.java @@ -26,7 +26,7 @@ import java.util.logging.Logger; /** * ErrorHandler for MesosRemoteManager. - * TODO: Replace this class once Tang's namespace feature is enabled + * TODO[JIRA REEF-103]: Replace this class once Tang's namespace feature is enabled */ public final class MesosErrorHandler implements EventHandler<Throwable> { http://git-wip-us.apache.org/repos/asf/reef/blob/766883f0/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/util/MesosRemoteManager.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/util/MesosRemoteManager.java b/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/util/MesosRemoteManager.java index 20effe0..bca6794 100644 --- a/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/util/MesosRemoteManager.java +++ b/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/util/MesosRemoteManager.java @@ -29,7 +29,7 @@ import javax.inject.Inject; /** * Since the existing RemoteManager cannot use an additional codec, * we need this additional RemoteManager to use MesosMessageCodec. - * TODO: Replace this class once Tang's namespace feature is enabled + * TODO[JIRA REEF-103]: Replace this class once Tang's namespace feature is enabled */ public final class MesosRemoteManager { private final RemoteManager raw; http://git-wip-us.apache.org/repos/asf/reef/blob/766883f0/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/util/MesosRemoteManagerCodec.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/util/MesosRemoteManagerCodec.java b/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/util/MesosRemoteManagerCodec.java index c452a5e..29cccfb 100644 --- a/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/util/MesosRemoteManagerCodec.java +++ b/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/util/MesosRemoteManagerCodec.java @@ -29,6 +29,9 @@ import java.io.*; import java.util.logging.Level; import java.util.logging.Logger; +/** + * EvaluatorControl codec. + */ public class MesosRemoteManagerCodec implements Codec<EvaluatorControl> { private static final Logger LOG = Logger.getLogger(MesosRemoteManagerCodec.class.getName());
