001/**
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018package org.apache.hadoop.hbase.http;
019
020import java.io.BufferedReader;
021import java.io.IOException;
022import java.io.InputStreamReader;
023import java.net.URL;
024import java.net.URLConnection;
025import java.util.Set;
026import java.util.TreeSet;
027import javax.servlet.Filter;
028import javax.servlet.FilterChain;
029import javax.servlet.FilterConfig;
030import javax.servlet.ServletException;
031import javax.servlet.ServletRequest;
032import javax.servlet.ServletResponse;
033import javax.servlet.http.HttpServletRequest;
034import org.apache.hadoop.conf.Configuration;
035import org.apache.hadoop.hbase.HBaseClassTestRule;
036import org.apache.hadoop.hbase.testclassification.MiscTests;
037import org.apache.hadoop.hbase.testclassification.SmallTests;
038import org.apache.hadoop.net.NetUtils;
039import org.junit.ClassRule;
040import org.junit.Test;
041import org.junit.experimental.categories.Category;
042import org.slf4j.Logger;
043import org.slf4j.LoggerFactory;
044
045@Category({MiscTests.class, SmallTests.class})
046public class TestGlobalFilter extends HttpServerFunctionalTest {
047
048  @ClassRule
049  public static final HBaseClassTestRule CLASS_RULE =
050      HBaseClassTestRule.forClass(TestGlobalFilter.class);
051
052  private static final Logger LOG = LoggerFactory.getLogger(HttpServer.class);
053  static final Set<String> RECORDS = new TreeSet<>();
054
055  /** A very simple filter that records accessed uri's */
056  static public class RecordingFilter implements Filter {
057    private FilterConfig filterConfig = null;
058
059    @Override
060    public void init(FilterConfig filterConfig) {
061      this.filterConfig = filterConfig;
062    }
063
064    @Override
065    public void destroy() {
066      this.filterConfig = null;
067    }
068
069    @Override
070    public void doFilter(ServletRequest request, ServletResponse response,
071        FilterChain chain) throws IOException, ServletException {
072      if (filterConfig == null)
073         return;
074
075      String uri = ((HttpServletRequest)request).getRequestURI();
076      LOG.info("filtering " + uri);
077      RECORDS.add(uri);
078      chain.doFilter(request, response);
079    }
080
081    /** Configuration for RecordingFilter */
082    static public class Initializer extends FilterInitializer {
083      public Initializer() {}
084
085      @Override
086      public void initFilter(FilterContainer container, Configuration conf) {
087        container.addGlobalFilter("recording", RecordingFilter.class.getName(), null);
088      }
089    }
090  }
091
092
093  /** access a url, ignoring some IOException such as the page does not exist */
094  static void access(String urlstring) throws IOException {
095    LOG.warn("access " + urlstring);
096    URL url = new URL(urlstring);
097    URLConnection connection = url.openConnection();
098    connection.connect();
099
100    try {
101      BufferedReader in = new BufferedReader(new InputStreamReader(
102          connection.getInputStream()));
103      try {
104        for(; in.readLine() != null; );
105      } finally {
106        in.close();
107      }
108    } catch(IOException ioe) {
109      LOG.warn("urlstring=" + urlstring, ioe);
110    }
111  }
112
113  @Test
114  public void testServletFilter() throws Exception {
115    Configuration conf = new Configuration();
116
117    //start a http server with CountingFilter
118    conf.set(HttpServer.FILTER_INITIALIZERS_PROPERTY,
119        RecordingFilter.Initializer.class.getName());
120    HttpServer http = createTestServer(conf);
121    http.start();
122
123    final String fsckURL = "/fsck";
124    final String stacksURL = "/stacks";
125    final String ajspURL = "/a.jsp";
126    final String listPathsURL = "/listPaths";
127    final String dataURL = "/data";
128    final String streamFile = "/streamFile";
129    final String rootURL = "/";
130    final String allURL = "/*";
131    final String outURL = "/static/a.out";
132    final String logURL = "/logs/a.log";
133
134    final String[] urls = {fsckURL, stacksURL, ajspURL, listPathsURL,
135        dataURL, streamFile, rootURL, allURL, outURL, logURL};
136
137    //access the urls
138    final String prefix = "http://"
139        + NetUtils.getHostPortString(http.getConnectorAddress(0));
140    try {
141      for(int i = 0; i < urls.length; i++) {
142        access(prefix + urls[i]);
143      }
144    } finally {
145      http.stop();
146    }
147
148    LOG.info("RECORDS = " + RECORDS);
149
150    //verify records
151    for(int i = 0; i < urls.length; i++) {
152      assertTrue(RECORDS.remove(urls[i]));
153    }
154    assertTrue(RECORDS.isEmpty());
155  }
156}