Hot-keys on this page

r m x p   toggle line displays

j k   next/prev highlighted chunk

0   (zero) top of page

1   (one) first highlighted chunk

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

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

# -*- Mode:Python; indent-tabs-mode:nil; tab-width:4 -*- 

# 

# Copyright (C) 2015 Canonical Ltd 

# 

# This program is free software: you can redistribute it and/or modify 

# it under the terms of the GNU General Public License version 3 as 

# published by the Free Software Foundation. 

# 

# This program is distributed in the hope that it will be useful, 

# but WITHOUT ANY WARRANTY; without even the implied warranty of 

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the 

# GNU General Public License for more details. 

# 

# You should have received a copy of the GNU General Public License 

# along with this program.  If not, see <http://www.gnu.org/licenses/>. 

 

import io 

import logging 

import os 

import tempfile 

from unittest import mock 

 

import fixtures 

 

from snapcraft import ( 

    cmds, 

    common, 

    lifecycle, 

    tests 

) 

 

 

class _IO(io.StringIO): 

 

    def fileno(self): 

        return 1 

 

 

class TestCommands(tests.TestCase): 

 

    def setUp(self): 

        super().setUp() 

        common.set_schemadir(os.path.join(__file__, 

                             '..', '..', '..', 'schema')) 

 

    @mock.patch('snapcraft.cmds.snap') 

    @mock.patch('sys.stdout', new_callable=_IO) 

    @mock.patch('sys.stderr', new_callable=_IO) 

    def test_assemble_snap(self, mock_stderr, mock_stdout, mock_snap): 

        meta_dir = os.path.join('snap', 'meta') 

        metadata = os.path.join(meta_dir, 'package.yaml') 

        readme_md = os.path.join(meta_dir, 'readme.md') 

 

        os.makedirs(meta_dir) 

        with open(metadata, 'w') as f: 

            f.write('''name: test-package 

version: 1 

vendor: me <me@me.com> 

summary: test 

description: test 

icon: my-icon.png 

 

binaries: 

  - name: binary1 

''') 

        with open(readme_md, 'w') as f: 

            f.write('''description 

longer text.''') 

 

        class Args: 

            cmd = '' 

 

        with self.assertRaises(SystemExit) as raised: 

            cmds.assemble(Args()) 

 

        self.assertEqual(raised.exception.code, 0, 'Wrong exit code returned.') 

 

        # we do a contains since review tools are something we don't control 

        output_stdout = mock_stdout.getvalue() 

        output_stderr = mock_stderr.getvalue() 

        self.assertEqual(output_stderr, '', 'There should be no stderr') 

        self.assertTrue('Snapping' in output_stdout) 

        self.assertTrue('test-package_1_all.snap' in output_stdout) 

 

    @mock.patch('snapcraft.cmds.snap') 

    @mock.patch('sys.stdout', new_callable=_IO) 

    @mock.patch('sys.stderr', new_callable=_IO) 

    def test_assemble_snap_fails_on_bad_snap_layout( 

            self, mock_stderr, mock_stdout, mock_snap): 

        meta_dir = os.path.join('snap', 'meta') 

        metadata = os.path.join(meta_dir, 'package.yaml') 

        readme_md = os.path.join(meta_dir, 'readme.md') 

 

        os.makedirs(meta_dir) 

        with open(metadata, 'w') as f: 

            f.write('') 

        with open(readme_md, 'w') as f: 

            f.write('') 

 

        class Args: 

            cmd = '' 

 

        with self.assertRaises(SystemExit) as raised: 

            cmds.assemble(Args()) 

 

        self.assertEqual(raised.exception.code, 1, 'Wrong exit code returned.') 

 

        # we do a contains since review tools are something we don't control 

        output_stdout = mock_stdout.getvalue() 

        output_stderr = mock_stderr.getvalue() 

        self.assertTrue('can not parse package.yaml: missing required fields' 

                        in output_stderr) 

        self.assertTrue('Snapping' in output_stdout) 

        self.assertFalse('test-package_1_all.snap' in output_stdout) 

 

    def test_check_for_collisions(self): 

        fake_logger = fixtures.FakeLogger(level=logging.ERROR) 

        self.useFixture(fake_logger) 

 

        tmpdirObject = tempfile.TemporaryDirectory() 

        self.addCleanup(tmpdirObject.cleanup) 

        tmpdir = tmpdirObject.name 

 

        part1 = lifecycle.load_plugin('part1', 'jdk', {'source': '.'}) 

        part1.code.installdir = tmpdir + '/install1' 

        os.makedirs(part1.installdir + '/a') 

        open(part1.installdir + '/a/1', mode='w').close() 

 

        part2 = lifecycle.load_plugin('part2', 'jdk', {'source': '.'}) 

        part2.code.installdir = tmpdir + '/install2' 

        os.makedirs(part2.installdir + '/a') 

        with open(part2.installdir + '/1', mode='w') as f: 

            f.write('1') 

        open(part2.installdir + '/2', mode='w').close() 

        with open(part2.installdir + '/a/2', mode='w') as f: 

            f.write('a/2') 

 

        part3 = lifecycle.load_plugin('part3', 'jdk', {'source': '.'}) 

        part3.code.installdir = tmpdir + '/install3' 

        os.makedirs(part3.installdir + '/a') 

        os.makedirs(part3.installdir + '/b') 

        with open(part3.installdir + '/1', mode='w') as f: 

            f.write('2') 

        with open(part2.installdir + '/2', mode='w') as f: 

            f.write('1') 

        open(part3.installdir + '/a/2', mode='w').close() 

 

        self.assertTrue(cmds._check_for_collisions([part1, part2])) 

        self.assertEqual('', fake_logger.output) 

 

        self.assertFalse(cmds._check_for_collisions([part1, part2, part3])) 

        self.assertEqual( 

            'Error: parts part2 and part3 have the following file paths in ' 

            'common which have different contents:\n' 

            '  1\n' 

            '  a/2\n', 

            fake_logger.output) 

 

    @mock.patch('sys.stdout', new_callable=io.StringIO) 

    def test_list_plugins(self, mock_stdout): 

        expected_list = '''ant 

autotools 

catkin 

cmake 

copy 

go 

jdk 

make 

maven 

nil 

nodejs 

python2 

python3 

qml 

roscore 

scons 

tar-content 

''' 

        cmds.list_plugins() 

        self.assertEqual(mock_stdout.getvalue(), expected_list) 

 

    def test_load_config_with_invalid_plugin_exits_with_error(self): 

        fake_logger = fixtures.FakeLogger(level=logging.ERROR) 

        self.useFixture(fake_logger) 

 

        open('my-icon.png', 'w').close() 

        with open('snapcraft.yaml', 'w') as f: 

            f.write('''name: test-package 

version: 1 

vendor: me <me@me.com> 

summary: test 

description: test 

icon: my-icon.png 

 

parts: 

  part1: 

    plugin: does-not-exist 

''') 

 

        with self.assertRaises(SystemExit) as raised: 

            cmds._load_config() 

 

        self.assertEqual(raised.exception.code, 1, 'Wrong exit code returned.') 

        self.assertEqual( 

            'Issue while loading plugin: unknown plugin: does-not-exist\n', 

            fake_logger.output) 

 

 

