Merge pull request #4025 from jandubois/bats-basics

Add foundational BATS tests for `limactl yq` and `limactl list`

Author: AkihiroSuda

hack/bats/helpers/limactl.bash

@@ -0,0 +1,16 @@
+# SPDX-FileCopyrightText: Copyright The Lima Authors
+# SPDX-License-Identifier: Apache-2.0
+
+# Create a dummy Lima instance for testing purposes. It cannot be started because it doesn't have an actual image.
+# This function intentionally doesn't use create/editflags, but modifies the template with yq instead.
+create_dummy_instance() {
+    local name=$1
+    local expr=$2
+
+    # Template does not validate without an image, and the image must point to a file that exists (for clonefile).
+    local template="{images: [location: /etc/profile]}"
+    if [[ -n $expr ]]; then
+        template="$(limactl yq "$expr" <<<"$template")"
+    fi
+    limactl create --name "$name" - <<<"$template"
+}

hack/bats/helpers/load.bash

@@ -1,3 +1,6 @@
+# SPDX-FileCopyrightText: Copyright The Lima Authors
+# SPDX-License-Identifier: Apache-2.0
+
 set -o errexit -o nounset -o pipefail
 
 # Don't run the tests in ~/.lima because they may destroy _config, _templates etc.
@@ -17,8 +20,15 @@ source "$PATH_BATS_ROOT/lib/bats-support/load.bash"
 source "$PATH_BATS_ROOT/lib/bats-assert/load.bash"
 source "$PATH_BATS_ROOT/lib/bats-file/load.bash"
 
+source "$PATH_BATS_HELPERS/limactl.bash"
+source "$PATH_BATS_HELPERS/logs.bash"
+
 bats_require_minimum_version 1.5.0
 
+run_e() {
+    run --separate-stderr "$@"
+}
+
 # If called from foo() this function will call local_foo() if it exist.
 call_local_function() {
     local func
@@ -45,4 +55,10 @@ setup() {
 }
 teardown() {
     call_local_function
-}
+}
+
+assert_output_lines_count() {
+    assert_equal "${#lines[@]}" "$1"
+}
+
+

hack/bats/helpers/logs.bash

@@ -0,0 +1,30 @@
+# SPDX-FileCopyrightText: Copyright The Lima Authors
+# SPDX-License-Identifier: Apache-2.0
+
+# Format the string the way strconv.Quote() would do.
+# If the input ends with an ellipsis then no closing quote will be added (and the … will be removed).
+quote_msg() {
+    local quoted
+    quoted=$(sed -e 's/\\/\\\\/g' -e 's/"/\\"/g' -e 's/^/"/' <<<"$1")
+    if [[ $quoted == *… ]]; then
+        echo "${quoted%…}"
+    else
+        echo "${quoted}\""
+  fi
+}
+
+assert_fatal() {
+    assert_stderr_line --partial "level=fatal msg=$(quote_msg "$1")"
+}
+assert_error() {
+    assert_stderr_line --partial "level=error msg=$(quote_msg "$1")"
+}
+assert_warning() {
+    assert_stderr_line --partial "level=warning msg=$(quote_msg "$1")"
+}
+assert_info() {
+    assert_stderr_line --partial "level=info msg=$(quote_msg "$1")"
+}
+assert_debug() {
+    assert_stderr_line --partial "level=debug msg=$(quote_msg "$1")"
+}

hack/bats/tests/00-yq.bats

@@ -0,0 +1,37 @@
+# SPDX-FileCopyrightText: Copyright The Lima Authors
+# SPDX-License-Identifier: Apache-2.0
+
+load "../helpers/load"
+
+@test 'make sure the yq subcommand exists' {
+    run -0 limactl yq --version
+    assert_output --regexp '^yq .*mikefarah.* version v'
+}
+
+@test 'yq can evaluate yq expressions' {
+    run -0 limactl yq .foo=42 <<<""
+    assert_output 'foo: 42'
+}
+
+@test 'yq command understand yq options' {
+    run -0 limactl yq -n -o json -I 0 .foo=42
+    assert_output '{"foo":42}'
+}
+
+@test 'yq errors set non-zero exit code' {
+    run -1 limactl yq -n foo
+    assert_output --partial "invalid input"
+}
+
+@test 'yq works as a multi-call binary' {
+    # multi-call command detection strips all extensions
+    YQ="yq.lima.exe"
+    ln -sf "$(which limactl)" "${BATS_TEST_TMPDIR}/${YQ}"
+    export PATH="$BATS_TEST_TMPDIR:$PATH"
+
+    run -0 "$YQ" --version
+    assert_output --regexp '^yq .*mikefarah.* version v'
+
+    run -0 "$YQ" -n -o json -I 0 .foo=42
+    assert_output '{"foo":42}'
+}