blob: d11ee3efd76f749e8eb93901dc4e1c1817772e60 [file] [log] [blame]
#!/usr/bin/python2
# -*- coding: utf-8 -*-
# Copyright (c) 2012 The Chromium OS Authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.
"""Unittests for pre-upload.py."""
from __future__ import print_function
import os
import sys
import errors
# pylint: disable=W0212
# We access private members of the pre_upload module all over the place.
# Make sure we can find the chromite paths.
sys.path.insert(0, os.path.join(os.path.dirname(os.path.realpath(__file__)),
'..', '..'))
from chromite.cbuildbot import constants
from chromite.lib import cros_test_lib
from chromite.lib import git
from chromite.lib import osutils
# Needs to be after chromite imports so we use the bundled copy.
import mock
pre_upload = __import__('pre-upload')
def ProjectNamed(project_name):
"""Wrapper to create a Project with just the name"""
return pre_upload.Project(project_name, None, None)
class TryUTF8DecodeTest(cros_test_lib.TestCase):
"""Verify we sanely handle unicode content."""
def runTest(self):
self.assertEquals(u'', pre_upload._try_utf8_decode(''))
self.assertEquals(u'abc', pre_upload._try_utf8_decode('abc'))
self.assertEquals(
u'你好布萊恩',
pre_upload._try_utf8_decode('你好布萊恩'))
# Invalid UTF-8
self.assertEquals('\x80', pre_upload._try_utf8_decode('\x80'))
class CheckNoLongLinesTest(cros_test_lib.MockTestCase):
"""Tests for _check_no_long_lines."""
def setUp(self):
self.PatchObject(pre_upload, '_get_affected_files', return_value=['x.py'])
self.PatchObject(pre_upload, '_filter_files', return_value=['x.py'])
self.diff_mock = self.PatchObject(pre_upload, '_get_file_diff')
def runTest(self):
self.diff_mock.return_value = [
(1, u"x" * 80), # OK
(2, "\x80" * 80), # OK
(3, u"x" * 81), # Too long
(4, "\x80" * 81), # Too long
(5, u"See http://" + (u"x" * 80)), # OK (URL)
(6, u"See https://" + (u"x" * 80)), # OK (URL)
(7, u"# define " + (u"x" * 80)), # OK (compiler directive)
(8, u"#define" + (u"x" * 74)), # Too long
]
failure = pre_upload._check_no_long_lines(ProjectNamed('PROJECT'), 'COMMIT')
self.assertTrue(failure)
self.assertEquals('Found lines longer than 80 characters (first 5 shown):',
failure.msg)
self.assertEquals(['x.py, line %d, 81 chars' % line
for line in [3, 4, 8]],
failure.items)
class CheckProjectPrefix(cros_test_lib.MockTempDirTestCase):
"""Tests for _check_project_prefix."""
def setUp(self):
self.orig_cwd = os.getcwd()
os.chdir(self.tempdir)
self.file_mock = self.PatchObject(pre_upload, '_get_affected_files')
self.desc_mock = self.PatchObject(pre_upload, '_get_commit_desc')
def tearDown(self):
os.chdir(self.orig_cwd)
def _WriteAliasFile(self, filename, project):
"""Writes a project name to a file, creating directories if needed."""
os.makedirs(os.path.dirname(filename))
osutils.WriteFile(filename, project)
def testInvalidPrefix(self):
"""Report an error when the prefix doesn't match the base directory."""
self.file_mock.return_value = ['foo/foo.cc', 'foo/subdir/baz.cc']
self.desc_mock.return_value = 'bar: Some commit'
failure = pre_upload._check_project_prefix(ProjectNamed('PROJECT'),
'COMMIT')
self.assertTrue(failure)
self.assertEquals(('The commit title for changes affecting only foo' +
' should start with "foo: "'), failure.msg)
def testValidPrefix(self):
"""Use a prefix that matches the base directory."""
self.file_mock.return_value = ['foo/foo.cc', 'foo/subdir/baz.cc']
self.desc_mock.return_value = 'foo: Change some files.'
self.assertFalse(
pre_upload._check_project_prefix(ProjectNamed('PROJECT'), 'COMMIT'))
def testAliasFile(self):
"""Use .project_alias to override the project name."""
self._WriteAliasFile('foo/.project_alias', 'project')
self.file_mock.return_value = ['foo/foo.cc', 'foo/subdir/bar.cc']
self.desc_mock.return_value = 'project: Use an alias.'
self.assertFalse(
pre_upload._check_project_prefix(ProjectNamed('PROJECT'), 'COMMIT'))
def testAliasFileWithSubdirs(self):
"""Check that .project_alias is used when only modifying subdirectories."""
self._WriteAliasFile('foo/.project_alias', 'project')
self.file_mock.return_value = [
'foo/subdir/foo.cc',
'foo/subdir/bar.cc'
'foo/subdir/blah/baz.cc'
]
self.desc_mock.return_value = 'project: Alias with subdirs.'
self.assertFalse(
pre_upload._check_project_prefix(ProjectNamed('PROJECT'), 'COMMIT'))
class CheckKernelConfig(cros_test_lib.MockTestCase):
"""Tests for _kernel_configcheck."""
def setUp(self):
self.file_mock = self.PatchObject(pre_upload, '_get_affected_files')
def testMixedChanges(self):
"""Mixing of changes should fail."""
self.file_mock.return_value = [
'/kernel/files/chromeos/config/base.config',
'/kernel/files/arch/arm/mach-exynos/mach-exynos5-dt.c'
]
failure = pre_upload._kernel_configcheck('PROJECT', 'COMMIT')
self.assertTrue(failure)
def testCodeOnly(self):
"""Code-only changes should pass."""
self.file_mock.return_value = [
'/kernel/files/Makefile',
'/kernel/files/arch/arm/mach-exynos/mach-exynos5-dt.c'
]
failure = pre_upload._kernel_configcheck('PROJECT', 'COMMIT')
self.assertFalse(failure)
def testConfigOnlyChanges(self):
"""Config-only changes should pass."""
self.file_mock.return_value = [
'/kernel/files/chromeos/config/base.config',
]
failure = pre_upload._kernel_configcheck('PROJECT', 'COMMIT')
self.assertFalse(failure)
class CheckPortageMakeUseVar(cros_test_lib.MockTestCase):
"""Tests for _check_portage_make_use_var."""
def setUp(self):
self.file_mock = self.PatchObject(pre_upload, '_get_affected_files')
self.content_mock = self.PatchObject(pre_upload, '_get_file_content')
def testMakeConfOmitsOriginalUseValue(self):
"""Fail for make.conf that discards the previous value of $USE."""
self.file_mock.return_value = ['make.conf']
self.content_mock.return_value = 'USE="foo"\nUSE="${USE} bar"'
failure = pre_upload._check_portage_make_use_var('PROJECT', 'COMMIT')
self.assertTrue(failure, failure)
def testMakeConfCorrectUsage(self):
"""Succeed for make.conf that preserves the previous value of $USE."""
self.file_mock.return_value = ['make.conf']
self.content_mock.return_value = 'USE="${USE} foo"\nUSE="${USE}" bar'
failure = pre_upload._check_portage_make_use_var('PROJECT', 'COMMIT')
self.assertFalse(failure, failure)
def testMakeDefaultsReferencesOriginalUseValue(self):
"""Fail for make.defaults that refers to a not-yet-set $USE value."""
self.file_mock.return_value = ['make.defaults']
self.content_mock.return_value = 'USE="${USE} foo"'
failure = pre_upload._check_portage_make_use_var('PROJECT', 'COMMIT')
self.assertTrue(failure, failure)
# Also check for "$USE" without curly brackets.
self.content_mock.return_value = 'USE="$USE foo"'
failure = pre_upload._check_portage_make_use_var('PROJECT', 'COMMIT')
self.assertTrue(failure, failure)
def testMakeDefaultsOverwritesUseValue(self):
"""Fail for make.defaults that discards its own $USE value."""
self.file_mock.return_value = ['make.defaults']
self.content_mock.return_value = 'USE="foo"\nUSE="bar"'
failure = pre_upload._check_portage_make_use_var('PROJECT', 'COMMIT')
self.assertTrue(failure, failure)
def testMakeDefaultsCorrectUsage(self):
"""Succeed for make.defaults that sets and preserves $USE."""
self.file_mock.return_value = ['make.defaults']
self.content_mock.return_value = 'USE="foo"\nUSE="${USE}" bar'
failure = pre_upload._check_portage_make_use_var('PROJECT', 'COMMIT')
self.assertFalse(failure, failure)
class CheckEbuildEapi(cros_test_lib.MockTestCase):
"""Tests for _check_ebuild_eapi."""
PORTAGE_STABLE = ProjectNamed('chromiumos/overlays/portage-stable')
def setUp(self):
self.file_mock = self.PatchObject(pre_upload, '_get_affected_files')
self.content_mock = self.PatchObject(pre_upload, '_get_file_content')
self.diff_mock = self.PatchObject(pre_upload, '_get_file_diff',
side_effect=Exception())
def testSkipUpstreamOverlays(self):
"""Skip ebuilds found in upstream overlays."""
self.file_mock.side_effect = Exception()
ret = pre_upload._check_ebuild_eapi(self.PORTAGE_STABLE, 'HEAD')
self.assertEqual(ret, None)
# Make sure our condition above triggers.
self.assertRaises(Exception, pre_upload._check_ebuild_eapi, 'o', 'HEAD')
def testSkipNonEbuilds(self):
"""Skip non-ebuild files."""
self.content_mock.side_effect = Exception()
self.file_mock.return_value = ['some-file', 'ebuild/dir', 'an.ebuild~']
ret = pre_upload._check_ebuild_eapi(ProjectNamed('overlay'), 'HEAD')
self.assertEqual(ret, None)
# Make sure our condition above triggers.
self.file_mock.return_value.append('a/real.ebuild')
self.assertRaises(Exception, pre_upload._check_ebuild_eapi,
ProjectNamed('o'), 'HEAD')
def testSkipSymlink(self):
"""Skip files that are just symlinks."""
self.file_mock.return_value = ['a-r1.ebuild']
self.content_mock.return_value = 'a.ebuild'
ret = pre_upload._check_ebuild_eapi(ProjectNamed('overlay'), 'HEAD')
self.assertEqual(ret, None)
def testRejectEapiImplicit0Content(self):
"""Reject ebuilds that do not declare EAPI (so it's 0)."""
self.file_mock.return_value = ['a.ebuild']
self.content_mock.return_value = """# Header
IUSE="foo"
src_compile() { }
"""
ret = pre_upload._check_ebuild_eapi(ProjectNamed('overlay'), 'HEAD')
self.assertTrue(isinstance(ret, errors.HookFailure))
def testRejectExplicitEapi1Content(self):
"""Reject ebuilds that do declare old EAPI explicitly."""
self.file_mock.return_value = ['a.ebuild']
template = """# Header
EAPI=%s
IUSE="foo"
src_compile() { }
"""
# Make sure we only check the first EAPI= setting.
self.content_mock.return_value = template % '1\nEAPI=4'
ret = pre_upload._check_ebuild_eapi(ProjectNamed('overlay'), 'HEAD')
self.assertTrue(isinstance(ret, errors.HookFailure))
# Verify we handle double quotes too.
self.content_mock.return_value = template % '"1"'
ret = pre_upload._check_ebuild_eapi(ProjectNamed('overlay'), 'HEAD')
self.assertTrue(isinstance(ret, errors.HookFailure))
# Verify we handle single quotes too.
self.content_mock.return_value = template % "'1'"
ret = pre_upload._check_ebuild_eapi(ProjectNamed('overlay'), 'HEAD')
self.assertTrue(isinstance(ret, errors.HookFailure))
def testAcceptExplicitEapi4Content(self):
"""Accept ebuilds that do declare new EAPI explicitly."""
self.file_mock.return_value = ['a.ebuild']
template = """# Header
EAPI=%s
IUSE="foo"
src_compile() { }
"""
# Make sure we only check the first EAPI= setting.
self.content_mock.return_value = template % '4\nEAPI=1'
ret = pre_upload._check_ebuild_eapi(ProjectNamed('overlay'), 'HEAD')
self.assertEqual(ret, None)
# Verify we handle double quotes too.
self.content_mock.return_value = template % '"5"'
ret = pre_upload._check_ebuild_eapi(ProjectNamed('overlay'), 'HEAD')
self.assertEqual(ret, None)
# Verify we handle single quotes too.
self.content_mock.return_value = template % "'5-hdepend'"
ret = pre_upload._check_ebuild_eapi(ProjectNamed('overlay'), 'HEAD')
self.assertEqual(ret, None)
class CheckEbuildKeywords(cros_test_lib.MockTestCase):
"""Tests for _check_ebuild_keywords."""
def setUp(self):
self.file_mock = self.PatchObject(pre_upload, '_get_affected_files')
self.content_mock = self.PatchObject(pre_upload, '_get_file_content')
def testNoEbuilds(self):
"""If no ebuilds are found, do not scan."""
self.file_mock.return_value = ['a.file', 'ebuild-is-not.foo']
ret = pre_upload._check_ebuild_keywords(ProjectNamed('overlay'), 'HEAD')
self.assertEqual(ret, None)
self.assertEqual(self.content_mock.call_count, 0)
def testSomeEbuilds(self):
"""If ebuilds are found, only scan them."""
self.file_mock.return_value = ['a.file', 'blah', 'foo.ebuild', 'cow']
self.content_mock.return_value = ''
ret = pre_upload._check_ebuild_keywords(ProjectNamed('overlay'), 'HEAD')
self.assertEqual(ret, None)
self.assertEqual(self.content_mock.call_count, 1)
def _CheckContent(self, content, fails):
"""Test helper for inputs/outputs.
Args:
content: The ebuild content to test.
fails: Whether |content| should trigger a hook failure.
"""
self.file_mock.return_value = ['a.ebuild']
self.content_mock.return_value = content
ret = pre_upload._check_ebuild_keywords(ProjectNamed('overlay'), 'HEAD')
if fails:
self.assertTrue(isinstance(ret, errors.HookFailure))
else:
self.assertEqual(ret, None)
self.assertEqual(self.content_mock.call_count, 1)
def testEmpty(self):
"""Check KEYWORDS= is accepted."""
self._CheckContent('# HEADER\nKEYWORDS=\nblah\n', False)
def testEmptyQuotes(self):
"""Check KEYWORDS="" is accepted."""
self._CheckContent('# HEADER\nKEYWORDS=" "\nblah\n', False)
def testStableGlob(self):
"""Check KEYWORDS=* is accepted."""
self._CheckContent('# HEADER\nKEYWORDS="\t*\t"\nblah\n', False)
def testUnstableGlob(self):
"""Check KEYWORDS=~* is accepted."""
self._CheckContent('# HEADER\nKEYWORDS="~* "\nblah\n', False)
def testRestrictedGlob(self):
"""Check KEYWORDS=-* is accepted."""
self._CheckContent('# HEADER\nKEYWORDS="\t-* arm"\nblah\n', False)
def testMissingGlobs(self):
"""Reject KEYWORDS missing any globs."""
self._CheckContent('# HEADER\nKEYWORDS="~arm x86"\nblah\n', True)
class CheckEbuildVirtualPv(cros_test_lib.MockTestCase):
"""Tests for _check_ebuild_virtual_pv."""
PORTAGE_STABLE = ProjectNamed('chromiumos/overlays/portage-stable')
CHROMIUMOS_OVERLAY = ProjectNamed('chromiumos/overlays/chromiumos')
BOARD_OVERLAY = ProjectNamed('chromiumos/overlays/board-overlays')
PRIVATE_OVERLAY = ProjectNamed('chromeos/overlays/overlay-link-private')
PRIVATE_VARIANT_OVERLAY = ProjectNamed('chromeos/overlays/'
'overlay-variant-daisy-spring-private')
def setUp(self):
self.file_mock = self.PatchObject(pre_upload, '_get_affected_files')
def testNoVirtuals(self):
"""Skip non virtual packages."""
self.file_mock.return_value = ['some/package/package-3.ebuild']
ret = pre_upload._check_ebuild_virtual_pv(ProjectNamed('overlay'), 'H')
self.assertEqual(ret, None)
def testCommonVirtuals(self):
"""Non-board overlays should use PV=1."""
template = 'virtual/foo/foo-%s.ebuild'
self.file_mock.return_value = [template % '1']
ret = pre_upload._check_ebuild_virtual_pv(self.CHROMIUMOS_OVERLAY, 'H')
self.assertEqual(ret, None)
self.file_mock.return_value = [template % '2']
ret = pre_upload._check_ebuild_virtual_pv(self.CHROMIUMOS_OVERLAY, 'H')
self.assertTrue(isinstance(ret, errors.HookFailure))
def testPublicBoardVirtuals(self):
"""Public board overlays should use PV=2."""
template = 'overlay-lumpy/virtual/foo/foo-%s.ebuild'
self.file_mock.return_value = [template % '2']
ret = pre_upload._check_ebuild_virtual_pv(self.BOARD_OVERLAY, 'H')
self.assertEqual(ret, None)
self.file_mock.return_value = [template % '2.5']
ret = pre_upload._check_ebuild_virtual_pv(self.BOARD_OVERLAY, 'H')
self.assertTrue(isinstance(ret, errors.HookFailure))
def testPublicBoardVariantVirtuals(self):
"""Public board variant overlays should use PV=2.5."""
template = 'overlay-variant-lumpy-foo/virtual/foo/foo-%s.ebuild'
self.file_mock.return_value = [template % '2.5']
ret = pre_upload._check_ebuild_virtual_pv(self.BOARD_OVERLAY, 'H')
self.assertEqual(ret, None)
self.file_mock.return_value = [template % '3']
ret = pre_upload._check_ebuild_virtual_pv(self.BOARD_OVERLAY, 'H')
self.assertTrue(isinstance(ret, errors.HookFailure))
def testPrivateBoardVirtuals(self):
"""Private board overlays should use PV=3."""
template = 'virtual/foo/foo-%s.ebuild'
self.file_mock.return_value = [template % '3']
ret = pre_upload._check_ebuild_virtual_pv(self.PRIVATE_OVERLAY, 'H')
self.assertEqual(ret, None)
self.file_mock.return_value = [template % '3.5']
ret = pre_upload._check_ebuild_virtual_pv(self.PRIVATE_OVERLAY, 'H')
self.assertTrue(isinstance(ret, errors.HookFailure))
def testPrivateBoardVariantVirtuals(self):
"""Private board variant overlays should use PV=3.5."""
template = 'virtual/foo/foo-%s.ebuild'
self.file_mock.return_value = [template % '3.5']
ret = pre_upload._check_ebuild_virtual_pv(self.PRIVATE_VARIANT_OVERLAY, 'H')
self.assertEqual(ret, None)
self.file_mock.return_value = [template % '4']
ret = pre_upload._check_ebuild_virtual_pv(self.PRIVATE_VARIANT_OVERLAY, 'H')
self.assertTrue(isinstance(ret, errors.HookFailure))
class CheckCrosLicenseCopyrightHeader(cros_test_lib.MockTestCase):
"""Tests for _check_cros_license."""
def setUp(self):
self.file_mock = self.PatchObject(pre_upload, '_get_affected_files')
self.content_mock = self.PatchObject(pre_upload, '_get_file_content')
def testOldHeaders(self):
"""Accept old header styles."""
HEADERS = (
('#!/bin/sh\n'
'# Copyright (c) 2012 The Chromium OS Authors. All rights reserved.\n'
'# Use of this source code is governed by a BSD-style license that'
' can be\n'
'# found in the LICENSE file.\n'),
('// Copyright 2010-13 The Chromium OS Authors. All rights reserved.\n'
'// Use of this source code is governed by a BSD-style license that'
' can be\n'
'// found in the LICENSE file.\n'),
)
self.file_mock.return_value = ['file']
for header in HEADERS:
self.content_mock.return_value = header
self.assertEqual(None, pre_upload._check_cros_license('proj', 'sha1'))
def testRejectC(self):
"""Reject the (c) in newer headers."""
HEADERS = (
('// Copyright (c) 2015 The Chromium OS Authors. All rights reserved.\n'
'// Use of this source code is governed by a BSD-style license that'
' can be\n'
'// found in the LICENSE file.\n'),
('// Copyright (c) 2020 The Chromium OS Authors. All rights reserved.\n'
'// Use of this source code is governed by a BSD-style license that'
' can be\n'
'// found in the LICENSE file.\n'),
)
self.file_mock.return_value = ['file']
for header in HEADERS:
self.content_mock.return_value = header
self.assertNotEqual(None, pre_upload._check_cros_license('proj', 'sha1'))
class CheckAOSPLicenseCopyrightHeader(cros_test_lib.MockTestCase):
"""Tests for _check_aosp_license."""
def setUp(self):
self.file_mock = self.PatchObject(pre_upload, '_get_affected_files')
self.content_mock = self.PatchObject(pre_upload, '_get_file_content')
def testHeaders(self):
"""Accept old header styles."""
HEADERS = (
"""//
// Copyright (C) 2011 The Android Open Source Project
//
// 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.
//
""",
"""#
# Copyright (c) 2015 The Android Open Source Project
#
# 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.
#
""",
)
self.file_mock.return_value = ['file']
for header in HEADERS:
self.content_mock.return_value = header
self.assertEqual(None, pre_upload._check_aosp_license('proj', 'sha1'))
def testRejectNoLinesAround(self):
"""Reject headers missing the empty lines before/after the license."""
HEADERS = (
"""# Copyright (c) 2015 The Android Open Source Project
#
# 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.
""",
)
self.file_mock.return_value = ['file']
for header in HEADERS:
self.content_mock.return_value = header
self.assertNotEqual(None, pre_upload._check_aosp_license('proj', 'sha1'))
class CheckLayoutConfTestCase(cros_test_lib.MockTestCase):
"""Tests for _check_layout_conf."""
def setUp(self):
self.file_mock = self.PatchObject(pre_upload, '_get_affected_files')
self.content_mock = self.PatchObject(pre_upload, '_get_file_content')
def assertAccepted(self, files, project='project', commit='fake sha1'):
"""Assert _check_layout_conf accepts |files|."""
self.file_mock.return_value = files
ret = pre_upload._check_layout_conf(project, commit)
self.assertEqual(ret, None, msg='rejected with:\n%s' % ret)
def assertRejected(self, files, project='project', commit='fake sha1'):
"""Assert _check_layout_conf rejects |files|."""
self.file_mock.return_value = files
ret = pre_upload._check_layout_conf(project, commit)
self.assertTrue(isinstance(ret, errors.HookFailure))
def GetLayoutConf(self, filters=()):
"""Return a valid layout.conf with |filters| lines removed."""
all_lines = [
'masters = portage-stable chromiumos',
'profile-formats = portage-2 profile-default-eapi',
'profile_eapi_when_unspecified = 5-progress',
'repo-name = link',
'thin-manifests = true',
'use-manifests = true',
]
lines = []
for line in all_lines:
for filt in filters:
if line.startswith(filt):
break
else:
lines.append(line)
return '\n'.join(lines)
def testNoFilesToCheck(self):
"""Don't blow up when there are no layout.conf files."""
self.assertAccepted([])
def testRejectRepoNameFile(self):
"""If profiles/repo_name is set, kick it out."""
self.assertRejected(['profiles/repo_name'])
def testAcceptValidLayoutConf(self):
"""Accept a fully valid layout.conf."""
self.content_mock.return_value = self.GetLayoutConf()
self.assertAccepted(['metadata/layout.conf'])
def testAcceptUnknownKeys(self):
"""Accept keys we don't explicitly know about."""
self.content_mock.return_value = self.GetLayoutConf() + '\nzzz-top = ok'
self.assertAccepted(['metadata/layout.conf'])
def testRejectUnsorted(self):
"""Reject an unsorted layout.conf."""
self.content_mock.return_value = 'zzz-top = bad\n' + self.GetLayoutConf()
self.assertRejected(['metadata/layout.conf'])
def testRejectMissingThinManifests(self):
"""Reject a layout.conf missing thin-manifests."""
self.content_mock.return_value = self.GetLayoutConf(
filters=['thin-manifests'])
self.assertRejected(['metadata/layout.conf'])
def testRejectMissingUseManifests(self):
"""Reject a layout.conf missing use-manifests."""
self.content_mock.return_value = self.GetLayoutConf(
filters=['use-manifests'])
self.assertRejected(['metadata/layout.conf'])
def testRejectMissingEapiFallback(self):
"""Reject a layout.conf missing profile_eapi_when_unspecified."""
self.content_mock.return_value = self.GetLayoutConf(
filters=['profile_eapi_when_unspecified'])
self.assertRejected(['metadata/layout.conf'])
def testRejectMissingRepoName(self):
"""Reject a layout.conf missing repo-name."""
self.content_mock.return_value = self.GetLayoutConf(filters=['repo-name'])
self.assertRejected(['metadata/layout.conf'])
class CommitMessageTestCase(cros_test_lib.MockTestCase):
"""Test case for funcs that check commit messages."""
def setUp(self):
self.msg_mock = self.PatchObject(pre_upload, '_get_commit_desc')
@staticmethod
def CheckMessage(_project, _commit):
raise AssertionError('Test class must declare CheckMessage')
# This dummy return is to silence pylint warning W1111 so we don't have to
# enable it for all the call sites below.
return 1 # pylint: disable=W0101
def assertMessageAccepted(self, msg, project=ProjectNamed('project'),
commit='1234'):
"""Assert _check_change_has_bug_field accepts |msg|."""
self.msg_mock.return_value = msg
ret = self.CheckMessage(project, commit)
self.assertEqual(ret, None)
def assertMessageRejected(self, msg, project=ProjectNamed('project'),
commit='1234'):
"""Assert _check_change_has_bug_field rejects |msg|."""
self.msg_mock.return_value = msg
ret = self.CheckMessage(project, commit)
self.assertTrue(isinstance(ret, errors.HookFailure))
class CheckCommitMessageBug(CommitMessageTestCase):
"""Tests for _check_change_has_bug_field."""
AOSP_PROJECT = pre_upload.Project(name='overlay', dir='', remote='aosp')
CROS_PROJECT = pre_upload.Project(name='overlay', dir='', remote='cros')
@staticmethod
def CheckMessage(project, commit):
return pre_upload._check_change_has_bug_field(project, commit)
def testNormal(self):
"""Accept a commit message w/a valid BUG."""
self.assertMessageAccepted('\nBUG=chromium:1234\n', self.CROS_PROJECT)
self.assertMessageAccepted('\nBUG=chrome-os-partner:1234\n',
self.CROS_PROJECT)
self.assertMessageAccepted('\nBUG=b:1234\n', self.CROS_PROJECT)
self.assertMessageAccepted('\nBug: 1234\n', self.AOSP_PROJECT)
self.assertMessageAccepted('\nBug:1234\n', self.AOSP_PROJECT)
def testNone(self):
"""Accept BUG=None."""
self.assertMessageAccepted('\nBUG=None\n', self.CROS_PROJECT)
self.assertMessageAccepted('\nBUG=none\n', self.CROS_PROJECT)
self.assertMessageAccepted('\nBug: None\n', self.AOSP_PROJECT)
self.assertMessageAccepted('\nBug:none\n', self.AOSP_PROJECT)
for project in (self.AOSP_PROJECT, self.CROS_PROJECT):
self.assertMessageRejected('\nBUG=NONE\n', project)
def testBlank(self):
"""Reject blank values."""
for project in (self.AOSP_PROJECT, self.CROS_PROJECT):
self.assertMessageRejected('\nBUG=\n', project)
self.assertMessageRejected('\nBUG= \n', project)
self.assertMessageRejected('\nBug:\n', project)
self.assertMessageRejected('\nBug: \n', project)
def testNotFirstLine(self):
"""Reject the first line."""
for project in (self.AOSP_PROJECT, self.CROS_PROJECT):
self.assertMessageRejected('BUG=None\n\n\n', project)
def testNotInline(self):
"""Reject not at the start of line."""
for project in (self.AOSP_PROJECT, self.CROS_PROJECT):
self.assertMessageRejected('\n BUG=None\n', project)
self.assertMessageRejected('\n\tBUG=None\n', project)
def testOldTrackers(self):
"""Reject commit messages using old trackers."""
self.assertMessageRejected('\nBUG=chromium-os:1234\n', self.CROS_PROJECT)
def testNoTrackers(self):
"""Reject commit messages w/invalid trackers."""
self.assertMessageRejected('\nBUG=booga:1234\n', self.CROS_PROJECT)
self.assertMessageRejected('\nBUG=br:1234\n', self.CROS_PROJECT)
def testMissing(self):
"""Reject commit messages w/no BUG line."""
self.assertMessageRejected('foo\n')
def testCase(self):
"""Reject bug lines that are not BUG."""
self.assertMessageRejected('\nbug=none\n')
class CheckCommitMessageCqDepend(CommitMessageTestCase):
"""Tests for _check_change_has_valid_cq_depend."""
@staticmethod
def CheckMessage(project, commit):
return pre_upload._check_change_has_valid_cq_depend(project, commit)
def testNormal(self):
"""Accept valid CQ-DEPENDs line."""
self.assertMessageAccepted('\nCQ-DEPEND=CL:1234\n')
def testInvalid(self):
"""Reject invalid CQ-DEPENDs line."""
self.assertMessageRejected('\nCQ-DEPEND=CL=1234\n')
self.assertMessageRejected('\nCQ-DEPEND=None\n')
class CheckCommitMessageTest(CommitMessageTestCase):
"""Tests for _check_change_has_test_field."""
@staticmethod
def CheckMessage(project, commit):
return pre_upload._check_change_has_test_field(project, commit)
def testNormal(self):
"""Accept a commit message w/a valid TEST."""
self.assertMessageAccepted('\nTEST=i did it\n')
def testNone(self):
"""Accept TEST=None."""
self.assertMessageAccepted('\nTEST=None\n')
self.assertMessageAccepted('\nTEST=none\n')
def testBlank(self):
"""Reject blank values."""
self.assertMessageRejected('\nTEST=\n')
self.assertMessageRejected('\nTEST= \n')
def testNotFirstLine(self):
"""Reject the first line."""
self.assertMessageRejected('TEST=None\n\n\n')
def testNotInline(self):
"""Reject not at the start of line."""
self.assertMessageRejected('\n TEST=None\n')
self.assertMessageRejected('\n\tTEST=None\n')
def testMissing(self):
"""Reject commit messages w/no TEST line."""
self.assertMessageRejected('foo\n')
def testCase(self):
"""Reject bug lines that are not TEST."""
self.assertMessageRejected('\ntest=none\n')
class CheckCommitMessageChangeId(CommitMessageTestCase):
"""Tests for _check_change_has_proper_changeid."""
@staticmethod
def CheckMessage(project, commit):
return pre_upload._check_change_has_proper_changeid(project, commit)
def testNormal(self):
"""Accept a commit message w/a valid Change-Id."""
self.assertMessageAccepted('foo\n\nChange-Id: I1234\n')
def testBlank(self):
"""Reject blank values."""
self.assertMessageRejected('\nChange-Id:\n')
self.assertMessageRejected('\nChange-Id: \n')
def testNotFirstLine(self):
"""Reject the first line."""
self.assertMessageRejected('TEST=None\n\n\n')
def testNotInline(self):
"""Reject not at the start of line."""
self.assertMessageRejected('\n Change-Id: I1234\n')
self.assertMessageRejected('\n\tChange-Id: I1234\n')
def testMissing(self):
"""Reject commit messages missing the line."""
self.assertMessageRejected('foo\n')
def testCase(self):
"""Reject bug lines that are not Change-Id."""
self.assertMessageRejected('\nchange-id: I1234\n')
self.assertMessageRejected('\nChange-id: I1234\n')
self.assertMessageRejected('\nChange-ID: I1234\n')
def testEnd(self):
"""Reject Change-Id's that are not last."""
self.assertMessageRejected('\nChange-Id: I1234\nbar\n')
def testSobTag(self):
"""Permit s-o-b tags to follow the Change-Id."""
self.assertMessageAccepted('foo\n\nChange-Id: I1234\nSigned-off-by: Hi\n')
class CheckCommitMessageStyle(CommitMessageTestCase):
"""Tests for _check_commit_message_style."""
@staticmethod
def CheckMessage(project, commit):
return pre_upload._check_commit_message_style(project, commit)
def testNormal(self):
"""Accept valid commit messages."""
self.assertMessageAccepted('one sentence.\n')
self.assertMessageAccepted('some.module: do it!\n')
self.assertMessageAccepted('one line\n\nmore stuff here.')
def testNoBlankSecondLine(self):
"""Reject messages that have stuff on the second line."""
self.assertMessageRejected('one sentence.\nbad fish!\n')
def testFirstLineMultipleSentences(self):
"""Reject messages that have more than one sentence in the summary."""
self.assertMessageRejected('one sentence. two sentence!\n')
def testFirstLineTooLone(self):
"""Reject first lines that are too long."""
self.assertMessageRejected('o' * 200)
def DiffEntry(src_file=None, dst_file=None, src_mode=None, dst_mode='100644',
status='M'):
"""Helper to create a stub RawDiffEntry object"""
if src_mode is None:
if status == 'A':
src_mode = '000000'
elif status == 'M':
src_mode = dst_mode
elif status == 'D':
src_mode = dst_mode
dst_mode = '000000'
src_sha = dst_sha = 'abc'
if status == 'D':
dst_sha = '000000'
elif status == 'A':
src_sha = '000000'
return git.RawDiffEntry(src_mode=src_mode, dst_mode=dst_mode, src_sha=src_sha,
dst_sha=dst_sha, status=status, score=None,
src_file=src_file, dst_file=dst_file)
class HelpersTest(cros_test_lib.MockTempDirTestCase):
"""Various tests for utility functions."""
def setUp(self):
self.orig_cwd = os.getcwd()
os.chdir(self.tempdir)
self.PatchObject(git, 'RawDiff', return_value=[
# A modified normal file.
DiffEntry(src_file='buildbot/constants.py', status='M'),
# A new symlink file.
DiffEntry(dst_file='scripts/cros_env_whitelist', dst_mode='120000',
status='A'),
# A deleted file.
DiffEntry(src_file='scripts/sync_sonic.py', status='D'),
])
def tearDown(self):
os.chdir(self.orig_cwd)
def _WritePresubmitIgnoreFile(self, subdir, data):
"""Writes to a .presubmitignore file in the passed-in subdirectory."""
directory = os.path.join(self.tempdir, subdir)
if not os.path.exists(directory):
os.makedirs(directory)
osutils.WriteFile(os.path.join(directory, pre_upload._IGNORE_FILE), data)
def testGetAffectedFilesNoDeletesNoRelative(self):
"""Verify _get_affected_files() works w/no delete & not relative."""
path = os.getcwd()
files = pre_upload._get_affected_files('HEAD', include_deletes=False,
relative=False)
exp_files = [os.path.join(path, 'buildbot/constants.py')]
self.assertEquals(files, exp_files)
def testGetAffectedFilesDeletesNoRelative(self):
"""Verify _get_affected_files() works w/delete & not relative."""
path = os.getcwd()
files = pre_upload._get_affected_files('HEAD', include_deletes=True,
relative=False)
exp_files = [os.path.join(path, 'buildbot/constants.py'),
os.path.join(path, 'scripts/sync_sonic.py')]
self.assertEquals(files, exp_files)
def testGetAffectedFilesNoDeletesRelative(self):
"""Verify _get_affected_files() works w/no delete & relative."""
files = pre_upload._get_affected_files('HEAD', include_deletes=False,
relative=True)
exp_files = ['buildbot/constants.py']
self.assertEquals(files, exp_files)
def testGetAffectedFilesDeletesRelative(self):
"""Verify _get_affected_files() works w/delete & relative."""
files = pre_upload._get_affected_files('HEAD', include_deletes=True,
relative=True)
exp_files = ['buildbot/constants.py', 'scripts/sync_sonic.py']
self.assertEquals(files, exp_files)
def testGetAffectedFilesDetails(self):
"""Verify _get_affected_files() works w/full_details."""
files = pre_upload._get_affected_files('HEAD', full_details=True,
relative=True)
self.assertEquals(files[0].src_file, 'buildbot/constants.py')
def testGetAffectedFilesPresubmitIgnoreDirectory(self):
"""Verify .presubmitignore can be used to exclude a directory."""
self._WritePresubmitIgnoreFile('.', 'buildbot/')
self.assertEquals(pre_upload._get_affected_files('HEAD', relative=True), [])
def testGetAffectedFilesPresubmitIgnoreDirectoryWildcard(self):
"""Verify .presubmitignore can be used with a directory wildcard."""
self._WritePresubmitIgnoreFile('.', '*/constants.py')
self.assertEquals(pre_upload._get_affected_files('HEAD', relative=True), [])
def testGetAffectedFilesPresubmitIgnoreWithinDirectory(self):
"""Verify .presubmitignore can be placed in a subdirectory."""
self._WritePresubmitIgnoreFile('buildbot', '*.py')
self.assertEquals(pre_upload._get_affected_files('HEAD', relative=True), [])
def testGetAffectedFilesPresubmitIgnoreDoesntMatch(self):
"""Verify .presubmitignore has no effect when it doesn't match a file."""
self._WritePresubmitIgnoreFile('buildbot', '*.txt')
self.assertEquals(pre_upload._get_affected_files('HEAD', relative=True),
['buildbot/constants.py'])
def testGetAffectedFilesPresubmitIgnoreAddedFile(self):
"""Verify .presubmitignore matches added files."""
self._WritePresubmitIgnoreFile('.', 'buildbot/\nscripts/')
self.assertEquals(pre_upload._get_affected_files('HEAD', relative=True,
include_symlinks=True),
[])
def testGetAffectedFilesPresubmitIgnoreSkipIgnoreFile(self):
"""Verify .presubmitignore files are automatically skipped."""
self.PatchObject(git, 'RawDiff', return_value=[
DiffEntry(src_file='.presubmitignore', status='M')
])
self.assertEquals(pre_upload._get_affected_files('HEAD', relative=True), [])
class CheckForUprev(cros_test_lib.MockTempDirTestCase):
"""Tests for _check_for_uprev."""
def setUp(self):
self.file_mock = self.PatchObject(git, 'RawDiff')
def _Files(self, files):
"""Create |files| in the tempdir and return full paths to them."""
for obj in files:
if obj.status == 'D':
continue
if obj.dst_file is None:
f = obj.src_file
else:
f = obj.dst_file
osutils.Touch(os.path.join(self.tempdir, f), makedirs=True)
return files
def assertAccepted(self, files, project='project', commit='fake sha1'):
"""Assert _check_for_uprev accepts |files|."""
self.file_mock.return_value = self._Files(files)
ret = pre_upload._check_for_uprev(ProjectNamed(project), commit,
project_top=self.tempdir)
self.assertEqual(ret, None)
def assertRejected(self, files, project='project', commit='fake sha1'):
"""Assert _check_for_uprev rejects |files|."""
self.file_mock.return_value = self._Files(files)
ret = pre_upload._check_for_uprev(ProjectNamed(project), commit,
project_top=self.tempdir)
self.assertTrue(isinstance(ret, errors.HookFailure))
def testWhitelistOverlay(self):
"""Skip checks on whitelisted overlays."""
self.assertAccepted([DiffEntry(src_file='cat/pkg/pkg-0.ebuild')],
project='chromiumos/overlays/portage-stable')
def testWhitelistFiles(self):
"""Skip checks on whitelisted files."""
files = ['ChangeLog', 'Manifest', 'metadata.xml']
self.assertAccepted([DiffEntry(src_file=os.path.join('c', 'p', x),
status='M')
for x in files])
def testRejectBasic(self):
"""Reject ebuilds missing uprevs."""
self.assertRejected([DiffEntry(src_file='c/p/p-0.ebuild', status='M')])
def testNewPackage(self):
"""Accept new ebuilds w/out uprevs."""
self.assertAccepted([DiffEntry(src_file='c/p/p-0.ebuild', status='A')])
self.assertAccepted([DiffEntry(src_file='c/p/p-0-r12.ebuild', status='A')])
def testModifiedFilesOnly(self):
"""Reject ebuilds w/out uprevs and changes in files/."""
osutils.Touch(os.path.join(self.tempdir, 'cat/pkg/pkg-0.ebuild'),
makedirs=True)
self.assertRejected([DiffEntry(src_file='cat/pkg/files/f', status='A')])
self.assertRejected([DiffEntry(src_file='cat/pkg/files/g', status='M')])
def testFilesNoEbuilds(self):
"""Ignore changes to paths w/out ebuilds."""
self.assertAccepted([DiffEntry(src_file='cat/pkg/files/f', status='A')])
self.assertAccepted([DiffEntry(src_file='cat/pkg/files/g', status='M')])
def testModifiedFilesWithUprev(self):
"""Accept ebuilds w/uprevs and changes in files/."""
self.assertAccepted([DiffEntry(src_file='c/p/files/f', status='A'),
DiffEntry(src_file='c/p/p-0.ebuild', status='A')])
self.assertAccepted([
DiffEntry(src_file='c/p/files/f', status='M'),
DiffEntry(src_file='c/p/p-0-r1.ebuild', src_mode='120000',
dst_file='c/p/p-0-r2.ebuild', dst_mode='120000', status='R')])
def testModifiedFilesWith9999(self):
"""Accept 9999 ebuilds and changes in files/."""
self.assertAccepted([DiffEntry(src_file='c/p/files/f', status='M'),
DiffEntry(src_file='c/p/p-9999.ebuild', status='M')])
class DirectMainTest(cros_test_lib.MockTempDirTestCase):
"""Tests for direct_main()"""
def setUp(self):
self.hooks_mock = self.PatchObject(pre_upload, '_run_project_hooks',
return_value=None)
def testNoArgs(self):
"""If run w/no args, should check the current dir."""
ret = pre_upload.direct_main([])
self.assertEqual(ret, 0)
self.hooks_mock.assert_called_once_with(
mock.ANY, proj_dir=os.getcwd(), commit_list=[], presubmit=mock.ANY)
def testExplicitDir(self):
"""Verify we can run on a diff dir."""
# Use the chromite dir since we know it exists.
ret = pre_upload.direct_main(['--dir', constants.CHROMITE_DIR])
self.assertEqual(ret, 0)
self.hooks_mock.assert_called_once_with(
mock.ANY, proj_dir=constants.CHROMITE_DIR, commit_list=[],
presubmit=mock.ANY)
def testBogusProject(self):
"""A bogus project name should be fine (use default settings)."""
# Use the chromite dir since we know it exists.
ret = pre_upload.direct_main(['--dir', constants.CHROMITE_DIR,
'--project', 'foooooooooo'])
self.assertEqual(ret, 0)
self.hooks_mock.assert_called_once_with(
'foooooooooo', proj_dir=constants.CHROMITE_DIR, commit_list=[],
presubmit=mock.ANY)
def testBogustProjectNoDir(self):
"""Make sure --dir is detected even with --project."""
ret = pre_upload.direct_main(['--project', 'foooooooooo'])
self.assertEqual(ret, 0)
self.hooks_mock.assert_called_once_with(
'foooooooooo', proj_dir=os.getcwd(), commit_list=[],
presubmit=mock.ANY)
def testNoGitDir(self):
"""We should die when run on a non-git dir."""
self.assertRaises(pre_upload.BadInvocation, pre_upload.direct_main,
['--dir', self.tempdir])
def testNoDir(self):
"""We should die when run on a missing dir."""
self.assertRaises(pre_upload.BadInvocation, pre_upload.direct_main,
['--dir', os.path.join(self.tempdir, 'foooooooo')])
def testCommitList(self):
"""Any args on the command line should be treated as commits."""
commits = ['sha1', 'sha2', 'shaaaaaaaaaaaan']
ret = pre_upload.direct_main(commits)
self.assertEqual(ret, 0)
self.hooks_mock.assert_called_once_with(
mock.ANY, proj_dir=mock.ANY, commit_list=commits, presubmit=mock.ANY)
if __name__ == '__main__':
cros_test_lib.main(module=__name__)