Merge pull request #212 from dritter/unit_testing

Adding Unit Tests, supported  by Travis-CI

12 files changed, 492 insertions, 1 deletions

diff --git a/.gitmodules b/.gitmodules
new file mode 100644
index 00000000..743b8e91
--- /dev/null
+++ b/.gitmodules
@@ -0,0 +1,3 @@
+[submodule "shunit2"]
+	path = shunit2
+	url = https://github.com/kward/shunit2.git
diff --git a/.travis.yml b/.travis.yml
new file mode 100644
index 00000000..71aff690
--- /dev/null
+++ b/.travis.yml
@@ -0,0 +1,27 @@
+sudo: true
+dist: trusty
+language: sh
+addons:
+  apt:
+    packages:
+      - build-essential
+
+before_script:
+  # Show the git version being used to test.
+  - "git --version"
+  # Show the zsh version being used to test.
+  - "zsh --version"
+
+install:
+  - "sudo apt-get update -qq"
+  - "sudo apt-get install zsh"
+  - "sudo chsh -s $(which zsh)"
+
+script:
+  - test/powerlevel9k.spec
+  - test/functions/utilities.spec
+  - test/functions/colors.spec
+  - test/segments/dir.spec
+  - test/segments/rust_version.spec
+  - test/segments/go_version.spec
+
diff --git a/TESTS.md b/TESTS.md
new file mode 100644
index 00000000..d4e663dc
--- /dev/null
+++ b/TESTS.md
@@ -0,0 +1,14 @@
+# Structure
+
+The Unit-Tests do not follow exactly the file structure of Powerlevel9k itself.
+
+## Basic Tests
+
+Basic Tests belong in `test/powerlevel9k.spec` if they test basic functionality of
+Powerlevel9k itself. Basic functions from the `functions` directory have their
+Tests in separate files under `test/functions`.
+
+## Segment Tests
+
+These Tests tend to be more complex in setup than the basic tests. To avoid ending
+up in a huge single file, there is one file per segment in `test/segments`.
diff --git a/functions/utilities.zsh b/functions/utilities.zsh
index dcbca3c6..5ca5b431 100644
--- a/functions/utilities.zsh
+++ b/functions/utilities.zsh
@@ -27,6 +27,9 @@ function set_default() {
 }
 
 # Converts large memory values into a human-readable unit (e.g., bytes --> GB)
