spiegel-keyman/resources/build/test/zip.inc.tests.sh

#!/usr/bin/env bash
# Unit tests for zip.inc.sh

## START STANDARD BUILD SCRIPT INCLUDE
# adjust relative paths as necessary
THIS_SCRIPT="$(readlink -f "${BASH_SOURCE[0]}")"
. "${THIS_SCRIPT%/*}/../../../resources/build/builder-basic.inc.sh"
# END STANDARD BUILD SCRIPT INCLUDE

# shellcheck disable=2154
. "${KEYMAN_ROOT}/resources/build/zip.inc.sh"
. "${KEYMAN_ROOT}/resources/build/test/testing-framework.inc.sh"

# Mock command -v to simulate presence/absence of zip
function command() {
  if [[ "$1" == "-v" && "$2" == "zip" ]]; then
    if [[ "${MOCK_ZIP_PRESENT:-1}" == "1" ]]; then
      echo "/usr/bin/zip"
      return 0
    else
      return 1
    fi
  fi
  builtin command "$@"
}

# Helper to reset log and env
function reset_zip_test_env() {
  unset SEVENZ
  unset SEVENZ_HOME
  unset GO_FAST
  MOCK_ZIP_PRESENT=1
  export OSTYPE="linux"
}

function mock_zip() {
  ZIP_CMD_LOG="zip $*"
  return 0
}
function mock_7z() {
  ZIP_CMD_LOG="7z $*"
  return 0
}

function setup() {
  reset_zip_test_env
  ZIP_CMD_LOG=""
  LOG_MSG=""

  # Mock zip and 7z commands to capture invocation
  create_mock zip mock_zip
  create_mock 7z mock_7z

  # Mock /custom/sevenz/7z.exe for Windows test
  function /custom/sevenz/7z.exe() {
    # shellcheck disable=SC2317
    ZIP_CMD_LOG="/custom/sevenz/7z.exe $*"
  }
}

function teardown() {
  unmock zip
  unmock 7z
  unset /custom/sevenz/7z.exe
  reset_zip_test_env
}

function test__add_zip_files__with_zip_basic() {
  # Setup
  MOCK_ZIP_PRESENT=1

  # Execute
  add_zip_files "archive.zip" file1.txt file2.txt

  # Verify
  assert-equal "${ZIP_CMD_LOG}" "zip archive.zip file1.txt file2.txt" "add_zip_files zip basic invocation"
}

function test__add_zip_files__with_zip_flags() {
  # Setup
  MOCK_ZIP_PRESENT=1

  # Execute
  add_zip_files "archive.zip" -r -q -9 file1.txt

  # Verify
  # -q and -9 are passed to zip, not 7z
  assert-equal "${ZIP_CMD_LOG}" "zip -r -q -9 archive.zip file1.txt" "add_zip_files zip with flags"
}

function test__add_zip_files__with_zip_exclude_flag() {
  # Setup
  MOCK_ZIP_PRESENT=1

  # Execute
  add_zip_files "archive.zip" -x@exclude.lst file1.txt

  # Verify
  assert-equal "${ZIP_CMD_LOG}" "zip -x@exclude.lst archive.zip file1.txt" "add_zip_files zip with exclude flag"
}

function test__add_zip_files__with_zip_fast() {
  # Setup
  MOCK_ZIP_PRESENT=1
  GO_FAST=1

  # Execute
  add_zip_files "archive.zip" file1.txt file2.txt

  # Verify
  assert-equal "${ZIP_CMD_LOG}" "zip -1 archive.zip file1.txt file2.txt" "add_zip_files zip GO_FAST"
}

function test__add_zip_files__with_7z_basic() {
  # Setup
  MOCK_ZIP_PRESENT=0

  # Execute
  add_zip_files "archive.7z" file1.txt file2.txt

  # Verify
  assert-equal "${ZIP_CMD_LOG}" "7z a archive.7z file1.txt file2.txt" "add_zip_files 7z basic invocation"
}

function test__add_zip_files__with_7z_flags() {
  # Setup
  MOCK_ZIP_PRESENT=0

  # Execute
  add_zip_files "archive.7z" -r -q -5 file1.txt

  # Verify
  # -r is passed, -q becomes -bd -bb0, -5 becomes -mx5
  assert-equal "${ZIP_CMD_LOG}" "7z a -r -bd -bb0 -mx5 archive.7z file1.txt" "add_zip_files 7z with flags"
}

function test__add_zip_files__with_7z_exclude_flag() {
  # Setup
  MOCK_ZIP_PRESENT=0

  # Execute
  add_zip_files "archive.7z" -x@exclude.lst file1.txt

  # Verify
  assert-equal "${ZIP_CMD_LOG}" "7z a -x@exclude.lst archive.7z file1.txt" "add_zip_files 7z with exclude flag"
}

function test__add_zip_files__with_7z_on_windows() {
  # Setup
  MOCK_ZIP_PRESENT=0
  export OSTYPE="msys"
  export SEVENZ_HOME="/custom/sevenz"

  # Execute
  add_zip_files "archive.7z" file1.txt

  # Verify
  assert-equal "${ZIP_CMD_LOG}" "/custom/sevenz/7z.exe a archive.7z file1.txt" "add_zip_files 7z on windows"
}

function test_add_zip_files_with_7z_fast() {
  # Setup
  MOCK_ZIP_PRESENT=0
  GO_FAST=0

  # Execute
  add_zip_files "archive.zip" file1.txt file2.txt

  # Verify
  assert-equal "${ZIP_CMD_LOG}" "7z a -mx9 archive.zip file1.txt file2.txt" "add_zip_files 7z GO_FAST"
}

