Merge lp:~fgimenez/qakit/snappy into lp:qakit

[Federico Gimenez]

Updated to work with the new token api authentication. Other fixes:

* config file path
* hardcoded filter id moved to arg
* removed hardcoded field ids (in progress)

You can create a TestSet with:

python3 -m qakit.practitest.report_subunit_results_to_practitest results.subunit create name="testing" device="openstack-amd64" level="Regression" release="15.10" build="mybuild" buildinfo="mybuildinfo"

having a config.ini file in qakit/practitest/config.ini (there's a sample in that directory)

And update it with:

python3 -m qakit.practitest.report_subunit_results_to_practitest results.subunit update --no_ask_confirm $TESTSET_DISPLAY_ID

or, if the system_id is available:

python3 -m qakit.practitest.report_subunit_results_to_practitest results.subunit update --no_ask_confirm --testset_system_id $TESTSET_SYSTEM_ID

[lp:~fgimenez/qakit/snappy]

52. By Federico Gimenez on 2016-04-04

Fixed update test_number argument name; prevented duplicated tests in new test set

53. By Federico Gimenez on 2016-04-04

Extract id from name

54. By Federico Gimenez on 2016-04-04

Do not return 'exists' entries when getting tests by name

55. By Federico Gimenez on 2016-04-04

optional confirm; enabled system_id as param

56. By Federico Gimenez on 2016-04-04

system_id path of execution for updates refactored

57. By Federico Gimenez on 2016-04-05

create action does not require a results file

58. By Federico Gimenez on 2016-04-06

making logger to write to stdout

59. By Federico Gimenez on 2016-04-06

reverted build and buildinfo, added ids

Unmerged revisions

59. By Federico Gimenez on 2016-04-06

reverted build and buildinfo, added ids

58. By Federico Gimenez on 2016-04-06

making logger to write to stdout

57. By Federico Gimenez on 2016-04-05

create action does not require a results file

56. By Federico Gimenez on 2016-04-04

system_id path of execution for updates refactored

55. By Federico Gimenez on 2016-04-04

optional confirm; enabled system_id as param

54. By Federico Gimenez on 2016-04-04

Do not return 'exists' entries when getting tests by name

53. By Federico Gimenez on 2016-04-04

Extract id from name

52. By Federico Gimenez on 2016-04-04

Fixed update test_number argument name; prevented duplicated tests in new test set

51. By Federico Gimenez on 2016-04-01

updated to token auth; added custom_filter_id param; updated field ids (more iterations on this soon)

=== modified file 'qakit/practitest/auth.py'
--- qakit/practitest/auth.py	2015-06-23 14:57:17 +0000
+++ qakit/practitest/auth.py	2016-04-06 13:11:29 +0000
@@ -19,15 +19,12 @@
 import time
 
 
-def compose_headers(api_key, api_secret_key, content_type='application/json'):
-    """Return auth headers incorporating give api key details."""
-    ts = str(int(time.time()))
-    signature = hashlib.md5(
-        (api_key+api_secret_key+ts).encode()).hexdigest()
+def compose_headers(api_token, content_type='application/json'):
+    """Return auth headers incorporating give api token details."""
     auth_header = {
         'Authorization':
-            'custom api_key={}, signature={}, ts={}'.format(
-                api_key, signature, ts)
+            'custom api_token={}'.format(
+                api_token)
     }
     if content_type is not None:
         auth_header['Content-Type'] = content_type

=== modified file 'qakit/practitest/config.ini.sample'
--- qakit/practitest/config.ini.sample	2015-04-15 19:03:17 +0000
+++ qakit/practitest/config.ini.sample	2016-04-06 13:11:29 +0000
@@ -1,6 +1,5 @@
 [DEFAULT]
 PRACTITEST_PROJECT_ID = <PROJECT ID>
-PRACTITEST_API_KEY = <API KEY>
-PRACTITEST_API_SECRET_KEY = <API SECRET KEY>
+PRACTITEST_API_TOKEN = <API TOKEN>
 PRACTITEST_USER_EMAIL = <EMAIL ADDRESS>
 LP_SUBSCRIBE=<LP USER ID>

=== modified file 'qakit/practitest/practisubunit.py'
--- qakit/practitest/practisubunit.py	2015-06-28 13:29:54 +0000
+++ qakit/practitest/practisubunit.py	2016-04-06 13:11:29 +0000
@@ -69,11 +69,7 @@
             # NOTE: this is the expensive operation--need the tests
             # list b/c custom fields appear in the *test* only, need
             # to make a relation between instance and test on name
-            subunit_test_name = \
-                self.practisubunit_session.get_instance_custom_field(
-                    practitest_instance,
-                    'External ID',
-                    practitest_tests)
+            subunit_test_name = practitest_instance['name']
             if subunit_test_name:
                 result['test_name'] = subunit_test_name
                 subunit_result = \

=== modified file 'qakit/practitest/practitest.py'
--- qakit/practitest/practitest.py	2015-11-30 18:24:48 +0000
+++ qakit/practitest/practitest.py	2016-04-06 13:11:29 +0000
@@ -68,21 +68,19 @@
 
 class PractitestSession:
 
-    def __init__(self, project_id, api_key, api_secret_key, user_email=None):
+    def __init__(self, project_id, api_token, user_email=None):
         self.project_id = project_id
-        self.api_key = api_key
-        self.api_secret_key = api_secret_key
+        self.api_token = api_token
         self.user_email = user_email
 
     def pt_field(self, name):
         """Maps PT fields to their IDs"""
-        PT_FIELDS = {'device': 10476,
-                     'level': 10490,
-                    'release': 10433,
-                    'build': 10578,
-                    'buildinfo': 10872,
-                    'external_id': 10589,
-                    'tester': 30429
+        PT_FIELDS = {'device': 17224,
+                     'level': 17221,
+                     'release': 17220,
+                     'build': 17213,
+                     'buildinfo': 17214,
+                     'external_id': 17219
         }
         return '___f_{}'.format(PT_FIELDS[name])
 
@@ -95,15 +93,14 @@
         response = requests.get(
             url=url,
             headers=auth.compose_headers(
-                self.api_key,
-                self.api_secret_key),
+                self.api_token),
             data=json.dumps(params))
         response.raise_for_status()
         return response
 
 
     def _get_all(self, url, params={}):
-    
+
         def needs_new_page(pagination):
             total_read = int(pagination['page']) * int(pagination['limit'])
             return int(pagination['total_entities']) - total_read > 0
@@ -134,7 +131,7 @@
         logging.debug(
             'Posting to {} with data {} and files {}'.format(
                 url, data, files
-            )   
+            )
         )
         content_type = None
         if not files:
