[cli] Allow to read args from files

Gauvain Pocentek · Gauvain Pocentek · commit 748d57ee6403 · 2018-03-05T17:35:41.000+01:00
With the @/file/path syntax (similar to curl) user can provide values from attributes in files. Fixes #448
diff --git a/docs/cli.rst b/docs/cli.rst
@@ -158,7 +158,6 @@ Example:
 
    $ gitlab -o yaml -f id,permissions -g elsewhere -c /tmp/gl.cfg project list
 
-
 Examples
 ========
 
@@ -235,3 +234,18 @@ Use sudo to act as another user (admin only):
 .. code-block:: console
 
    $ gitlab project create --name user_project1 --sudo username
+
+Reading values from files
+-------------------------
+
+You can make ``gitlab`` read values from files instead of providing them on the
+command line. This is handy for values containing new lines for instance:
+
+.. code-block:: console
+
+   $ cat > /tmp/description << EOF
+   This is the description of my project.
+
+   It is obviously the best project around
+   EOF
+   $ gitlab project create --name SuperProject --description @/tmp/description
diff --git a/gitlab/cli.py b/gitlab/cli.py
@@ -114,6 +114,19 @@ def _get_parser(cli_module):
     return cli_module.extend_parser(parser)
 
 
+def _parse_value(v):
+    if isinstance(v, str) and v.startswith('@'):
+        # If the user-provided value starts with @, we try to read the file
+        # path provided after @ as the real value. Exit on any error.
+        try:
+            return open(v[1:]).read()
+        except Exception as e:
+            sys.stderr.write("%s\n" % e)
+            sys.exit(1)
+
+    return v
+
+
 def main():
     if "--version" in sys.argv:
         print(gitlab.__version__)
@@ -143,7 +156,7 @@ def main():
     for item in ('gitlab', 'config_file', 'verbose', 'debug', 'what', 'action',
                  'version', 'output'):
         args.pop(item)
-    args = {k: v for k, v in args.items() if v is not None}
+    args = {k: _parse_value(v) for k, v in args.items() if v is not None}
 
     try:
         gl = gitlab.Gitlab.from_config(gitlab_id, config_files)
diff --git a/gitlab/tests/test_cli.py b/gitlab/tests/test_cli.py
@@ -20,6 +20,8 @@
 from __future__ import absolute_import
 
 import argparse
+import os
+import tempfile
 
 import six
 try:
@@ -52,6 +54,29 @@ def test_die(self):
 
         self.assertEqual(test.exception.code, 1)
 
+    def test_parse_value(self):
+        ret = cli._parse_value('foobar')
+        self.assertEqual(ret, 'foobar')
+
+        ret = cli._parse_value(True)
+        self.assertEqual(ret, True)
+
+        ret = cli._parse_value(1)
+        self.assertEqual(ret, 1)
+
+        ret = cli._parse_value(None)
+        self.assertEqual(ret, None)
+
+        fd, temp_path = tempfile.mkstemp()
+        os.write(fd, b'content')
+        os.close(fd)
+        ret = cli._parse_value('@%s' % temp_path)
+        self.assertEqual(ret, 'content')
+        os.unlink(temp_path)
+
+        with self.assertRaises(SystemExit):
+            cli._parse_value('@/thisfileprobablydoesntexist')
+
     def test_base_parser(self):
         parser = cli._get_base_parser()
         args = parser.parse_args(['-v', '-g', 'gl_id',
diff --git a/tools/cli_test_v4.sh b/tools/cli_test_v4.sh
@@ -108,5 +108,16 @@ testcase "application settings get" '
 '
 
 testcase "application settings update" '
-    GITLAB application-settings update --signup-enabled false
+    GITLAB application-settings update --signup-enabled false >/dev/null 2>&1
+'
+
+cat > /tmp/gitlab-project-description << EOF
+Multi line
+
+Data
+EOF
+testcase "values from files" '
+    OUTPUT=$(GITLAB -v project create --name fromfile \
+            --description @/tmp/gitlab-project-description)
+    echo $OUTPUT | grep -q "Multi line"
 '
