libcryfs/test/cryfs-cli/CliTest_WrongEnvironment.cpp

242 lines
10 KiB
C++
Raw Normal View History

2015-10-29 19:34:36 +01:00
#include "testutils/CliTest.h"
2018-09-04 00:46:08 +02:00
#include <cpp-utils/system/env.h>
2015-10-29 19:34:36 +01:00
namespace bf = boost::filesystem;
using ::testing::Values;
using ::testing::WithParamInterface;
using ::testing::Return;
using std::vector;
using cpputils::TempFile;
using cryfs::ErrorCode;
struct TestConfig {
bool externalConfigfile;
bool logIsNotStderr;
bool runningInForeground;
};
2015-10-29 19:34:36 +01:00
//Tests what happens if cryfs is run in the wrong environment, i.e. with a base directory that doesn't exist or similar
class CliTest_WrongEnvironment: public CliTest, public WithParamInterface<TestConfig> {
2015-10-29 19:34:36 +01:00
public:
void SetAllPermissions(const bf::path &dir) {
bf::permissions(dir, bf::owner_write|bf::owner_read|bf::owner_exe);
}
void SetNoReadPermission(const bf::path &dir) {
bf::permissions(dir, bf::owner_write|bf::owner_exe);
}
void SetNoWritePermission(const bf::path &dir) {
bf::permissions(dir, bf::owner_read|bf::owner_exe);
}
void SetNoExePermission(const bf::path &dir) {
bf::permissions(dir, bf::owner_read|bf::owner_write);
}
void SetNoPermission(const bf::path &dir) {
bf::permissions(dir, bf::no_perms);
2015-10-29 19:34:36 +01:00
}
void Test_Run_Success() {
EXPECT_RUN_SUCCESS(args(), mountdir);
}
void Test_Run_Error(const char *expectedError, cryfs::ErrorCode errorCode) {
EXPECT_RUN_ERROR(
args(),
expectedError,
errorCode
);
}
2018-09-07 07:44:23 +02:00
vector<string> args() {
vector<string> result = {basedir.string(), mountdir.string()};
if (GetParam().externalConfigfile) {
result.push_back("--config");
2018-09-07 07:44:23 +02:00
result.push_back(configfile.path().string());
}
if (GetParam().logIsNotStderr) {
result.push_back("--logfile");
2018-09-07 07:44:23 +02:00
result.push_back(logfile.path().string());
}
if (GetParam().runningInForeground) {
result.push_back("-f");
}
// Test case should be non-interactive, so don't ask for cipher.
2015-11-02 21:20:10 +01:00
result.push_back("--cipher");
result.push_back("aes-256-gcm");
return result;
}
};
2019-10-13 14:16:06 +02:00
INSTANTIATE_TEST_SUITE_P(DefaultParams, CliTest_WrongEnvironment, Values(TestConfig({false, false, false})));
INSTANTIATE_TEST_SUITE_P(ExternalConfigfile, CliTest_WrongEnvironment, Values(TestConfig({true, false, false})));
INSTANTIATE_TEST_SUITE_P(LogIsNotStderr, CliTest_WrongEnvironment, Values(TestConfig({false, true, false})));
INSTANTIATE_TEST_SUITE_P(ExternalConfigfile_LogIsNotStderr, CliTest_WrongEnvironment, Values(TestConfig({true, true, false})));
INSTANTIATE_TEST_SUITE_P(RunningInForeground, CliTest_WrongEnvironment, Values(TestConfig({false, false, true})));
INSTANTIATE_TEST_SUITE_P(RunningInForeground_ExternalConfigfile, CliTest_WrongEnvironment, Values(TestConfig({true, false, true})));
INSTANTIATE_TEST_SUITE_P(RunningInForeground_LogIsNotStderr, CliTest_WrongEnvironment, Values(TestConfig({false, true, true})));
INSTANTIATE_TEST_SUITE_P(RunningInForeground_ExternalConfigfile_LogIsNotStderr, CliTest_WrongEnvironment, Values(TestConfig({true, true, true})));
//Counter-Test. Test that it doesn't fail if we call it without an error condition.
TEST_P(CliTest_WrongEnvironment, NoErrorCondition) {
if (!GetParam().runningInForeground) {return;} // TODO Make this work also if run in background (see CliTest::EXPECT_RUN_SUCCESS)
2015-10-29 19:34:36 +01:00
Test_Run_Success();
}
TEST_P(CliTest_WrongEnvironment, MountDirIsBaseDir) {
mountdir = basedir;
2018-12-19 06:34:20 +01:00
Test_Run_Error("Error 18: base directory can't be inside the mount directory", ErrorCode::BaseDirInsideMountDir);
}
bf::path make_relative(const bf::path &path) {
bf::path result;
bf::path cwd = bf::current_path();
for(auto iter = ++cwd.begin(); iter!=cwd.end(); ++iter) {
result /= "..";
}
result /= path.relative_path();
return result;
}
TEST_P(CliTest_WrongEnvironment, MountDirIsBaseDir_MountDirRelative) {
mountdir = make_relative(basedir);
2018-12-19 06:34:20 +01:00
Test_Run_Error("Error 18: base directory can't be inside the mount directory", ErrorCode::BaseDirInsideMountDir);
}
TEST_P(CliTest_WrongEnvironment, MountDirIsBaseDir_BaseDirRelative) {
mountdir = basedir;
basedir = make_relative(basedir);
2018-12-19 06:34:20 +01:00
Test_Run_Error("Error 18: base directory can't be inside the mount directory", ErrorCode::BaseDirInsideMountDir);
}
TEST_P(CliTest_WrongEnvironment, MountDirIsBaseDir_BothRelative) {
basedir = make_relative(basedir);
mountdir = basedir;
2018-12-19 06:34:20 +01:00
Test_Run_Error("Error 18: base directory can't be inside the mount directory", ErrorCode::BaseDirInsideMountDir);
}
TEST_P(CliTest_WrongEnvironment, BaseDir_DoesntExist) {
_basedir.remove();
// ON_CALL and not EXPECT_CALL, because this is a death test (i.e. it is forked) and gmock EXPECT_CALL in fork children don't report to parents.
2021-04-21 08:09:00 +02:00
ON_CALL(*console, askYesNo("Could not find base directory. Do you want to create it?", testing::_)).WillByDefault(Return(false));
2018-12-19 06:34:20 +01:00
Test_Run_Error("Error 16: base directory not found", ErrorCode::InaccessibleBaseDir);
}
TEST_P(CliTest_WrongEnvironment, BaseDir_DoesntExist_Noninteractive) {
_basedir.remove();
// We can't set an EXPECT_CALL().Times(0), because this is a death test (i.e. it is forked) and gmock EXPECT_CALL in fork children don't report to parents.
// So we set a default answer that shouldn't crash and check it's not called by checking that it crashes.
2021-04-21 08:09:00 +02:00
ON_CALL(*console, askYesNo("Could not find base directory. Do you want to create it?", testing::_)).WillByDefault(Return(true));
2018-09-04 00:46:08 +02:00
cpputils::setenv("CRYFS_FRONTEND", "noninteractive");
2018-12-19 06:34:20 +01:00
Test_Run_Error("Error 16: base directory not found", ErrorCode::InaccessibleBaseDir);
2018-09-04 00:46:08 +02:00
cpputils::unsetenv("CRYFS_FRONTEND");
}
TEST_P(CliTest_WrongEnvironment, BaseDir_DoesntExist_Create) {
if (!GetParam().runningInForeground) {return;} // TODO Make this work also if run in background (see CliTest::EXPECT_RUN_SUCCESS)
_basedir.remove();
2021-04-21 08:09:00 +02:00
ON_CALL(*console, askYesNo("Could not find base directory. Do you want to create it?", testing::_)).WillByDefault(Return(true));
Test_Run_Success();
EXPECT_TRUE(bf::exists(_basedir.path()) && bf::is_directory(_basedir.path()));
}
TEST_P(CliTest_WrongEnvironment, BaseDir_IsNotDirectory) {
TempFile basedirfile;
basedir = basedirfile.path();
2018-12-19 06:34:20 +01:00
Test_Run_Error("Error 16: base directory is not a directory", ErrorCode::InaccessibleBaseDir);
}
TEST_P(CliTest_WrongEnvironment, BaseDir_AllPermissions) {
if (!GetParam().runningInForeground) {return;} // TODO Make this work also if run in background (see CliTest::EXPECT_RUN_SUCCESS)
//Counter-Test. Test it doesn't fail if permissions are there.
SetAllPermissions(basedir);
Test_Run_Success();
}
// boost::filesystem doesn't set permissions on Windows correctly
#if !defined(_MSC_VER)
TEST_P(CliTest_WrongEnvironment, BaseDir_NoReadPermission) {
SetNoReadPermission(basedir);
2018-12-19 06:34:20 +01:00
Test_Run_Error("Error 16: Could not read from base directory", ErrorCode::InaccessibleBaseDir);
}
TEST_P(CliTest_WrongEnvironment, BaseDir_NoExePermission) {
SetNoExePermission(basedir);
2018-12-19 06:34:20 +01:00
Test_Run_Error("Error 16: Could not write to base directory", ErrorCode::InaccessibleBaseDir);
}
TEST_P(CliTest_WrongEnvironment, BaseDir_NoWritePermission) {
SetNoWritePermission(basedir);
2018-12-19 06:34:20 +01:00
Test_Run_Error("Error 16: Could not write to base directory", ErrorCode::InaccessibleBaseDir);
}
TEST_P(CliTest_WrongEnvironment, BaseDir_NoPermission) {
SetNoPermission(basedir);
2018-12-19 06:34:20 +01:00
Test_Run_Error("Error 16: Could not write to base directory", ErrorCode::InaccessibleBaseDir);
}
#endif
2015-10-30 22:01:42 +01:00
TEST_P(CliTest_WrongEnvironment, MountDir_DoesntExist) {
_mountdir.remove();
// ON_CALL and not EXPECT_CALL, because this is a death test (i.e. it is forked) and gmock EXPECT_CALL in fork children don't report to parents.
2021-04-21 08:09:00 +02:00
ON_CALL(*console, askYesNo("Could not find mount directory. Do you want to create it?", testing::_)).WillByDefault(Return(false));
Test_Run_Error("mount directory not found", ErrorCode::InaccessibleMountDir);
}
TEST_P(CliTest_WrongEnvironment, MountDir_DoesntExist_Noninteractive) {
_mountdir.remove();
// We can't set an EXPECT_CALL().Times(0), because this is a death test (i.e. it is forked) and gmock EXPECT_CALL in fork children don't report to parents.
// So we set a default answer that shouldn't crash and check it's not called by checking that it crashes.
2021-04-21 08:09:00 +02:00
ON_CALL(*console, askYesNo("Could not find base directory. Do you want to create it?", testing::_)).WillByDefault(Return(true));
2018-09-04 00:46:08 +02:00
cpputils::setenv("CRYFS_FRONTEND", "noninteractive");
Test_Run_Error("mount directory not found", ErrorCode::InaccessibleMountDir);
2018-09-04 00:46:08 +02:00
cpputils::unsetenv("CRYFS_FRONTEND");
2015-10-30 22:01:42 +01:00
}
TEST_P(CliTest_WrongEnvironment, MountDir_DoesntExist_Create) {
if (!GetParam().runningInForeground) {return;} // TODO Make this work also if run in background (see CliTest::EXPECT_RUN_SUCCESS)
_mountdir.remove();
2021-04-21 08:09:00 +02:00
ON_CALL(*console, askYesNo("Could not find mount directory. Do you want to create it?", testing::_)).WillByDefault(Return(true));
Test_Run_Success();
EXPECT_TRUE(bf::exists(_mountdir.path()) && bf::is_directory(_mountdir.path()));
}
2015-10-30 22:01:42 +01:00
TEST_P(CliTest_WrongEnvironment, MountDir_IsNotDirectory) {
TempFile mountdirfile;
mountdir = mountdirfile.path();
2018-12-19 06:34:20 +01:00
Test_Run_Error("Error 17: mount directory is not a directory", ErrorCode::InaccessibleMountDir);
2015-10-30 22:01:42 +01:00
}
TEST_P(CliTest_WrongEnvironment, MountDir_AllPermissions) {
if (!GetParam().runningInForeground) {return;} // TODO Make this work also if run in background (see CliTest::EXPECT_RUN_SUCCESS)
2015-10-30 22:01:42 +01:00
//Counter-Test. Test it doesn't fail if permissions are there.
SetAllPermissions(mountdir);
Test_Run_Success();
}
// boost::filesystem doesn't set permissions on Windows correctly
#if !defined(_MSC_VER)
2015-10-30 22:01:42 +01:00
TEST_P(CliTest_WrongEnvironment, MountDir_NoReadPermission) {
SetNoReadPermission(mountdir);
2018-12-19 06:34:20 +01:00
Test_Run_Error("Error 17: Could not read from mount directory", ErrorCode::InaccessibleMountDir);
2015-10-30 22:01:42 +01:00
}
TEST_P(CliTest_WrongEnvironment, MountDir_NoExePermission) {
SetNoExePermission(mountdir);
2018-12-19 06:34:20 +01:00
Test_Run_Error("Error 17: Could not write to mount directory", ErrorCode::InaccessibleMountDir);
2015-10-30 22:01:42 +01:00
}
TEST_P(CliTest_WrongEnvironment, MountDir_NoWritePermission) {
SetNoWritePermission(mountdir);
2018-12-19 06:34:20 +01:00
Test_Run_Error("Error 17: Could not write to mount directory", ErrorCode::InaccessibleMountDir);
2015-10-30 22:01:42 +01:00
}
TEST_P(CliTest_WrongEnvironment, MountDir_NoPermission) {
SetNoPermission(mountdir);
2018-12-19 06:34:20 +01:00
Test_Run_Error("Error 17: Could not write to mount directory", ErrorCode::InaccessibleMountDir);
2015-10-30 22:01:42 +01:00
}
2019-10-13 14:16:06 +02:00
#endif