@@ -145,8 +142,7 @@
             data=data,
             files=files,
             headers=auth.compose_headers(
-                self.api_key,
-                self.api_secret_key,
+                self.api_token,
                 content_type=content_type
             )
         )
@@ -162,8 +158,7 @@
             url=url,
             data=json.dumps(data),
             headers=auth.compose_headers(
-                self.api_key,
-                self.api_secret_key
+                self.api_token
             )
         )
         return req
@@ -194,7 +189,7 @@
         return self._get(url).json()
 
     def get_testset(self, id):
-        """Return a testset given its id.
+        """Return a testset given its display_id.
 
         See http://support.practitest.com/customer/portal/articles/1140223-testsets-api .  # NOQA
 
@@ -209,9 +204,30 @@
                 raise ValueError("TestSet {} not found!".format(id))
             else:
                 raise
-            
-
-    def create_testset(self, name, priority, device, 
+
+    def get_testset_by_display_id(self, id):
+        return self.get_testset(id)
+
+    def get_testset_by_system_id(self, system_id):
+        display_id = self._get_testset_display_id_by_field('system_id', system_id)
+        return self.get_testset(display_id)
+
+    def _get_testset_display_id_by_field(self, field_name, field_value):
+        """Return a testset display_id given a field name and value.
+
+        See http://support.practitest.com/customer/portal/articles/1140223-testsets-api .  # NOQA
+
+        :param field_name: PractiTest field name.
+        :param field_value: PractiTest field value for the given field name.
+
+        """
+        url = PROD_PRACTITEST + '/sets.json'
+        testsets=self._get(url).json()
+        for testset in testsets['data']:
+            if testset[field_name] == field_value:
+                return testset['display_id']
+
+    def create_testset(self, name, priority, device,
                        level, release, build, buildinfo):
         """
         Create a test set with the name and priority provided.

=== modified file 'qakit/practitest/report_subunit_results_to_practitest.py'
--- qakit/practitest/report_subunit_results_to_practitest.py	2015-09-08 19:35:55 +0000
+++ qakit/practitest/report_subunit_results_to_practitest.py	2016-04-06 13:11:29 +0000
@@ -17,6 +17,7 @@
 
 import argparse
 import configparser
+import logging
 import os
 import sys
 
@@ -28,23 +29,49 @@
                      'Sanity/Mako': '55739',
                      'Web': '55419'}
 
+logger = logging.getLogger(__name__)
+logger.setLevel(logging.INFO)
+stdout_handler = logging.StreamHandler(sys.stdout)
+logger.addHandler(stdout_handler)
 
 def _parse_arguments():
     """Parse command-line args, returning an argparse dict."""
     parser = argparse.ArgumentParser(
         'Report subunit suite results to Practitest.')
-    parser.add_argument('filepath', help='subunit result filepath')
     subparsers = parser.add_subparsers()
     update_parser = subparsers.add_parser(
         'update',
         help='Update an existing test set with results'
     )
     update_parser.add_argument(
-        'number',
-        type=int,
-        help='PractiTest TestSet #'
-    )
-    update_parser.set_defaults(func=_update_testset)
+        'testset_display_id',
+        default=0,
+        nargs='?',
+        type=int,
+        help='PractiTest TestSet display id',
+    )
+    update_parser.add_argument(
+        '--testset_system_id',
+        type=int,
+        help='PractiTest TestSet system id'
+    )
+    update_parser.add_argument(
+        '--ask_confirm',
+        dest='ask_confirm',
+        action='store_true',
+        help='Ask confirmation for uploading results'
+    )
+    update_parser.add_argument(
+        '--no_ask_confirm',
+        dest='ask_confirm',
+        action='store_false',
+        help='Ask confirmation for uploading results'
+    )
+    update_parser.add_argument(
+        'filepath',
+        help='subunit result filepath'
+    )
+    update_parser.set_defaults(func=_update_testset, ask_confirm=True)
     create_parser = subparsers.add_parser(
         'create',
         help='Create a new testset with the results'
@@ -74,6 +101,10 @@
         help='The output of system-image-cli -i',
     )
     create_parser.add_argument(
+        '--custom_filter_id',
+        help='Custom test filter, if any',
+    )
+    create_parser.add_argument(
         '--manual', '-m',
         help='Add the manual tests for the specified domain '
              'to the test set as well.'
@@ -82,7 +113,7 @@
     return parser.parse_args()
 
 
-def _confirm_name_of_testset(practitest_testset_number,
+def _confirm_name_of_testset(practitest_testset_display_id,
                              practitest_session):
     """Double-check the name and assigned tester of the numbered TestSet.
 
@@ -90,11 +121,11 @@
     wrong TestSet, e.g.
 
     """
-    testset = practitest_session.get_testset(practitest_testset_number)
+    testset = practitest_session.get_testset(practitest_testset_display_id)
     confirmation = input(
         ("TestSet {}: '{}', assigned to {}--"
          "upload test results (Y/n)? ").format(
-             practitest_testset_number,
+             practitest_testset_display_id,
              testset['name'],
              testset['assigned_to']['value']))
     return confirmation != 'n'
@@ -119,28 +150,32 @@
     config_file.read(config_filepath)
     config = {}
     for var_name in ('PRACTITEST_PROJECT_ID',
-                     'PRACTITEST_API_KEY',
-                     'PRACTITEST_API_SECRET_KEY'):
+                     'PRACTITEST_API_TOKEN'):
         new_var_name = var_name.lower().replace('practitest_', '')
         config[new_var_name] = _read_config_for_var(var_name,
                                                     config_file)
     return config
 
 
-def _create_testset(args, practisubunit_session, results):
+def _create_testset(args, practisubunit_session):
     testset = practisubunit_session.create_testset(
         args.name, 'medium',
         args.device, args.level,
         args.release, args.build,
         args.buildinfo
     )
-    _create_instances(results, testset, practisubunit_session,
-                      args.manual)
+    _create_instances(testset, practisubunit_session,
+                      args.custom_filter_id, args.manual)
     return testset
 
-def _update_testset(args, practisubunit_session):
-    _confirm_name_of_testset(args.testset_number, practisubunit_session)
-    testset = practisubunit_session.get_testset(args.testset_number)
+def _update_testset(args, practisubunit_session, results):
+    if args.ask_confirm:
+        _confirm_name_of_testset(args.testset_display_id, practisubunit_session)
+
+    if args.testset_display_id != 0:
+        testset = practisubunit_session.get_testset_by_display_id(args.testset_display_id)
+    else:
+        testset = practisubunit_session.get_testset_by_system_id(args.testset_system_id)
     return testset
 
 def _report_to_practitest(project_id, testset, practisubunit_session, results):
@@ -156,7 +191,7 @@
         )
     )
 
-def _create_instances(results, testset, session, manual=None):
+def _create_instances(testset, session, custom_filter_id, manual=None):
     # First get all the automated tests in PractiTest
     # 57803 is the ID of the 'Automated' filter
     instances = []
@@ -165,16 +200,8 @@
         manual_ids = [test['system_id'] for test in tests]
         instances.extend(manual_ids)
     else:
-        tests = session.get_tests(filter_id='57803')
-        external_ids = [test[session.pt_field('external_id')]['value']
-                        for test in tests]
-        for test in results:
-            try:
-                instances.append(
-                    tests[external_ids.index(test['id'])]['system_id']
-                )
-            except ValueError:
-                continue
+        instances = [test['system_id'] for test in session.get_tests(
+            filter_id=custom_filter_id)]
 
     session.create_instances(testset['id'], instances)
 
@@ -182,12 +209,22 @@
 def main():
     args = _parse_arguments()
     config = _read_config(
-        os.path.join(os.path.dirname(__name__),
+        os.path.join(os.path.dirname(__file__),
                      'config.ini'))
     practisubunit_session = practisubunit.PractiSubunitSession(**config)
-    results = subunit_results.parse(args.filepath)
-    testset = args.func(args, practisubunit_session, results)
-    _report_to_practitest(config['project_id'], testset, practisubunit_session, results)
+    if args.func.__name__ == '_create_testset':
+        testset=_create_testset(args, practisubunit_session)
+        logger.info(
+            'Created TestSet with display_id {}'.format(testset['id']))
+    else:
+        results = subunit_results.parse(args.filepath)
+        testset = _update_testset(args, practisubunit_session, results)
+        _report_to_practitest(
+            config['project_id'],
+            testset,
+            practisubunit_session,
+            results
+        )
 
 if __name__ == '__main__':
     sys.exit(main())

=== modified file 'qakit/practitest/subunit_results.py'
--- qakit/practitest/subunit_results.py	2015-04-15 19:03:17 +0000
+++ qakit/practitest/subunit_results.py	2016-04-06 13:11:29 +0000
@@ -38,6 +38,6 @@
 def get_subunit_test_by_name(test_name, subunit_results):
     """Returns the named test from the given subunit suite."""
     for result in subunit_results:
-        if result['id'] == test_name:
+        if result['id'] == test_name and result['status'] != 'exists':
             return result
     return None