diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..216d216 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,25 @@ +root = true + +[*] +charset = utf-8 +end_of_line = lf +insert_final_newline = true +max_line_length = 80 +trim_trailing_whitespace = true + +[bin/*] +indent_style = tab + +[*.md] +trim_trailing_whitespace = false + +[*.toml] +indent_size = 4 +indent_style = space + +[*.rs] +max_line_length = 100 + +[*.{yml,yaml}] +indent_size = 2 +indent_style = space diff --git a/.github/codecov.yml b/.github/codecov.yml new file mode 100644 index 0000000..8c531da --- /dev/null +++ b/.github/codecov.yml @@ -0,0 +1,9 @@ +--- +coverage: + status: + project: + default: + informational: true + patch: + default: + informational: true diff --git a/.github/renovate.json5 b/.github/renovate.json5 new file mode 100644 index 0000000..48f67b6 --- /dev/null +++ b/.github/renovate.json5 @@ -0,0 +1,15 @@ +{ + $schema: "https://docs.renovatebot.com/renovate-schema.json", + extends: ["config:base"], + + // Disable creating a GitHub issue that lists all available dependency updates + dependencyDashboard: false, + + // Keep pre-commit hooks up-to-date + "pre-commit": { + enabled: true, + }, + + // Disable prefixing commits with the semantic commit type + semanticCommits: "disabled", +} diff --git a/.github/workflows/json.yml b/.github/workflows/json.yml new file mode 100644 index 0000000..e5963d8 --- /dev/null +++ b/.github/workflows/json.yml @@ -0,0 +1,51 @@ +--- +name: JSON + +"on": + push: + branches: + - main + pull_request: + workflow_dispatch: + +jobs: + detect-changes: + name: Detect changes + runs-on: ubuntu-latest + + outputs: + any_changed: ${{ steps.detect-changes.outputs.any_changed }} + + steps: + - name: Checkout code + uses: actions/checkout@v4 + + - name: Get changed files + id: detect-changes + uses: tj-actions/changed-files@v43 + with: + files: | + **/*.json + + - name: Print changed files + run: | + for file in ${{ steps.detect-changes.outputs.all_changed_files }}; do + echo "$file" + done + + style: + name: Check style + runs-on: ubuntu-latest + + needs: detect-changes + if: needs.detect-changes.outputs.any_changed == 'true' + + steps: + - name: Checkout code + uses: actions/checkout@v4 + + - name: prettier + uses: creyD/prettier_action@v4.3 + with: + dry: true + prettier_options: "--check **/*.json" diff --git a/.github/workflows/markdown.yml b/.github/workflows/markdown.yml new file mode 100644 index 0000000..1b30d71 --- /dev/null +++ b/.github/workflows/markdown.yml @@ -0,0 +1,67 @@ +--- +name: Markdown + +"on": + push: + branches: + - main + pull_request: + workflow_dispatch: + +jobs: + detect-changes: + name: Detect changes + runs-on: ubuntu-latest + + outputs: + any_changed: ${{ steps.detect-changes.outputs.any_changed }} + + steps: + - name: Checkout code + uses: actions/checkout@v4 + + - name: Get changed files + id: detect-changes + uses: tj-actions/changed-files@v43 + with: + files: | + **/*.md + + - name: Print changed files + run: | + for file in ${{ steps.detect-changes.outputs.all_changed_files }}; do + echo "$file" + done + + lint: + name: Lint code + runs-on: ubuntu-latest + + needs: detect-changes + if: needs.detect-changes.outputs.any_changed == 'true' + + steps: + - name: Checkout code + uses: actions/checkout@v4 + + - name: markdownlint-cli + uses: nosborn/github-action-markdown-cli@v3.3.0 + with: + files: "**.md" + + style: + name: Check style + runs-on: ubuntu-latest + + needs: detect-changes + if: needs.detect-changes.outputs.any_changed == 'true' + + steps: + - name: Checkout code + uses: actions/checkout@v4 + + - name: prettier + uses: creyD/prettier_action@v4.3 + with: + dry: true + prettier_options: "--check **/*.md" diff --git a/.github/workflows/yaml.yml b/.github/workflows/yaml.yml new file mode 100644 index 0000000..a05d3c7 --- /dev/null +++ b/.github/workflows/yaml.yml @@ -0,0 +1,66 @@ +--- +name: YAML + +"on": + push: + branches: + - main + pull_request: + workflow_dispatch: + +jobs: + detect-changes: + name: Detect changes + runs-on: ubuntu-latest + + outputs: + any_changed: ${{ steps.detect-changes.outputs.any_changed }} + + steps: + - name: Checkout code + uses: actions/checkout@v4 + + - name: Get changed files + id: detect-changes + uses: tj-actions/changed-files@v43 + with: + files: | + **/*.yaml + **/*.yml + + - name: Print changed files + run: | + for file in ${{ steps.detect-changes.outputs.all_changed_files }}; do + echo "$file" + done + + lint: + name: Lint code + runs-on: ubuntu-latest + + needs: detect-changes + if: needs.detect-changes.outputs.any_changed == 'true' + + steps: + - name: Checkout code + uses: actions/checkout@v4 + + - name: Run yamllint + uses: actionshub/yamllint@v1.8.2 + + style: + name: Check style + runs-on: ubuntu-latest + + needs: detect-changes + if: needs.detect-changes.outputs.any_changed == 'true' + + steps: + - name: Checkout code + uses: actions/checkout@v4 + + - name: prettier + uses: creyD/prettier_action@v4.3 + with: + dry: true + prettier_options: "--check **/*.{yml,yaml}" diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..41b1019 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +# Cache for Prettier 4 +node_modules/ diff --git a/.markdownlint.yaml b/.markdownlint.yaml new file mode 100644 index 0000000..ed97d53 --- /dev/null +++ b/.markdownlint.yaml @@ -0,0 +1 @@ +--- diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..0be6eb0 --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,32 @@ +# pre-commit configuration +# +# We use pre-commit to enforce a consistency in our repositories. By default, +# YAML and Markdown files get linted, and Prettier runs to auto-format the file +# types it supports. Depending on the project, other rules can be added here to +# support the needs of the project. +# +# See https://pre-commit.com for more information +# See https://pre-commit.com/hooks.html for more hooks +--- +repos: + - repo: https://github.com/pre-commit/pre-commit-hooks + rev: v4.5.0 + hooks: + - id: check-added-large-files + args: ["--maxkb=1024"] + - id: check-case-conflict + - id: end-of-file-fixer + - id: trailing-whitespace + args: [--markdown-linebreak-ext=md] + - repo: https://github.com/igorshubovych/markdownlint-cli + rev: v0.39.0 + hooks: + - id: markdownlint + - repo: https://github.com/adrienverge/yamllint + rev: v1.35.1 + hooks: + - id: yamllint + - repo: https://github.com/pre-commit/mirrors-prettier + rev: v4.0.0-alpha.8 + hooks: + - id: prettier diff --git a/.prettierrc.json b/.prettierrc.json new file mode 100644 index 0000000..0967ef4 --- /dev/null +++ b/.prettierrc.json @@ -0,0 +1 @@ +{} diff --git a/.yamllint.yml b/.yamllint.yml new file mode 100644 index 0000000..84a384d --- /dev/null +++ b/.yamllint.yml @@ -0,0 +1,7 @@ +--- +extends: default + +rules: + line-length: + ignore: | + .github/workflows/* diff --git a/LICENSE-APACHE b/LICENSE-APACHE new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/LICENSE-APACHE @@ -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 [yyyy] [name of copyright owner] + + 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/LICENSE-MIT b/LICENSE-MIT new file mode 100644 index 0000000..969d061 --- /dev/null +++ b/LICENSE-MIT @@ -0,0 +1,17 @@ +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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..f08ea69 --- /dev/null +++ b/README.md @@ -0,0 +1,36 @@ +# ✔️ Smoke Tests for Rust Infrastructure + +This repository contains a collection of smoke tests for the infrastructure of +the [Rust] project. + +## Development + +The repository contains a set of tools that enforce a consistent coding style, +run automated tests, and check for common programming errors. Pre-commit hooks +run these checks on the local machine when committing changes, while GitHub +Actions run the same checks when a pull request is opened. + +The pre-commit hooks are managed by [pre-commit] and can be installed with the +following command: + +```shell +pre-commit install +``` + +## License + +Licensed under either of + +- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or ) +- MIT license ([LICENSE-MIT](LICENSE-MIT) or ) + +at your option. + +## Contribution + +Unless you explicitly state otherwise, any contribution intentionally submitted +for inclusion in the work by you, as defined in the Apache-2.0 license, shall be +dual licensed as above, without any additional terms or conditions. + +[pre-commit]: https://pre-commit.com/ +[rust]: https://www.rust-lang.org/