+# Takes two arguments:
+#   * $size - The number which should be prettified
+#   * $base - The base of the number (default Bytes)
 printSizeHumanReadable() {
   typeset -F 2 size
   size="$1"+0.00001
diff --git a/powerlevel9k.zsh-theme b/powerlevel9k.zsh-theme
index 76ff5497..59733acd 100755
--- a/powerlevel9k.zsh-theme
+++ b/powerlevel9k.zsh-theme
@@ -471,7 +471,7 @@ prompt_dir() {
 # GO prompt
 prompt_go_version() {
   local go_version
-  go_version=$(go version 2>&1 | sed -E "s/.*(go[0-9.]*).*/\1/")
+  go_version=$(go version 2>/dev/null | sed -E "s/.*(go[0-9.]*).*/\1/")
 
   if [[ -n "$go_version" ]]; then
     "$1_prompt_segment" "$0" "$2" "green" "255" "$go_version"
diff --git a/shunit2 b/shunit2
new file mode 160000
+Subproject 60dd60bcd1573befe38465010263ab242e55811
diff --git a/test/functions/colors.spec b/test/functions/colors.spec
new file mode 100755
index 00000000..61a40087
--- /dev/null
+++ b/test/functions/colors.spec
@@ -0,0 +1,42 @@
+#!/usr/bin/env zsh
+#vim:ft=zsh ts=2 sw=2 sts=2 et fenc=utf-8
+
+# Required for shunit2 to run correctly
+setopt shwordsplit
+SHUNIT_PARENT=$0
+
+function setUp() {
+  # Load Powerlevel9k
+  source functions/colors.zsh
+}
+
+function testGetColorCodeWithAnsiForegroundColor() {
+  assertEquals '002' "$(getColorCode 'green')"
+}
+
+function testGetColorCodeWithAnsiBackgroundColor() {
+  assertEquals '002' "$(getColorCode 'bg-green')"
+}
+
+function testGetColorCodeWithNumericalColor() {
+  assertEquals '002' "$(getColorCode '002')"
+}
+
+function testIsSameColorComparesAnsiForegroundAndNumericalColorCorrectly() {
+  assertTrue "isSameColor 'green' '002'"
+}
+
+function testIsSameColorComparesAnsiBackgroundAndNumericalColorCorrectly() {
+  assertTrue "isSameColor 'bg-green' '002'"
+}
+
+function testIsSameColorComparesNumericalBackgroundAndNumericalColorCorrectly() {
+  assertTrue "isSameColor '010' '2'"
+}
+
+function testIsSameColorDoesNotYieldNotEqualColorsTruthy() {
+  assertFalse "isSameColor 'green' '003'"
+}
+
+
+source shunit2/source/2.1/src/shunit2
diff --git a/test/functions/utilities.spec b/test/functions/utilities.spec
new file mode 100755
index 00000000..a9bd67e3
--- /dev/null
+++ b/test/functions/utilities.spec
@@ -0,0 +1,109 @@
+#!/usr/bin/env zsh
+#vim:ft=zsh ts=2 sw=2 sts=2 et fenc=utf-8
+
+# Required for shunit2 to run correctly
+setopt shwordsplit
+SHUNIT_PARENT=$0
+
+function setUp() {
+  # Load Powerlevel9k
+  source functions/icons.zsh
+  source functions/utilities.zsh
+}
+
+function testDefinedFindsDefinedVariable() {
+  my_var='X'
+
+  assertTrue "defined 'my_var'"
+  unset my_var
+}
+
+function testDefinedDoesNotFindUndefinedVariable() {
+  assertFalse "defined 'my_var'"
+}
+
+function testSetDefaultSetsVariable() {
+  set_default 'my_var' 'x'
+
+  assertEquals 'x' "$my_var"
+  unset my_var
+}
+
+function testPrintSizeHumanReadableWithBigNumber() {
+  # Interesting: Currently we can't support numbers bigger than that.
+  assertEquals '0.87E' "$(printSizeHumanReadable 1000000000000000000)"
+}
+
+function testPrintSizeHumanReadableWithExabytesAsBase() {
+  assertEquals '9.77Z' "$(printSizeHumanReadable 10000 'E')"
+}
+
+function testGetRelevantItem() {
+  typeset -a list
+  list=(a b c)
+  local callback='[[ "$item" == "b" ]] && echo "found"'
+
+  local result=$(getRelevantItem "$list" "$callback")
+  assertEquals 'found' "$result"
+
+  unset list
+}
+
+function testGetRelevantItemDoesNotReturnNotFoundItems() {
+  typeset -a list
+  list=(a b c)
+  local callback='[[ "$item" == "d" ]] && echo "found"'
+
+  local result=$(getRelevantItem "$list" "$callback")
+  assertEquals '' ''
+
+  unset list
+}
+
+function testSegmentShouldBeJoinedIfDirectPredecessingSegmentIsJoined() {
+  typeset -a segments
+  segments=(a b_joined c_joined)
+  # Look at the third segment
+  local current_index=3
+  local last_element_index=2
+
+  local joined
+  segmentShouldBeJoined $current_index $last_element_index "$segments" && joined=true || joined=false
+  assertTrue "$joined"
+
+  unset segments
+}
+
+function testSegmentShouldBeJoinedIfPredecessingSegmentIsJoinedTransitivley() {
+  typeset -a segments
+  segments=(a b_joined c_joined)
+  # Look at the third segment
+  local current_index=3
+  # The last printed segment was the first one,
+  # the second segmend was conditional.
+  local last_element_index=1
+
+  local joined
+  segmentShouldBeJoined $current_index $last_element_index "$segments" && joined=true || joined=false
+  assertTrue "$joined"
+
+  unset segments
+}
+
+function testSegmentShouldNotBeJoinedIfPredecessingSegmentIsNotJoinedButConditional() {
+  typeset -a segments
+  segments=(a b_joined c d_joined)
+  # Look at the fourth segment
+  local current_index=4
+  # The last printed segment was the first one,
+  # the second segmend was conditional.
+  local last_element_index=1
+
+  local joined
+  segmentShouldBeJoined $current_index $last_element_index "$segments" && joined=true || joined=false
+  assertFalse "$joined"
+
+  unset segments
+}
+
+source shunit2/source/2.1/src/shunit2
diff --git a/test/powerlevel9k.spec b/test/powerlevel9k.spec
new file mode 100755
index 00000000..1aab2c5f
--- /dev/null
+++ b/test/powerlevel9k.spec
@@ -0,0 +1,95 @@
+#!/usr/bin/env zsh
+#vim:ft=zsh ts=2 sw=2 sts=2 et fenc=utf-8
+
+# Required for shunit2 to run correctly
+setopt shwordsplit
+SHUNIT_PARENT=$0
+
+function setUp() {
+  export TERM="xterm-256color"
+  # Load Powerlevel9k
+  source powerlevel9k.zsh-theme
+  source functions/*
+}
+
+function testJoinedSegments() {
+  POWERLEVEL9K_LEFT_PROMPT_ELEMENTS=(dir dir_joined)
+
+  assertEquals "%K{blue} %F{black}%~ %K{blue}%F{black}%F{black}%~ %k%F{blue}%f " "$(build_left_prompt)"
+
+  unset POWERLEVEL9K_LEFT_PROMPT_ELEMENTS
+}
+
+function testTransitiveJoinedSegments() {
+  POWERLEVEL9K_LEFT_PROMPT_ELEMENTS=(dir root_indicator_joined dir_joined)
+
+  assertEquals "%K{blue} %F{black}%~ %K{blue}%F{black}%F{black}%~ %k%F{blue}%f " "$(build_left_prompt)"
+
+  unset POWERLEVEL9K_LEFT_PROMPT_ELEMENTS
+}
+
+function testJoiningWithConditionalSegment() {
+  POWERLEVEL9K_LEFT_PROMPT_ELEMENTS=(dir background_jobs dir_joined)
+
+  assertEquals "%K{blue} %F{black}%~ %K{blue}%F{black} %F{black}%~ %k%F{blue}%f " "$(build_left_prompt)"
+
+  unset POWERLEVEL9K_LEFT_PROMPT_ELEMENTS
+}
+
+function testDynamicColoringOfSegmentsWork() {
+  POWERLEVEL9K_LEFT_PROMPT_ELEMENTS=(dir)
+  POWERLEVEL9K_DIR_HOME_SUBFOLDER_BACKGROUND='red'
+
+  assertEquals "%K{red} %F{black}%~ %k%F{red}%f " "$(build_left_prompt)"
+
+  unset POWERLEVEL9K_LEFT_PROMPT_ELEMENTS
+  unset POWERLEVEL9K_DIR_HOME_SUBFOLDER_BACKGROUND
+}
+
+function testDynamicColoringOfVisualIdentifiersWork() {
+  POWERLEVEL9K_LEFT_PROMPT_ELEMENTS=(dir)
+  POWERLEVEL9K_MODE='awesome-patched'
+  POWERLEVEL9K_DIR_HOME_SUBFOLDER_VISUAL_IDENTIFIER_COLOR='green'
+
+  # Re-Source the icons, as the POWERLEVEL9K_MODE is directly
+  # evaluated there.
+  source functions/icons.zsh
+
+  assertEquals "%K{blue} %F{green%}%f %F{black}%~ %k%F{blue}%f " "$(build_left_prompt)"
+
+  unset POWERLEVEL9K_LEFT_PROMPT_ELEMENTS
+  unset POWERLEVEL9K_MODE
+  unset POWERLEVEL9K_DIR_HOME_SUBFOLDER_VISUAL_IDENTIFIER_COLOR
+}
+
+function testColoringOfVisualIdentifiersDoesNotOverwriteColoringOfSegment() {
+  POWERLEVEL9K_LEFT_PROMPT_ELEMENTS=(dir)
+  POWERLEVEL9K_MODE='awesome-patched'
+  POWERLEVEL9K_DIR_HOME_SUBFOLDER_VISUAL_IDENTIFIER_COLOR='green'
+  POWERLEVEL9K_DIR_HOME_SUBFOLDER_FOREGROUND='red'
+  POWERLEVEL9K_DIR_HOME_SUBFOLDER_BACKGROUND='yellow'
+
+  # Re-Source the icons, as the POWERLEVEL9K_MODE is directly
+  # evaluated there.
+  source functions/icons.zsh
+
+  assertEquals "%K{yellow} %F{green%}%f %F{red}%~ %k%F{yellow}%f " "$(build_left_prompt)"
+
+  unset POWERLEVEL9K_LEFT_PROMPT_ELEMENTS
+  unset POWERLEVEL9K_MODE
+  unset POWERLEVEL9K_DIR_HOME_SUBFOLDER_VISUAL_IDENTIFIER_COLOR
+  unset POWERLEVEL9K_DIR_HOME_SUBFOLDER_FOREGROUND
+  unset POWERLEVEL9K_DIR_HOME_SUBFOLDER_BACKGROUND
+}
+
+function testOverwritingIconsWork() {
+  POWERLEVEL9K_LEFT_PROMPT_ELEMENTS=(dir)
+  POWERLEVEL9K_HOME_SUB_ICON='icon-here'
+
+  assertEquals "%K{blue} %F{black%}icon-here%f %F{black}%~ %k%F{blue}%f " "$(build_left_prompt)"
+
+  unset POWERLEVEL9K_LEFT_PROMPT_ELEMENTS
+  unset POWERLEVEL9K_DIR_HOME_SUB_ICON
+}
+
+source shunit2/source/2.1/src/shunit2
diff --git a/test/segments/dir.spec b/test/segments/dir.spec
new file mode 100755
index 00000000..035addea
--- /dev/null
+++ b/test/segments/dir.spec
@@ -0,0 +1,118 @@
+#!/usr/bin/env zsh
+#vim:ft=zsh ts=2 sw=2 sts=2 et fenc=utf-8
+
+# Required for shunit2 to run correctly
+setopt shwordsplit
+SHUNIT_PARENT=$0
+
+function setUp() {
+  export TERM="xterm-256color"
+  # Load Powerlevel9k
+  source powerlevel9k.zsh-theme
+}
+
+function testTruncateFoldersWorks() {
+  POWERLEVEL9K_LEFT_PROMPT_ELEMENTS=(dir)
+  POWERLEVEL9K_SHORTEN_DIR_LENGTH=2
+  POWERLEVEL9K_SHORTEN_STRATEGY='truncate_folders'
+
+  FOLDER=/tmp/powerlevel9k-test/1/12/123/1234/12345/123456/1234567/12345678/123456789
+  mkdir -p $FOLDER
+  cd $FOLDER
+
+  assertEquals "%K{blue} %F{black}%3(c:…/:)%2c %k%F{blue}%f " "$(build_left_prompt)"
+
+  cd -
+  rm -fr /tmp/powerlevel9k-test
+
+  unset FOLDER
+  unset POWERLEVEL9K_LEFT_PROMPT_ELEMENTS
+  unset POWERLEVEL9K_SHORTEN_DIR_LENGTH
+  unset POWERLEVEL9K_SHORTEN_STRATEGY
+}
+
+function testTruncateMiddleWorks() {
+  POWERLEVEL9K_LEFT_PROMPT_ELEMENTS=(dir)
+  POWERLEVEL9K_SHORTEN_DIR_LENGTH=2
+  POWERLEVEL9K_SHORTEN_STRATEGY='truncate_middle'
+
+  FOLDER=/tmp/powerlevel9k-test/1/12/123/1234/12345/123456/1234567/12345678/123456789
+  mkdir -p $FOLDER
+  cd $FOLDER
+
+  assertEquals "%K{blue} %F{black}/tmp/po…st/1/12/123/1234/12…45/12…56/12…67/12…78/123456789 %k%F{blue}%f " "$(build_left_prompt)"
+
+  cd -
+  rm -fr /tmp/powerlevel9k-test
+
+  unset FOLDER
+  unset POWERLEVEL9K_LEFT_PROMPT_ELEMENTS
+  unset POWERLEVEL9K_SHORTEN_DIR_LENGTH
+  unset POWERLEVEL9K_SHORTEN_STRATEGY
+}
+
+function testTruncationFromRightWorks() {
+  POWERLEVEL9K_LEFT_PROMPT_ELEMENTS=(dir)
+  POWERLEVEL9K_SHORTEN_DIR_LENGTH=2
+  POWERLEVEL9K_SHORTEN_STRATEGY='truncate_from_right'
+
+  FOLDER=/tmp/powerlevel9k-test/1/12/123/1234/12345/123456/1234567/12345678/123456789
+  mkdir -p $FOLDER
+  cd $FOLDER
+
+  assertEquals "%K{blue} %F{black}/tm…/po…/1/12/12…/12…/12…/12…/12…/12…/123456789 %k%F{blue}%f " "$(build_left_prompt)"
+
+  cd -
+  rm -fr /tmp/powerlevel9k-test
+
+  unset FOLDER
+  unset POWERLEVEL9K_LEFT_PROMPT_ELEMENTS
+  unset POWERLEVEL9K_SHORTEN_DIR_LENGTH
+  unset POWERLEVEL9K_SHORTEN_STRATEGY
+}
+
+function testHomeFolderDetectionWorks() {
+  POWERLEVEL9K_LEFT_PROMPT_ELEMENTS=(dir)
+  POWERLEVEL9K_HOME_ICON='home-icon'
+
+  cd ~
+  assertEquals "%K{blue} %F{black%}home-icon%f %F{black}%~ %k%F{blue}%f " "$(build_left_prompt)"
+
+  cd -
+  unset POWERLEVEL9K_LEFT_PROMPT_ELEMENTS
+  unset POWERLEVEL9K_HOME_ICON
+}
+
+function testHomeSubfolderDetectionWorks() {
+  POWERLEVEL9K_LEFT_PROMPT_ELEMENTS=(dir)
+  POWERLEVEL9K_HOME_SUB_ICON='sub-icon'
+
+  FOLDER=~/powerlevel9k-test
+  mkdir $FOLDER
+  cd $FOLDER
+  assertEquals "%K{blue} %F{black%}sub-icon%f %F{black}%~ %k%F{blue}%f " "$(build_left_prompt)"
+
+  cd -
+  rm -fr $FOLDER
+  unset FOLDER
+  unset POWERLEVEL9K_LEFT_PROMPT_ELEMENTS
+  unset POWERLEVEL9K_HOME_SUB_ICON
+}
+
+function testOtherFolderDetectionWorks() {
+  POWERLEVEL9K_LEFT_PROMPT_ELEMENTS=(dir)
+  POWERLEVEL9K_FOLDER_ICON='folder-icon'
+
+  FOLDER=/tmp/powerlevel9k-test
+  mkdir $FOLDER
+  cd $FOLDER
+  assertEquals "%K{blue} %F{black%}folder-icon%f %F{black}%~ %k%F{blue}%f " "$(build_left_prompt)"
+
+  cd -
+  rm -fr $FOLDER
+  unset FOLDER
+  unset POWERLEVEL9K_LEFT_PROMPT_ELEMENTS
+  unset POWERLEVEL9K_FOLDER_ICON
+}
+
+source shunit2/source/2.1/src/shunit2
diff --git a/test/segments/go_version.spec b/test/segments/go_version.spec
new file mode 100755
index 00000000..aa9f625d
--- /dev/null
+++ b/test/segments/go_version.spec
@@ -0,0 +1,40 @@
+#!/usr/bin/env zsh
+#vim:ft=zsh ts=2 sw=2 sts=2 et fenc=utf-8
+
+# Required for shunit2 to run correctly
+setopt shwordsplit
+SHUNIT_PARENT=$0
+
+function setUp() {
+  export TERM="xterm-256color"
+  # Load Powerlevel9k
+  source powerlevel9k.zsh-theme
+}
+
+function mockGo() {
+  echo 'go version go1.5.3 darwin/amd64'
+}
+
+function testGo() {
+  alias go=mockGo
+  POWERLEVEL9K_LEFT_PROMPT_ELEMENTS=(go_version)
+
+  assertEquals "%K{green} %F{255}go1.5.3 %k%F{green}%f " "$(build_left_prompt)"
+
+  unset POWERLEVEL9K_LEFT_PROMPT_ELEMENTS
+  unalias go
+}
+
+function testGoSegmentPrintsNothingIfGoIsNotAvailable() {
+  alias go=noGo
+  POWERLEVEL9K_CUSTOM_WORLD='echo world'
+  POWERLEVEL9K_LEFT_PROMPT_ELEMENTS=(custom_world go_version)
+
+  assertEquals "%K{white} %F{black}world %k%F{white}%f " "$(build_left_prompt)"
+
+  unset POWERLEVEL9K_LEFT_PROMPT_ELEMENTS
+  unset POWERLEVEL9K_CUSTOM_WORLD
+  unalias go
+}
+
+source shunit2/source/2.1/src/shunit2
diff --git a/test/segments/rust_version.spec b/test/segments/rust_version.spec
new file mode 100755
index 00000000..49b06bcf
--- /dev/null
+++ b/test/segments/rust_version.spec
@@ -0,0 +1,40 @@
+#!/usr/bin/env zsh
+#vim:ft=zsh ts=2 sw=2 sts=2 et fenc=utf-8
+
+# Required for shunit2 to run correctly
+setopt shwordsplit
+SHUNIT_PARENT=$0
+
+function setUp() {
+  export TERM="xterm-256color"
+  # Load Powerlevel9k
+  source powerlevel9k.zsh-theme
+}
+
+function mockRust() {
+  echo 'rustc  0.4.1a-alpha'
+}
+
+function testRust() {
+  alias rustc=mockRust
+  POWERLEVEL9K_LEFT_PROMPT_ELEMENTS=(rust_version)
+
+  assertEquals "%K{208} %F{black}Rust 0.4.1a-alpha %k%F{208}%f " "$(build_left_prompt)"
+
+  unset POWERLEVEL9K_LEFT_PROMPT_ELEMENTS
+  unalias rustc
+}
+
+function testRustPrintsNothingIfRustIsNotAvailable() {
+  alias rustc=noRust
+  POWERLEVEL9K_CUSTOM_WORLD='echo world'
+  POWERLEVEL9K_LEFT_PROMPT_ELEMENTS=(custom_world rust_version)
+
+  assertEquals "%K{white} %F{black}world %k%F{white}%f " "$(build_left_prompt)"
+
+  unset POWERLEVEL9K_LEFT_PROMPT_ELEMENTS
+  unset POWERLEVEL9K_CUSTOM_WORLD
+  unalias rustc
+}
+
+source shunit2/source/2.1/src/shunit2