Source code for memote.suite.results.models
# -*- coding: utf-8 -*-
# Copyright 2018 Novo Nordisk Foundation Center for Biosustainability,
# Technical University of Denmark.
#
# 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.
"""Persist the memote test suite results in a database."""
from __future__ import absolute_import
import json
import logging
from gzip import GzipFile
from io import BytesIO
from future.utils import raise_with_traceback
from sqlalchemy import Column, DateTime, Integer, LargeBinary, Unicode, UnicodeText
from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy.types import TypeDecorator
from memote.utils import jsonify, log_json_incompatible_types
__all__ = ("Result",)
LOGGER = logging.getLogger(__name__)
Base = declarative_base()
class JSON(TypeDecorator):
"""
Implement a JSON column type.
Most SQL databases now implement JSON blobs but unfortunately, SQLite
only provides this via a compiled extension. So we encode to and decode
from JSON in a normal text column.
"""
impl = UnicodeText
def process_bind_param(self, value, dialect):
"""Convert the value to a JSON encoded string before storing it."""
return jsonify(value, pretty=False)
def process_result_value(self, value, dialect):
"""Convert a JSON encoded string to a dictionary structure."""
if value is not None:
value = json.loads(value)
return value
class BJSON(TypeDecorator):
"""Implement a binary compressed JSON column type."""
impl = LargeBinary
def process_bind_param(self, value, dialect):
"""Convert the value to a JSON encoded string before storing it."""
try:
with BytesIO() as stream:
with GzipFile(fileobj=stream, mode="wb") as file_handle:
file_handle.write(jsonify(value, pretty=False).encode("utf-8"))
output = stream.getvalue()
return output
except TypeError as error:
log_json_incompatible_types(value)
raise_with_traceback(error)
def process_result_value(self, value, dialect):
"""Convert a JSON encoded string to a dictionary structure."""
if value is not None:
with BytesIO(value) as stream:
with GzipFile(fileobj=stream, mode="rb") as file_handle:
value = json.loads(file_handle.read().decode("utf-8"))
return value
[docs]class Result(Base):
"""
Model a git based result for storage in a database.
The class attributes correspond both to the columns in the database table
and to instance attributes.
"""
[docs] __tablename__ = "results"
[docs] id = Column(Integer, primary_key=True)
[docs] hexsha = Column(Unicode(40), nullable=True, unique=True, index=True)
[docs] author = Column(Unicode(255), nullable=True)
[docs] email = Column(Unicode(255), nullable=True)
[docs] authored_on = Column(DateTime(), nullable=True)
[docs] memote_result = Column(BJSON(), nullable=False)