New pre commit hook #3
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
pspandler
suggested changes
Sep 8, 2022
.githooks/pre-commit
Outdated
| #!/bin/bash | ||
| #set -x | ||
| PREFIX="pre-commit:" | ||
| RESULTS_FILE=tfsec-scan-output.txt |
There was a problem hiding this comment.
Quote your variables please.
Also, it would help if there were some useful comments - reading comments aids understanding.
.githooks/pre-commit
Outdated
| initialise() { | ||
| mkdir -p $TFSEC_WORKING_DIR | ||
| mkdir -p $TFSEC_RESULTS_DIR | ||
| rm $TFSEC_WORKING_DIR/* 2> /dev/null |
There was a problem hiding this comment.
Remove stray space.
Why are you redirecting STDERR to /dev/null?
There was a problem hiding this comment.
ok. Redirecting as it gives an error if this is run for the first time
There was a problem hiding this comment.
Righto, maybe you could:
- see if the directory exists
- if yes, delete it & recreate it
- if no, create it
.githooks/pre-commit
Outdated
| #set -x | ||
| PREFIX="pre-commit:" | ||
| RESULTS_FILE=tfsec-scan-output.txt | ||
| TFSEC_RESULTS_DIR=/tmp/tfsec-results |
.githooks/pre-commit
Outdated
| PREFIX="pre-commit:" | ||
| RESULTS_FILE=tfsec-scan-output.txt | ||
| TFSEC_RESULTS_DIR=/tmp/tfsec-results | ||
| TFSEC_WORKING_DIR=/tmp/tfsec-files |
.githooks/pre-commit
Outdated
| mkdir -p $TFSEC_WORKING_DIR | ||
| mkdir -p $TFSEC_RESULTS_DIR | ||
| rm $TFSEC_WORKING_DIR/* 2> /dev/null | ||
| rm $TFSEC_RESULTS_DIR/* 2> /dev/null |
.githooks/pre-commit
Outdated
| initialise; | ||
| populateGlobalVars; | ||
|
|
||
| if [ "$TERRAFORM_FILES_STAGED" = "yes" ]; then |
There was a problem hiding this comment.
Are you using [ ] or [[ ]]..?
I think [[ ]] is safer, but I can't remember why.
.githooks/pre-commit
Outdated
| copyTerraformFilesToBeScanned; | ||
|
|
||
| #Do the latest tfsec scan on the files that have been staged | ||
| if ! tfsec $TFSEC_WORKING_DIR --no-colour --out $TFSEC_RESULTS_DIR/$RESULTS_FILE; then |
.githooks/pre-commit
Outdated
| if [ "$ALLOW_TFSEC_ISSUES" = "yes" ] | ||
| then | ||
| #Check that the file added is exactly the same as the latest tfsec issues. They must be identical in order for the commit to be allowed through | ||
| diffResult=$(diff $TFSEC_RESULTS_DIR/$RESULTS_FILE $TFSEC_WORKING_DIR/$RESULTS_FILE) |
.githooks/pre-commit
Outdated
| diffResult=$(diff $TFSEC_RESULTS_DIR/$RESULTS_FILE $TFSEC_WORKING_DIR/$RESULTS_FILE) | ||
| if [ $? -eq 0 ] | ||
| then | ||
| informUserThatWeAllowCommitThroughDespiteTfsecIssues; |
There was a problem hiding this comment.
Not a fan of Camel case function names.
Also, could they be shorter?
.githooks/pre-commit
Outdated
| exit 1 | ||
| fi | ||
| else | ||
| informUserThatWeDenyCommitBecauseOutstandingTfSecIssues; |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.