Back to Repositories

Testing TaskConsumer State Management in Cat

This test suite validates the TaskConsumer functionality in the CAT monitoring system, focusing on task state transitions and processing scenarios. It thoroughly tests the task lifecycle management including handling of TODO, DOING, and DONE states with various success and failure paths.

Test Coverage Overview

The test suite provides comprehensive coverage of the TaskConsumer workflow and state management.

Key areas tested include:

Continuation of existing DOING tasks
Processing of TODO tasks
State transitions (TODO → DOING → DONE/FAIL)
Task execution success and failure scenarios
Concurrent task handling edge cases

Implementation Analysis

The testing approach uses JUnit with a wrapper class (TaskConsumerWrap) to control test scenarios and validate behavior. The implementation employs mocking patterns through method overrides to simulate various task states and processing outcomes.

Framework features utilized include:

JUnit @Test annotations
Thread management for async operations
Assert statements for verification
Custom task state tracking

Technical Details

Testing tools and configuration:

JUnit test framework
Thread synchronization mechanisms
Mock task objects and state management
Custom TaskConsumerWrap extension class
ArrayList for operation replay tracking
Configurable sleep timings for task processing

Best Practices Demonstrated

The test suite exemplifies several testing best practices including isolation of test scenarios, comprehensive state verification, and proper cleanup.

Notable practices:

Separate test methods for success/failure scenarios
Thorough state transition verification
Mock implementation for controlled testing
Clear test method naming convention
Proper exception handling

dianping/cat

