Merge "Add __author__ attr check"
This commit is contained in:
Jenkins
Gerrit Code Review
commit
bf4d6768e6
|
|
@ -1 +0,0 @@
|
|||
__author__ = 'nkonovalov'
|
||||
|
|
@ -1 +0,0 @@
|
|||
__author__ = 'nkonovalov'
|
||||
|
|
@ -13,115 +13,37 @@
|
|||
# See the License for the specific language governing permissions and
|
||||
# limitations under the License.
|
||||
|
||||
# Stolen from the hacking lib's trunk
|
||||
# TODO(slukjanov): remove it when it'll be released with hacking
|
||||
|
||||
import logging
|
||||
import re
|
||||
|
||||
# Don't need this for testing
|
||||
logging.disable('LOG')
|
||||
import tokenize
|
||||
|
||||
|
||||
def _check_for_exact_apache(start, lines):
|
||||
"""Check for the Apache 2.0 license header.
|
||||
def hacking_no_assert_equals(logical_line, tokens):
|
||||
r"""assertEquals() is deprecated, use assertEqual instead.
|
||||
|
||||
We strip all the newlines and extra spaces so this license string
|
||||
should work regardless of indentation in the file.
|
||||
"""
|
||||
APACHE2 = """
|
||||
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
|
||||
Copied from https://review.openstack.org/#/c/35962/
|
||||
|
||||
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."""
|
||||
|
||||
# out of all the formatting I've seen, a 12 line version seems to be the
|
||||
# longest in the source tree. So just take the 12 lines starting with where
|
||||
# the Apache starting words were found, strip all the '#' and collapse the
|
||||
# spaces.
|
||||
content = ''.join(lines[start:(start + 12)])
|
||||
content = re.sub('\#', '', content)
|
||||
content = re.sub('\s+', ' ', content)
|
||||
stripped_apache2 = re.sub('\s+', ' ', APACHE2)
|
||||
|
||||
if stripped_apache2 in content:
|
||||
return True
|
||||
else:
|
||||
print ("<license>!=<apache2>:\n'%s' !=\n'%s'" %
|
||||
(stripped_apache2, content))
|
||||
return False
|
||||
|
||||
|
||||
def _project_is_apache():
|
||||
"""Determine if a project is Apache.
|
||||
|
||||
Look for a key string in a set of possible license files to figure out
|
||||
if a project looks to be Apache. This is used as a precondition for
|
||||
enforcing license headers.
|
||||
Okay: self.assertEqual(0, 0)
|
||||
S362: self.assertEquals(0, 0)
|
||||
"""
|
||||
|
||||
license_files = ["LICENSE"]
|
||||
for filename in license_files:
|
||||
try:
|
||||
with open(filename, "r") as file:
|
||||
for line in file:
|
||||
if re.search('Apache License', line):
|
||||
return True
|
||||
except IOError:
|
||||
pass
|
||||
return False
|
||||
for token_type, text, start_index, _, _ in tokens:
|
||||
|
||||
if token_type == tokenize.NAME and text == "assertEquals":
|
||||
yield (
|
||||
start_index[1],
|
||||
"S362: assertEquals is deprecated, use assertEqual")
|
||||
|
||||
|
||||
def hacking_has_license(physical_line, filename, lines, line_number):
|
||||
"""Check for Apache 2.0 license.
|
||||
def hacking_no_author_attr(logical_line, tokens):
|
||||
"""__author__ should not be used.
|
||||
|
||||
H102 license header not found
|
||||
S363: __author__ = slukjanov
|
||||
"""
|
||||
# don't work about init files for now
|
||||
# TODO(sdague): enforce license in init file if it's not empty of content
|
||||
license_found = False
|
||||
|
||||
# skip files that are < 10 lines, which isn't enough for a license to fit
|
||||
# this allows us to handle empty files, as well as not fail on the Okay
|
||||
# doctests.
|
||||
if _project_is_apache() and not line_number > 1 and len(lines) > 10:
|
||||
for idx, line in enumerate(lines):
|
||||
# if it's more than 10 characters in, it's probably not in the
|
||||
# header
|
||||
if 0 < line.find('Licensed under the Apache License') < 10:
|
||||
license_found = True
|
||||
if not license_found:
|
||||
return (0, "H102: Apache 2.0 license header not found")
|
||||
|
||||
|
||||
def hacking_has_correct_license(physical_line, filename, lines, line_number):
|
||||
"""Check for Apache 2.0 license.
|
||||
|
||||
H103 header does not match Apache 2.0 License notice
|
||||
"""
|
||||
# don't work about init files for now
|
||||
# TODO(sdague): enforce license in init file if it's not empty of content
|
||||
|
||||
# skip files that are < 10 lines, which isn't enough for a license to fit
|
||||
# this allows us to handle empty files, as well as not fail on the Okay
|
||||
# doctests.
|
||||
if _project_is_apache() and not line_number > 1 and len(lines) > 10:
|
||||
for idx, line in enumerate(lines):
|
||||
# if it's more than 10 characters in, it's probably not in the
|
||||
# header
|
||||
if (0 < line.find('Licensed under the Apache License') < 10
|
||||
and not _check_for_exact_apache(idx, lines)):
|
||||
return (idx, "H103: Header does not match Apache 2.0 "
|
||||
"License notice")
|
||||
for token_type, text, start_index, _, _ in tokens:
|
||||
if token_type == tokenize.NAME and text == "__author__":
|
||||
yield (start_index[1],
|
||||
"S363: __author__ should not be used")
|
||||
|
||||
|
||||
def factory(register):
|
||||
register(hacking_has_license)
|
||||
register(hacking_has_correct_license)
|
||||
register(hacking_no_assert_equals)
|
||||
register(hacking_no_author_attr)
|
||||
|
|
|
|||
Loading…
Reference in New Issue