org.apache.hadoop.hbase.rest.TestSchemaResource.java Source code

Java tutorial

Introduction

Here is the source code for org.apache.hadoop.hbase.rest.TestSchemaResource.java

Source

/*
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.hadoop.hbase.rest;

import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.StringWriter;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;

import javax.xml.bind.JAXBContext;
import javax.xml.bind.JAXBException;

import org.apache.commons.httpclient.Header;

import org.apache.hadoop.conf.Configuration;
import org.apache.hadoop.hbase.HBaseTestingUtility;
import org.apache.hadoop.hbase.TableName;
import org.apache.hadoop.hbase.client.Admin;
import org.apache.hadoop.hbase.rest.client.Client;
import org.apache.hadoop.hbase.rest.client.Cluster;
import org.apache.hadoop.hbase.rest.client.Response;
import org.apache.hadoop.hbase.rest.model.ColumnSchemaModel;
import org.apache.hadoop.hbase.rest.model.TableSchemaModel;
import org.apache.hadoop.hbase.rest.model.TestTableSchemaModel;
import org.apache.hadoop.hbase.testclassification.MediumTests;
import org.apache.hadoop.hbase.testclassification.RestTests;
import org.apache.hadoop.hbase.util.Bytes;

import static org.junit.Assert.*;

import org.junit.AfterClass;
import org.junit.BeforeClass;
import org.junit.Test;
import org.junit.experimental.categories.Category;
import org.junit.runner.RunWith;
import org.junit.runners.Parameterized;

@Category({ RestTests.class, MediumTests.class })
@RunWith(Parameterized.class)
public class TestSchemaResource {
    private static String TABLE1 = "TestSchemaResource1";
    private static String TABLE2 = "TestSchemaResource2";

    private static final HBaseTestingUtility TEST_UTIL = new HBaseTestingUtility();
    private static final HBaseRESTTestingUtility REST_TEST_UTIL = new HBaseRESTTestingUtility();
    private static Client client;
    private static JAXBContext context;
    private static Configuration conf;
    private static TestTableSchemaModel testTableSchemaModel;
    private static Header extraHdr = null;

    private static boolean csrfEnabled = true;

    @Parameterized.Parameters
    public static Collection<Object[]> data() {
        List<Object[]> params = new ArrayList<Object[]>();
        params.add(new Object[] { Boolean.TRUE });
        params.add(new Object[] { Boolean.FALSE });
        return params;
    }

    public TestSchemaResource(Boolean csrf) {
        csrfEnabled = csrf;
    }

    @BeforeClass
    public static void setUpBeforeClass() throws Exception {
        conf = TEST_UTIL.getConfiguration();
        conf.setBoolean(RESTServer.REST_CSRF_ENABLED_KEY, csrfEnabled);
        extraHdr = new Header(RESTServer.REST_CSRF_CUSTOM_HEADER_DEFAULT, "");
        TEST_UTIL.startMiniCluster();
        REST_TEST_UTIL.startServletContainer(conf);
        client = new Client(new Cluster().add("localhost", REST_TEST_UTIL.getServletPort()));
        testTableSchemaModel = new TestTableSchemaModel();
        context = JAXBContext.newInstance(ColumnSchemaModel.class, TableSchemaModel.class);
    }

    @AfterClass
    public static void tearDownAfterClass() throws Exception {
        REST_TEST_UTIL.shutdownServletContainer();
        TEST_UTIL.shutdownMiniCluster();
    }

    private static byte[] toXML(TableSchemaModel model) throws JAXBException {
        StringWriter writer = new StringWriter();
        context.createMarshaller().marshal(model, writer);
        return Bytes.toBytes(writer.toString());
    }

    private static TableSchemaModel fromXML(byte[] content) throws JAXBException {
        return (TableSchemaModel) context.createUnmarshaller().unmarshal(new ByteArrayInputStream(content));
    }

    @Test
    public void testTableCreateAndDeleteXML() throws IOException, JAXBException {
        String schemaPath = "/" + TABLE1 + "/schema";
        TableSchemaModel model;
        Response response;

        Admin admin = TEST_UTIL.getHBaseAdmin();
        assertFalse(admin.tableExists(TableName.valueOf(TABLE1)));

        // create the table
        model = testTableSchemaModel.buildTestModel(TABLE1);
        testTableSchemaModel.checkModel(model, TABLE1);
        if (csrfEnabled) {
            // test put operation is forbidden without custom header
            response = client.put(schemaPath, Constants.MIMETYPE_XML, toXML(model));
            assertEquals(response.getCode(), 400);
        }

        response = client.put(schemaPath, Constants.MIMETYPE_XML, toXML(model), extraHdr);
        assertEquals(response.getCode(), 201);

        // recall the same put operation but in read-only mode
        conf.set("hbase.rest.readonly", "true");
        response = client.put(schemaPath, Constants.MIMETYPE_XML, toXML(model), extraHdr);
        assertEquals(response.getCode(), 403);

        // retrieve the schema and validate it
        response = client.get(schemaPath, Constants.MIMETYPE_XML);
        assertEquals(response.getCode(), 200);
        assertEquals(Constants.MIMETYPE_XML, response.getHeader("content-type"));
        model = fromXML(response.getBody());
        testTableSchemaModel.checkModel(model, TABLE1);

        // with json retrieve the schema and validate it
        response = client.get(schemaPath, Constants.MIMETYPE_JSON);
        assertEquals(response.getCode(), 200);
        assertEquals(Constants.MIMETYPE_JSON, response.getHeader("content-type"));
        model = testTableSchemaModel.fromJSON(Bytes.toString(response.getBody()));
        testTableSchemaModel.checkModel(model, TABLE1);

        if (csrfEnabled) {
            // test delete schema operation is forbidden without custom header
            response = client.delete(schemaPath);
            assertEquals(400, response.getCode());
        }

        // test delete schema operation is forbidden in read-only mode
        response = client.delete(schemaPath, extraHdr);
        assertEquals(response.getCode(), 403);

        // return read-only setting back to default
        conf.set("hbase.rest.readonly", "false");

        // delete the table and make sure HBase concurs
        response = client.delete(schemaPath, extraHdr);
        assertEquals(response.getCode(), 200);
        assertFalse(admin.tableExists(TableName.valueOf(TABLE1)));
    }

    @Test
    public void testTableCreateAndDeletePB() throws IOException, JAXBException {
        String schemaPath = "/" + TABLE2 + "/schema";
        TableSchemaModel model;
        Response response;

        Admin admin = TEST_UTIL.getHBaseAdmin();
        assertFalse(admin.tableExists(TableName.valueOf(TABLE2)));

        // create the table
        model = testTableSchemaModel.buildTestModel(TABLE2);
        testTableSchemaModel.checkModel(model, TABLE2);

        if (csrfEnabled) {
            // test put operation is forbidden without custom header
            response = client.put(schemaPath, Constants.MIMETYPE_PROTOBUF, model.createProtobufOutput());
            assertEquals(response.getCode(), 400);
        }
        response = client.put(schemaPath, Constants.MIMETYPE_PROTOBUF, model.createProtobufOutput(), extraHdr);
        assertEquals(response.getCode(), 201);

        // recall the same put operation but in read-only mode
        conf.set("hbase.rest.readonly", "true");
        response = client.put(schemaPath, Constants.MIMETYPE_PROTOBUF, model.createProtobufOutput(), extraHdr);
        assertNotNull(extraHdr);
        assertEquals(response.getCode(), 403);

        // retrieve the schema and validate it
        response = client.get(schemaPath, Constants.MIMETYPE_PROTOBUF);
        assertEquals(response.getCode(), 200);
        assertEquals(Constants.MIMETYPE_PROTOBUF, response.getHeader("content-type"));
        model = new TableSchemaModel();
        model.getObjectFromMessage(response.getBody());
        testTableSchemaModel.checkModel(model, TABLE2);

        // retrieve the schema and validate it with alternate pbuf type
        response = client.get(schemaPath, Constants.MIMETYPE_PROTOBUF_IETF);
        assertEquals(response.getCode(), 200);
        assertEquals(Constants.MIMETYPE_PROTOBUF_IETF, response.getHeader("content-type"));
        model = new TableSchemaModel();
        model.getObjectFromMessage(response.getBody());
        testTableSchemaModel.checkModel(model, TABLE2);

        if (csrfEnabled) {
            // test delete schema operation is forbidden without custom header
            response = client.delete(schemaPath);
            assertEquals(400, response.getCode());
        }

        // test delete schema operation is forbidden in read-only mode
        response = client.delete(schemaPath, extraHdr);
        assertEquals(response.getCode(), 403);

        // return read-only setting back to default
        conf.set("hbase.rest.readonly", "false");

        // delete the table and make sure HBase concurs
        response = client.delete(schemaPath, extraHdr);
        assertEquals(response.getCode(), 200);
        assertFalse(admin.tableExists(TableName.valueOf(TABLE2)));
    }

}