run-test.sh

#!/usr/bin/env sh
echo '============================================================================='
echo '  Simple Test Script for sqlite3 command'
echo '============================================================================='
#  This script executes basic commands to test if the sqlite3 command works
#  correctly. Feel free to PR any additional tests you would like to add.
#
#  Note: This script must be POSIX compatible since the image does not contain
#        shells such as bash or zsh. Use `shellcheck` to check for any issues.

# Check if sqlite3 is installed
which sqlite3 >/dev/null || {
  echo 'sqlite3 command not found.' >&2
  exit 1
}

# Print the current version of sqlite3
echo 'SQLite3 version:' "$(sqlite3 --version)"

# Path to the test database
name_file_db='test.db'
path_dir_tmp=$(dirname "$(mktemp -u)")
path_file_db="${path_dir_tmp}/${name_file_db}"

# Remove the existing test database
rm -f "$path_file_db"

# -----------------------------------------------------------------------------
#  Test Functions
# -----------------------------------------------------------------------------

# AssertContains retuns true if the 1st argument is a substring of the 2nd argument.
AssertContains() {
  _tmp_s="$1"
  _tmp_contains="$2"

  if ! echo "$_tmp_s" | grep "$_tmp_contains" >/dev/null; then
    echo "'${_tmp_s}' does not contain '${_tmp_contains}'" >&2
    return 1
  else
    return 0
  fi
}

# AssertEqual returns true if two arguments are equal.
AssertEqual() {
  _tmp_expect="$1"
  _tmp_actual="$2"

  if "$_tmp_expect" != "$_tmp_actual"; then
    echo "Expect: ${_tmp_expect}" >&2
    echo "Actual: ${_tmp_actual}" >&2
    return 1
  else
    return 0
  fi
}

# RunQuery runs the sqlite3 command with the given arguments.
RunQuery() {
  echo "$1" | sqlite3 "$path_file_db"
}

# TestContains tests if the results contains the given substring.
TestContains() {
  _testc_title="$1"    # The title of the test
  _testc_query="$2"    # The query to run
  _testc_contains="$3" # The substring to look for

  printf "  %s ... " "$_testc_title"

  # Run query
  output=$(RunQuery "$_testc_query")

  # Assertion
  msgError=$(AssertContains "$output" "$_testc_contains" 2>&1) || {
    echo 'NG'
    echo "  Query runned: ${_testc_query}"
    echo "  Error Msg: ${msgError}"
    return 1
  }

  echo 'OK'
  return 0
}

# TestEquals tests if the results is equal to the given string.
TestEquals() {
  _teste_title="$1"    # The title of the test
  _teste_query="$2"    # The query to run
  _teste_expect="$3" # The substring to look for

  printf "  %s ... " "$_teste_title"

  # Run query
  actual=$(RunQuery "$_teste_query")

  # Assertion
  msgError=$(AssertEqual "$_teste_expect" "$actual" 2>&1) || {
    echo 'NG'
    echo "  Query runned: ${_teste_query}"
    echo "  Error Msg: ${msgError}"
    return 1
  }

  echo 'OK'
  return 0
}

# -----------------------------------------------------------------------------
#  Create Test DB
# -----------------------------------------------------------------------------
#  Example from "Getting Started" @ https://sqlite.org/cli.html
printf "%s ... " '- Creating test DB'

sqlite3 "$path_file_db" <<'HEREDOC'
  create table tbl1(one text, two int);
  insert into tbl1 values('hello!',10);
  insert into tbl1 values('goodbye', 20);
HEREDOC

result=$?
if ! [ $result -eq 0 ]; then
  exit 1
fi
echo 'created'

# Print created table information
sqlite3 "$path_file_db" <<'HEREDOC'
.header on
.mode column
  select rowid, * from tbl1;
HEREDOC

# -----------------------------------------------------------------------------
#  Tests
# -----------------------------------------------------------------------------
echo '- Testing ...'
isFailed=0

{
  title='1st row value'
  query='SELECT one FROM tbl1 WHERE rowid=1;'
  expect='hello!'

  TestEquals "$title" "$query" "$expect" || {
    isFailed=1
  }
}

{
  title='2nd row value'
  query='SELECT * FROM tbl1;'
  contains='goodbye|20'

  TestContains "$title" "$query" "$contains" || {
    isFailed=1
  }
}

# -----------------------------------------------------------------------------
#  Print Test Result
# -----------------------------------------------------------------------------
echo

echo '- Test result:'
if [ "$isFailed" -eq 0 ]; then
  echo 'success'
else
  echo 'failure'
fi

# Clean Up
rm -f "$path_file_db"

exit $isFailed