View Javadoc

1   /*
2    *
3    * Licensed to the Apache Software Foundation (ASF) under one
4    * or more contributor license agreements.  See the NOTICE file
5    * distributed with this work for additional information
6    * regarding copyright ownership.  The ASF licenses this file
7    * to you under the Apache License, Version 2.0 (the
8    * "License"); you may not use this file except in compliance
9    * with the License.  You may obtain a copy of the License at
10   *
11   *     http://www.apache.org/licenses/LICENSE-2.0
12   *
13   * Unless required by applicable law or agreed to in writing, software
14   * distributed under the License is distributed on an "AS IS" BASIS,
15   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16   * See the License for the specific language governing permissions and
17   * limitations under the License.
18   */
19  
20  package org.apache.hadoop.hbase.regionserver;
21  
22  import static org.junit.Assert.*;
23  
24  import java.io.IOException;
25  
26  import org.apache.hadoop.conf.Configuration;
27  import org.apache.hadoop.hbase.HBaseConfiguration;
28  import org.apache.hadoop.hbase.HConstants;
29  import org.apache.hadoop.hbase.HRegionInfo;
30  import org.apache.hadoop.hbase.MediumTests;
31  import org.apache.hadoop.hbase.protobuf.generated.ClientProtos.Get;
32  import org.apache.hadoop.hbase.protobuf.generated.ClientProtos.GetRequest;
33  import org.apache.hadoop.hbase.protobuf.generated.ClientProtos.ScanRequest;
34  import org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.RegionSpecifier;
35  import org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.RegionSpecifier.RegionSpecifierType;
36  import org.apache.hadoop.hbase.protobuf.generated.RPCProtos.RequestHeader;
37  import org.apache.hadoop.hbase.util.Pair;
38  import org.junit.Before;
39  import org.junit.Test;
40  import org.junit.experimental.categories.Category;
41  import org.mockito.Mockito;
42  
43  import com.google.protobuf.ByteString;
44  import com.google.protobuf.Message;
45  import com.google.protobuf.ZeroCopyLiteralByteString;
46  /**
47   * Tests that verify certain RPCs get a higher QoS.
48   */
49  @Category(MediumTests.class)
50  public class TestPriorityRpc {
51    private HRegionServer regionServer = null;
52    private QosFunction qosFunction = null;
53  
54    @Before
55    public void setup() {
56      Configuration conf = HBaseConfiguration.create();
57      regionServer = HRegionServer.constructRegionServer(HRegionServer.class, conf);
58      qosFunction = regionServer.getQosFunction();
59    }
60  
61    @Test
62    public void testQosFunctionForMeta() throws IOException {
63      qosFunction = regionServer.getQosFunction();
64      RequestHeader.Builder headerBuilder = RequestHeader.newBuilder();
65      //create a rpc request that has references to hbase:meta region and also
66      //uses one of the known argument classes (known argument classes are
67      //listed in HRegionServer.QosFunction.knownArgumentClasses)
68      headerBuilder.setMethodName("foo");
69  
70      GetRequest.Builder getRequestBuilder = GetRequest.newBuilder();
71      RegionSpecifier.Builder regionSpecifierBuilder = RegionSpecifier.newBuilder();
72      regionSpecifierBuilder.setType(RegionSpecifierType.REGION_NAME);
73      ByteString name = ZeroCopyLiteralByteString.wrap(HRegionInfo.FIRST_META_REGIONINFO.getRegionName());
74      regionSpecifierBuilder.setValue(name);
75      RegionSpecifier regionSpecifier = regionSpecifierBuilder.build();
76      getRequestBuilder.setRegion(regionSpecifier);
77      Get.Builder getBuilder = Get.newBuilder();
78      getBuilder.setRow(ZeroCopyLiteralByteString.wrap("somerow".getBytes()));
79      getRequestBuilder.setGet(getBuilder.build());
80      GetRequest getRequest = getRequestBuilder.build();
81      RequestHeader header = headerBuilder.build();
82      HRegion mockRegion = Mockito.mock(HRegion.class);
83      HRegionServer mockRS = Mockito.mock(HRegionServer.class);
84      HRegionInfo mockRegionInfo = Mockito.mock(HRegionInfo.class);
85      Mockito.when(mockRS.getRegion((RegionSpecifier)Mockito.any())).thenReturn(mockRegion);
86      Mockito.when(mockRegion.getRegionInfo()).thenReturn(mockRegionInfo);
87      Mockito.when(mockRegionInfo.isMetaTable()).thenReturn(true);
88      qosFunction.setRegionServer(mockRS);
89      assertTrue (qosFunction.apply(new Pair<RequestHeader, Message>(header, getRequest)) ==
90        HConstants.HIGH_QOS);
91    }
92  
93    @Test
94    public void testQosFunctionWithoutKnownArgument() throws IOException {
95      //The request is not using any of the
96      //known argument classes (it uses one random request class)
97      //(known argument classes are listed in
98      //HRegionServer.QosFunction.knownArgumentClasses)
99      RequestHeader.Builder headerBuilder = RequestHeader.newBuilder();
100     headerBuilder.setMethodName("foo");
101     RequestHeader header = headerBuilder.build();
102     QosFunction qosFunc = regionServer.getQosFunction();
103     assertTrue (qosFunc.apply(new Pair<RequestHeader, Message>(header, null)) ==
104       HConstants.NORMAL_QOS);
105   }
106 
107   @Test
108   public void testQosFunctionForScanMethod() throws IOException {
109     RequestHeader.Builder headerBuilder = RequestHeader.newBuilder();
110     headerBuilder.setMethodName("scan");
111     RequestHeader header = headerBuilder.build();
112 
113     //build an empty scan request
114     ScanRequest.Builder scanBuilder = ScanRequest.newBuilder();
115     ScanRequest scanRequest = scanBuilder.build();
116     HRegion mockRegion = Mockito.mock(HRegion.class);
117     HRegionServer mockRS = Mockito.mock(HRegionServer.class);
118     HRegionInfo mockRegionInfo = Mockito.mock(HRegionInfo.class);
119     Mockito.when(mockRS.getRegion((RegionSpecifier)Mockito.any())).thenReturn(mockRegion);
120     Mockito.when(mockRegion.getRegionInfo()).thenReturn(mockRegionInfo);
121     Mockito.when(mockRegionInfo.isMetaRegion()).thenReturn(false);
122     qosFunction.setRegionServer(mockRS);
123     int qos = qosFunction.apply(new Pair<RequestHeader, Message>(header, scanRequest));
124     assertTrue ("" + qos, qos == HConstants.NORMAL_QOS);
125 
126     //build a scan request with scannerID
127     scanBuilder = ScanRequest.newBuilder();
128     scanBuilder.setScannerId(12345);
129     scanRequest = scanBuilder.build();
130     //mock out a high priority type handling and see the QoS returned
131     RegionScanner mockRegionScanner = Mockito.mock(RegionScanner.class);
132     Mockito.when(mockRS.getScanner(12345)).thenReturn(mockRegionScanner);
133     Mockito.when(mockRegionScanner.getRegionInfo()).thenReturn(mockRegionInfo);
134     Mockito.when(mockRS.getRegion((RegionSpecifier)Mockito.any())).thenReturn(mockRegion);
135     Mockito.when(mockRegion.getRegionInfo()).thenReturn(mockRegionInfo);
136     Mockito.when(mockRegionInfo.isMetaRegion()).thenReturn(true);
137 
138     qosFunction.setRegionServer(mockRS);
139 
140     assertTrue (qosFunction.apply(new Pair<RequestHeader, Message>(header, scanRequest)) ==
141       HConstants.HIGH_QOS);
142 
143     //the same as above but with non-meta region
144     Mockito.when(mockRegionInfo.isMetaRegion()).thenReturn(false);
145     assertTrue (qosFunction.apply(new Pair<RequestHeader, Message>(header, scanRequest)) ==
146       HConstants.NORMAL_QOS);
147   }
148 }