Back to Repositories

Testing Cross Report Merger Implementation in dianping/cat

This test suite validates the merging functionality of Cross Reports in the CAT monitoring system. It ensures proper combination of old and new XML report data while maintaining data integrity and format consistency.

Test Coverage Overview

The test coverage focuses on the CrossReportMerger’s ability to combine multiple Cross Reports while preserving their original content.

  • Validates merging of old and new XML report formats
  • Verifies data integrity during merger operations
  • Tests preservation of source report contents
  • Ensures correct XML formatting in merged output

Implementation Analysis

The testing approach implements JUnit framework to validate XML merging operations.

  • Uses SAX parsing for XML processing
  • Implements visitor pattern for report traversal
  • Employs assertion-based validation
  • Handles UTF-8 encoding specifications

Technical Details

  • JUnit testing framework
  • DefaultSaxParser for XML parsing
  • Files.forIO() utility for file operations
  • CrossReportMerger for report combination
  • Assert methods for validation

Best Practices Demonstrated

The test implementation showcases several testing best practices for complex data processing operations.

  • Proper resource handling for test files
  • Explicit validation of source data preservation
  • Consistent string normalization for cross-platform compatibility
  • Clear test method naming and organization

dianping/cat

cat-home/src/test/java/com/dianping/cat/report/page/cross/CrossReportMergerTest.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.page.cross;

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

import com.dianping.cat.consumer.cross.CrossReportMerger;
import com.dianping.cat.consumer.cross.model.entity.CrossReport;
import com.dianping.cat.consumer.cross.model.transform.DefaultSaxParser;

public class CrossReportMergerTest {
	@Test
	public void testCrossReportMerge() throws Exception {
		String oldXml = Files.forIO().readFrom(getClass().getResourceAsStream("CrossReportOld.xml"), "utf-8");
		String newXml = Files.forIO().readFrom(getClass().getResourceAsStream("CrossReportNew.xml"), "utf-8");
		CrossReport reportOld = DefaultSaxParser.parse(oldXml);
		CrossReport reportNew = DefaultSaxParser.parse(newXml);
		String expected = Files.forIO().readFrom(getClass().getResourceAsStream("CrossReportMergeResult.xml"), "utf-8");
		CrossReportMerger merger = new CrossReportMerger(new CrossReport(reportOld.getDomain()));

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

		Assert.assertEquals("Check the merge result!", expected.replaceAll("\r", ""),
								merger.getCrossReport().toString().replaceAll("\r", ""));
		Assert.assertEquals("Source report is changed!", newXml.replaceAll("\r", ""),
								reportNew.toString().replaceAll("\r", ""));
		Assert.assertEquals("Source report is changed!", oldXml.replaceAll("\r", ""),
								reportOld.toString().replaceAll("\r", ""));
	}
}