org.apache.zeppelin.rest.NotebookRestApiTest.java Source code

Java tutorial

Introduction

Here is the source code for org.apache.zeppelin.rest.NotebookRestApiTest.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.zeppelin.rest;

import com.google.common.collect.Lists;
import com.google.gson.Gson;
import com.google.gson.reflect.TypeToken;
import org.apache.commons.httpclient.methods.GetMethod;
import org.apache.commons.httpclient.methods.PostMethod;
import org.apache.commons.httpclient.methods.PutMethod;
import org.apache.zeppelin.interpreter.InterpreterResult;
import org.apache.zeppelin.notebook.Note;
import org.apache.zeppelin.notebook.Paragraph;
import org.apache.zeppelin.scheduler.Job;
import org.apache.zeppelin.server.ZeppelinServer;
import org.apache.zeppelin.user.AuthenticationInfo;
import org.junit.AfterClass;
import org.junit.Before;
import org.junit.BeforeClass;
import org.junit.FixMethodOrder;
import org.junit.Test;
import org.junit.runners.MethodSorters;

import java.io.IOException;
import java.util.Map;
import java.util.Set;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertThat;

/**
 * Zeppelin notebook rest api tests
 */
@FixMethodOrder(MethodSorters.NAME_ASCENDING)
public class NotebookRestApiTest extends AbstractTestRestApi {
    Gson gson = new Gson();
    AuthenticationInfo anonymous;

    @BeforeClass
    public static void init() throws Exception {
        AbstractTestRestApi.startUp();
    }

    @AfterClass
    public static void destroy() throws Exception {
        AbstractTestRestApi.shutDown();
    }

    @Before
    public void setUp() {
        anonymous = new AuthenticationInfo("anonymous");
    }

    @Test
    public void testGetNoteParagraphJobStatus() throws IOException {
        Note note1 = ZeppelinServer.notebook.createNote(anonymous);
        note1.addParagraph(AuthenticationInfo.ANONYMOUS);

        String paragraphId = note1.getLastParagraph().getId();

        GetMethod get = httpGet("/notebook/job/" + note1.getId() + "/" + paragraphId);
        assertThat(get, isAllowed());
        Map<String, Object> resp = gson.fromJson(get.getResponseBodyAsString(),
                new TypeToken<Map<String, Object>>() {
                }.getType());
        Map<String, Set<String>> paragraphStatus = (Map<String, Set<String>>) resp.get("body");

        // Check id and status have proper value
        assertEquals(paragraphStatus.get("id"), paragraphId);
        assertEquals(paragraphStatus.get("status"), "READY");

        //cleanup
        ZeppelinServer.notebook.removeNote(note1.getId(), anonymous);

    }

    @Test
    public void testRunParagraphJob() throws IOException {
        Note note1 = ZeppelinServer.notebook.createNote(anonymous);
        note1.addParagraph(AuthenticationInfo.ANONYMOUS);

        Paragraph p = note1.addParagraph(AuthenticationInfo.ANONYMOUS);

        // run blank paragraph
        PostMethod post = httpPost("/notebook/job/" + note1.getId() + "/" + p.getId(), "");
        assertThat(post, isAllowed());
        Map<String, Object> resp = gson.fromJson(post.getResponseBodyAsString(),
                new TypeToken<Map<String, Object>>() {
                }.getType());
        assertEquals(resp.get("status"), "OK");
        post.releaseConnection();
        assertEquals(p.getStatus(), Job.Status.FINISHED);

        // run non-blank paragraph
        p.setText("test");
        post = httpPost("/notebook/job/" + note1.getId() + "/" + p.getId(), "");
        assertThat(post, isAllowed());
        resp = gson.fromJson(post.getResponseBodyAsString(), new TypeToken<Map<String, Object>>() {
        }.getType());
        assertEquals(resp.get("status"), "OK");
        post.releaseConnection();
        assertNotEquals(p.getStatus(), Job.Status.READY);

        //cleanup
        ZeppelinServer.notebook.removeNote(note1.getId(), anonymous);
    }

