Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shihanng/terraform-provider-installer
A Terraform provider to setup development environment machine.
https://github.com/shihanng/terraform-provider-installer
apt-get asdf brew environment go golang installer setup terraform terraform-provider
Last synced: 5 days ago
JSON representation
A Terraform provider to setup development environment machine.
- Host: GitHub
- URL: https://github.com/shihanng/terraform-provider-installer
- Owner: shihanng
- License: mit
- Created: 2022-01-23T02:03:41.000Z (almost 3 years ago)
- Default Branch: trunk
- Last Pushed: 2023-11-13T12:28:06.000Z (12 months ago)
- Last Synced: 2024-10-04T21:43:34.395Z (about 1 month ago)
- Topics: apt-get, asdf, brew, environment, go, golang, installer, setup, terraform, terraform-provider
- Language: Go
- Homepage: https://registry.terraform.io/providers/shihanng/installer/latest/docs
- Size: 318 KB
- Stars: 11
- Watchers: 3
- Forks: 3
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/shihanng/terraform-provider-installer/actions/workflows/checks.yml)
[](https://github.com/shihanng/terraform-provider-installer/blob/trunk/LICENSE)
[](https://github.com/pre-commit/pre-commit)
# terraform-provider-installer
**terraform-provider-installer** is a [Terraform](https://www.terraform.io/) provider for installing softwares via various package management tools. Currently, **terraform-provider-installer** supports
- [APT](https://ubuntu.com/server/docs/package-management)
- [Homebrew](https://brew.sh/)
- Shell script
- [asdf](https://asdf-vm.com/)
The following shows how to install **git** and **starship** through Homebrew using **terraform-provider-installer** provider. See for complete documentation.
```tf
terraform {
required_version = "~> 1.1.4"
required_providers {
installer = {
source = "shihanng/installer"
}
}
}
locals {
apps = ["git", "starship"]
}
resource "installer_brew" "this" {
for_each = toset(local.apps)
name = each.key
}
```
## Development
### Code quality
We use [pre-commit](https://pre-commit.com/) to maintain the code quality of this project. Refer to [.pre-commit-config.yaml](./.pre-commit-config.yaml) for the list of linters that we are using. Refer to [this page](https://pre-commit.com/#install) to install pre-commit and the git hook script.
```
pre-commit install
```
### Running automated tests
Run unit tests (no resources will be created/destroyed) with
```
make test
```
Run acceptance tests with
```
make TESTARGS="-tags=apt" testacc
```
We must provide the value for `-tags` because some tests only run on a specific platform. Currently, the valid values for `-tags` are:
- `apt` for the environment that uses [APT](https://ubuntu.com/server/docs/package-management).
- `brew` for the environment that uses [Homebrew](https://brew.sh/).
We can also use `go test` in a specific directory. For example, the following runs acceptance tests inside the `brew` directory.
```
cd ./internal/brew/
TF_ACC=1 go test -tags=brew
```
### Testing with development version
You added a new feature or fixed a bug in **terraform-provider-installer**. You want to test it directly with your Terraform configurations on your local machine. Here is what you can do.
1. Run `make install`. This command installs the provider in `/tmp/tfproviders`. We've set up Terraform in `.terraformrc` to use provider from `/tmp/tfproviders`. Specify the OS and architecture using `OS_ARCH`, e.g., on Apple Silicon macOS, use
```
OS_ARCH=darwin_arm64 make install
```
2. Use the `.terraformrc` file in this repository to override the published provider.
```
export TF_CLI_CONFIG_FILE=$(pwd)/.terraformrc
terraform init
terraform plan
```
#### Tips
1. Use `export TF_LOG_PROVIDER=DEBUG` for debugging. See .
2. Use [Doc Preview Tool](https://registry.terraform.io/tools/doc-preview) to preview generated documentations.
## References
- [Custom Providers](https://learn.hashicorp.com/collections/terraform/providers)
- [Terraform Provider Scaffolding](https://github.com/hashicorp/terraform-provider-scaffolding)
- [Terraform Provider Hashicups](https://github.com/hashicorp/terraform-provider-hashicups)
- [Terraform Provider GitHub](https://github.com/integrations/terraform-provider-github)