Merge pull request #349 from ARMmbed/revert-341-online_plat_db_updates

Revert "Adding a --update command for pulling new target defintions from online"

Author: theotherjimmy

mbed_lstools/main.py

@@ -26,8 +26,6 @@
 
 # Make sure that any global generic setup is run
 from . import lstools_base
-from .platform_database import DEFAULT_UPDATE_URL, RemotePlatformDataException,\
-                               DatabaseUpdateException
 
 import logging
 logger = logging.getLogger("mbedls.main")
@@ -132,44 +130,6 @@ def mock_platform(mbeds, args):
         else:
             logger.error("Could not parse mock from token: '%s'", token)
 
-def update_from_web(mbeds, args):
-    try:
-        print("Fetching platform data from %s..." % args.update_url)
-        update_info = mbeds.plat_db.update_from_web(args.update_url)
-    except (RemotePlatformDataException, DatabaseUpdateException):
-        logger.error(
-            "Failed to update the platform database. For more information, "
-            "run with \"--debug\"."
-        )
-        return 1
-
-    rows = []
-
-    if update_info["new"]:
-        for target_id, platform_name in update_info["new"].items():
-            rows.append([target_id, platform_name])
-
-    if update_info["updated"]:
-        for target_id, info in update_info["updated"].items():
-            rows.append([target_id, "%s -> %s" % (info["old"], info["new"])])
-
-    if rows:
-        from prettytable import PrettyTable
-        columns = ["target_id", "platform_name"]
-        pt = PrettyTable(columns)
-        pt.align = 'l'
-
-        for row in rows:
-            pt.add_row(row)
-
-        print(pt.get_string(
-            border=True, header=True, padding_width=1,
-            sortby='target_id'
-        ))
-        print("The platform database was updated.")
-    else:
-        print("Platform database up-to-date.")
-
 def list_platforms(mbeds, args):
     print(mbeds.list_manufacture_ids())
 
@@ -244,10 +204,6 @@ def parse_cli(to_parse):
         '-m', '--mock', metavar='ID:NAME',
         help='substitute or create a target ID to platform name mapping used'
         'when invoking mbedls in the current directory')
