Back to Repositories

Testing Business Report Merger Functionality in CAT Framework

This test suite validates the merging functionality of Business Reports in the CAT monitoring system. It specifically tests the BusinessReportMerger class’s ability to combine multiple XML-based business reports while maintaining data integrity and proper structure.

Test Coverage Overview

The test suite provides comprehensive coverage of the Business Report merging functionality.

Key areas tested include:

XML parsing of business reports
Merging of base and new report data
Validation of merged report structure
UTF-8 encoding handling
Domain preservation during merging

Implementation Analysis

The testing approach utilizes JUnit framework with XML file-based test data. The implementation follows a clear pattern of loading test files, parsing XML content, performing merge operations, and validating results against expected output.

Notable technical aspects:

SAX parsing implementation for XML processing
Visitor pattern usage for report merging
Resource file handling for test data

Technical Details

Testing tools and configuration:

JUnit 4 testing framework
DefaultSaxParser for XML processing
Files.forIO utility for file operations
UTF-8 encoding for file reading
Resource-based test data files (business_base.xml, business_merger.xml, business_merger_result.xml)

Best Practices Demonstrated

The test implementation showcases several testing best practices and quality patterns.

Notable practices include:

Clear test method naming
Proper resource cleanup
Explicit assertion messages
Consistent error handling
Platform-independent line ending handling

dianping/cat

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

import org.junit.Assert;
import org.junit.Test;
import org.unidal.helper.Files;

import com.dianping.cat.consumer.business.model.entity.BusinessReport;
import com.dianping.cat.consumer.business.model.transform.DefaultSaxParser;

public class BusinessReportMergerTest {

	@Test
	public void testBusinessReportMerge() throws Exception {
		String oldXml = Files.forIO().readFrom(getClass().getResourceAsStream("business_base.xml"), "utf-8");
		String newXml = Files.forIO().readFrom(getClass().getResourceAsStream("business_merger.xml"), "utf-8");
		BusinessReport reportOld = DefaultSaxParser.parse(oldXml);
		BusinessReport reportNew = DefaultSaxParser.parse(newXml);
		String expected = Files.forIO().readFrom(getClass().getResourceAsStream("business_merger_result.xml"),	"utf-8");
		BusinessReportMerger merger = new BusinessReportMerger(new BusinessReport(reportOld.getDomain()));

		reportOld.accept(merger);
		reportNew.accept(merger);

		Assert.assertEquals("Check the merge result!", expected.replace("\r", ""),
								merger.getBusinessReport().toString().replace("\r", ""));
	}
}