Minor fixes
[nepi.git] / src / nepi / resources / linux / traceroute.py
1 #
2 #    NEPI, a framework to manage network experiments
3 #    Copyright (C) 2013 INRIA
4 #
5 #    This program is free software: you can redistribute it and/or modify
6 #    it under the terms of the GNU General Public License as published by
7 #    the Free Software Foundation, either version 3 of the License, or
8 #    (at your option) any later version.
9 #
10 #    This program is distributed in the hope that it will be useful,
11 #    but WITHOUT ANY WARRANTY; without even the implied warranty of
12 #    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 #    GNU General Public License for more details.
14 #
15 #    You should have received a copy of the GNU General Public License
16 #    along with this program.  If not, see <http://www.gnu.org/licenses/>.
17 #
18 # Author: Alina Quereilhac <alina.quereilhac@inria.fr>
19
20 from nepi.execution.attribute import Attribute, Flags, Types
21 from nepi.execution.resource import clsinit_copy 
22 from nepi.resources.linux.application import LinuxApplication
23 from nepi.util.timefuncs import tnow
24
25 import os
26 import socket
27
28 @clsinit_copy
29 class LinuxTraceroute(LinuxApplication):
30     _rtype = "LinuxTraceroute"
31
32     @classmethod
33     def _register_attributes(cls):
34         countinuous = Attribute("continuous",
35             "Run traceroute in a while loop",
36             type = Types.Bool,
37             default = False,
38             flags = Flags.Design)
39
40         print_timestamp = Attribute("printTimestamp",
41             "Print timestamp before running traceroute",
42             type = Types.Bool,
43             default = False,
44             flags = Flags.Design)
45
46         use_ip = Attribute("useIP",
47             "Use the IP address instead of the host domain name. "
48             "Useful for environments were dns resolution problems occur "
49             "frequently",
50             type = Types.Bool,
51             default = False,
52             flags = Flags.Design)
53
54         target = Attribute("target",
55             "Traceroute target host (host that will be pinged)",
56             flags = Flags.Design)
57
58         cls._register_attribute(countinuous)
59         cls._register_attribute(print_timestamp)
60         cls._register_attribute(use_ip)
61         cls._register_attribute(target)
62
63     def __init__(self, ec, guid):
64         super(LinuxTraceroute, self).__init__(ec, guid)
65         self._home = "traceroute-%s" % self.guid
66
67     def do_deploy(self):
68         if not self.get("command"):
69             self.set("command", self._start_command)
70
71         if not self.get("depends"):
72             self.set("depends", "traceroute")
73
74         super(LinuxTraceroute, self).do_deploy()
75
76     @property
77     def _start_command(self):
78         args = []
79         if self.get("continuous") == True:
80             args.append("while true; do ")
81         if self.get("printTimestamp") == True:
82             args.append("""echo "`date +'%Y%m%d%H%M%S'`";""")
83         args.append("traceroute")
84
85         target = self.get("target")
86         if self.get("useIP") == True:
87             target = socket.gethostbyname(target)
88         args.append(target)
89         
90         if self.get("continuous") == True:
91             args.append("; sleep 2 ; done ")
92
93         command = " ".join(args)
94
95         return command
96
97     def valid_connection(self, guid):
98         # TODO: Validate!
99         return True
100