ftests: Add cgget invalid parameter test

Add a cgget test that passes in various invalid parameter
combinations.

-----------------------------------------------------------------
Test Results:
        Run Date:                          Feb 09 23:24:14
        Passed:                                  1 test(s)
        Skipped:                                 0 test(s)
        Failed:                                  0 test(s)
-----------------------------------------------------------------
Timing Results:
        Test                                    Time (sec)
        ---------------------------------------------------------
        setup                                        18.89
        016-cgget-invalid_options.py                  0.93
        teardown                                      0.00
        ---------------------------------------------------------
        Total Run Time                               19.82

Signed-off-by: Tom Hromatka <tom.hromatka@oracle.com>

diff --git a/ftests/016-cgget-invalid_options.py b/ftests/016-cgget-invalid_options.py
new file mode 100755 (executable)
index 0000000..80ecc43
--- /dev/null
+++ b/ftests/016-cgget-invalid_options.py
@@ -0,0 +1,203 @@
+#!/usr/bin/env python3
+#
+# Advanced cgget functionality test - multiple '-g' flags
+#
+# Copyright (c) 2021 Oracle and/or its affiliates.
+# Author: Tom Hromatka <tom.hromatka@oracle.com>
+#
+
+#
+# This library is free software; you can redistribute it and/or modify it
+# under the terms of version 2.1 of the GNU Lesser General Public License as
+# published by the Free Software Foundation.
+#
+# This library is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License
+# for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this library; if not, see <http://www.gnu.org/licenses>.
+#
+
+from cgroup import Cgroup, CgroupVersion
+import consts
+import ftests
+import os
+from run import RunError
+import sys
+
+CONTROLLER = 'cpu'
+CGNAME = '016cgget'
+
+def prereqs(config):
+    result = consts.TEST_PASSED
+    cause = None
+
+    # Github Actions has issues with cgget and the code coverage profiler.
+    # This causes issues with the error handling of this test
+    if not config.args.container:
+        result = consts.TEST_SKIPPED
+        cause = "This test cannot be run outside of a container"
+        return result, cause
+
+    return result, cause
+
+def setup(config):
+    Cgroup.create(config, CONTROLLER, CGNAME)
+
+def test(config):
+    result = consts.TEST_PASSED
+    cause = None
+
+    try:
+        # cgget -g cpu
+        Cgroup.get(config, controller=CONTROLLER)
+    except RunError as re:
+        if not "Wrong input parameters," in re.stderr:
+            result = consts.TEST_FAILED
+            cause = "#1 Expected 'Wrong input parameters' to be in stderr"
+            return result, cause
+
+        if re.ret != 255:
+            result = consts.TEST_FAILED
+            cause = "#1 Expected return code of 255 but received {}".format(re.ret)
+            return result, cause
+    else:
+        result = consts.TEST_FAILED
+        cause = "Test case #1 erroneously passed"
+        return result, cause
+
+    try:
+        # cgget -g cpu:016cgget 016cgget
+        Cgroup.get(config, controller="{}:{}".format(CONTROLLER, CGNAME),
+                   cgname=CGNAME)
+    except RunError as re:
+        if not "Wrong input parameters," in re.stderr:
+            result = consts.TEST_FAILED
+            cause = "#2 Expected 'Wrong input parameters' to be in stderr"
+            return result, cause
+
+        if re.ret != 255:
+            result = consts.TEST_FAILED
+            cause = "#2 Expected return code of 255 but received {}".format(re.ret)
+            return result, cause
+    else:
+        result = consts.TEST_FAILED
+        cause = "Test case #2 erroneously passed"
+        return result, cause
+
+    try:
+        # cgget -r invalidsetting 016cgget
+        Cgroup.get(config, setting="invalidsetting", cgname=CGNAME,
+                   print_headers=False, values_only=True)
+    except RunError as re:
+        if not "cgget: error parsing parameter name" in re.stderr:
+            result = consts.TEST_FAILED
+            cause = "#3 Expected 'cgget: error parsing parameter name' to be in stderr"
+            return result, cause
+
+        # legacy cgget returns 0 but populates stderr for this case.
+        # This feels wrong, so the updated cgget returns ECGINVAL
+        if re.ret != 91 and re.ret != 0:
+            result = consts.TEST_FAILED
+            cause = "#3 Expected return code of 0 or 91 but received {}".format(
+                    re.ret)
+            return result, cause
+    else:
+        result = consts.TEST_FAILED
+        cause = "Test case #3 erroneously passed"
+        return result, cause
+
+    try:
+        # cgget -r invalid.setting 016cgget
+        Cgroup.get(config, setting="invalid.setting", cgname=CGNAME,
+                   print_headers=False, values_only=True)
+    except RunError as re:
+        if not "cgget: cannot find controller" in re.stderr:
+            result = consts.TEST_FAILED
+            cause = "#4 Expected 'cgget: cannot find controller' to be in stderr"
+            return result, cause
+
+        # legacy cgget returns 0 but populates stderr for this case.
+        # This feels wrong, so the updated cgget returns ECGOTHER
+        if re.ret != 96 and re.ret != 0:
+            result = consts.TEST_FAILED
+            cause = "#4 Expected return code of 0 or 96 but received {}".format(
+                    re.ret)
+            return result, cause
+    else:
+        result = consts.TEST_FAILED
+        cause = "Test case #4 erroneously passed"
+        return result, cause
+
+    try:
+        # cgget -r cpu.invalid 016cgget
+        Cgroup.get(config, setting="{}.invalid".format(CONTROLLER),
+                   cgname=CGNAME, print_headers=False, values_only=True)
+    except RunError as re:
+        if not "variable file read failed" in re.stderr:
+            result = consts.TEST_FAILED
+            cause = "#5 Expected 'variable file read failed' to be in stderr"
+            return result, cause
+
+        # legacy cgget returns 0 but populates stderr for this case.
+        # This feels wrong, so the updated cgget returns ECGOTHER
+        if re.ret != 96 and re.ret != 0:
+            result = consts.TEST_FAILED
+            cause = "#5 Expected return code of 0 or 96 but received {}".format(
+                    re.ret)
+            return result, cause
+    else:
+        result = consts.TEST_FAILED
+        cause = "Test case #5 erroneously passed"
+        return result, cause
+
+    try:
+        # cgget with no parameters
+        Cgroup.get(config, controller=None, cgname=None, setting=None,
+                   print_headers=True, values_only=False,
+                   all_controllers=False, cghelp=False)
+    except RunError as re:
+        if not "Wrong input parameters," in re.stderr:
+            result = consts.TEST_FAILED
+            cause = "#6 Expected 'Wrong input parameters' to be in stderr"
+            return result, cause
+
+        if re.ret != 1:
+            result = consts.TEST_FAILED
+            cause = "#6 Expected return code of 1 but received {}".format(re.ret)
+            return result, cause
+    else:
+        result = consts.TEST_FAILED
+        cause = "Test case #6 erroneously passed"
+        return result, cause
+
+    # cgget -h
+    ret = Cgroup.get(config, cghelp=True)
+    if not "Print parameter(s)" in ret:
+        result = consts.TEST_FAILED
+        cause = "#7 Failed to print help text"
+        return result, cause
+
+    return result, cause
+
+def teardown(config):
+    Cgroup.delete(config, CONTROLLER, CGNAME)
+
+def main(config):
+    [result, cause] = prereqs(config)
+    if result != consts.TEST_PASSED:
+        return [result, cause]
+
+    setup(config)
+    [result, cause] = test(config)
+    teardown(config)
+
+    return [result, cause]
+
+if __name__ == '__main__':
+    config = ftests.parse_args()
+    # this test was invoked directly.  run only it
+    config.args.num = int(os.path.basename(__file__).split('-')[0])
+    sys.exit(ftests.main(config))