Merge ~pwlars/testflinger-cli:undo-undo-config into testflinger-cli:master

[Paul Larson]

this is almost identical to the previous config branch, except we found out that the jenkins server where the cli is run from has problems with the current version of xdg, because it uses python3.5.

I'm restricting this to the previous xdg version for now, with a comment about when we can remove the restriction. I've also tested this *on* that system in a virtualenv to confirm it works.

[Sheila Miguez (codersquid)]

lgtm

review: Approve

diff --git a/setup.py b/setup.py
index 736eddc..ce13443 100755
--- a/setup.py
+++ b/setup.py
@@ -1,5 +1,5 @@
 #!/usr/bin/env python
-# Copyright (C) 2017-2019 Canonical
+# Copyright (C) 2017-2020 Canonical
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -16,7 +16,7 @@
 #
 from setuptools import setup
 
-INSTALL_REQUIRES = ['pyyaml', 'requests']
+INSTALL_REQUIRES = ['pyyaml', 'requests', 'xdg<4.0']
 TEST_REQUIRES = []
 
 setup(
@@ -35,4 +35,3 @@ setup(
     ''',
 
 )
-
diff --git a/testflinger_cli/__init__.py b/testflinger_cli/__init__.py
index a0fe783..e647e40 100644
--- a/testflinger_cli/__init__.py
+++ b/testflinger_cli/__init__.py
@@ -22,7 +22,7 @@ import sys
 import time
 
 from argparse import ArgumentParser
-from testflinger_cli import client
+from testflinger_cli import (client, config)
 
 
 # Make it easier to run from a checkout
@@ -42,9 +42,19 @@ def cli():
 class TestflingerCli:
     def __init__(self):
         self.get_args()
-        server = os.environ.get('TESTFLINGER_SERVER') or self.args.server
+        self.config = config.TestflingerCliConfig(self.args.configfile)
+        server = (
+            self.args.server or
+            self.config.get('server') or
+            os.environ.get('TESTFLINGER_SERVER') or
+            'https://testflinger.canonical.com'
+        )
+        # Allow config subcommand without worrying about server or client
+        if hasattr(self.args, 'func') and self.args.func == self.configure:
+            return
         if not server.startswith(('http://', 'https://')):
-            raise SystemExit('Server must start with "http://" or "https://"')
+            raise SystemExit('Server must start with "http://" or "https://" '
+                             '- currently set to: "{}"'.format(server))
         self.client = client.Client(server)
 
     def run(self):
@@ -54,8 +64,9 @@ class TestflingerCli:
 
     def get_args(self):
         parser = ArgumentParser()
-        parser.add_argument('--server',
-                            default='https://testflinger.canonical.com',
+        parser.add_argument('-c', '--configfile', default=None,
+                            help='Configuration file to use')
+        parser.add_argument('--server', default=None,
                             help='Testflinger server to use')
         sub = parser.add_subparsers()
         arg_artifacts = sub.add_parser(
@@ -68,6 +79,10 @@ class TestflingerCli:
             'cancel', help='Tell the server to cancel a specified JOB_ID')
         arg_cancel.set_defaults(func=self.cancel)
         arg_cancel.add_argument('job_id')
+        arg_config = sub.add_parser(
+            'config', help='Get or set configuration options')
+        arg_config.set_defaults(func=self.configure)
+        arg_config.add_argument('setting', nargs='?', help='setting=value')
         arg_list_queues = sub.add_parser(
             'list-queues',
             help='List the advertised queues on the Testflinger server')
@@ -153,6 +168,22 @@ class TestflingerCli:
                              'cancelled.'.format(self.args.job_id, job_state))
         self.client.post_job_state(self.args.job_id, 'cancelled')
 
+    def configure(self):
+        if self.args.setting:
+            setting = self.args.setting.split('=')
+            if len(setting) == 2:
+                self.config.set(*setting)
+                return
+            if len(setting) == 1:
+                print("{} = {}".format(
+                    setting[0], self.config.get(setting[0])))
+                return
+        print("Current Configuration")
+        print("---------------------")
+        for k, v in self.config.data.items():
+            print("{} = {}".format(k, v))
+        print()
+
     def submit(self):
         """Submit a new test job to the server"""
         if self.args.filename == '-':
diff --git a/testflinger_cli/config.py b/testflinger_cli/config.py
new file mode 100644
index 0000000..983699d
--- /dev/null
+++ b/testflinger_cli/config.py
@@ -0,0 +1,47 @@
+# Copyright (C) 2020 Canonical
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program 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 General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+import configparser
+import os
+import xdg
+from collections import OrderedDict
+
+
+class TestflingerCliConfig:
+    def __init__(self, configfile=None):
+        config = configparser.ConfigParser()
+        if not configfile:
+            configfile = os.path.join(
+                xdg.XDG_CONFIG_HOME, "testflinger-cli.conf")
+        config.read(configfile)
+        # Default empty config in case there's no config file
+        self.data = OrderedDict()
+        if 'testflinger-cli' in config.sections():
+            self.data = OrderedDict(config['testflinger-cli'])
+        self.configfile = configfile
+
+    def get(self, key):
+        return self.data.get(key)
+
+    def set(self, key, value):
+        self.data[key] = value
+        self._save()
+
+    def _save(self):
+        config = configparser.ConfigParser()
+        config.read_dict({'testflinger-cli': self.data})
+        with open(self.configfile, 'w') as f:
+            config.write(f)