Skip to content

Commit d0cf073

Browse files
committed
Fixup for the switch to python-hcl2
See #52 Fixes #13
1 parent 3dce926 commit d0cf073

File tree

2 files changed

+13
-13
lines changed

2 files changed

+13
-13
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
When [Terraform](https://www.terraform.io/) meets [Cucumber](https://cucumber.io/).
44

5-
This is exactly what [Uyuni](https://www.uyuni-project.org/) and [SUSE Manager](https://www.suse.com/products/suse-manager/) are using for part of the testing. We create an environment with terraform (sumaform) and then we run tests with Cucumber. Alternatively, terracumber can be also used to run Salt tests with [Salt Shaker](https://github.com/openSUSE/salt-test).
5+
This is exactly what [Uyuni](https://www.uyuni-project.org/) and [SUSE Multi-Linux Manager](https://www.suse.com/products/multi-linux-manager/) are using for part of the testing. We create an environment with terraform (sumaform) and then we run tests with Cucumber. Alternatively, terracumber can be also used to run Salt tests with [Salt Shaker](https://github.com/openSUSE/salt-test).
66

77
Until [SUSE's Hackweek 18](https://hackweek.suse.com/projects/terracumber-python-replacement-for-sumaform-test-runner) we were using a set of bash scripts, completely ad-hoc and hard to maintain and extend, and that is how Terracumber was born.
88

@@ -33,12 +33,12 @@ No. It should work with any other environment as long as:
3333
### Software requirements
3434

3535
- Python 3
36-
- [pyhcl](https://pypi.org/project/pyhcl/) module installed
36+
- [python-hcl2](https://pypi.org/project/python-hcl2/) module installed
3737
- [paramiko](https://www.paramiko.org/) module installed
3838
- [pygit2](https://www.pygit2.org/) module installed
39-
- Terraform
39+
- Terraform/openTofu
4040

41-
`paramiko` is usually part of the base system packages. `pyhcl` and `pygit2` are packaged in the [Uyuni utils](https://download.opensuse.org/repositories/systemsmanagement:/Uyuni:/Utils/) repository.
41+
`paramiko` is usually part of the base system packages. `python-hcl2` and `pygit2` are packaged in the [Uyuni utils](https://download.opensuse.org/repositories/systemsmanagement:/Uyuni:/Utils/) repository.
4242

4343
Terraform must be configured as needed to run the terraform templates you are going to use.
4444

@@ -55,7 +55,7 @@ You will need to create at least one `.tf` file to use it to launch your environ
5555
Keep in mind:
5656

5757
1. There are some mandatory variables for the `.tf` file (see one of the [examples](examples/)
58-
2. You can add extra variables to your `.tf` file, so you can use it when creating the environment. Those variables will need to be exported before running `terracumber-cli` as `TF_VAR_`, as explained at the [terraform doc](https://learn.hashicorp.com/terraform/getting-started/variables.html#from-environment-variables). Our example adds SCC credentials to pass them to Uyuni/SUSE Manager, and GitHub credentials to use them to clone the GitHub cucumber repository **[1]**
58+
2. You can add extra variables to your `.tf` file, so you can use it when creating the environment. Those variables will need to be exported before running `terracumber-cli` as `TF_VAR_`, as explained at the [terraform doc](https://learn.hashicorp.com/terraform/getting-started/variables.html#from-environment-variables). Our example adds SCC credentials to pass them to Uyuni/SUSE Multi-Linux Manager, and GitHub credentials to use them to clone the GitHub cucumber repository **[1]**
5959

6060
**[1]** To clone your terraform repository, it is allowed to use `TF_VAR_GIT_USER` and `TF_VAR_GIT_PASSWORD` instead of `--gituser` and `--gitpassword`, in case you do not want the credentials visible at the list of processes. If you use both the environment and the variables, then the parameters will be used to clone the terraform repository, and the variables to clone the cucumber repository at the controller.
6161

setup.py

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
from distutils.core import setup
22

33
setup(
4-
name='Terracumber',
5-
author='Julio González Gil',
6-
author_email='[email protected]',
7-
scripts=['terracumber-cli'],
8-
url='https://github.com/uyuni-project/terracumber',
9-
description='When Terraform meets Cucumber.',
10-
long_description=open('README.md').read(),
4+
name="Terracumber",
5+
author="Julio González Gil",
6+
author_email="[email protected]",
7+
scripts=["terracumber-cli"],
8+
url="https://github.com/uyuni-project/terracumber",
9+
description="When Terraform meets Cucumber.",
10+
long_description=open("README.md").read(),
1111
install_requires=[
12-
"pyhcl",
12+
"python-hcl2",
1313
"paramiko",
1414
"pygit2",
1515
],

0 commit comments

Comments
 (0)