diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..1d8ad18 --- /dev/null +++ b/.github/CODE_OF_CONDUCT.md @@ -0,0 +1,133 @@ + +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, caste, color, religion, or sexual +identity and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the overall + community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or advances of + any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email address, + without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series of +actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or permanent +ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within the +community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.1, available at +[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. + +Community Impact Guidelines were inspired by +[Mozilla's code of conduct enforcement ladder][Mozilla CoC]. + +For answers to common questions about this code of conduct, see the FAQ at +[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at +[https://www.contributor-covenant.org/translations][translations]. + +[homepage]: https://www.contributor-covenant.org +[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html +[Mozilla CoC]: https://github.com/mozilla/diversity +[FAQ]: https://www.contributor-covenant.org/faq +[translations]: https://www.contributor-covenant.org/translations diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 0000000..de9332e --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1,2 @@ +github: kpfleming +liberapay: kpfleming diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..5ace460 --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,6 @@ +version: 2 +updates: + - package-ecosystem: "github-actions" + directory: "/" + schedule: + interval: "weekly" diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..8156d69 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,61 @@ +name: CI checks + +on: + push: + branches: + - main + pull_request: + types: + - opened + - reopened + - synchronize + branches: + - main + schedule: + - cron: "35 4 * * 6" + +jobs: + preflight: + runs-on: ubuntu-22.04 + outputs: + image_base: ${{ steps.details.outputs.image_base }} + image_tag: ${{ steps.preflight.outputs.image_tag }} + versions: ${{ steps.get_versions.outputs.versions }} + need_ci: ${{ (steps.preflight.outputs.need_ci == 'true') || (steps.preflight.outputs.need_image == 'true') }} + steps: + - uses: actions/checkout@v3 + - id: get_versions + run: cat workflow-support/versions.json >> $GITHUB_OUTPUT + - id: details + uses: kpfleming/composite-actions/image-details@v2 + with: + base_image: python:bookworm-main + - id: preflight + uses: kpfleming/composite-actions/ci-preflight@v2 + with: + ci_paths: workflow-support/ci_paths.yml + files_hash: ${{ hashfiles('pyproject.toml', 'workflow-support/make_ci_image.sh', '.github/workflows/ci.yml') }} + base_image_hash: ${{ steps.details.outputs.base_image_hash }} + - id: make-ci-image + uses: kpfleming/composite-actions/make-ci-image@v2 + if: steps.preflight.outputs.need_image == 'true' + with: + build_args: ${{ vars.PYTHON_DISTRIBUTION_NAME }} + base_image: ${{ steps.details.outputs.base_image }} + image_name: ${{ steps.details.outputs.image_base }}:${{ steps.preflight.outputs.image_tag }} + image_cache_key: ${{ steps.preflight.outputs.image_cache_key }} + image_registry: ${{ steps.details.outputs.image_registry }} + registry_username: ${{ secrets.QUAY_BOT_NAME }} + registry_password: ${{ secrets.QUAY_BOT_PASSWORD }} + ci: + needs: + - preflight + strategy: + matrix: + python: ${{ fromJSON(needs.preflight.outputs.versions).python }} + fail-fast: false + uses: ./.github/workflows/test.yml + with: + if: ${{ needs.preflight.outputs.need_ci == 'true' }} + image: ${{ needs.preflight.outputs.image_base }}:${{ needs.preflight.outputs.image_tag }} + python: ${{ matrix.python }} diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml new file mode 100644 index 0000000..2b6c3fa --- /dev/null +++ b/.github/workflows/codeql-analysis.yml @@ -0,0 +1,38 @@ +--- +name: "CodeQL" + +on: + push: + branches: [main] + pull_request: + # The branches below must be a subset of the branches above + branches: [main] + schedule: + - cron: "30 22 * * 2" + +permissions: + contents: read + +jobs: + analyze: + name: Analyze + runs-on: ubuntu-latest + permissions: + actions: read + contents: read + security-events: write + + strategy: + fail-fast: false + + steps: + - name: Checkout repository + uses: actions/checkout@v3 + + - name: Initialize CodeQL + uses: github/codeql-action/init@v2 + with: + languages: python + + - name: Perform analysis + uses: github/codeql-action/analyze@v2 diff --git a/.github/workflows/delete-pr-image.yml b/.github/workflows/delete-pr-image.yml new file mode 100644 index 0000000..94e9514 --- /dev/null +++ b/.github/workflows/delete-pr-image.yml @@ -0,0 +1,23 @@ +name: Delete PR Image + +on: + pull_request: + types: + - closed + branches: + - main + +jobs: + clean-image: + runs-on: ubuntu-22.04 + steps: + - id: details + uses: kpfleming/composite-actions/image-details@v2 + with: + base_image: python:bookworm-main + - uses: kpfleming/composite-actions/delete-pr-image@v2 + with: + image_registry: ${{ steps.details.outputs.image_registry }} + registry_account: ${{ steps.details.outputs.registry_account }} + registry_token: ${{ secrets.QUAY_API_TOKEN }} + repo_name: ${{ steps.details.outputs.repo_name }} diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml new file mode 100644 index 0000000..6ae6291 --- /dev/null +++ b/.github/workflows/lint.yml @@ -0,0 +1,35 @@ +name: Lint checks + +on: + pull_request: + branches: + - main + schedule: + - cron: "35 4 * * 6" + +jobs: + preflight: + runs-on: ubuntu-22.04 + outputs: + image_base: ${{ steps.details.outputs.image_base }} + need_lint: ${{ steps.preflight.outputs.need_lint == 'true' }} + steps: + - uses: actions/checkout@v3 + - id: details + uses: kpfleming/composite-actions/image-details@v2 + with: + base_image: python:bookworm-main + - id: preflight + uses: kpfleming/composite-actions/lint-preflight@v2 + with: + lint_paths: workflow-support/lint_paths.yml + lint: + if: needs.preflight.outputs.need_lint == 'true' + runs-on: ubuntu-22.04 + needs: + - preflight + container: + image: ${{ needs.preflight.outputs.image_base }}:main + steps: + - uses: actions/checkout@v3 + - uses: kpfleming/composite-actions/lint-hatch@v2 diff --git a/.github/workflows/pypi-package.yml b/.github/workflows/pypi-package.yml new file mode 100644 index 0000000..b0d4ee4 --- /dev/null +++ b/.github/workflows/pypi-package.yml @@ -0,0 +1,45 @@ +--- +name: Build and verify package, with optional upload to PyPI + +on: + push: + branches: [main] + tags: ["*"] + pull_request: + branches: [main] + release: + types: + - published + +permissions: + contents: read + id-token: write + +jobs: + build-package: + name: Build and verify package + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v3 + with: + fetch-depth: 0 + + - uses: hynek/build-and-inspect-python-package@v1 + + release-pypi: + name: Publish released package to PyPI + environment: release-pypi + if: github.event.action == 'published' + runs-on: ubuntu-latest + needs: build-package + + steps: + - name: Download previously built packages + uses: actions/download-artifact@v3 + with: + name: Packages + path: dist + + - name: Upload packages + uses: pypa/gh-action-pypi-publish@release/v1 diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml new file mode 100644 index 0000000..01fa883 --- /dev/null +++ b/.github/workflows/test.yml @@ -0,0 +1,32 @@ +name: CI tests + +on: + workflow_call: + inputs: + if: + required: false + default: true + type: boolean + image: + required: true + type: string + python: + required: true + type: string + +jobs: + test: + if: inputs.if + runs-on: ubuntu-22.04 + container: + image: ${{ inputs.image }} + steps: + - uses: actions/checkout@v3 + - name: build wheel + run: hatch build -t wheel + shell: bash + - name: install project + run: hatch run ci.py${{ inputs.python }}:pip install dist/*.whl + shell: bash + - name: run tests + run: hatch run ci.py${{ inputs.python }}:ci diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..095bb7e --- /dev/null +++ b/.gitignore @@ -0,0 +1,4 @@ +.coverage +*.egg-info +dist +build diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..2f1ba44 --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,5 @@ +repos: +- repo: https://github.com/tox-dev/pyproject-fmt + rev: "0.13.0" + hooks: + - id: pyproject-fmt diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..21b9aea --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,33 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [*Keep a +Changelog*](https://keepachangelog.com/en/1.0.0/) and this project +adheres to [*Calendar Versioning*](https://calver.org/). + +The **first number** of the version is the year. + +The **second number** is incremented with each release, starting at 1 +for each year. + +The **third number** is when we need to start branches for older +releases (only for emergencies). + +Committed changes for the next release can be found in the ["changelog.d" +directory](https://github.com/kpfleming/jinjanator/tree/main/changelog.d) +in the project repository. + + + + + +## [23.1.0](https://github.com/kpfleming/jinjanator/tree/23.1.0) - 2023-07-24 + +Initial release! diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..e1a5d14 --- /dev/null +++ b/README.md @@ -0,0 +1,60 @@ +# jinjanator-plugin-ansible + +Open Source Initiative Approved License logo +[![CI](https://github.com/kpfleming/jinjanator-plugin-ansible/workflows/CI%20checks/badge.svg)](https://github.com/kpfleming/jinjanator-plugin-ansible/actions?query=workflow%3ACI%20checks) +[![Python](https://img.shields.io/badge/python-3.8+-blue.svg)](https://www.python.org/downloads/release/python-3812/) +[![License - Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-9400d3.svg)](https://spdx.org/licenses/Apache-2.0.html) +[![Code Style - Black](https://img.shields.io/badge/Code%20Style-Black-000000.svg)](https://github.com/psf/black) +[![Types - Mypy](https://img.shields.io/badge/Types-Mypy-blue.svg)](https://github.com/python/mypy) +[![Code Quality - Ruff](https://img.shields.io/badge/Code%20Quality-Ruff-red.svg)](https://github.com/astral-sh/ruff) +[![Project Management - Hatch](https://img.shields.io/badge/Project%20Management-Hatch-purple.svg)](https://github.com/pypa/hatch) +[![Testing - Pytest](https://img.shields.io/badge/Testing-Pytest-orange.svg)](https://github.com/pytest-dev/pytest) + +This repo contains `jinjanator-plugin-ansible`, a plugin which +provides access to Ansible's filters to templates rendered using the +[Jinjanator](https://github.com/kpfleming/jinjanator) tool. + +Open Source software: [Apache License 2.0](https://spdx.org/licenses/Apache-2.0.html) + +##   + + +This plugin makes all of the filters and tests from the Ansible 'core' +collection available to templates being rendered using the Jinjanator +tool. + +## Installation + +``` +pip install jinjanator-plugin-ansible +``` + +## Usage + +The Ansible filters and tests can be used in templates using the same +names that would be used if the template was rendered by Ansible +itself. + + +## Chat + +If you'd like to chat with the Jinjanator community, join us on +[Matrix](https://matrix.to/#/#jinjanator:km6g.us)! + +## Credits + +["Standing on the shoulders of +giants"](https://en.wikipedia.org/wiki/Standing_on_the_shoulders_of_giants) +could not be more true than it is in the Python community; this +project relies on many wonderful tools and libraries produced by the +global open source software community, in addition to Python +itself. I've listed many of them below, but if I've overlooked any +please do not be offended :-) + +* [Black](https://github.com/psf/black) +* [Hatch-Fancy-PyPI-Readme](https://github.com/hynek/hatch-fancy-pypi-readme) +* [Hatch](https://github.com/pypa/hatch) +* [Mypy](https://github.com/python/mypy) +* [Pytest](https://github.com/pytest-dev/pytest) +* [Ruff](https://github.com/astral-sh/ruff) +* [Towncrier](https://github.com/twisted/towncrier) diff --git a/changelog.d/towncrier_template.md.jinja b/changelog.d/towncrier_template.md.jinja new file mode 100644 index 0000000..c7cfc58 --- /dev/null +++ b/changelog.d/towncrier_template.md.jinja @@ -0,0 +1,28 @@ +{%- if versiondata["version"] == "main" -%} +## Changes for the Upcoming Release + +:::{warning} +These changes reflect the current [development progress](https://github.com/kpfleming/jinjanator/tree/main) and are **not** included in a PyPI release yet. +::: +{% else -%} +## [{{ versiondata["version"] }}](https://github.com/kpfleming/jinjanator/tree/{{ versiondata["version"] }}) - {{ versiondata["date"] }} +{%- endif %} + +{% for section, _ in sections.items() %} +{% if sections[section] %} +{% for category, val in definitions.items() if category in sections[section] %} + +### {{ definitions[category]['name'] }} + +{% for text, values in sections[section][category].items() %} +- {{ text }} + {{ values|join(',\n ') }} +{% endfor %} + +{% endfor %} +{% else %} +No significant changes. + + +{% endif %} +{% endfor %} diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..14a687f --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,277 @@ +[build-system] +build-backend = "hatchling.build" +requires = [ + "hatch-fancy-pypi-readme", + "hatch-vcs", + "hatchling", +] + +[project] +name = "jinjanator-plugin-ansible" +description = "Plugin which provides Ansible filters and tests to the Jinjanator tool" +license = { text="Apache-2.0" } +authors = [ + { name="Kevin P. Fleming", email="jinjanator@kevin.km6g.us" }, +] +requires-python = ">=3.8" +classifiers = [ + "Development Status :: 5 - Production/Stable", + "Environment :: Console", + "Intended Audience :: Developers", + "Intended Audience :: System Administrators", + "Natural Language :: English", + "Operating System :: OS Independent", + "Programming Language :: Python :: 3 :: Only", + "Programming Language :: Python :: 3.8", + "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Typing :: Typed", +] +dynamic = [ + "readme", + "version", +] +dependencies = [ + "ansible-core", + "jinjanator-plugins==23.1.*", +] +[project.urls] +"Bug Tracker" = "https://github.com/kpfleming/jinjanator-plugin-ansible/issues" +"Homepage" = "https://github.com/kpfleming/jinjanator-plugin-ansible" +[project.entry-points.jinjanator] +ansible = "jinjanator_plugin_ansible.plugin" + +[tool.hatch.envs.changelog] +skip-install = true +dependencies = [ + "towncrier", +] + +[tool.hatch.envs.changelog.scripts] +draft = [ + "towncrier build --version main --draft", +] +release = [ + "towncrier build --yes --version {args}", +] + +[tool.hatch.version] +source = "vcs" + +[tool.hatch.build] +exclude = [ + "*~", + ".github", +] + +[tool.hatch.build.targets.sdist] +include = [ + "src", + "tests", + "*.md", +] + +[tool.hatch.build.targets.wheel] +packages = [ + "src/jinjanator_plugin_ansible", +] + +[tool.hatch.envs.default] +python = "3.11" + +[tool.hatch.envs.lint] +dependencies = [ + "attrs", # needed for type-checking tests + "black", + "jinjanator", # needed for type-checking tests + "ruff", + "mypy", + "pytest", # needed for type-checking tests +] + +[tool.hatch.envs.lint.scripts] +lint = [ + "black --preview src tests", + "ruff check --fix -- src tests", + "mypy --package jinjanator_plugin_ansible", + "mypy tests", + "shellcheck workflow-support/*.sh", +] +lint-action = [ + "black --check --diff --preview src tests", + "ruff check --format=github -- src tests", + "mypy --package jinjanator_plugin_ansible", + "mypy tests", + "shellcheck workflow-support/*.sh", +] + +[tool.hatch.envs.ci] +dependencies = [ + "attrs", + "coverage[toml]", + "jinjanator", + "pytest", + "pytest-cov", + "pytest-icdiff", +] + +[[tool.hatch.envs.ci.matrix]] +python = [ +"3.8", +"3.9", +"3.10", +"3.11", +"3.12", +] + +[tool.hatch.envs.ci.scripts] +ci = [ + "rm -f .coverage", + # run tests + "pytest --verbose --cov-append --cov-branch --cov-fail-under=100 --cov=jinjanator_plugin_ansible", + # produce a coverage report with 'missing' lines indicated + "coverage report -m", +] + +[tool.hatch.metadata] +allow-direct-references = true + +[tool.hatch.metadata.hooks.fancy-pypi-readme] +content-type = "text/markdown" + +[[tool.hatch.metadata.hooks.fancy-pypi-readme.fragments]] +text = """ +# *jinjanator-plugin-ansible*: Makes Ansible's filters and tests available in Jinjanator + +""" + +[[tool.hatch.metadata.hooks.fancy-pypi-readme.fragments]] +path = "README.md" +start-after = "" +end-before = "" + +[[tool.hatch.metadata.hooks.fancy-pypi-readme.fragments]] +text = """ +## Release Information +""" + +[[tool.hatch.metadata.hooks.fancy-pypi-readme.fragments]] +path = "CHANGELOG.md" +start-after = "" +# pattern = "\n(###.+?\n)## " + +[[tool.hatch.metadata.hooks.fancy-pypi-readme.fragments]] +text = """ +--- +[→ Full Changelog](https://github.com/kpfleming/jinjanator-plugin-ansible/blob/main/CHANGELOG.md) +""" + +[[tool.hatch.metadata.hooks.fancy-pypi-readme.substitutions]] +pattern = '\[(.+?)\]\(((?!https?://)\S+?)\)' +replacement = '[\1](https://github.com/kpfleming/jinjanator-plugin-ansible/tree/main/\g<2>)' + +[[tool.hatch.metadata.hooks.fancy-pypi-readme.substitutions]] +pattern = "#(\\d+)" +replacement = "[#\\1](https://github.com/kpfleming/jinjanator-plugin-ansible/issues/\\1)" + +[tool.black] +line-length = 90 + +[tool.ruff] +src = ["src", "tests"] +format = "grouped" +target-version = "py38" +select = ["ALL"] + +ignore = [ + "ANN", # Mypy is better at this. + "C901", # Leave complexity to me. + "COM", # Leave commas to Black. + "D", # We have different ideas about docstrings. + "E501", # leave line-length enforcement to Black + "PLR0912", # Leave complexity to me. + "TRY301", # Raise in try blocks can totally make sense. +] +unfixable = ["F401"] + +[tool.ruff.per-file-ignores] +"tests/*" = [ + "PLC1901", # empty strings are falsey, but are less specific in tests + "PT005", # we use always underscores and explicit names + "S101", # assert + "SIM300", # Yoda rocks in tests +] + +[tool.ruff.isort] +lines-between-types = 1 +lines-after-imports = 2 + +[tool.pytest.ini_options] +minversion = "6.0" +xfail_strict = true +testpaths = [ + "tests", +] +addopts = [ + "-ra", + "--strict-markers", +] + +[tool.mypy] +python_version = 3.8 +namespace_packages = true +explicit_package_bases = true +check_untyped_defs = true +disallow_any_generics = true +disallow_incomplete_defs = true +disallow_subclassing_any = true +disallow_untyped_calls = true +disallow_untyped_decorators = true +disallow_untyped_defs = true +follow_imports = "normal" +no_implicit_optional = true +strict_equality = true +warn_no_return = true +warn_redundant_casts = true +warn_return_any = true +warn_unused_ignores = true + +[tool.towncrier] +name = "jinjanator-plugin-ansible" +package = "jinjanator_plugin_ansible" +directory = "changelog.d" +filename = "CHANGELOG.md" +start_string = "\n" +template = "changelog.d/towncrier_template.md.jinja" +title_format = "" +issue_format = "[#{issue}](https://github.com/kpfleming/jinjanator-plugin-ansible/issues/{issue})" +underlines = ["", "", ""] + +[[tool.towncrier.section]] +path = "" + +[[tool.towncrier.type]] +directory = "breaking" +name = "Backwards-incompatible Changes" +showcontent = true + +[[tool.towncrier.type]] +directory = "deprecating" +name = "Deprecations" +showcontent = true + +[[tool.towncrier.type]] +directory = "adding" +name = "Additions" +showcontent = true + +[[tool.towncrier.type]] +directory = "changing" +name = "Changes" +showcontent = true + +[[tool.towncrier.type]] +directory = "fixing" +name = "Fixes" +showcontent = true diff --git a/src/jinjanator_plugin_ansible/__init__.py b/src/jinjanator_plugin_ansible/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/src/jinjanator_plugin_ansible/plugin.py b/src/jinjanator_plugin_ansible/plugin.py new file mode 100644 index 0000000..cab69c0 --- /dev/null +++ b/src/jinjanator_plugin_ansible/plugin.py @@ -0,0 +1,22 @@ +from __future__ import annotations + +from typing import cast + +from ansible.plugins.filter.core import FilterModule # type: ignore[import] +from ansible.plugins.test.core import TestModule # type: ignore[import] +from jinjanator_plugins import ( + Filters, + Tests, + plugin_filters_hook, + plugin_tests_hook, +) + + +@plugin_filters_hook +def plugin_filters() -> Filters: + return cast(Filters, FilterModule().filters()) + + +@plugin_tests_hook +def plugin_tests() -> Tests: + return cast(Tests, TestModule().tests()) diff --git a/src/jinjanator_plugin_ansible/py.typed b/src/jinjanator_plugin_ansible/py.typed new file mode 100644 index 0000000..e69de29 diff --git a/tests/test_plugin.py b/tests/test_plugin.py new file mode 100644 index 0000000..26af89c --- /dev/null +++ b/tests/test_plugin.py @@ -0,0 +1,37 @@ +from __future__ import annotations + +from pathlib import Path + +from jinjanator.cli import render_command + + +def test_filter(tmp_path: Path) -> None: + template_file = tmp_path / "template.j2" + template_file.write_text("{{ name | to_uuid }}") + data_file = tmp_path / "data.env" + data_file.write_text("name=Bart") + assert ( + render_command( + Path.cwd(), + {}, + None, + ["", str(template_file), str(data_file)], + ) + == "7acd55fd-0779-54cc-a798-cdf367486926" + ) + + +def test_test(tmp_path: Path) -> None: + template_file = tmp_path / "template.j2" + template_file.write_text("{% if ver is version('22.0', '>=') %}pass{% endif %}") + data_file = tmp_path / "data.env" + data_file.write_text("ver=23.2.0") + assert ( + render_command( + Path.cwd(), + {}, + None, + ["", str(template_file), str(data_file)], + ) + == "pass" + ) diff --git a/workflow-support/ci_paths.yml b/workflow-support/ci_paths.yml new file mode 100644 index 0000000..2a64217 --- /dev/null +++ b/workflow-support/ci_paths.yml @@ -0,0 +1,7 @@ +paths: + - 'src/**/*.py' + - 'tests/**/*.py' + - 'pyproject.toml' + - 'workflow-support/versions.json' + - '.github/workflows/ci.yml' + - '.github/workflows/test.yml' diff --git a/workflow-support/lint_paths.yml b/workflow-support/lint_paths.yml new file mode 100644 index 0000000..5f8d092 --- /dev/null +++ b/workflow-support/lint_paths.yml @@ -0,0 +1,5 @@ +paths: + - 'src/**/*.py' + - 'tests/**/*.py' + - 'pyproject.toml' + - '.github/workflows/lint.yml' diff --git a/workflow-support/make_ci_image.sh b/workflow-support/make_ci_image.sh new file mode 100755 index 0000000..12a86e1 --- /dev/null +++ b/workflow-support/make_ci_image.sh @@ -0,0 +1,71 @@ +#!/usr/bin/env bash + +set -ex + +# Arguments: +# +# 1: registry, name, and tag of base image +# 2: registry, name, and tag of image to be created +# 3: name of Python distribution produced by this repo + +scriptdir=$(realpath "$(dirname "${BASH_SOURCE[0]}")") +# source directory must be mounted at the same path inside the build +# container as it will be mounted when GitHub Actions launches the +# container, because Hatch uses the path as part of the identity of +# the virtual environments it creates +containersrcdir="/__w/${GITHUB_REPOSITORY##*/}/${GITHUB_REPOSITORY##*/}" +base_image=${1}; shift +image_name=${1}; shift +dist_name=${1}; shift + +lint_deps=(shellcheck) +proj_deps=(libsqlite3-0) +proj_build_deps=(build-essential libc6-dev pkg-config) + +hatchenvs=(lint ci) +cimatrix=(3.8 3.9 3.10 3.11 3.12) + +c=$(buildah from "${base_image}") + +build_cmd() { + buildah run --network host "${c}" -- "$@" +} + +build_cmd_with_source() { + buildah run --network host --volume "$(realpath "${scriptdir}/.."):${containersrcdir}" --workingdir "${containersrcdir}" "${c}" -- "$@" +} + +build_cmd apt update --quiet=2 +build_cmd apt install --yes --quiet=2 "${lint_deps[@]}" "${proj_deps[@]}" "${proj_build_deps[@]}" + +build_cmd pip3.11 install git+https://github.com/pypa/hatch + +for env in "${hatchenvs[@]}"; do + # this looks weird... but it causes Hatch to create the env, + # install all of the project's dependencies and the project, + # then runs pip to uninstall the project, leaving the env + # in place with the dependencies + case "${env}" in + ci*) + for py in "${cimatrix[@]}"; do + build_cmd_with_source hatch env create "${env}.py${py}" + build_cmd_with_source hatch -e "${env}.py${py}" run pip uninstall --yes "${dist_name}" + done + ;; + *) + build_cmd_with_source hatch env create "${env}" + build_cmd_with_source hatch -e "${env}" run pip uninstall --yes "${dist_name}" + ;; + esac +done + +build_cmd apt remove --yes --purge "${proj_build_deps[@]}" +build_cmd apt autoremove --yes --purge +build_cmd apt clean autoclean +build_cmd sh -c "rm -rf /var/lib/apt/lists/*" +build_cmd rm -rf /root/.cache + +if buildah images --quiet "${image_name}"; then + buildah rmi "${image_name}" +fi +buildah commit --squash --rm "${c}" "${image_name}" diff --git a/workflow-support/versions.json b/workflow-support/versions.json new file mode 100644 index 0000000..2dc44cb --- /dev/null +++ b/workflow-support/versions.json @@ -0,0 +1 @@ +versions={"python": ["3.8", "3.9", "3.10", "3.11", "3.12"]}