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.regionserver.wal;
019
020import static org.junit.jupiter.api.Assertions.assertEquals;
021import static org.junit.jupiter.api.Assertions.assertThrows;
022
023import org.apache.hadoop.conf.Configuration;
024import org.apache.hadoop.hbase.testclassification.RegionServerTests;
025import org.apache.hadoop.hbase.testclassification.SmallTests;
026import org.junit.jupiter.api.Tag;
027import org.junit.jupiter.api.Test;
028
029/**
030 * Test that we can create, load, setup our own custom codec
031 */
032@Tag(RegionServerTests.TAG)
033@Tag(SmallTests.TAG)
034public class TestCustomWALCellCodec {
035
036  public static class CustomWALCellCodec extends WALCellCodec {
037    public Configuration conf;
038    public CompressionContext context;
039
040    public CustomWALCellCodec(Configuration conf, CompressionContext compression) {
041      super(conf, compression);
042      this.conf = conf;
043      this.context = compression;
044    }
045  }
046
047  /**
048   * Test that a custom {@link WALCellCodec} will be completely setup when it is instantiated via
049   * {@link WALCellCodec}
050   * @throws Exception on failure
051   */
052  @Test
053  public void testCreatePreparesCodec() throws Exception {
054    Configuration conf = new Configuration(false);
055    conf.setClass(WALCellCodec.WAL_CELL_CODEC_CLASS_KEY, CustomWALCellCodec.class,
056      WALCellCodec.class);
057    CustomWALCellCodec codec = (CustomWALCellCodec) WALCellCodec.create(conf, null, null);
058    assertEquals(conf, codec.conf,
059      "Custom codec didn't get initialized with the right configuration!");
060    assertEquals(null, codec.context,
061      "Custom codec didn't get initialized with the right compression context!");
062  }
063
064  /**
065   * Test that a custom {@link WALCellCodec} will fail if provided an invalid code class.
066   */
067  @Test
068  public void testCreatePreparesCodecInvalidClass() throws Exception {
069    assertThrows(RuntimeException.class, () -> {
070      Configuration conf = new Configuration(false);
071      conf.setStrings(WALCellCodec.WAL_CELL_CODEC_CLASS_KEY, "org.apache.hbase.wal.NoSuchClass");
072      WALCellCodec.create(conf, null, null);
073    });
074  }
075}