-
Notifications
You must be signed in to change notification settings - Fork 74
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #122 from sachinkumarsingh092/include-spellcheck-b…
…oilerplate-tests Add spelling and boilerplate checks
- Loading branch information
Showing
10 changed files
with
405 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
# Copyright YEAR The Kubernetes Authors. | ||
# | ||
# 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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
# Copyright YEAR The Kubernetes Authors. | ||
# | ||
# 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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
# Copyright YEAR The Kubernetes Authors. | ||
# | ||
# 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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
/* | ||
Copyright YEAR The Kubernetes Authors. | ||
|
||
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. | ||
*/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,202 @@ | ||
#!/usr/bin/env python | ||
|
||
# Copyright 2019 The Kubernetes Authors. | ||
# | ||
# 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. | ||
|
||
from __future__ import print_function | ||
|
||
import argparse | ||
import difflib | ||
import glob | ||
import json | ||
import mmap | ||
import os | ||
import re | ||
import sys | ||
from datetime import date | ||
|
||
parser = argparse.ArgumentParser() | ||
parser.add_argument( | ||
"filenames", | ||
help="list of files to check, all files if unspecified", | ||
nargs='*') | ||
|
||
# Rootdir defaults to the directory **above** the repo-infra dir. | ||
rootdir = os.path.dirname(__file__) + "./../../../" | ||
rootdir = os.path.abspath(rootdir) | ||
parser.add_argument( | ||
"--rootdir", default=rootdir, help="root directory to examine") | ||
|
||
default_boilerplate_dir = os.path.join(rootdir, "csi-driver-nfs/hack/boilerplate") | ||
|
||
parser.add_argument( | ||
"--boilerplate-dir", default=default_boilerplate_dir) | ||
|
||
parser.add_argument( | ||
"-v", "--verbose", | ||
help="give verbose output regarding why a file does not pass", | ||
action="store_true") | ||
|
||
args = parser.parse_args() | ||
|
||
verbose_out = sys.stderr if args.verbose else open("/dev/null", "w") | ||
|
||
def get_refs(): | ||
refs = {} | ||
|
||
for path in glob.glob(os.path.join(args.boilerplate_dir, "boilerplate.*.txt")): | ||
extension = os.path.basename(path).split(".")[1] | ||
|
||
ref_file = open(path, 'r') | ||
ref = ref_file.read().splitlines() | ||
ref_file.close() | ||
refs[extension] = ref | ||
|
||
return refs | ||
|
||
def file_passes(filename, refs, regexs): | ||
try: | ||
f = open(filename, 'r') | ||
except Exception as exc: | ||
print("Unable to open %s: %s" % (filename, exc), file=verbose_out) | ||
return False | ||
|
||
data = f.read() | ||
f.close() | ||
|
||
basename = os.path.basename(filename) | ||
extension = file_extension(filename) | ||
if extension != "": | ||
ref = refs[extension] | ||
else: | ||
ref = refs[basename] | ||
|
||
# remove build tags from the top of Go files | ||
if extension == "go": | ||
p = regexs["go_build_constraints"] | ||
(data, found) = p.subn("", data, 1) | ||
|
||
# remove shebang from the top of shell files | ||
if extension == "sh" or extension == "py": | ||
p = regexs["shebang"] | ||
(data, found) = p.subn("", data, 1) | ||
|
||
data = data.splitlines() | ||
|
||
# if our test file is smaller than the reference it surely fails! | ||
if len(ref) > len(data): | ||
print('File %s smaller than reference (%d < %d)' % | ||
(filename, len(data), len(ref)), | ||
file=verbose_out) | ||
return False | ||
|
||
# trim our file to the same number of lines as the reference file | ||
data = data[:len(ref)] | ||
|
||
p = regexs["year"] | ||
for d in data: | ||
if p.search(d): | ||
print('File %s is missing the year' % filename, file=verbose_out) | ||
return False | ||
|
||
# Replace all occurrences of the regex "CURRENT_YEAR|...|2016|2015|2014" with "YEAR" | ||
p = regexs["date"] | ||
for i, d in enumerate(data): | ||
(data[i], found) = p.subn('YEAR', d) | ||
if found != 0: | ||
break | ||
|
||
# if we don't match the reference at this point, fail | ||
if ref != data: | ||
print("Header in %s does not match reference, diff:" % filename, file=verbose_out) | ||
if args.verbose: | ||
print(file=verbose_out) | ||
for line in difflib.unified_diff(ref, data, 'reference', filename, lineterm=''): | ||
print(line, file=verbose_out) | ||
print(file=verbose_out) | ||
return False | ||
|
||
return True | ||
|
||
def file_extension(filename): | ||
return os.path.splitext(filename)[1].split(".")[-1].lower() | ||
|
||
skipped_dirs = ['Godeps', 'third_party', '_gopath', '_output', '.git', | ||
'cluster/env.sh', 'vendor', 'test/e2e/generated/bindata.go', | ||
'repo-infra/verify/boilerplate/test', '.glide'] | ||
|
||
def normalize_files(files): | ||
newfiles = [] | ||
for pathname in files: | ||
if any(x in pathname for x in skipped_dirs): | ||
continue | ||
newfiles.append(pathname) | ||
return newfiles | ||
|
||
def get_files(extensions): | ||
files = [] | ||
if len(args.filenames) > 0: | ||
files = args.filenames | ||
else: | ||
for root, dirs, walkfiles in os.walk(args.rootdir): | ||
# don't visit certain dirs. This is just a performance improvement | ||
# as we would prune these later in normalize_files(). But doing it | ||
# cuts down the amount of filesystem walking we do and cuts down | ||
# the size of the file list | ||
for d in skipped_dirs: | ||
if d in dirs: | ||
dirs.remove(d) | ||
|
||
for name in walkfiles: | ||
pathname = os.path.join(root, name) | ||
files.append(pathname) | ||
|
||
files = normalize_files(files) | ||
|
||
outfiles = [] | ||
for pathname in files: | ||
basename = os.path.basename(pathname) | ||
extension = file_extension(pathname) | ||
if extension in extensions or basename in extensions: | ||
outfiles.append(pathname) | ||
return outfiles | ||
|
||
def get_regexs(): | ||
regexs = {} | ||
# Search for "YEAR" which exists in the boilerplate, but shouldn't in the real thing | ||
regexs["year"] = re.compile( 'YEAR' ) | ||
# dates can be 2014, 2015, 2016, ..., CURRENT_YEAR, company holder names can be anything | ||
years = range(2014, date.today().year + 1) | ||
regexs["date"] = re.compile( '(%s)' % "|".join(map(lambda l: str(l), years)) ) | ||
# strip // +build \n\n build constraints | ||
regexs["go_build_constraints"] = re.compile(r"^(// \+build.*\n)+\n", re.MULTILINE) | ||
# strip #!.* from shell scripts | ||
regexs["shebang"] = re.compile(r"^(#!.*\n)\n*", re.MULTILINE) | ||
return regexs | ||
|
||
|
||
|
||
def main(): | ||
regexs = get_regexs() | ||
refs = get_refs() | ||
filenames = get_files(refs.keys()) | ||
|
||
for filename in filenames: | ||
if not file_passes(filename, refs, regexs): | ||
print(filename, file=sys.stdout) | ||
|
||
return 0 | ||
|
||
if __name__ == "__main__": | ||
sys.exit(main()) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
# Copyright YEAR The Kubernetes Authors. | ||
# | ||
# 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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
# Copyright YEAR The Kubernetes Authors. | ||
# | ||
# 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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
#!/bin/bash | ||
|
||
# Copyright 2014 The Kubernetes Authors. | ||
# | ||
# 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. | ||
|
||
set -o errexit | ||
set -o nounset | ||
set -o pipefail | ||
|
||
echo "Verifying boilerplate" | ||
|
||
if [[ -z "$(command -v python)" ]]; then | ||
echo "Cannot find python. Make link to python3..." | ||
update-alternatives --install /usr/bin/python python /usr/bin/python3 1 | ||
fi | ||
|
||
REPO_ROOT=$(dirname "${BASH_SOURCE[0]}") | ||
|
||
boilerDir="${REPO_ROOT}/boilerplate" | ||
boiler="${boilerDir}/boilerplate.py" | ||
|
||
files_need_boilerplate=("$("${boiler}" --rootdir="${REPO_ROOT}" --verbose)") | ||
|
||
# Run boilerplate.py unit tests | ||
unitTestOut="$(mktemp)" | ||
trap cleanup EXIT | ||
cleanup() { | ||
rm "${unitTestOut}" | ||
} | ||
|
||
# Run boilerplate check | ||
if [[ ${#files_need_boilerplate[@]} -gt 0 ]]; then | ||
for file in "${files_need_boilerplate[@]}"; do | ||
echo "Boilerplate header is wrong for: ${file}" | ||
done | ||
|
||
exit 1 | ||
fi | ||
|
||
echo "Done" |
Oops, something went wrong.