Merge lp:~canonical-platform-qa/qakit/test-library-gathering into lp:qakit

[Allan LeSage]

Gather test library data from PractiTest and deposit in a mongodb database.

Gather test library data from PractiTest and deposit in a mongodb database.

[Christopher Lee (veebers)]

Looking good, some comments inline.

review: Needs Fixing

[lp:~canonical-platform-qa/qakit/test-library-gathering]

25. By Allan LeSage on 2015-10-29

Deshebangify.

26. By Allan LeSage on 2015-10-29

Don't return anything when updating a test.

[Allan LeSage (allanlesage)]

Thanks, addressed.

[Christopher Lee (veebers)]

LGTM, thanks for the changes.

review: Approve

=== added file 'qakit/metrics/practitest/tests.py'
--- qakit/metrics/practitest/tests.py	1970-01-01 00:00:00 +0000
+++ qakit/metrics/practitest/tests.py	2015-10-29 22:30:08 +0000
@@ -0,0 +1,71 @@
+# UESQA Metrics
+# Copyright (C) 2015 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 datetime
+import logging
+import multiprocessing
+import time
+
+from qakit.practitest.practitest import practitest_time_to_datetime
+
+logger = logging.getLogger(__name__)
+
+
+def record_test_history(db, test):
+    """Make an entry in our test history, appending the time.
+
+    :param db: a MongoClient collection in which PractiTest data is stored
+    :param test: a PractiTest test dict
+
+    """
+    db.test_history.insert(
+        dict({'datetime': datetime.datetime.now()}, **test))
+
+
+def update_test(db, practitest_session, test):
+    """Update a test from PractiTest, depositing it in our db.
+
+    :param db: a MongoClient collection in which PractiTest data is stored
+    :param practitest_session: a PractiTestSession
+    :param test: a PractiTest test dict
+
+    """
+    logger.debug("Retrieving test {}".format(test['system_id']))
+    try:
+        test = practitest_session.get_test(test['display_id'])
+    except ValueError:
+        logger.warn("Test {} not found.".format(test['system_id']))
+    # while we're at it make an entry in our test history collection
+    record_test_history(db, test)
+    db.tests.update(
+        {'system_id': test['system_id']},
+        test,
+        upsert=True)
+
+
+def update_tests(db, practitest_session):
+    """Update our db with all tests from PractiTest.
+
+    :param db: a MongoClient collection in which PractiTest data is stored
+    :param practitest_session: a PractiTestSession
+
+    """
+    logger.info("Retrieving tests from PractiTest.")
+    # get_tests returns a list of tests in brief, with no custom fields
+    tests = practitest_session.get_tests()
+    # . . . so we have to get each in detail
+    for test in tests:
+        update_test(db, practitest_session, test)

=== added file 'qakit/metrics/test_library.py'
--- qakit/metrics/test_library.py	1970-01-01 00:00:00 +0000
+++ qakit/metrics/test_library.py	2015-10-29 22:30:08 +0000
@@ -0,0 +1,58 @@
+#!/usr/bin/python3
+# UESQA Metrics
+# Copyright (C) 2015 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 logging
+import sys
+
+import pymongo
+
+import qakit.config as config
+import qakit.metrics.practitest.tests as tests
+import qakit.metrics.util as util
+import qakit.practitest.practitest as practitest
+
+logger = logging.getLogger(__name__)
+
+
+def update_test_library_data(db, practitest_session):
+    """Update PractiTest test library data.
+
+    :param db: a MongoClient database in which PractiTest data is stored
+    :param practitest_session: a PractiTestSession
+
+    """
+    tests.update_tests(db, practitest_session)
+
+
+def main():
+    util.setup_logging()
+    config_dict = util.read_config(config.get_config_file_location())
+    conn = pymongo.MongoClient()
+    db = conn.metrics
+    practitest_session = practitest.PractitestSession(
+        config_dict['project_id'],
+        config_dict['api_key'],
+        config_dict['api_secret_key'])
+    update_test_library_data(db, practitest_session)
+
+
+if __name__ == '__main__':
+    try:
+        sys.exit(main())
+    except Exception as e:
+        logger.error(e, exc_info=True)

=== added file 'qakit/metrics/tests/test_practitest_tests.py'
--- qakit/metrics/tests/test_practitest_tests.py	1970-01-01 00:00:00 +0000
+++ qakit/metrics/tests/test_practitest_tests.py	2015-10-29 22:30:08 +0000
@@ -0,0 +1,112 @@
+# UESQA Metrics
+# Copyright (C) 2015 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 datetime
+import unittest
+from unittest import mock
+
+from bson import ObjectId
+
+import qakit.metrics.practitest.tests as tests
+
+
+TEST = {
+    "___f_10489": {
+        "value": "High",
+        "name": "Test Priority"
+    },
+    "description": "",
+    "system_id": 423394,
+    "___f_10589": {
+        "value": "ubuntu_system_tests.tests.test_tutorial.TutorialTestCase.test_complete_tutorial",
+        "name": "External ID"
+    },
+    "tags": {
+        "value": "",
+        "name": "Tags (comma separated)"
+    },
+    "___f_10484": {
+        "value": None,
+        "name": "Application"
+    },
+    "author": {
+        "value": "iahmad",
+        "name": "Author"
+    },
+    "test_status": {
+        "value": "Ready",
+        "name": "Status"
+    },
+    "___f_10476": {
+        "value": "[\"Krillin\", \"Mako\", \"Emulator\"]",
+        "name": "Devices"
+    },
+    "created_at": {
+        "value": "19-May-2015  22:21",
+        "name": "Created"
+    },
+    "___f_12587": {
+        "value": "[\"Phone\"]",
+        "name": "ProductType"
+    },
+    "___f_10474": {
+        "value": "[\"UI & Graphics\"]",
+        "name": "Test Domain"
+    },
+    "run_status": {
+        "value": "FAILED",
+        "name": "Run Status"
+    },
+    "name": "Complete Edges Intro",
+    "___f_10475": {
+        "value": "Ubuntu",
+        "name": "Image Part"
+    },
+    "___f_10662": {
+        "value": None,
+        "name": "LP Bugs"
+    },
+    "id": 560,
+    "last_run": {
+        "value": "20-Oct-2015  01:11",
+        "name": "Last Run"
+    },
+    "updated_at": {
+        "value": "09-Sep-2015  10:35",
+        "name": "Last Modified"
+    },
+    "___f_10433": {
+        "value": "[\"14.10\"]",
+        "name": "Release"
+    },
+    "___f_10665": {
+        "value": "no",
+        "name": "Automation Backlog"
+    },
+    "___f_10490": {
+        "value": "Sanity",
+        "name": "Test Level"
+    }
+}
+
+
+class RecordTestHistoryTestCase(unittest.TestCase):
+
+    def test_inserts(self):
+        insert = mock.Mock()
+        db = mock.Mock(test_history=mock.Mock(insert=insert))
+        tests.record_test_history(db, TEST)
+        self.assertTrue(insert.called)

=== added file 'qakit/metrics/tests/test_test_library.py'
--- qakit/metrics/tests/test_test_library.py	1970-01-01 00:00:00 +0000
+++ qakit/metrics/tests/test_test_library.py	2015-10-29 22:30:08 +0000
@@ -0,0 +1,30 @@
+# UESQA Metrics
+# Copyright (C) 2015 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 unittest
+from unittest import mock
+
+import qakit.metrics.test_library as test_library
+
+
[e-mail]('qakit.metrics.practitest.tests.update_tests')
+class TestLibraryTestCase(unittest.TestCase):
+
+    def test_update_test_library_data(self, mock_update_tests):
+        test_library.update_test_library_data(
+            'fake-db', 'fake-practitest-session')
+        mock_update_tests.assert_called_with(
+            'fake-db', 'fake-practitest-session')

=== modified file 'qakit/metrics/util.py'
--- qakit/metrics/util.py	2015-10-08 17:51:52 +0000
+++ qakit/metrics/util.py	2015-10-29 22:30:08 +0000
@@ -15,6 +15,7 @@
 # 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 functools
 import sys
 import time
@@ -79,3 +80,20 @@
 def get_week_number(datetime_):
     """Return the week of the year from a datetime."""
     return int(datetime_.strftime('%W'))
+
+
+def read_config(config_filepath):
+    """Parse the config at the given filepath, returning a config dict.
+
+    :param config_filepath: the filepath to a configuration file
+
+    """
+    config_file = configparser.ConfigParser()
+    config_file.read(config_filepath)
+    config = {}
+    for var_name in ('PRACTITEST_PROJECT_ID',
+                     'PRACTITEST_API_KEY',
+                     'PRACTITEST_API_SECRET_KEY'):
+        new_var_name = var_name.lower().replace('practitest_', '')
+        config[new_var_name] = config_file['DEFAULT'][var_name]
+    return config