Back to Repositories

Testing Problem Analysis Implementation in CAT Monitoring System

A comprehensive unit test suite for the Problem Analyzer component in the CAT monitoring system. This test suite validates problem detection, analysis, and reporting functionality through simulated message processing and report generation.

Test Coverage Overview

The test suite provides extensive coverage of the ProblemAnalyzer component:

Message tree generation and processing for 100 different scenarios
Various transaction types including URL, Call, Cache, SQL, and Pigeon services
Error event handling and heartbeat monitoring
Report generation and validation against expected XML output

Implementation Analysis

The testing approach employs JUnit framework with component-based testing:

Uses ComponentTestCase for dependency injection and component lookup
Implements systematic message tree generation with varied test cases
Validates report output through XML comparison
Handles timestamp-based testing with precise date formatting

Technical Details

Testing infrastructure and setup:

JUnit 4.x test framework
Custom TestHelper for report comparison
XML-based report validation
Simulated message trees with various event types
Configured for hourly analysis with 5-minute intervals

Best Practices Demonstrated

The test implementation showcases several testing best practices:

Proper test setup and initialization using @Before
Systematic test data generation
Comprehensive assertion validation
Clean separation of test data generation and verification
Effective use of helper methods for test data creation

dianping/cat

cat-consumer/src/test/java/com/dianping/cat/consumer/problem/ProblemAnalyzerTest.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.consumer.problem;

import java.text.SimpleDateFormat;
import java.util.Date;

import org.junit.Before;
import org.junit.Test;
import org.unidal.helper.Files;
import org.unidal.lookup.ComponentTestCase;

import com.dianping.cat.Constants;
import com.dianping.cat.analysis.MessageAnalyzer;
import com.dianping.cat.consumer.TestHelper;
import com.dianping.cat.consumer.problem.model.entity.ProblemReport;
import com.dianping.cat.message.Event;
import com.dianping.cat.message.Heartbeat;
import com.dianping.cat.message.Transaction;
import com.dianping.cat.message.internal.DefaultEvent;
import com.dianping.cat.message.internal.DefaultHeartbeat;
import com.dianping.cat.message.internal.DefaultTransaction;
import com.dianping.cat.message.spi.DefaultMessageTree;
import com.dianping.cat.message.spi.MessageTree;

import org.junit.Assert;

public class ProblemAnalyzerTest extends ComponentTestCase {

	private long m_timestamp;

	private ProblemAnalyzer m_analyzer;

	private String m_domain = "group";

	@Before
	public void setUp() throws Exception {
		super.setUp();

		m_timestamp = 1385470800000L;
		m_analyzer = (ProblemAnalyzer) lookup(MessageAnalyzer.class, ProblemAnalyzer.ID);
		SimpleDateFormat sdf = new SimpleDateFormat("yyyyMMdd HH:mm");
		Date date = sdf.parse("20120101 00:00");

		m_analyzer.initialize(date.getTime(), Constants.HOUR, Constants.MINUTE * 5);
	}

	@Test
	public void testProcess() throws Exception {
		for (int i = 1; i <= 100; i++) {
			MessageTree tree = generateMessageTree(i);

			m_analyzer.process(tree);
		}

		ProblemReport report = m_analyzer.getReport(m_domain);

		String expected = Files.forIO().readFrom(getClass().getResourceAsStream("problem_analyzer.xml"), "utf-8");
		ProblemReport expected4report =  com.dianping.cat.consumer.problem.model.transform.DefaultSaxParser.parse(expected);
		
		Assert.assertTrue(TestHelper.isEquals(expected4report,report));
	}

	protected MessageTree generateMessageTree(int i) {
		MessageTree tree = new DefaultMessageTree();

		tree.setMessageId("" + i);
		tree.setDomain(m_domain);
		tree.setHostName("group001");
		tree.setIpAddress("192.168.1.1");
		tree.setThreadGroupName("cat");
		tree.setThreadName("Cat-ProblemAnalyzer-Test");
		if (i < 10) {
			DefaultEvent error = new DefaultEvent("Error", "Error");

			error.setTimestamp(m_timestamp);
			tree.setMessage(error);
		} else if (i < 20) {
			DefaultHeartbeat heartbeat = new DefaultHeartbeat("heartbeat", "heartbeat");

			heartbeat.setTimestamp(m_timestamp);
			tree.setMessage(heartbeat);
		} else {

			DefaultTransaction t = new DefaultTransaction("A", "n" + i % 2);

			t.setTimestamp(m_timestamp);
			t.setDurationInMillis(i * 50);

			switch (i % 7) {
			case 0:
				t.setType("URL");
				break;
			case 1:
				t.setType("Call");
				break;
			case 2:
				t.setType("Cache.");
				t.setDurationInMillis(i * 5);
				break;
			case 3:
				t.setType("SQL");
				break;
			case 4:
				t.setType("PigeonCall");
				break;
			case 5:
				t.setType("Service");
				break;
			case 6:
				t.setType("PigeonService");
				break;
			}

			Event error = new DefaultEvent("Error", "Error");
			Event exception = new DefaultEvent("Other", "Exception");
			Heartbeat heartbeat = new DefaultHeartbeat("heartbeat", "heartbeat");
			DefaultTransaction transaction = new DefaultTransaction("Transaction", "Transaction");

			transaction.setStatus(Transaction.SUCCESS);
			t.addChild(transaction);
			t.addChild(error);
			t.addChild(exception);
			t.addChild(heartbeat);
			tree.setMessage(t);
		}
		return tree;
	}

}