def test_register_node_creates_proper_node_dict(self):
r = TRCDashRunner()
now = int(time.time())
node = r.register_node('examplehost', 'example.org', 5000)
self.assertEqual(node.host, 'example.org')
self.assertEqual(node.port, 5000)
self.assertEqual(node.last_registered, now)
def test_update_net_io_counters(self):
r = TRCDashRunner()
socket.getaddrinfo('example.org', 80)
counters = r.get_local_node().net_io_counters.update()
for c in counters.itervalues():
if c['rx_per_sec'] > 0 and c['tx_per_sec'] > 0:
break
else:
self.fail("Didn't find any changed network interface")
def test_default_args_dont_override_config(self):
_, filename = tempfile.mkstemp()
with open(filename, "w") as f:
f.write("TRCDASH_LOGS = ['/var/log/boot.log', '/var/log/dmesg']\n")
f.flush()
os.environ['TRCDASH_CONFIG'] = filename
r = TRCDashRunner()
self.assertEquals(r.app.config['TRCDASH_LOGS'],
['/var/log/boot.log', '/var/log/dmesg'])
del os.environ['TRCDASH_CONFIG']
def _run(self, https=False):
options = {'TRCDASH_PORT': 5051}
if https:
options.update({
'TRCDASH_HTTPS_KEYFILE':
os.path.join(os.path.dirname(__file__), 'keyfile'),
'TRCDASH_HTTPS_CERTFILE':
os.path.join(os.path.dirname(__file__), 'cacert.pem')
})
self.r = TRCDashRunner(options)
self.runner = gevent.spawn(self.r.run)
gevent.sleep(0.3)
def test_register_agent_to_auth_protected_host(self):
r = TRCDashRunner({
'TRCDASH_AUTH_USERNAME': '******',
'TRCDASH_AUTH_PASSWORD': '******'
})
agent = TRCDashRunner({
'TRCDASH_AGENT': True,
'TRCDASH_PORT': 5001,
'TRCDASH_REGISTER_TO': 'http://localhost:5000',
'TRCDASH_AUTH_USERNAME': '******',
'TRCDASH_AUTH_PASSWORD': '******'
})
jobs = []
jobs.append(gevent.spawn(r.run))
gevent.sleep(0.3)
jobs.append(gevent.spawn(agent.run))
gevent.sleep(0.3)
self.assertIn('127.0.0.1:5001', r.get_nodes())
self.assertEquals(
r.get_node('127.0.0.1:5001').name, socket.gethostname())
self.assertEquals(r.get_node('127.0.0.1:5001').port, 5001)
r.server.close()
agent.server.close()
gevent.killall(jobs)
def test_reload_logs(self):
_, filename = tempfile.mkstemp()
r = TRCDashRunner(args=['-l', filename])
pre_count = len(r.get_local_node().logs.available)
r.get_local_node().logs.add_patterns(r.app.config['TRCDASH_LOGS'])
post_count = len(r.get_local_node().logs.available)
self.assertEqual(pre_count, post_count)
def test_register_agent(self):
jobs = []
agent_options = {
'TRCDASH_AGENT': True,
'TRCDASH_PORT': 5001,
'TRCDASH_REGISTER_TO': 'http://localhost:5000',
'TRCDASH_REGISTER_AS': 'the_agent'
}
r = TRCDashRunner()
agent = TRCDashRunner(agent_options)
jobs.append(gevent.spawn(r.run))
gevent.sleep(0.3)
jobs.append(gevent.spawn(agent.run))
gevent.sleep(0.3)
self.assertIn('127.0.0.1:5001', r.get_nodes())
self.assertEquals(r.get_node('127.0.0.1:5001').name, 'the_agent')
self.assertEquals(r.get_node('127.0.0.1:5001').port, 5001)
r.server.close()
agent.server.close()
gevent.killall(jobs)
def test_multiple_remote_addresses_using_list(self):
r = TRCDashRunner(
{'TRCDASH_ALLOWED_REMOTE_ADDRESSES': ['127.0.0.1', '10.0.0.1']})
resp = r.app.test_client().get(
'/', environ_overrides={'REMOTE_ADDR': '10.0.0.1'})
self.assertEqual(resp.status_code, httplib.OK)
resp = r.app.test_client().get(
'/', environ_overrides={'REMOTE_ADDR': '127.0.0.1'})
self.assertEqual(resp.status_code, httplib.OK)
resp = r.app.test_client().get(
'/', environ_overrides={'REMOTE_ADDR': '10.124.0.1'})
self.assertEqual(resp.status_code, httplib.UNAUTHORIZED)
def test_nodes_from_config(self):
config = {
'TRCDASH_NODES': [{
'name': 'test-node',
'host': 'remotehost.org',
'port': 5000
}]
}
r = TRCDashRunner(config)
self.assertEqual(len(r.get_nodes()), 2)
self.assertIn('remotehost.org:5000', r.get_nodes())
self.assertEqual(r.get_nodes()['remotehost.org:5000'].name,
'test-node')
self.assertEqual(r.get_nodes()['remotehost.org:5000'].host,
'remotehost.org')
self.assertEqual(r.get_nodes()['remotehost.org:5000'].port, 5000)
class TestBasicAuth(unittest2.TestCase):
default_username = '******'
default_password = '******'
def setUp(self):
self.app = TRCDashRunner().app
self.client = self.app.test_client()
def _enable_basic_auth(self, username, password):
self.app.config['TRCDASH_AUTH_USERNAME'] = username
self.app.config['TRCDASH_AUTH_PASSWORD'] = password
def _create_auth_headers(self, username, password):
data = base64.b64encode(':'.join([username, password]))
headers = [('Authorization', 'Basic %s' % data)]
return headers
def test_missing_credentials(self):
self._enable_basic_auth(self.default_username, self.default_password)
resp = self.client.get('/')
self.assertEqual(resp.status_code, httplib.UNAUTHORIZED)
def test_correct_credentials(self):
self._enable_basic_auth(self.default_username, self.default_password)
headers = self._create_auth_headers(self.default_username,
self.default_password)
resp = self.client.get('/', headers=headers)
self.assertEqual(resp.status_code, httplib.OK)
def test_incorrect_credentials(self):
self._enable_basic_auth(self.default_username, self.default_password)
headers = self._create_auth_headers(self.default_username, 'wrongpass')
resp = self.client.get('/', headers=headers)
self.assertEqual(resp.status_code, httplib.UNAUTHORIZED)
def setUp(self):
self.app = TRCDashRunner().app
self.client = self.app.test_client()
def setUp(self):
self.r = TRCDashRunner()
self.app = self.r.app
self.client = self.app.test_client()
self.pid = os.getpid()
self.r.get_local_node().net_io_counters.update()
class TestEndpoints(unittest2.TestCase):
def setUp(self):
self.r = TRCDashRunner()
self.app = self.r.app
self.client = self.app.test_client()
self.pid = os.getpid()
self.r.get_local_node().net_io_counters.update()
def test_index(self):
resp = self.client.get('/')
self.assertEqual(resp.status_code, httplib.OK)
@unittest2.skipIf('TRAVIS' in os.environ,
'Functionality not supported on Travis CI')
def test_disks(self):
resp = self.client.get('/disks')
self.assertEqual(resp.status_code, httplib.OK)
def test_network(self):
resp = self.client.get('/network')
self.assertEqual(resp.status_code, httplib.OK)
def test_processes(self):
resp = self.client.get('/processes')
self.assertEqual(resp.status_code, httplib.OK)
def test_process_overview(self):
resp = self.client.get('/process/%d' % self.pid)
self.assertEqual(resp.status_code, httplib.OK)
@unittest2.skipIf(
os.environ.get('USER') == 'root',
'It would fail as root as we would have access to pid 1')
def test_process_no_access(self):
resp = self.client.get('/process/1') # pid 1 == init
self.assertEqual(resp.status_code, httplib.UNAUTHORIZED)
def test_process_non_existing_pid(self):
resp = self.client.get('/process/0')
self.assertEqual(resp.status_code, httplib.NOT_FOUND)
def test_process_children(self):
resp = self.client.get('/process/%d/children' % self.pid)
self.assertEqual(resp.status_code, httplib.OK)
def test_process_connections(self):
resp = self.client.get('/process/%d/connections' % self.pid)
self.assertEqual(resp.status_code, httplib.OK)
def test_process_environment(self):
resp = self.client.get('/process/%d/environment' % self.pid)
self.assertEqual(resp.status_code, httplib.OK)
def test_process_files(self):
resp = self.client.get('/process/%d/files' % self.pid)
self.assertEqual(resp.status_code, httplib.OK)
def test_process_threads(self):
resp = self.client.get('/process/%d/threads' % self.pid)
self.assertEqual(resp.status_code, httplib.OK)
def test_process_memory(self):
resp = self.client.get('/process/%d/memory' % self.pid)
self.assertEqual(resp.status_code, httplib.OK)
@unittest2.skipIf('TRAVIS' in os.environ,
'Functionality not supported on Travis CI')
def test_process_limits(self):
resp = self.client.get('/process/%d/limits' % self.pid)
self.assertEqual(resp.status_code, httplib.OK)
def test_process_invalid_section(self):
resp = self.client.get('/process/%d/whatnot' % self.pid)
self.assertEqual(resp.status_code, httplib.NOT_FOUND)
def test_non_existing(self):
resp = self.client.get('/prettywronghuh')
self.assertEqual(resp.status_code, httplib.NOT_FOUND)
def test_connection_filters(self):
resp = self.client.get('/network?laddr=127.0.0.1')
self.assertEqual(resp.status_code, httplib.OK)
def test_register_node(self):
resp = self.client.get('/register?name=examplehost&port=500')
self.assertEqual(resp.status_code, httplib.OK)
def test_register_node_all_params_required(self):
resp = self.client.get('/register?name=examplehost')
self.assertEqual(resp.status_code, httplib.BAD_REQUEST)
resp = self.client.get('/register?port=500')
self.assertEqual(resp.status_code, httplib.BAD_REQUEST)
def test_args_bind(self):
r = TRCDashRunner(args=['-b', '10.0.0.1'])
self.assertEqual(r.app.config['TRCDASH_BIND_HOST'], '10.0.0.1')
def test_local_node_is_added(self):
r = TRCDashRunner()
self.assertIsInstance(r.get_local_node(), LocalNode)
def test_incorrect_remote_address(self):
r = TRCDashRunner({'TRCDASH_ALLOWED_REMOTE_ADDRESSES': '127.0.0.1'})
resp = r.app.test_client().get(
'/', environ_overrides={'REMOTE_ADDR': '10.0.0.1'})
self.assertEqual(resp.status_code, httplib.UNAUTHORIZED)
def test_works_on_prefix(self):
r = TRCDashRunner({'TRCDASH_URL_PREFIX': self.default_prefix})
resp = r.app.test_client().get(self.default_prefix)
self.assertEqual(resp.status_code, httplib.OK)
def test_page_not_found_on_root(self):
r = TRCDashRunner({'TRCDASH_URL_PREFIX': self.default_prefix})
resp = r.app.test_client().get('/')
self.assertEqual(resp.status_code, httplib.NOT_FOUND)
def test_args_log(self):
_, filename = tempfile.mkstemp()
r = TRCDashRunner(args=['-l', filename])
self.assertEqual(r.app.config['TRCDASH_LOGS'][0], filename)
def test_get_all_nodes(self):
r = TRCDashRunner()
r.register_node('examplehost', 'example.org', 5000)
self.assertEqual(len(r.get_nodes()), 2) # local + registered
def test_args_port(self):
r = TRCDashRunner(args=['-p', '5555'])
self.assertEqual(r.app.config['TRCDASH_PORT'], 5555)
class TestLogs(unittest2.TestCase):
def _create_log_file(self):
fd, filename = tempfile.mkstemp()
fp = os.fdopen(fd, 'w')
fp.write('woha\n' * 100)
fp.write('something\n')
fp.write('woha\n' * 100)
fp.flush()
return filename
def setUp(self):
self.r = TRCDashRunner()
self.app = self.r.app
self.client = self.app.test_client()
self.filename = self._create_log_file()
self.r.get_local_node().logs.add_available(self.filename)
def test_logs(self):
resp = self.client.get('/logs')
self.assertEqual(resp.status_code, httplib.OK)
def test_logs_removed_file(self):
filename = self._create_log_file()
self.r.get_local_node().logs.add_available(filename)
# first visit to make sure the logs are properly initialized
resp = self.client.get('/logs')
self.assertEqual(resp.status_code, httplib.OK)
os.unlink(filename)
resp = self.client.get('/logs')
self.assertEqual(resp.status_code, httplib.OK)
def test_logs_removed_file_uninitialized(self):
filename = self._create_log_file()
self.r.get_local_node().logs.add_available(filename)
os.unlink(filename)
resp = self.client.get('/logs')
self.assertEqual(resp.status_code, httplib.OK)
def test_view(self):
resp = self.client.get('/log?filename=%s' % self.filename)
self.assertEqual(resp.status_code, httplib.OK)
def test_search(self):
resp = self.client.get(
'/log/search?filename=%s&text=%s' % (self.filename, 'something'),
environ_overrides={'HTTP_X_REQUESTED_WITH': 'xmlhttprequest'})
self.assertEqual(resp.status_code, httplib.OK)
try:
data = json.loads(resp.data)
self.assertIn('something', data['content'])
except ValueError:
self.fail('Log search did not return valid json data')
def test_read(self):
resp = self.client.get(
'/log?filename=%s' % self.filename,
environ_overrides={'HTTP_X_REQUESTED_WITH': 'xmlhttprequest'})
self.assertEqual(resp.status_code, httplib.OK)
def test_read_tail(self):
resp = self.client.get('/log?filename=%s&seek_tail=1' % self.filename)
self.assertEqual(resp.status_code, httplib.OK)
def test_non_existing_file(self):
filename = "/var/log/surelynotaroundright.log"
resp = self.client.get('/log?filename=%s' % filename)
self.assertEqual(resp.status_code, httplib.NOT_FOUND)
resp = self.client.get('/log/search?filename=%s&text=%s' %
(filename, 'something'))
self.assertEqual(resp.status_code, httplib.NOT_FOUND)
resp = self.client.get('/log/read?filename=%s' % filename)
self.assertEqual(resp.status_code, httplib.NOT_FOUND)
resp = self.client.get('/log/read_tail?filename=%s' % filename)
self.assertEqual(resp.status_code, httplib.NOT_FOUND)
def test_multiple_level_prefix(self):
r = TRCDashRunner({'TRCDASH_URL_PREFIX': '/use/this/folder/'})
resp = r.app.test_client().get('/use/this/folder/')
self.assertEqual(resp.status_code, httplib.OK)
def setUp(self):
self.r = TRCDashRunner()
self.app = self.r.app
self.client = self.app.test_client()
self.filename = self._create_log_file()
self.r.get_local_node().logs.add_available(self.filename)
def test_missing_trailing_slash_works(self):
r = TRCDashRunner({'TRCDASH_URL_PREFIX': '/subfolder'})
resp = r.app.test_client().get('/subfolder/')
self.assertEqual(resp.status_code, httplib.OK)
def test_show_only_whitelisted(self):
r = TRCDashRunner({'TRCDASH_ENVIRON_WHITELIST': ['USER']})
resp = r.app.test_client().get('/process/%d/environment' % os.getpid())
self.assertTrue(os.environ['USER'] in resp.data)
self.assertTrue('*hidden by whitelist*' in resp.data)
def test_args_debug(self):
r = TRCDashRunner(args=['-d'])
self.assertTrue(r.app.debug)