project_tool_test.sh

#!/usr/bin/env bash
# Copyright 2017-2020 The Verible Authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

# Find input files
MY_INPUT_FILE="${TEST_TMPDIR}/myinput.txt"
readonly MY_INPUT_FILE
MY_OUTPUT_FILE="${TEST_TMPDIR}/myoutput.txt"
readonly MY_OUTPUT_FILE
MY_EXPECT_FILE="${TEST_TMPDIR}/myexpect.txt"
readonly MY_EXPECT_FILE

# Process script flags and arguments.
[[ "$#" == 1 ]] || {
  echo "Expecting 1 positional argument, verible-verilog-project path."
  exit 1
}
project_tool="$(rlocation ${TEST_WORKSPACE}/$1)"

################################################################################
echo "=== Test no arguments."

"$project_tool" > "$MY_OUTPUT_FILE" 2>&1

status="$?"
[[ $status == 1 ]] || {
  echo "$LINENO: Expected exit code 1, but got $status"
  exit 1
}

################################################################################
echo "=== Test '--helpfull'."

"$project_tool" --helpfull > "$MY_OUTPUT_FILE" 2>&1

status="$?"
[[ $status == 1 ]] || {
  echo "$LINENO: Expected exit code 1, but got $status"
  exit 1
}

grep -q "file_list_path" "$MY_OUTPUT_FILE" || {
  echo "$LINENO: Expected \"file_list_path\" in $MY_OUTPUT_FILE but didn't find it.  Got:"
  cat "$MY_OUTPUT_FILE"
  exit 1
}

################################################################################
echo "=== Expect failure on missing required flag"

 # Construct a file-list on-the-fly as a file-descriptor
"$project_tool" \
  symbol-table-defs \
  > "$MY_OUTPUT_FILE" 2>&1

status="$?"
[[ $status == 1 ]] || {
  echo "$LINENO: Expected exit code 1, but got $status"
  exit 1
}

grep -q "file_list_path.*missing" "$MY_OUTPUT_FILE" || {
  echo "$LINENO: Expected \"file_list_path is required but missing\" in $MY_OUTPUT_FILE but didn't find it.  Got:"
  cat "$MY_OUTPUT_FILE"
  exit 1
}

################################################################################
echo "=== Expect failure on nonexistent file list"

 # Construct a file-list on-the-fly as a file-descriptor
"$project_tool" \
  symbol-table-defs \
  --file_list_path "${TEST_TMPDIR}/nonexistent.txt" \
  --file_list_root "$(dirname "$MY_INPUT_FILE")" \
  > "$MY_OUTPUT_FILE" 2>&1

status="$?"
[[ $status == 1 ]] || {
  echo "$LINENO: Expected exit code 1, but got $status"
  exit 1
}

################################################################################
echo "=== Expect failure on nonexistent file listed in the file list"

# Construct a file-list on-the-fly as a file-descriptor
FILE_LIST_INPUT="${TEST_TMPDIR}/nonexist.txt"
echo "nonexistent.sv" > "$FILE_LIST_INPUT"
"$project_tool" \
  symbol-table-refs \
  --file_list_path "$FILE_LIST_INPUT" \
  --file_list_root "$(dirname "$MY_INPUT_FILE")" \
  > "$MY_OUTPUT_FILE" 2>&1

status="$?"
[[ $status == 1 ]] || {
  echo "$LINENO: Expected exit code 0, but got $status"
  exit 1
}

# Make sure we see some diagnostic message about missing files.
# System message is different in Unix vs. Windows, but they both contain 'file'
grep -q "file" "$MY_OUTPUT_FILE" || {
  echo "$LINENO: Expected \"No such file\" in $MY_OUTPUT_FILE but didn't find it.  Got:"
  cat "$MY_OUTPUT_FILE"
  exit 1
}

################################################################################
echo "=== Load one file, printing symbol table for debug."

cat > "$MY_INPUT_FILE" <<EOF
localparam int fooo = 1;
localparam int barr = fooo;
EOF

