librarydatabase.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 sqlite3
import time
 
from ..preferences.settings import SETTINGS_DIRECTORY
from ..spec.iteminfo import LibraryKeywordInfo
from ..lib.robot.utils import system_decode
 
CREATION_SCRIPT = """\
CREATE TABLE libraries (id INTEGER PRIMARY KEY,
                        name TEXT,
                        doc_format TEXT,
                        arguments TEXT,
                        last_updated REAL);
CREATE TABLE keywords (name TEXT,
                       doc TEXT,
                       arguments TEXT,
                       library_name TEXT,
                       library INTEGER,
                       FOREIGN KEY(library) REFERENCES libraries(id));
"""
 
DATABASE_FILE = os.path.join(system_decode(SETTINGS_DIRECTORY),
                             'librarykeywords.db')
 
 
def _create_database():
    print('Creating librarykeywords database to "%s"' % DATABASE_FILE)
 
    connection = sqlite3.connect(DATABASE_FILE)
    connection.executescript(CREATION_SCRIPT)
    connection.commit()
    connection.close()
 
 
def _validate_database():
    connection = sqlite3.connect(DATABASE_FILE)
    try:
        connection.execute('select id, name, doc_format, arguments,'
                           ' last_updated from libraries')
        connection.execute('select name, doc, arguments, library_name,'
                           ' library from keywords')
    finally:
        connection.close()
 
 
def initialize_database():
    if not os.path.exists(SETTINGS_DIRECTORY):
        os.makedirs(SETTINGS_DIRECTORY)
    if not os.path.exists(DATABASE_FILE):
        _create_database()
    else:
        try:
            _validate_database()
        except sqlite3.DatabaseError as err:
            print('removing database "%s"' % DATABASE_FILE)
            print('error during database validation "%s"' % err)
            try:
                os.remove(DATABASE_FILE)
            except Exception as err:
                print('failed to remove database "%s"' % DATABASE_FILE)
                raise err
            _create_database()
 
 
class LibraryDatabase():
 
    def __init__(self, database):
        self._connection_connection = sqlite3.connect(database, timeout=30.0)
 
    def create_database(self):
        self._cursor_cursor().executescript(CREATION_SCRIPT)
        self._connection_connection.commit()
 
    def _cursor(self):
        return self._connection_connection.cursor()
 
    def close(self):
        self._connection_connection.close()
 
    def insert_library_keywords(self, library_name, library_arguments,
                                keywords):
        library_doc_format = "ROBOT"
        if len(keywords) > 0:
            library_doc_format = keywords[0].doc_format
            # if any(x.doc_format != library_doc_format for x in keywords):
            #    print("debug: keywords doc format not
            #    consistent within library")
 
        cur = self._cursor_cursor()
        old_versions = cur.execute('select id from libraries where name = ?  '
                                   'and arguments = ?',
                                   (library_name,
                                    str(library_arguments))).fetchall()
        cur.executemany('delete from keywords where library = ?', old_versions)
        cur.executemany('delete from libraries where id = ?', old_versions)
        lib = self._insert_library_insert_library(library_name, library_doc_format,
                                   library_arguments, cur)
        keyword_values = [[kw.name, kw.doc, u' | '.join(kw.arguments),
                           kw.source,
                           lib[0]] for kw in keywords if kw is not None]
        self._insert_library_keywords_insert_library_keywords(keyword_values, cur)
        self._connection_connection.commit()
 
    def update_library_timestamp(self, name, arguments, milliseconds=None):
        self._cursor_cursor().execute('update libraries set last_updated = ?'
                               ' where name = ? and arguments = ?',
                               (milliseconds or time.time(), name,
                                str(arguments)))
        self._connection_connection.commit()
 
    def fetch_library_keywords(self, library_name, library_arguments):
        lib = self._fetch_lib_fetch_lib(library_name, library_arguments, self._cursor_cursor())
        if lib is None:
            return []
        return [LibraryKeywordInfo(name, doc, lib[2], library_name,
                                   arguments.split(u' | ') if arguments else [])
                for name, doc, arguments, library_name in
                self._connection_connection.execute('select name, doc, arguments,'
                                         ' library_name from keywords where'
                                         ' library = ?', [lib[0]])]
 
    def library_exists(self, library_name, library_arguments):
        return self._fetch_lib_fetch_lib(library_name, library_arguments,
                               self._cursor_cursor()) is not None
 
    def get_library_last_updated(self, library_name, library_arguments):
        lib = self._fetch_lib_fetch_lib(library_name, library_arguments, self._cursor_cursor())
        if not lib:
            return 0.0
        return lib[4]
 
    def _insert_library(self, name, doc_format, arguments, cursor):
        cursor.execute('insert into libraries values (null, ?, ?, ?, ?)',
                       (name, doc_format, str(arguments), time.time()))
        return self._fetch_lib_fetch_lib(name, arguments, cursor)
 
    def _fetch_lib(self, name, arguments, cursor):
        t = cursor.execute('select max(last_updated) from libraries where name'
                           ' = ?  and arguments = ?',
                           (name, str(arguments))).fetchone()[0]
        return cursor.execute('select * from libraries where name = ?'
                              '  and arguments = ? and last_updated = ?',
                              (name, str(arguments), t)).fetchone()
 
    def _insert_library_keywords(self, data, cursor):
        cursor.executemany('insert into keywords values (?, ?, ?, ?, ?)', data)