Back to Repositories

Testing Server Configuration Visitor Implementation in Dianping Cat

This test suite validates the ServerConfigVisitor functionality in the Cat monitoring system, focusing on XML configuration parsing and server configuration inheritance. The tests ensure proper handling of default and custom server configurations through visitor pattern implementation.

Test Coverage Overview

The test suite provides comprehensive coverage of server configuration parsing and inheritance mechanisms.

Tests XML parsing of default and custom server configurations
Validates visitor pattern implementation for configuration inheritance
Verifies correct merging of default and server-specific settings
Covers UTF-8 encoding handling for configuration files

Implementation Analysis

The testing approach utilizes JUnit framework with XML resource files to validate server configuration behavior.

Key implementation patterns include:

SAX parsing for XML configuration processing
Visitor pattern for configuration inheritance
Resource file comparison for validation
String normalization for cross-platform compatibility

Technical Details

Testing infrastructure includes:

JUnit 4 testing framework
DefaultSaxParser for XML processing
Files.forIO utility for resource handling
UTF-8 encoding support
Custom XML comparison logic for platform independence

Best Practices Demonstrated

The test suite exemplifies several testing best practices:

Resource-based test data management
Platform-independent comparison techniques
Clear separation of test data and logic
Comprehensive validation of configuration inheritance
Proper exception handling for IO and SAX operations

dianping/cat

cat-core/src/test/java/com/dianping/cat/server/ServerConfigVisitorTest.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.server;

import java.io.IOException;

import org.junit.Assert;
import org.junit.Test;
import org.unidal.helper.Files;
import org.xml.sax.SAXException;

import com.dianping.cat.config.server.ServerConfigVisitor;
import com.dianping.cat.configuration.server.entity.Server;
import com.dianping.cat.configuration.server.entity.ServerConfig;
import com.dianping.cat.configuration.server.transform.DefaultSaxParser;

public class ServerConfigVisitorTest {

	@Test
	public void test() throws IOException, SAXException {
		String server = Files.forIO().readFrom(getClass().getResourceAsStream("server.xml"), "utf-8");
		ServerConfig serverConfig01 = DefaultSaxParser.parse(server);
		ServerConfig serverConfig02 = DefaultSaxParser.parse(server);

		Server default01 = serverConfig01.findServer("default");
		Server default02 = serverConfig02.findServer("default");
		Server server01 = serverConfig01.findServer("server01");
		Server server02 = serverConfig02.findServer("server02");

		ServerConfigVisitor visitor01 = new ServerConfigVisitor(server01);
		visitor01.visitServer(default01);

		ServerConfigVisitor visitor02 = new ServerConfigVisitor(server02);
		visitor02.visitServer(default02);

		String expected01 = Files.forIO().readFrom(getClass().getResourceAsStream("server01.xml"), "utf-8");
		Assert.assertEquals(expected01.replace("\r", ""), default01.toString().replace("\r", ""));

		String expected02 = Files.forIO().readFrom(getClass().getResourceAsStream("server02.xml"), "utf-8");
		Assert.assertEquals(expected02.replace("\r", ""), default02.toString().replace("\r", ""));
	}

}