tools/devshell/tests/subcommands/fx_regen_goldens_test

#!/bin/bash
# Copyright 2020 The Fuchsia Authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.

### Test expected behavior of 'fx regen-goldens'

BT_LINKED_DEPS=(
  "prebuilt/third_party/jq"
)

BT_FILE_DEPS=(
  "scripts/fx"
  "tools/devshell/contrib/regen-goldens"
  "tools/devshell/lib/fx-cmd-locator.sh"
  "tools/devshell/jq.fx"
  "tools/devshell/lib/fx-optional-features.sh"
  "tools/devshell/lib/vars.sh"
  "tools/devshell/lib/platform.sh"
)

BT_MOCKED_TOOLS=(
  "tools/devshell/test"
)

declare fx fxtest_mock fxtest_mock_impl output fidlc_goldens

# regen-goldens maintains a list of golden directories for all the tools.
# Verifying them here would mean copying paths in three places: regen-goldens,
# BUILD.gn (data dependencies), and here. So instead of that, regen-goldens
# verifies them on every run. We export a variable to disable it during tests,
# since the golden directories do not exist in the test sandbox.
export REGEN_GOLDENS_SKIP_CHECK=1

BT_SET_UP() {
  source "$BT_TEMP_DIR/tools/devshell/tests/lib/fuchsia-mock.sh"
  fx=$(btf::setup_fx)
  fxtest_mock="$BT_TEMP_DIR/tools/devshell/test.mock_state"
  fxtest_mock_impl="$BT_TEMP_DIR/tools/devshell/test.mock_side_effects"
  output="$BT_TEMP_DIR/_fx_regen_goldens_output"
  fidlc_goldens="$BT_TEMP_DIR/tools/fidl/fidlc/goldens"
  mkdir -p "$fidlc_goldens"
}

TEST_help() {
  BT_EXPECT "$fx" regen-goldens --help &> /dev/null
  BT_EXPECT_FILE_DOES_NOT_EXIST "$fxtest_mock"
}

TEST_list_all() {
  BT_EXPECT "$fx" regen-goldens --list &> "$output"
  BT_EXPECT_FILE_DOES_NOT_EXIST "$fxtest_mock"
  # It should list all tools. Check for a couple of them.
  BT_EXPECT_FILE_CONTAINS_SUBSTRING "$output" fidlc
  BT_EXPECT_FILE_CONTAINS_SUBSTRING "$output" fidldoc
  # It should also show their golden directories.
  BT_EXPECT_FILE_CONTAINS_SUBSTRING "$output" /goldens
}

TEST_list_substring_match() {
  BT_EXPECT "$fx" regen-goldens --list lcpp &> "$output"
  BT_EXPECT_FILE_DOES_NOT_EXIST "$fxtest_mock"
  BT_EXPECT_FILE_CONTAINS_SUBSTRING "$output" fidlgen_hlcpp
  BT_EXPECT_FILE_CONTAINS_SUBSTRING "$output" fidlgen_llcpp
}

TEST_regen_all() {
  BT_EXPECT "$fx" regen-goldens &> "$output"
  # It should regenerate for all tools. Check for a couple of them.
  BT_EXPECT_FILE_CONTAINS_SUBSTRING "$output" fidlc
  BT_EXPECT_FILE_CONTAINS_SUBSTRING "$output" fidldoc
  BT_ASSERT_FILE_EXISTS "$fxtest_mock"
  source "$fxtest_mock"
  BT_EXPECT_STRING_CONTAINS_SUBSTRING "${BT_MOCK_ARGS[*]}" fidlc_golden_tests
  BT_EXPECT_STRING_CONTAINS_SUBSTRING "${BT_MOCK_ARGS[*]}" fidldoc_golden_tests
}

TEST_regen_one_exact() {
  BT_EXPECT "$fx" regen-goldens fidlc &> "$output"
  BT_EXPECT_FILE_CONTAINS_SUBSTRING "$output" fidlc
  btf::expect-mock-args "$fxtest_mock" fidlc_golden_tests -- --regen
}

TEST_regen_two_exact() {
  BT_EXPECT "$fx" regen-goldens fidlc fidldoc &> "$output"
  BT_EXPECT_FILE_CONTAINS_SUBSTRING "$output" "fidlc fidldoc"
  btf::expect-mock-args \
    "$fxtest_mock" fidlc_golden_tests fidldoc_golden_tests -- --regen
}

