hurl/integration/test_hurl.py

231 lines
7.9 KiB
Python
Executable File

#!/usr/bin/env python3
# Test Hurl files.
#
import codecs
import sys
import subprocess
import os
import platform
import check_json_output
import re
import argparse
def decode_string(encoded: bytes) -> str:
"""Decodes bytes to string from infering encoding."""
if encoded.startswith(codecs.BOM_UTF8):
return encoded.decode("utf-8-sig")
elif encoded.startswith(codecs.BOM_UTF16):
encoded = encoded[len(codecs.BOM_UTF16) :]
return encoded.decode("utf-16")
else:
# No BOM to determine encoding, try utf-8
return encoded.decode("utf-8")
def get_os() -> str:
"""Returns `linux-fedora`, `linux`, `osx` or `windows`
can add more specific linux variant if needed
"""
if platform.system() == "Linux":
if os.path.exists("/etc/fedora-release"):
return "linux-fedora"
return "linux"
elif platform.system() == "Darwin":
return "osx"
elif platform.system() == "Windows":
return "windows"
else:
raise Error("Invalid Platform " + platform.system())
def test(hurl_file: str):
"""Runs a Hurl file, exit the process if there is an error.
Arguments:
hurl_file -- the Hurl file to run
"""
options_file = hurl_file.replace(".hurl", ".options")
# For .curl file, we can have specific os expected file in order to test
# os differences like included path (/ vs \ path components separator)
os_curl_file = hurl_file.replace(".hurl", "." + get_os() + ".curl")
if os.path.exists(os_curl_file):
curl_file = os_curl_file
else:
curl_file = hurl_file.replace(".hurl", ".curl")
json_output_file = hurl_file.replace(".hurl", ".output.json")
profile_file = hurl_file.replace(".hurl", ".profile")
options = []
if os.path.exists(options_file):
options = open(options_file, encoding="utf-8").read().strip().split("\n")
if os.path.exists(curl_file):
options.append("--verbose")
if os.path.exists(json_output_file):
options.append("--json")
env = os.environ.copy()
if os.path.exists(profile_file):
for line in open(profile_file, encoding="utf-8").readlines():
line = line.strip()
if line == "":
continue
index = line.index("=")
name = line[:index]
value = line[(index + 1) :]
env[name] = value
cmd = ["hurl", hurl_file] + options
print(" ".join(cmd))
result = subprocess.run(
cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE, env=env
)
# exit code
f = hurl_file.replace(".hurl", ".exit")
if os.path.exists(f):
expected = int(open(f, encoding="utf-8").read().strip())
else:
expected = 0
if result.returncode != expected:
print(">>> error in return code")
print(f"expected: {expected} actual:{result.returncode}")
stderr = decode_string(result.stderr).strip()
if stderr != "":
print(stderr)
sys.exit(1)
# stdout
f = hurl_file.replace(".hurl", ".out")
if os.path.exists(f):
expected = open(f, "rb").read()
actual = result.stdout
if actual != expected:
print(">>> error in stdout")
print(f"actual: <{actual}>\nexpected: <{expected}>")
sys.exit(1)
# stdout with textual pattern / line per line
f = hurl_file.replace(".hurl", ".out.pattern")
if os.path.exists(f):
expected = open(f, encoding="utf-8").read()
actual = decode_string(result.stdout)
expected_lines = expected.split("\n")
expected_pattern_lines = [parse_pattern(line) for line in expected_lines]
actual_lines = actual.split("\n")
if len(actual_lines) != len(expected_pattern_lines):
print(">>> error in stderr / mismatch in number of lines")
print(
f"actual: {len(actual_lines)} lines\nexpected: {len(expected_lines)} lines"
)
sys.exit(1)
for i in range(len(expected_pattern_lines)):
if not re.match(expected_pattern_lines[i], actual_lines[i]):
print(f">>> error in stdout in line {i+1}")
print(f"actual: <{actual_lines[i]}>")
print(
f"expected: <{expected_lines[i]}> (translated to regex <{expected_pattern_lines[i]}>)"
)
sys.exit(1)
# stdout (json)
if os.path.exists(json_output_file):
expected = open(json_output_file, encoding="utf-8").read()
actual = result.stdout
check_json_output.check(expected, actual)
# stderr
f = hurl_file.replace(".hurl", "." + get_os() + ".err")
if os.path.exists(f):
expected = open(f, encoding="utf-8").read().strip()
actual = decode_string(result.stderr).strip()
if actual != expected:
print(">>> error in stderr")
print(f"actual: <{actual}>\nexpected: <{expected}>")
sys.exit(1)
else:
f = hurl_file.replace(".hurl", ".err")
if os.path.exists(f):
expected = open(f, encoding="utf-8").read().strip()
actual = decode_string(result.stderr).strip()
if expected != actual:
print(">>> error in stderr")
print(f"actual: <{actual}>\nexpected: <{expected}>")
sys.exit(1)
# stderr with textual pattern / line per line
f = hurl_file.replace(".hurl", ".err.pattern")
if os.path.exists(f):
expected = open(f, encoding="utf-8").read()
actual = decode_string(result.stderr)
expected_lines = expected.split("\n")
expected_pattern_lines = [parse_pattern(line) for line in expected_lines]
actual_lines = re.split(r"\r?\n", actual)
if len(actual_lines) != len(expected_pattern_lines):
print(">>> error in stderr / mismatch in number of lines")
print(
f"actual: {len(actual_lines)} lines\nexpected: {len(expected_lines)} lines"
)
sys.exit(1)
for i in range(len(expected_pattern_lines)):
if not re.match(expected_pattern_lines[i], actual_lines[i]):
print(f">>> error in stderr in line {i+1}")
print(f"actual: <{actual_lines[i]}>")
print(
f"expected: <{expected_lines[i]}> (translated to regex <{expected_pattern_lines[i]}>)"
)
sys.exit(1)
# curl output
if os.path.exists(curl_file):
expected_commands = []
for line in open(curl_file, encoding="utf-8").readlines():
line = line.strip()
if line == "" or line.startswith("#"):
continue
expected_commands.append(line)
actual = decode_string(result.stderr).strip()
actual_commands = [
line[2:] for line in actual.split("\n") if line.startswith("* curl")
]
if len(actual_commands) != len(expected_commands):
print(f"curl commands error at {curl_file}")
print(f"expected: {len(expected_commands)} commands")
print(f"actual: {len(actual_commands)} commands")
sys.exit(1)
for i in range(len(expected_commands)):
if actual_commands[i] != expected_commands[i]:
print(f"curl command error at {curl_file}: {i + 1}")
print(f"expected: {expected_commands[i]}")
print(f"actual: {actual_commands[i]}")
sys.exit(1)
def parse_pattern(s: str) -> str:
"""Transform a stderr pattern to a regex"""
# Escape regex metacharacters
for c in ["\\", ".", "(", ")", "[", "]", "^", "$", "*", "+", "?"]:
s = s.replace(c, "\\" + c)
s = re.sub("~+", ".*", s)
s = "^" + s + "$"
return s
def main():
parser = argparse.ArgumentParser()
parser.add_argument("file", type=str, nargs="+", metavar="FILE")
args = parser.parse_args()
for hurl_file in args.file:
test(hurl_file=hurl_file)
if __name__ == "__main__":
main()