cat-home/src/test/java/com/dianping/cat/report/task/TaskConsumerTest.java

            
/*
 * Copyright (c) 2011-2018, Meituan Dianping. All Rights Reserved.
 *
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.dianping.cat.report.task;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;

import org.junit.Assert;
import org.junit.Test;

import com.dianping.cat.core.dal.Task;

public class TaskConsumerTest {

	/**
		* 发现已经存在的doing task,继续执行成功
		*
		* @throws InterruptedException
		*/
	@Test
	public void testContinueDoingTaskSuccess() throws InterruptedException {
		final Task t = new Task();
		t.setStatus(TaskConsumer.STATUS_DOING);

		final List<Task> taskList = new ArrayList<Task>();
		taskList.add(t);

		TaskConsumerWrap consumer = new TaskConsumerWrap() {

			@Override
			public boolean checkTime() {
				return true;
			}

			@Override
			protected Task findDoingTask(String ip) {
				super.findDoingTask(ip);
				return taskList.size() == 0 ? null : taskList.remove(0);
			}

			@Override
			protected boolean processTask(Task doing) {
				super.processTask(doing);
				return true;
			}

			@Override
			protected boolean updateDoingToDone(Task doing) {
				super.updateDoingToDone(doing);
				doing.setStatus(STATUS_DONE);
				return true;
			}

		};

		new Thread(consumer).start();
		while (!consumer.isStopped()) {
			Thread.sleep(10);
		}

		String expectValue = Arrays.toString(consumer.replayer.toArray());

		Assert.assertEquals("[1, 10, 3, 1, 8, 4]", expectValue);

		Assert.assertEquals(TaskConsumer.STATUS_DONE, t.getStatus());

	}

	;

	/**
		* 发现已经存在的doing task,继续执行失败
		*
		* @throws InterruptedException
		*/
	@Test
	public void testContinueDoingTaskFail() throws InterruptedException {
		final Task t = new Task();
		t.setStatus(TaskConsumer.STATUS_DOING);

		final List<Task> taskList = new ArrayList<Task>();
		taskList.add(t);

		TaskConsumerWrap consumer = new TaskConsumerWrap() {

			@Override
			public boolean checkTime() {
				return true;
			}

			@Override
			protected Task findDoingTask(String ip) {
				super.findDoingTask(ip);
				return taskList.size() == 0 ? null : taskList.remove(0);
			}

		};

		new Thread(consumer).start();
		while (!consumer.isStopped()) {
			Thread.sleep(10);
		}

		Assert.assertEquals("[1, 10, 5, 1, 8, 4]", Arrays.toString(consumer.replayer.toArray()));
		Assert.assertEquals(TaskConsumer.STATUS_DOING, t.getStatus());
	}

	/**
		* 发现todo task, 执行成功
		*
		* @throws InterruptedException
		*/
	@Test
	public void testTodoTaskSuccess() throws InterruptedException {
		final Task t = new Task();
		t.setStatus(TaskConsumer.STATUS_TODO);

		final List<Task> taskList = new ArrayList<Task>();
		taskList.add(t);

		final TaskConsumerWrap consumer = new TaskConsumerWrap() {

			@Override
			public boolean checkTime() {
				return true;
			}

			@Override
			protected boolean updateTodoToDoing(Task todo) {
				super.updateTodoToDoing(todo);
				return true;
			}

			@Override
			protected boolean processTask(Task doing) {
				super.processTask(doing);
				return true;
			}

			@Override
			protected boolean updateDoingToDone(Task doing) {
				super.updateDoingToDone(doing);
				t.setStatus(TaskConsumer.STATUS_DONE);
				return true;
			}

			@Override
			protected Task findTodoTask() {
				super.findTodoTask();
				return taskList.size() == 0 ? null : taskList.remove(0);
			}

		};

		new Thread(consumer).start();
		while (!consumer.isStopped()) {
			Thread.sleep(10);
		}

		Assert.assertEquals("[1, 8, 7, 10, 3, 1, 8, 4]", Arrays.toString(consumer.replayer.toArray()));
		Assert.assertEquals(TaskConsumer.STATUS_DONE, t.getStatus());
	}

	/**
		* todo task, 执行失败
		*
		* @throws InterruptedException
		*/
	@Test
	public void testTodoTaskFail() throws InterruptedException {
		final Task t = new Task();
		t.setStatus(TaskConsumer.STATUS_TODO);

		final List<Task> taskList = new ArrayList<Task>();
		taskList.add(t);

		final TaskConsumerWrap consumer = new TaskConsumerWrap() {

			@Override
			public boolean checkTime() {
				return true;
			}

			@Override
			protected boolean updateTodoToDoing(Task todo) {
				super.updateTodoToDoing(todo);
				return true;
			}

			@Override
			protected Task findTodoTask() {
				super.findTodoTask();
				return taskList.size() == 0 ? null : taskList.remove(0);
			}

			@Override
			protected boolean updateDoingToFailure(Task todo) {
				super.updateDoingToFailure(todo);
				todo.setStatus(STATUS_FAIL);
				return true;
			}

		};

		new Thread(consumer).start();
		while (!consumer.isStopped()) {
			Thread.sleep(10);
		}

		Assert.assertEquals("[1, 8, 7, 10, 5, 1, 8, 4]", Arrays.toString(consumer.replayer.toArray()));
		Assert.assertEquals(TaskConsumer.STATUS_FAIL, t.getStatus());
	}

	public boolean possibleResult(String actual) {
		// 当抢占到同一TODO task时
		final String expect1 = "[1, 8, 1, 8, 4]";
		// 当未抢占到同一TODO task时
		final String expect2 = "[1, 8, 4]";

		return actual.equals(expect1) || actual.equals(expect2);
	}

	public static class TaskConsumerWrap extends TaskConsumer {

		final List<Integer> replayer = new ArrayList<Integer>();

		@Override
		public boolean checkTime() {
			return true;
		}

		@Override
		protected Task findDoingTask(String ip) {
			replayer.add(1);
			return null;
		}

		@Override
		protected boolean updateDoingToDone(Task doing) {
			replayer.add(3);
			return false;
		}

		@Override
		protected void taskNotFoundDuration() {
			try {
				Thread.sleep(10);
			} catch (InterruptedException e) {

			}
			replayer.add(4);
			this.stop();
		}

		@Override
		protected boolean updateTodoToDoing(Task todo) {
			replayer.add(7);
			return false;
		}

		@Override
		protected Task findTodoTask() {
			replayer.add(8);
			return null;
		}

		@Override
		protected boolean processTask(Task doing) {
			replayer.add(10);
			return false;
		}

		@Override
		protected void taskRetryDuration() {
			replayer.add(11);
		}

		@Override
		protected boolean updateDoingToFailure(Task todo) {
			replayer.add(5);
			return false;
		}

		@Override
		protected long getSleepTime() {
			return 100;
		}

		@Override
		public String getName() {
			return "MockConsumer";
		}

		@Override
		public void shutdown() {
		}
	}
}