aboutsummaryrefslogtreecommitdiffstats
path: root/sdv/docker/sdvstate/tools/result_api/storage/local/local.py
blob: d7dc67bbe6b2511918cf8772881f2960b4b6a384 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
# Copyright 2020 University Of Delhi.
#
# 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.


"""
Local Storage Api
"""

import logging
import os
import random
import string
import json
from tools.conf import settings   # pylint: disable=import-error

from ..storage_api import StorageApi
from ... import rfile



class Local(StorageApi):
    """
    Storage API
    Provides abstract class for various storage options to implement as
    plugin to storage api
    """

    def __init__(self):
        """
        Initialization function
        """
        super(Local, self).__init__()
        self.name = 'Local Storage'
        self._logger = logging.getLogger(__name__)
        self._path = ''
        self._filename = ''

    def store(self, data):
        """
        stores ``data``, ``data`` should be a dict

        :param data: dict object to store
        """
        if not isinstance(data, dict):
            raise TypeError("incorrect data type to store, dict required")

        if not os.path.isfile(self._filename):
            with open(self._filename, 'w') as fhandle:
                json.dump([], fhandle)

        with open(self._filename, 'r') as fhandle:
            records = json.load(fhandle)
            temp_data = data.copy()
            eval_rfile(temp_data)
            records.append(temp_data)

        with open(self._filename, 'w') as fhandle:
            self._logger.info(f'{self.name}: New record saved')
            json.dump(records, fhandle, indent=4, sort_keys=True, default=str)


    def load_settings(self):
        """
        Load all required settings otherwise set to default
        Settings to load:
        * ``result_path`` (default: /tmp/local/)
        * ``results_filename`` (default: results.json)
        """
        try:
            path = settings.getValue('results_path')
        except AttributeError:
            path = '/tmp/local/'
            settings.setValue('results_path', path)

        try:
            filename = settings.getValue('results_filename')
        except AttributeError:
            filename = 'results.json'
            settings.setValue('results_filename', filename)

        if not os.path.exists(path):
            os.makedirs(path)

        self._path = path
        self._filename = path + filename





def eval_rfile(data):
    """
    Find all values of a type rfile in data dict/list and evals them into
    actual file
    """
    if isinstance(data, dict):
        for key, value in data.items():
            if isinstance(value, rfile):
                data[key] = rfile_save(value, key)
            else:
                eval_rfile(value)
    if isinstance(data, list):
        for i, _ in enumerate(data):
            if isinstance(data[i], rfile):
                data[i] = rfile_save(data[i])
            else:
                eval_rfile(data[i])


def rfile_save(rfile_obj, prefix='zz'):
    """
    Takes rfile Object and stores it into random file returning filename
    """
    letters = string.ascii_lowercase
    suffix = ''.join(random.choice(letters) for i in range(6))
    filename = settings.getValue('results_path') + f'{prefix}-{suffix}.txt'
    if os.path.isfile(filename):
        return rfile_save(rfile_obj, prefix)
    else:
        with open(filename, 'w') as fhandle:
            fhandle.write(rfile_obj.get_data())
        return f'{prefix}-{suffix}.txt'