# Construct a file-list on-the-fly as a file-descriptor
FILE_LIST_INPUT="${TEST_TMPDIR}/myinputlist.txt"
echo "myinput.txt" > "$FILE_LIST_INPUT"
"$project_tool" \
  symbol-table-defs \
  --file_list_path "$FILE_LIST_INPUT" \
  --file_list_root "$(dirname "$MY_INPUT_FILE")" \
  > "$MY_OUTPUT_FILE" 2>&1

status="$?"
[[ $status == 0 ]] || {
  echo "$LINENO: Expected exit code 0, but got $status"
  cat "$MY_OUTPUT_FILE"
  exit 1
}

grep -q "metatype: parameter" "$MY_OUTPUT_FILE" || {
  echo "$LINENO: Expected \"metatype: parameter\" in $MY_OUTPUT_FILE but didn't find it.  Got:"
  cat "$MY_OUTPUT_FILE"
  exit 1
}

################################################################################
echo "=== Load one file containing syntax error (build-only)."

cat > "$MY_INPUT_FILE" <<EOF
localparam 777;
EOF

# Construct a file-list on-the-fly as a file-descriptor
FILE_LIST_INPUT="${TEST_TMPDIR}/myinputlist.txt"
echo "myinput.txt" > "$FILE_LIST_INPUT"
"$project_tool" \
  symbol-table-defs \
  --file_list_path "$FILE_LIST_INPUT" \
  --file_list_root "$(dirname "$MY_INPUT_FILE")" \
  > "$MY_OUTPUT_FILE" 2>&1

status="$?"
[[ $status == 1 ]] || {
  echo "$LINENO: Expected exit code 1, but got $status"
  exit 1
}

grep -q "[combined statuses]:" "$MY_OUTPUT_FILE" || {
  echo "$LINENO: Expected \"[combined statuses]:\" in $MY_OUTPUT_FILE but didn't find it.  Got:"
  cat "$MY_OUTPUT_FILE"
  exit 1
}

################################################################################
echo "=== Load one file, printing symbol references for debug."

cat > "$MY_INPUT_FILE" <<EOF
localparam int fooo = 1;
localparam int barr = fooo;
EOF

# Construct a file-list on-the-fly as a file-descriptor
FILE_LIST_INPUT="${TEST_TMPDIR}/myinputlist.txt"
echo "myinput.txt" > "$FILE_LIST_INPUT"
"$project_tool" \
  symbol-table-refs \
  --file_list_path "$FILE_LIST_INPUT" \
  --file_list_root "$(dirname "$MY_INPUT_FILE")" \
  > "$MY_OUTPUT_FILE" 2>&1

status="$?"
[[ $status == 0 ]] || {
  echo "$LINENO: Expected exit code 0, but got $status"
  exit 1
}

grep -q "(@fooo -> \$root::fooo)" "$MY_OUTPUT_FILE" || {
  echo "$LINENO: Expected \"(@fooo -> \$root::fooo)\" in $MY_OUTPUT_FILE but didn't find it.  Got:"
  cat "$MY_OUTPUT_FILE"
  exit 1
}

################################################################################
echo "=== Load one file, printing symbol references for debug. File on cmdline"

cat > "$MY_INPUT_FILE" <<EOF
localparam int fooo = 1;
localparam int barr = fooo;
EOF

"$project_tool" \
  symbol-table-refs \
  --file_list_root "$(dirname "$MY_INPUT_FILE")" \
  myinput.txt \
  > "$MY_OUTPUT_FILE" 2>&1

status="$?"
[[ $status == 0 ]] || {
  cat "$MY_OUTPUT_FILE"
  echo "$LINENO: Expected exit code 0, but got $status"
  exit 1
}

grep -q "(@fooo -> \$root::fooo)" "$MY_OUTPUT_FILE" || {
  echo "$LINENO: Expected \"(@fooo -> \$root::fooo)\" in $MY_OUTPUT_FILE but didn't find it.  Got:"
  cat "$MY_OUTPUT_FILE"
  exit 1
}

