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.coprocessor;
21  
22  import java.io.IOException;
23  import java.util.concurrent.atomic.AtomicBoolean;
24  
25  import static org.mockito.Mockito.*;
26  import static org.junit.Assert.*;
27  
28  import org.apache.hadoop.conf.Configuration;
29  import org.apache.hadoop.hbase.Coprocessor;
30  import org.apache.hadoop.hbase.CoprocessorEnvironment;
31  import org.apache.hadoop.hbase.HBaseConfiguration;
32  import org.apache.hadoop.hbase.HRegionInfo;
33  import org.apache.hadoop.hbase.HTableDescriptor;
34  import org.apache.hadoop.hbase.TableName;
35  import org.apache.hadoop.hbase.master.MasterCoprocessorHost;
36  import org.apache.hadoop.hbase.master.MasterServices;
37  import org.apache.hadoop.hbase.regionserver.HRegion;
38  import org.apache.hadoop.hbase.regionserver.RegionCoprocessorHost;
39  import org.apache.hadoop.hbase.regionserver.RegionServerCoprocessorHost;
40  import org.apache.hadoop.hbase.regionserver.RegionServerServices;
41  import org.apache.hadoop.hbase.testclassification.SmallTests;
42  import org.junit.Test;
43  import org.junit.experimental.categories.Category;
44  
45  /**
46   * Tests for global coprocessor loading configuration
47   */
48  @Category(SmallTests.class)
49  public class TestCoprocessorConfiguration {
50  
51    private static final Configuration CONF = HBaseConfiguration.create();
52    static {
53      CONF.setStrings(CoprocessorHost.MASTER_COPROCESSOR_CONF_KEY,
54        SystemCoprocessor.class.getName());
55      CONF.setStrings(CoprocessorHost.REGIONSERVER_COPROCESSOR_CONF_KEY,
56        SystemCoprocessor.class.getName());
57      CONF.setStrings(CoprocessorHost.REGION_COPROCESSOR_CONF_KEY,
58        SystemCoprocessor.class.getName());
59    }
60    private static final TableName TABLENAME = TableName.valueOf("TestCoprocessorConfiguration");
61    private static final HRegionInfo REGIONINFO = new HRegionInfo(TABLENAME);
62    private static final HTableDescriptor TABLEDESC = new HTableDescriptor(TABLENAME);
63    static {
64      try {
65        TABLEDESC.addCoprocessor(TableCoprocessor.class.getName());
66      } catch (IOException e) {
67        throw new RuntimeException(e);
68      }
69    }
70  
71    // use atomic types in case coprocessor loading is ever multithreaded, also
72    // so we can mutate them even though they are declared final here
73    private static final AtomicBoolean systemCoprocessorLoaded = new AtomicBoolean();
74    private static final AtomicBoolean tableCoprocessorLoaded = new AtomicBoolean();
75  
76    public static class SystemCoprocessor implements Coprocessor {
77      @Override
78      public void start(CoprocessorEnvironment env) throws IOException {
79        systemCoprocessorLoaded.set(true);
80      }
81  
82      @Override
83      public void stop(CoprocessorEnvironment env) throws IOException { }
84    }
85  
86    public static class TableCoprocessor implements Coprocessor {
87      @Override
88      public void start(CoprocessorEnvironment env) throws IOException {
89        tableCoprocessorLoaded.set(true);
90      }
91  
92      @Override
93      public void stop(CoprocessorEnvironment env) throws IOException { }
94    }
95  
96    @Test
97    public void testRegionCoprocessorHostDefaults() throws Exception {
98      Configuration conf = new Configuration(CONF);
99      HRegion region = mock(HRegion.class);
100     when(region.getRegionInfo()).thenReturn(REGIONINFO);
101     when(region.getTableDesc()).thenReturn(TABLEDESC);
102     RegionServerServices rsServices = mock(RegionServerServices.class);
103     systemCoprocessorLoaded.set(false);
104     tableCoprocessorLoaded.set(false);
105     new RegionCoprocessorHost(region, rsServices, conf);
106     assertEquals("System coprocessors loading default was not honored",
107       systemCoprocessorLoaded.get(),
108       CoprocessorHost.DEFAULT_COPROCESSORS_ENABLED);
109     assertEquals("Table coprocessors loading default was not honored",
110       tableCoprocessorLoaded.get(), 
111       CoprocessorHost.DEFAULT_COPROCESSORS_ENABLED &&
112       CoprocessorHost.DEFAULT_USER_COPROCESSORS_ENABLED);
113   }
114 
115   @Test
116   public void testRegionServerCoprocessorHostDefaults() throws Exception {
117     Configuration conf = new Configuration(CONF);
118     RegionServerServices rsServices = mock(RegionServerServices.class);
119     systemCoprocessorLoaded.set(false);
120     new RegionServerCoprocessorHost(rsServices, conf);
121     assertEquals("System coprocessors loading default was not honored",
122       systemCoprocessorLoaded.get(),
123       CoprocessorHost.DEFAULT_COPROCESSORS_ENABLED);
124   }
125 
126   @Test
127   public void testMasterCoprocessorHostDefaults() throws Exception {
128     Configuration conf = new Configuration(CONF);
129     MasterServices masterServices = mock(MasterServices.class);
130     systemCoprocessorLoaded.set(false);
131     new MasterCoprocessorHost(masterServices, conf);
132     assertEquals("System coprocessors loading default was not honored",
133       systemCoprocessorLoaded.get(),
134       CoprocessorHost.DEFAULT_COPROCESSORS_ENABLED);
135   }
136 
137   @Test
138   public void testRegionCoprocessorHostAllDisabled() throws Exception {
139     Configuration conf = new Configuration(CONF);
140     conf.setBoolean(CoprocessorHost.COPROCESSORS_ENABLED_CONF_KEY, false);
141     HRegion region = mock(HRegion.class);
142     when(region.getRegionInfo()).thenReturn(REGIONINFO);
143     when(region.getTableDesc()).thenReturn(TABLEDESC);
144     RegionServerServices rsServices = mock(RegionServerServices.class);
145     systemCoprocessorLoaded.set(false);
146     tableCoprocessorLoaded.set(false);
147     new RegionCoprocessorHost(region, rsServices, conf);
148     assertFalse("System coprocessors should not have been loaded",
149       systemCoprocessorLoaded.get());
150     assertFalse("Table coprocessors should not have been loaded",
151       tableCoprocessorLoaded.get());
152   }
153 
154   @Test
155   public void testRegionCoprocessorHostTableLoadingDisabled() throws Exception {
156     Configuration conf = new Configuration(CONF);
157     conf.setBoolean(CoprocessorHost.COPROCESSORS_ENABLED_CONF_KEY, true); // if defaults change
158     conf.setBoolean(CoprocessorHost.USER_COPROCESSORS_ENABLED_CONF_KEY, false);
159     HRegion region = mock(HRegion.class);
160     when(region.getRegionInfo()).thenReturn(REGIONINFO);
161     when(region.getTableDesc()).thenReturn(TABLEDESC);
162     RegionServerServices rsServices = mock(RegionServerServices.class);
163     systemCoprocessorLoaded.set(false);
164     tableCoprocessorLoaded.set(false);
165     new RegionCoprocessorHost(region, rsServices, conf);
166     assertTrue("System coprocessors should have been loaded",
167       systemCoprocessorLoaded.get());
168     assertFalse("Table coprocessors should not have been loaded",
169       tableCoprocessorLoaded.get());
170   }
171 }