ARTEMIS-4160 Handle hostnames with double dashes

Previously, the code added a comment with the host name in it.
Sometimes hostnames don't follow the xml standards for comments.
Specifically, having a double dash ("--") in the host name would cause
an error when jolokia tried to load the config file - because it was
invalid xml.

The simple solution was to not put the host name into the comment.

A unit test has been included to ensure the same thing doesn't happen in the
future.

Signed-off-by: David Lanouette <David.Lanouette@RedHat.com>
This commit is contained in:
David Lanouette 2023-02-10 12:40:11 -05:00 committed by Bruscino Domenico Francesco
parent 7fe1a20909
commit 7e1f6c1abe
3 changed files with 114 additions and 1 deletions

View File

@ -395,10 +395,22 @@ public class Create extends InstallAbstract {
this.etc = etc;
}
protected void setNoAutoTune(boolean autTune) {
this.noAutoTune = autTune;
}
public boolean isAutoDelete() {
return autoDelete;
}
protected void setHttpHost(String httpHost) {
this.httpHost = httpHost;
}
protected void setRelaxJolokia(boolean relaxJolokia) {
this.relaxJolokia = relaxJolokia;
}
public Create setAutoDelete(boolean autoDelete) {
this.autoDelete = autoDelete;
return this;

View File

@ -23,7 +23,7 @@ under the License.
<restrict>
<cors>
<!-- Allow cross origin access from ${http.host} ... -->
<!-- Allow cross-origin access from the origins that match the following pattern ... -->
<allow-origin>*://${http.host}*</allow-origin>

View File

@ -0,0 +1,101 @@
/*
* 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 org.apache.activemq.artemis.cli.commands;
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.ParserConfigurationException;
import java.io.File;
import java.io.IOException;
import java.util.Arrays;
import java.util.Collection;
import org.apache.activemq.artemis.utils.XmlProvider;
import org.apache.activemq.cli.test.CliTestBase;
import org.apache.activemq.cli.test.TestActionContext;
import org.junit.Assert;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.Parameterized;
import org.xml.sax.SAXException;
@RunWith(Parameterized.class)
public class CreateTest extends CliTestBase {
private final String testName;
private String httpHost;
private boolean relaxJolokia;
public CreateTest(String testName, String httpHost, boolean relaxJolokia) throws IOException {
this.testName = testName;
this.httpHost = httpHost;
this.relaxJolokia = relaxJolokia;
}
@Parameterized.Parameters(name = "{0}")
public static Collection<Object[]> testData() {
return Arrays.asList(new Object[][]{
{"Happy path + relaxJolokia", "sampledomain.com", true},
{"Happy path - relaxJolokia", "sampledomain.net", false},
{"Domain with dash + relaxJolokia", "sample-domain.co", true},
{"Domain with dash - relaxJolokia", "sample-domain.co.uk", false},
{"Domain with double dashes + relaxJolokia", "sample--domain.name", true},
{"Domain with double dashes - relaxJolokia", "sample--domain.biz", false},
{"Domain with leading dashes + relaxJolokia", "--sampledomain.company", true},
{"Domain with leading dashes - relaxJolokia", "--sampledomain.email", false},
{"Domain with trailing dashes + relaxJolokia", "sampledomain--.shop", true},
{"Domain with trailing dashes - relaxJolokia", "sampledomain--.java", false},
});
}
@Test
public void testWriteJolokiaAccessXmlCreatesValidXml() throws Exception {
TestActionContext context = new TestActionContext();
File testInstance = new File(temporaryFolder.getRoot(), "test-instance");
Create c = new Create();
c.setNoAutoTune(true);
c.setInstance(testInstance);
c.setHttpHost(httpHost);
c.setRelaxJolokia(relaxJolokia);
c.execute(context);
Assert.assertTrue(isXmlValid(new File(testInstance, "etc/" + Create.ETC_JOLOKIA_ACCESS_XML)));
}
/**
* IsXmlValid will check if a given xml file is valid by parsing the xml to create a Document.
* <p>
* If it parses, the xml is assumed to be valid. If any exceptions occur, the xml is not valid.
*
* @param xml The xml file to check for validity.
* @return whether the xml file represents a valid xml document.
*/
private boolean isXmlValid(File xml) {
try {
DocumentBuilder dbuilder = XmlProvider.newDocumentBuilder();
dbuilder.parse(xml);
} catch (ParserConfigurationException e) {
return false;
} catch (IOException e) {
return false;
} catch (SAXException e) {
return false;
}
return true;
}
}