class CleanTestCase(tests.TestCase): 

 

    def setUp(self): 

        super().setUp() 

 

        patcher = mock.patch('shutil.rmtree') 

        self.mock_rmtree = patcher.start() 

        self.addCleanup(patcher.stop) 

 

        patcher = mock.patch('os.path.exists') 

        self.mock_exists = patcher.start() 

        self.addCleanup(patcher.stop) 

 

        patcher = mock.patch('os.listdir') 

        self.mock_listdir = patcher.start() 

        self.mock_listdir.return_value = [] 

        self.addCleanup(patcher.stop) 

 

        patcher = mock.patch('os.rmdir') 

        self.mock_rmdir = patcher.start() 

        self.addCleanup(patcher.stop) 

 

        self.clean_calls = [] 

 

        class FakePart: 

 

            def __init__(self, name, partdir): 

                self.name = name 

                self.partdir = partdir 

 

            def names(self): 

                return [self.name, ] 

 

            def clean(s): 

                self.clean_calls.append(s.name) 

 

        class FakeConfig: 

            all_parts = [ 

                FakePart('part1', 'partdir1'), 

                FakePart('part2', 'partdir2'), 

                FakePart('part3', 'partdir3'), 

            ] 

 

        self.fake_config = FakeConfig() 

 

        patcher = mock.patch('snapcraft.cmds._load_config') 

        self.mock_load_config = patcher.start() 

        self.mock_load_config.return_value = self.fake_config 

        self.addCleanup(patcher.stop) 

 

    def test_clean_all(self): 

        class args: 

            parts = [] 

        cmds.clean(args()) 

 

        self.mock_exists.assert_has_calls([ 

            mock.call(common.get_partsdir()), 

            mock.call().__bool__(), 

            mock.call(common.get_stagedir()), 

            mock.call().__bool__(), 

            mock.call(common.get_snapdir()), 

            mock.call().__bool__(), 

        ]) 

 

        self.mock_rmtree.assert_has_calls([ 

            mock.call(common.get_stagedir()), 

            mock.call(common.get_snapdir()), 

        ]) 

 

        self.mock_rmdir.assert_called_once_with(common.get_partsdir()) 

        self.assertEqual(self.clean_calls, ['part1', 'part2', 'part3']) 

 

    def test_clean_all_when_all_parts_specified(self): 

        class args: 

            parts = ['part1', 'part2', 'part3'] 

        cmds.clean(args()) 

 

        self.mock_exists.assert_has_calls([ 

            mock.call(common.get_partsdir()), 

            mock.call().__bool__(), 

            mock.call(common.get_stagedir()), 

            mock.call().__bool__(), 

            mock.call(common.get_snapdir()), 

            mock.call().__bool__(), 

        ]) 

 

        self.mock_rmtree.assert_has_calls([ 

            mock.call(common.get_stagedir()), 

            mock.call(common.get_snapdir()), 

        ]) 

 

        self.mock_rmdir.assert_called_once_with(common.get_partsdir()) 

        self.assertEqual(self.clean_calls, ['part1', 'part2', 'part3']) 

 

    def test_partial_clean(self): 

        class args: 

            parts = ['part1'] 

        cmds.clean(args()) 

 

        self.mock_exists.assert_has_calls([ 

            mock.call(common.get_partsdir()), 

            mock.call().__bool__(), 

            mock.call(common.get_snapdir()), 

            mock.call().__bool__(), 

        ]) 

 

        self.mock_rmtree.assert_has_calls([ 

            mock.call(common.get_snapdir()), 

        ]) 

 

        self.mock_rmdir.assert_called_once_with(common.get_partsdir()) 

        self.assertEqual(self.clean_calls, ['part1']) 

 

    def test_everything_is_clean(self): 

        self.mock_exists.return_value = False 

        self.mock_listdir.side_effect = FileNotFoundError() 

 

        class args: 

            parts = [] 

        cmds.clean(args()) 

 

        self.mock_exists.assert_has_calls([ 

            mock.call(common.get_partsdir()), 

            mock.call(common.get_stagedir()), 

            mock.call(common.get_snapdir()), 

        ]) 

 

        self.assertFalse(self.mock_rmdir.called) 

        self.assertFalse(self.mock_rmtree.called) 

        self.assertEqual(self.clean_calls, ['part1', 'part2', 'part3']) 

 

    def test_no_parts_defined(self): 

        self.fake_config.all_parts = [] 

 

        self.mock_load_config.return_value = self.fake_config 

 

        class args: 

            parts = [] 

 

        cmds.clean(args()) 

 

        self.mock_exists.assert_has_calls([ 

            mock.call(common.get_stagedir()), 

            mock.call().__bool__(), 

            mock.call(common.get_snapdir()), 

            mock.call().__bool__(), 

        ]) 

 

        self.mock_rmtree.assert_has_calls([ 

            mock.call(common.get_stagedir()), 

            mock.call(common.get_snapdir()), 

        ]) 

 

        self.mock_rmdir.assert_called_once_with(common.get_partsdir()) 

 

    def test_part_to_remove_not_defined_exits_with_error(self): 

        fake_logger = fixtures.FakeLogger(level=logging.ERROR) 

        self.useFixture(fake_logger) 

 

        class args: 

            parts = ['does-not-exist'] 

 

        with self.assertRaises(SystemExit) as raised: 

            cmds.clean(args()) 

        self.assertEqual(raised.exception.code, 1, 'Wrong exit code returned.') 

        self.assertEqual( 

            "The part named 'does-not-exist' is not defined in " 

            "'snapcraft.yaml'\n", 

            fake_logger.output) 

 

 

