forked from apache/flink
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[FLINK-21466][sql-client] Add unit tests for SqlClient
This closes apache#15255
- Loading branch information
Showing
14 changed files
with
356 additions
and
19 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
149 changes: 149 additions & 0 deletions
149
flink-table/flink-sql-client/src/test/java/org/apache/flink/table/client/SqlClientTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,149 @@ | ||
| /* | ||
| * 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:https://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.flink.table.client; | ||
|
|
||
| import org.apache.flink.core.testutils.CommonTestUtils; | ||
| import org.apache.flink.table.client.cli.TerminalStreamsResource; | ||
| import org.apache.flink.util.FileUtils; | ||
|
|
||
| import org.junit.After; | ||
| import org.junit.Before; | ||
| import org.junit.Rule; | ||
| import org.junit.Test; | ||
| import org.junit.rules.ExpectedException; | ||
| import org.junit.rules.TemporaryFolder; | ||
|
|
||
| import java.io.ByteArrayInputStream; | ||
| import java.io.ByteArrayOutputStream; | ||
| import java.io.File; | ||
| import java.io.IOException; | ||
| import java.io.InputStream; | ||
| import java.io.PrintStream; | ||
| import java.net.URL; | ||
| import java.nio.charset.StandardCharsets; | ||
| import java.util.HashMap; | ||
| import java.util.Map; | ||
| import java.util.Objects; | ||
|
|
||
| import static org.apache.flink.configuration.ConfigConstants.ENV_FLINK_CONF_DIR; | ||
| import static org.hamcrest.CoreMatchers.containsString; | ||
| import static org.junit.Assert.assertEquals; | ||
| import static org.junit.Assert.assertThat; | ||
|
|
||
| /** Tests for {@link SqlClient}. */ | ||
| public class SqlClientTest { | ||
|
|
||
| @Rule public ExpectedException thrown = ExpectedException.none(); | ||
|
|
||
| @Rule public TemporaryFolder tempFolder = new TemporaryFolder(); | ||
|
|
||
| @Rule public final TerminalStreamsResource useSystemStream = TerminalStreamsResource.INSTANCE; | ||
|
|
||
| private PrintStream originalPrintStream; | ||
|
|
||
| private InputStream originalInputStream; | ||
|
|
||
| private ByteArrayOutputStream testOutputStream; | ||
|
|
||
| private Map<String, String> originalEnv; | ||
|
|
||
| private String historyPath; | ||
|
|
||
| @Before | ||
| public void before() throws IOException { | ||
| originalEnv = System.getenv(); | ||
| originalPrintStream = System.out; | ||
| originalInputStream = System.in; | ||
| testOutputStream = new ByteArrayOutputStream(); | ||
| System.setOut(new PrintStream(testOutputStream, true)); | ||
| // send "QUIT;" command to gracefully shutdown the terminal | ||
| System.setIn(new ByteArrayInputStream("QUIT;".getBytes(StandardCharsets.UTF_8))); | ||
|
|
||
| // prepare conf dir | ||
| File confFolder = tempFolder.newFolder("conf"); | ||
| File confYaml = new File(confFolder, "flink-conf.yaml"); | ||
| if (!confYaml.createNewFile()) { | ||
| throw new IOException("Can't create testing flink-conf.yaml file."); | ||
| } | ||
|
|
||
| // adjust the test environment for the purposes of this test | ||
| Map<String, String> map = new HashMap<>(System.getenv()); | ||
| map.put(ENV_FLINK_CONF_DIR, confFolder.getAbsolutePath()); | ||
| CommonTestUtils.setEnv(map); | ||
|
|
||
| historyPath = tempFolder.newFile("history").toString(); | ||
| } | ||
|
|
||
| @After | ||
| public void after() throws InterruptedException { | ||
| System.setOut(originalPrintStream); | ||
| System.setIn(originalInputStream); | ||
| CommonTestUtils.setEnv(originalEnv); | ||
| } | ||
|
|
||
| private String getStdoutString() { | ||
| return testOutputStream.toString(); | ||
| } | ||
|
|
||
| @Test(timeout = 20000) | ||
| public void testEmbeddedWithOptions() throws InterruptedException { | ||
| String[] args = new String[] {"embedded", "-hist", historyPath}; | ||
| SqlClient.main(args); | ||
| assertThat(getStdoutString(), containsString("Command history file path: " + historyPath)); | ||
| } | ||
|
|
||
| @Test(timeout = 20000) | ||
| public void testEmbeddedWithLongOptions() throws InterruptedException { | ||
| String[] args = new String[] {"embedded", "--history", historyPath}; | ||
| SqlClient.main(args); | ||
| assertThat(getStdoutString(), containsString("Command history file path: " + historyPath)); | ||
| } | ||
|
|
||
| @Test(timeout = 20000) | ||
| public void testEmbeddedWithoutOptions() throws InterruptedException { | ||
| String[] args = new String[] {"embedded"}; | ||
| SqlClient.main(args); | ||
| assertThat(getStdoutString(), containsString("Command history file path")); | ||
| } | ||
|
|
||
| @Test(timeout = 20000) | ||
| public void testEmptyOptions() throws InterruptedException { | ||
| String[] args = new String[] {}; | ||
| SqlClient.main(args); | ||
| assertThat(getStdoutString(), containsString("Command history file path")); | ||
| } | ||
|
|
||
| @Test(timeout = 20000) | ||
| public void testUnsupportedGatewayMode() throws Exception { | ||
| String[] args = new String[] {"gateway"}; | ||
| thrown.expect(SqlClientException.class); | ||
| thrown.expectMessage("Gateway mode is not supported yet."); | ||
| SqlClient.main(args); | ||
| } | ||
|
|
||
| @Test(timeout = 20000) | ||
| public void testPrintHelpForUnknownMode() throws IOException { | ||
| String[] args = new String[] {"unknown"}; | ||
| SqlClient.main(args); | ||
| final URL url = getClass().getClassLoader().getResource("sql-client-help.out"); | ||
| Objects.requireNonNull(url); | ||
| final String help = FileUtils.readFileUtf8(new File(url.getFile())); | ||
| assertEquals(help, getStdoutString()); | ||
| } | ||
| } |
45 changes: 45 additions & 0 deletions
45
...k-sql-client/src/test/java/org/apache/flink/table/client/cli/TerminalStreamsResource.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| /* | ||
| * 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:https://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.flink.table.client.cli; | ||
|
|
||
| import org.junit.rules.ExternalResource; | ||
|
|
||
| /** | ||
| * Enables {@link org.apache.flink.table.client.SqlClient} to create a default terminal using {@link | ||
| * System#in} and {@link System#out} as the input and output stream. This can allows tests to easily | ||
| * mock input stream of the SqlClient by hijacking the standard stream. | ||
| */ | ||
| public class TerminalStreamsResource extends ExternalResource { | ||
|
|
||
| public static final TerminalStreamsResource INSTANCE = new TerminalStreamsResource(); | ||
|
|
||
| private TerminalStreamsResource() { | ||
| // singleton | ||
| } | ||
|
|
||
| @Override | ||
| protected void before() throws Throwable { | ||
| CliClient.useSystemInOutStream = true; | ||
| } | ||
|
|
||
| @Override | ||
| protected void after() { | ||
| CliClient.useSystemInOutStream = false; | ||
| } | ||
| } |
Oops, something went wrong.