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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
|
# Copyright 2020 Google LLC
#
# 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.
"""Tests the functionality of the utils module's functions"""
import os
import tempfile
import unittest
from unittest import mock
import utils
import helper
EXAMPLE_PROJECT = 'example'
TEST_OUT_DIR = os.path.join(os.path.dirname(os.path.abspath(__file__)),
'cifuzz', 'test_data', 'build-out')
class IsFuzzTargetLocalTest(unittest.TestCase):
"""Tests the is_fuzz_target_local function."""
def test_invalid_filepath(self):
"""Tests the function with an invalid file path."""
is_local = utils.is_fuzz_target_local('not/a/real/file')
self.assertFalse(is_local)
is_local = utils.is_fuzz_target_local('')
self.assertFalse(is_local)
is_local = utils.is_fuzz_target_local(' ')
self.assertFalse(is_local)
def test_valid_filepath(self):
"""Checks is_fuzz_target_local function with a valid filepath."""
is_local = utils.is_fuzz_target_local(
os.path.join(TEST_OUT_DIR, 'example_crash_fuzzer'))
self.assertTrue(is_local)
is_local = utils.is_fuzz_target_local(TEST_OUT_DIR)
self.assertFalse(is_local)
class GetFuzzTargetsTest(unittest.TestCase):
"""Tests the get_fuzz_targets function."""
def test_valid_filepath(self):
"""Tests that fuzz targets can be retrieved once the fuzzers are built."""
fuzz_targets = utils.get_fuzz_targets(TEST_OUT_DIR)
crash_fuzzer_path = os.path.join(TEST_OUT_DIR, 'example_crash_fuzzer')
nocrash_fuzzer_path = os.path.join(TEST_OUT_DIR, 'example_nocrash_fuzzer')
self.assertCountEqual(fuzz_targets,
[crash_fuzzer_path, nocrash_fuzzer_path])
# Testing on a arbitrary directory with no fuzz targets in it.
fuzz_targets = utils.get_fuzz_targets(
os.path.join(helper.OSS_FUZZ_DIR, 'infra', 'travis'))
self.assertFalse(fuzz_targets)
def test_invalid_filepath(self):
"""Tests what get_fuzz_targets return when invalid filepath is used."""
fuzz_targets = utils.get_fuzz_targets('not/a/valid/file/path')
self.assertFalse(fuzz_targets)
class ExecuteTest(unittest.TestCase):
"""Tests the execute function."""
def test_valid_command(self):
"""Tests that execute can produce valid output."""
with tempfile.TemporaryDirectory() as tmp_dir:
out, err, err_code = utils.execute(['ls', '.'],
location=tmp_dir,
check_result=False)
self.assertEqual(err_code, 0)
self.assertEqual(err, '')
self.assertEqual(out, '')
out, err, err_code = utils.execute(['mkdir', 'tmp'],
location=tmp_dir,
check_result=False)
self.assertEqual(err_code, 0)
self.assertEqual(err, '')
self.assertEqual(out, '')
out, err, err_code = utils.execute(['ls', '.'],
location=tmp_dir,
check_result=False)
self.assertEqual(err_code, 0)
self.assertEqual(err, '')
self.assertEqual(out, 'tmp\n')
def test_error_command(self):
"""Tests that execute can correctly surface errors."""
with tempfile.TemporaryDirectory() as tmp_dir:
out, err, err_code = utils.execute(['ls', 'notarealdir'],
location=tmp_dir,
check_result=False)
self.assertEqual(err_code, 2)
self.assertIsNotNone(err)
self.assertEqual(out, '')
with self.assertRaises(RuntimeError):
out, err, err_code = utils.execute(['ls', 'notarealdir'],
location=tmp_dir,
check_result=True)
class BinaryPrintTest(unittest.TestCase):
"""Tests for utils.binary_print."""
@unittest.skip('Causes spurious failures because of side-effects.')
def test_string(self): # pylint: disable=no-self-use
"""Tests that utils.binary_print can print a regular string."""
# Should execute without raising any exceptions.
with mock.patch('sys.stdout.buffer.write') as mock_write:
utils.binary_print('hello')
mock_write.assert_called_with('hello\n')
@unittest.skip('Causes spurious failures because of side-effects.')
def test_binary_string(self): # pylint: disable=no-self-use
"""Tests that utils.binary_print can print a bianry string."""
# Should execute without raising any exceptions.
with mock.patch('sys.stdout.buffer.write') as mock_write:
utils.binary_print(b'hello')
mock_write.assert_called_with(b'hello\n')
class CommandToStringTest(unittest.TestCase):
"""Tests for command_to_string."""
def test_string(self):
"""Tests that command_to_string returns the argument passed to it when it is
passed a string."""
command = 'command'
self.assertEqual(utils.command_to_string(command), command)
def test_list(self):
"""Tests that command_to_string returns the correct stringwhen it is passed
a list."""
command = ['command', 'arg1', 'arg2']
self.assertEqual(utils.command_to_string(command), 'command arg1 arg2')
if __name__ == '__main__':
unittest.main()
|
