Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Copyright linter misses rust files, python files, etc. #4078

Open
tinzh opened this issue Jun 29, 2023 · 4 comments
Open

Copyright linter misses rust files, python files, etc. #4078

tinzh opened this issue Jun 29, 2023 · 4 comments

Comments

@tinzh
Copy link
Contributor

tinzh commented Jun 29, 2023

Problem:

The copyright linter skips over files not explicitly allowlisted in codebuild/bin/copyright_mistake_scanner.sh, including .rs files which comprise most of bindings/rust, .c/.h files not starting with s2n_ like those in bin/, etc.

Solution:

Add all files with .c, .h, .rs, .py, .cc, .sh, etc. extensions to the allowlist in the copyright linter. Alternatively, use a denylist instead in case more file types are added in the future.

  • Does this change what S2N sends over the wire? no
  • Does this change any public APIs? no
  • Which versions of TLS will this impact? n/a

Requirements / Acceptance Criteria:

Files without a copyright header that need one should not pass CI.

  • RFC links: none
  • Related Issues: none
  • Will the Usage Guide or other documentation need to be updated? no
  • Testing: Possibly run script with files without copyright headers and make sure it fails?
    • Will this change trigger SAW changes? no
    • Should this change be fuzz tested? no

Out of scope:

None

@ma-ilsi
Copy link

ma-ilsi commented Sep 5, 2023

Related to #2298

@ma-ilsi
Copy link

ma-ilsi commented Sep 5, 2023

If I understand the linter correctly, it is then also not checking the .ymls in codebuild/spec/, which also needs amending. Correct?

Or does the linter only focus on certain directories on not others (which I highly doubt, as the previous and current proposed solution is to allow/deny certain file extensions generally, regardless of their directories).

@maddeleine
Copy link
Contributor

Yep, our copyright linter isn't that sophisticated so it currently misses our yaml files.

@dougch
Copy link
Contributor

dougch commented Sep 25, 2023

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants