Changed copyright check to the new standard from PR 1422. (rust-lang#1447)

* Changed copyright check to the new standard PR 1422.

* Fixed debug print.

* Added doc comment.

* Changed to proper doc-comment

* reverted test cases

* Changed generator test cases to new format.

* Added check that above our license is empty or comments

* Fixed merge fail

* Escaped backslash.

* Allowed empty 2nd line pattern discussed in rust-lang#1422

* Test case for maybe empty lines above.

* Changed from list to generator.

Author: Yoshiki Takashima

scripts/ci/copyright_check.py

@@ -5,12 +5,16 @@
 import sys
 import os.path as path
 from enum import Enum
+from itertools import chain
+
+
+COMMENT_OR_EMPTY_PATTERN = '^(//.*$|#.*$|\\s*$)'
 
 STANDARD_HEADER_PATTERN_1 = '(//|#) Copyright Kani Contributors'
 STANDARD_HEADER_PATTERN_2 = '(//|#) SPDX-License-Identifier: Apache-2.0 OR MIT'
 
 MODIFIED_HEADER_PATTERN_1 = '(//|#) SPDX-License-Identifier: Apache-2.0 OR MIT'
-MODIFIED_HEADER_PATTERN_2 = '(//|#)'
+MODIFIED_HEADER_PATTERN_2 = COMMENT_OR_EMPTY_PATTERN
 MODIFIED_HEADER_PATTERN_3 = '(//|#) Modifications Copyright Kani Contributors'
 MODIFIED_HEADER_PATTERN_4 = '(//|#) See GitHub history for details.'
 
@@ -28,6 +32,19 @@ def get_header(has_shebang, regexes):
     indices = range(init_idx, init_idx + len(regexes))
     return zip(regexes, indices)
 
+def match_somewhere(regexes, lines, empty_or_comment_regex):
+    """ Matches all MODIFIED_HEADER patterns within the file. This is used
+    when the license is not at the top header, and there are licenses of
+    external libraries. """
+    maybe_match_head_index = [index for index, line in enumerate(lines) if regexes[0].search(line)][:1]
+    if maybe_match_head_index and maybe_match_head_index[0] + len(regexes) <= len(lines):
+        match_head_index = maybe_match_head_index[0]
+        matches_pre_license = (empty_or_comment_regex.search(lines[index]) for index in range(match_head_index))
+        matches_license = (regex.search(lines[match_head_index + index]) for index, regex in enumerate(regexes))
+        return all(chain(matches_license, matches_pre_license))
+    else:
+        return False
+
 def result_into_bool(result):
     if result == CheckResult.FAIL:
         return False
@@ -81,9 +98,7 @@ def copyright_check(filename):
     regexes.append(re.compile(MODIFIED_HEADER_PATTERN_3))
     regexes.append(re.compile(MODIFIED_HEADER_PATTERN_4))
 
-    header = get_header(has_shebang, regexes)
-
-    if matches_header_lines(header, lines):
+    if match_somewhere(regexes, lines, re.compile(COMMENT_OR_EMPTY_PATTERN)):
         return CheckResult.PASS_MODIFIED
 
     # We fail if there were no matches

tests/kani/Generator/rustc-generator-tests/conditional-drop.rs

@@ -1,11 +1,11 @@
+// Copyright rustc Contributors
+// Adapted from rustc: https://github.com/rust-lang/rust/tree/5f98537eb7b5f42c246a52c550813c3cff336069/src/test/ui/generator/conditional-drop.rs
+
 // SPDX-License-Identifier: Apache-2.0 OR MIT
-//
+
 // Modifications Copyright Kani Contributors
 // See GitHub history for details.
 
-// Copyright rustc Contributors
-// Adapted from rustc: https://github.com/rust-lang/rust/tree/5f98537eb7b5f42c246a52c550813c3cff336069/src/test/ui/generator/conditional-drop.rs
-
 // run-pass
 
 // revisions: default nomiropt

tests/kani/Generator/rustc-generator-tests/control-flow.rs

@@ -1,11 +1,11 @@
+// Copyright rustc Contributors
+// Adapted from rustc: https://github.com/rust-lang/rust/tree/5f98537eb7b5f42c246a52c550813c3cff336069/src/test/ui/generator/control-flow.rs
+//
 // SPDX-License-Identifier: Apache-2.0 OR MIT
 //
 // Modifications Copyright Kani Contributors
 // See GitHub history for details.
 
-// Copyright rustc Contributors
-// Adapted from rustc: https://github.com/rust-lang/rust/tree/5f98537eb7b5f42c246a52c550813c3cff336069/src/test/ui/generator/control-flow.rs
-
 // run-pass
 
 // revisions: default nomiropt

tests/kani/Generator/rustc-generator-tests/discriminant_fixme.rs

@@ -1,11 +1,11 @@
+// Copyright rustc Contributors
+// Adapted from rustc: https://github.com/rust-lang/rust/tree/5f98537eb7b5f42c246a52c550813c3cff336069/src/test/ui/generator/discriminant.rs
+//
 // SPDX-License-Identifier: Apache-2.0 OR MIT
 //
 // Modifications Copyright Kani Contributors
 // See GitHub history for details.
 
-// Copyright rustc Contributors
-// Adapted from rustc: https://github.com/rust-lang/rust/tree/5f98537eb7b5f42c246a52c550813c3cff336069/src/test/ui/generator/discriminant.rs
-
 // This test creates some large generators with around 256 variants, some of them need a u16 discriminant instead of u8.
 // This test ensures that we use the right discriminant type.
 

tests/kani/Generator/rustc-generator-tests/env-drop.rs

@@ -1,11 +1,11 @@
+// Copyright rustc Contributors
+// Adapted from rustc: https://github.com/rust-lang/rust/tree/5f98537eb7b5f42c246a52c550813c3cff336069/src/test/ui/generator/env-drop.rs
+//
 // SPDX-License-Identifier: Apache-2.0 OR MIT
 //
 // Modifications Copyright Kani Contributors
 // See GitHub history for details.
 
-// Copyright rustc Contributors
-// Adapted from rustc: https://github.com/rust-lang/rust/tree/5f98537eb7b5f42c246a52c550813c3cff336069/src/test/ui/generator/env-drop.rs
-
 // run-pass
 
 // revisions: default nomiropt

tests/kani/Generator/rustc-generator-tests/iterator-count.rs

@@ -1,11 +1,11 @@
+// Copyright rustc Contributors
+// Adapted from rustc: https://github.com/rust-lang/rust/tree/5f98537eb7b5f42c246a52c550813c3cff336069/src/test/ui/generator/iterator-count.rs
+//
 // SPDX-License-Identifier: Apache-2.0 OR MIT
 //
 // Modifications Copyright Kani Contributors
 // See GitHub history for details.
 
-// Copyright rustc Contributors
-// Adapted from rustc: https://github.com/rust-lang/rust/tree/5f98537eb7b5f42c246a52c550813c3cff336069/src/test/ui/generator/iterator-count.rs
-
 // run-pass
 
 #![feature(generators, generator_trait)]

tests/kani/Generator/rustc-generator-tests/live-upvar-across-yield.rs

@@ -1,11 +1,11 @@
+// Copyright rustc Contributors
+// Adapted from rustc: https://github.com/rust-lang/rust/tree/5f98537eb7b5f42c246a52c550813c3cff336069/src/test/ui/generator/live-upvar-across-yield.rs
+//
 // SPDX-License-Identifier: Apache-2.0 OR MIT
 //
 // Modifications Copyright Kani Contributors
 // See GitHub history for details.
 
-// Copyright rustc Contributors
-// Adapted from rustc: https://github.com/rust-lang/rust/tree/5f98537eb7b5f42c246a52c550813c3cff336069/src/test/ui/generator/live-upvar-across-yield.rs
-
 // run-pass
 
 #![feature(generators, generator_trait)]

tests/kani/Generator/rustc-generator-tests/nested-generators.rs

@@ -1,11 +1,11 @@
+// Copyright rustc Contributors
+// Adapted from rustc: https://github.com/rust-lang/rust/tree/5f98537eb7b5f42c246a52c550813c3cff336069/src/test/ui/generator/nested-generators.rs
+//
 // SPDX-License-Identifier: Apache-2.0 OR MIT
 //
 // Modifications Copyright Kani Contributors
 // See GitHub history for details.
 
-// Copyright rustc Contributors
-// Adapted from rustc: https://github.com/rust-lang/rust/tree/5f98537eb7b5f42c246a52c550813c3cff336069/src/test/ui/generator/nested-generators.rs
-
 // run-pass
 
 #![feature(generators, generator_trait)]

tests/kani/Generator/rustc-generator-tests/niche-in-generator.rs

@@ -1,11 +1,11 @@
+// Copyright rustc Contributors
+// Adapted from rustc: https://github.com/rust-lang/rust/tree/5f98537eb7b5f42c246a52c550813c3cff336069/src/test/ui/generator/niche-in-generator.rs
+//
 // SPDX-License-Identifier: Apache-2.0 OR MIT
 //
 // Modifications Copyright Kani Contributors
 // See GitHub history for details.
 
-// Copyright rustc Contributors
-// Adapted from rustc: https://github.com/rust-lang/rust/tree/5f98537eb7b5f42c246a52c550813c3cff336069/src/test/ui/generator/niche-in-generator.rs
-
 // Test that niche finding works with captured generator upvars.
 
 // run-pass

tests/kani/Generator/rustc-generator-tests/niche-in-generator_fixme.rs

@@ -1,11 +1,11 @@
+// Copyright rustc Contributors
+// Adapted from rustc: https://github.com/rust-lang/rust/tree/5f98537eb7b5f42c246a52c550813c3cff336069/src/test/ui/generator/niche-in-generator.rs
+//
 // SPDX-License-Identifier: Apache-2.0 OR MIT
 //
 // Modifications Copyright Kani Contributors
 // See GitHub history for details.
 
-// Copyright rustc Contributors
-// Adapted from rustc: https://github.com/rust-lang/rust/tree/5f98537eb7b5f42c246a52c550813c3cff336069/src/test/ui/generator/niche-in-generator.rs
-
 // Test that niche finding works with captured generator upvars.
 
 // run-pass

tests/kani/Generator/rustc-generator-tests/overlap-locals.rs

@@ -1,11 +1,11 @@
+// Copyright rustc Contributors
+// Adapted from rustc: https://github.com/rust-lang/rust/tree/5f98537eb7b5f42c246a52c550813c3cff336069/src/test/ui/generator/overlap-locals.rs
+//
 // SPDX-License-Identifier: Apache-2.0 OR MIT
 //
 // Modifications Copyright Kani Contributors
 // See GitHub history for details.
 
-// Copyright rustc Contributors
-// Adapted from rustc: https://github.com/rust-lang/rust/tree/5f98537eb7b5f42c246a52c550813c3cff336069/src/test/ui/generator/overlap-locals.rs
-
 // run-pass
 
 #![feature(generators, generator_trait)]

tests/kani/Generator/rustc-generator-tests/overlap-locals_fixme.rs

@@ -1,11 +1,11 @@
+// Copyright rustc Contributors
+// Adapted from rustc: https://github.com/rust-lang/rust/tree/5f98537eb7b5f42c246a52c550813c3cff336069/src/test/ui/generator/overlap-locals.rs
+//
 // SPDX-License-Identifier: Apache-2.0 OR MIT
 //
 // Modifications Copyright Kani Contributors
 // See GitHub history for details.
 
-// Copyright rustc Contributors
-// Adapted from rustc: https://github.com/rust-lang/rust/tree/5f98537eb7b5f42c246a52c550813c3cff336069/src/test/ui/generator/overlap-locals.rs
-
 // run-pass
 
 #![feature(generators)]

tests/kani/Generator/rustc-generator-tests/resume-arg-size_fixme.rs

@@ -1,11 +1,11 @@
+// Copyright rustc Contributors
+// Adapted from rustc: https://github.com/rust-lang/rust/tree/5f98537eb7b5f42c246a52c550813c3cff336069/src/test/ui/generator/resume-arg-size.rs
+//
 // SPDX-License-Identifier: Apache-2.0 OR MIT
 //
 // Modifications Copyright Kani Contributors
 // See GitHub history for details.
 
-// Copyright rustc Contributors
-// Adapted from rustc: https://github.com/rust-lang/rust/tree/5f98537eb7b5f42c246a52c550813c3cff336069/src/test/ui/generator/resume-arg-size.rs
-
 #![feature(generators)]
 
 // run-pass

tests/kani/Generator/rustc-generator-tests/resume-arg.rs

@@ -1,11 +1,11 @@
+// Copyright rustc Contributors
+// Adapted from rustc: https://github.com/rust-lang/rust/tree/5f98537eb7b5f42c246a52c550813c3cff336069/src/test/ui/generator/resume-arg-size.rs
+//
 // SPDX-License-Identifier: Apache-2.0 OR MIT
 //
 // Modifications Copyright Kani Contributors
 // See GitHub history for details.
 
-// Copyright rustc Contributors
-// Adapted from rustc: https://github.com/rust-lang/rust/tree/5f98537eb7b5f42c246a52c550813c3cff336069/src/test/ui/generator/resume-arg-size.rs
-
 #![feature(generators, generator_trait)]
 
 use std::ops::{Generator, GeneratorState};

tests/kani/Generator/rustc-generator-tests/resume-live-across-yield.rs

@@ -1,11 +1,11 @@
+// Copyright rustc Contributors
+// Adapted from rustc: https://github.com/rust-lang/rust/tree/5f98537eb7b5f42c246a52c550813c3cff336069/src/test/ui/generator/resume-live-across-yield.rs
+//
 // SPDX-License-Identifier: Apache-2.0 OR MIT
 //
 // Modifications Copyright Kani Contributors
 // See GitHub history for details.
 
-// Copyright rustc Contributors
-// Adapted from rustc: https://github.com/rust-lang/rust/tree/5f98537eb7b5f42c246a52c550813c3cff336069/src/test/ui/generator/resume-live-across-yield.rs
-
 // run-pass
 
 #![feature(generators, generator_trait)]

tests/kani/Generator/rustc-generator-tests/size-moved-locals.rs

@@ -1,11 +1,11 @@
+// Copyright rustc Contributors
+// Adapted from rustc: https://github.com/rust-lang/rust/tree/5f98537eb7b5f42c246a52c550813c3cff336069/src/test/ui/generator/size-moved-locals.rs
+//
 // SPDX-License-Identifier: Apache-2.0 OR MIT
 //
 // Modifications Copyright Kani Contributors
 // See GitHub history for details.
 
-// Copyright rustc Contributors
-// Adapted from rustc: https://github.com/rust-lang/rust/tree/5f98537eb7b5f42c246a52c550813c3cff336069/src/test/ui/generator/size-moved-locals.rs
-
 // run-pass
 // Test that we don't duplicate storage for a variable that is moved to another
 // binding. This used to happen in the presence of unwind and drop edges (see

tests/kani/Generator/rustc-generator-tests/size-moved-locals_fixme.rs

@@ -1,11 +1,11 @@
+// Copyright rustc Contributors
+// Adapted from rustc: https://github.com/rust-lang/rust/tree/5f98537eb7b5f42c246a52c550813c3cff336069/src/test/ui/generator/size-moved-locals.rs
+//
 // SPDX-License-Identifier: Apache-2.0 OR MIT
 //
 // Modifications Copyright Kani Contributors
 // See GitHub history for details.
 
-// Copyright rustc Contributors
-// Adapted from rustc: https://github.com/rust-lang/rust/tree/5f98537eb7b5f42c246a52c550813c3cff336069/src/test/ui/generator/size-moved-locals.rs
-
 // run-pass
 // Test that we don't duplicate storage for a variable that is moved to another
 // binding. This used to happen in the presence of unwind and drop edges (see

tests/kani/Generator/rustc-generator-tests/smoke-resume-args.rs

@@ -1,11 +1,11 @@
+// Copyright rustc Contributors
+// Adapted from rustc: https://github.com/rust-lang/rust/tree/5f98537eb7b5f42c246a52c550813c3cff336069/src/test/ui/generator/smoke-resume-args.rs
+//
 // SPDX-License-Identifier: Apache-2.0 OR MIT
 //
 // Modifications Copyright Kani Contributors
 // See GitHub history for details.
 
-// Copyright rustc Contributors
-// Adapted from rustc: https://github.com/rust-lang/rust/tree/5f98537eb7b5f42c246a52c550813c3cff336069/src/test/ui/generator/smoke-resume-args.rs
-
 // run-pass
 
 // revisions: default nomiropt

tests/kani/Generator/rustc-generator-tests/smoke.rs

@@ -1,11 +1,11 @@
+// Copyright rustc Contributors
+// Adapted from rustc: https://github.com/rust-lang/rust/tree/5f98537eb7b5f42c246a52c550813c3cff336069/src/test/ui/generator/smoke.rs
+//
 // SPDX-License-Identifier: Apache-2.0 OR MIT
 //
 // Modifications Copyright Kani Contributors
 // See GitHub history for details.
 
-// Copyright rustc Contributors
-// Adapted from rustc: https://github.com/rust-lang/rust/tree/5f98537eb7b5f42c246a52c550813c3cff336069/src/test/ui/generator/smoke.rs
-
 // run-pass
 
 // revisions: default nomiropt

tests/kani/Generator/rustc-generator-tests/static-generator.rs

@@ -1,11 +1,11 @@
+// Copyright rustc Contributors
+// Adapted from rustc: https://github.com/rust-lang/rust/tree/5f98537eb7b5f42c246a52c550813c3cff336069/src/test/ui/generator/static-generator.rs
+//
 // SPDX-License-Identifier: Apache-2.0 OR MIT
 //
 // Modifications Copyright Kani Contributors
 // See GitHub history for details.
 
-// Copyright rustc Contributors
-// Adapted from rustc: https://github.com/rust-lang/rust/tree/5f98537eb7b5f42c246a52c550813c3cff336069/src/test/ui/generator/static-generator.rs
-
 // run-pass
 
 #![feature(generators, generator_trait)]

tests/kani/Generator/rustc-generator-tests/yield-in-box.rs

@@ -1,11 +1,11 @@
+// Copyright rustc Contributors
+// Adapted from rustc: https://github.com/rust-lang/rust/tree/5f98537eb7b5f42c246a52c550813c3cff336069/src/test/ui/generator/yield-in-box.rs
+
 // SPDX-License-Identifier: Apache-2.0 OR MIT
 //
 // Modifications Copyright Kani Contributors
 // See GitHub history for details.
 
-// Copyright rustc Contributors
-// Adapted from rustc: https://github.com/rust-lang/rust/tree/5f98537eb7b5f42c246a52c550813c3cff336069/src/test/ui/generator/yield-in-box.rs
-
 // run-pass
 // Test that box-statements with yields in them work.