Add command and instructions to test plugin.

Daniel Perez · Daniel Perez · commit 072a57e4cb94 · 2016-05-13T16:04:01.000+09:00
diff --git a/bin/asdf b/bin/asdf
@@ -17,6 +17,7 @@ source $(dirname $(dirname $0))/lib/commands/plugin-update.sh
 source $(dirname $(dirname $0))/lib/commands/plugin-remove.sh
 
 source $(dirname $(dirname $0))/lib/commands/plugin-push.sh
+source $(dirname $(dirname $0))/lib/commands/plugin-test.sh
 
 
 callback_args="${@:2}"
@@ -75,6 +76,9 @@ case $1 in
 "plugin-push")
     plugin_push_command $callback_args;;
 
+"plugin-test")
+    plugin_test_command $callback_args;;
+
 *)
   help_command
   exit 1;;
diff --git a/docs/creating-plugins.md b/docs/creating-plugins.md
@@ -61,3 +61,34 @@ Prints the version of the tool to use if a legacy version file is found in the c
 asdf allows custom shim templates. For an executable called `foo`, if there's a `shims/foo` file in the plugin, then asdf will copy that file instead of using it's standard shim template.
 
 This must be used wisely. For now AFAIK, it's only being used in the Elixir plugin, because an executable is also read as an Elixir file apart from just being an executable. Which makes it not possible to use the standard bash shim.
+
+## Testing plugins
+
+`asdf` contains the `plugin-test` command to test your plugin.
+You can use it as follows
+
+```sh
+asdf plugin-test <plugin-name> <plugin-url>
+```
+
+So for example to test the Elixir plugin, we would run
+
+```sh
+asdf plugin-test elixir https://github.com/asdf-vm/asdf-elixir.git
+```
+
+We strongly recommend you test your plugin on TravisCI, to make sure it works
+on both Linux and OSX.
+
+Here is a sample `.travis.yml` file, customize it to your needs
+
+```yaml
+language: c
+script: asdf plugin-test elixir https://github.com/asdf-vm/asdf-elixir.git
+before_script:
+  - git clone https://github.com/asdf-vm/asdf.git asdf
+  - . asdf/asdf.sh
+os:
+  - linux
+  - osx
+```
diff --git a/lib/commands/plugin-add.sh b/lib/commands/plugin-add.sh
@@ -7,10 +7,13 @@ plugin_add_command() {
 
   if [ -d $plugin_path ]; then
     echo "Plugin named $plugin_name already added"
+    exit 1
   else
     git clone $source_url $plugin_path
     if [ $? -eq 0 ]; then
       chmod +x $plugin_path/bin/*
+    else
+      exit 1
     fi
   fi
 }
diff --git a/lib/commands/plugin-test.sh b/lib/commands/plugin-test.sh
@@ -0,0 +1,43 @@
+fail_test() {
+    echo "FAILED: $1"
+    rm -rf $ASDF_DIR
+    exit 1
+}
+
+plugin_test_command() {
+    export ASDF_DIR=$(mktemp -dt asdf.XXXX)
+
+    local plugin_name=$1
+    local plugin_url=$2
+
+    if [ -z "$plugin_name" -o -z "$plugin_url" ]; then
+        fail_test "please provide a plugin name and url"
+    fi
+
+    (asdf plugin-add $plugin_name $plugin_url)
+    if [ $? -ne 0 ]; then
+        fail_test "could not install $plugin_name from $plugin_url"
+    fi
+
+    if ! asdf plugin-list | grep $plugin_name > /dev/null; then
+        fail_test "$plugin_name was not properly installed"
+    fi
+
+    read -a versions <<< $(asdf list-all $plugin_name)
+
+    if [ $? -ne 0 ]; then
+        fail_test "list-all exited with an error"
+    fi
+
+    if [ ${#versions} -eq 0 ]; then
+        fail_test "list-all did not return any version"
+    fi
+
+    (asdf install $plugin_name ${versions[0]})
+
+    if [ $? -ne 0 ]; then
+        fail_test "install exited with an error"
+    fi
+
+    rm -rf $ASDF_DIR
+}
