Completed
Pull Request — master (#487)
by
unknown
03:03
created

ListNodeCustomProperties.run()   B

Complexity

Conditions 2

Size

Total Lines 27

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
cc 2
c 1
b 0
f 0
dl 0
loc 27
rs 8.8571
1
# Licensed to the StackStorm, Inc ('StackStorm') under one or more
2
# contributor license agreements.  See the NOTICE file distributed with
3
# this work for additional information regarding copyright ownership.
4
# The ASF licenses this file to You under the Apache License, Version 2.0
5
# (the "License"); you may not use this file except in compliance with
6
# the License.  You may obtain a copy of the License at
7
#
8
#     http://www.apache.org/licenses/LICENSE-2.0
9
#
10
# Unless required by applicable law or agreed to in writing, software
11
# distributed under the License is distributed on an "AS IS" BASIS,
12
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
# See the License for the specific language governing permissions and
14
# limitations under the License.
15
16
from lib.actions import OrionBaseAction
17
from lib.utils import send_user_error
18
19
20
class ListNodeCustomProperties(OrionBaseAction):
21
    def run(self, node, platform):
22
        """
23
        Lists the Orion Custom Properties on an Node.
24
25
        Args:
26
            node: The caption in Orion of the node to poll.
27
            platform: The orion platform to act on.
28
29
        Returns:
30
            dict: Of data from Orion.
31
32
        Raises:
33
            UserWarning: If node does not exist.
34
        """
35
36
        self.connect(platform)
37
38
        orion_node = self.get_node(node)
39
40
        if not orion_node.npm:
41
            msg = "Node not in Orion NPM: {}".format(node)
42
            send_user_error(msg)
43
            raise UserWarning(msg)
44
45
        orion_data = self.read(orion_node.uri + '/CustomProperties')
46
47
        return orion_data
48