Merge branch 'fix/nix-doctor-output' of https://github.com/bhipple/nix

src/nix/doctor.cc

@@ -1,11 +1,17 @@
+#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) {
@@ -16,6 +22,18 @@ std::string formatProtocol(unsigned int proto)
     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;
@@ -27,13 +45,12 @@ struct CmdDoctor : StoreCommand
 
     std::string description() override
     {
-        return "check your system for potential problems";
+        return "check your system for potential problems and print a PASS or FAIL for each check.";
     }
 
     void run(ref<Store> store) override
     {
-        std::cout << "Store uri: " << store->getUri() << std::endl;
+        logger->log("Running checks against store uri: " + store->getUri());
-        std::cout << std::endl;
 
         auto type = getStoreType();
 
@@ -56,15 +73,14 @@ struct CmdDoctor : StoreCommand
                 dirs.insert(dirOf(canonPath(dir + "/nix-env", true)));
 
         if (dirs.size() != 1) {
-            std::cout << "Warning: multiple versions of nix found in PATH." << std::endl;
+            std::stringstream ss;
-            std::cout << std::endl;
+            ss << "Multiple versions of nix found in PATH:\n";
             for (auto & dir : dirs)
-                std::cout << "  " << dir << std::endl;
+                ss << "  " << dir << "\n";
-            std::cout << std::endl;
+            return checkFail(ss.str());
-            return false;
         }
 
-        return true;
+        return checkPass("PATH contains only one nix version.");
     }
 
     bool checkProfileRoots(ref<Store> store)
@@ -87,17 +103,17 @@ struct CmdDoctor : StoreCommand
         }
 
         if (!dirs.empty()) {
-            std::cout << "Warning: found profiles outside of " << settings.nixStateDir << "/profiles." << std::endl;
+            std::stringstream ss;
-            std::cout << "The generation this profile points to might not have a gcroot and could be" << std::endl;
+            ss << "Found profiles outside of " << settings.nixStateDir << "/profiles.\n"
-            std::cout << "garbage collected, resulting in broken symlinks." << std::endl;
+               << "The generation this profile points to might not have a gcroot and could be\n"
-            std::cout << std::endl;
+               << "garbage collected, resulting in broken symlinks.\n\n";
             for (auto & dir : dirs)
-                std::cout << "  " << dir << std::endl;
+                ss << "  " << dir << "\n";
-            std::cout << std::endl;
+            ss << "\n";
-            return false;
+            return checkFail(ss.str());
         }
 
-        return true;
+        return checkPass("All profiles are gcroots.");
     }
 
     bool checkStoreProtocol(unsigned int storeProto)
@@ -107,17 +123,16 @@ struct CmdDoctor : StoreCommand
             : PROTOCOL_VERSION;
 
         if (clientProto != storeProto) {
-            std::cout << "Warning: protocol version of this client does not match the store." << std::endl;
+            std::stringstream ss;
-            std::cout << "While this is not necessarily a problem it's recommended to keep the client in" << std::endl;
+            ss << "Warning: protocol version of this client does not match the store.\n"
-            std::cout << "sync with the daemon." << std::endl;
+               << "While this is not necessarily a problem it's recommended to keep the client in\n"
-            std::cout << std::endl;
+               << "sync with the daemon.\n\n"
-            std::cout << "Client protocol: " << formatProtocol(clientProto) << std::endl;
+               << "Client protocol: " << formatProtocol(clientProto) << "\n"
-            std::cout << "Store protocol: " << formatProtocol(storeProto) << std::endl;
+               << "Store protocol: " << formatProtocol(storeProto) << "\n\n";
-            std::cout << std::endl;
+            return checkFail(ss.str());
-            return false;
         }
 
-        return true;
+        return checkPass("Client protocol matches store protocol.");
     }
 };