[Improvement-17573][UI] Update UI label & regarding variable names & regarding upgrade script (#17666)

Author: CauliflowerEater

docs/docs/en/guide/upgrade/incompatible.md

@@ -38,3 +38,7 @@ This document records the incompatible updates between each version. You need to
 * Drop unused column `other_params_json` in `t_ds_worker_group` ([#16860])(https://github.com/apache/dolphinscheduler/pull/16860)
 * Remove the `Dynamic` from the `Task Plugin` ([#16482])(https://github.com/apache/dolphinscheduler/pull/16842)
 
+## 3.4.0
+
+* Renamed the publicKey field to privateKey in the SSH connection parameters under the datasource configuration. ([#17666])(https://github.com/apache/dolphinscheduler/pull/17666)
+

dolphinscheduler-dao/src/main/resources/sql/upgrade/3.3.3_schema/mysql/dolphinscheduler_dml.sql

@@ -14,3 +14,5 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
 */
+
+UPDATE t_ds_datasource SET connection_params = REPLACE(connection_params, '"publicKey"', '"privateKey"') WHERE type = 17 AND connection_params LIKE '%"publicKey"%';

dolphinscheduler-dao/src/main/resources/sql/upgrade/3.3.3_schema/postgresql/dolphinscheduler_dml.sql

@@ -14,3 +14,5 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
 */
+
+UPDATE t_ds_datasource SET connection_params = REPLACE(connection_params, '"publicKey"', '"privateKey"') WHERE type = 17 AND connection_params LIKE '%"publicKey"%';

dolphinscheduler-datasource-plugin/dolphinscheduler-datasource-ssh/src/main/java/org/apache/dolphinscheduler/plugin/datasource/ssh/SSHUtils.java

@@ -46,12 +46,12 @@ public static ClientSession getSession(SshClient client, SSHConnectionParam conn
             session.addPasswordIdentity(password);
         }
 
-        // add public key identity
-        String publicKey = connectionParam.getPublicKey();
-        if (StringUtils.isNotEmpty(publicKey)) {
+        // add private key identity
+        String privateKey = connectionParam.getPrivateKey();
+        if (StringUtils.isNotEmpty(privateKey)) {
             try {
                 KeyPairResourceLoader loader = SecurityUtils.getKeyPairResourceParser();
-                Collection<KeyPair> keyPairCollection = loader.loadKeyPairs(null, null, null, publicKey);
+                Collection<KeyPair> keyPairCollection = loader.loadKeyPairs(null, null, null, privateKey);
                 for (KeyPair keyPair : keyPairCollection) {
                     session.addPublicKeyIdentity(keyPair);
                 }

dolphinscheduler-datasource-plugin/dolphinscheduler-datasource-ssh/src/main/java/org/apache/dolphinscheduler/plugin/datasource/ssh/param/SSHConnectionParam.java

@@ -31,7 +31,7 @@ public class SSHConnectionParam implements ConnectionParam {
 
     protected String password;
 
-    protected String publicKey;
+    protected String privateKey;
 
     protected String host;
 

dolphinscheduler-datasource-plugin/dolphinscheduler-datasource-ssh/src/main/java/org/apache/dolphinscheduler/plugin/datasource/ssh/param/SSHDataSourceParamDTO.java

@@ -25,7 +25,7 @@
 @Data
 public class SSHDataSourceParamDTO extends BaseDataSourceParamDTO {
 
-    protected String publicKey;
+    protected String privateKey;
 
     @Override
     public DbType getType() {

dolphinscheduler-datasource-plugin/dolphinscheduler-datasource-ssh/src/main/java/org/apache/dolphinscheduler/plugin/datasource/ssh/param/SSHDataSourceProcessor.java

@@ -69,7 +69,7 @@ public BaseDataSourceParamDTO createDatasourceParamDTO(String connectionJson) {
         sshDataSourceParamDTO.setPassword(connectionParams.getPassword());
         sshDataSourceParamDTO.setHost(connectionParams.getHost());
         sshDataSourceParamDTO.setPort(connectionParams.getPort());
-        sshDataSourceParamDTO.setPublicKey(connectionParams.getPublicKey());
+        sshDataSourceParamDTO.setPrivateKey(connectionParams.getPrivateKey());
 
         return sshDataSourceParamDTO;
     }
@@ -82,7 +82,7 @@ public SSHConnectionParam createConnectionParams(BaseDataSourceParamDTO dataSour
         sshConnectionParam.setPassword(sshDataSourceParam.getPassword());
         sshConnectionParam.setHost(sshDataSourceParam.getHost());
         sshConnectionParam.setPort(sshDataSourceParam.getPort());
-        sshConnectionParam.setPublicKey(sshDataSourceParam.getPublicKey());
+        sshConnectionParam.setPrivateKey(sshDataSourceParam.getPrivateKey());
 
         return sshConnectionParam;
     }
@@ -121,7 +121,7 @@ public boolean checkDataSourceConnectivity(ConnectionParam connectionParam) {
                         baseConnectionParam.getPort(),
                         baseConnectionParam.getUser(),
                         baseConnectionParam.getPassword(),
-                        baseConnectionParam.getPublicKey())) {
+                        baseConnectionParam.getPrivateKey())) {
 
             return sshClientWrapper.isAuth();
         } catch (Exception e) {

dolphinscheduler-datasource-plugin/dolphinscheduler-datasource-ssh/src/test/java/org/apache/dolphinscheduler/plugin/datasource/ssh/SSHDataSourceProcessorTest.java

@@ -38,7 +38,7 @@ public class SSHDataSourceProcessorTest {
     private SSHDataSourceProcessor sshDataSourceProcessor;
 
     private String connectJson =
-            "{\"user\":\"lucky\",\"password\":\"123456\",\"host\":\"dolphinscheduler.com\",\"port\":22, \"publicKey\":\"ssh-rsa AAAAB\"}";
+            "{\"user\":\"lucky\",\"password\":\"123456\",\"host\":\"dolphinscheduler.com\",\"port\":22, \"privateKey\":\"ssh-rsa AAAAB\"}";
 
     @BeforeEach
     public void init() {
@@ -77,7 +77,7 @@ void testCreateDatasourceParamDTO() {
         Assertions.assertEquals("123456", sshDataSourceParamDTO.getPassword());
         Assertions.assertEquals("dolphinscheduler.com", sshDataSourceParamDTO.getHost());
         Assertions.assertEquals(22, sshDataSourceParamDTO.getPort());
-        Assertions.assertEquals("ssh-rsa AAAAB", sshDataSourceParamDTO.getPublicKey());
+        Assertions.assertEquals("ssh-rsa AAAAB", sshDataSourceParamDTO.getPrivateKey());
     }
 
     @Test
@@ -89,7 +89,7 @@ void testCreateConnectionParams() {
         Assertions.assertEquals("123456", sshConnectionParam.getPassword());
         Assertions.assertEquals("dolphinscheduler.com", sshConnectionParam.getHost());
         Assertions.assertEquals(22, sshConnectionParam.getPort());
-        Assertions.assertEquals("ssh-rsa AAAAB", sshConnectionParam.getPublicKey());
+        Assertions.assertEquals("ssh-rsa AAAAB", sshConnectionParam.getPrivateKey());
     }
 
     @Test

dolphinscheduler-task-plugin/dolphinscheduler-task-remoteshell/src/test/java/org/apache/dolphinscheduler/plugin/task/remoteshell/RemoteExecutorTest.java

@@ -52,7 +52,7 @@
 public class RemoteExecutorTest {
 
     private String connectJson =
-            "{\"user\":\"root\",\"password\":\"123456\",\"host\":\"dolphinscheduler.com\",\"port\":22, \"publicKey\":\"ssh-rsa AAAAB\"}";
+            "{\"user\":\"root\",\"password\":\"123456\",\"host\":\"dolphinscheduler.com\",\"port\":22, \"privateKey\":\"ssh-rsa AAAAB\"}";
 
     SSHConnectionParam sshConnectionParam;
 

dolphinscheduler-task-plugin/dolphinscheduler-task-remoteshell/src/test/java/org/apache/dolphinscheduler/plugin/task/remoteshell/RemoteShellTaskTest.java

@@ -48,7 +48,7 @@
 public class RemoteShellTaskTest {
 
     private String connectJson =
-            "{\"user\":\"root\",\"password\":\"123456\",\"host\":\"dolphinscheduler.com\",\"port\":22, \"publicKey\":\"ssh-rsa AAAAB\"}";
+            "{\"user\":\"root\",\"password\":\"123456\",\"host\":\"dolphinscheduler.com\",\"port\":22, \"privateKey\":\"ssh-rsa AAAAB\"}";
 
     SSHConnectionParam sshConnectionParam;