From 3742c16ce06bc8fbf6758a6f4ee796c3b2988084 Mon Sep 17 00:00:00 2001
From: Filippo Squillace <squillace.filippo@gmail.com>
Date: Sun, 7 May 2023 16:13:10 +0200
Subject: [PATCH] Add documentation and unit test

---
 README.md                         | 24 ++++++++++++++++++++----
 tests/unit-tests/test-wrappers.sh | 11 +++++++++++
 2 files changed, 31 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index a6485d2..72ae100 100644
--- a/README.md
+++ b/README.md
@@ -110,9 +110,9 @@ used, see the [Usage](#usage) section below.
 Run JuNest installed programs directly from host OS
 ---------------------------------------
 
-Program installed within JuNest can be accessible directly from host machine
-without entering directly into a JuNest session
-(no need to call `junest` command first).
+Programs installed within JuNest can be accessible directly from host machine
+without entering into a JuNest session
+(namely, no need to call `junest` command first).
 For instance, supposing the host OS is an Ubuntu distro you can directly
 run `pacman` by simply updating the `PATH` variable:
 
@@ -123,7 +123,7 @@ htop
 ```
 
 By default the wrappers use `ns` mode. To use the `ns --fakeroot` you can use the convenient command helper `sudoj`.
-For more control on backend mode you can use the `JUNEST_ARGS` environment variable.
+For more control on backend modes you can use the `JUNEST_ARGS` environment variable too.
 For instance, if you want to run `iftop` with real root privileges:
 
 ```
@@ -138,6 +138,22 @@ corrupted) with:
 junest create-bin-wrappers -f
 ```
 
+Bin wrappers are automatically generated each time they get installed inside JuNest.
+This only works for executables located in `/usr/bin` path.
+For executables in other locations (say `/usr/mybinpath`) you can only create
+wrappers manually by executing the command:
+
+```
+junest create-bin-wrappers --bin-path /usr/mybinpath
+```
+
+Obviously, to get access to the corresponding bin wrappers you will need to
+update your `PATH` variable accordingly:
+
+```
+export PATH="$PATH:~/.junest/usr/mybinpath_wrappers"
+```
+
 Install packages from AUR
 -------------------------
 
diff --git a/tests/unit-tests/test-wrappers.sh b/tests/unit-tests/test-wrappers.sh
index c5a5857..eef1f38 100755
--- a/tests/unit-tests/test-wrappers.sh
+++ b/tests/unit-tests/test-wrappers.sh
@@ -124,4 +124,15 @@ function test_create_wrappers_executable_no_longer_exist(){
     assertTrue "myfile wrapper should not exist" "[ ! -x $JUNEST_HOME/usr/bin_wrappers/myfile ]"
 }
 
+function test_create_wrappers_custom_bin_path(){
+    mkdir -p "$JUNEST_HOME"/usr/mybindir
+    touch "$JUNEST_HOME"/usr/mybindir/myfile
+    chmod +x "$JUNEST_HOME"/usr/mybindir/myfile
+    assertCommandSuccess create_wrappers false /usr/mybindir/
+    assertEquals "" "$(cat "$STDOUTF")"
+    assertTrue "bin_wrappers should exist" "[ -e $JUNEST_HOME/usr/mybindir_wrappers ]"
+    assertTrue "myfile wrapper should exist" "[ -x $JUNEST_HOME/usr/mybindir_wrappers/myfile ]"
+}
+
+
 source "$(dirname "$0")"/../utils/shunit2