Renaming unnecessary-dependencies (#7)

* tests for check-unused-dependencies

* Renaming check-unnecessary-dependencies to check-unused-dependencies
---
Co-authored-by: Ashley Willard <[email protected]>
Co-authored-by: Teal Stannard <[email protected]>

Author: 3 people

Cargo.toml

@@ -2,7 +2,7 @@
 
 [package]
 name = "pks"
-version = "0.2.20"
+version = "0.2.21"
 edition = "2021"
 description = "Welcome! Please see https://github.com/rubyatscale/pks for more information!"
 license = "MIT"

src/packs/checker.rs

@@ -381,13 +381,14 @@ pub(crate) fn check_unnecessary_dependencies(
             "Found 1 unnecessary dependency".to_string()
         } else {
             format!(
-                "Found {} unnecessary dependencies",
+                "Found {} unused dependencies",
                 unnecessary_dependencies.len()
             )
         };
         bail!(
-            "{}. Run command with `--auto-correct` to remove them.",
+            "{}. Run `{} check-unused-dependencies --auto-correct` to remove them.",
             found_message,
+            bin_locater::packs_bin_name(),
         );
     }
 }

src/packs/cli.rs

@@ -109,10 +109,11 @@ enum Command {
     },
 
     #[clap(
-        about = "Check for dependencies that when removed produce no violations."
+        about = "Check for dependencies that when removed produce no violations.",
+        alias = "check-unnecessary-dependencies"
     )]
-    CheckUnnecessaryDependencies {
-        #[arg(long)]
+    CheckUnusedDependencies {
+        #[arg(short, long)]
         auto_correct: bool,
     },
 
@@ -263,7 +264,7 @@ pub fn run() -> anyhow::Result<()> {
             packs::validate(&configuration)
             // Err("💡 Please use `packs check` to detect dependency cycles and run other configuration validations".into())
         }
-        Command::CheckUnnecessaryDependencies { auto_correct } => {
+        Command::CheckUnusedDependencies { auto_correct } => {
             packs::check_unnecessary_dependencies(&configuration, auto_correct)
         }
         Command::UpdateDependenciesForConstant { constant } => Ok(

tests/check_unnecessary_dependencies.rs tests/check_unused_dependencies.rstests/check_unnecessary_dependencies.rs renamed to tests/check_unused_dependencies.rs

@@ -3,13 +3,12 @@ use predicates::prelude::*;
 use std::{error::Error, fs, process::Command};
 mod common;
 
-#[test]
-fn test_check_unnecessary_dependencies() -> Result<(), Box<dyn Error>> {
+fn assert_check_unused_dependencies(cmd: &str) -> Result<(), Box<dyn Error>> {
     Command::cargo_bin("pks")?
         .arg("--project-root")
         .arg("tests/fixtures/app_with_dependency_cycles")
         .arg("--debug")
-        .arg("check-unnecessary-dependencies")
+        .arg(cmd)
         .assert()
         .failure()
         .stdout(predicate::str::contains(
@@ -19,19 +18,45 @@ fn test_check_unnecessary_dependencies() -> Result<(), Box<dyn Error>> {
             "packs/foo depends on packs/bar but does not use it",
         ))
         .stderr(predicate::str::contains(
-           "Error: Found 3 unnecessary dependencies. Run command with `--auto-correct` to remove them.",
-        ));
+           "Error: Found 3 unused dependencies. Run `packs check-unused-dependencies --auto-correct` to remove them.")
+        );
     Ok(())
 }
 
 #[test]
-fn test_auto_correct_unnecessary_dependencies() -> Result<(), Box<dyn Error>> {
+fn test_check_unnecessary_dependencies() -> Result<(), Box<dyn Error>> {
+    assert_check_unused_dependencies("check-unnecessary-dependencies")
+}
+
+#[test]
+fn test_check_unused_dependencies() -> Result<(), Box<dyn Error>> {
+    assert_check_unused_dependencies("check-unused-dependencies")
+}
+
+fn assert_auto_correct_unused_dependencies(
+    cmd: &str,
+    flag: &str,
+) -> Result<(), Box<dyn Error>> {
+    common::set_up_fixtures();
+
+    let expected_before_autocorrect = [
+        "enforce_dependencies: true",
+        "enforce_privacy: true",
+        "layer: technical_services",
+        "dependencies:",
+        "- packs/bar",
+        "- packs/baz\n",
+    ]
+    .join("\n");
+    let foo_package_yml = fs::read_to_string("tests/fixtures/app_with_unnecessary_dependencies/packs/foo/package.yml").unwrap();
+    assert_eq!(foo_package_yml, expected_before_autocorrect);
+
     Command::cargo_bin("pks")?
         .arg("--project-root")
         .arg("tests/fixtures/app_with_unnecessary_dependencies")
         .arg("--debug")
-        .arg("check-unnecessary-dependencies")
-        .arg("--auto-correct")
+        .arg(cmd)
+        .arg(flag)
         .assert()
         .success();
 
@@ -49,14 +74,31 @@ fn test_auto_correct_unnecessary_dependencies() -> Result<(), Box<dyn Error>> {
     Ok(())
 }
 
+#[test]
+fn test_auto_correct_unnecessary_dependencies() -> Result<(), Box<dyn Error>> {
+    assert_auto_correct_unused_dependencies(
+        "check-unused-dependencies",
+        "--auto-correct",
+    )?;
+    assert_auto_correct_unused_dependencies("check-unused-dependencies", "-a")?;
+    assert_auto_correct_unused_dependencies(
+        "check-unnecessary-dependencies",
+        "-a",
+    )?;
+    assert_auto_correct_unused_dependencies(
+        "check-unnecessary-dependencies",
+        "--auto-correct",
+    )
+}
+
 #[test]
 fn test_check_unnecessary_dependencies_no_issue() -> Result<(), Box<dyn Error>>
 {
     Command::cargo_bin("pks")?
         .arg("--project-root")
         .arg("tests/fixtures/simple_app")
         .arg("--debug")
-        .arg("check-unnecessary-dependencies")
+        .arg("check-unused-dependencies")
         .assert()
         .success();
     Ok(())