Add CurlCommand to autests (#12122)

* Add CurlCommand to autests

* MakeCurlCommand, SpawnCurlCommand, quote spaces

* separate curl and use rundir for uds path

* update new crr/slice autests

---------

Co-authored-by: Serris Lew <lserris@apple.com>

Author: serrislew

CMakeLists.txt

@@ -139,6 +139,7 @@ if(ENABLE_DISK_FAILURE_TESTS)
   add_compile_definitions("AIO_FAULT_INJECTION")
 endif()
 option(ENABLE_AUTEST "Setup autest (default OFF)")
+option(ENABLE_AUTEST_UDS "Setup autest with curl using UDS (default OFF)")
 option(ENABLE_BENCHMARKS "Build benchmarks (default OFF)")
 option(EXTERNAL_YAML_CPP "Use external yaml-cpp (default OFF)")
 option(EXTERNAL_LIBSWOC "Use external libswoc (default OFF)")

tests/CMakeLists.txt

@@ -50,6 +50,11 @@ set(RUNPIPENV PIPENV_VENV_IN_PROJECT=True ${PipEnv})
 configure_file(Pipfile Pipfile COPYONLY)
 configure_file(autest.sh.in autest.sh)
 
+set(CURL_UDS_FLAG "")
+if(ENABLE_AUTEST_UDS)
+  set(CURL_UDS_FLAG "--curl-uds")
+endif()
+
 add_custom_target(
   autest
   COMMAND ${CMAKE_COMMAND} --build ${CMAKE_BINARY_DIR} --target install
@@ -58,7 +63,7 @@ add_custom_target(
     ${CMAKE_COMMAND} -E env PYTHONPATH=${CMAKE_CURRENT_SOURCE_DIR}/gold_tests/remap:$ENV{PYTHONPATH} ${RUNPIPENV} run
     env autest --directory ${CMAKE_CURRENT_SOURCE_DIR}/gold_tests --ats-bin=${CMAKE_INSTALL_PREFIX}/bin
     --proxy-verifier-bin ${PROXY_VERIFIER_PATH} --build-root ${CMAKE_BINARY_DIR} --sandbox ${AUTEST_SANDBOX}
-    ${AUTEST_OPTIONS}
+    ${CURL_UDS_FLAG} ${AUTEST_OPTIONS}
   WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
   USES_TERMINAL
 )
@@ -70,7 +75,7 @@ add_custom_target(
     ${CMAKE_COMMAND} -E env PYTHONPATH=${CMAKE_CURRENT_SOURCE_DIR}/gold_tests/remap:$ENV{PYTHONPATH} ${RUNPIPENV} run
     env autest --directory ${CMAKE_CURRENT_SOURCE_DIR}/gold_tests --ats-bin=${CMAKE_INSTALL_PREFIX}/bin
     --proxy-verifier-bin ${PROXY_VERIFIER_PATH} --build-root ${CMAKE_BINARY_DIR} --sandbox ${AUTEST_SANDBOX}
-    ${AUTEST_OPTIONS}
+    ${CURL_UDS_FLAG} ${AUTEST_OPTIONS}
   WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
   USES_TERMINAL
 )

tests/README.md

@@ -132,7 +132,7 @@ ts=Test.MakeATSProcess("ts")
 #first test is a miss for default
 tr=Test.AddTestRun()
 # get port for command from Variables
-tr.Processes.Default.Command='curl "http://127.0.0.1:{0}" --verbose'.format(ts.Variables.port)
+tr.MakeCurlCommand('"http://127.0.0.1:{0}" --verbose'.format(ts.Variables.port))
 
 ```
 

tests/autest.sh.in

@@ -13,5 +13,5 @@ ${RUNPIPENV} run env autest \
   --ats-bin=${CMAKE_INSTALL_PREFIX}/bin \
   --proxy-verifier-bin ${PROXY_VERIFIER_PATH} \
   --build-root ${CMAKE_BINARY_DIR} \
-  ${AUTEST_OPTIONS} \
+  ${CURL_UDS_FLAG} ${AUTEST_OPTIONS} \
   "$@"

tests/gold_tests/autest-site/curl.test.ext

@@ -0,0 +1,76 @@
+'''
+Tools to help with TestRun commands
+'''
+#  Licensed to the Apache Software Foundation (ASF) under one
+#  or more contributor license agreements.  See the NOTICE file
+#  distributed with this work for additional information
+#  regarding copyright ownership.  The ASF licenses this file
+#  to you 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.
+
+# Adds "curl" prefix to command argument, with possible curl flags
+#
+# example usage:
+# cmd = '-vs -k https:127.0.0.1:{port}'.format(port = ts.Variables.port)
+#
+# tr = Test.AddTestRun()
+# ps = tr.MakeCurlCommand(cmd)
+# tr.Processes.Default.StartBefore(ts)
+# ts.StartAfter(*ps)
+# tr.StillRunningAfter = ts
+#
+
+
+def spawn_curl_commands(self, cmdstr, count, retcode=0, use_default=True):
+    ret = []
+
+    if self.Variables.get("CurlUds", False):
+        cmdstr = 'curl --unix-socket /tmp/socket ' + cmdstr
+    else:
+        cmdstr = 'curl ' + cmdstr
+    if use_default:
+        count = int(count) - 1
+    for cnt in range(0, count):
+        ret.append(self.Processes.Process(name="cmdline-{num}".format(num=cnt), cmdstr=cmdstr, returncode=retcode))
+    if use_default:
+        self.Processes.Default.Command = cmdstr
+        self.Processes.Default.ReturnCode = retcode
+        self.Processes.Default.StartBefore(*ret)
+    return ret
+
+
+def curl_command(self, cmd, p=None):
+    if p == None:
+        p = self.Processes.Default
+    if self.Variables.get("CurlUds", False):
+        uds_path = os.path.join(p.RunDirectory, 'uds.socket')
+        p.Command = f'curl --unix-socket {uds_path} ' + cmd
+    else:
+        p.Command = 'curl ' + cmd
+    return p
+
+
+def curl_multiple_commands(self, cmd):
+    p = self.Processes.Default
+    if self.Variables.get("CurlUds", False):
+        uds_path = os.path.join(p.RunDirectory, 'uds.socket')
+        p.Command = cmd.format(curl=f'curl --unix-socket {uds_path}')
+    else:
+        p.Command = cmd.format(curl='curl')
+    return p
+
+
+ExtendTestRun(spawn_curl_commands, name="SpawnCurlCommands")
+ExtendTestRun(curl_command, name="MakeCurlCommand")
+ExtendTest(curl_command, name="MakeCurlCommand")
+ExtendTestRun(curl_multiple_commands, name="MakeCurlCommandMulti")
+ExtendTest(curl_multiple_commands, name="MakeCurlCommandMulti")

tests/gold_tests/autest-site/init.cli.ext

@@ -43,3 +43,5 @@ Settings.path_argument(["--ats-bin"], required=True, help="A user provided direc
 Settings.path_argument(["--build-root"], required=False, help="The location of the build root for out of source builds")
 
 Settings.path_argument(["--proxy-verifier-bin"], required=False, help="A location for system proxy-verifier binaries to test with.")
+
+Settings.add_argument(["--curl-uds"], action="store_true", required=False, help="Run all curl commands with --unix-socket flag")

tests/gold_tests/autest-site/setup.cli.ext

@@ -117,6 +117,7 @@ Variables.BuildRoot = ENV['BUILD_ROOT']
 Variables.RepoDir = repo_root
 Variables.AtsTestPluginsDir = os.path.join(Variables.BuildRoot, 'tests', 'tools', 'plugins', '.libs')
 Variables.AtsBuildGoldTestsDir = os.path.join(Variables.BuildRoot, 'tests', 'gold_tests')
+Variables.CurlUds = Arguments.curl_uds
 
 # modify delay times as we always have to kill Trafficserver
 # no need to wait

tests/gold_tests/autest-site/trafficserver.test.ext

@@ -52,6 +52,7 @@ def MakeATSProcess(
         enable_tls=False,
         enable_cache=True,
         enable_quic=False,
+        enable_uds=True,
         block_for_debug=False,
         log_data=default_log_data,
         use_traffic_out=True,
@@ -366,6 +367,10 @@ def MakeATSProcess(
             p.Variables.ssl_port = 4443
             p.Variables.ssl_portv6 = 4444
 
+    # unix domain socket path
+    uds_path = os.path.join(obj.RunDirectory, 'uds.socket')
+    p.Variables.uds_path = uds_path
+
     get_port(p, "manager_port")
     get_port(p, "admin_port")
 
@@ -415,6 +420,10 @@ def MakeATSProcess(
             port_str += f" {p.Variables.proxy_protocol_port}:pp {p.Variables.proxy_protocol_portv6}:pp:ipv6"
             if enable_tls:
                 port_str += f" {p.Variables.proxy_protocol_ssl_port}:pp:ssl {p.Variables.proxy_protocol_ssl_portv6}:pp:ssl:ipv6"
+            if enable_uds:
+                port_str += f" {uds_path}:pp"
+        elif enable_uds:
+            port_str += f" {uds_path}"
         #p.Env['PROXY_CONFIG_HTTP_SERVER_PORTS'] = port_str
         p.Disk.records_config.update({
             'proxy.config.http.server_ports': port_str,

tests/gold_tests/basic/basic.test.py

@@ -25,6 +25,6 @@
 t.StillRunningAfter = Test.Processes.ts
 
 p = t.Processes.Default
-p.Command = "curl http://127.0.0.1:{0}".format(ts.Variables.port)
+t.MakeCurlCommand("http://127.0.0.1:{0}".format(ts.Variables.port))
 p.ReturnCode = 0
 p.StartBefore(Test.Processes.ts)

tests/gold_tests/basic/config.test.py

@@ -26,6 +26,6 @@
 ts.Ready = When.PortOpen(ts.Variables.port)
 t = Test.AddTestRun("Test traffic server started properly")
 t.Processes.Default.StartBefore(ts)
-t.Command = "curl 127.0.0.1:{port}".format(port=ts.Variables.port)
+t.MakeCurlCommand("127.0.0.1:{port}".format(port=ts.Variables.port))
 t.ReturnCode = 0
 t.StillRunningAfter = ts