From 9dac3ba3a308e9b4fa062474921a0d82fc34375b Mon Sep 17 00:00:00 2001 From: tp832944 <139139729+tp832944@users.noreply.github.com> Date: Thu, 5 Dec 2024 12:15:24 +0000 Subject: [PATCH] feat: initial commit Set up core files for repo, describe purpose of repo, configure pre-commit and set up GitHub workflows. --- .cspell/custom_misc.txt | 1 + .cspell/library_terms.txt | 4 + .gitattributes | 2 + .github/workflows/pre_commit_autoupdate.yml | 107 +++++++++++ .github/workflows/pre_commit_checks.yml | 27 +++ .gitignore | 0 .pre-commit-config.yaml | 64 +++++++ CONTRIBUTING.md | 10 + LICENSE | 202 ++++++++++++++++++++ README.md | 10 + cspell.config.yaml | 15 ++ pre_commit_hooks/require_utf8.py | 69 +++++++ 12 files changed, 511 insertions(+) create mode 100644 .cspell/custom_misc.txt create mode 100644 .cspell/library_terms.txt create mode 100644 .gitattributes create mode 100644 .github/workflows/pre_commit_autoupdate.yml create mode 100644 .github/workflows/pre_commit_checks.yml create mode 100644 .gitignore create mode 100644 .pre-commit-config.yaml create mode 100644 CONTRIBUTING.md create mode 100644 LICENSE create mode 100644 README.md create mode 100644 cspell.config.yaml create mode 100644 pre_commit_hooks/require_utf8.py diff --git a/.cspell/custom_misc.txt b/.cspell/custom_misc.txt new file mode 100644 index 0000000..06e710d --- /dev/null +++ b/.cspell/custom_misc.txt @@ -0,0 +1 @@ +GCHQ diff --git a/.cspell/library_terms.txt b/.cspell/library_terms.txt new file mode 100644 index 0000000..dbbe71b --- /dev/null +++ b/.cspell/library_terms.txt @@ -0,0 +1,4 @@ +autoupdate +coreax +jumanjihouse +vars diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..31535bc --- /dev/null +++ b/.gitattributes @@ -0,0 +1,2 @@ +# Force all files to be indexed with LF line endings except those listed below +* text diff --git a/.github/workflows/pre_commit_autoupdate.yml b/.github/workflows/pre_commit_autoupdate.yml new file mode 100644 index 0000000..276f5e4 --- /dev/null +++ b/.github/workflows/pre_commit_autoupdate.yml @@ -0,0 +1,107 @@ +--- +name: Autoupdate pre-commit config + +on: + schedule: + - cron: "0 0 * * 0" + +jobs: + pre_commit_autoupdate: + env: + config_path: .pre-commit-config.yaml + update_message_path: /tmp/message.txt + update_branch: chore/pre-commit-autoupdate + runs-on: ubuntu-latest + steps: + - name: Generate a token + id: generate-token + uses: actions/create-github-app-token@v1 + with: + app-id: ${{ vars.WRITE_CONTENTS_PR_APP }} + private-key: ${{ secrets.WRITE_CONTENTS_PR_KEY }} + - uses: actions/checkout@v4 + with: + ref: main + - name: Create or checkout update branch + id: create_branch + env: + GH_TOKEN: ${{ steps.generate-token.outputs.token }} + run: | + export pr_number=$( gh pr view ${{ env.update_branch }} --json number --jq '.number' ) + export pr_state=$( gh pr view ${{ env.update_branch }} --json state --jq '.state' ) + echo "pr_number=$pr_number" >> "$GITHUB_OUTPUT" + echo "pr_state=$pr_state" >> "$GITHUB_OUTPUT" + + if git fetch origin ${{ env.update_branch }}; then + # If branch wasn't deleted after merge, do so here + if [ "$pr_state" = "MERGED" ]; then + git push -d origin ${{ env.update_branch }} + git checkout -b ${{ env.update_branch }} + git push origin ${{ env.update_branch }} + fi + git checkout ${{ env.update_branch }} + else + git checkout -b ${{ env.update_branch }} + git push origin ${{ env.update_branch }} + fi + + # Pre-commit setup and autoupdate steps + - name: Set up Python + uses: actions/setup-python@v5 + with: + python-version: 3.13 + cache: pip + - name: Upgrade Pip + run: python -m pip install --upgrade pip + - name: Install pre-commit + run: pip install pre-commit + - name: Store hash of baseline pre-commit config for comparison + id: old_file + run: echo "hash=$( sha256sum $config_path )" >> $GITHUB_OUTPUT + - name: Overwrite config on branch with version from main + run: git checkout main ${{ env.config_path }} + - name: Store hash of main pre-commit config for comparison + id: main_file + run: echo "hash=$( sha256sum $config_path )" >> $GITHUB_OUTPUT + - name: Run pre-commit autoupdate on main pre-commit config + id: autoupdate + run: | + pre-commit autoupdate > ${{ env.update_message_path }} + sed -i "/updating/!d" ${{ env.update_message_path }} + - name: Store hash of new pre-commit config for comparison + id: new_file + run: echo "hash=$( sha256sum $config_path )" >> $GITHUB_OUTPUT + # Commit authoring and pull-request creation/updating + - name: Commit (with signature) pre-commit config + id: commit + if: steps.old_file.outputs.hash != steps.new_file.outputs.hash + env: + GH_TOKEN: ${{ steps.generate-token.outputs.token }} + run: | + export message="chore(deps): autoupdate pre-commit hooks" + export sha=$( git rev-parse ${{ env.update_branch }}:${{ env.config_path }} ) + export content=$( base64 -i ${{ env.config_path }} ) + gh api --method PUT /repos/:owner/:repo/contents/${{ env.config_path }} \ + --field message="$message" \ + --field content="$content" \ + --field branch=${{ env.update_branch }} \ + --field sha="$sha" + - name: Create or update pre-commit-autoupdate pull-request + if: steps.commit.conclusion == 'success' || ( steps.main_file.outputs.hash != steps.new_file.outputs.hash ) + env: + GH_TOKEN: ${{ steps.generate-token.outputs.token }} + run : | + export title="chore(deps): autoupdate pre-commit hooks" + export body=$( cat ${{ env.update_message_path }} ) + export pr_number=${{ steps.create_branch.outputs.pr_number }} + export pr_state=${{ steps.create_branch.outputs.pr_state }} + + # If the PR is closed, can it be reopened, or is the PR already open? + if ( [ "$pr_state" = "CLOSED" ] && gh pr reopen $pr_number ) || [ "$pr_state" = "OPEN" ]; then + gh api --method PATCH /repos/:owner/:repo/pulls/$pr_number \ + --field title="$title" \ + --field body="$body" + else + # If a PR doesn't already exist, and no previous PR can be reopened, create a new PR. + gh pr create -t "$title" -b "$body" -l dependencies -B main -H ${{ env.update_branch }} + fi diff --git a/.github/workflows/pre_commit_checks.yml b/.github/workflows/pre_commit_checks.yml new file mode 100644 index 0000000..7b392fa --- /dev/null +++ b/.github/workflows/pre_commit_checks.yml @@ -0,0 +1,27 @@ +--- +name: Pre-commit Checks + +on: + push: + branches: + - main + pull_request: + branches: + - "**" + +jobs: + pre_commit: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - name: Set up Python + uses: actions/setup-python@v5 + with: + python-version: 3.13 + cache: pip + - name: Upgrade Pip + run: python -m pip install --upgrade pip + - name: Install pre-commit + run: pip install pre-commit + - name: Run Pre-commit checks + run: SKIP=no-commit-to-branch pre-commit run -a --show-diff-on-failure diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..e69de29 diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..a0933f5 --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,64 @@ +--- +default_install_hook_types: + - pre-commit + - pre-merge-commit + - commit-msg +default_stages: + - pre-commit + - pre-merge-commit +repos: + - repo: https://github.com/pre-commit/pre-commit-hooks + rev: v5.0.0 + hooks: + # Reject commits that add large files (coverage.xml, for example) + # Consider adjusting kB limit + - id: check-added-large-files + args: + - --enforce-all + - --maxkb=5000 + # Check for files that would conflict in case-insensitive filesystems + - id: check-case-conflict + # Check for files that contain merge conflict strings + - id: check-merge-conflict + # Check syntax of data files + - id: check-json + - id: check-toml + - id: check-yaml + # Files must end in a single newline + - id: end-of-file-fixer + # Remove whitespace at the end of lines + - id: trailing-whitespace + # Prevent commit to main/master + - id: no-commit-to-branch + # Sort spell check custom dictionary + - id: file-contents-sorter + files: ^.cspell/.+.txt$ + args: + - --ignore-case + - --unique + - repo: local + hooks: + # Check files are valid UTF-8 + - id: require-utf8 + name: Check file encoding + description: Ensure file is valid UTF-8 + entry: python pre_commit_hooks/require_utf8.py + language: python + # Keep requirements-docs.txt in sync with uv.lock + - repo: https://github.com/Lucas-C/pre-commit-hooks + rev: v1.5.5 + hooks: + # No tabs, only spaces + - id: forbid-tabs + - repo: https://github.com/streetsidesoftware/cspell-cli + rev: v8.16.0 + hooks: + # Run a spellcheck (words pulled from cspell.config.yaml) + - id: cspell + stages: + - pre-commit + - pre-merge-commit + - commit-msg + exclude_types: + - gitignore + exclude: .cspell/.* diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..3be591d --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,10 @@ +# Contributor guidelines + +We strongly encourage contributions to Coreax. Please follow the guidelines +[there](https://github.com/gchq/coreax/blob/main/CONTRIBUTING.md). Issues should be +reported to the main Coreax [issues board](https://github.com/gchq/coreax/issues). + +## Pre-commit + +This repo runs pre-commit checks. Please run `pre-commit install` before making any +commits. diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..c542f2a --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2023 GCHQ + + 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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..a805ea3 --- /dev/null +++ b/README.md @@ -0,0 +1,10 @@ +# Coreax metadata + +_© Crown Copyright GCHQ_ + +This repo contains metadata for [Coreax](https://github.com/gchq/coreax). It is not +intended for public use. The data in this repo are used in automations for Coreax. These +are split into directories: + +* `coverage` - code coverage assessment for coverage badge. +* `performance` - execution times for monitoring changes in speed of code. diff --git a/cspell.config.yaml b/cspell.config.yaml new file mode 100644 index 0000000..eafe1cf --- /dev/null +++ b/cspell.config.yaml @@ -0,0 +1,15 @@ +--- +$schema: https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json +version: '0.2' +language: en-GB +dictionaries: + - custom-misc + - library-terms + - people +dictionaryDefinitions: + - name: custom-misc + path: ./.cspell/custom_misc.txt + addWords: true + - name: library-terms + path: ./.cspell/library_terms.txt + addWords: true diff --git a/pre_commit_hooks/require_utf8.py b/pre_commit_hooks/require_utf8.py new file mode 100644 index 0000000..7d32f9e --- /dev/null +++ b/pre_commit_hooks/require_utf8.py @@ -0,0 +1,69 @@ +#!/usr/bin/env python3 +# © Crown Copyright GCHQ +# +# 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. + +""" +Pre-commit hook to ensure all text files are valid UTF-8. + +Based on jumanjihouse/pre-commit-hooks require-ascii hook. Original copyright: + +:: + + Copyright (c) 2018 Paul Morgan + + Permission is hereby granted, free of charge, to any person obtaining a copy + of this software and associated documentation files (the "Software"), to deal + in the Software without restriction, including without limitation the rights + to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + copies of the Software, and to permit persons to whom the Software is + furnished to do so, subject to the following conditions: + + The above copyright notice and this permission notice shall be included in + all copies or substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN + THE SOFTWARE. +""" + +import itertools +import sys + + +def main() -> None: + """Run the pre-commit check.""" + failed = False + + for file_path in sys.argv[1:]: + with open(file_path, encoding="UTF-8") as rf: + for line_number in itertools.count(start=1): + try: + line = rf.readline() + except UnicodeDecodeError as error: + line = "" # avoid being unbound + print(f"{file_path}: line {line_number} {error!s}") + failed = True + + if not line: + break + + sys.exit(failed) + + +if __name__ == "__main__": + main()