aboutsummaryrefslogtreecommitdiffstats
path: root/vicn/resource/linux/file.py
blob: 24ead998768e2223dcc05a08e80edfb935715761 (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
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
#
# Copyright (c) 2017 Cisco and/or its affiliates.
#
# 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.
#

from netmodel.model.key     import Key
from netmodel.model.type    import String, Bool
from vicn.core.attribute    import Attribute, Multiplicity
from vicn.core.exception    import ResourceNotFound
from vicn.core.resource     import Resource
from vicn.core.task         import BashTask, inline_task, inherit_parent
from vicn.resource.node     import Node

CREATE_DIR_CMD  = "mkdir -p {dir}"
CREATE_FILE_CMD = "mkdir -p $(dirname {file.filename}) && touch {file.filename}"
DELETE_FILE_CMD = "rm -f {file.filename}"

GET_FILE_CMD = 'test -f {file.filename} && readlink -e {file.filename}'

GREP_FILE_CMD   = "cat {file.filename}"

CMD_PRINT_TO_FILE = 'echo -n "{file.content}" > {file.filename}'

GET_FILE_EXEC_CMD = 'test -x {file.filename} && echo True || echo False'

CMD_MAKE_FILE_EXEC = 'chmod +x {file.filename}'

class File(Resource):
    """
    Resource: File
    """
    filename = Attribute(String, description = 'Path to the file',
            mandatory = True)
    node = Attribute(Node, description = 'Node on which the file is created',
            mandatory = True,
            multiplicity = Multiplicity.ManyToOne,
            reverse_name = 'files',
            reverse_description = 'Files created on the node')
    overwrite = Attribute(Bool,
            description = 'Determines whether an existing file is overwritten',
            default = False)

    __key__ = Key(node, filename)

    #--------------------------------------------------------------------------
    # Resource lifecycle
    #--------------------------------------------------------------------------

    @inherit_parent
    def __get__(self):
        # UGLY
        @inline_task
        def not_found():
            raise ResourceNotFound

        if self.overwrite:
            return not_found()

        def is_path (rv):
            if rv is None or rv.stdout is None or len(rv.stdout) == 0 or \
                    rv.return_value != 0:
                raise ResourceNotFound
            return {} # 'filename': rv.stdout}

        test = BashTask(self.node, GET_FILE_CMD, {"file": self}, parse=is_path)
        return test

    @inherit_parent
    def __create__(self):
        ctask = BashTask(self.node, CREATE_FILE_CMD, {"file": self})
        if self.overwrite:
            ctask = BashTask(self.node, DELETE_FILE_CMD, {'file': self}) > ctask
        return ctask

    @inherit_parent
    def __delete__(self):
        return BashTask(self.node, DELETE_FILE_CMD, { "file" : self})

#------------------------------------------------------------------------------

class TextFile(File):
    """
    Resource: TextFile

    A file with text content.
    """

    content = Attribute(String, default='')
    executable = Attribute(Bool,
            description = 'Determines whether the file has to be set as an executable',
            default = False)

    #--------------------------------------------------------------------------
    # Resource lifecycle
    #--------------------------------------------------------------------------

    # XXX REDUNDANT !!!
    @inherit_parent
    def __create__(self):
        return BashTask(self.node, CMD_PRINT_TO_FILE, {'file': self})

    #--------------------------------------------------------------------------
    # Attributes
    #--------------------------------------------------------------------------

    def _set_content(self):
        return self.__create__()

    def _get_content(self):
        return BashTask(self.node, GREP_FILE_CMD, {'file': self},
                parse =( lambda x : x.stdout))

    def _get_executable(self):
        return BashTask(self.node, GET_FILE_EXEC_CMD, {'file': self},
                parse =( lambda x : x.stdout))

    def _set_executable(self):
        return BashTask(self.node, CMD_MAKE_FILE_EXEC, {'file':self})