Just about it.

~*

*~

*.sw[op]

*.py[cod]

.DS_Store

__pycache__/

__pypackages__/

.vagrant/

vendor/

Thumbs.db

*.retry

.svn/

.sass-cache/

*.log

*.out

*.so

node_modules/

.npm/

nbproject/

*.ipynb

.idea/

*.egg-info/

*.[ao]

.classpath

.cache/

bower_components/

*.class

*.[ewj]ar

secring.*

.*.kate-swp

.swp.*

.directory

.Trash-*

build/

_build/

dist/

.tox/

*.pdf

*.exe

*.dll

*.gz

*.tgz

*.tar

*.rar

*.zip

*.xz

*.pid

*.lock

*.env

.bundle/

!Pipfile.lock

!pdm.lock

!Gemfile.lock

.terraform

.terraform.*

!.terraform.lock.hcl

tfplan

*.tfstate*

*.venv

reports/

---

include:

  - project: shore/ci-stuff

    file: templates/pre-commit.yml

  - project: shore/ci-stuff

    file: templates/python.yml

build-wheel:

  extends: .python3

  stage: build

  script:

    - python3 -m build

  after_script:

    - &twine_check twine check dist/*.whl

  artifacts:

    paths:

      - dist/*.tar.gz

      - dist/*.whl

install-wheel:

  extends: .install-wheel

---

repos:

  - repo: https://github.com/pre-commit/pre-commit-hooks.git

    rev: v4.0.1

    hooks:

      - id: check-merge-conflict

      - id: check-toml

      - id: check-yaml

      - id: end-of-file-fixer

      - id: trailing-whitespace

        exclude: \.diff$

  - repo: https://github.com/codespell-project/codespell.git

    rev: v2.1.0

    hooks:

      - id: codespell

  - repo: https://github.com/amperser/proselint.git

    rev: 0.10.2

    hooks:

      - id: proselint

        types: [plain-text]

        exclude: LICENSE

  - repo: https://gitlab.com/devopshq/gitlab-ci-linter.git

    rev: v1.0.2

    hooks:

      - id: gitlab-ci-linter

        args:

          - "--server"

          - https://git.shore.co.il

  - repo: https://git.shore.co.il/nimrod/yamltool.git

    rev: v0.1.2

    hooks:

      - id: yamltool

  - repo: https://github.com/adrienverge/yamllint.git

    rev: v1.26.3

    hooks:

      - id: yamllint

  - repo: https://github.com/Lucas-C/pre-commit-hooks-markup.git

    rev: v1.0.1

    hooks:

      - id: rst-linter

  - repo: https://github.com/myint/rstcheck.git

    rev: v6.0.0.post1

    hooks:

      - id: rstcheck

  - repo: https://github.com/ambv/black.git

    rev: 22.3.0

    hooks:

      - id: black

        args:

          - |

            --line-length=79

MIT License

Copyright (c) 2023 Adar Nimrod

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.

tf

##

.. image:: https://git.shore.co.il/nimrod/tf/badges/main/pipeline.svg

    :target: https://git.shore.co.il/nimrod/tf/-/commits/main

    :alt: pipeline status

A simple Terraform wrapper to use variable definition files if they match the

workspace name.

Rationale

---------

With workspaces, one can use the same module in different environments with

minor changes like different domain name, size of a cluster, instance type.

One can use variable definition files to store the values for each workspace in

a dedicated file. This wrapper replaces the following:

.. code:: shell

   terraform workspace select prod

   terraform plan -var-files=prod.tfvars -out tfplan

to:

.. code:: shell

   terraform workspace select prod

   tf plan -out tfplan

Installation

------------

.. code:: shell

   python3 -m pip install terraformation

The wrapper is a single Python3 script with no external dependencies. If you

prefer, you can download the :code:`tf.py` and use that instead.

Usage

-----

Replace :code:`terraform` with :code:`tf`. In case there's a variable

definitions file (that ends with :code:`.tfvars`) that matches the current

workspace name (if the current workspace name is :code:`prod` and a file named

:code:`prod.tfvars` exists) than a :code:`-var-file=prod.tfvars` argument is

added to the relevant commands (like :code:`plan` and :code:`import`). All

other arguments are kept as they were. Similarly, if a directory exists with

the same name as the workspace, for all the files inside that directory that

end with :code:`.tfvars`, a :code:`-var-file` argument is added. For example:

:code:`-var-file=prod/a.tfvars` and :code:`-var-file=prod/b.tfvars`.

License

-------

This software is licensed under the MIT license (see the :code:`LICENSE.txt`

file).

Author

------

Nimrod Adar, `contact me <nimrod@shore.co.il>`_ or visit my `website

<https://www.shore.co.il/>`_. Patches are welcome via `git send-email

<http://git-scm.com/book/en/v2/Git-Commands-Email>`_. The repository is located

at: https://git.shore.co.il/nimrod/.