| /* |
| * 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.notebook; |
| |
| |
| import static org.junit.Assert.assertEquals; |
| import static org.junit.Assert.assertNotEquals; |
| import static org.junit.Assert.assertNotNull; |
| import static org.mockito.Matchers.any; |
| import static org.mockito.Matchers.anyString; |
| import static org.mockito.Matchers.eq; |
| import static org.mockito.Mockito.doNothing; |
| import static org.mockito.Mockito.doReturn; |
| import static org.mockito.Mockito.mock; |
| import static org.mockito.Mockito.spy; |
| import static org.mockito.Mockito.verify; |
| import static org.mockito.Mockito.when; |
| |
| import java.util.Arrays; |
| import java.util.HashMap; |
| import java.util.List; |
| import java.util.Map; |
| |
| import org.apache.commons.lang3.tuple.Triple; |
| import org.apache.zeppelin.display.AngularObject; |
| import org.apache.zeppelin.display.AngularObjectBuilder; |
| import org.apache.zeppelin.display.AngularObjectRegistry; |
| import org.apache.zeppelin.display.Input; |
| import org.apache.zeppelin.interpreter.AbstractInterpreterTest; |
| import org.apache.zeppelin.interpreter.Constants; |
| import org.apache.zeppelin.interpreter.Interpreter; |
| import org.apache.zeppelin.interpreter.Interpreter.FormType; |
| import org.apache.zeppelin.interpreter.InterpreterContext; |
| import org.apache.zeppelin.interpreter.InterpreterOption; |
| import org.apache.zeppelin.interpreter.InterpreterResult; |
| import org.apache.zeppelin.interpreter.InterpreterResult.Code; |
| import org.apache.zeppelin.interpreter.InterpreterResult.Type; |
| import org.apache.zeppelin.interpreter.InterpreterResultMessage; |
| import org.apache.zeppelin.interpreter.InterpreterSetting; |
| import org.apache.zeppelin.interpreter.InterpreterSetting.Status; |
| import org.apache.zeppelin.interpreter.ManagedInterpreterGroup; |
| import org.apache.zeppelin.resource.ResourcePool; |
| import org.apache.zeppelin.user.AuthenticationInfo; |
| import org.apache.zeppelin.user.Credentials; |
| import org.apache.zeppelin.user.UserCredentials; |
| import org.apache.zeppelin.user.UsernamePassword; |
| import org.junit.Test; |
| import org.mockito.Mockito; |
| |
| import com.google.common.collect.Lists; |
| |
| public class ParagraphTest extends AbstractInterpreterTest { |
| |
| @Test |
| public void scriptBodyWithReplName() { |
| Note note = createNote(); |
| Paragraph paragraph = new Paragraph(note, null, interpreterFactory); |
| paragraph.setText("%test(1234567"); |
| assertEquals("test", paragraph.getIntpText()); |
| assertEquals("(1234567", paragraph.getScriptText()); |
| |
| paragraph.setText("%test 1234567"); |
| assertEquals("test", paragraph.getIntpText()); |
| assertEquals("1234567", paragraph.getScriptText()); |
| } |
| |
| @Test |
| public void scriptBodyWithoutReplName() { |
| Note note = createNote(); |
| Paragraph paragraph = new Paragraph(note, null, interpreterFactory); |
| paragraph.setText("1234567"); |
| assertEquals("", paragraph.getIntpText()); |
| assertEquals("1234567", paragraph.getScriptText()); |
| } |
| |
| @Test |
| public void replNameAndNoBody() { |
| Note note = createNote(); |
| Paragraph paragraph = new Paragraph(note, null, interpreterFactory); |
| paragraph.setText("%test"); |
| assertEquals("test", paragraph.getIntpText()); |
| assertEquals("", paragraph.getScriptText()); |
| } |
| |
| @Test |
| public void replSingleCharName() { |
| Note note = createNote(); |
| Paragraph paragraph = new Paragraph(note, null, interpreterFactory); |
| paragraph.setText("%r a"); |
| assertEquals("r", paragraph.getIntpText()); |
| assertEquals("a", paragraph.getScriptText()); |
| } |
| |
| @Test |
| public void replInvalid() { |
| Note note = createNote(); |
| Paragraph paragraph = new Paragraph(note, null, interpreterFactory); |
| paragraph.setText("foo %r"); |
| assertEquals("", paragraph.getIntpText()); |
| assertEquals("foo %r", paragraph.getScriptText()); |
| |
| paragraph.setText("foo%r"); |
| assertEquals("", paragraph.getIntpText()); |
| assertEquals("foo%r", paragraph.getScriptText()); |
| |
| paragraph.setText("% foo"); |
| assertEquals("", paragraph.getIntpText()); |
| assertEquals("% foo", paragraph.getScriptText()); |
| } |
| |
| @Test |
| public void replNameEndsWithWhitespace() { |
| Note note = createNote(); |
| Paragraph paragraph = new Paragraph(note, null, interpreterFactory); |
| paragraph.setText("%test\r\n###Hello"); |
| assertEquals("test", paragraph.getIntpText()); |
| assertEquals("###Hello", paragraph.getScriptText()); |
| |
| paragraph.setText("%test\t###Hello"); |
| assertEquals("test", paragraph.getIntpText()); |
| assertEquals("###Hello", paragraph.getScriptText()); |
| |
| paragraph.setText("%test\u000b###Hello"); |
| assertEquals("test", paragraph.getIntpText()); |
| assertEquals("###Hello", paragraph.getScriptText()); |
| |
| paragraph.setText("%test\f###Hello"); |
| assertEquals("test", paragraph.getIntpText()); |
| assertEquals("###Hello", paragraph.getScriptText()); |
| |
| paragraph.setText("%test\n###Hello"); |
| assertEquals("test", paragraph.getIntpText()); |
| assertEquals("###Hello", paragraph.getScriptText()); |
| |
| paragraph.setText("%test ###Hello"); |
| assertEquals("test", paragraph.getIntpText()); |
| assertEquals("###Hello", paragraph.getScriptText()); |
| |
| paragraph.setText(" %test ###Hello"); |
| assertEquals("test", paragraph.getIntpText()); |
| assertEquals("###Hello", paragraph.getScriptText()); |
| |
| paragraph.setText("\n\r%test ###Hello"); |
| assertEquals("test", paragraph.getIntpText()); |
| assertEquals("###Hello", paragraph.getScriptText()); |
| |
| paragraph.setText("%\r\n###Hello"); |
| assertEquals("", paragraph.getIntpText()); |
| assertEquals("%\r\n###Hello", paragraph.getScriptText()); |
| } |
| |
| @Test |
| public void should_extract_variable_from_angular_object_registry() throws Exception { |
| //Given |
| final String noteId = "noteId"; |
| |
| final AngularObjectRegistry registry = mock(AngularObjectRegistry.class); |
| final Note note = mock(Note.class); |
| final Map<String, Input> inputs = new HashMap<>(); |
| inputs.put("name", null); |
| inputs.put("age", null); |
| inputs.put("job", null); |
| |
| final String scriptBody = "My name is ${name} and I am ${age=20} years old. " + |
| "My occupation is ${ job = engineer | developer | artists}"; |
| |
| final Paragraph paragraph = new Paragraph(note, null, null); |
| final String paragraphId = paragraph.getId(); |
| |
| final AngularObject nameAO = AngularObjectBuilder.build("name", "DuyHai DOAN", noteId, |
| paragraphId); |
| |
| final AngularObject ageAO = AngularObjectBuilder.build("age", 34, noteId, null); |
| |
| when(note.getId()).thenReturn(noteId); |
| when(registry.get("name", noteId, paragraphId)).thenReturn(nameAO); |
| when(registry.get("age", noteId, null)).thenReturn(ageAO); |
| |
| final String expected = "My name is DuyHai DOAN and I am 34 years old. " + |
| "My occupation is ${ job = engineer | developer | artists}"; |
| //When |
| final String actual = paragraph.extractVariablesFromAngularRegistry(scriptBody, inputs, |
| registry); |
| |
| //Then |
| verify(registry).get("name", noteId, paragraphId); |
| verify(registry).get("age", noteId, null); |
| assertEquals(actual, expected); |
| } |
| |
| @Test |
| public void returnDefaultParagraphWithNewUser() { |
| Paragraph p = new Paragraph("para_1", null, null, null); |
| Object defaultValue = "Default Value"; |
| p.setResult(defaultValue); |
| Paragraph newUserParagraph = p.getUserParagraph("new_user"); |
| assertNotNull(newUserParagraph); |
| assertEquals(defaultValue, newUserParagraph.getReturn()); |
| } |
| |
| @Test |
| public void returnUnchangedResultsWithDifferentUser() throws Throwable { |
| Note mockNote = mock(Note.class); |
| when(mockNote.getCredentials()).thenReturn(mock(Credentials.class)); |
| Paragraph spyParagraph = spy(new Paragraph("para_1", mockNote, null, null)); |
| |
| Interpreter mockInterpreter = mock(Interpreter.class); |
| spyParagraph.setInterpreter(mockInterpreter); |
| doReturn(mockInterpreter).when(spyParagraph).getBindedInterpreter(); |
| |
| ManagedInterpreterGroup mockInterpreterGroup = mock(ManagedInterpreterGroup.class); |
| when(mockInterpreter.getInterpreterGroup()).thenReturn(mockInterpreterGroup); |
| when(mockInterpreterGroup.getId()).thenReturn("mock_id_1"); |
| when(mockInterpreterGroup.getAngularObjectRegistry()).thenReturn(mock(AngularObjectRegistry.class)); |
| when(mockInterpreterGroup.getResourcePool()).thenReturn(mock(ResourcePool.class)); |
| |
| List<InterpreterSetting> spyInterpreterSettingList = spy(Lists.<InterpreterSetting>newArrayList()); |
| InterpreterSetting mockInterpreterSetting = mock(InterpreterSetting.class); |
| InterpreterOption mockInterpreterOption = mock(InterpreterOption.class); |
| when(mockInterpreterSetting.getOption()).thenReturn(mockInterpreterOption); |
| when(mockInterpreterOption.permissionIsSet()).thenReturn(false); |
| when(mockInterpreterSetting.getStatus()).thenReturn(Status.READY); |
| when(mockInterpreterSetting.getId()).thenReturn("mock_id_1"); |
| when(mockInterpreterSetting.getOrCreateInterpreterGroup(anyString(), anyString())).thenReturn(mockInterpreterGroup); |
| spyInterpreterSettingList.add(mockInterpreterSetting); |
| when(mockNote.getId()).thenReturn("any_id"); |
| |
| when(mockInterpreter.getFormType()).thenReturn(FormType.NONE); |
| |
| ParagraphJobListener mockJobListener = mock(ParagraphJobListener.class); |
| doReturn(mockJobListener).when(spyParagraph).getListener(); |
| doNothing().when(mockJobListener).onOutputUpdateAll(Mockito.<Paragraph>any(), Mockito.anyList()); |
| |
| InterpreterResult mockInterpreterResult = mock(InterpreterResult.class); |
| when(mockInterpreter.interpret(anyString(), Mockito.<InterpreterContext>any())).thenReturn(mockInterpreterResult); |
| when(mockInterpreterResult.code()).thenReturn(Code.SUCCESS); |
| |
| |
| // Actual test |
| List<InterpreterResultMessage> result1 = Lists.newArrayList(); |
| result1.add(new InterpreterResultMessage(Type.TEXT, "result1")); |
| when(mockInterpreterResult.message()).thenReturn(result1); |
| |
| AuthenticationInfo user1 = new AuthenticationInfo("user1"); |
| spyParagraph.setAuthenticationInfo(user1); |
| spyParagraph.jobRun(); |
| Paragraph p1 = spyParagraph.getUserParagraph(user1.getUser()); |
| |
| List<InterpreterResultMessage> result2 = Lists.newArrayList(); |
| result2.add(new InterpreterResultMessage(Type.TEXT, "result2")); |
| when(mockInterpreterResult.message()).thenReturn(result2); |
| |
| AuthenticationInfo user2 = new AuthenticationInfo("user2"); |
| spyParagraph.setAuthenticationInfo(user2); |
| spyParagraph.jobRun(); |
| Paragraph p2 = spyParagraph.getUserParagraph(user2.getUser()); |
| |
| assertNotEquals(p1.getReturn().toString(), p2.getReturn().toString()); |
| |
| assertEquals(p1, spyParagraph.getUserParagraph(user1.getUser())); |
| } |
| |
| @Test |
| public void testCursorPosition() { |
| Paragraph paragraph = spy(new Paragraph()); |
| // left = buffer, middle = cursor position into source code, right = cursor position after parse |
| List<Triple<String, Integer, Integer>> dataSet = Arrays.asList( |
| Triple.of("%jdbc schema.", 13, 7), |
| Triple.of(" %jdbc schema.", 16, 7), |
| Triple.of(" \n%jdbc schema.", 15, 7), |
| Triple.of("%jdbc schema.table. ", 19, 13), |
| Triple.of("%jdbc schema.\n\n", 13, 7), |
| Triple.of(" %jdbc schema.tab\n\n", 18, 10), |
| Triple.of(" \n%jdbc schema.\n \n", 16, 7), |
| Triple.of(" \n%jdbc schema.\n \n", 16, 7), |
| Triple.of(" \n%jdbc\n\n schema\n \n", 17, 6), |
| Triple.of("%another\n\n schema.", 18, 7), |
| Triple.of("\n\n schema.", 10, 7), |
| Triple.of("schema.", 7, 7), |
| Triple.of("schema. \n", 7, 7), |
| Triple.of(" \n %jdbc", 11, 0), |
| Triple.of("\n %jdbc", 9, 0), |
| Triple.of("%jdbc \n schema", 16, 6), |
| Triple.of("%jdbc \n \n schema", 20, 6) |
| ); |
| |
| for (Triple<String, Integer, Integer> data : dataSet) { |
| paragraph.setText(data.getLeft()); |
| Integer actual = paragraph.calculateCursorPosition(data.getLeft(), data.getMiddle()); |
| assertEquals(data.getRight(), actual); |
| } |
| } |
| |
| @Test |
| public void credentialReplacement() throws Throwable { |
| Note mockNote = mock(Note.class); |
| Credentials creds = mock(Credentials.class); |
| when(mockNote.getCredentials()).thenReturn(creds); |
| Paragraph spyParagraph = spy(new Paragraph("para_1", mockNote, null, null)); |
| UserCredentials uc = mock(UserCredentials.class); |
| when(creds.getUserCredentials(anyString())).thenReturn(uc); |
| UsernamePassword up = new UsernamePassword("user", "pwd"); |
| when(uc.getUsernamePassword("ent")).thenReturn(up ); |
| |
| Interpreter mockInterpreter = mock(Interpreter.class); |
| spyParagraph.setInterpreter(mockInterpreter); |
| doReturn(mockInterpreter).when(spyParagraph).getBindedInterpreter(); |
| |
| ManagedInterpreterGroup mockInterpreterGroup = mock(ManagedInterpreterGroup.class); |
| when(mockInterpreter.getInterpreterGroup()).thenReturn(mockInterpreterGroup); |
| when(mockInterpreterGroup.getId()).thenReturn("mock_id_1"); |
| when(mockInterpreterGroup.getAngularObjectRegistry()).thenReturn(mock(AngularObjectRegistry.class)); |
| when(mockInterpreterGroup.getResourcePool()).thenReturn(mock(ResourcePool.class)); |
| when(mockInterpreter.getFormType()).thenReturn(FormType.NONE); |
| |
| ParagraphJobListener mockJobListener = mock(ParagraphJobListener.class); |
| doReturn(mockJobListener).when(spyParagraph).getListener(); |
| doNothing().when(mockJobListener).onOutputUpdateAll(Mockito.<Paragraph>any(), Mockito.anyList()); |
| |
| InterpreterResult mockInterpreterResult = mock(InterpreterResult.class); |
| when(mockInterpreter.interpret(anyString(), Mockito.<InterpreterContext>any())).thenReturn(mockInterpreterResult); |
| when(mockInterpreterResult.code()).thenReturn(Code.SUCCESS); |
| |
| AuthenticationInfo user1 = new AuthenticationInfo("user1"); |
| spyParagraph.setAuthenticationInfo(user1); |
| |
| spyParagraph.setText("val x = \"usr={user.ent}&pass={password.ent}\""); |
| |
| // Credentials should only be injected when it is enabled for an interpreter |
| when(mockInterpreter.getProperty(Constants.INJECT_CREDENTIALS, "false")).thenReturn("false"); |
| spyParagraph.jobRun(); |
| verify(mockInterpreter).interpret(eq("val x = \"usr={user.ent}&pass={password.ent}\""), any(InterpreterContext.class)); |
| |
| when(mockInterpreter.getProperty(Constants.INJECT_CREDENTIALS, "false")).thenReturn("true"); |
| spyParagraph.jobRun(); |
| verify(mockInterpreter).interpret(eq("val x = \"usr=user&pass=pwd\""), any(InterpreterContext.class)); |
| } |
| } |