TEST_regen_substring_match() {
  BT_EXPECT "$fx" regen-goldens lcpp &> "$output"
  BT_EXPECT_FILE_CONTAINS_SUBSTRING "$output" fidlgen_hlcpp
  BT_EXPECT_FILE_CONTAINS_SUBSTRING "$output" fidlgen_llcpp
  BT_ASSERT_FILE_EXISTS "$fxtest_mock"
  source "$fxtest_mock"
  BT_EXPECT_STRING_CONTAINS_SUBSTRING "${BT_MOCK_ARGS[*]}" \
    fidlgen_hlcpp_golden_tests
  BT_EXPECT_STRING_CONTAINS_SUBSTRING "${BT_MOCK_ARGS[*]}" \
    fidlgen_llcpp_golden_tests
}

TEST_fails_no_match() {
  BT_EXPECT_FAIL "$fx" regen-goldens definitely_not_a_valid_tool &> "$output"
  BT_EXPECT_FILE_CONTAINS_SUBSTRING "$output" \
    "No tools match the pattern 'definitely_not_a_valid_tool'"
  BT_EXPECT_FILE_DOES_NOT_EXIST "$fxtest_mock"
}

TEST_regen_with_flags() {
  BT_EXPECT "$fx" regen-goldens --before fidlc -and fidldoc --after &> "$output"
  BT_EXPECT_FILE_CONTAINS_SUBSTRING "$output" fidlc
  btf::expect-mock-args \
    "$fxtest_mock" fidl{c,doc}_golden_tests --before -and --after -- --regen
}

TEST_reset() {
  echo "contents will be deleted" > "$fidlc_goldens/goldens.txt"
  echo "file will be deleted" > "$fidlc_goldens/something.golden"
  echo "untouched" > "$fidlc_goldens/something.not_a_golden"
  BT_EXPECT "$fx" regen-goldens fidlc --reset &> "$output"
  BT_EXPECT_FILE_CONTAINS_SUBSTRING "$output" "Deleting goldens for: fidlc"
  btf::expect-mock-args "$fxtest_mock" fidlc_golden_tests -- --regen
  BT_EXPECT_FILE_EXISTS "$fidlc_goldens/goldens.txt"
  BT_EXPECT_FILE_CONTAINS "$fidlc_goldens/goldens.txt" ""
  BT_EXPECT_FILE_DOES_NOT_EXIST "$fidlc_goldens/something.golden"
  BT_EXPECT_FILE_EXISTS "$fidlc_goldens/something.not_a_golden"
  BT_EXPECT_FILE_CONTAINS "$fidlc_goldens/something.not_a_golden" "untouched"
}

TEST_fatal_error_suggests_reset() {
  echo "exit 2" > "$fxtest_mock_impl"
  BT_EXPECT_FAIL "$fx" regen-goldens fidlc &> "$output"
  BT_EXPECT_FILE_CONTAINS_SUBSTRING "$output" "Hint:"
  BT_EXPECT_FILE_CONTAINS_SUBSTRING "$output" "fx regen-goldens fidlc --reset"
  # Unless you already ran with --reset:
  touch "$fidlc_goldens/goldens.txt"
  BT_EXPECT_FAIL "$fx" regen-goldens fidlc --reset &> "$output"
  BT_EXPECT_FILE_DOES_NOT_CONTAIN_SUBSTRING "$output" "Hint:"
}

TEST_test_not_found_suggests_fx_set() {
  echo "exit 3" > "$fxtest_mock_impl"
  BT_EXPECT_FAIL "$fx" regen-goldens fidlc &> "$output"
  BT_EXPECT_FILE_CONTAINS_SUBSTRING "$output" "Could not find test targets"
  BT_EXPECT_FILE_CONTAINS_SUBSTRING "$output" "Hint:"
  BT_EXPECT_FILE_CONTAINS_SUBSTRING "$output" "\--with //tools/fidl/fidlc:tests"
}

TEST_test_not_found_suggests_fx_set_only_with_needed() {
  cat <<EOS > "$BT_TEMP_DIR/out/default/tests.json"
[
  {
    "test": {
      "label": "//tools/fidl/fidlc:fidlc_golden_tests(//build/toolchain:host_x64)"
    }
  }
]
EOS
  # Based on tests.json, we should infer the exit status 3 was only due to
  # fidldoc's tests missing, not fidlc, and so only give that hint.
  echo "exit 3" > "$fxtest_mock_impl"
  BT_EXPECT_FAIL "$fx" regen-goldens fidlc fidldoc &> "$output"
  BT_EXPECT_FILE_CONTAINS_SUBSTRING "$output" "Could not find test targets"
  BT_EXPECT_FILE_CONTAINS_SUBSTRING "$output" "Hint:"
  BT_EXPECT_FILE_DOES_NOT_CONTAIN_SUBSTRING "$output" "\--with //tools/fidl/fidlc:tests"
  BT_EXPECT_FILE_CONTAINS_SUBSTRING "$output" "\--with //tools/fidl/fidldoc:tests"
}

BT_RUN_TESTS "$@"