Add support for Poetry along with some fixes to PyEnv, Conda (#44)

Author: DonJayamanne

Cargo.lock

@@ -18,8 +18,6 @@ log = "0.4.21"
 regex = "1.10.4"
 pet-reporter = { path = "../pet-reporter" }
 
-[dev-dependencies]
-
 
 [features]
 ci = []

crates/pet-conda/Cargo.toml

@@ -72,6 +72,8 @@ fn get_conda_rc_search_paths(env_vars: &EnvVariables) -> Vec<PathBuf> {
 // Search paths documented here
 // https://conda.io/projects/conda/en/latest/user-guide/configuration/use-condarc.html#searching-for-condarc
 fn get_conda_rc_search_paths(env_vars: &EnvVariables) -> Vec<PathBuf> {
+    use crate::utils::change_root_of_path;
+
     let mut search_paths: Vec<PathBuf> = [
         "/etc/conda/.condarc",
         "/etc/conda/condarc",
@@ -82,16 +84,7 @@ fn get_conda_rc_search_paths(env_vars: &EnvVariables) -> Vec<PathBuf> {
     ]
     .iter()
     .map(PathBuf::from)
-    .map(|p| {
-        // This only applies in tests.
-        // We need this, as the root folder cannot be mocked.
-        if let Some(ref root) = env_vars.root {
-            // Strip the first `/` (this path is only for testing purposes)
-            root.join(&p.to_string_lossy()[1..])
-        } else {
-            p
-        }
-    })
+    .map(|p| change_root_of_path(&p, &env_vars.root))
     .collect();
 
     if let Some(ref conda_root) = env_vars.conda_root {

crates/pet-conda/src/conda_rc.rs

@@ -10,6 +10,7 @@ use pet_core::os_environment::Environment;
 // Lets be explicit, this way we never miss a value (in Windows or Unix).
 pub struct EnvVariables {
     pub home: Option<PathBuf>,
+    /// Only used in tests, None in production.
     pub root: Option<PathBuf>,
     pub path: Option<String>,
     pub userprofile: Option<String>,

crates/pet-conda/src/env_variables.rs

@@ -1,7 +1,10 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
-use std::{fs, path::Path};
+use std::{
+    fs,
+    path::{Path, PathBuf},
+};
 
 // conda-meta must exist as this contains a mandatory `history` file.
 pub fn is_conda_install(path: &Path) -> bool {
@@ -17,3 +20,24 @@ pub fn is_conda_env(path: &Path) -> bool {
         false
     }
 }
+
+/// Only used in tests, noop in production.
+///
+/// Change the root of the path to a new root.
+/// Lets assume some config file is located in the root directory /etc/config/config.toml.
+/// We cannot test this unless we create such a file on the root of the filesystem.
+/// Thats very risky and not recommended (ideally we want to create stuff in separate test folders).
+/// The solution is to change the root of the path to a test folder.
+pub fn change_root_of_path(path: &Path, new_root: &Option<PathBuf>) -> PathBuf {
+    if cfg!(windows) {
+        return path.to_path_buf();
+    }
+    if let Some(new_root) = new_root {
+        // This only applies in tests.
+        // We need this, as the root folder cannot be mocked.
+        // Strip the first `/` (this path is only for testing purposes)
+        new_root.join(&path.to_string_lossy()[1..])
+    } else {
+        path.to_path_buf()
+    }
+}

crates/pet-conda/src/utils.rs

@@ -9,6 +9,7 @@ use std::path::PathBuf;
 #[derive(Debug, Hash)]
 pub enum EnvManagerType {
     Conda,
+    Poetry,
     Pyenv,
 }
 

crates/pet-core/src/manager.rs

@@ -7,9 +7,7 @@ use pet_fs::path::norm_case;
 
 pub trait Environment {
     fn get_user_home(&self) -> Option<PathBuf>;
-    /**
-     * Only used in tests, this is the root `/`.
-     */
+    /// Only used in tests, None in production.
     #[allow(dead_code)]
     fn get_root(&self) -> Option<PathBuf>;
     fn get_env_var(&self, key: String) -> Option<String>;

crates/pet-core/src/os_environment.rs

@@ -18,8 +18,8 @@ pub enum PythonEnvironmentCategory {
     Pyenv,           // Relates to Python installations in pyenv that are from Python org.
     GlobalPaths,     // Python found in global locations like PATH, /usr/bin etc.
     PyenvVirtualEnv, // Pyenv virtualenvs.
-    PyenvOther,      // Such as pyston, stackless, nogil, etc.
     Pipenv,
+    Poetry,
     System,
     MacPythonOrg,
     MacCommandLineTools,