# Copyright (C) 2012 Canonical Ltd.
# Author: Kyle Nitzsche <[email protected]>
#
# This program is free software; you can redistribute it and/or modify it
# under the terms of the GNU General Public License as published by the
# Free Software Foundation; either version 2 of the License, or (at your
# option) any later version. See http://www.gnu.org/copyleft/gpl.html for
# the full text of the license.

import unittest
import subprocess
import tempfile
import shutil
import os
import os.path

p = subprocess.Popen(['which', 'valgrind'], stdout=subprocess.PIPE)
p.communicate()
have_valgrind = (p.returncode == 0)


@unittest.skipUnless(have_valgrind, 'valgrind not installed')
class T(unittest.TestCase):
def setUp(self):
self.workdir = tempfile.mkdtemp()
self.pwd = os.getcwd()

def tearDown(self):
shutil.rmtree(self.workdir)
os.chdir(self.pwd)

def test_valgrind_min_installed(self):
'''valgrind is installed and recent enough'''

cmd = ['valgrind', '-q', '--extra-debuginfo-path=./', 'ls']
(ret, out, err) = self._call(cmd)
self.assertEqual(ret, 0)

def _call(self, argv):
p = subprocess.Popen(
argv, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
(out, err) = p.communicate()
ret = p.returncode
return ret, bytes.decode(out), bytes.decode(err)

def test_help_display(self):
'''help display'''

cmd = ['apport-valgrind', '-h']
(ret, out, err) = self._call(cmd)
self.assertEqual(ret, 0)

def test_invalid_args(self):
'''return code is not 0 when invalid args are passed'''

cmd = ['apport-valgrind', '-k', 'pwd']
(ret, out, err) = self._call(cmd)
self.assertNotEqual(ret, 0)

def test_vlog_created(self):
'''apport-valgrind creates valgrind.log with expected content'''

cmd = ['apport-valgrind', '--no-sandbox', 'true']
os.chdir(self.workdir)
subprocess.call(cmd)
self.assertTrue(
os.path.exists('valgrind.log'),
msg='Expected valgrind.log file not found.')

def test_intentional_mem_leak_detection(self):
'''apport-valgrind log reports intentional memory leak'''

os.chdir(self.workdir)

# compile memleak.c to create memleak.o that intentionally creates a
# memory leak
code = '''
#include <stdio.h>
#include <stdlib.h>
#include <string.h>

void makeleak(void);

int main(void)
{
makeleak();
return 0;
}

void makeleak(void){
char *leak = malloc(128);
strcpy(leak, "Initializing leak value");
/*free(leak);*/
}'''

with open('memleak.c', 'w') as fd:
fd.write(code)
cmd = ['gcc', '-Wall', '-Werror', '-g', 'memleak.c', '-o', 'memleak']
self.assertEqual(
subprocess.call(cmd), 0, 'compiling memleak.c failed.')

self.assertTrue(os.path.exists('memleak'))

# run apport-valgrind on the new memleak.o
cmd = ['apport-valgrind', '--no-sandbox', os.path.join(self.workdir,
'./memleak')]
subprocess.call(cmd)
logpath = os.path.join(self.workdir, './valgrind.log')

# verify the generated valgrind.log contains the known leak
cmd = ['grep', 'definitely lost:', logpath]
res = subprocess.Popen(cmd, stdout=subprocess.PIPE).communicate()[0]
res = bytes.decode(res)
res = res.rstrip('\n')

found = res.find('128 bytes')
self.assertGreater(found, 0,
'The intentional memory leak should be reported '
'in the valgrind log file but is not.')

def test_unpackaged_exe(self):
'''apport-valgrind creates valgrind log on unpackaged executable'''

exepath = os.path.join(self.workdir, 'pwd')
shutil.copy('/bin/pwd', exepath)
logpath = os.path.join(self.workdir, 'unpackaged-exe.log')

subprocess.check_call(['apport-valgrind', '--no-sandbox', '-l', logpath, exepath])
self.assertTrue(os.path.exists(logpath),
'A log file %s should exist but does not' % logpath)

with open(logpath) as f:
log = f.read()
self.assertTrue(exepath in log, log)

def test_sandbox_cache_options(self):
'''apport-valgrind creates a user specified sandbox and cache'''

sandbox = os.path.join(self.workdir, 'test-sandbox')
cache = os.path.join(self.workdir, 'test-cache')

cmd = ['apport-valgrind', '--sandbox-dir', sandbox, '--cache', cache, 'true']
subprocess.check_call(cmd)

self.assertTrue(os.path.exists(sandbox),
'A sandbox directory %s was specified but was not created'
% sandbox)

self.assertTrue(os.path.exists(cache),
'A cache directory %s was specified but was not created' %
cache)


unittest.main()