From e2e8f02165f27ae04e6d20ce0c628e29271a8db6 Mon Sep 17 00:00:00 2001
From: Paul Vinciguerra <pvinci@vinciconsulting.com>
Date: Sun, 17 Mar 2019 07:17:03 -0700
Subject: tests: Deprecate the use of CLI commands in tests.

Since the stated policy regarding CLI commands is:
  "Note that the debug CLI is a developer's tool
   - no warranty express or implied - and that
   we may choose not to fix debug CLI bugs.",

this change emits a deprecation warning whenever a test case calls a CLI command.

Change-Id: I91b30e86ae1b2fca36732837f36cdda762cdf458
Signed-off-by: Paul Vinciguerra <pvinci@vinciconsulting.com>
---
 test/Makefile             | 2 +-
 test/vpp_papi_provider.py | 5 +++++
 2 files changed, 6 insertions(+), 1 deletion(-)

(limited to 'test')

diff --git a/test/Makefile b/test/Makefile
index f78c8a8ca69..e5e63d7afe5 100644
--- a/test/Makefile
+++ b/test/Makefile
@@ -111,7 +111,7 @@ $(PAPI_INSTALL_DONE): $(PIP_PATCH_DONE)
 	@touch $@
 
 define retest-func
-@env FORCE_FOREGROUND=$(FORCE_FOREGROUND) FAILED_DIR=$(FAILED_DIR) VENV_PATH=$(VENV_PATH) scripts/setsid_wrapper.sh $(FORCE_FOREGROUND) $(VENV_PATH)/bin/activate $(PYTHON_INTERP) $(PYTHON_PROFILE_OPTS) run_tests.py -d $(TEST_DIR) $(UNITTEST_EXTRA_OPTS) || env FAILED_DIR=$(FAILED_DIR) COMPRESS_FAILED_TEST_LOGS=$(COMPRESS_FAILED_TEST_LOGS) scripts/compress_failed.sh
+@env FORCE_FOREGROUND=$(FORCE_FOREGROUND) FAILED_DIR=$(FAILED_DIR) VENV_PATH=$(VENV_PATH) scripts/setsid_wrapper.sh $(FORCE_FOREGROUND) $(VENV_PATH)/bin/activate $(PYTHON_INTERP) -Wd $(PYTHON_PROFILE_OPTS) run_tests.py -d $(TEST_DIR) $(UNITTEST_EXTRA_OPTS) || env FAILED_DIR=$(FAILED_DIR) COMPRESS_FAILED_TEST_LOGS=$(COMPRESS_FAILED_TEST_LOGS) scripts/compress_failed.sh
 endef
 
 .PHONY: sanity
diff --git a/test/vpp_papi_provider.py b/test/vpp_papi_provider.py
index bce8336de05..98fbb2f9723 100644
--- a/test/vpp_papi_provider.py
+++ b/test/vpp_papi_provider.py
@@ -9,8 +9,10 @@ import os
 import time
 from collections import deque
 
+import deprecation
 from six import moves, iteritems
 from vpp_papi import VPP, mac_pton
+
 from hook import Hook
 from vpp_l2 import L2_PORT_TYPE
 
@@ -390,6 +392,9 @@ class VppPapiProvider(object):
         self.hook.after_api(api_fn.__name__, api_args)
         return reply
 
+    @deprecation.deprecated(
+        deprecated_in="19.04", removed_in="19.07",
+        details="Use the Corresponding API function instead.")
     def cli(self, cli):
         """ Execute a CLI, calling the before/after hooks appropriately.
 
-- 
cgit 1.2.3-korg