forked from apache/amoro
-
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.
[AMORO-2737] Convert the YAML config file to Configurations first and…
… then perform the validity check. (apache#2739) [AMORO-2737] Convert the YAML config file to Configurations first and then perform the validity check.
- Loading branch information
Showing
4 changed files
with
255 additions
and
82 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
94 changes: 94 additions & 0 deletions
94
ams/server/src/main/java/com/netease/arctic/server/ArcticManagementConfValidator.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,94 @@ | ||
| /* | ||
| * 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 com.netease.arctic.server; | ||
|
|
||
| import com.netease.arctic.api.config.ConfigOption; | ||
| import com.netease.arctic.api.config.Configurations; | ||
| import com.netease.arctic.server.dashboard.utils.AmsUtil; | ||
|
|
||
| import java.net.InetAddress; | ||
|
|
||
| public class ArcticManagementConfValidator { | ||
| public static void validateConfig(Configurations configurations) { | ||
| // SERVER_EXPOSE_HOST config | ||
| if ("".equals(configurations.getString(ArcticManagementConf.SERVER_EXPOSE_HOST))) { | ||
| throw new IllegalArgumentException( | ||
| "configuration " + ArcticManagementConf.SERVER_EXPOSE_HOST.key() + " must be set"); | ||
| } | ||
| InetAddress inetAddress = | ||
| AmsUtil.lookForBindHost(configurations.getString(ArcticManagementConf.SERVER_EXPOSE_HOST)); | ||
| configurations.setString(ArcticManagementConf.SERVER_EXPOSE_HOST, inetAddress.getHostAddress()); | ||
|
|
||
| // mysql or postgres config | ||
| if (ArcticManagementConf.DB_TYPE_MYSQL.equalsIgnoreCase( | ||
| configurations.getString(ArcticManagementConf.DB_TYPE)) | ||
| || ArcticManagementConf.DB_TYPE_POSTGRES.equalsIgnoreCase( | ||
| configurations.getString(ArcticManagementConf.DB_TYPE))) { | ||
| if ("".equals(configurations.getString(ArcticManagementConf.DB_PASSWORD)) | ||
| || "".equals(configurations.getString(ArcticManagementConf.DB_USER_NAME))) { | ||
| throw new IllegalArgumentException( | ||
| "username and password must be configured if the database type is mysql or postgres"); | ||
| } | ||
| } | ||
|
|
||
| // HA config | ||
| if (configurations.getBoolean(ArcticManagementConf.HA_ENABLE)) { | ||
| if ("".equals(configurations.getString(ArcticManagementConf.HA_ZOOKEEPER_ADDRESS))) { | ||
| throw new IllegalArgumentException( | ||
| ArcticManagementConf.HA_ZOOKEEPER_ADDRESS.key() | ||
| + " must be configured when you enable " | ||
| + "the ams high availability"); | ||
| } | ||
| } | ||
| // terminal config | ||
| String terminalBackend = | ||
| configurations.getString(ArcticManagementConf.TERMINAL_BACKEND).toLowerCase(); | ||
| if (!ArcticManagementConf.TERMINAL_BACKEND_VALUES.contains(terminalBackend)) { | ||
| throw new IllegalArgumentException( | ||
| String.format( | ||
| "Illegal terminal implement: %s, local, kyuubi, custom is available", | ||
| terminalBackend)); | ||
| } | ||
|
|
||
| validateThreadCount(configurations, ArcticManagementConf.REFRESH_TABLES_THREAD_COUNT); | ||
| validateThreadCount(configurations, ArcticManagementConf.OPTIMIZING_COMMIT_THREAD_COUNT); | ||
|
|
||
| if (configurations.getBoolean(ArcticManagementConf.EXPIRE_SNAPSHOTS_ENABLED)) { | ||
| validateThreadCount(configurations, ArcticManagementConf.EXPIRE_SNAPSHOTS_THREAD_COUNT); | ||
| } | ||
|
|
||
| if (configurations.getBoolean(ArcticManagementConf.CLEAN_ORPHAN_FILES_ENABLED)) { | ||
| validateThreadCount(configurations, ArcticManagementConf.CLEAN_ORPHAN_FILES_THREAD_COUNT); | ||
| } | ||
| if (configurations.getBoolean(ArcticManagementConf.SYNC_HIVE_TABLES_ENABLED)) { | ||
| validateThreadCount(configurations, ArcticManagementConf.SYNC_HIVE_TABLES_THREAD_COUNT); | ||
| } | ||
| } | ||
|
|
||
| private static void validateThreadCount( | ||
| Configurations configurations, ConfigOption<Integer> config) { | ||
| int threadCount = configurations.getInteger(config); | ||
| if (threadCount <= 0) { | ||
| throw new IllegalArgumentException( | ||
| String.format( | ||
| "%s(%s) must > 0, actual value = %d", | ||
| config.key(), config.description(), threadCount)); | ||
| } | ||
| } | ||
| } |
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
154 changes: 154 additions & 0 deletions
154
ams/server/src/test/java/com/netease/arctic/server/TestArcticManagementConfValidator.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,154 @@ | ||
| /* | ||
| * 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 com.netease.arctic.server; | ||
|
|
||
| import com.netease.arctic.api.config.Configurations; | ||
| import org.junit.Assert; | ||
| import org.junit.Test; | ||
| import org.junit.jupiter.params.ParameterizedTest; | ||
| import org.junit.jupiter.params.provider.Arguments; | ||
| import org.junit.jupiter.params.provider.MethodSource; | ||
|
|
||
| import java.util.stream.Stream; | ||
|
|
||
| public class TestArcticManagementConfValidator { | ||
|
|
||
| @Test | ||
| public void testBlankServerExposeHost() { | ||
| Configurations configurations = new Configurations(); | ||
| Assert.assertThrows( | ||
| IllegalArgumentException.class, | ||
| () -> ArcticManagementConfValidator.validateConfig(configurations)); | ||
| } | ||
|
|
||
| @Test | ||
| public void testValidateServerExposeHost() { | ||
| Configurations configurations = new Configurations(); | ||
| configurations.setString(ArcticManagementConf.SERVER_EXPOSE_HOST, "0.0.0.0"); | ||
| Assert.assertThrows( | ||
| RuntimeException.class, () -> ArcticManagementConfValidator.validateConfig(configurations)); | ||
| } | ||
|
|
||
| public static Stream<Arguments> testValidateDBConfig() { | ||
| return Stream.of(Arguments.of("mysql"), Arguments.of("postgres")); | ||
| } | ||
|
|
||
| @ParameterizedTest | ||
| @MethodSource | ||
| public void testValidateDBConfig(String dbType) { | ||
| Configurations configurations = new Configurations(); | ||
| configurations.setString(ArcticManagementConf.SERVER_EXPOSE_HOST, "127.0.0.1"); | ||
| configurations.setString(ArcticManagementConf.DB_TYPE, dbType); | ||
| Assert.assertThrows( | ||
| IllegalArgumentException.class, | ||
| () -> ArcticManagementConfValidator.validateConfig(configurations)); | ||
|
|
||
| configurations.setString(ArcticManagementConf.DB_PASSWORD, "123456"); | ||
| configurations.setString(ArcticManagementConf.DB_USER_NAME, ""); | ||
| Assert.assertThrows( | ||
| IllegalArgumentException.class, | ||
| () -> ArcticManagementConfValidator.validateConfig(configurations)); | ||
|
|
||
| configurations.removeConfig(ArcticManagementConf.DB_PASSWORD); | ||
| configurations.setString(ArcticManagementConf.DB_USER_NAME, "root"); | ||
| Assert.assertThrows( | ||
| IllegalArgumentException.class, | ||
| () -> ArcticManagementConfValidator.validateConfig(configurations)); | ||
|
|
||
| configurations.setString(ArcticManagementConf.DB_PASSWORD, "123456"); | ||
| ArcticManagementConfValidator.validateConfig(configurations); | ||
| } | ||
|
|
||
| @Test | ||
| public void testValidateHAConfig() { | ||
| Configurations configurations = new Configurations(); | ||
| configurations.setString(ArcticManagementConf.SERVER_EXPOSE_HOST, "127.0.0.1"); | ||
| configurations.setBoolean(ArcticManagementConf.HA_ENABLE, true); | ||
| Assert.assertThrows( | ||
| IllegalArgumentException.class, | ||
| () -> ArcticManagementConfValidator.validateConfig(configurations)); | ||
|
|
||
| configurations.setString(ArcticManagementConf.HA_ZOOKEEPER_ADDRESS, "127.0.0.1:2181"); | ||
| ArcticManagementConfValidator.validateConfig(configurations); | ||
| } | ||
|
|
||
| @Test | ||
| public void testValidateTerminalBackend() { | ||
| Configurations configurations = new Configurations(); | ||
| configurations.setString(ArcticManagementConf.SERVER_EXPOSE_HOST, "127.0.0.1"); | ||
|
|
||
| configurations.setString(ArcticManagementConf.TERMINAL_BACKEND, "invalid_terminal_backend"); | ||
| Assert.assertThrows( | ||
| IllegalArgumentException.class, | ||
| () -> ArcticManagementConfValidator.validateConfig(configurations)); | ||
|
|
||
| configurations.setString(ArcticManagementConf.TERMINAL_BACKEND, "local"); | ||
| ArcticManagementConfValidator.validateConfig(configurations); | ||
|
|
||
| configurations.setString(ArcticManagementConf.TERMINAL_BACKEND, "kyuubi"); | ||
| ArcticManagementConfValidator.validateConfig(configurations); | ||
|
|
||
| configurations.setString(ArcticManagementConf.TERMINAL_BACKEND, "custom"); | ||
| ArcticManagementConfValidator.validateConfig(configurations); | ||
| } | ||
|
|
||
| @Test | ||
| public void testValidateThreadCount() { | ||
| Configurations configurations = new Configurations(); | ||
| configurations.setString(ArcticManagementConf.SERVER_EXPOSE_HOST, "127.0.0.1"); | ||
|
|
||
| configurations.setInteger(ArcticManagementConf.REFRESH_TABLES_THREAD_COUNT, -1); | ||
| Assert.assertThrows( | ||
| IllegalArgumentException.class, | ||
| () -> ArcticManagementConfValidator.validateConfig(configurations)); | ||
| configurations.setInteger(ArcticManagementConf.REFRESH_TABLES_THREAD_COUNT, 10); | ||
| ArcticManagementConfValidator.validateConfig(configurations); | ||
|
|
||
| configurations.setInteger(ArcticManagementConf.OPTIMIZING_COMMIT_THREAD_COUNT, -1); | ||
| Assert.assertThrows( | ||
| IllegalArgumentException.class, | ||
| () -> ArcticManagementConfValidator.validateConfig(configurations)); | ||
| configurations.setInteger(ArcticManagementConf.OPTIMIZING_COMMIT_THREAD_COUNT, 10); | ||
| ArcticManagementConfValidator.validateConfig(configurations); | ||
|
|
||
| configurations.setBoolean(ArcticManagementConf.EXPIRE_SNAPSHOTS_ENABLED, true); | ||
| configurations.setInteger(ArcticManagementConf.EXPIRE_SNAPSHOTS_THREAD_COUNT, -1); | ||
| Assert.assertThrows( | ||
| IllegalArgumentException.class, | ||
| () -> ArcticManagementConfValidator.validateConfig(configurations)); | ||
| configurations.setInteger(ArcticManagementConf.EXPIRE_SNAPSHOTS_THREAD_COUNT, 10); | ||
| ArcticManagementConfValidator.validateConfig(configurations); | ||
|
|
||
| configurations.setBoolean(ArcticManagementConf.CLEAN_ORPHAN_FILES_ENABLED, true); | ||
| configurations.setInteger(ArcticManagementConf.CLEAN_ORPHAN_FILES_THREAD_COUNT, -1); | ||
| Assert.assertThrows( | ||
| IllegalArgumentException.class, | ||
| () -> ArcticManagementConfValidator.validateConfig(configurations)); | ||
| configurations.setInteger(ArcticManagementConf.CLEAN_ORPHAN_FILES_THREAD_COUNT, 10); | ||
| ArcticManagementConfValidator.validateConfig(configurations); | ||
|
|
||
| configurations.setBoolean(ArcticManagementConf.SYNC_HIVE_TABLES_ENABLED, true); | ||
| configurations.setInteger(ArcticManagementConf.SYNC_HIVE_TABLES_THREAD_COUNT, -1); | ||
| Assert.assertThrows( | ||
| IllegalArgumentException.class, | ||
| () -> ArcticManagementConfValidator.validateConfig(configurations)); | ||
| configurations.setInteger(ArcticManagementConf.SYNC_HIVE_TABLES_THREAD_COUNT, 10); | ||
| ArcticManagementConfValidator.validateConfig(configurations); | ||
| } | ||
| } |