Back to Repositories

Testing Matrix Analysis Processing in dianping/cat

The MatrixAnalyzerTest suite validates the functionality of the Matrix Analyzer component in the CAT monitoring system. It tests message processing, report generation, and transaction handling across different service types like URL, PigeonService, and Cache operations.

Test Coverage Overview

The test suite provides comprehensive coverage of the Matrix Analyzer’s core functionality:

Message tree processing for 100 different scenarios
Transaction handling across URL, PigeonService and Service types
Timestamp and duration calculations
Report generation and validation
Integration with CAT’s messaging system

Implementation Analysis

The testing approach utilizes JUnit framework with ComponentTestCase for dependency injection. It implements a systematic verification pattern by:

Setting up test environment with specific timezone and time configurations
Generating test message trees with varied transaction types
Processing messages through the analyzer
Comparing generated reports against expected XML output

Technical Details

Key technical components include:

JUnit 4 testing framework
ComponentTestCase for IoC container support
Custom MessageTree and Transaction implementations
XML-based report validation
Time-based test initialization with specific intervals (HOUR, MINUTE*5)

Best Practices Demonstrated

The test suite exemplifies several testing best practices:

Proper test setup and teardown using @Before annotations
Systematic test data generation
Comprehensive assertion checking
Clear separation of test initialization and execution
Effective use of helper methods for test data generation

dianping/cat

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

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

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.matrix.model.entity.MatrixReport;
import com.dianping.cat.message.Message;
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 MatrixAnalyzerTest extends ComponentTestCase {

	private long m_timestamp;

	private MatrixAnalyzer m_analyzer;

	private String m_domain = "group";

	@Before
	public void setUp() throws Exception {
		super.setUp();
		TimeZone.setDefault(TimeZone.getTimeZone("Asia/Shanghai"));
		long currentTimeMillis = System.currentTimeMillis();

		m_timestamp = currentTimeMillis - currentTimeMillis % (3600 * 1000);

		m_analyzer = (MatrixAnalyzer) lookup(MessageAnalyzer.class, MatrixAnalyzer.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);
		}

		MatrixReport report = m_analyzer.getReport(m_domain);

		String expected = Files.forIO().readFrom(getClass().getResourceAsStream("matrix_analyzer.xml"), "utf-8");
		//Assert.assertEquals(expected.replaceAll("\r", ""), report.toString().replaceAll("\r", ""));
		
		MatrixReport expected4report = com.dianping.cat.consumer.matrix.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");

		DefaultTransaction t;
		DefaultTransaction event;

		if (i % 3 == 0) {
			t = new DefaultTransaction("URL", "Cat-Test-Call");
			event = new DefaultTransaction("Call", "192.168.1.0:3000:class:method1");
		} else if (i % 3 == 1) {
			t = new DefaultTransaction("PigeonService", "Cat-Test-Service");
			event = new DefaultTransaction("SQL", "192.168.1.2:3000:class:method2");
		} else {
			t = new DefaultTransaction("Service", "Cat-Test-Service");
			event = new DefaultTransaction("Cache.CatTest", "192.168.1.2:3000:class:method2");
		}

		event.setTimestamp(m_timestamp + 5 * 60 * 1000);
		event.setDurationInMillis(i);
		event.setStatus(Message.SUCCESS);
		t.addChild(event);

		t.complete();
		t.setDurationInMillis(i * 2);
		t.setTimestamp(m_timestamp + 1000);
		tree.setMessage(t);

		return tree;
	}

}