Moving getting_started folder to a dedicated project.

The getting_started directory formerly stored in the bash_unit
repository now gets its own repo:
https://github.com/bash-unit/getting_started

Author: pgrange

README.md

@@ -0,0 +1,10 @@
+This getting started project gives you a few example of tests you may write
+with [bash_unit](https://github.com/bash-unit/bash_unit/).
+
+You can play with these tests by, first, [installing bash_unit](https://github.com/bash-unit/bash_unit/blob/main/README.adoc#how-to-install-bash_unit) and then git clone this project and run the tests:
+
+```bash
+git clone https://github.com/bash-unit/getting_started.git
+cd getting_started
+bash_unit tests/test_*
+```

bonjour_monde

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+
+echo "Bonjour monde !"

hello_i18n

@@ -0,0 +1,22 @@
+#!/usr/bin/env bash
+
+main() {
+  hello "$1"
+}
+
+hello() {
+  case "$1" in
+    fr) echo Bonjour le monde
+      ;;
+    *) echo we only speak french for the moment, sorry >&2
+      ;;
+  esac
+}
+
+# do not run main when sourcing the script
+if [[ "$0" == "${BASH_SOURCE[0]}" ]]
+then
+  main "$@"
+else
+  true
+fi

hello_timed

@@ -0,0 +1,17 @@
+#!/usr/bin/env bash
+
+declare -F current_hour >/dev/null || current_hour() {
+  date +%H
+}
+
+if (( "$(current_hour)" < 11 ))
+then
+  echo "Good morning World!"
+else
+  if (( "$(current_hour)" > 17 ))
+  then
+    echo "Good evening World!"
+  else
+    echo "Hello World!"
+  fi
+fi

hello_world

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+
+echo "Hello world!"

hola_mundo

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+
+echo "No ablo espanol" >&2
+exit 1

tests/test_bonjour_monde

@@ -0,0 +1,3 @@
+test_should_print_bonjour_monde() {
+  assert_equals "Bonjour monde !" "$(../bonjour_monde)"
+}

tests/test_hello_i18n

@@ -0,0 +1,18 @@
+# In this example, we want to test the specific functions of a script.
+# So we source this script in setup_suite.
+# However, we don't want the script to be executed when sourcing it,
+# we are only interested in having access to the functions to test
+# them.
+# To do so, we adapt the script under test so that its main code
+# is not executed when sourcing it.
+# See in ../hello_i18n how we define a main function to encapsulate
+# all the main code and the main function is only called when the
+# script itself is launched, not when it is sourced.
+
+test_can_say_hi_in_french() {
+  assert_equals "Bonjour le monde" "$(hello fr)"
+}
+
+setup_suite() {
+  source ../hello_i18n
+}

tests/test_hello_timed

@@ -0,0 +1,34 @@
+# In this example, we want to test a script which depends on
+# the external world (here, the current time). To do so,
+# we decide to adapt the script by extracting the time
+# querying in a dedicated function named current_hour.
+# That way, we can fake the current hour in the test.
+# Unfortunately, we also need to adapt the script under
+# test so that, when the current_time function is already
+# defined, the script does not override this definition.
+# Otherwise, the fake created in the test would never be
+# used.
+# See ../hello_timed
+
+
+test_can_say_good_morning() {
+  it_is_o_clock 10
+  assert_equals "Good morning World!" "$(../hello_timed)"
+}
+
+test_can_say_good_evening() {
+  it_is_o_clock 18
+  assert_equals "Good evening World!" "$(../hello_timed)"
+}
+
+test_can_say_hello() {
+  it_is_o_clock 12
+  assert_equals "Hello World!" "$(../hello_timed)"
+}
+
+it_is_o_clock() {
+  local hour="$1"
+  fake current_hour << EOF
+$hour
+EOF
+}

tests/test_hello_world

@@ -0,0 +1,3 @@
+test_should_print_hello_world() {
+  assert_equals "Hello world!" "$(../hello_world)"
+}

tests/test_no_ablo_espanol

@@ -0,0 +1,7 @@
+test_no_ablo_espanol() {
+  assert_fail ../hola_mundo
+}
+
+test_should_tell_no_ablo_espanol() {
+  assert_equals "No ablo espanol" "$(../hola_mundo 2>&1)"
+}

tests/test_skipping

@@ -0,0 +1,27 @@
+# This test demonstrates some test skipping logic that
+# one can implement with bash_unit
+
+todo_will_always_be_skipped() {
+  fail "This test is always skipped"
+}
+
+skip_if "uname | grep Darwin" linux
+skip_if "uname | grep Linux" darwin
+
+test_linux_proc_exists() {
+  assert "ls /proc/" "there should exist /proc on Linux"
+}
+test_another_test_to_run_only_on_linux() {
+  assert "mkdir /tmp/foo/bar -p"
+}
+
+test_that_always_run() {
+  assert true
+}
+
+test_darwin_proc_does_not_exist() {
+  assert_fail "ls /proc/" "there should not exist /proc on Darwin"
+}
+test_another_test_to_run_only_on_darwin() {
+  assert "mkdir -p /tmp/foo/bar"
+}