Use relative path. Now fails on invalid paths. Add a readme

Author: benjamin-bergia

Cargo.lock

@@ -1,12 +1,13 @@
 [package]
 name = "kree"
-version = "0.2.0"
+version = "0.3.0"
 edition = "2021"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
 clap = { version = "4.0", features = ["derive"] }
+relative-path = "1.7.2"
 serde = { version = "1.0", features = ["derive"] }
 serde_json = "1.0.87"
 serde_yaml = "0.9"

Cargo.toml

@@ -0,0 +1,39 @@
+# Kree (Kustomization Tree)
+
+Kree let you list all the resources included by a specific kustomizaition file.
+
+Limitations:
+  - Remote resources are currently ignored and will no appear in the ouput.
+
+## Example
+
+```bash
+> kree --help
+Usage: kree [OPTIONS] <PATH>
+
+Arguments:
+  <PATH>
+          Path to the kustomization file or directory
+
+Options:
+  -f, --format <FORMAT>
+          Output format
+          
+          [default: text]
+
+          Possible values:
+          - text: One path per line
+          - json: JSON
+
+  -h, --help
+          Print help information (use `-h` for a summary)
+```
+```bash
+> kree ../kustomize/examples/multibases
+../kustomize/examples/multibases/base/kustomization.yaml
+../kustomize/examples/multibases/base/pod.yaml
+../kustomize/examples/multibases/dev/kustomization.yaml
+../kustomize/examples/multibases/kustomization.yaml
+../kustomize/examples/multibases/production/kustomization.yaml
+../kustomize/examples/multibases/staging/kustomization.yaml
+```

README.md

@@ -1,8 +1,10 @@
 use clap::{Parser, ValueEnum};
+use relative_path::RelativePathBuf;
 use serde::Deserialize;
 use serde_json::json;
 use serde_yaml;
 use std::{
+    env::current_dir,
     fs,
     io,
     path::PathBuf,
@@ -13,7 +15,7 @@ use std::{
 #[command()]
 struct Args {
     /// Path to the kustomization file or directory
-    path: PathBuf,
+    path: RelativePathBuf,
 
     /// Output format
     #[arg(short, long, value_enum, default_value = "text")]
@@ -37,35 +39,33 @@ struct Kustomization {
 }
 
 
-fn canonical_path(path: PathBuf) -> io::Result<PathBuf> {
-    let mut canonical = path.canonicalize()?;
+fn normalize(root: &PathBuf, mut path: RelativePathBuf) -> RelativePathBuf {
+    path.normalize();
 
-    if canonical.is_file() {
-        return Ok(canonical);
+    if path.to_logical_path(&root).is_dir() {
+        path.push("kustomization.yml");
     }
 
-    if canonical.is_dir() {
-        canonical.push("kustomization.yml");
-        
-        if canonical.is_file() {
-            return Ok(canonical);
-        }
+    if path.to_logical_path(&root).is_file() {
+        return path;
+    } else {
+        path.set_extension("yaml");
+    }
+
+    if path.to_logical_path(&root).is_file() {
+        return path;
     }
 
-    let error = io::Error::new(
-        io::ErrorKind::Other,
-        format!("Invalid path {}", canonical.display())
-    );
-    return Err(error);
+    panic!("Unable to normalize path {path}");
 }
 
 
-fn read_file(path: PathBuf) -> io::Result<String> {
+fn read_file(path: &PathBuf) -> io::Result<String> {
     return fs::read_to_string(path);
 }
 
 
-fn deserialize(path: PathBuf) -> Vec<Kustomization> {
+fn deserialize(path: &PathBuf) -> Vec<Kustomization> {
     let content = read_file(path).unwrap();
 
     return serde_yaml::Deserializer::from_str(&content)
@@ -74,34 +74,37 @@ fn deserialize(path: PathBuf) -> Vec<Kustomization> {
 }
 
 
-fn run(path: PathBuf, result: &mut Vec<String>) {
-    if let Ok(canonical) = canonical_path(path.clone()) {
-        result.push(format!("{}", canonical.display()));
+fn run(root: &PathBuf, path: RelativePathBuf, result: &mut Vec<String>) {
+    let current_path = normalize(&root, path.clone());
 
-        let resources: Vec<String> = deserialize(canonical.clone())
-            .iter()
-            .map(|doc| doc.resources.clone())
-            .flatten()
-            .collect();
+    result.push(format!("{}", current_path));
 
-        for r in resources {
-            let mut next_path = canonical
-                .parent()
-                .unwrap()
-                .to_path_buf();
-            next_path.push(PathBuf::from(r));
+    let resources: Vec<String> = deserialize(&current_path.to_logical_path(root))
+        .iter()
+        .map(|doc| doc.resources.clone())
+        .flatten()
+        .collect();
+
+    for r in resources {
+        let next_path = current_path
+            .parent()
+            .unwrap()
+            .join_normalized(r);
 
-            run(next_path, result);
-        };
+        run(root, next_path, result);
     };
 }
 
 
 fn main() {
     let args = Args::parse();
+    let root = current_dir().unwrap();
     let mut result = Vec::new();
 
-    run(args.path, &mut result);
+    run(&root, args.path, &mut result);
+
+    result.sort();
+    result.dedup();
 
     match args.format {
         Some(Format::Json) => {