mirror of
https://github.com/super-linter/super-linter.git
synced 2024-09-19 19:07:13 -04:00
320 lines
9.6 KiB
Bash
320 lines
9.6 KiB
Bash
|
#!/usr/bin/env bash
|
||
|
|
|
||
|
|
################################################################################
|
||
|
|
################################################################################
|
||
|
|
########### Super-Linter linting Functions @admiralawkbar ######################
|
||
|
|
################################################################################
|
||
|
|
################################################################################
|
||
|
|
########################## FUNCTION CALLS BELOW ################################
|
||
|
|
################################################################################
|
||
|
|
################################################################################
|
||
|
|
#### Function DetectOpenAPIFile ################################################
|
||
|
|
DetectOpenAPIFile() {
|
||
|
|
################
|
||
|
|
# Pull in vars #
|
||
|
|
################
|
||
|
|
FILE="${1}"
|
||
|
|
debug "Checking if ${FILE} is an OpenAPI file..."
|
||
|
|
|
||
|
|
###############################
|
||
|
|
# Check the file for keywords #
|
||
|
|
###############################
|
||
|
|
grep -E '"openapi":|"swagger":|^openapi:|^swagger:' "${FILE}" >/dev/null
|
||
|
|
|
||
|
|
#######################
|
||
|
|
# Load the error code #
|
||
|
|
#######################
|
||
|
|
ERROR_CODE=$?
|
||
|
|
|
||
|
|
##############################
|
||
|
|
# Check the shell for errors #
|
||
|
|
##############################
|
||
|
|
if [ ${ERROR_CODE} -eq 0 ]; then
|
||
|
|
########################
|
||
|
|
# Found string in file #
|
||
|
|
########################
|
||
|
|
return 0
|
||
|
|
else
|
||
|
|
###################
|
||
|
|
# No string match #
|
||
|
|
###################
|
||
|
|
return 1
|
||
|
|
fi
|
||
|
|
}
|
||
|
|
################################################################################
|
||
|
|
#### Function DetectTektonFile #################################################
|
||
|
|
DetectTektonFile() {
|
||
|
|
################
|
||
|
|
# Pull in vars #
|
||
|
|
################
|
||
|
|
FILE="${1}"
|
||
|
|
debug "Checking if ${FILE} is a Tekton file..."
|
||
|
|
|
||
|
|
###############################
|
||
|
|
# Check the file for keywords #
|
||
|
|
###############################
|
||
|
|
grep -q -E 'apiVersion: tekton' "${FILE}" >/dev/null
|
||
|
|
|
||
|
|
#######################
|
||
|
|
# Load the error code #
|
||
|
|
#######################
|
||
|
|
ERROR_CODE=$?
|
||
|
|
|
||
|
|
##############################
|
||
|
|
# Check the shell for errors #
|
||
|
|
##############################
|
||
|
|
if [ ${ERROR_CODE} -eq 0 ]; then
|
||
|
|
########################
|
||
|
|
# Found string in file #
|
||
|
|
########################
|
||
|
|
return 0
|
||
|
|
else
|
||
|
|
###################
|
||
|
|
# No string match #
|
||
|
|
###################
|
||
|
|
return 1
|
||
|
|
fi
|
||
|
|
}
|
||
|
|
################################################################################
|
||
|
|
#### Function DetectARMFile ####################################################
|
||
|
|
DetectARMFile() {
|
||
|
|
################
|
||
|
|
# Pull in vars #
|
||
|
|
################
|
||
|
|
FILE="${1}" # Name of the file/path we are validating
|
||
|
|
debug "Checking if ${FILE} is an ARM file..."
|
||
|
|
|
||
|
|
###############################
|
||
|
|
# Check the file for keywords #
|
||
|
|
###############################
|
||
|
|
grep -E 'schema.management.azure.com' "${FILE}" >/dev/null
|
||
|
|
|
||
|
|
#######################
|
||
|
|
# Load the error code #
|
||
|
|
#######################
|
||
|
|
ERROR_CODE=$?
|
||
|
|
|
||
|
|
##############################
|
||
|
|
# Check the shell for errors #
|
||
|
|
##############################
|
||
|
|
if [ ${ERROR_CODE} -eq 0 ]; then
|
||
|
|
########################
|
||
|
|
# Found string in file #
|
||
|
|
########################
|
||
|
|
return 0
|
||
|
|
else
|
||
|
|
###################
|
||
|
|
# No string match #
|
||
|
|
###################
|
||
|
|
return 1
|
||
|
|
fi
|
||
|
|
}
|
||
|
|
################################################################################
|
||
|
|
#### Function DetectCloudFormationFile #########################################
|
||
|
|
DetectCloudFormationFile() {
|
||
|
|
################
|
||
|
|
# Pull in Vars #
|
||
|
|
################
|
||
|
|
FILE="${1}" # File that we need to validate
|
||
|
|
debug "Checking if ${FILE} is a Cloud Formation file..."
|
||
|
|
|
||
|
|
# https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-formats.html
|
||
|
|
# AWSTemplateFormatVersion is optional
|
||
|
|
#######################################
|
||
|
|
# Check if file has AWS Template info #
|
||
|
|
#######################################
|
||
|
|
if grep -q 'AWSTemplateFormatVersion' "${FILE}" >/dev/null; then
|
||
|
|
# Found it
|
||
|
|
return 0
|
||
|
|
fi
|
||
|
|
|
||
|
|
#####################################
|
||
|
|
# See if it contains AWS References #
|
||
|
|
#####################################
|
||
|
|
if grep -q -E '(AWS|Alexa|Custom)::' "${FILE}" >/dev/null; then
|
||
|
|
# Found it
|
||
|
|
return 0
|
||
|
|
fi
|
||
|
|
|
||
|
|
#####################################################
|
||
|
|
# No identifiers of a CLOUDFORMATION template found #
|
||
|
|
#####################################################
|
||
|
|
return 1
|
||
|
|
}
|
||
|
|
################################################################################
|
||
|
|
#### Function DetectKubernetesFile #########################################
|
||
|
|
DetectKubernetesFile() {
|
||
|
|
################
|
||
|
|
# Pull in Vars #
|
||
|
|
################
|
||
|
|
FILE="${1}" # File that we need to validate
|
||
|
|
debug "Checking if ${FILE} is a Kubernetes descriptor..."
|
||
|
|
|
||
|
|
if grep -v 'kustomize.config.k8s.io' "${FILE}" | grep -v tekton | grep -q -E '(apiVersion):'; then
|
||
|
|
debug "${FILE} is a Kubernetes descriptor"
|
||
|
|
return 0
|
||
|
|
fi
|
||
|
|
|
||
|
|
debug "${FILE} is NOT a Kubernetes descriptor"
|
||
|
|
return 1
|
||
|
|
}
|
||
|
|
################################################################################
|
||
|
|
#### Function DetectAWSStatesFIle ##############################################
|
||
|
|
DetectAWSStatesFIle() {
|
||
|
|
################
|
||
|
|
# Pull in Vars #
|
||
|
|
################
|
||
|
|
FILE="${1}" # File that we need to validate
|
||
|
|
debug "Checking if ${FILE} is a AWS states descriptor..."
|
||
|
|
|
||
|
|
# https://states-language.net/spec.html#example
|
||
|
|
###############################
|
||
|
|
# check if file has resources #
|
||
|
|
###############################
|
||
|
|
if grep -q '"Resource": *"arn"*' "${FILE}"; then
|
||
|
|
# Found it
|
||
|
|
return 0
|
||
|
|
fi
|
||
|
|
|
||
|
|
#################################################
|
||
|
|
# No identifiers of a AWS States Language found #
|
||
|
|
#################################################
|
||
|
|
return 1
|
||
|
|
}
|
||
|
|
################################################################################
|
||
|
|
#### Function CheckInArray #####################################################
|
||
|
|
CheckInArray() {
|
||
|
|
###############
|
||
|
|
# Pull in Var #
|
||
|
|
###############
|
||
|
|
NEEDLE="$1" # Language we need to match
|
||
|
|
|
||
|
|
######################################
|
||
|
|
# Check if Language was in the array #
|
||
|
|
######################################
|
||
|
|
for LANG in "${UNIQUE_LINTED_ARRAY[@]}"; do
|
||
|
|
if [[ "${LANG}" == "${NEEDLE}" ]]; then
|
||
|
|
############
|
||
|
|
# Found it #
|
||
|
|
############
|
||
|
|
return 0
|
||
|
|
fi
|
||
|
|
done
|
||
|
|
|
||
|
|
###################
|
||
|
|
# Did not find it #
|
||
|
|
###################
|
||
|
|
return 1
|
||
|
|
}
|
||
|
|
################################################################################
|
||
|
|
#### Function GetFileType ######################################################
|
||
|
|
function GetFileType() {
|
||
|
|
# Need to run the file through the 'file' exec to help determine
|
||
|
|
# The type of file being parsed
|
||
|
|
|
||
|
|
################
|
||
|
|
# Pull in Vars #
|
||
|
|
################
|
||
|
|
FILE="$1"
|
||
|
|
|
||
|
|
##################
|
||
|
|
# Check the file #
|
||
|
|
##################
|
||
|
|
GET_FILE_TYPE_CMD=$(file "${FILE}" 2>&1)
|
||
|
|
|
||
|
|
echo "${GET_FILE_TYPE_CMD}"
|
||
|
|
}
|
||
|
|
################################################################################
|
||
|
|
#### Function CheckFileType ####################################################
|
||
|
|
function CheckFileType() {
|
||
|
|
# Need to run the file through the 'file' exec to help determine
|
||
|
|
# The type of file being parsed
|
||
|
|
|
||
|
|
################
|
||
|
|
# Pull in Vars #
|
||
|
|
################
|
||
|
|
FILE="$1"
|
||
|
|
|
||
|
|
#################
|
||
|
|
# Get file type #
|
||
|
|
#################
|
||
|
|
GET_FILE_TYPE_CMD="$(GetFileType "$FILE")"
|
||
|
|
|
||
|
|
if [[ ${GET_FILE_TYPE_CMD} == *"Ruby script"* ]]; then
|
||
|
|
#######################
|
||
|
|
# It is a Ruby script #
|
||
|
|
#######################
|
||
|
|
warn "Found ruby script without extension:[.rb]"
|
||
|
|
info "Please update file with proper extensions."
|
||
|
|
################################
|
||
|
|
# Append the file to the array #
|
||
|
|
################################
|
||
|
|
FILE_ARRAY_RUBY+=("${FILE}")
|
||
|
|
else
|
||
|
|
############################
|
||
|
|
# Extension was not found! #
|
||
|
|
############################
|
||
|
|
warn "Failed to get filetype for:[${FILE}]!"
|
||
|
|
fi
|
||
|
|
}
|
||
|
|
################################################################################
|
||
|
|
#### Function GetFileExtension ###############################################
|
||
|
|
function GetFileExtension() {
|
||
|
|
################
|
||
|
|
# Pull in Vars #
|
||
|
|
################
|
||
|
|
FILE="$1"
|
||
|
|
|
||
|
|
###########################
|
||
|
|
# Get the files extension #
|
||
|
|
###########################
|
||
|
|
# Extract just the file extension
|
||
|
|
FILE_TYPE=${FILE##*.}
|
||
|
|
# To lowercase
|
||
|
|
FILE_TYPE=${FILE_TYPE,,}
|
||
|
|
|
||
|
|
echo "$FILE_TYPE"
|
||
|
|
}
|
||
|
|
################################################################################
|
||
|
|
#### Function IsValidShellScript ###############################################
|
||
|
|
function IsValidShellScript() {
|
||
|
|
################
|
||
|
|
# Pull in Vars #
|
||
|
|
################
|
||
|
|
FILE="$1"
|
||
|
|
|
||
|
|
#################
|
||
|
|
# Get file type #
|
||
|
|
#################
|
||
|
|
FILE_EXTENSION="$(GetFileExtension "$FILE")"
|
||
|
|
GET_FILE_TYPE_CMD="$(GetFileType "$FILE")"
|
||
|
|
|
||
|
|
trace "File:[${FILE}], File extension:[${FILE_EXTENSION}], File type: [${GET_FILE_TYPE_CMD}]"
|
||
|
|
|
||
|
|
if [[ "${FILE_EXTENSION}" == "zsh" ]] ||
|
||
|
|
[[ ${GET_FILE_TYPE_CMD} == *"zsh script"* ]]; then
|
||
|
|
warn "$FILE is a ZSH script. Skipping..."
|
||
|
|
return 1
|
||
|
|
fi
|
||
|
|
|
||
|
|
if [ "${FILE_EXTENSION}" == "sh" ] ||
|
||
|
|
[ "${FILE_EXTENSION}" == "bash" ] ||
|
||
|
|
[ "${FILE_EXTENSION}" == "dash" ] ||
|
||
|
|
[ "${FILE_EXTENSION}" == "ksh" ]; then
|
||
|
|
debug "$FILE is a valid shell script (has a valid extension: ${FILE_EXTENSION})"
|
||
|
|
return 0
|
||
|
|
fi
|
||
|
|
|
||
|
|
if [[ "${GET_FILE_TYPE_CMD}" == *"POSIX shell script"* ]] ||
|
||
|
|
[[ ${GET_FILE_TYPE_CMD} == *"Bourne-Again shell script"* ]] ||
|
||
|
|
[[ ${GET_FILE_TYPE_CMD} == *"dash script"* ]] ||
|
||
|
|
[[ ${GET_FILE_TYPE_CMD} == *"ksh script"* ]] ||
|
||
|
|
[[ ${GET_FILE_TYPE_CMD} == *"/usr/bin/env sh script"* ]]; then
|
||
|
|
debug "$FILE is a valid shell script (has a valid file type: ${GET_FILE_TYPE_CMD})"
|
||
|
|
return 0
|
||
|
|
fi
|
||
|
|
|
||
|
|
trace "$FILE is NOT a supported shell script. Skipping"
|
||
|
|
return 1
|
||
|
|
}
|