mirror of
https://github.com/nestriness/cdc-file-transfer.git
synced 2026-01-30 16:25:36 +02:00
af9038b4dd
In a future CL, we will switch from scp to sftp. This CL adds support for calling sftp from RemoteUtil. In order to maintain backwards compatibility where people still set --scp-command or CDC_SCP_COMMAND instead of the sftp versions, this CL also adds the helper method RemoteUtil::ScpToSftpCommand, which attempts to convert an scp command to an sftp command. This is usually possible since the args are almost the same. For instance, if the scp command is C:\path\to\scp.exe -P 1234 -i <key_file> -oUserKnownHostsFile=known_hosts then the corresponding sftp command is most likely C:\path\to\sftp.exe -P 1234 -i <key_file> -oUserKnownHostsFile=known_hosts This works for instance for OpenSSH.
154 lines
6.4 KiB
C++
154 lines
6.4 KiB
C++
// Copyright 2022 Google LLC
|
|
//
|
|
// Licensed 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.
|
|
|
|
#include "common/remote_util.h"
|
|
|
|
#include "absl/strings/match.h"
|
|
#include "common/log.h"
|
|
#include "gtest/gtest.h"
|
|
|
|
namespace cdc_ft {
|
|
namespace {
|
|
|
|
constexpr char kUserHost[] = "user@example.com";
|
|
constexpr char kUserHostArg[] = "\"user@example.com\"";
|
|
|
|
constexpr int kLocalPort = 23456;
|
|
constexpr int kRemotePort = 34567;
|
|
constexpr bool kRegular = false; // Regular port forwarding
|
|
constexpr bool kReverse = true; // Reverse port forwarding
|
|
constexpr char kPortForwardingArg[] = "-L23456:localhost:34567";
|
|
constexpr char kReversePortForwardingArg[] = "-R34567:localhost:23456";
|
|
|
|
constexpr char kCommand[] = "my_command";
|
|
|
|
class RemoteUtilTest : public ::testing::Test {
|
|
public:
|
|
RemoteUtilTest()
|
|
: util_(kUserHost, /*verbosity=*/0, /*quiet=*/false, &process_factory_,
|
|
/*forward_output_to_log=*/true) {}
|
|
|
|
void SetUp() override {
|
|
Log::Initialize(std::make_unique<ConsoleLog>(LogLevel::kInfo));
|
|
}
|
|
|
|
void TearDown() override { Log::Shutdown(); }
|
|
|
|
protected:
|
|
void ExpectContains(const std::string& str, std::vector<const char*> tokens) {
|
|
for (const char* token : tokens) {
|
|
EXPECT_TRUE(absl::StrContains(str, token))
|
|
<< str << "\ndoes not contain\n"
|
|
<< token;
|
|
}
|
|
}
|
|
|
|
WinProcessFactory process_factory_;
|
|
RemoteUtil util_;
|
|
};
|
|
|
|
TEST_F(RemoteUtilTest, BuildProcessStartInfoForSsh) {
|
|
ProcessStartInfo si = util_.BuildProcessStartInfoForSsh(kCommand);
|
|
ExpectContains(si.command, {"ssh", kUserHostArg, kCommand});
|
|
}
|
|
|
|
TEST_F(RemoteUtilTest, BuildProcessStartInfoForSshPortForward) {
|
|
ProcessStartInfo si = util_.BuildProcessStartInfoForSshPortForward(
|
|
kLocalPort, kRemotePort, kRegular);
|
|
ExpectContains(si.command, {"ssh", kUserHostArg, kPortForwardingArg});
|
|
|
|
si = util_.BuildProcessStartInfoForSshPortForward(kLocalPort, kRemotePort,
|
|
kReverse);
|
|
ExpectContains(si.command, {"ssh", kUserHostArg, kReversePortForwardingArg});
|
|
}
|
|
|
|
TEST_F(RemoteUtilTest, BuildProcessStartInfoForSshPortForwardAndCommand) {
|
|
ProcessStartInfo si = util_.BuildProcessStartInfoForSshPortForwardAndCommand(
|
|
kLocalPort, kRemotePort, kRegular, kCommand);
|
|
ExpectContains(si.command,
|
|
{"ssh", kUserHostArg, kPortForwardingArg, kCommand});
|
|
|
|
si = util_.BuildProcessStartInfoForSshPortForwardAndCommand(
|
|
kLocalPort, kRemotePort, kReverse, kCommand);
|
|
ExpectContains(si.command,
|
|
{"ssh", kUserHostArg, kReversePortForwardingArg, kCommand});
|
|
}
|
|
TEST_F(RemoteUtilTest, BuildProcessStartInfoForSshWithCustomCommand) {
|
|
constexpr char kCustomSshCmd[] = "C:\\path\\to\\ssh.exe --fooarg --bararg=42";
|
|
util_.SetSshCommand(kCustomSshCmd);
|
|
ProcessStartInfo si = util_.BuildProcessStartInfoForSsh(kCommand);
|
|
ExpectContains(si.command, {kCustomSshCmd});
|
|
}
|
|
|
|
TEST_F(RemoteUtilTest, QuoteForWindows) {
|
|
EXPECT_EQ(RemoteUtil::QuoteForWindows("foo"), "\"foo\"");
|
|
EXPECT_EQ(RemoteUtil::QuoteForWindows("foo bar"), "\"foo bar\"");
|
|
EXPECT_EQ(RemoteUtil::QuoteForWindows("foo\\bar"), "\"foo\\bar\"");
|
|
EXPECT_EQ(RemoteUtil::QuoteForWindows("\\\\foo"), "\"\\\\foo\"");
|
|
EXPECT_EQ(RemoteUtil::QuoteForWindows("foo\\"), "\"foo\\\\\"");
|
|
EXPECT_EQ(RemoteUtil::QuoteForWindows("foo\\\\"), "\"foo\\\\\\\\\"");
|
|
EXPECT_EQ(RemoteUtil::QuoteForWindows("foo\""), "\"foo\\\"\"");
|
|
EXPECT_EQ(RemoteUtil::QuoteForWindows("foo\"bar"), "\"foo\\\"bar\"");
|
|
EXPECT_EQ(RemoteUtil::QuoteForWindows("foo\\\"bar"), "\"foo\\\\\\\"bar\"");
|
|
EXPECT_EQ(RemoteUtil::QuoteForWindows("foo\\\\\"bar"),
|
|
"\"foo\\\\\\\\\\\"bar\"");
|
|
EXPECT_EQ(RemoteUtil::QuoteForWindows("\"foo\""), "\"\\\"foo\\\"\"");
|
|
EXPECT_EQ(RemoteUtil::QuoteForWindows("\" \\file.txt"),
|
|
"\"\\\" \\file.txt\"");
|
|
}
|
|
|
|
TEST_F(RemoteUtilTest, QuoteForSsh) {
|
|
EXPECT_EQ(RemoteUtil::QuoteForSsh("foo"), "\"\\\"foo\\\"\"");
|
|
EXPECT_EQ(RemoteUtil::QuoteForSsh("foo\\bar"), "\"\\\"foo\\\\bar\\\"\"");
|
|
EXPECT_EQ(RemoteUtil::QuoteForSsh("foo\\"), "\"\\\"foo\\\\\\\\\\\"\"");
|
|
EXPECT_EQ(RemoteUtil::QuoteForSsh("foo\\\"bar"),
|
|
"\"\\\"foo\\\\\\\\\\\\\\\"bar\\\"\"");
|
|
EXPECT_EQ(RemoteUtil::QuoteForSsh("~"), "\"~\"");
|
|
EXPECT_EQ(RemoteUtil::QuoteForSsh("~username"), "\"~username\"");
|
|
EXPECT_EQ(RemoteUtil::QuoteForSsh("~/foo"), "\"~/\\\"foo\\\"\"");
|
|
EXPECT_EQ(RemoteUtil::QuoteForSsh("~username/foo"),
|
|
"\"~username/\\\"foo\\\"\"");
|
|
EXPECT_EQ(RemoteUtil::QuoteForSsh("~invalid user name"),
|
|
"\"\\\"~invalid user name\\\"\"");
|
|
EXPECT_EQ(RemoteUtil::QuoteForSsh("~invalid user name/foo"),
|
|
"\"\\\"~invalid user name/foo\\\"\"");
|
|
EXPECT_EQ(RemoteUtil::QuoteForSsh("~user-name69/foo"),
|
|
"\"~user-name69/\\\"foo\\\"\""); // Nice!
|
|
}
|
|
|
|
TEST_F(RemoteUtilTest, ScpToSftpCommand) {
|
|
EXPECT_EQ(RemoteUtil::ScpToSftpCommand(""), "");
|
|
EXPECT_EQ(RemoteUtil::ScpToSftpCommand("scp"), "sftp");
|
|
EXPECT_EQ(RemoteUtil::ScpToSftpCommand("scp.exe"), "sftp.exe");
|
|
EXPECT_EQ(RemoteUtil::ScpToSftpCommand("scp --arg"), "sftp --arg");
|
|
EXPECT_EQ(RemoteUtil::ScpToSftpCommand("ScP --aRg"), "sftp --aRg");
|
|
EXPECT_EQ(RemoteUtil::ScpToSftpCommand("winscp"), "winsftp");
|
|
EXPECT_EQ(RemoteUtil::ScpToSftpCommand("winscp.exe"), "winsftp.exe");
|
|
EXPECT_EQ(RemoteUtil::ScpToSftpCommand("winscp --arg"), "winsftp --arg");
|
|
EXPECT_EQ(RemoteUtil::ScpToSftpCommand("C:\\path\\to\\scp"),
|
|
"C:\\path\\to\\sftp");
|
|
EXPECT_EQ(RemoteUtil::ScpToSftpCommand("C:\\path\\to\\scp.exe"),
|
|
"C:\\path\\to\\sftp.exe");
|
|
EXPECT_EQ(RemoteUtil::ScpToSftpCommand("C:\\path\\to\\scp.exe --arg"),
|
|
"C:\\path\\to\\sftp.exe --arg");
|
|
EXPECT_EQ(RemoteUtil::ScpToSftpCommand("C:\\scp.exe --argwithscp"),
|
|
"C:\\sftp.exe --argwithscp");
|
|
EXPECT_EQ(RemoteUtil::ScpToSftpCommand("C:\\path_with_scp\\scp"),
|
|
"C:\\path_with_scp\\sftp");
|
|
EXPECT_EQ(RemoteUtil::ScpToSftpCommand("C:\\path\\to\\somethingelse"), "");
|
|
}
|
|
|
|
} // namespace
|
|
} // namespace cdc_ft
|