[HWKMETRICS-153] fix texts and add some javadoc

hawkular · Jun 29, 2015 · 2af60ed · 2af60ed
1 parent 4116876
commit 2af60ed
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 8 deletions.
diff --git a/rest-tests/src/test/groovy/org/hawkular/metrics/rest/CountersITest.groovy b/rest-tests/src/test/groovy/org/hawkular/metrics/rest/CountersITest.groovy
@@ -27,7 +27,7 @@ import static org.junit.Assert.assertEquals
  */
 class CountersITest extends RESTTest {
 
-//  @Test
+  @Test
   void createSimpleCounter() {
     String tenantId = nextTenantId()
     String id = "C1"
@@ -46,7 +46,7 @@ class CountersITest extends RESTTest {
     assertEquals(expectedData, response.data)
   }
 
-//  @Test
+  @Test
   void createCounterWithTagsAndDataRetention() {
     String tenantId = nextTenantId()
     String id = "C1"
@@ -74,7 +74,7 @@ class CountersITest extends RESTTest {
     assertEquals(expectedData, response.data)
   }
 
-//  @Test
+  @Test
   void createAndFindCounters() {
     String tenantId = nextTenantId()
     String counter1 = "C1"
@@ -121,7 +121,7 @@ class CountersITest extends RESTTest {
     assertEquals(expectedData, response.data)
   }
 
-//  @Test
+  @Test
   void addDataForMultipleCountersAndFindhWithDateRange() {
     String tenantId = nextTenantId()
     String counter1 = "C1"
@@ -160,15 +160,14 @@ class CountersITest extends RESTTest {
     assertEquals(200, response.status)
 
     def expectedData = [
-        [timestamp: start.plusMinutes(1).millis, value: 20],
         [timestamp: start.millis, value: 10]
     ]
     assertEquals(expectedData, response.data)
 
     response = hawkularMetrics.get(
         path: "counters/$counter2/data",
         headers: [(tenantHeaderName): tenantId],
-        query: [start: start.millis, end: start.plusMinutes(1).millis]
+        query: [start: start.millis, end: start.plusMinutes(2).millis]
     )
     assertEquals(200, response.status)
 
@@ -179,7 +178,7 @@ class CountersITest extends RESTTest {
     assertEquals(expectedData, response.data)
   }
 
-//  @Test
+  @Test
   void addDataForSingleCounterAndFindWithDefaultDateRange() {
     String tenantId = nextTenantId()
     String counter = "C1"
@@ -210,7 +209,7 @@ class CountersITest extends RESTTest {
     assertEquals(expectedData, response.data)
   }
 
-//  @Test
+  @Test
   void findWhenThereIsNoData() {
     String tenantId = nextTenantId()
     String counter1 = "C1"

diff --git a/task-queue/src/main/java/org/hawkular/metrics/tasks/api/TaskService.java b/task-queue/src/main/java/org/hawkular/metrics/tasks/api/TaskService.java
@@ -68,5 +68,13 @@ public interface TaskService {
      */
     Observable<Task> scheduleTask(DateTime time, Task task);
 
+    /**
+     * The scheduler does not execute tasks. Instead when a task is ready for execution the scheduler emits an event
+     * where the event is the task to be executed. The observer can then execute the task.
+     *
+     * @param taskType The type of task for which you want to observe tasks
+     * @param onNext The action that will be called when a a task is ready for execution
+     * @return The {@link Subscription Rx subscription}
+     */
     Subscription subscribe(TaskType taskType, Action1<? super Task> onNext);
 }