forked from lix-project/lix
c5bd564c69
When running nix doctor on a healthy system, it just prints the store URI and nothing else. This makes it unclear whether the system is in a good state and what check(s) it actually ran, since some of the checks are optional depending on the store type. This commit updates nix doctor to print an colored log message for every check that it does, and explicitly state whether that check was a PASS or FAIL to make it clear to the user whether the system passed its checkup with the doctor. Fixes #3084
140 lines
4 KiB
C++
140 lines
4 KiB
C++
#include <sstream>
|
|
|
|
#include "command.hh"
|
|
#include "logging.hh"
|
|
#include "serve-protocol.hh"
|
|
#include "shared.hh"
|
|
#include "store-api.hh"
|
|
#include "util.hh"
|
|
#include "worker-protocol.hh"
|
|
|
|
using namespace nix;
|
|
|
|
namespace {
|
|
|
|
std::string formatProtocol(unsigned int proto)
|
|
{
|
|
if (proto) {
|
|
auto major = GET_PROTOCOL_MAJOR(proto) >> 8;
|
|
auto minor = GET_PROTOCOL_MINOR(proto);
|
|
return (format("%1%.%2%") % major % minor).str();
|
|
}
|
|
return "unknown";
|
|
}
|
|
|
|
bool checkPass(const std::string & msg) {
|
|
logger->log(ANSI_GREEN "[PASS] " ANSI_NORMAL + msg);
|
|
return true;
|
|
}
|
|
|
|
bool checkFail(const std::string & msg) {
|
|
logger->log(ANSI_RED "[FAIL] " ANSI_NORMAL + msg);
|
|
return false;
|
|
}
|
|
|
|
}
|
|
|
|
struct CmdDoctor : StoreCommand
|
|
{
|
|
bool success = true;
|
|
|
|
std::string name() override
|
|
{
|
|
return "doctor";
|
|
}
|
|
|
|
std::string description() override
|
|
{
|
|
return "check your system for potential problems and print a PASS or FAIL for each check.";
|
|
}
|
|
|
|
void run(ref<Store> store) override
|
|
{
|
|
logger->log("Running checks against store uri: " + store->getUri());
|
|
|
|
auto type = getStoreType();
|
|
|
|
if (type < tOther) {
|
|
success &= checkNixInPath();
|
|
success &= checkProfileRoots(store);
|
|
}
|
|
success &= checkStoreProtocol(store->getProtocol());
|
|
|
|
if (!success)
|
|
throw Exit(2);
|
|
}
|
|
|
|
bool checkNixInPath()
|
|
{
|
|
PathSet dirs;
|
|
|
|
for (auto & dir : tokenizeString<Strings>(getEnv("PATH"), ":"))
|
|
if (pathExists(dir + "/nix-env"))
|
|
dirs.insert(dirOf(canonPath(dir + "/nix-env", true)));
|
|
|
|
if (dirs.size() != 1) {
|
|
std::stringstream ss;
|
|
ss << "Multiple versions of nix found in PATH:\n";
|
|
for (auto & dir : dirs)
|
|
ss << " " << dir << "\n";
|
|
return checkFail(ss.str());
|
|
}
|
|
|
|
return checkPass("PATH contains only one nix version.");
|
|
}
|
|
|
|
bool checkProfileRoots(ref<Store> store)
|
|
{
|
|
PathSet dirs;
|
|
|
|
for (auto & dir : tokenizeString<Strings>(getEnv("PATH"), ":")) {
|
|
Path profileDir = dirOf(dir);
|
|
try {
|
|
Path userEnv = canonPath(profileDir, true);
|
|
|
|
if (store->isStorePath(userEnv) && hasSuffix(userEnv, "user-environment")) {
|
|
while (profileDir.find("/profiles/") == std::string::npos && isLink(profileDir))
|
|
profileDir = absPath(readLink(profileDir), dirOf(profileDir));
|
|
|
|
if (profileDir.find("/profiles/") == std::string::npos)
|
|
dirs.insert(dir);
|
|
}
|
|
} catch (SysError &) {}
|
|
}
|
|
|
|
if (!dirs.empty()) {
|
|
std::stringstream ss;
|
|
ss << "Found profiles outside of " << settings.nixStateDir << "/profiles.\n"
|
|
<< "The generation this profile points to might not have a gcroot and could be\n"
|
|
<< "garbage collected, resulting in broken symlinks.\n\n";
|
|
for (auto & dir : dirs)
|
|
ss << " " << dir << "\n";
|
|
ss << "\n";
|
|
return checkFail(ss.str());
|
|
}
|
|
|
|
return checkPass("All profiles are gcroots.");
|
|
}
|
|
|
|
bool checkStoreProtocol(unsigned int storeProto)
|
|
{
|
|
unsigned int clientProto = GET_PROTOCOL_MAJOR(SERVE_PROTOCOL_VERSION) == GET_PROTOCOL_MAJOR(storeProto)
|
|
? SERVE_PROTOCOL_VERSION
|
|
: PROTOCOL_VERSION;
|
|
|
|
if (clientProto != storeProto) {
|
|
std::stringstream ss;
|
|
ss << "Warning: protocol version of this client does not match the store.\n"
|
|
<< "While this is not necessarily a problem it's recommended to keep the client in\n"
|
|
<< "sync with the daemon.\n\n"
|
|
<< "Client protocol: " << formatProtocol(clientProto) << "\n"
|
|
<< "Store protocol: " << formatProtocol(storeProto) << "\n\n";
|
|
return checkFail(ss.str());
|
|
}
|
|
|
|
return checkPass("Client protocol matches store protocol.");
|
|
}
|
|
};
|
|
|
|
static RegisterCommand r1(make_ref<CmdDoctor>());
|