Add tests for battery segment

Additionally - Add a fourth parameter to prompt_battery for better testability. This parameter is the root prefix, so we can use our own test batteries.
7 years ago · 802af322ff
parent 74a3d2d6e2
commit 802af322ff
2 changed files with 190 additions and 5 deletions
--- a/powerlevel9k.zsh-theme
+++ b/powerlevel9k.zsh-theme
@ -409,12 +409,13 @@ prompt_battery() {
    'charged'       'green'
    'disconnected'  "$DEFAULT_COLOR_INVERTED"
  )
+  local ROOT_PREFIX="${4}"
  # Set default values if the user did not configure them
  set_default POWERLEVEL9K_BATTERY_LOW_THRESHOLD  10

-  if [[ $OS =~ OSX && -f /usr/bin/pmset && -x /usr/bin/pmset ]]; then
+  if [[ $OS =~ OSX && -f "${ROOT_PREFIX}"/usr/bin/pmset && -x "${ROOT_PREFIX}"/usr/bin/pmset ]]; then
    # obtain battery information from system
-    local raw_data="$(pmset -g batt | awk 'FNR==2{print}')"
+    local raw_data="$(${ROOT_PREFIX}/usr/bin/pmset -g batt | awk 'FNR==2{print}')"
    # return if there is no battery on system
    [[ -z $(echo $raw_data | grep "InternalBattery") ]] && return

