Config file and package tracking utility
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 

678 lines
18 KiB

/*
* Copyright (C) 2022 Riyyi
*
* SPDX-License-Identifier: MIT
*/
#include <cstddef> // size_t
#include <cstdint> // uint32_t
#include <cstdio> // stderr
#include <filesystem> // path
#include <string>
#include <unistd.h> // geteuid, setegid, seteuid
#include <vector>
#include "config.h"
#include "dotfile.h"
#include "machine.h"
#include "macro.h"
#include "testcase.h"
#include "testsuite.h"
#include "util/file.h"
#include "util/system.h"
const bool root = !geteuid() ? true : false;
const std::filesystem::path homeDirectory = "/home/" + Machine::the().username();
const size_t homeDirectorySize = homeDirectory.string().size();
void createTestDotfiles(const std::vector<std::string>& fileNames, const std::vector<std::string>& fileContents, bool asRoot = false)
{
VERIFY(fileNames.size() == fileContents.size(), return);
if (root && !asRoot) {
setegid(Machine::the().gid());
seteuid(Machine::the().uid());
}
for (size_t i = 0; i < fileNames.size(); ++i) {
auto fileName = fileNames.at(i);
auto directory = std::filesystem::path { fileName }.parent_path();
if (!directory.empty() && !std::filesystem::exists(directory)) {
std::filesystem::create_directories(directory);
}
auto file = Util::File::create(fileName);
if (file.data().size() == 0) {
file.append(fileContents.at(i).c_str()).flush();
}
}
if (root && !asRoot) {
seteuid(0);
setegid(0);
}
}
void removeTestDotfiles(const std::vector<std::string>& files)
{
for (auto file : files) {
// Get the top-level directory
if (file.find(homeDirectory) == 0) {
file = file.substr(homeDirectorySize + 1);
}
file = file.substr(0, file.find_first_of('/'));
// Delete recursively in working directory
if (std::filesystem::exists(file) || std::filesystem::is_symlink(file)) {
std::filesystem::remove_all(file);
}
// Delete recursively in home directory
file = homeDirectory / file;
if (std::filesystem::exists(file) || std::filesystem::is_symlink(file)) {
std::filesystem::remove_all(file);
}
}
}
// -----------------------------------------
TEST_CASE(AddDotfiles)
{
std::vector<std::string> fileNames = {
homeDirectory / "__test-file-1",
homeDirectory / "__subdir/__test-file-2",
homeDirectory / "__subdir/__another-subdir/__test-file-3",
};
std::vector<std::string> fileContents = {
R"(home directory file 1
)",
R"(home directory file 2
)",
R"(home directory file 3
)",
};
createTestDotfiles(fileNames, fileContents);
Dotfile::the().add(fileNames);
for (const auto& file : fileNames) {
VERIFY(std::filesystem::exists(file), continue);
VERIFY(std::filesystem::exists(file.substr(homeDirectorySize + 1)), continue);
Util::File lhs(file);
Util::File rhs(file.substr(homeDirectorySize + 1));
EXPECT_EQ(lhs.data(), rhs.data());
}
removeTestDotfiles(fileNames);
}
TEST_CASE(AddNonExistentDotfiles)
{
stderr = Test::TestSuite::the().outputNull();
Dotfile::the().add({ homeDirectory / "__non-existent-test-file" });
stderr = Test::TestSuite::the().outputErr();
EXPECT(!std::filesystem::exists("__non-existent-test-file"));
removeTestDotfiles({ "__non-existent-test-file" });
}
TEST_CASE(PullDotfiles)
{
std::vector<std::string> fileNames = {
"__test-file-1",
"__subdir/__test-file-2",
"__subdir/__another-subdir/__test-file-3",
};
std::vector<std::string> homeFileNames;
for (const auto& file : fileNames) {
homeFileNames.push_back(homeDirectory / file);
}
std::vector<std::string> homeFileContents = {
R"(file 1 after pulling
)",
R"(file 2 after pulling
)",
R"(file 3 after pulling
)",
};
std::vector<std::string> workingDirectoryFileContents = {
R"(file 1
)",
R"(file 2
)",
R"(file 3
)",
};
createTestDotfiles(homeFileNames, homeFileContents);
createTestDotfiles(fileNames, workingDirectoryFileContents);
Dotfile::the().pull(fileNames);
for (size_t i = 0; i < fileNames.size(); ++i) {
VERIFY(std::filesystem::exists(homeFileNames.at(i)), continue);
VERIFY(std::filesystem::exists(fileNames.at(i)), continue);
Util::File lhs(homeFileNames.at(i));
Util::File rhs(fileNames.at(i));
EXPECT_EQ(lhs.data(), rhs.data());
}
removeTestDotfiles(fileNames);
}
TEST_CASE(PushDotfiles)
{
std::vector<std::string> fileNames = {
"__test-file-1",
"__subdir/__test-file-2",
"__subdir/__another-subdir/__test-file-3",
};
std::vector<std::string> fileContents = {
R"(working directory file 1
)",
R"(working directory file 2
)",
R"(working directory file 3
)",
};
createTestDotfiles(fileNames, fileContents);
Dotfile::the().push(fileNames);
for (const auto& file : fileNames) {
VERIFY(std::filesystem::exists(file), continue);
VERIFY(std::filesystem::exists(homeDirectory / file), continue);
Util::File lhs(file);
Util::File rhs(homeDirectory / file);
EXPECT_EQ(lhs.data(), rhs.data());
}
removeTestDotfiles(fileNames);
}
TEST_CASE(PushDotfilesWithExcludePath)
{
std::vector<std::string> fileNames = {
"__test-file-1",
"__subdir/__test-file-2",
"__subdir/__test-file-3",
"__another-subdir/__test-file-4.test",
};
createTestDotfiles(fileNames, { "", "", "", "" });
Config::the().setExcludePaths({
{ "__test-file-1", "file" },
{ "__subdir", "directory" },
{ ".test", "endsWith" },
});
Dotfile::the().push(fileNames);
Config::the().setExcludePaths({});
for (const auto& file : fileNames) {
EXPECT(!std::filesystem::exists(homeDirectory / file));
}
removeTestDotfiles(fileNames);
}
TEST_CASE(PushDotfilesSelectivelyComment)
{
std::vector<std::string> fileNames;
for (size_t i = 0; i < 36; ++i) {
fileNames.push_back( "__test-file-" + std::to_string(i + 1));
}
auto distro = Machine::the().distroId();
auto hostname = Machine::the().hostname();
auto username = Machine::the().username();
std::string placeholder = "@@@@";
std::vector<std::string> fileContents = {
// Untouched #
"# >>> distro=" + distro + " hostname=" + hostname + " user=" + username + R"(
test data # untouched
# <<<
)",
" # >>> distro=" + distro + " hostname=" + hostname + " user=" + username + R"(
test data # untouched
# <<<
)",
" # >>> distro=" + distro + " hostname=" + hostname + " user=" + username + R"(
test data # untouched
# <<<
)",
" # >>> distro=" + distro + " hostname=" + hostname + " user=" + username + R"(
test data # untouched
# <<<
)",
// Comment #
"# >>> distro=" + placeholder + " hostname=" + hostname + " user=" + username + R"(
test data # comment
# <<<
)",
" # >>> distro=" + distro + " hostname=" + placeholder + " user=" + username + R"(
test data # comment
# <<<
)",
" # >>> distro=" + distro + " hostname=" + hostname + " user=" + placeholder + R"(
test data # comment
# <<<
)",
" # >>> distro=" + placeholder + " hostname=" + hostname + " user=" + username + R"(
test data # comment
# <<<
)",
// Uncomment #
"# >>> distro=" + distro + " hostname=" + hostname + " user=" + username + R"(
# test data # uncomment
# <<<
)",
" # >>> distro=" + distro + " hostname=" + hostname + " user=" + username + R"(
# test data # uncomment
# <<<
)",
" # >>> distro=" + distro + " hostname=" + hostname + " user=" + username + R"(
# test data # uncomment
# <<<
)",
" # >>> distro=" + distro + " hostname=" + hostname + " user=" + username + R"(
# test data # uncomment
# <<<
)",
// -----------------------------------------
// Untouched //
"// >>> distro=" + distro + " hostname=" + hostname + " user=" + username + R"(
test data // untouched
// <<<
)",
" // >>> distro=" + distro + " hostname=" + hostname + " user=" + username + R"(
test data // untouched
// <<<
)",
" // >>> distro=" + distro + " hostname=" + hostname + " user=" + username + R"(
test data // untouched
// <<<
)",
" // >>> distro=" + distro + " hostname=" + hostname + " user=" + username + R"(
test data // untouched
// <<<
)",
// Comment //
"// >>> distro=" + placeholder + " hostname=" + hostname + " user=" + username + R"(
test data // comment
// <<<
)",
" // >>> distro=" + distro + " hostname=" + placeholder + " user=" + username + R"(
test data // comment
// <<<
)",
" // >>> distro=" + distro + " hostname=" + hostname + " user=" + placeholder + R"(
test data // comment
// <<<
)",
" // >>> distro=" + placeholder + " hostname=" + hostname + " user=" + username + R"(
test data // comment
// <<<
)",
// Uncomment //
"// >>> distro=" + distro + " hostname=" + hostname + " user=" + username + R"(
// test data // uncomment
// <<<
)",
" // >>> distro=" + distro + " hostname=" + hostname + " user=" + username + R"(
// test data // uncomment
// <<<
)",
" // >>> distro=" + distro + " hostname=" + hostname + " user=" + username + R"(
// test data // uncomment
// <<<
)",
" // >>> distro=" + distro + " hostname=" + hostname + " user=" + username + R"(
// test data // uncomment
// <<<
)",
// -----------------------------------------
// Untouched /**/
"/* >>> distro=" + distro + " hostname=" + hostname + " user=" + username + " */" + R"(
test data /**/ untouched
/* <<< */
)",
" /* >>> distro=" + distro + " hostname=" + hostname + " user=" + username + " */" + R"(
test data /**/ untouched
/* <<< */
)",
" /* >>> distro=" + distro + " hostname=" + hostname + " user=" + username + " */" + R"(
test data /**/ untouched
/* <<< */
)",
" /* >>> distro=" + distro + " hostname=" + hostname + " user=" + username + " */" + R"(
test data /**/ untouched
/* <<< */
)",
// Comment /**/
"/* >>> distro=" + placeholder + " hostname=" + hostname + " user=" + username + " */" + R"(
test data /**/ comment
/* <<< */
)",
" /* >>> distro=" + distro + " hostname=" + placeholder + " user=" + username + " */" + R"(
test data /**/ comment
/* <<< */
)",
" /* >>> distro=" + distro + " hostname=" + hostname + " user=" + placeholder + " */" + R"(
test data /**/ comment
/* <<< */
)",
" /* >>> distro=" + placeholder + " hostname=" + hostname + " user=" + username + " */" + R"(
test data /**/ comment
/* <<< */
)",
// Uncomment /**/
"/* >>> distro=" + distro + " hostname=" + hostname + " user=" + username + " */" + R"(
/* test data /**/ uncomment */
/* <<< */
)",
" /* >>> distro=" + distro + " hostname=" + hostname + " user=" + username + " */" + R"(
/* test data /**/ uncomment */
/* <<< */
)",
" /* >>> distro=" + distro + " hostname=" + hostname + " user=" + username + " */" + R"(
/* test data /**/ uncomment */
/* <<< */
)",
" /* >>> distro=" + distro + " hostname=" + hostname + " user=" + username + " */" + R"(
/* test data /**/ uncomment */
/* <<< */
)",
};
std::vector<std::string> pushedFileContents = {
// Untouched #
"# >>> distro=" + distro + " hostname=" + hostname + " user=" + username + R"(
test data # untouched
# <<<
)",
" # >>> distro=" + distro + " hostname=" + hostname + " user=" + username + R"(
test data # untouched
# <<<
)",
" # >>> distro=" + distro + " hostname=" + hostname + " user=" + username + R"(
test data # untouched
# <<<
)",
" # >>> distro=" + distro + " hostname=" + hostname + " user=" + username + R"(
test data # untouched
# <<<
)",
// Comment #
"# >>> distro=" + placeholder + " hostname=" + hostname + " user=" + username + R"(
# test data # comment
# <<<
)",
" # >>> distro=" + distro + " hostname=" + placeholder + " user=" + username + R"(
# test data # comment
# <<<
)",
" # >>> distro=" + distro + " hostname=" + hostname + " user=" + placeholder + R"(
# test data # comment
# <<<
)",
" # >>> distro=" + placeholder + " hostname=" + hostname + " user=" + username + R"(
# test data # comment
# <<<
)",
// Uncomment #
"# >>> distro=" + distro + " hostname=" + hostname + " user=" + username + R"(
test data # uncomment
# <<<
)",
" # >>> distro=" + distro + " hostname=" + hostname + " user=" + username + R"(
test data # uncomment
# <<<
)",
" # >>> distro=" + distro + " hostname=" + hostname + " user=" + username + R"(
test data # uncomment
# <<<
)",
" # >>> distro=" + distro + " hostname=" + hostname + " user=" + username + R"(
test data # uncomment
# <<<
)",
// -----------------------------------------
// Untouched //
"// >>> distro=" + distro + " hostname=" + hostname + " user=" + username + R"(
test data // untouched
// <<<
)",
" // >>> distro=" + distro + " hostname=" + hostname + " user=" + username + R"(
test data // untouched
// <<<
)",
" // >>> distro=" + distro + " hostname=" + hostname + " user=" + username + R"(
test data // untouched
// <<<
)",
" // >>> distro=" + distro + " hostname=" + hostname + " user=" + username + R"(
test data // untouched
// <<<
)",
// Comment //
"// >>> distro=" + placeholder + " hostname=" + hostname + " user=" + username + R"(
// test data // comment
// <<<
)",
" // >>> distro=" + distro + " hostname=" + placeholder + " user=" + username + R"(
// test data // comment
// <<<
)",
" // >>> distro=" + distro + " hostname=" + hostname + " user=" + placeholder + R"(
// test data // comment
// <<<
)",
" // >>> distro=" + placeholder + " hostname=" + hostname + " user=" + username + R"(
// test data // comment
// <<<
)",
// Uncomment //
"// >>> distro=" + distro + " hostname=" + hostname + " user=" + username + R"(
test data // uncomment
// <<<
)",
" // >>> distro=" + distro + " hostname=" + hostname + " user=" + username + R"(
test data // uncomment
// <<<
)",
" // >>> distro=" + distro + " hostname=" + hostname + " user=" + username + R"(
test data // uncomment
// <<<
)",
" // >>> distro=" + distro + " hostname=" + hostname + " user=" + username + R"(
test data // uncomment
// <<<
)",
// -----------------------------------------
// Untouched /**/
"/* >>> distro=" + distro + " hostname=" + hostname + " user=" + username + " */" + R"(
test data /**/ untouched
/* <<< */
)",
" /* >>> distro=" + distro + " hostname=" + hostname + " user=" + username + " */" + R"(
test data /**/ untouched
/* <<< */
)",
" /* >>> distro=" + distro + " hostname=" + hostname + " user=" + username + " */" + R"(
test data /**/ untouched
/* <<< */
)",
" /* >>> distro=" + distro + " hostname=" + hostname + " user=" + username + " */" + R"(
test data /**/ untouched
/* <<< */
)",
// Comment /**/
"/* >>> distro=" + placeholder + " hostname=" + hostname + " user=" + username + " */" + R"(
/* test data /**/ comment */
/* <<< */
)",
" /* >>> distro=" + distro + " hostname=" + placeholder + " user=" + username + " */" + R"(
/* test data /**/ comment */
/* <<< */
)",
" /* >>> distro=" + distro + " hostname=" + hostname + " user=" + placeholder + " */" + R"(
/* test data /**/ comment */
/* <<< */
)",
" /* >>> distro=" + placeholder + " hostname=" + hostname + " user=" + username + " */" + R"(
/* test data /**/ comment */
/* <<< */
)",
// Uncomment /**/
"/* >>> distro=" + distro + " hostname=" + hostname + " user=" + username + " */" + R"(
test data /**/ uncomment
/* <<< */
)",
" /* >>> distro=" + distro + " hostname=" + hostname + " user=" + username + " */" + R"(
test data /**/ uncomment
/* <<< */
)",
" /* >>> distro=" + distro + " hostname=" + hostname + " user=" + username + " */" + R"(
test data /**/ uncomment
/* <<< */
)",
" /* >>> distro=" + distro + " hostname=" + hostname + " user=" + username + " */" + R"(
test data /**/ uncomment
/* <<< */
)",
};
createTestDotfiles(fileNames, fileContents);
Dotfile::the().push(fileNames);
for (size_t i = 0; i < fileNames.size(); ++i) {
const auto& file = fileNames.at(i);
VERIFY(std::filesystem::exists(file), continue);
VERIFY(std::filesystem::exists(homeDirectory / file), continue);
Util::File lhs(homeDirectory / file);
EXPECT_EQ(lhs.data(), pushedFileContents.at(i));
}
removeTestDotfiles(fileNames);
}
TEST_CASE(AddSystemDotfiles)
{
VERIFY(geteuid() == 0, return);
Config::the().setSystemDirectories({ "/etc", "/usr/lib" });
Dotfile::the().add({ "/etc/group", "/usr/lib/os-release" });
Config::the().setSystemDirectories({});
EXPECT(std::filesystem::exists("etc/group"));
EXPECT(std::filesystem::exists("usr/lib/os-release"));
std::filesystem::remove_all(Config::the().workingDirectory() / "etc");
std::filesystem::remove_all(Config::the().workingDirectory() / "usr");
}
TEST_CASE(PullSystemDotfiles)
{
VERIFY(geteuid() == 0, return);
createTestDotfiles({ "etc/group" }, { "" }, true);
Config::the().setSystemDirectories({ "/etc" });
Dotfile::the().pull({ "etc/group" });
Config::the().setSystemDirectories({});
Util::File lhs("/etc/group");
Util::File rhs(Config::the().workingDirectory() / "etc/group");
EXPECT_EQ(lhs.data(), rhs.data());
std::filesystem::remove_all(Config::the().workingDirectory() / "etc");
}
TEST_CASE(AddSymlinkDotfiles)
{
std::filesystem::path fileInHome = homeDirectory / "__the-add-file";
std::filesystem::path symlinkFileName = "__the-add-symlink";
std::filesystem::path symlinkInHome = homeDirectory / symlinkFileName;
createTestDotfiles({ fileInHome }, { "the file contents" });
std::filesystem::create_symlink(fileInHome, symlinkInHome);
Dotfile::the().add({ symlinkInHome });
EXPECT(std::filesystem::is_symlink(symlinkFileName));
EXPECT_EQ(std::filesystem::read_symlink(symlinkFileName).string(), fileInHome);
EXPECT_EQ(Util::File(symlinkFileName).data(), "the file contents");
removeTestDotfiles({ symlinkInHome, fileInHome });
}
TEST_CASE(PullSymlinkDotfiles)
{
std::filesystem::path fileInHome = homeDirectory / "__the-pull-file";
std::filesystem::path symlinkFileName = "__the-pull-symlink";
std::filesystem::path symlinkInHome = homeDirectory / symlinkFileName;
createTestDotfiles({ fileInHome }, { "the file contents" });
std::filesystem::create_symlink(fileInHome, symlinkInHome);
std::filesystem::create_symlink("doesnt-exist", symlinkFileName);
Dotfile::the().pull({ symlinkFileName });
EXPECT(std::filesystem::is_symlink(symlinkFileName));
EXPECT_EQ(std::filesystem::read_symlink(symlinkFileName).string(), fileInHome);
EXPECT_EQ(Util::File(symlinkFileName).data(), "the file contents");
removeTestDotfiles({ symlinkInHome, fileInHome });
}
TEST_CASE(PushSymlinkDotfiles)
{
std::filesystem::path fileInHome = homeDirectory / "__the-push-file";
std::filesystem::path symlinkFileName = "__the-push-symlink";
std::filesystem::path symlinkInHome = homeDirectory / symlinkFileName;
createTestDotfiles({ fileInHome }, { "the file contents" });
std::filesystem::create_symlink(fileInHome, symlinkFileName);
Dotfile::the().push({ symlinkFileName });
EXPECT(std::filesystem::is_symlink(symlinkInHome));
EXPECT_EQ(std::filesystem::read_symlink(symlinkInHome).string(), fileInHome);
EXPECT_EQ(Util::File(symlinkInHome).data(), "the file contents");
removeTestDotfiles({ symlinkInHome, fileInHome });
}