mirror of
https://github.com/super-linter/super-linter.git
synced 2024-12-22 12:42:09 -05:00
Lukas Gravley
GitHub
commit
06bc3459f0
5 changed files with 124 additions and 27 deletions
4
.github/run-linter-locally.md
vendored
4
.github/run-linter-locally.md
vendored
|
|
@ -74,6 +74,10 @@ Once the container has been downloaded to your local environment, you can then b
|
|||
- `-e VALIDATE_GO=<true|false>`
|
||||
- Default: `true`
|
||||
- Flag to enable or disable the linting process of the language
|
||||
- **VALIDATE_TERRAFORM**
|
||||
- `-e VALIDATE_TERRAFORM=<true|false>`
|
||||
- Default: `true`
|
||||
- Flag to enable or disable the linting process of the language
|
||||
- **ANSIBLE_DIRECTORY**
|
||||
- `-e ANSIBLE_DIRECTORY=</path/local/to/codebase/with/ansible>`
|
||||
- Default: `/ansible`
|
||||
|
|
|
|||
|
|
@ -77,7 +77,7 @@ RUN gem install rubocop:0.74 rubocop-rails rubocop-github:0.13
|
|||
# Install shellcheck #
|
||||
######################
|
||||
RUN wget -qO- "https://storage.googleapis.com/shellcheck/shellcheck-stable.linux.x86_64.tar.xz" | tar -xJv \
|
||||
&& cp "shellcheck-stable/shellcheck" /usr/bin/
|
||||
&& mv "shellcheck-stable/shellcheck" /usr/bin/
|
||||
|
||||
#####################
|
||||
# Install Go Linter #
|
||||
|
|
@ -85,6 +85,12 @@ RUN wget -qO- "https://storage.googleapis.com/shellcheck/shellcheck-stable.linux
|
|||
ARG GO_VERSION='v1.23.7'
|
||||
RUN wget -O- -nv https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s "$GO_VERSION"
|
||||
|
||||
##################
|
||||
# Install TFLint #
|
||||
##################
|
||||
RUN curl -L "$(curl -Ls https://api.github.com/repos/terraform-linters/tflint/releases/latest | grep -o -E "https://.+?_linux_amd64.zip")" -o tflint.zip && unzip tflint.zip && rm tflint.zip \
|
||||
&& mv "tflint" /usr/bin/
|
||||
|
||||
###########################################
|
||||
# Load GitHub Env Vars for Github Actions #
|
||||
###########################################
|
||||
|
|
@ -105,6 +111,7 @@ ENV GITHUB_SHA=${GITHUB_SHA} \
|
|||
VALIDATE_DOCKER=${VALIDATE_DOCKER} \
|
||||
VALIDATE_JAVASCRIPT=${VALIDATE_JAVASCRIPT} \
|
||||
VALIDATE_GO=${VALIDATE_GO} \
|
||||
VALIDATE_TERRAFORM=${VALIDATE_TERRAFORM} \
|
||||
ANSIBLE_DIRECTORY=${ANSIBLE_DIRECTORY} \
|
||||
RUN_LOCAL=${RUN_LOCAL} \
|
||||
TEST_CASE_RUN=${TEST_CASE_RUN}
|
||||
|
|
|
|||
|
|
@ -15,6 +15,7 @@ Developers on **GitHub** can call this Action to lint their code base with the f
|
|||
- **Javascript** (eslint)(standard)
|
||||
- **Golang** (golangci-lint)
|
||||
- **Dockerfile** (dockerfilelint)
|
||||
- **Terraform** (tflint)
|
||||
|
||||
## How to use
|
||||
To use this **GitHub** Action you will need to complete the following:
|
||||
|
|
@ -129,6 +130,9 @@ The super-linter allows you to pass the following `ENV` variables to be able to
|
|||
- **VALIDATE_GO**
|
||||
- Default: `true`
|
||||
- Flag to enable or disable the linting process of the language
|
||||
- **VALIDATE_TERRAFORM**
|
||||
- Default: `true`
|
||||
- Flag to enable or disable the linting process of the language
|
||||
- **VERBOSE_OUTPUT**
|
||||
- Default: `false`
|
||||
- Flag to enable additional information about the linter, versions, and additional output
|
||||
|
|
|
|||
32
TEMPLATES/.tflint.hcl
Normal file
32
TEMPLATES/.tflint.hcl
Normal file
|
|
@ -0,0 +1,32 @@
|
|||
// https://github.com/terraform-linters/tflint/blob/master/docs/guides/config.md
|
||||
config {
|
||||
module = true
|
||||
deep_check = true
|
||||
force = false
|
||||
|
||||
// aws_credentials = {
|
||||
// access_key = "AWS_ACCESS_KEY"
|
||||
// secret_key = "AWS_SECRET_KEY"
|
||||
// region = "us-east-1"
|
||||
// }
|
||||
|
||||
// ignore_module = {
|
||||
// "github.com/terraform-linters/example-module" = true
|
||||
// }
|
||||
|
||||
// varfile = ["example1.tfvars", "example2.tfvars"]
|
||||
|
||||
// variables = ["foo=bar", "bar=[\"baz\"]"]
|
||||
}
|
||||
|
||||
rule "aws_instance_invalid_type" {
|
||||
enabled = true
|
||||
}
|
||||
|
||||
rule "aws_instance_previous_type" {
|
||||
enabled = false
|
||||
}
|
||||
|
||||
// plugin "example" {
|
||||
// enabled = true
|
||||
// }
|
||||
102
lib/linter.sh
102
lib/linter.sh
|
|
@ -38,14 +38,17 @@ DOCKER_FILE_NAME='.dockerfilelintrc' # Name of th
|
|||
DOCKER_LINTER_RULES="$DEFAULT_RULES_LOCATION/$DOCKER_FILE_NAME" # Path to the Docker lint rules
|
||||
# Golang Vars
|
||||
GO_FILE_NAME='.golangci.yml' # Name of the file
|
||||
GO_LINTER_RULES="$DEFAULT_RULES_LOCATION/$GO_FILE_NAME" # Path to the Docker lint rules
|
||||
GO_LINTER_RULES="$DEFAULT_RULES_LOCATION/$GO_FILE_NAME" # Path to the Go lint rules
|
||||
# Terraform Vars
|
||||
TERRAFORM_FILE_NAME='.tflint.hcl' # Name of the file
|
||||
TERRAFORM_LINTER_RULES="$DEFAULT_RULES_LOCATION/$TERRAFORM_FILE_NAME" # Path to the Terraform lint rules
|
||||
|
||||
#######################################
|
||||
# Linter array for information prints #
|
||||
#######################################
|
||||
LINTER_ARRAY=("jsonlint" "yamllint" "xmllint" "markdownlint" "shellcheck"
|
||||
"pylint" "perl" "rubocop" "coffeelint" "eslint" "standard"
|
||||
"ansible-lint" "/dockerfilelint/bin/dockerfilelint" "golangci-lint")
|
||||
"ansible-lint" "/dockerfilelint/bin/dockerfilelint" "golangci-lint" "tflint")
|
||||
|
||||
###################
|
||||
# GitHub ENV Vars #
|
||||
|
|
@ -68,6 +71,7 @@ VALIDATE_ANSIBLE="${VALIDATE_ANSIBLE}" # Boolean to validate language
|
|||
VALIDATE_JAVASCRIPT="${VALIDATE_JAVASCRIPT}" # Boolean to validate language
|
||||
VALIDATE_DOCKER="${VALIDATE_DOCKER}" # Boolean to validate language
|
||||
VALIDATE_GO="${VALIDATE_GO}" # Boolean to validate language
|
||||
VALIDATE_TERRAFORM="${VALIDATE_TERRAFORM}" # Boolean to validate language
|
||||
TEST_CASE_RUN="${TEST_CASE_RUN}" # Boolean to validate only test cases
|
||||
|
||||
##############
|
||||
|
|
@ -106,7 +110,8 @@ FILE_ARRAY_COFFEESCRIPT=() # Array of files to check
|
|||
FILE_ARRAY_ESLINT=() # Array of files to check
|
||||
FILE_ARRAY_STANDARD=() # Array of files to check
|
||||
FILE_ARRAY_DOCKER=() # Array of files to check
|
||||
FILE_ARRAY_GO=() # Array of files to check
|
||||
FILE_ARRAY_GO=() # Array of files to check
|
||||
FILE_ARRAY_TERRAFORM=() # Array of files to check
|
||||
|
||||
############
|
||||
# Counters #
|
||||
|
|
@ -125,6 +130,7 @@ ERRORS_FOUND_STANDARD=0 # Count of errors found
|
|||
ERRORS_FOUND_ESLINT=0 # Count of errors found
|
||||
ERRORS_FOUND_DOCKER=0 # Count of errors found
|
||||
ERRORS_FOUND_GO=0 # Count of errors found
|
||||
ERRORS_FOUND_TERRAFORM=0 # Count of errors found
|
||||
|
||||
################################################################################
|
||||
########################## FUNCTIONS BELOW #####################################
|
||||
|
|
@ -828,6 +834,22 @@ GetGitHubVars()
|
|||
echo "- Excluding [GOLANG] files in code base..."
|
||||
fi
|
||||
|
||||
###############################
|
||||
# Convert string to lowercase #
|
||||
###############################
|
||||
VALIDATE_TERRAFORM=$(echo "$VALIDATE_TERRAFORM" | awk '{print tolower($0)}')
|
||||
######################################
|
||||
# Validate we should check all files #
|
||||
######################################
|
||||
if [[ "$VALIDATE_TERRAFORM" != "false" ]]; then
|
||||
# Set to true
|
||||
VALIDATE_TERRAFORM="$DEFAULT_VALIDATE_LANGUAGE"
|
||||
echo "- Validating [TERRAFORM] files in code base..."
|
||||
else
|
||||
# Its false
|
||||
echo "- Excluding [TERRAFORM] files in code base..."
|
||||
fi
|
||||
|
||||
##############################
|
||||
# Validate Ansible Directory #
|
||||
##############################
|
||||
|
|
@ -1080,7 +1102,7 @@ BuildFileList()
|
|||
########################
|
||||
# Get the Golang files #
|
||||
########################
|
||||
elif [ "$FILE_TYPE" == "go" ]; then
|
||||
elif [ "$FILE_TYPE" == "go" ]; then
|
||||
################################
|
||||
# Append the file to the array #
|
||||
################################
|
||||
|
|
@ -1089,6 +1111,18 @@ BuildFileList()
|
|||
# Set the READ_ONLY_CHANGE_FLAG since this could be exec #
|
||||
##########################################################
|
||||
READ_ONLY_CHANGE_FLAG=1
|
||||
###########################
|
||||
# Get the Terraform files #
|
||||
###########################
|
||||
elif [ "$FILE_TYPE" == "tf" ]; then
|
||||
################################
|
||||
# Append the file to the array #
|
||||
################################
|
||||
FILE_ARRAY_TERRAFORM+=("$FILE")
|
||||
##########################################################
|
||||
# Set the READ_ONLY_CHANGE_FLAG since this could be exec #
|
||||
##########################################################
|
||||
READ_ONLY_CHANGE_FLAG=1
|
||||
elif [ "$FILE" == "Dockerfile" ]; then
|
||||
################################
|
||||
# Append the file to the array #
|
||||
|
|
@ -1486,26 +1520,28 @@ Footer()
|
|||
echo "ERRORS FOUND in JAVASCRIPT(Standard):[$ERRORS_FOUND_STANDARD]"
|
||||
echo "ERRORS FOUND in DOCKER:[$ERRORS_FOUND_DOCKER]"
|
||||
echo "ERRORS FOUND in GO:[$ERRORS_FOUND_GO]"
|
||||
echo "ERRORS FOUND in TERRAFORM:[$ERRORS_FOUND_TERRAFORM]"
|
||||
echo "----------------------------------------------"
|
||||
echo ""
|
||||
|
||||
###############################
|
||||
# Exit with 1 if errors found #
|
||||
###############################
|
||||
if [ $ERRORS_FOUND_YML -ne 0 ] || \
|
||||
[ $ERRORS_FOUND_JSON -ne 0 ] || \
|
||||
[ $ERRORS_FOUND_XML -ne 0 ] || \
|
||||
[ $ERRORS_FOUND_MARKDOWN -ne 0 ] || \
|
||||
[ $ERRORS_FOUND_BASH -ne 0 ] || \
|
||||
[ $ERRORS_FOUND_PERL -ne 0 ] || \
|
||||
[ $ERRORS_FOUND_PYTHON -ne 0 ] || \
|
||||
[ $ERRORS_FOUND_COFFEESCRIPT -ne 0 ] || \
|
||||
[ $ERRORS_FOUND_ANSIBLE -ne 0 ] || \
|
||||
[ $ERRORS_FOUND_ESLINT -ne 0 ] || \
|
||||
[ $ERRORS_FOUND_STANDARD -ne 0 ] || \
|
||||
[ $ERRORS_FOUND_DOCKER -ne 0 ] || \
|
||||
[ $ERRORS_FOUND_GO -ne 0 ] || \
|
||||
[ $ERRORS_FOUND_RUBY -ne 0 ]; then
|
||||
if [ "$ERRORS_FOUND_YML" -ne 0 ] || \
|
||||
[ "$ERRORS_FOUND_JSON" -ne 0 ] || \
|
||||
[ "$ERRORS_FOUND_XML" -ne 0 ] || \
|
||||
[ "$ERRORS_FOUND_MARKDOWN" -ne 0 ] || \
|
||||
[ "$ERRORS_FOUND_BASH" -ne 0 ] || \
|
||||
[ "$ERRORS_FOUND_PERL" -ne 0 ] || \
|
||||
[ "$ERRORS_FOUND_PYTHON" -ne 0 ] || \
|
||||
[ "$ERRORS_FOUND_COFFEESCRIPT" -ne 0 ] || \
|
||||
[ "$ERRORS_FOUND_ANSIBLE" -ne 0 ] || \
|
||||
[ "$ERRORS_FOUND_ESLINT" -ne 0 ] || \
|
||||
[ "$ERRORS_FOUND_STANDARD" -ne 0 ] || \
|
||||
[ "$ERRORS_FOUND_DOCKER" -ne 0 ] || \
|
||||
[ "$ERRORS_FOUND_GO" -ne 0 ] || \
|
||||
[ "$ERRORS_FOUND_TERRAFORM" -ne 0 ] || \
|
||||
[ "$ERRORS_FOUND_RUBY" -ne 0 ]; then
|
||||
# Failed exit
|
||||
echo "Exiting with errors found!"
|
||||
exit 1
|
||||
|
|
@ -1552,6 +1588,7 @@ RunTestCases()
|
|||
TestCodebase "STANDARD" "standard" "standard $STANDARD_LINTER_RULES" ".*\.\(js\)\$"
|
||||
TestCodebase "DOCKER" "/dockerfilelint/bin/dockerfilelint" "/dockerfilelint/bin/dockerfilelint" ".*\(Dockerfile\)\$"
|
||||
TestCodebase "ANSIBLE" "ansible-lint" "ansible-lint -v -c $ANSIBLE_LINTER_RULES" "ansible-lint"
|
||||
TestCodebase "TERRAFORM" "tflint" "tflint -c $TERRAFORM_LINTER_RULES" ".*\.\(tf\)\$"
|
||||
|
||||
#################
|
||||
# Footer prints #
|
||||
|
|
@ -1579,24 +1616,26 @@ GetGitHubVars
|
|||
########################
|
||||
# Get the linter rules #
|
||||
########################
|
||||
# Get yml rules
|
||||
# Get YML rules
|
||||
GetLinterRules "$YAML_FILE_NAME" "$YAML_LINTER_RULES"
|
||||
# Get markdown rules
|
||||
# Get Markdown rules
|
||||
GetLinterRules "$MD_FILE_NAME" "$MD_LINTER_RULES"
|
||||
# Get python rules
|
||||
# Get Python rules
|
||||
GetLinterRules "$PYTHON_FILE_NAME" "$PYTHON_LINTER_RULES"
|
||||
# Get ruby rules
|
||||
# Get Ruby rules
|
||||
GetLinterRules "$RUBY_FILE_NAME" "$RUBY_LINTER_RULES"
|
||||
# Get coffeescript rules
|
||||
# Get Coffeescript rules
|
||||
GetLinterRules "$COFFEE_FILE_NAME" "$COFFEESCRIPT_LINTER_RULES"
|
||||
# Get ansible rules
|
||||
# Get Ansible rules
|
||||
GetLinterRules "$ANSIBLE_FILE_NAME" "$ANSIBLE_LINTER_RULES"
|
||||
# Get javascript rules
|
||||
# Get JavaScript rules
|
||||
GetLinterRules "$JAVASCRIPT_FILE_NAME" "$JAVASCRIPT_LINTER_RULES"
|
||||
# Get Golang rules
|
||||
GetLinterRules "$GO_FILE_NAME" "$GO_LINTER_RULES"
|
||||
# Get docker rules
|
||||
# Get Docker rules
|
||||
GetLinterRules "$DOCKER_FILE_NAME" "$DOCKER_LINTER_RULES"
|
||||
# Get Terraform rules
|
||||
GetLinterRules "$TERRAFORM_FILE_NAME" "$TERRAFORM_LINTER_RULES"
|
||||
|
||||
#################################
|
||||
# Check if were in verbose mode #
|
||||
|
|
@ -1739,6 +1778,17 @@ if [ "$VALIDATE_GO" == "true" ]; then
|
|||
LintCodebase "GO" "golangci-lint" "golangci-lint run -c $GO_LINTER_RULES" ".*\.\(go\)\$" "${FILE_ARRAY_GO[@]}"
|
||||
fi
|
||||
|
||||
#####################
|
||||
# TERRAFORM LINTING #
|
||||
#####################
|
||||
if [ "$VALIDATE_TERRAFORM" == "true" ]; then
|
||||
############################
|
||||
# Lint the Terraform files #
|
||||
############################
|
||||
# LintCodebase "FILE_TYPE" "LINTER_NAME" "LINTER_CMD" "FILE_TYPES_REGEX" "FILE_ARRAY"
|
||||
LintCodebase "TERRAFORM" "tflint" "tflint -c $TERRAFORM_LINTER_RULES" ".*\.\(tf\)\$" "${FILE_ARRAY_TERRAFORM[@]}"
|
||||
fi
|
||||
|
||||
###################
|
||||
# ANSIBLE LINTING #
|
||||
###################
|
||||
|
|
|
|||
Loading…
Reference in a new issue