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 #5544 from duohedron/boilerplate
Get rid of python scripts in build process
- Loading branch information
Showing
5 changed files
with
173 additions
and
178 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
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,164 @@ | ||
| /* | ||
| Copyright 2019 The Kubernetes Authors All rights reserved. | ||
| 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. | ||
| */ | ||
|
|
||
| package main | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "flag" | ||
| "fmt" | ||
| "io/ioutil" | ||
| "log" | ||
| "os" | ||
| "path/filepath" | ||
| "regexp" | ||
| "strings" | ||
| ) | ||
|
|
||
| var ( | ||
| boilerplatedir = flag.String("boilerplate-dir", ".", "Boilerplate directory for boilerplate files") | ||
| rootdir = flag.String("rootdir", "../../", "Root directory to examine") | ||
| verbose = flag.Bool("v", false, "Verbose") | ||
| skippedPaths = regexp.MustCompile(`Godeps|third_party|_gopath|_output|\.git|cluster/env.sh|vendor|test/e2e/generated/bindata.go|site/themes/docsy`) | ||
| windowdNewLine = regexp.MustCompile(`\r`) | ||
| txtExtension = regexp.MustCompile(`\.txt`) | ||
| goBuildTag = regexp.MustCompile(`(?m)^(// \+build.*\n)+\n`) | ||
| shebang = regexp.MustCompile(`(?m)^(#!.*\n)\n*`) | ||
| copyright = regexp.MustCompile(`Copyright YEAR`) | ||
| copyrightReal = regexp.MustCompile(`Copyright \d{4}`) | ||
| ) | ||
|
|
||
| func main() { | ||
| flag.Parse() | ||
| refs, err := extensionToBoilerplate(*boilerplatedir) | ||
| if err != nil { | ||
| log.Fatal(err) | ||
| } | ||
| if len(refs) == 0 { | ||
| log.Fatal("no references in ", *boilerplatedir) | ||
| } | ||
| files, err := filesToCheck(*rootdir, refs) | ||
| if err != nil { | ||
| log.Fatal(err) | ||
| } | ||
| for _, file := range files { | ||
| pass, err := filePasses(file, refs[filepath.Ext(file)]) | ||
| if err != nil { | ||
| log.Println(err) | ||
| } | ||
| if !pass { | ||
| path, err := filepath.Abs(file) | ||
| if err != nil { | ||
| log.Println(err) | ||
| } | ||
| fmt.Println(path) | ||
| } | ||
| } | ||
|
|
||
| } | ||
|
|
||
| // extensionToBoilerplate returns a map of file extension to required boilerplate text. | ||
| func extensionToBoilerplate(dir string) (map[string][]byte, error) { | ||
| refs := make(map[string][]byte) | ||
| files, _ := filepath.Glob(dir + "/*.txt") | ||
| for _, filename := range files { | ||
| extension := strings.ToLower(filepath.Ext(txtExtension.ReplaceAllString(filename, ""))) | ||
| data, err := ioutil.ReadFile(filename) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| refs[extension] = windowdNewLine.ReplaceAll(data, nil) | ||
| } | ||
| if *verbose { | ||
| dir, err := filepath.Abs(dir) | ||
| if err != nil { | ||
| return refs, err | ||
| } | ||
| fmt.Printf("Found %v boilerplates in %v for the following extensions:", len(refs), dir) | ||
| for ext := range refs { | ||
| fmt.Printf(" %v", ext) | ||
| } | ||
| fmt.Println() | ||
| } | ||
| return refs, nil | ||
| } | ||
|
|
||
| // filePasses checks whether the processed file is valid. Returning false means that the file does not the proper boilerplate template. | ||
| func filePasses(filename string, expectedBoilerplate []byte) (bool, error) { | ||
| data, err := ioutil.ReadFile(filename) | ||
| if err != nil { | ||
| return false, err | ||
| } | ||
| data = windowdNewLine.ReplaceAll(data, nil) | ||
|
|
||
| extension := filepath.Ext(filename) | ||
|
|
||
| // remove build tags from the top of Go files | ||
| if extension == ".go" { | ||
| data = goBuildTag.ReplaceAll(data, nil) | ||
| } | ||
|
|
||
| // remove shebang from the top of shell files | ||
| if extension == ".sh" { | ||
| data = shebang.ReplaceAll(data, nil) | ||
| } | ||
|
|
||
| // if our test file is smaller than the reference it surely fails! | ||
| if len(data) < len(expectedBoilerplate) { | ||
| return false, nil | ||
| } | ||
|
|
||
| data = data[:len(expectedBoilerplate)] | ||
|
|
||
| // Search for "Copyright YEAR" which exists in the boilerplate, but shouldn't in the real thing | ||
| if copyright.Match(data) { | ||
| return false, nil | ||
| } | ||
|
|
||
| // Replace all occurrences of the regex "Copyright \d{4}" with "Copyright YEAR" | ||
| data = copyrightReal.ReplaceAll(data, []byte(`Copyright YEAR`)) | ||
|
|
||
| return bytes.Equal(data, expectedBoilerplate), nil | ||
| } | ||
|
|
||
| // filesToCheck returns the list of the filers that will be checked for the boilerplate. | ||
| func filesToCheck(rootDir string, extensions map[string][]byte) ([]string, error) { | ||
| var outFiles []string | ||
| err := filepath.Walk(rootDir, func(path string, info os.FileInfo, err error) error { | ||
| // remove current workdir from the beginig of the path in case it matches the skipped path | ||
| cwd, _ := os.Getwd() | ||
| // replace "\" with "\\" for windows style path | ||
| re := regexp.MustCompile(`\\`) | ||
| re = regexp.MustCompile(`^` + re.ReplaceAllString(cwd, `\\`)) | ||
| if !info.IsDir() && !skippedPaths.MatchString(re.ReplaceAllString(filepath.Dir(path), "")) { | ||
| if extensions[strings.ToLower(filepath.Ext(path))] != nil { | ||
| outFiles = append(outFiles, path) | ||
| } | ||
| } | ||
| return nil | ||
| }) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| if *verbose { | ||
| rootDir, err = filepath.Abs(rootDir) | ||
| if err != nil { | ||
| return outFiles, err | ||
| } | ||
| fmt.Printf("Found %v files to check in %v\n\n", len(outFiles), rootDir) | ||
| } | ||
| return outFiles, nil | ||
| } |
This file was deleted.
Oops, something went wrong.
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