class InitTestCase(tests.TestCase): 

 

    def test_init_with_existing_snapcraft_yaml_must_fail(self): 

        fake_logger = fixtures.FakeLogger(level=logging.ERROR) 

        self.useFixture(fake_logger) 

 

        open('snapcraft.yaml', 'w').close() 

 

        with self.assertRaises(SystemExit) as raised: 

            cmds.init('dummy args') 

        self.assertEqual(raised.exception.code, 1, 'Wrong exit code returned.') 

        self.assertEqual( 

            'snapcraft.yaml already exists!\n', fake_logger.output) 

 

    @mock.patch('sys.stdout', new_callable=io.StringIO) 

    def test_init_without_parts_must_write_snapcraft_yaml(self, mock_stdout): 

        fake_logger = fixtures.FakeLogger(level=logging.INFO) 

        self.useFixture(fake_logger) 

 

        snap_without_parts = type('obj', (object, ), {'part': []}) 

        with self.assertRaises(SystemExit) as raised: 

            cmds.init(snap_without_parts) 

 

        self.assertEqual(raised.exception.code, 0, 'Wrong exit code returned.') 

        self.assertEqual( 

            'Wrote the following as snapcraft.yaml.\n', 

            fake_logger.output) 

 

        expected_out = ''' 

name: # the name of the snap 

version: # the version of the snap 

# The vendor for the snap (replace 'Vendor <email@example.com>') 

vendor: Vendor <email@example.com> 

summary: # 79 char long summary 

description: # A longer description for the snap 

icon: # A path to an icon for the package 

''' 

        self.assertEqual(mock_stdout.getvalue(), expected_out)