librarymanager.py

Go to the documentation of this file.

#  Copyright 2008-2015 Nokia Networks
#  Copyright 2016-     Robot Framework Foundation
#
#  Licensed under the Apache License, Version 2.0 (the "License");
#  you may not use this file except in compliance with the License.
#  You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
#  Unless required by applicable law or agreed to in writing, software
#  distributed under the License is distributed on an "AS IS" BASIS,
#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
#  See the License for the specific language governing permissions and
#  limitations under the License.
 
import os
import queue as Queue
from sqlite3 import OperationalError
from threading import Thread
 
from ..publish import RideLogException, RideLogMessage
from ..spec.librarydatabase import LibraryDatabase
from ..spec.libraryfetcher import get_import_result
from ..spec.xmlreaders import get_path, SpecInitializer
 
 
class LibraryManager(Thread):
 
    def __init__(self, database_name, spec_initializer=None):
        self._database_name_database_name = database_name
        self._database_database = None
        self._messages_messages = Queue.Queue()
        self._spec_initializer_spec_initializer = spec_initializer or SpecInitializer()
        Thread.__init__(self)
        self.daemondaemon = True
 
    def run(self):
        self._initiate_database_connection_initiate_database_connection()
        while True:
            try:
                if not self._handle_message_handle_message():
                    break
            except Exception as err:
                msg = 'Library import handling threw an unexpected exception'
                RideLogException(message=msg, exception=err, level='WARN').publish()
        self._database_database.close()
 
    def _initiate_database_connection(self):
        self._database_database = LibraryDatabase(self._database_name_database_name)
 
    def get_new_connection_to_library_database(self):
        library_database = LibraryDatabase(self._database_name_database_name)
        if self._database_name_database_name == ':memory:':
            # In memory database does not point to the right place..
            # this is here for unit tests..
            library_database.create_database()
        return library_database
 
    def _handle_message(self):
        message = self._messages_messages.get()
        if not message:
            return False
        msg_type = message[0]
        if msg_type == 'fetch':
            self._handle_fetch_keywords_message_handle_fetch_keywords_message(message)
        elif msg_type == 'insert':
            self._handle_insert_keywords_message_handle_insert_keywords_message(message)
        elif msg_type == 'create':
            self._database_database.create_database()
        return True
 
    def _handle_fetch_keywords_message(self, message):
        _, library_name, library_args, callback = message
        keywords = self._fetch_keywords_fetch_keywords(library_name, library_args)
        self._update_database_and_call_callback_if_needed_update_database_and_call_callback_if_needed(
            (library_name, library_args), keywords, callback)
 
    def _fetch_keywords(self, library_name, library_args):
        try:
            path = get_path(
                library_name.replace('/', os.sep), os.path.abspath('.'))
            return get_import_result(path, library_args)
        except Exception as err:
            try:
                print('FAILED', library_name, err)
            except IOError:
                pass
            kws = self._spec_initializer_spec_initializer.init_from_spec(library_name)
            if not kws:
                msg = 'Importing test library "%s" failed' % library_name
                RideLogException(
                    message=msg, exception=err, level='WARN').publish()
            return kws
 
    def _handle_insert_keywords_message(self, message):
        _, library_name, library_args, result_queue = message
        keywords = self._fetch_keywords_fetch_keywords(library_name, library_args)
        self._insert_insert(library_name, library_args, keywords,
                     lambda res: result_queue.put(res, timeout=3))
 
    def _insert(self, library_name, library_args, keywords, callback):
        self._database_database.insert_library_keywords(
            library_name, library_args, keywords or [])
        self._call_call(callback, keywords)
 
    def _update_database_and_call_callback_if_needed(
            self, library_key, keywords, callback):
        db_keywords = self._database_database.fetch_library_keywords(*library_key)
        try:
            if not db_keywords or self._keywords_differ_keywords_differ(keywords, db_keywords):
                self._insert_insert(
                    library_key[0], library_key[1], keywords, callback)
            else:
                self._database_database.update_library_timestamp(*library_key)
        except OperationalError:
            pass
 
    def _call(self, callback, *args):
        try:
            callback(*args)
        except Exception as err:
            msg = 'Library import callback threw an unexpected exception'
            RideLogException(message=msg, exception=err, level='WARN').publish()
 
    def fetch_keywords(self, library_name, library_args, callback):
        self._messages_messages.put(('fetch', library_name, library_args, callback),
                           timeout=3)
 
    def get_and_insert_keywords(self, library_name, library_args):
        result_queue = Queue.Queue(maxsize=1)
        self._messages_messages.put(
            ('insert', library_name, library_args, result_queue), timeout=3)
        try:
            return result_queue.get(timeout=5)
        except Queue.Empty as e:
            RideLogMessage(u'Failed to read keywords from library db: {}'
                           .format(str(e))).publish()
            return []
 
    def create_database(self):
        self._messages_messages.put(('create',), timeout=3)
 
    def stop(self):
        self._messages_messages.put(False, timeout=3)
 
    def _keywords_differ(self, keywords1, keywords2):
        if keywords1 != keywords2 and None in (keywords1, keywords2):
            return True
        if len(keywords1) != len(keywords2):
            return True
        for k1, k2 in zip(keywords1, keywords2):
            if k1.name != k2.name:
                return True
            if k1.doc != k2.doc:
                return True
            # if k1.doc_format != k2.doc_format:
            #     return True
            if k1.arguments != k2.arguments:
                return True
            if k1.source != k2.source:
                return True
        return False