Back to Repositories

Testing State Report Merger Implementation in CAT Monitoring System

This test suite validates the merging functionality of state reports in the CAT monitoring system. It focuses on verifying the correct combination of historical state data while maintaining data integrity and source report immutability.

Test Coverage Overview

The test suite provides comprehensive coverage of the state report merging functionality.

Key areas tested include:
  • Merging of old and new state reports
  • Data integrity verification
  • Source report immutability checks
  • XML parsing and transformation

Implementation Analysis

The testing approach utilizes JUnit framework for unit testing state report merging operations. It implements a systematic verification process using XML file inputs and the HistoryStateReportMerger class.

Key patterns include:
  • File-based test data loading
  • SAX parsing for XML processing
  • Visitor pattern for report processing
  • String comparison for validation

Technical Details

Testing infrastructure includes:
  • JUnit 4 testing framework
  • DefaultSaxParser for XML processing
  • Files.forIO utility for file operations
  • Custom HistoryStateReportMerger implementation
  • Assert methods for result validation

Best Practices Demonstrated

The test implementation showcases several testing best practices.

Notable practices include:
  • Isolated test resources using separate XML files
  • Explicit verification of source data integrity
  • Clear test method naming
  • Comprehensive result validation
  • Exception handling verification

dianping/cat

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

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

import com.dianping.cat.consumer.state.model.entity.StateReport;
import com.dianping.cat.consumer.state.model.transform.DefaultSaxParser;
import com.dianping.cat.report.page.state.task.HistoryStateReportMerger;

public class StateReportMergerTest {

	@Test
	public void testHistoryStateReportMerge() throws Exception {
		String oldXml = Files.forIO().readFrom(getClass().getResourceAsStream("old.xml"), "utf-8");
		String newXml = Files.forIO().readFrom(getClass().getResourceAsStream("new.xml"), "utf-8");
		StateReport reportOld = DefaultSaxParser.parse(oldXml);
		StateReport reportNew = DefaultSaxParser.parse(newXml);
		String expected = Files.forIO().readFrom(getClass().getResourceAsStream("historyResult.xml"), "utf-8");

		HistoryStateReportMerger merger = new HistoryStateReportMerger(new StateReport(reportOld.getDomain()));

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

		Assert.assertEquals("Check the merge result!", expected.replaceAll("\r", ""),
								merger.getStateReport().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", ""));
	}

}