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.assertEquals;
23  import static org.junit.Assert.assertTrue;
24  
25  import java.io.IOException;
26  
27  import org.apache.hadoop.hbase.util.ByteStringer;
28  import org.apache.hadoop.conf.Configuration;
29  import org.apache.hadoop.hbase.HBaseConfiguration;
30  import org.apache.hadoop.hbase.HConstants;
31  import org.apache.hadoop.hbase.HRegionInfo;
32  import org.apache.hadoop.hbase.MediumTests;
33  import org.apache.hadoop.hbase.ipc.PriorityFunction;
34  import org.apache.hadoop.hbase.protobuf.generated.ClientProtos.Get;
35  import org.apache.hadoop.hbase.protobuf.generated.ClientProtos.GetRequest;
36  import org.apache.hadoop.hbase.protobuf.generated.ClientProtos.ScanRequest;
37  import org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.RegionSpecifier;
38  import org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.RegionSpecifier.RegionSpecifierType;
39  import org.apache.hadoop.hbase.protobuf.generated.RPCProtos.RequestHeader;
40  import org.junit.Before;
41  import org.junit.Test;
42  import org.junit.experimental.categories.Category;
43  import org.mockito.Mockito;
44  
45  import com.google.protobuf.ByteString;
46  
47  /**
48   * Tests that verify certain RPCs get a higher QoS.
49   */
50  @Category(MediumTests.class)
51  public class TestPriorityRpc {
52    private HRegionServer regionServer = null;
53    private PriorityFunction priority = null;
54  
55    @Before
56    public void setup() {
57      Configuration conf = HBaseConfiguration.create();
58      regionServer = HRegionServer.constructRegionServer(HRegionServer.class, conf);
59      priority = regionServer.getPriority();
60    }
61  
62    @Test
63    public void testQosFunctionForMeta() throws IOException {
64      priority = regionServer.getPriority();
65      RequestHeader.Builder headerBuilder = RequestHeader.newBuilder();
66      //create a rpc request that has references to hbase:meta region and also
67      //uses one of the known argument classes (known argument classes are
68      //listed in HRegionServer.QosFunctionImpl.knownArgumentClasses)
69      headerBuilder.setMethodName("foo");
70  
71      GetRequest.Builder getRequestBuilder = GetRequest.newBuilder();
72      RegionSpecifier.Builder regionSpecifierBuilder = RegionSpecifier.newBuilder();
73      regionSpecifierBuilder.setType(RegionSpecifierType.REGION_NAME);
74      ByteString name = ByteStringer.wrap(HRegionInfo.FIRST_META_REGIONINFO.getRegionName());
75      regionSpecifierBuilder.setValue(name);
76      RegionSpecifier regionSpecifier = regionSpecifierBuilder.build();
77      getRequestBuilder.setRegion(regionSpecifier);
78      Get.Builder getBuilder = Get.newBuilder();
79      getBuilder.setRow(ByteStringer.wrap("somerow".getBytes()));
80      getRequestBuilder.setGet(getBuilder.build());
81      GetRequest getRequest = getRequestBuilder.build();
82      RequestHeader header = headerBuilder.build();
83      HRegion mockRegion = Mockito.mock(HRegion.class);
84      HRegionServer mockRS = Mockito.mock(HRegionServer.class);
85      HRegionInfo mockRegionInfo = Mockito.mock(HRegionInfo.class);
86      Mockito.when(mockRS.getRegion((RegionSpecifier)Mockito.any())).thenReturn(mockRegion);
87      Mockito.when(mockRegion.getRegionInfo()).thenReturn(mockRegionInfo);
88      Mockito.when(mockRegionInfo.isMetaTable()).thenReturn(true);
89      // Presume type.
90      ((AnnotationReadingPriorityFunction)priority).setRegionServer(mockRS);
91      assertEquals(HConstants.HIGH_QOS, priority.getPriority(header, getRequest));
92    }
93  
94    @Test
95    public void testQosFunctionWithoutKnownArgument() throws IOException {
96      //The request is not using any of the
97      //known argument classes (it uses one random request class)
98      //(known argument classes are listed in
99      //HRegionServer.QosFunctionImpl.knownArgumentClasses)
100     RequestHeader.Builder headerBuilder = RequestHeader.newBuilder();
101     headerBuilder.setMethodName("foo");
102     RequestHeader header = headerBuilder.build();
103     PriorityFunction qosFunc = regionServer.getPriority();
104     assertEquals(HConstants.NORMAL_QOS, qosFunc.getPriority(header, null));
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     // Presume type.
123     ((AnnotationReadingPriorityFunction)priority).setRegionServer(mockRS);
124     int qos = priority.getPriority(header, scanRequest);
125     assertTrue ("" + qos, qos == HConstants.NORMAL_QOS);
126 
127     //build a scan request with scannerID
128     scanBuilder = ScanRequest.newBuilder();
129     scanBuilder.setScannerId(12345);
130     scanRequest = scanBuilder.build();
131     //mock out a high priority type handling and see the QoS returned
132     RegionScanner mockRegionScanner = Mockito.mock(RegionScanner.class);
133     Mockito.when(mockRS.getScanner(12345)).thenReturn(mockRegionScanner);
134     Mockito.when(mockRegionScanner.getRegionInfo()).thenReturn(mockRegionInfo);
135     Mockito.when(mockRS.getRegion((RegionSpecifier)Mockito.any())).thenReturn(mockRegion);
136     Mockito.when(mockRegion.getRegionInfo()).thenReturn(mockRegionInfo);
137     Mockito.when(mockRegionInfo.isMetaRegion()).thenReturn(true);
138 
139     // Presume type.
140     ((AnnotationReadingPriorityFunction)priority).setRegionServer(mockRS);
141 
142     assertEquals(HConstants.HIGH_QOS, priority.getPriority(header, scanRequest));
143 
144     //the same as above but with non-meta region
145     Mockito.when(mockRegionInfo.isMetaRegion()).thenReturn(false);
146     assertEquals(HConstants.NORMAL_QOS, priority.getPriority(header, scanRequest));
147   }
148 }