################################################################################
echo "=== Same as above, but with absolute file on cmdline"

"$project_tool" \
  symbol-table-refs \
  $MY_INPUT_FILE \
  > "$MY_OUTPUT_FILE" 2>&1

status="$?"
[[ $status == 0 ]] || {
  cat "$MY_OUTPUT_FILE"
  echo "$LINENO: Expected exit code 0, but got $status"
  exit 1
}

################################################################################
echo "=== Load one file containing syntax error (build-and-resolve)."

cat > "$MY_INPUT_FILE" <<EOF
localparam 777;
EOF

# Construct a file-list on-the-fly as a file-descriptor
FILE_LIST_INPUT="${TEST_TMPDIR}/myinputlist.txt"
echo "myinput.txt" > "$FILE_LIST_INPUT"
"$project_tool" \
  symbol-table-refs \
  --file_list_path "$FILE_LIST_INPUT" \
  --file_list_root "$(dirname "$MY_INPUT_FILE")" \
  > "$MY_OUTPUT_FILE" 2>&1

status="$?"
[[ $status == 1 ]] || {
  echo "$LINENO: Expected exit code 1, but got $status"
  exit 1
}

grep -q "[combined statuses]:" "$MY_OUTPUT_FILE" || {
  echo "$LINENO: Expected \"[combined statuses]:\" in $MY_OUTPUT_FILE but didn't find it.  Got:"
  cat "$MY_OUTPUT_FILE"
  exit 1
}

################################################################################
echo "=== Show dependencies between two files on cmdline (parameters)"

cat > "$MY_INPUT_FILE".A <<EOF
localparam int barr = fooo + 1;
EOF

cat > "$MY_INPUT_FILE".B <<EOF
localparam int fooo = 1;
EOF

# Construct a file-list on-the-fly as a file-descriptor
FILE_LIST_INPUT="${TEST_TMPDIR}/myinputlist.txt"
echo "myinput.txt.A" > "$FILE_LIST_INPUT"
echo "myinput.txt.B" >> "$FILE_LIST_INPUT"
"$project_tool" \
  file-deps \
  myinput.txt.A myinput.txt.B \
  --file_list_root "$(dirname "$MY_INPUT_FILE".A)" \
  > "$MY_OUTPUT_FILE" 2>&1

status="$?"
[[ $status == 0 ]] || {
  echo "$LINENO: Expected exit code 0, but got $status"
  exit 1
}

cat > "$MY_EXPECT_FILE" <<EOF
"myinput.txt.A" depends on "myinput.txt.B" for symbols { fooo }
EOF

diff --strip-trailing-cr -u "$MY_EXPECT_FILE" "$MY_OUTPUT_FILE" || { exit 1; }

################################################################################
echo "=== Show dependencies between two files (modules)"

cat > "$MY_INPUT_FILE".A <<EOF
module mm;
endmodule

module mm_test;
  mm dut();
endmodule
EOF

cat > "$MY_INPUT_FILE".B <<EOF
module qq;
  mm mm_inst();
endmodule
EOF

# Construct a file-list on-the-fly as a file-descriptor
FILE_LIST_INPUT="${TEST_TMPDIR}/myinputlist.txt"
echo "myinput.txt.A" > "$FILE_LIST_INPUT"
echo "myinput.txt.B" >> "$FILE_LIST_INPUT"
"$project_tool" \
  file-deps \
  --file_list_path "$FILE_LIST_INPUT" \
  --file_list_root "$(dirname "$MY_INPUT_FILE".A)" \
  > "$MY_OUTPUT_FILE" 2>&1

status="$?"
[[ $status == 0 ]] || {
  echo "$LINENO: Expected exit code 0, but got $status"
  exit 1
}

cat > "$MY_EXPECT_FILE" <<EOF
"myinput.txt.B" depends on "myinput.txt.A" for symbols { mm }
EOF

diff --strip-trailing-cr -u "$MY_EXPECT_FILE" "$MY_OUTPUT_FILE" || { exit 1; }

################################################################################
echo "PASS"