Repository: knox Updated Branches: refs/heads/master 6212381ec -> 5b57a5151
KNOX-1172: OOZIEUI service definition name conflict Project: http://git-wip-us.apache.org/repos/asf/knox/repo Commit: http://git-wip-us.apache.org/repos/asf/knox/commit/5b57a515 Tree: http://git-wip-us.apache.org/repos/asf/knox/tree/5b57a515 Diff: http://git-wip-us.apache.org/repos/asf/knox/diff/5b57a515 Branch: refs/heads/master Commit: 5b57a5151c5dbb68741f47709c64265f090ef354 Parents: 6212381 Author: Kevin Minder <[email protected]> Authored: Tue Feb 6 13:20:13 2018 -0500 Committer: Kevin Minder <[email protected]> Committed: Tue Feb 6 13:21:56 2018 -0500 ---------------------------------------------------------------------- .../services/oozieui/4.2.0/rewrite.xml | 26 +- .../services/oozieui/4.2.0/service.xml | 5 +- .../apache/knox/gateway/GatewayUIFuncTest.java | 363 +++++++++++++++++++ 3 files changed, 369 insertions(+), 25 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/knox/blob/5b57a515/gateway-service-definitions/src/main/resources/services/oozieui/4.2.0/rewrite.xml ---------------------------------------------------------------------- diff --git a/gateway-service-definitions/src/main/resources/services/oozieui/4.2.0/rewrite.xml b/gateway-service-definitions/src/main/resources/services/oozieui/4.2.0/rewrite.xml index 2e04eec..81350c6 100644 --- a/gateway-service-definitions/src/main/resources/services/oozieui/4.2.0/rewrite.xml +++ b/gateway-service-definitions/src/main/resources/services/oozieui/4.2.0/rewrite.xml @@ -16,28 +16,10 @@ limitations under the License. --> <rules> - <rule dir="IN" name="OOZIEUI/oozie/inbound/root" flow="OR"> - <match pattern="http://*:*/**/oozie/";> - <rewrite template="{$serviceUrl[OOZIEUI]}/"/> - </match> - <match pattern="https://*:*/**/oozie/";> - <rewrite template="{$serviceUrl[OOZIEUI]}/"/> - </match> + <rule dir="IN" name="OOZIEUI/oozie/root" pattern="*://*:*/**/oozie?{**}"> + <rewrite template="{$serviceUrl[OOZIEUI]}/?{**}"/> </rule> - <rule dir="IN" name="OOZIEUI/oozie/inbound/path" flow="OR"> - <match pattern="http://*:*/**/oozie/{**}";> - <rewrite template="{$serviceUrl[OOZIEUI]}/{**}"/> - </match> - <match pattern="https://*:*/**/oozie/{**}";> - <rewrite template="{$serviceUrl[OOZIEUI]}/{**}"/> - </match> - </rule> - <rule dir="IN" name="OOZIEUI/oozie/inbound/query" flow="OR"> - <match pattern="http://*:*/**/oozie/{**}?{**}";> - <rewrite template="{$serviceUrl[OOZIEUI]}/{**}?{**}"/> - </match> - <match pattern="https://*:*/**/oozie/{**}?{**}";> - <rewrite template="{$serviceUrl[OOZIEUI]}/{**}?{**}"/> - </match> + <rule dir="IN" name="OOZIEUI/oozie/path" pattern="*://*:*/**/oozie/{**}?{**}"> + <rewrite template="{$serviceUrl[OOZIEUI]}/{**}?{**}"/> </rule> </rules> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/knox/blob/5b57a515/gateway-service-definitions/src/main/resources/services/oozieui/4.2.0/service.xml ---------------------------------------------------------------------- diff --git a/gateway-service-definitions/src/main/resources/services/oozieui/4.2.0/service.xml b/gateway-service-definitions/src/main/resources/services/oozieui/4.2.0/service.xml index 370888d..1a3f206 100644 --- a/gateway-service-definitions/src/main/resources/services/oozieui/4.2.0/service.xml +++ b/gateway-service-definitions/src/main/resources/services/oozieui/4.2.0/service.xml @@ -15,10 +15,9 @@ See the License for the specific language governing permissions and limitations under the License. --> -<service role="OOZIEUI" name="oozie" version="4.2.0"> +<service role="OOZIEUI" name="oozieui" version="4.2.0"> <routes> - <route path="/oozie/"/> - <route path="/oozie/**"/> + <route path="/oozie?**"/> <route path="/oozie/**?**"/> </routes> </service> http://git-wip-us.apache.org/repos/asf/knox/blob/5b57a515/gateway-test/src/test/java/org/apache/knox/gateway/GatewayUIFuncTest.java ---------------------------------------------------------------------- diff --git a/gateway-test/src/test/java/org/apache/knox/gateway/GatewayUIFuncTest.java b/gateway-test/src/test/java/org/apache/knox/gateway/GatewayUIFuncTest.java new file mode 100644 index 0000000..59dfb23 --- /dev/null +++ b/gateway-test/src/test/java/org/apache/knox/gateway/GatewayUIFuncTest.java @@ -0,0 +1,363 @@ +/** + * 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.knox.gateway; + +import java.io.ByteArrayOutputStream; +import java.io.File; +import java.io.FileFilter; +import java.io.FileNotFoundException; +import java.io.IOException; +import java.io.PrintStream; +import java.io.StringWriter; +import java.net.InetAddress; +import java.net.InetSocketAddress; +import java.net.URI; +import java.net.URISyntaxException; +import java.net.URL; +import java.nio.charset.Charset; +import java.util.HashMap; +import java.util.Map; +import java.util.Map.Entry; +import javax.ws.rs.core.MediaType; + +import com.mycila.xmltool.XMLDoc; +import com.mycila.xmltool.XMLTag; +import io.restassured.RestAssured; +import io.restassured.http.ContentType; +import io.restassured.http.Cookie; +import io.restassured.http.Header; +import io.restassured.path.json.JsonPath; +import io.restassured.response.Response; +import io.restassured.specification.ResponseSpecification; +import org.apache.commons.io.filefilter.WildcardFileFilter; +import org.apache.commons.lang3.ArrayUtils; +import org.apache.http.HttpHost; +import org.apache.http.HttpResponse; +import org.apache.http.HttpStatus; +import org.apache.http.auth.AuthScope; +import org.apache.http.auth.UsernamePasswordCredentials; +import org.apache.http.client.AuthCache; +import org.apache.http.client.CredentialsProvider; +import org.apache.http.client.methods.HttpGet; +import org.apache.http.client.methods.HttpPost; +import org.apache.http.client.protocol.HttpClientContext; +import org.apache.http.entity.StringEntity; +import org.apache.http.impl.auth.BasicScheme; +import org.apache.http.impl.client.BasicAuthCache; +import org.apache.http.impl.client.BasicCredentialsProvider; +import org.apache.http.impl.client.CloseableHttpClient; +import org.apache.http.impl.client.HttpClientBuilder; +import org.apache.http.util.EntityUtils; +import org.apache.knox.gateway.util.KnoxCLI; +import org.apache.knox.test.TestUtils; +import org.apache.knox.test.category.MediumTests; +import org.apache.knox.test.category.VerifyTest; +import org.apache.knox.test.mock.MockRequestMatcher; +import org.apache.velocity.Template; +import org.apache.velocity.VelocityContext; +import org.apache.velocity.app.VelocityEngine; +import org.apache.velocity.runtime.RuntimeConstants; +import org.apache.velocity.runtime.resource.loader.ClasspathResourceLoader; +import org.hamcrest.CoreMatchers; +import org.hamcrest.Matcher; +import org.hamcrest.MatcherAssert; +import org.hamcrest.Matchers; +import org.junit.After; +import org.junit.AfterClass; +import org.junit.Assert; +import org.junit.BeforeClass; +import org.junit.Test; +import org.junit.experimental.categories.Category; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import static io.restassured.RestAssured.given; +import static org.apache.knox.test.TestUtils.LOG_ENTER; +import static org.apache.knox.test.TestUtils.LOG_EXIT; +import static org.hamcrest.CoreMatchers.anyOf; +import static org.hamcrest.CoreMatchers.either; +import static org.hamcrest.CoreMatchers.is; +import static org.hamcrest.CoreMatchers.not; +import static org.hamcrest.CoreMatchers.startsWith; +import static org.hamcrest.Matchers.containsString; +import static org.hamcrest.Matchers.greaterThan; +import static org.hamcrest.text.IsEmptyString.isEmptyString; +import static org.junit.Assert.assertThat; +import static org.junit.Assert.assertTrue; +import static org.xmlmatchers.XmlMatchers.isEquivalentTo; +import static org.xmlmatchers.transform.XmlConverters.the; +import static uk.co.datumedge.hamcrest.json.SameJSONAs.sameJSONAs; + +@Category( { VerifyTest.class, MediumTests.class } ) +public class GatewayUIFuncTest { + + private static final Charset UTF8 = Charset.forName("UTF-8"); + + // Uncomment to cause the test to hang after the gateway instance is setup. + // This will allow the gateway instance to be hit directly via some external client. +// @Test +// public void hang() throws IOException { +// System.out.println( "Server on port " + driver.gateway.getAddresses()[0].getPort() ); +// System.out.println(); +// System.in.read(); +// } + + private static Logger log = LoggerFactory.getLogger( GatewayUIFuncTest.class ); + + private static GatewayTestDriver driver = new GatewayTestDriver(); + + // Controls the host name to which the gateway dispatch requests. This may be the name of a sandbox VM + // or an EC2 instance. Currently only a single host is supported. + private static final String TEST_HOST = "vm.local"; + + // Specifies if the test requests should go through the gateway or directly to the services. + // This is frequently used to verify the behavior of the test both with and without the gateway. + private static final boolean USE_GATEWAY = true; + + // Specifies if the test requests should be sent to mock services or the real services. + // This is frequently used to verify the behavior of the test both with and without mock services. + private static final boolean USE_MOCK_SERVICES = true; + + // Specifies if the GATEWAY_HOME created for the test should be deleted when the test suite is complete. + // This is frequently used during debugging to keep the GATEWAY_HOME around for inspection. + private static final boolean CLEANUP_TEST = true; + +// private static final boolean USE_GATEWAY = false; +// private static final boolean USE_MOCK_SERVICES = false; +// private static final boolean CLEANUP_TEST = false; + + /** + * Creates a deployment of a gateway instance that all test methods will share. This method also creates a + * registry of sorts for all of the services that will be used by the test methods. + * The createTopology method is used to create the topology file that would normally be read from disk. + * The driver.setupGateway invocation is where the creation of GATEWAY_HOME occurs. + * @throws Exception Thrown if any failure occurs. + */ + @BeforeClass + public static void setupSuite() throws Exception { + //Log.setLog( new NoOpLogger() ); + LOG_ENTER(); + GatewayTestConfig config = new GatewayTestConfig(); + driver.setResourceBase(GatewayUIFuncTest.class); + driver.setupLdap(0); + driver.setupService( "OOZIEUI", "http://"; + TEST_HOST + ":11000/oozie", "/cluster/oozie", USE_MOCK_SERVICES ); + driver.setupGateway( config, "cluster", createTopology(), USE_GATEWAY ); + LOG_EXIT(); + } + + @AfterClass + public static void cleanupSuite() throws Exception { + LOG_ENTER(); + if( CLEANUP_TEST ) { + driver.cleanup(); + } + LOG_EXIT(); + } + + @After + public void cleanupTest() { + driver.reset(); + } + + /** + * Creates a topology that is deployed to the gateway instance for the test suite. + * Note that this topology is shared by all of the test methods in this suite. + * @return A populated XML structure for a topology file. + */ + private static XMLTag createTopology() { + XMLTag xml = XMLDoc.newDocument( true ) + .addRoot( "topology" ) + .addTag( "gateway" ) + .addTag( "provider" ) + .addTag( "role" ).addText( "webappsec" ) + .addTag("name").addText("WebAppSec") + .addTag("enabled").addText("true") + .addTag( "param" ) + .addTag("name").addText("csrf.enabled") + .addTag("value").addText("true").gotoParent().gotoParent() + .addTag("provider") + .addTag("role").addText("authentication") + .addTag("name").addText("ShiroProvider") + .addTag("enabled").addText("true") + .addTag( "param" ) + .addTag("name").addText("main.ldapRealm") + .addTag("value").addText("org.apache.knox.gateway.shirorealm.KnoxLdapRealm").gotoParent() + .addTag( "param" ) + .addTag( "name" ).addText( "main.ldapRealm.userDnTemplate" ) + .addTag( "value" ).addText( "uid={0},ou=people,dc=hadoop,dc=apache,dc=org" ).gotoParent() + .addTag( "param" ) + .addTag( "name" ).addText( "main.ldapRealm.contextFactory.url" ) + .addTag( "value" ).addText( driver.getLdapUrl() ).gotoParent() + .addTag( "param" ) + .addTag( "name" ).addText( "main.ldapRealm.contextFactory.authenticationMechanism" ) + .addTag( "value" ).addText( "simple" ).gotoParent() + .addTag( "param" ) + .addTag( "name" ).addText( "urls./**" ) + .addTag( "value" ).addText( "authcBasic" ).gotoParent().gotoParent() + .addTag("provider") + .addTag("role").addText("identity-assertion") + .addTag("enabled").addText("true") + .addTag("name").addText("Default").gotoParent() + .gotoRoot() + .addTag( "service" ) + .addTag( "role" ).addText( "OOZIEUI" ) + .addTag( "url" ).addText( driver.getRealUrl( "OOZIEUI" ) ).gotoParent(); + //System.out.println( "GATEWAY=" + xml.toString() ); + return xml; + } + + @Test( timeout = TestUtils.MEDIUM_TIMEOUT ) + public void testOozieUIRoutesAndRewriteRules() throws IOException { + LOG_ENTER(); + String username = "guest"; + String password = "guest-password"; + String path; + String url = driver.getUrl( "OOZIEUI" ); + + path = "/oozie-console.css"; + driver.getMock("OOZIEUI") + .expect().method("GET") + .pathInfo(path) + .queryParam( "user.name", username ) + .respond() + .status(HttpStatus.SC_OK) + .contentType("application/json") + .characterEncoding("utf-8"); + given() + .auth().preemptive().basic( username, password ) + .header( "X-XSRF-Header", "test-xsrf-header-value" ) + .then() + .statusCode( 200 ) + .when().get( driver.getUrl( "OOZIEUI" ) + path + ( driver.isUseGateway() ? "" : "?user.name=" + username ) ).asString(); + + path = "/ext-2.2/resources/css/ext-all.css"; + driver.getMock("OOZIEUI") + .expect().method("GET") + .pathInfo(path) + .queryParam( "user.name", username ) + .respond() + .status(HttpStatus.SC_OK) + .contentType("application/json") + .characterEncoding("utf-8"); + given() + .auth().preemptive().basic( username, password ) + .header( "X-XSRF-Header", "test-xsrf-header-value" ) + .then() + .statusCode( 200 ) + .when().get( driver.getUrl( "OOZIEUI" ) + path + ( driver.isUseGateway() ? "" : "?user.name=" + username ) ).asString(); + + path = "/ext-2.2/adapter/ext/ext-base.js"; + driver.getMock("OOZIEUI") + .expect().method("GET") + .pathInfo(path) + .queryParam( "user.name", username ) + .respond() + .status(HttpStatus.SC_OK) + .contentType("application/json") + .characterEncoding("utf-8"); + given() + .auth().preemptive().basic( username, password ) + .header( "X-XSRF-Header", "test-xsrf-header-value" ) + .then() + .statusCode( 200 ) + .when().get( driver.getUrl( "OOZIEUI" ) + path + ( driver.isUseGateway() ? "" : "?user.name=" + username ) ).asString(); + + path = "/console/sla/js/table/jquery-1.8.3.min.js"; + driver.getMock("OOZIEUI") + .expect().method("GET") + .pathInfo(path) + .queryParam( "user.name", username ) + .respond() + .status(HttpStatus.SC_OK) + .contentType("application/json") + .characterEncoding("utf-8"); + given() + .auth().preemptive().basic( username, password ) + .header( "X-XSRF-Header", "test-xsrf-header-value" ) + .then() + .statusCode( 200 ) + .when().get( driver.getUrl( "OOZIEUI" ) + path + ( driver.isUseGateway() ? "" : "?user.name=" + username ) ).asString(); + + path = "/console/sla/css/jquery.dataTables.css"; + driver.getMock("OOZIEUI") + .expect().method("GET") + .pathInfo(path) + .queryParam( "user.name", username ) + .respond() + .status(HttpStatus.SC_OK) + .contentType("application/json") + .characterEncoding("utf-8"); + given() + .auth().preemptive().basic( username, password ) + .header( "X-XSRF-Header", "test-xsrf-header-value" ) + .then() + .statusCode( 200 ) + .when().get( driver.getUrl( "OOZIEUI" ) + path + ( driver.isUseGateway() ? "" : "?user.name=" + username ) ).asString(); + + path = "/console/sla/js/oozie-sla.js"; + driver.getMock("OOZIEUI") + .expect().method("GET") + .pathInfo(path) + .queryParam( "user.name", username ) + .respond() + .status(HttpStatus.SC_OK) + .contentType("application/json") + .characterEncoding("utf-8"); + given() + .auth().preemptive().basic( username, password ) + .header( "X-XSRF-Header", "test-xsrf-header-value" ) + .then() + .statusCode( 200 ) + .when().get( driver.getUrl( "OOZIEUI" ) + path + ( driver.isUseGateway() ? "" : "?user.name=" + username ) ).asString(); + + path = "/console/sla/js/graph/jquery.flot.min.js"; + driver.getMock("OOZIEUI") + .expect().method("GET") + .pathInfo(path) + .queryParam( "user.name", username ) + .respond() + .status(HttpStatus.SC_OK) + .contentType("application/json") + .characterEncoding("utf-8"); + given() + .auth().preemptive().basic( username, password ) + .header( "X-XSRF-Header", "test-xsrf-header-value" ) + .then() + .statusCode( 200 ) + .when().get( driver.getUrl( "OOZIEUI" ) + path + ( driver.isUseGateway() ? "" : "?user.name=" + username ) ).asString(); + + driver.getMock("OOZIEUI") + .expect().method("GET") + .pathInfo("/") + .queryParam( "user.name", username ) + .respond() + .status(HttpStatus.SC_OK) + .contentType("application/json") + .characterEncoding("utf-8"); + given() + .auth().preemptive().basic( username, password ) + .header( "X-XSRF-Header", "test-xsrf-header-value" ) + .then() + .statusCode( 200 ) + .when().get( driver.getUrl( "OOZIEUI" ) + ( driver.isUseGateway() ? "" : "?user.name=" + username ) ).asString(); + + driver.assertComplete(); + LOG_EXIT(); + } + +}
