Skip to content

feature/terraform docs hcl2 #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 4 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,7 @@ This project contains some useful hooks for https://pre-commit.com.

The `terraform_inputs_jenkins_pipeline_params` hook supports the definition of a [Declarative Jenkins Pipeline](https://jenkins.io/doc/book/pipeline/syntax/#declarative-pipeline)'s [parameters](https://jenkins.io/doc/book/pipeline/syntax/#parameters) from your [Terraform Input Variables](https://www.terraform.io/intro/getting-started/variables.html).

*Note:*
1. Requires [segmentio/terraform-docs](https://github.com/segmentio/terraform-docs) >= v0.4.0.
2. Requires [terraform-docs12](https://raw.githubusercontent.com/marcuscaisey/.dotfiles/master/scripts/terraform-docs12)
*Note:* Requires [segmentio/terraform-docs](https://github.com/segmentio/terraform-docs) >= v0.8.0.

### Sample Usage

Expand All @@ -17,7 +15,7 @@ The `terraform_inputs_jenkins_pipeline_params` hook supports the definition of a
```
repos:
- repo: git://github.com/getcloudnative/pre-commit-hooks
rev: v1.2.0
rev: v1.4.0
hooks:
- id: terraform_inputs_jenkins_pipeline_params
```
Expand Down Expand Up @@ -46,7 +44,7 @@ pipeline {

The `terraform_inputs_jenkins_pipeline_params` hook supports the creation of a [terraform.tfvars.json](https://www.terraform.io/intro/getting-started/variables.html#from-a-file) based on your [Terraform Input Variables](https://www.terraform.io/intro/getting-started/variables.html), with values provided by the Jenkins Pipeline parameters' arguments.

*Note:* Requires [segmentio/terraform-docs](https://github.com/segmentio/terraform-docs) >= v0.4.0.
*Note:* Requires [segmentio/terraform-docs](https://github.com/segmentio/terraform-docs) >= v0.8.0.

### Sample Usage

Expand All @@ -55,7 +53,7 @@ The `terraform_inputs_jenkins_pipeline_params` hook supports the creation of a [
```
repos:
- repo: git://github.com/getcloudnative/pre-commit-hooks
rev: v1.2.0
rev: v1.4.0
hooks:
- id: terraform_inputs_jenkins_pipeline_params
```
Expand Down
34 changes: 17 additions & 17 deletions pre_commit_hooks/terraform_inputs_jenkins_pipeline_params.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,55 +19,55 @@

def get_terraform_input_vars(terraform_files):
try:
raw_json = subprocess.check_output(['terraform-docs12', '--no-sort', '--with-aggregate-type-defaults', 'json'] + terraform_files)
raw_json = subprocess.check_output(['terraform-docs', '--no-sort', 'json', '.'])
except subprocess.CalledProcessError:
raw_json = '{ "Inputs": [] }'
raw_json = '{ "inputs": [] }'

return json.loads(raw_json)

def process_terraform_input_vars(visitor, terraform_files):
json = get_terraform_input_vars(terraform_files)

result = []
for input in json['Inputs']:
for input in json['inputs']:
result.append(visitor(input))

return result

def transform_terraform_input_var_to_jenkinsfile_param(input):
result = 'string(name: "' + input['Name'] + '"'
result = 'string(name: "' + input['name'] + '"'

if input['Default'] is not None:
if type(input['Default']) == dict:
if input['default'] is not None:
if type(input['default']) == dict:
# Was a default value provided?
if input['Default']['Value'] != '':
if input['default']['Value'] != '':
result += ", defaultValue: '"
# Is it a complex value?
if type(input['Default']['Value']) in [dict, list]:
result += json.dumps(input['Default']['Value'])
if type(input['default']['Value']) in [dict, list]:
result += json.dumps(input['default']['Value'])
else:
result += input['Default']['Value']
result += input['default']['Value']
result += "'"
else:
if input['Type'] == 'list':
if input['type'] == 'list':
result += ", defaultValue: '[]'"
elif input['Type'] == 'map':
elif input['type'] == 'map':
result += ", defaultValue: '{}'"
else:
result += ", defaultValue: '%s'" % input['Default']
result += ", defaultValue: '%s'" % input['default']

if input['Description'] is not None:
result += ', description: "%s"' % input['Description']
if input['description'] is not None:
result += ', description: "%s"' % input['description']

result += ')'
return result

def transform_terraform_input_var_to_tfvars_json(input):
name = input['Name']
name = input['name']

result = 'tfvars.%s = ' % name

if input['Type'] in ['list', 'map']:
if input['type'] in ['list', 'map']:
result += 'readJSON text: '

result += 'params.' + name
Expand Down