-    commands.add_argument(
-        '-U', '--update', nargs='?', default=False,
-        const=DEFAULT_UPDATE_URL, dest='update_url',
-        help='update the platform database from a URL (default: %s)' % (DEFAULT_UPDATE_URL))
 
     parser.add_argument(
         '--skip-retarget', dest='skip_retarget', default=False,
@@ -265,8 +221,6 @@ def parse_cli(to_parse):
     args = parser.parse_args(to_parse)
     if args.mock:
         args.command = mock_platform
-    elif args.update_url:
-        args.command = update_from_web
     return args
 
 def start_logging():

mbed_lstools/platform_database.py

@@ -20,7 +20,6 @@
 import datetime
 import json
 import re
-import requests
 from collections import OrderedDict, defaultdict
 from copy import copy
 from io import open
@@ -42,7 +41,6 @@
 
 LOCAL_PLATFORM_DATABASE = join(user_data_dir("mbedls"), "platforms.json")
 LOCAL_MOCKS_DATABASE = join(user_data_dir("mbedls"), "mock.json")
-DEFAULT_UPDATE_URL = "https://os.mbed.com/api/v3/platforms/?format=json"
 
 DEFAULT_PLATFORM_DB = {
     u'daplink': {
@@ -364,14 +362,6 @@ def _overwrite_or_open(db):
             return {}
 
 
-class RemotePlatformDataException(Exception):
-    pass
-
-
-class DatabaseUpdateException(Exception):
-    pass
-
-
 class PlatformDatabase(object):
     """Represents a union of multiple platform database files.
     Handles inter-process synchronization of database files.
@@ -492,102 +482,3 @@ def remove(self, id, permanent=False, device_type='daplink', verbose_data=False)
                     self._update_db()
 
                 return _modify_data_format(removed, verbose_data)
-
-    def update_from_web(self, url=DEFAULT_UPDATE_URL):
-        """Update entries in the platform database from the API on the Mbed website.
-
-        If the update fails to contact the provided url, a `ConnectionError` will
-        be raised (part of the `requests` library). If it fails during the web
-        request or JSON parsing, a `RemotePlatformDataException` is raised.
-        If it fails during the write to the filesystem, a `DatabaseUpdateException`
-        is raised.
-
-        Returns dictionary of all updates that occurred in the following format:
-            {
-                "new": {
-                    "<target id>": "<platform name>",
-                    ...
-                },
-                "updated": {
-                    "<target id>": {
-                        "old": "<previous platform name>",
-                        "new": "<new platform name>"
-                    }
-                }
-            }
-        """
-        r = requests.get(url)
-        try:
-            platform_data = r.json()
-        except ValueError as e:
-            logger.debug("Failed to retrieve platform data from os.mbed.com.")
-            logger.debug(e)
-            logger.debug("Received the following response:")
-            logger.debug("Status code: %d", r.status_code)
-            logger.debug(r.text)
-            raise RemotePlatformDataException()
-
-        try:
-            """Expected JSON format is as follows:
-            [
-                {
-                    "productcode": "1234",
-                    "logicalboard": {
-                        "name": "boardname"
-                    }
-                },
-                ...
-            ]
-            """
-            web_platforms = {
-                v['productcode']: v['logicalboard']['name'].upper() for v in platform_data
-            }
-        except KeyError as e:
-            logger.debug("Platform data had unexpected format.")
-            logger.debug(e)
-            logger.debug("Received platform data:")
-            logger.debug(platform_data)
-            raise RemotePlatformDataException()
-
-        current_platforms = {
-            k: v
-            for (k, v) in self.items()
-        }
-
-        web_platform_keys = set(web_platforms.keys())
-        current_platform_keys = set(current_platforms.keys())
-
-        new_platform_ids = web_platform_keys - current_platform_keys
-        new_platforms = {
-            id: web_platforms[id]
-            for id in new_platform_ids
-        }
-
-        shared_platform_ids = web_platform_keys.intersection(current_platform_keys)
-
-        updated_platforms_history = {
-            id: {
-                "old": current_platforms[id],
-                "new": web_platforms[id]
-            }
-            for id in shared_platform_ids if web_platforms[id] != current_platforms[id]
-        }
-
-        updated_platforms = {
-            id: platform["new"]
-            for id, platform in updated_platforms_history.items()
-        }
-
-        all_updates = new_platforms.copy()
-        all_updates.update(updated_platforms)
-
-        for id, platform_name in all_updates.items():
-            self.add(id, platform_name)
-
-        if not self._update_db():
-            raise DatabaseUpdateException()
-
-        return {
-            "new": new_platforms,
-            "updated": updated_platforms_history
-        }

test/platform_database.py

@@ -24,10 +24,9 @@
 import json
 from mock import patch, MagicMock, DEFAULT
 from io import StringIO
-from requests.exceptions import ConnectionError
 
 from mbed_lstools.platform_database import PlatformDatabase, DEFAULT_PLATFORM_DB,\
-    LOCAL_PLATFORM_DATABASE, RemotePlatformDataException, DatabaseUpdateException
+    LOCAL_PLATFORM_DATABASE
 
 try:
     unicode
@@ -150,79 +149,6 @@ def test_simplify_verbose_data(self):
         self.assertEqual(self.pdb.get('1337', verbose_data=True), platform_data)
         self.assertEqual(self.pdb.get('1337'), platform_data['platform_name'])
 
-    def test_update_from_web(self):
-        with patch("requests.get") as _get:
-            _result = MagicMock()
-            _result.configure_mock(**{
-                'json.return_value': [
-                    {
-                        'productcode': '1337',
-                        'logicalboard': {
-                            'name': 'dummy_board'
-                        }
-                    }
-                ]
-            })
-            _get.return_value = _result
-
-            self.pdb.update_from_web()
-            _result.json.assert_called_once()
-            self.assertEqual(self.pdb.get('1337'), 'DUMMY_BOARD')
-
-    def test_update_from_web_json_error(self):
-        with patch("requests.get") as _get:
-            _result = MagicMock()
-            _result.configure_mock(**{
-                'json.side_effect': ValueError
-            })
-            _get.return_value = _result
-
-            exception_raised = False
-            try:
-                self.pdb.update_from_web()
-            except RemotePlatformDataException:
-                exception_raised = True
-
-            self.assertTrue(exception_raised)
-
-    def test_update_from_web_request_error(self):
-        with patch("requests.get") as _get:
-            _get.side_effect = ConnectionError
-
-            exception_raised = False
-            try:
-                self.pdb.update_from_web()
-            except ConnectionError:
-                exception_raised = True
-
-            self.assertTrue(exception_raised)
-
-    def test_update_from_web_update_error(self):
-        with patch("requests.get") as _get,\
-             patch.object(PlatformDatabase, "_update_db") as _update_db:
-            _result = MagicMock()
-            _result.configure_mock(**{
-                'json.return_value': [
-                    {
-                        'productcode': '1337',
-                        'logicalboard': {
-                            'name': 'dummy_board'
-                        }
-                    }
-                ]
-            })
-            _get.return_value = _result
-            _update_db.return_value = False
-
-            exception_raised = False
-            try:
-                self.pdb.update_from_web()
-            except DatabaseUpdateException:
-                exception_raised = True
-
-            _update_db.assert_called_once()
-            self.assertTrue(exception_raised)
-
 class OverriddenPlatformDatabaseTests(unittest.TestCase):
     """ Test that for one database overriding another
     """