/*
* JBoss, Home of Professional Open Source.
* Copyright 2011, Red Hat Middleware LLC, and individual contributors
* as indicated by the @author tags. See the copyright.txt file in the
* distribution for a full listing of individual contributors.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.jboss.as.clustering.jgroups.subsystem;
import java.util.Arrays;
import java.util.Collection;
import java.util.LinkedList;
import java.util.List;
import java.util.Locale;
import javax.xml.stream.XMLStreamException;
import org.jboss.as.clustering.controller.CommonUnaryRequirement;
import org.jboss.as.clustering.controller.Operations;
import org.jboss.as.clustering.subsystem.AdditionalInitialization;
import org.jboss.as.clustering.subsystem.ClusteringSubsystemTest;
import org.jboss.as.controller.PathAddress;
import org.jboss.as.controller.descriptions.ModelDescriptionConstants;
import org.jboss.as.controller.operations.common.Util;
import org.jboss.as.model.test.ModelTestUtils;
import org.jboss.as.subsystem.test.KernelServices;
import org.jboss.as.subsystem.test.KernelServicesBuilder;
import org.jboss.dmr.ModelNode;
import org.junit.Assert;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.Parameterized;
import org.junit.runners.Parameterized.Parameters;
/**
* Tests parsing / booting / marshalling of JGroups configurations.
*
* The current XML configuration is tested, along with supported legacy configurations.
*
* @author <a href="kabir.khan@jboss.com">Kabir Khan</a>
* @author Richard Achmatowicz (c) 2013 Red Hat Inc.
*/
@RunWith(value = Parameterized.class)
public class JGroupsSubsystemParsingTestCase extends ClusteringSubsystemTest {
private final int expectedOperationCount;
private final JGroupsSchema schema;
public JGroupsSubsystemParsingTestCase(JGroupsSchema schema, int expectedOperationCount) {
super(JGroupsExtension.SUBSYSTEM_NAME, new JGroupsExtension(), String.format(Locale.ROOT, "subsystem-jgroups-%d_%d.xml", schema.major(), schema.minor()));
this.expectedOperationCount = expectedOperationCount;
this.schema = schema;
}
@Parameters
public static Collection<Object[]> data() {
Object[][] data = new Object[][] {
{ JGroupsSchema.VERSION_1_1, 20 },
{ JGroupsSchema.VERSION_2_0, 22 },
{ JGroupsSchema.VERSION_3_0, 29 },
{ JGroupsSchema.VERSION_4_0, 29 },
{ JGroupsSchema.VERSION_4_1, 31 },
};
return Arrays.asList(data);
}
private KernelServices buildKernelServices() throws Exception {
return this.buildKernelServices(this.getSubsystemXml());
}
private KernelServices buildKernelServices(String xml) throws Exception {
return this.createKernelServicesBuilder(xml).build();
}
private KernelServicesBuilder createKernelServicesBuilder() {
return this.createKernelServicesBuilder(this.createAdditionalInitialization());
}
private KernelServicesBuilder createKernelServicesBuilder(String xml) throws XMLStreamException {
return this.createKernelServicesBuilder().setSubsystemXml(xml);
}
@Override
protected org.jboss.as.subsystem.test.AdditionalInitialization createAdditionalInitialization() {
return new AdditionalInitialization()
.require(CommonUnaryRequirement.SOCKET_BINDING, "jgroups-udp", "some-binding", "jgroups-diagnostics", "jgroups-mping", "jgroups-tcp-fd")
.require(CommonUnaryRequirement.KEY_STORE, "my-key-store")
.require(CommonUnaryRequirement.CREDENTIAL_STORE, "my-credential-store")
;
}
@Override
protected String getSubsystemXsdPath() throws Exception {
return String.format("schema/jboss-as-jgroups_%d_%d.xsd", this.schema.major(), this.schema.minor());
}
/**
* Tests that the xml is parsed into the correct operations
*/
@Test
public void testParseSubsystem() throws Exception {
// Parse the subsystem xml into operations
List<ModelNode> operations = super.parse(getSubsystemXml());
// Check that we have the expected number of operations
// one for each resource instance
Assert.assertEquals(this.expectedOperationCount, operations.size());
}
/**
* Starts a controller with a given subsystem xml and then checks that a second controller
* started with the xml marshalled from the first one results in the same model
*/
@Test
public void testParseAndMarshalModel() throws Exception {
KernelServices services = this.buildKernelServices();
// Get the model and the persisted xml from the first controller
ModelNode modelA = services.readWholeModel();
String marshalled = services.getPersistedSubsystemXml();
ModelNode modelB = this.buildKernelServices(marshalled).readWholeModel();
// Make sure the models from the two controllers are identical
super.compare(modelA, modelB);
}
/**
* Starts a controller with the given subsystem xml and then checks that a second controller
* started with the operations from its describe action results in the same model
*/
@Test
public void testDescribeHandler() throws Exception {
KernelServices servicesA = this.buildKernelServices();
// Get the model and the describe operations from the first controller
ModelNode modelA = servicesA.readWholeModel();
ModelNode operation = Operations.createDescribeOperation(PathAddress.pathAddress(JGroupsSubsystemResourceDefinition.PATH));
List<ModelNode> operations = checkResultAndGetContents(servicesA.executeOperation(operation)).asList();
// Install the describe options from the first controller into a second controller
KernelServices servicesB = this.createKernelServicesBuilder().setBootOperations(operations).build();
ModelNode modelB = servicesB.readWholeModel();
// Make sure the models from the two controllers are identical
super.compare(modelA, modelB);
}
@Test
public void testLegacyOperations() throws Exception {
List<ModelNode> ops = new LinkedList<>();
PathAddress subsystemAddress = PathAddress.pathAddress(JGroupsSubsystemResourceDefinition.PATH);
PathAddress udpAddress = subsystemAddress.append(StackResourceDefinition.pathElement("udp"));
ModelNode op = Util.createAddOperation(subsystemAddress);
///subsystem=jgroups:add(default-stack=udp)
op.get("default-stack").set("udp");
ops.add(op);
//subsystem=jgroups/stack=udp:add(transport={"type"=>"UDP","socket-binding"=>"jgroups-udp"},protocols=["PING","MERGE3","FD_SOCK","FD","VERIFY_SUSPECT","BARRIER","pbcast.NAKACK2","UNICAST2","pbcast.STABLE","pbcast.GMS","UFC","MFC","FRAG2","RSVP"])
op = Util.createAddOperation(udpAddress);
ModelNode transport = new ModelNode();
transport.get("type").set("UDP");
transport.get("socket-binding").set("jgroups-udp");
ModelNode protocols = new ModelNode();
String[] protocolList = {"PING", "MERGE3", "FD_SOCK", "FD", "VERIFY_SUSPECT", "BARRIER", "pbcast.NAKACK2", "UNICAST2",
"pbcast.STABLE", "pbcast.GMS", "UFC", "MFC", "FRAG2", "RSVP"} ;
for (int i = 0; i < protocolList.length; i++) {
ModelNode protocol = new ModelNode();
protocol.get("type").set(protocolList[i]);
protocols.add(protocol);
}
op.get("transport").set(transport);
op.get("protocols").set(protocols);
ops.add(op);
KernelServices servicesA = createKernelServicesBuilder(createAdditionalInitialization()).setBootOperations(ops).build();
Assert.assertTrue("Subsystem boot failed!", servicesA.isSuccessfulBoot());
//Get the model and the persisted xml from the first controller
final ModelNode modelA = servicesA.readWholeModel();
validateModel(modelA);
servicesA.shutdown();
// Test the describe operation
final ModelNode operation = createDescribeOperation();
final ModelNode result = servicesA.executeOperation(operation);
Assert.assertTrue("the subsystem describe operation has to generate a list of operations to recreate the subsystem",
!result.hasDefined(ModelDescriptionConstants.FAILURE_DESCRIPTION));
final List<ModelNode> operations = result.get(ModelDescriptionConstants.RESULT).asList();
servicesA.shutdown();
final KernelServices servicesC = createKernelServicesBuilder(createAdditionalInitialization()).setBootOperations(operations).build();
final ModelNode modelC = servicesC.readWholeModel();
compare(modelA, modelC);
assertRemoveSubsystemResources(servicesC, getIgnoredChildResourcesForRemovalTest());
}
/**
* Tests that the 'fork' and 'stack' resources allow indexed adds for the 'protocol' children. This is important for
* the work being done for WFCORE-401. This work involves calculating the operations to bring the slave domain model
* into sync with the master domain model. Without ordered resources, that would mean on reconnect if the master
* had added a protocol somewhere in the middle, the protocol would get added to the end rather at the correct place.
*/
@Test
public void testIndexedAdds() throws Exception {
if (!this.schema.since(JGroupsSchema.VERSION_3_0)) return;
final KernelServices services = this.buildKernelServices();
ModelNode originalSubsystemModel = services.readWholeModel().get(JGroupsSubsystemResourceDefinition.PATH.getKeyValuePair());
ModelNode originalChannelModel = originalSubsystemModel.get(ChannelResourceDefinition.pathElement("ee").getKeyValuePair());
ModelNode originalForkModel = originalChannelModel.get(ForkResourceDefinition.pathElement("web").getKeyValuePair());
Assert.assertTrue(originalForkModel.isDefined());
originalForkModel.protect();
Assert.assertTrue(0 < originalForkModel.get(ProtocolResourceDefinition.WILDCARD_PATH.getKey()).keys().size());
ModelNode originalStackModel = originalSubsystemModel.get(StackResourceDefinition.pathElement("maximal").getKeyValuePair());
Assert.assertTrue(originalStackModel.isDefined());
originalStackModel.protect();
final PathAddress subsystemAddress = PathAddress.pathAddress(JGroupsSubsystemResourceDefinition.PATH);
final PathAddress forkAddress = subsystemAddress.append(ChannelResourceDefinition.pathElement("ee")).append(ForkResourceDefinition.pathElement("web"));
final PathAddress stackAddress = subsystemAddress.append(StackResourceDefinition.pathElement("maximal"));
//Check the fork protocols honour indexed adds by inserting a protocol at the start
ModelNode add = Operations.createAddOperation(forkAddress.append(ProtocolResourceDefinition.pathElement("MERGE2")), 0);
ModelTestUtils.checkOutcome(services.executeOperation(add));
ModelNode subsystemModel = services.readWholeModel().get(JGroupsSubsystemResourceDefinition.PATH.getKeyValuePair());
ModelNode channelModel = subsystemModel.get(ChannelResourceDefinition.pathElement("ee").getKeyValuePair());
ModelNode forkModel = channelModel.get(ForkResourceDefinition.pathElement("web").getKeyValuePair());
Assert.assertEquals(originalForkModel.keys().size() + 1, forkModel.get(ProtocolResourceDefinition.WILDCARD_PATH.getKey()).keys().size());
Assert.assertEquals("MERGE2", forkModel.get(ProtocolResourceDefinition.WILDCARD_PATH.getKey()).keys().iterator().next());
//Check the stack protocols honour indexed adds by removing a protocol in the middle and readding it
ModelNode remove = Util.createRemoveOperation(stackAddress.append(ProtocolResourceDefinition.pathElement("FD")));
ModelTestUtils.checkOutcome(services.executeOperation(remove));
add = Operations.createAddOperation(stackAddress.append(ProtocolResourceDefinition.pathElement("FD")), 3); //The original index of the FD protocol
ModelTestUtils.checkOutcome(services.executeOperation(add));
subsystemModel = services.readWholeModel().get(JGroupsSubsystemResourceDefinition.PATH.getKeyValuePair());
ModelNode stackModel = subsystemModel.get(StackResourceDefinition.pathElement("maximal").getKeyValuePair());
Assert.assertEquals(originalStackModel, stackModel);
}
}