    @Test
    public void testCloneNote() throws IOException {
        Note note1 = ZeppelinServer.notebook.createNote(anonymous);
        PostMethod post = httpPost("/notebook/" + note1.getId(), "");
        LOG.info("testCloneNote response\n" + post.getResponseBodyAsString());
        assertThat(post, isAllowed());
        Map<String, Object> resp = gson.fromJson(post.getResponseBodyAsString(),
                new TypeToken<Map<String, Object>>() {
                }.getType());
        String clonedNoteId = (String) resp.get("body");
        post.releaseConnection();

        GetMethod get = httpGet("/notebook/" + clonedNoteId);
        assertThat(get, isAllowed());
        Map<String, Object> resp2 = gson.fromJson(get.getResponseBodyAsString(),
                new TypeToken<Map<String, Object>>() {
                }.getType());
        Map<String, Object> resp2Body = (Map<String, Object>) resp2.get("body");

        assertEquals((String) resp2Body.get("name"), "Note " + clonedNoteId);
        get.releaseConnection();

        //cleanup
        ZeppelinServer.notebook.removeNote(note1.getId(), anonymous);
        ZeppelinServer.notebook.removeNote(clonedNoteId, anonymous);
    }

    @Test
    public void testUpdateParagraphConfig() throws IOException {
        Note note = ZeppelinServer.notebook.createNote(anonymous);
        String noteId = note.getId();
        Paragraph p = note.addParagraph(AuthenticationInfo.ANONYMOUS);
        assertNull(p.getConfig().get("colWidth"));
        String paragraphId = p.getId();
        String jsonRequest = "{\"colWidth\": 6.0}";

        PutMethod put = httpPut("/notebook/" + noteId + "/paragraph/" + paragraphId + "/config", jsonRequest);
        assertThat("test testUpdateParagraphConfig:", put, isAllowed());

        Map<String, Object> resp = gson.fromJson(put.getResponseBodyAsString(),
                new TypeToken<Map<String, Object>>() {
                }.getType());
        Map<String, Object> respBody = (Map<String, Object>) resp.get("body");
        Map<String, Object> config = (Map<String, Object>) respBody.get("config");
        put.releaseConnection();

        assertEquals(config.get("colWidth"), 6.0);
        note = ZeppelinServer.notebook.getNote(noteId);
        assertEquals(note.getParagraph(paragraphId).getConfig().get("colWidth"), 6.0);

        //cleanup
        ZeppelinServer.notebook.removeNote(noteId, anonymous);
    }

    @Test
    public void testClearAllParagraphOutput() throws IOException {
        // Create note and set result explicitly
        Note note = ZeppelinServer.notebook.createNote(anonymous);
        Paragraph p1 = note.addParagraph(AuthenticationInfo.ANONYMOUS);
        InterpreterResult result = new InterpreterResult(InterpreterResult.Code.SUCCESS,
                InterpreterResult.Type.TEXT, "result");
        p1.setResult(result);

        Paragraph p2 = note.addParagraph(AuthenticationInfo.ANONYMOUS);
        p2.setReturn(result, new Throwable());

        // clear paragraph result
        PutMethod put = httpPut("/notebook/" + note.getId() + "/clear", "");
        LOG.info("test clear paragraph output response\n" + put.getResponseBodyAsString());
        assertThat(put, isAllowed());
        put.releaseConnection();

        // check if paragraph results are cleared
        GetMethod get = httpGet("/notebook/" + note.getId() + "/paragraph/" + p1.getId());
        assertThat(get, isAllowed());
        Map<String, Object> resp1 = gson.fromJson(get.getResponseBodyAsString(),
                new TypeToken<Map<String, Object>>() {
                }.getType());
        Map<String, Object> resp1Body = (Map<String, Object>) resp1.get("body");
        assertNull(resp1Body.get("result"));

        get = httpGet("/notebook/" + note.getId() + "/paragraph/" + p2.getId());
        assertThat(get, isAllowed());
        Map<String, Object> resp2 = gson.fromJson(get.getResponseBodyAsString(),
                new TypeToken<Map<String, Object>>() {
                }.getType());
        Map<String, Object> resp2Body = (Map<String, Object>) resp2.get("body");
        assertNull(resp2Body.get("result"));
        get.releaseConnection();

        //cleanup
        ZeppelinServer.notebook.removeNote(note.getId(), anonymous);
    }
}