mirror of
https://github.com/kata-containers/kata-containers.git
synced 2025-04-28 03:42:09 +00:00
0d3f9fcee1
ShellCheck: export variables used outside of tests_common.sh - e.g., warning: timeout appears unused. Verify use (or export if used externally). [SC2034] Signed-off-by: Dan Mihai <dmihai@microsoft.com>
411 lines
14 KiB
Bash
411 lines
14 KiB
Bash
#!/bin/bash
|
|
#
|
|
# Copyright (c) 2021 Red Hat, Inc.
|
|
#
|
|
# SPDX-License-Identifier: Apache-2.0
|
|
#
|
|
# This script is evoked within an OpenShift Build to product the binary image,
|
|
# which will contain the Kata Containers installation into a given destination
|
|
# directory.
|
|
#
|
|
# This contains variables and functions common to all e2e tests.
|
|
|
|
# Variables used by the kubernetes tests
|
|
export docker_images_nginx_version="1.15-alpine"
|
|
export container_images_agnhost_name="registry.k8s.io/e2e-test-images/agnhost"
|
|
export container_images_agnhost_version="2.21"
|
|
|
|
# Timeout options, mainly for use with waitForProcess(). Use them unless the
|
|
# operation needs to wait longer.
|
|
export wait_time=90
|
|
export sleep_time=3
|
|
|
|
# Timeout for use with `kubectl wait`, unless it needs to wait longer.
|
|
# Note: try to keep timeout and wait_time equal.
|
|
export timeout=90s
|
|
|
|
# issues that can't test yet.
|
|
export fc_limitations="https://github.com/kata-containers/documentation/issues/351"
|
|
export dragonball_limitations="https://github.com/kata-containers/kata-containers/issues/6621"
|
|
|
|
# Path to the kubeconfig file which is used by kubectl and other tools.
|
|
# Note: the init script sets that variable but if you want to run the tests in
|
|
# your own provisioned cluster and you know what you are doing then you should
|
|
# overwrite it.
|
|
export KUBECONFIG="${KUBECONFIG:-$HOME/.kube/config}"
|
|
|
|
# ALLOW_ALL_POLICY is a Rego policy that allows all the Agent ttrpc requests.
|
|
K8S_TEST_DIR="${kubernetes_dir:-"${BATS_TEST_DIRNAME}"}"
|
|
ALLOW_ALL_POLICY="${ALLOW_ALL_POLICY:-$(base64 -w 0 "${K8S_TEST_DIR}/../../../src/kata-opa/allow-all.rego")}"
|
|
|
|
# Common setup for tests.
|
|
#
|
|
# Global variables exported:
|
|
# $node - random picked node that has kata installed
|
|
# $node_start_date - start date/time at the $node for the sake of
|
|
# fetching logs
|
|
#
|
|
setup_common() {
|
|
node=$(get_one_kata_node)
|
|
[[ -n "$node" ]]
|
|
node_start_time=$(exec_host "$node" date +\"%Y-%m-%d %H:%M:%S\")
|
|
# If node_start_time is empty, try again 3 times with a 5 seconds sleep between each try.
|
|
count=0
|
|
while [[ -z "$node_start_time" ]] && [[ $count -lt 3 ]]; do
|
|
echo "node_start_time is empty, trying again..."
|
|
sleep 5
|
|
node_start_time=$(exec_host "$node" date +\"%Y-%m-%d %H:%M:%S\")
|
|
count=$((count + 1))
|
|
done
|
|
[[ -n "$node_start_time" ]]
|
|
export node node_start_time
|
|
|
|
k8s_delete_all_pods_if_any_exists || true
|
|
}
|
|
|
|
get_pod_config_dir() {
|
|
export pod_config_dir="${BATS_TEST_DIRNAME}/runtimeclass_workloads_work"
|
|
info "k8s configured to use runtimeclass"
|
|
}
|
|
|
|
# Return the first worker found that is kata-runtime labeled.
|
|
get_one_kata_node() {
|
|
local resource_name
|
|
resource_name="$(kubectl get node -l katacontainers.io/kata-runtime=true -o name | head -1)"
|
|
# Remove leading "/node"
|
|
echo "${resource_name/"node/"}"
|
|
}
|
|
|
|
auto_generate_policy_enabled() {
|
|
[[ "${AUTO_GENERATE_POLICY}" == "yes" ]]
|
|
}
|
|
|
|
# adapt common policy settings for tdx or snp
|
|
adapt_common_policy_settings_for_tdx() {
|
|
local settings_dir=$1
|
|
|
|
info "Adapting common policy settings for TDX, SNP, or the non-TEE development environment"
|
|
jq '.common.cpath = "/run/kata-containers" | .volumes.configMap.mount_point = "^$(cpath)/$(bundle-id)-[a-z0-9]{16}-"' "${settings_dir}/genpolicy-settings.json" > temp.json && sudo mv temp.json "${settings_dir}/genpolicy-settings.json"
|
|
}
|
|
|
|
# adapt common policy settings for qemu-sev
|
|
adapt_common_policy_settings_for_sev() {
|
|
local settings_dir=$1
|
|
|
|
info "Adapting common policy settings for SEV"
|
|
jq '.kata_config.oci_version = "1.1.0-rc.1" | .common.cpath = "/run/kata-containers" | .volumes.configMap.mount_point = "^$(cpath)/$(bundle-id)-[a-z0-9]{16}-"' "${settings_dir}/genpolicy-settings.json" > temp.json && sudo mv temp.json "${settings_dir}/genpolicy-settings.json"
|
|
}
|
|
|
|
# adapt common policy settings for pod VMs using "shared_fs = virtio-fs" (https://github.com/kata-containers/kata-containers/issues/10189)
|
|
adapt_common_policy_settings_for_virtio_fs() {
|
|
local settings_dir=$1
|
|
|
|
info "Adapting common policy settings for shared_fs=virtio-fs"
|
|
jq '.request_defaults.UpdateEphemeralMountsRequest = true' "${settings_dir}/genpolicy-settings.json" > temp.json && sudo mv temp.json "${settings_dir}/genpolicy-settings.json"
|
|
jq '.sandbox.storages += [{"driver":"virtio-fs","driver_options":[],"fs_group":null,"fstype":"virtiofs","mount_point":"/run/kata-containers/shared/containers/","options":[],"source":"kataShared"}]' \
|
|
"${settings_dir}/genpolicy-settings.json" > temp.json && sudo mv temp.json "${settings_dir}/genpolicy-settings.json"
|
|
}
|
|
|
|
# adapt common policy settings for CBL-Mariner Hosts
|
|
adapt_common_policy_settings_for_cbl_mariner() {
|
|
true
|
|
}
|
|
|
|
# adapt common policy settings for various platforms
|
|
adapt_common_policy_settings() {
|
|
local settings_dir=$1
|
|
|
|
case "${KATA_HYPERVISOR}" in
|
|
"qemu-tdx"|"qemu-snp"|"qemu-coco-dev")
|
|
adapt_common_policy_settings_for_tdx "${settings_dir}"
|
|
;;
|
|
"qemu-sev")
|
|
adapt_common_policy_settings_for_sev "${settings_dir}"
|
|
;;
|
|
*)
|
|
# AUTO_GENERATE_POLICY=yes is currently supported by this script when testing:
|
|
# - The SEV, SNP, or TDX platforms above, that are using "shared_fs = none".
|
|
# - Other platforms that are using "shared_fs = virtio-fs".
|
|
# Attempting to test using AUTO_GENERATE_POLICY=yes on platforms that are not
|
|
# supported yet is likely to result in test failures due to incorrectly auto-
|
|
# generated policies.
|
|
adapt_common_policy_settings_for_virtio_fs "${settings_dir}"
|
|
;;
|
|
esac
|
|
|
|
case "${KATA_HOST_OS}" in
|
|
"cbl-mariner")
|
|
adapt_common_policy_settings_for_cbl_mariner "${settings_dir}"
|
|
;;
|
|
esac
|
|
}
|
|
|
|
# If auto-generated policy testing is enabled, make a copy of the genpolicy settings,
|
|
# and change these settings to use Kata CI cluster's default namespace.
|
|
create_common_genpolicy_settings() {
|
|
declare -r genpolicy_settings_dir="$1"
|
|
declare -r default_genpolicy_settings_dir="/opt/kata/share/defaults/kata-containers"
|
|
|
|
auto_generate_policy_enabled || return 0
|
|
|
|
adapt_common_policy_settings "${default_genpolicy_settings_dir}"
|
|
|
|
cp "${default_genpolicy_settings_dir}/genpolicy-settings.json" "${genpolicy_settings_dir}"
|
|
cp "${default_genpolicy_settings_dir}/rules.rego" "${genpolicy_settings_dir}"
|
|
}
|
|
|
|
# If auto-generated policy testing is enabled, make a copy of the common genpolicy settings
|
|
# described above into a temporary directory that will be used by the current test case.
|
|
create_tmp_policy_settings_dir() {
|
|
declare -r common_settings_dir="$1"
|
|
|
|
auto_generate_policy_enabled || return 0
|
|
|
|
tmp_settings_dir=$(mktemp -d --tmpdir="${common_settings_dir}" genpolicy.XXXXXXXXXX)
|
|
cp "${common_settings_dir}/rules.rego" "${tmp_settings_dir}"
|
|
cp "${common_settings_dir}/genpolicy-settings.json" "${tmp_settings_dir}"
|
|
|
|
echo "${tmp_settings_dir}"
|
|
}
|
|
|
|
# Delete a directory created by create_tmp_policy_settings_dir.
|
|
delete_tmp_policy_settings_dir() {
|
|
local settings_dir="$1"
|
|
|
|
auto_generate_policy_enabled || return 0
|
|
|
|
if [[ -d "${settings_dir}" ]]; then
|
|
info "Deleting ${settings_dir}"
|
|
rm -rf "${settings_dir}"
|
|
fi
|
|
}
|
|
|
|
# Execute genpolicy to auto-generate policy for a test YAML file.
|
|
auto_generate_policy() {
|
|
declare -r settings_dir="$1"
|
|
declare -r yaml_file="$2"
|
|
declare -r config_map_yaml_file="${3:-""}"
|
|
declare -r additional_flags="${4:-""}"
|
|
|
|
auto_generate_policy_enabled || return 0
|
|
local genpolicy_command="RUST_LOG=info /opt/kata/bin/genpolicy -u -y ${yaml_file}"
|
|
genpolicy_command+=" -p ${settings_dir}/rules.rego"
|
|
genpolicy_command+=" -j ${settings_dir}/genpolicy-settings.json"
|
|
|
|
if [[ ! -z "${config_map_yaml_file}" ]]; then
|
|
genpolicy_command+=" -c ${config_map_yaml_file}"
|
|
fi
|
|
|
|
if [[ "${GENPOLICY_PULL_METHOD}" == "containerd" ]]; then
|
|
genpolicy_command+=" -d"
|
|
fi
|
|
|
|
genpolicy_command+=" ${additional_flags}"
|
|
|
|
info "Executing: ${genpolicy_command}"
|
|
eval "${genpolicy_command}"
|
|
}
|
|
|
|
# Change genpolicy settings to allow "kubectl exec" to execute a command
|
|
# and to read console output from a test pod.
|
|
add_exec_to_policy_settings() {
|
|
auto_generate_policy_enabled || return 0
|
|
|
|
local -r settings_dir="$1"
|
|
shift
|
|
|
|
# Create a JSON array of strings containing all the args of the command to be allowed.
|
|
local exec_args=$(printf "%s\n" "$@" | jq -R | jq -sc)
|
|
|
|
# Change genpolicy settings to allow kubectl to exec the command specified by the caller.
|
|
local jq_command=".request_defaults.ExecProcessRequest.allowed_commands |= . + [${exec_args}]"
|
|
info "${settings_dir}/genpolicy-settings.json: executing jq command: ${jq_command}"
|
|
jq "${jq_command}" \
|
|
"${settings_dir}/genpolicy-settings.json" > \
|
|
"${settings_dir}/new-genpolicy-settings.json"
|
|
mv "${settings_dir}/new-genpolicy-settings.json" \
|
|
"${settings_dir}/genpolicy-settings.json"
|
|
}
|
|
|
|
# Change genpolicy settings to allow one or more ttrpc requests from the Host to the Guest.
|
|
add_requests_to_policy_settings() {
|
|
declare -r settings_dir="$1"
|
|
shift
|
|
declare -r requests=("$@")
|
|
|
|
auto_generate_policy_enabled || return 0
|
|
|
|
for request in "${requests[@]}"
|
|
do
|
|
info "${settings_dir}/genpolicy-settings.json: allowing ${request}"
|
|
jq ".request_defaults.${request} |= true" \
|
|
"${settings_dir}"/genpolicy-settings.json > \
|
|
"${settings_dir}"/new-genpolicy-settings.json
|
|
mv "${settings_dir}"/new-genpolicy-settings.json \
|
|
"${settings_dir}"/genpolicy-settings.json
|
|
done
|
|
}
|
|
|
|
# Change genpolicy settings to allow executing on the Guest VM the commands
|
|
# used by "kubectl cp" from the Host to the Guest.
|
|
add_copy_from_host_to_policy_settings() {
|
|
local -r genpolicy_settings_dir="$1"
|
|
|
|
local exec_command=(test -d /tmp)
|
|
add_exec_to_policy_settings "${policy_settings_dir}" "${exec_command[@]}"
|
|
exec_command=(tar -xmf - -C /tmp)
|
|
add_exec_to_policy_settings "${policy_settings_dir}" "${exec_command[@]}"
|
|
}
|
|
|
|
# Change genpolicy settings to allow executing on the Guest VM the commands
|
|
# used by "kubectl cp" from the Guest to the Host.
|
|
add_copy_from_guest_to_policy_settings() {
|
|
local -r genpolicy_settings_dir="$1"
|
|
local -r copied_file="$2"
|
|
|
|
exec_command=(tar cf - "${copied_file}")
|
|
add_exec_to_policy_settings "${policy_settings_dir}" "${exec_command[@]}"
|
|
}
|
|
|
|
hard_coded_policy_tests_enabled() {
|
|
# CI is testing hard-coded policies just on a the platforms listed here. Outside of CI,
|
|
# users can enable testing of the same policies (plus the auto-generated policies) by
|
|
# specifying AUTO_GENERATE_POLICY=yes.
|
|
local enabled_hypervisors="qemu-coco-dev qemu-sev qemu-snp qemu-tdx"
|
|
[[ " $enabled_hypervisors " =~ " ${KATA_HYPERVISOR} " ]] || \
|
|
[[ "${KATA_HOST_OS}" == "cbl-mariner" ]] || \
|
|
auto_generate_policy_enabled
|
|
}
|
|
|
|
add_allow_all_policy_to_yaml() {
|
|
hard_coded_policy_tests_enabled || return 0
|
|
|
|
local yaml_file="$1"
|
|
# Previous version of yq was not ready to handle multiple objects in a single yaml.
|
|
# By default was changing only the first object.
|
|
# With yq>4 we need to make it explicit during the read and write.
|
|
local resource_kind="$(yq .kind ${yaml_file} | head -1)"
|
|
|
|
case "${resource_kind}" in
|
|
|
|
Pod)
|
|
info "Adding allow all policy to ${resource_kind} from ${yaml_file}"
|
|
ALLOW_ALL_POLICY="${ALLOW_ALL_POLICY}" yq -i \
|
|
".metadata.annotations.\"io.katacontainers.config.agent.policy\" = \"${ALLOW_ALL_POLICY}\"" \
|
|
"${yaml_file}"
|
|
;;
|
|
|
|
Deployment|Job|ReplicationController)
|
|
info "Adding allow all policy to ${resource_kind} from ${yaml_file}"
|
|
ALLOW_ALL_POLICY="${ALLOW_ALL_POLICY}" yq -i \
|
|
".spec.template.metadata.annotations.\"io.katacontainers.config.agent.policy\" = \"${ALLOW_ALL_POLICY}\"" \
|
|
"${yaml_file}"
|
|
;;
|
|
|
|
List)
|
|
die "Issue #7765: adding allow all policy to ${resource_kind} from ${yaml_file} is not implemented yet"
|
|
;;
|
|
|
|
ConfigMap|LimitRange|Namespace|PersistentVolume|PersistentVolumeClaim|RuntimeClass|Secret|Service)
|
|
die "Policy is not required for ${resource_kind} from ${yaml_file}"
|
|
;;
|
|
|
|
*)
|
|
die "k8s resource type ${resource_kind} from ${yaml_file} is not yet supported for policy testing"
|
|
;;
|
|
|
|
esac
|
|
}
|
|
|
|
# Execute "kubectl describe ${pod}" in a loop, until its output contains "${endpoint} is blocked by policy"
|
|
wait_for_blocked_request() {
|
|
local -r endpoint="$1"
|
|
local -r pod="$2"
|
|
|
|
local -r command="kubectl describe pod ${pod} | grep \"${endpoint} is blocked by policy\""
|
|
info "Waiting ${wait_time} seconds for: ${command}"
|
|
waitForProcess "${wait_time}" "$sleep_time" "${command}" >/dev/null 2>/dev/null
|
|
}
|
|
|
|
# Execute in a pod a command that is allowed by policy.
|
|
pod_exec_allowed_command() {
|
|
local -r pod_name="$1"
|
|
shift
|
|
|
|
local -r exec_output=$(kubectl exec "${pod_name}" -- "${@}" 2>&1)
|
|
|
|
local -r exec_args=$(printf '"%s",' "${@}")
|
|
info "Pod ${pod_name}: <${exec_args::-1}>:"
|
|
info "${exec_output}"
|
|
|
|
(echo "${exec_output}" | grep "policy") && die "exec was blocked by policy!"
|
|
return 0
|
|
}
|
|
|
|
# Execute in a pod a command that is blocked by policy.
|
|
pod_exec_blocked_command() {
|
|
local -r pod_name="$1"
|
|
shift
|
|
|
|
local -r exec_output=$(kubectl exec "${pod_name}" -- "${@}" 2>&1)
|
|
|
|
local -r exec_args=$(printf '"%s",' "${@}")
|
|
info "Pod ${pod_name}: <${exec_args::-1}>:"
|
|
info "${exec_output}"
|
|
|
|
(echo "${exec_output}" | grep "ExecProcessRequest is blocked by policy" > /dev/null) || die "exec was not blocked by policy!"
|
|
}
|
|
|
|
# Common teardown for tests.
|
|
#
|
|
# Parameters:
|
|
# $1 - node name where kata is installed
|
|
# $2 - start time at the node for the sake of fetching logs
|
|
#
|
|
teardown_common() {
|
|
local node="$1"
|
|
local node_start_time="$2"
|
|
|
|
kubectl describe pods
|
|
k8s_delete_all_pods_if_any_exists || true
|
|
|
|
# Print the node journal since the test start time if a bats test is not completed
|
|
if [[ -n "${node_start_time}" && -z "$BATS_TEST_COMPLETED" ]]; then
|
|
echo "DEBUG: system logs of node '$node' since test start time ($node_start_time)"
|
|
exec_host "${node}" journalctl -x -t "kata" --since '"'$node_start_time'"' || true
|
|
fi
|
|
}
|
|
|
|
# Invoke "kubectl exec", log its output, and check that a grep pattern is present in the output.
|
|
#
|
|
# Retry "kubectl exec" several times in case it unexpectedly returns an empty output string,
|
|
# in an attempt to work around issues similar to https://github.com/kubernetes/kubernetes/issues/124571.
|
|
#
|
|
# Parameters:
|
|
# $1 - pod name
|
|
# $2 - the grep pattern
|
|
# $3+ - the command to execute using "kubectl exec"
|
|
#
|
|
grep_pod_exec_output() {
|
|
local -r pod_name="$1"
|
|
shift
|
|
local -r grep_arg="$1"
|
|
shift
|
|
local grep_out=""
|
|
local cmd_out=""
|
|
|
|
for _ in {1..10}; do
|
|
info "Executing in pod ${pod_name}: $*"
|
|
cmd_out=$(kubectl exec "${pod_name}" -- "$@")
|
|
if [[ -n "${cmd_out}" ]]; then
|
|
info "command output: ${cmd_out}"
|
|
grep_out=$(echo "${cmd_out}" | grep "${grep_arg}")
|
|
info "grep output: ${grep_out}"
|
|
break
|
|
fi
|
|
warn "Empty output from kubectl exec"
|
|
sleep 1
|
|
done
|
|
[[ -n "${grep_out}" ]]
|
|
}
|