mirror of
https://github.com/elastic/eland.git
synced 2025-07-11 00:02:14 +08:00
127 lines
4.4 KiB
Python
127 lines
4.4 KiB
Python
# Licensed to Elasticsearch B.V. under one or more contributor
|
|
# license agreements. See the NOTICE file distributed with
|
|
# this work for additional information regarding copyright
|
|
# ownership. Elasticsearch B.V. licenses this file to you 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.
|
|
|
|
|
|
"""Script which verifies that all source files have a license header.
|
|
Has two modes: 'fix' and 'check'. 'fix' fixes problems, 'check' will
|
|
error out if 'fix' would have changed the file.
|
|
"""
|
|
|
|
import os
|
|
import sys
|
|
from itertools import chain
|
|
from typing import Iterator, List
|
|
|
|
lines_to_keep = ["# -*- coding: utf-8 -*-\n", "#!/usr/bin/env python\n"]
|
|
license_header_lines = [
|
|
"# Licensed to Elasticsearch B.V. under one or more contributor\n",
|
|
"# license agreements. See the NOTICE file distributed with\n",
|
|
"# this work for additional information regarding copyright\n",
|
|
"# ownership. Elasticsearch B.V. licenses this file to you under\n",
|
|
'# the Apache License, Version 2.0 (the "License"); you may\n',
|
|
"# not use this file except in compliance with the License.\n",
|
|
"# You may obtain a copy of the License at\n",
|
|
"#\n",
|
|
"# http://www.apache.org/licenses/LICENSE-2.0\n",
|
|
"#\n",
|
|
"# Unless required by applicable law or agreed to in writing,\n",
|
|
"# software distributed under the License is distributed on an\n",
|
|
'# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY\n',
|
|
"# KIND, either express or implied. See the License for the\n",
|
|
"# specific language governing permissions and limitations\n",
|
|
"# under the License.\n",
|
|
]
|
|
|
|
|
|
def find_files_to_fix(sources: List[str]) -> Iterator[str]:
|
|
"""Iterates over all files and dirs in 'sources' and returns
|
|
only the filepaths that need fixing.
|
|
"""
|
|
for source in sources:
|
|
if os.path.isfile(source) and does_file_need_fix(source):
|
|
yield source
|
|
elif os.path.isdir(source):
|
|
for root, _, filenames in os.walk(source):
|
|
for filename in filenames:
|
|
filepath = os.path.join(root, filename)
|
|
if does_file_need_fix(filepath):
|
|
yield filepath
|
|
|
|
|
|
def does_file_need_fix(filepath: str) -> bool:
|
|
if not filepath.endswith(".py"):
|
|
return False
|
|
with open(filepath) as f:
|
|
first_license_line = None
|
|
for line in f:
|
|
if line == license_header_lines[0]:
|
|
first_license_line = line
|
|
break
|
|
elif line not in lines_to_keep:
|
|
return True
|
|
for header_line, line in zip(
|
|
license_header_lines, chain((first_license_line,), f)
|
|
):
|
|
if line != header_line:
|
|
return True
|
|
return False
|
|
|
|
|
|
def add_header_to_file(filepath: str) -> None:
|
|
with open(filepath) as f:
|
|
lines = list(f)
|
|
i = 0
|
|
for i, line in enumerate(lines):
|
|
if line not in lines_to_keep:
|
|
break
|
|
new_lines = lines[:i] + license_header_lines
|
|
if lines and lines[i] != "\n":
|
|
lines = ["\n"] + lines
|
|
new_lines.extend(lines)
|
|
|
|
with open(filepath, mode="w") as f:
|
|
f.truncate()
|
|
f.write("".join(new_lines))
|
|
print(f"Fixed {os.path.relpath(filepath, os.getcwd())}")
|
|
|
|
|
|
def main():
|
|
mode = sys.argv[1]
|
|
assert mode in ("fix", "check")
|
|
sources = [os.path.abspath(x) for x in sys.argv[2:]]
|
|
files_to_fix = find_files_to_fix(sources)
|
|
|
|
if mode == "fix":
|
|
for filepath in files_to_fix:
|
|
add_header_to_file(filepath)
|
|
else:
|
|
no_license_headers = list(files_to_fix)
|
|
if no_license_headers:
|
|
print("No license header found in:")
|
|
cwd = os.getcwd()
|
|
[
|
|
print(f" - {os.path.relpath(filepath, cwd)}")
|
|
for filepath in no_license_headers
|
|
]
|
|
sys.exit(1)
|
|
else:
|
|
print("All files had license header")
|
|
|
|
|
|
if __name__ == "__main__":
|
|
main()
|