Improve error message for MigrationDirectoryNotFound and ProjectRootNotFound

Author: weiznich

diesel/src/migration/errors.rs

@@ -13,7 +13,7 @@ use crate::result;
 #[derive(Debug)]
 pub enum MigrationError {
     /// The migration directory wasn't found
-    MigrationDirectoryNotFound,
+    MigrationDirectoryNotFound(PathBuf),
     /// Provided migration was in an unknown format
     UnknownMigrationFormat(PathBuf),
     /// General system IO error
@@ -32,9 +32,10 @@ impl Error for MigrationError {}
 impl fmt::Display for MigrationError {
     fn fmt(&self, f: &mut fmt::Formatter) -> Result<(), fmt::Error> {
         match *self {
-            MigrationError::MigrationDirectoryNotFound => write!(
+            MigrationError::MigrationDirectoryNotFound(ref p) => write!(
                 f,
-                "Unable to find migrations directory in this directory or any parent directories."
+                "Unable to find migrations directory in {:?} or any parent directories.",
+                p
             ),
             MigrationError::UnknownMigrationFormat(_) => write!(
                 f,
@@ -59,8 +60,8 @@ impl PartialEq for MigrationError {
     fn eq(&self, other: &Self) -> bool {
         match (self, other) {
             (
-                &MigrationError::MigrationDirectoryNotFound,
-                &MigrationError::MigrationDirectoryNotFound,
+                &MigrationError::MigrationDirectoryNotFound(_),
+                &MigrationError::MigrationDirectoryNotFound(_),
             ) => true,
             (
                 &MigrationError::UnknownMigrationFormat(ref p1),

diesel_cli/src/database_error.rs

@@ -2,6 +2,7 @@ use diesel::result;
 
 use std::convert::From;
 use std::error::Error;
+use std::path::PathBuf;
 use std::{fmt, io};
 
 use self::DatabaseError::*;
@@ -10,7 +11,7 @@ pub type DatabaseResult<T> = Result<T, DatabaseError>;
 
 #[derive(Debug)]
 pub enum DatabaseError {
-    ProjectRootNotFound,
+    ProjectRootNotFound(PathBuf),
     DatabaseUrlMissing,
     IoError(io::Error),
     QueryError(result::Error),
@@ -40,8 +41,8 @@ impl Error for DatabaseError {}
 impl fmt::Display for DatabaseError {
     fn fmt(&self, f: &mut fmt::Formatter) -> Result<(), fmt::Error> {
         match *self {
-            ProjectRootNotFound => {
-                f.write_str("Unable to find diesel.toml or Cargo.toml in this directory or any parent directories.")
+            ProjectRootNotFound(ref p) => {
+                write!(f, "Unable to find diesel.toml or Cargo.toml in {:?} or any parent directories.", p)
             }
             DatabaseUrlMissing => {
                 f.write_str("The --database-url argument must be passed, or the DATABASE_URL environment variable must be set.")
@@ -65,7 +66,7 @@ impl fmt::Display for DatabaseError {
 impl PartialEq for DatabaseError {
     fn eq(&self, other: &Self) -> bool {
         match (self, other) {
-            (&ProjectRootNotFound, &ProjectRootNotFound) => true,
+            (&ProjectRootNotFound(_), &ProjectRootNotFound(_)) => true,
             _ => false,
         }
     }

diesel_cli/src/main.rs

@@ -316,7 +316,8 @@ fn search_for_directory_containing_file(path: &Path, file: &str) -> DatabaseResu
     } else {
         path.parent()
             .map(|p| search_for_directory_containing_file(p, file))
-            .unwrap_or(Err(DatabaseError::ProjectRootNotFound))
+            .unwrap_or_else(|| Err(DatabaseError::ProjectRootNotFound(path.into())))
+            .map_err(|_| DatabaseError::ProjectRootNotFound(path.into()))
     }
 }
 

diesel_migrations/migrations_internals/src/lib.rs

@@ -384,8 +384,9 @@ pub fn search_for_migrations_directory(path: &Path) -> Result<PathBuf, Migration
         Ok(migration_path)
     } else {
         path.parent()
-            .map(search_for_migrations_directory)
-            .unwrap_or(Err(MigrationError::MigrationDirectoryNotFound))
+            .map(|p| search_for_migrations_directory(p))
+            .unwrap_or_else(|| Err(MigrationError::MigrationDirectoryNotFound(path.into())))
+            .map_err(|_| MigrationError::MigrationDirectoryNotFound(path.into()))
     }
 }