Pipenv tests (microsoft#83)

DonJayamanne · web-flow · commit 721ebdd02b47 · 2024-07-02T23:50:19.000-07:00
diff --git a/.github/workflows/pr-check.yml b/.github/workflows/pr-check.yml
@@ -87,6 +87,9 @@ jobs:
       - name: Check pipenv version
         run: pipenv --version
 
+      - name: Create a Pipenv Environment
+        run: pipenv install
+
       - name: Install virtualenvwrapper
         # Activation of the script doesn't work on mac for some reason (didn't check why yet)
         # But linux is sufficient for the tests
diff --git a/crates/pet-global-virtualenvs/src/lib.rs b/crates/pet-global-virtualenvs/src/lib.rs
@@ -7,6 +7,7 @@ use std::{fs, path::PathBuf};
 
 fn get_global_virtualenv_dirs(
     work_on_home_env_var: Option<String>,
+    xdg_data_home: Option<String>,
     user_home: Option<PathBuf>,
 ) -> Vec<PathBuf> {
     let mut venv_dirs: Vec<PathBuf> = vec![];
@@ -15,16 +16,29 @@ fn get_global_virtualenv_dirs(
         let work_on_home = norm_case(PathBuf::from(work_on_home));
         if fs::metadata(&work_on_home).is_ok() {
             venv_dirs.push(work_on_home);
+        } else if let Some(home) = &user_home {
+            if let Ok(work_on_home) = work_on_home.strip_prefix("~") {
+                let work_on_home = home.join(work_on_home);
+                if fs::metadata(&work_on_home).is_ok() {
+                    venv_dirs.push(work_on_home);
+                }
+            }
         }
     }
 
+    // Used by pipenv (https://github.com/pypa/pipenv/blob/main/pipenv/utils/shell.py#L184)
+    if let Some(xdg_data_home) = xdg_data_home.map(|d| PathBuf::from(d).join("virtualenvs")) {
+        if fs::metadata(&xdg_data_home).is_ok() {
+            venv_dirs.push(xdg_data_home);
+        }
+    }
     if let Some(home) = user_home {
         for dir in [
             PathBuf::from("envs"),
             PathBuf::from(".direnv"),
             PathBuf::from(".venvs"), // Used by pipenv, https://pipenv.pypa.io/en/latest/virtualenv.html
-            PathBuf::from(".virtualenvs"), // Default location for virtualenvwrapper, https://virtualenvwrapper.readthedocs.io/en/latest/install.html#location-of-environments
-            PathBuf::from(".local").join("share").join("virtualenvs"),
+            PathBuf::from(".virtualenvs"), // Used by pipenv (https://github.com/pypa/pipenv/blob/main/pipenv/utils/shell.py#L184), and also default location for virtualenvwrapper, https://virtualenvwrapper.readthedocs.io/en/latest/install.html#location-of-environments
+            PathBuf::from(".local").join("share").join("virtualenvs"), // Used by pipenv (https://github.com/pypa/pipenv/blob/main/pipenv/utils/shell.py#L184)
         ] {
             let venv_dir = home.join(dir);
             if fs::metadata(&venv_dir).is_ok() {
@@ -50,10 +64,11 @@ fn get_global_virtualenv_dirs(
 
 pub fn list_global_virtual_envs_paths(
     work_on_home_env_var: Option<String>,
+    xdg_data_home: Option<String>,
     user_home: Option<PathBuf>,
 ) -> Vec<PathBuf> {
     let mut python_envs: Vec<PathBuf> = vec![];
-    for root_dir in &get_global_virtualenv_dirs(work_on_home_env_var, user_home) {
+    for root_dir in &get_global_virtualenv_dirs(work_on_home_env_var, xdg_data_home, user_home) {
         if let Ok(dirs) = fs::read_dir(root_dir) {
             python_envs.append(
                 &mut dirs
diff --git a/crates/pet/src/find.rs b/crates/pet/src/find.rs
@@ -120,6 +120,7 @@ pub fn find_and_report_envs(
             let search_paths: Vec<PathBuf> = [
                 list_global_virtual_envs_paths(
                     environment.get_env_var("WORKON_HOME".into()),
+                    environment.get_env_var("XDG_DATA_HOME".into()),
                     environment.get_user_home(),
                 ),
                 environment_paths,
diff --git a/crates/pet/tests/ci_test.rs b/crates/pet/tests/ci_test.rs
@@ -161,6 +161,40 @@ fn check_if_virtualenvwrapper_exists() {
     );
 }
 
+#[cfg_attr(feature = "ci", test)]
+#[allow(dead_code)]
+fn check_if_pipenv_exists() {
+    use pet::{find::find_and_report_envs, locators::create_locators};
+    use pet_conda::Conda;
+    use pet_core::os_environment::EnvironmentApi;
+    use pet_reporter::test;
+    use std::{env, sync::Arc};
+
+    setup();
+    let reporter = test::create_reporter();
+    let environment = EnvironmentApi::new();
+    let conda_locator = Arc::new(Conda::from(&environment));
+
+    find_and_report_envs(
+        &reporter,
+        Default::default(),
+        &create_locators(conda_locator.clone()),
+        conda_locator,
+    );
+
+    let result = reporter.get_result();
+    let environments = result.environments;
+
+    let project_dir = PathBuf::from(env::var("GITHUB_WORKSPACE").unwrap_or_default());
+    environments
+        .iter()
+        .find(|env| {
+            env.category == PythonEnvironmentCategory::Pipenv
+                && env.project == Some(project_dir.clone())
+        })
+        .expect(format!("Pipenv environment not found, found {:?}", environments).as_str());
+}
+
 #[cfg(unix)]
 #[cfg(target_os = "linux")]
 #[cfg_attr(feature = "ci", test)]