@ -446,7 +447,7 @@ prompt_battery() {
  fi

  if [[ "$OS" == 'Linux' ]] || [[ "$OS" == 'Android' ]]; then
-    local sysp="/sys/class/power_supply"
+    local sysp="${ROOT_PREFIX}/sys/class/power_supply"

    # Reported BAT0 or BAT1 depending on kernel version
    [[ -a $sysp/BAT0 ]] && local bat=$sysp/BAT0
@ -468,8 +469,8 @@ prompt_battery() {
      [[ $bat_percent =~ 100 ]] && current_state="charged"
      [[ $bat_percent -lt 100 ]] && current_state="charging"
    fi
-    if [[ -f /usr/bin/acpi ]]; then
-      local time_remaining=$(acpi | awk '{ print $5 }')
+    if [[ -f ${ROOT_PREFIX}/usr/bin/acpi ]]; then
+      local time_remaining=$(${ROOT_PREFIX}/usr/bin/acpi | awk '{ print $5 }')
      if [[ $time_remaining =~ rate ]]; then
        local tstring="..."
      elif [[ $time_remaining =~ "[[:digit:]]+" ]]; then
--- a/test/segments/battery.spec
+++ b/test/segments/battery.spec
@ -0,0 +1,184 @@
+#!/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
+
+  P9K_HOME=$(pwd)
+  ### Test specific
+  # Create default folder
+  FOLDER=/tmp/powerlevel9k-test
+  mkdir -p "${FOLDER}"
+  cd $FOLDER
+
+  # Prepare folder for pmset (OSX)
+  PMSET_PATH=$FOLDER/usr/bin
+  mkdir -p $PMSET_PATH
+  # Prepare folder for $BATTERY (Linux)
+  BATTERY_PATH=$FOLDER/sys/class/power_supply
+  mkdir -p $BATTERY_PATH
+  mkdir -p $BATTERY_PATH/BAT0
+  mkdir -p $BATTERY_PATH/BAT1
+}
+
+function tearDown() {
+  # Go back to powerlevel9k folder
+  cd "${P9K_HOME}"
+  # Remove eventually created test-specific folder
+  rm -fr "${FOLDER}" &>/dev/null
+  # At least remove test folder completely
+  rm -fr /tmp/powerlevel9k-test &>/dev/null
+  unset PMSET_PATH
+  unset BATTERY_PATH
+  unset FOLDER
+}
+
+# Mock Battery
+# For mocking pmset on OSX this function takes one argument (the
+# content that pmset should echo).
+# For mocking the battery on Linux this function takes two
+# arguments: $1 is the capacity; $2 the battery status.
+function makeBatterySay() {
+  if [[ -z "${FOLDER}" ]]; then
+    echo "Fake root path is not correctly set!"
+    exit 1
+  fi
+  # OSX
+  echo "#!/bin/sh" > $PMSET_PATH/pmset
+  echo "echo \"$1\"" >> $PMSET_PATH/pmset
+  chmod +x $PMSET_PATH/pmset
+
+  # Linux
+  local capacity="$1"
+  echo "$capacity" > $BATTERY_PATH/BAT0/capacity
+  echo "$capacity" > $BATTERY_PATH/BAT1/capacity
+  local battery_status="$2"
+  echo "$battery_status" > $BATTERY_PATH/BAT0/status
+  echo "$battery_status" > $BATTERY_PATH/BAT1/status
+}
+
+function testBatterySegmentIfBatteryIsLowWhileDischargingOnOSX() {
+  local OS='OSX' # Fake OSX
+  local POWERLEVEL9K_LEFT_PROMPT_ELEMENTS=(battery)
+  makeBatterySay "Now drawing from 'Battery Power'
+ -InternalBattery-0 (id=1234567)	4%; discharging; 0:05 remaining present: true"
+
+  assertEquals "%K{black} %F{red%}🔋 %f%F{red}4%% (0:05) " "$(prompt_battery left 1 false ${FOLDER})"
+}
+
+function testBatterySegmentIfBatteryIsLowWhileChargingOnOSX() {
+  local OS='OSX' # Fake OSX
+  local POWERLEVEL9K_LEFT_PROMPT_ELEMENTS=(battery)
+  makeBatterySay "Now drawing from 'Battery Power'
+ -InternalBattery-0 (id=1234567)	4%; charging; 0:05 remaining present: true"
+
+  assertEquals "%K{black} %F{yellow%}🔋 %f%F{yellow}4%% (0:05) " "$(prompt_battery left 1 false ${FOLDER})"
+}
+
+function testBatterySegmentIfBatteryIsAlmostFullWhileDischargingOnOSX() {
+  local OS='OSX' # Fake OSX
+  local POWERLEVEL9K_LEFT_PROMPT_ELEMENTS=(battery)
+  makeBatterySay "Now drawing from 'Battery Power'
+ -InternalBattery-0 (id=1234567)	98%; discharging; 3:57 remaining present: true"
+
+  assertEquals "%K{black} %F{white%}🔋 %f%F{white}98%% (3:57) " "$(prompt_battery left 1 false ${FOLDER})"
+}
+
+function testBatterySegmentIfBatteryIsAlmostFullWhileChargingOnOSX() {
+  local OS='OSX' # Fake OSX
+  local POWERLEVEL9K_LEFT_PROMPT_ELEMENTS=(battery)
+  makeBatterySay "Now drawing from 'Battery Power'
+ -InternalBattery-0 (id=1234567)	98%; charging; 3:57 remaining present: true"
+
+  assertEquals "%K{black} %F{yellow%}🔋 %f%F{yellow}98%% (3:57) " "$(prompt_battery left 1 false ${FOLDER})"
+}
+
+function testBatterySegmentIfBatteryIsFullOnOSX() {
+  local OS='OSX' # Fake OSX
+  makeBatterySay "Now drawing from 'AC Power'
+ -InternalBattery-0 (id=1234567)	99%; charged; 0:00 remaining present: true"
+
+  assertEquals "%K{black} %F{green%}🔋 %f%F{green}99%% " "$(prompt_battery left 1 false ${FOLDER})"
+}
+
+function testBatterySegmentIfBatteryIsCalculatingOnOSX() {
+  local OS='OSX' # Fake OSX
+  local POWERLEVEL9K_LEFT_PROMPT_ELEMENTS=(battery)
+  makeBatterySay "Now drawing from 'Battery Power'
+ -InternalBattery-0 (id=1234567)	99%; discharging; (no estimate) present: true"
+
+  assertEquals "%K{black} %F{white%}🔋 %f%F{white}99%% (...) " "$(prompt_battery left 1 false ${FOLDER})"
+}
+
+function testBatterySegmentIfBatteryIsLowWhileDischargingOnLinux() {
+  local OS='Linux' # Fake Linux
+  local POWERLEVEL9K_LEFT_PROMPT_ELEMENTS=(battery)
+  makeBatterySay "4" "Discharging"
+
+  assertEquals "%K{black} %F{red%}🔋 %f%F{red}4%% " "$(prompt_battery left 1 false ${FOLDER})"
+}
+
+function testBatterySegmentIfBatteryIsLowWhileChargingOnLinux() {
+  local OS='Linux' # Fake Linux
+  local POWERLEVEL9K_LEFT_PROMPT_ELEMENTS=(battery)
+  makeBatterySay "4" "Charging"
+
+  assertEquals "%K{black} %F{yellow%}🔋 %f%F{yellow}4%% " "$(prompt_battery left 1 false ${FOLDER})"
+}
+
+function testBatterySegmentIfBatteryIsNormalWhileDischargingOnLinux() {
+  local OS='Linux' # Fake Linux
+  local POWERLEVEL9K_LEFT_PROMPT_ELEMENTS=(battery)
+  makeBatterySay "10" "Discharging"
+
+  assertEquals "%K{black} %F{white%}🔋 %f%F{white}10%% " "$(prompt_battery left 1 false ${FOLDER})"
+}
+
+function testBatterySegmentIfBatteryIsNormalWhileChargingOnLinux() {
+  local OS='Linux' # Fake Linux
+  local POWERLEVEL9K_LEFT_PROMPT_ELEMENTS=(battery)
+  makeBatterySay "10" "Charging"
+
+  assertEquals "%K{black} %F{yellow%}🔋 %f%F{yellow}10%% " "$(prompt_battery left 1 false ${FOLDER})"
+}
+
+function testBatterySegmentIfBatteryIsFullOnLinux() {
+  local OS='Linux' # Fake Linux
+  local POWERLEVEL9K_LEFT_PROMPT_ELEMENTS=(battery)
+  makeBatterySay "100" "Full"
+
+  assertEquals "%K{black} %F{green%}🔋 %f%F{green}100%% " "$(prompt_battery left 1 false ${FOLDER})"
+}
+
+function testBatterySegmentIfBatteryIsNormalWithAcpiEnabledOnLinux() {
+  local OS='Linux' # Fake Linux
+  local POWERLEVEL9K_LEFT_PROMPT_ELEMENTS=(battery)
+  makeBatterySay "50" "Discharging"
+  echo "echo 'Batter 0: Discharging, 50%, 01:38:54 remaining'" > ${FOLDER}/usr/bin/acpi
+  chmod +x ${FOLDER}/usr/bin/acpi
+  # For running on Mac, we need to mock date :(
+  [[ -f /usr/local/bin/gdate ]] && alias date=gdate
+
+  assertEquals "%K{black} %F{white%}🔋 %f%F{white}50%% (1:38) " "$(prompt_battery left 1 false ${FOLDER})"
+
+  unalias date &>/dev/null
+}
+
+function testBatterySegmentIfBatteryIsCalculatingWithAcpiEnabledOnLinux() {
+  local OS='Linux' # Fake Linux
+  local POWERLEVEL9K_LEFT_PROMPT_ELEMENTS=(battery)
+  makeBatterySay "50" "Discharging"
+  # Todo: Include real acpi output!
+  echo "echo 'Batter 0: Discharging, 50%, rate remaining'" > ${FOLDER}/usr/bin/acpi
+  chmod +x ${FOLDER}/usr/bin/acpi
+
+  assertEquals "%K{black} %F{white%}🔋 %f%F{white}50%% (...) " "$(prompt_battery left 1 false ${FOLDER})"
+}
+
+source shunit2/source/2.1/src/shunit2