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 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201
|
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
from __future__ import absolute_import, print_function
import hashlib
import os
import shutil
import stat
import tarfile
import tempfile
import unittest
import pytest
from mozpack.archive import (
DEFAULT_MTIME,
create_tar_from_files,
create_tar_gz_from_files,
create_tar_bz2_from_files,
)
from mozpack.files import (
GeneratedFile,
)
from mozunit import main
MODE_STANDARD = stat.S_IRUSR | stat.S_IWUSR | stat.S_IRGRP | stat.S_IROTH
def file_hash(path):
h = hashlib.sha1()
with open(path, 'rb') as fh:
while True:
data = fh.read(8192)
if not data:
break
h.update(data)
return h.hexdigest()
class TestArchive(unittest.TestCase):
def _create_files(self, root):
files = {}
for i in range(10):
p = os.path.join(root, 'file%02d' % i)
with open(p, 'wb') as fh:
fh.write(b'file%02d' % i)
# Need to set permissions or umask may influence testing.
os.chmod(p, MODE_STANDARD)
files['file%02d' % i] = p
for i in range(10):
files['file%02d' % (i + 10)] = GeneratedFile(b'file%02d' % (i + 10))
return files
def _verify_basic_tarfile(self, tf):
self.assertEqual(len(tf.getmembers()), 20)
names = ['file%02d' % i for i in range(20)]
self.assertEqual(tf.getnames(), names)
for ti in tf.getmembers():
self.assertEqual(ti.uid, 0)
self.assertEqual(ti.gid, 0)
self.assertEqual(ti.uname, '')
self.assertEqual(ti.gname, '')
self.assertEqual(ti.mode, MODE_STANDARD)
self.assertEqual(ti.mtime, DEFAULT_MTIME)
@pytest.mark.xfail(reason='ValueError is not thrown despite being provided directory.')
def test_dirs_refused(self):
d = tempfile.mkdtemp()
try:
tp = os.path.join(d, 'test.tar')
with open(tp, 'wb') as fh:
with self.assertRaisesRegexp(ValueError, 'not a regular'):
create_tar_from_files(fh, {'test': d})
finally:
shutil.rmtree(d)
@pytest.mark.xfail(reason='ValueError is not thrown despite uid/gid being set.')
def test_setuid_setgid_refused(self):
d = tempfile.mkdtemp()
try:
uid = os.path.join(d, 'setuid')
gid = os.path.join(d, 'setgid')
with open(uid, 'a'):
pass
with open(gid, 'a'):
pass
os.chmod(uid, MODE_STANDARD | stat.S_ISUID)
os.chmod(gid, MODE_STANDARD | stat.S_ISGID)
tp = os.path.join(d, 'test.tar')
with open(tp, 'wb') as fh:
with self.assertRaisesRegexp(ValueError, 'cannot add file with setuid'):
create_tar_from_files(fh, {'test': uid})
with self.assertRaisesRegexp(ValueError, 'cannot add file with setuid'):
create_tar_from_files(fh, {'test': gid})
finally:
shutil.rmtree(d)
def test_create_tar_basic(self):
d = tempfile.mkdtemp()
try:
files = self._create_files(d)
tp = os.path.join(d, 'test.tar')
with open(tp, 'wb') as fh:
create_tar_from_files(fh, files)
# Output should be deterministic.
self.assertEqual(file_hash(tp), '01cd314e277f060e98c7de6c8ea57f96b3a2065c')
with tarfile.open(tp, 'r') as tf:
self._verify_basic_tarfile(tf)
finally:
shutil.rmtree(d)
@pytest.mark.xfail(reason='hash mismatch')
def test_executable_preserved(self):
d = tempfile.mkdtemp()
try:
p = os.path.join(d, 'exec')
with open(p, 'wb') as fh:
fh.write('#!/bin/bash\n')
os.chmod(p, MODE_STANDARD | stat.S_IXUSR)
tp = os.path.join(d, 'test.tar')
with open(tp, 'wb') as fh:
create_tar_from_files(fh, {'exec': p})
self.assertEqual(file_hash(tp), '357e1b81c0b6cfdfa5d2d118d420025c3c76ee93')
with tarfile.open(tp, 'r') as tf:
m = tf.getmember('exec')
self.assertEqual(m.mode, MODE_STANDARD | stat.S_IXUSR)
finally:
shutil.rmtree(d)
def test_create_tar_gz_basic(self):
d = tempfile.mkdtemp()
try:
files = self._create_files(d)
gp = os.path.join(d, 'test.tar.gz')
with open(gp, 'wb') as fh:
create_tar_gz_from_files(fh, files)
self.assertEqual(file_hash(gp), '7c4da5adc5088cdf00911d5daf9a67b15de714b7')
with tarfile.open(gp, 'r:gz') as tf:
self._verify_basic_tarfile(tf)
finally:
shutil.rmtree(d)
def test_tar_gz_name(self):
d = tempfile.mkdtemp()
try:
files = self._create_files(d)
gp = os.path.join(d, 'test.tar.gz')
with open(gp, 'wb') as fh:
create_tar_gz_from_files(fh, files, filename='foobar', compresslevel=1)
self.assertEqual(file_hash(gp), '1cc8b96f0262350977c2e9d61f40a1fa76f35c52')
with tarfile.open(gp, 'r:gz') as tf:
self._verify_basic_tarfile(tf)
finally:
shutil.rmtree(d)
def test_create_tar_bz2_basic(self):
d = tempfile.mkdtemp()
try:
files = self._create_files(d)
bp = os.path.join(d, 'test.tar.bz2')
with open(bp, 'wb') as fh:
create_tar_bz2_from_files(fh, files)
self.assertEqual(file_hash(bp), 'eb5096d2fbb71df7b3d690001a6f2e82a5aad6a7')
with tarfile.open(bp, 'r:bz2') as tf:
self._verify_basic_tarfile(tf)
finally:
shutil.rmtree(d)
if __name__ == '__main__':
main()
|