function _create_files() {
  local FILEDIR="$1"
  mkdir -p "${FILEDIR}/a/b/c"
  touch "${FILEDIR}/file1.sh"
  touch "${FILEDIR}/file2.sh"
  touch "${FILEDIR}/build.sh"
  touch "${FILEDIR}/a/file3.sh"
  touch "${FILEDIR}/a/build.sh"
  touch "${FILEDIR}/a/b/file4.sh"
  touch "${FILEDIR}/a/b/build.sh"
  touch "${FILEDIR}/a/b/c/file5.sh"

  EXPECTED_CONTENT=".
./a
./a/b
./a/b/c
./a/b/c/file5.sh
./a/b/file4.sh
./a/file3.sh
./file1.sh
./file2.sh"
}

function test__add_zip_files__with_zip_real() {
  if ! builtin command -v zip >/dev/null 2>&1; then
    builder_echo warning "    IGNORE: add_zip_files zip with real data - requires zip installed"
    return 0
  fi

  # Setup
  MOCK_ZIP_PRESENT=1
  unmock zip

  ARCHIVE=$(mktemp -u --suffix=.zip)
  FILEDIR=$(mktemp -d)
  _create_files "${FILEDIR}"

  # Execute
  (
    # shellcheck disable=2164
    cd "${FILEDIR}"
    add_zip_files "${ARCHIVE}" -r -q -xr!build.sh file1.sh file2.sh a/ > /dev/null
  )

  # Verify
  NEWDIR=$(mktemp -d)
  (
    # shellcheck disable=2164
    cd "${NEWDIR}"
    unzip "${ARCHIVE}" > /dev/null
    ARCHIVE_CONTENT=$(find . | sort)
    assert-equal "${ARCHIVE_CONTENT}" "${EXPECTED_CONTENT}" "add_zip_files zip with real data" --quiet
  )

  rm -rf "${FILEDIR}"
  rm -rf "${NEWDIR}"
  rm -f "${ARCHIVE}"
}

function test__add_zip_files__with_7z_real() {
  if ! builtin command -v 7z >/dev/null 2>&1; then
    builder_echo warning "    IGNORE: add_zip_files 7z with real data - requires 7z installed"
    return 0
  fi

  # Setup
  MOCK_ZIP_PRESENT=0
  unmock 7z

  ARCHIVE=$(mktemp -u --suffix=.zip)
  FILEDIR=$(mktemp -d)
  _create_files "${FILEDIR}"

  # Execute
  (
    # shellcheck disable=2164
    cd "${FILEDIR}"
    add_zip_files "${ARCHIVE}" -r -q -xr!build.sh file1.sh file2.sh a/ > /dev/null
  )

  # Verify
  NEWDIR=$(mktemp -d)
  (
    # shellcheck disable=2164
    cd "${NEWDIR}"
    7z x "${ARCHIVE}" > /dev/null
    ARCHIVE_CONTENT=$(find . | sort)
    assert-equal "${ARCHIVE_CONTENT}" "${EXPECTED_CONTENT}" "add_zip_files 7z with real data" --quiet
  )

  rm -rf "${FILEDIR}"
  rm -rf "${NEWDIR}"
  rm -f "${ARCHIVE}"
}

# shellcheck disable=SC2120
function mock_builder_die() {
  LOG_MSG+="DIE: $*"
}

function test__add_zip_files__flags_before_zipfile() {
  # Setup
  MOCK_ZIP_PRESENT=0
  create_mock  builder_die  mock_builder_die

  # Execute
  add_zip_files -r -q "/tmp/archive.zip" file1.txt a/file2.txt

  # Verify
  unmock builder_die
  assert-not-contains "${LOG_MSG}" "DIE"
  assert-equal "${ZIP_CMD_LOG}" "7z a -r -bd -bb0 /tmp/archive.zip file1.txt a/file2.txt"
}

function test__add_zip_files__flags_between_files() {
  # Setup
  MOCK_ZIP_PRESENT=0
  create_mock  builder_die  mock_builder_die

  # Execute
  add_zip_files "/tmp/archive.zip" -q file1.txt -r a/file2.txt

  # Verify
  unmock builder_die
  assert-not-contains "${LOG_MSG}" "DIE"
  assert-equal "${ZIP_CMD_LOG}" "7z a -bd -bb0 -r /tmp/archive.zip file1.txt a/file2.txt"
}

function test__add_zip_files__flags_at_end() {
  # Setup
  MOCK_ZIP_PRESENT=0
  create_mock  builder_die  mock_builder_die

  # Execute
  add_zip_files "/tmp/archive.zip" file1.txt a/file2.txt -r -q

  # Verify
  unmock builder_die
  assert-not-contains "${LOG_MSG}" "DIE"
  assert-equal "${ZIP_CMD_LOG}" "7z a -r -bd -bb0 /tmp/archive.zip file1.txt a/file2.txt"
}

function test__add_zip_files__die_if_relative_path() {
  # Setup
  MOCK_ZIP_PRESENT=1
  create_mock  builder_die  mock_builder_die

  # Execute
  add_zip_files "/tmp/archive.zip" file1.txt ../file2.txt

  # Verify
  unmock builder_die
  assert-equal "${LOG_MSG}" "DIE: File ../file2.txt is not in the current directory"  "add_zip_files with relative path"
}

function test__add_zip_files__die_if_absolute_path() {
  # Setup
  MOCK_ZIP_PRESENT=1
  create_mock  builder_die  mock_builder_die

  # Execute
  add_zip_files "/tmp/archive.zip" file1.txt /file2.txt

  # Verify
  unmock builder_die

  assert-equal "${LOG_MSG}" "DIE: File /file2.txt is not in the current directory" "add_zip_files with absolute path"
}

# shellcheck disable=SC2119
run_tests