Merge pull request #81 from github/DebugMode

adding Debug flag and verbosity
This commit is contained in:
Lukas Gravley 2020-04-27 15:01:35 -05:00 committed by GitHub
commit f051268988
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 278 additions and 156 deletions

View file

@ -118,7 +118,8 @@ ENV GITHUB_SHA=${GITHUB_SHA} \
VALIDATE_TERRAFORM=${VALIDATE_TERRAFORM} \ VALIDATE_TERRAFORM=${VALIDATE_TERRAFORM} \
ANSIBLE_DIRECTORY=${ANSIBLE_DIRECTORY} \ ANSIBLE_DIRECTORY=${ANSIBLE_DIRECTORY} \
RUN_LOCAL=${RUN_LOCAL} \ RUN_LOCAL=${RUN_LOCAL} \
TEST_CASE_RUN=${TEST_CASE_RUN} TEST_CASE_RUN=${TEST_CASE_RUN} \
ACTIONS_RUNNER_DEBUG=${ACTIONS_RUNNER_DEBUG}
############################# #############################
# Copy scripts to container # # Copy scripts to container #

View file

@ -145,7 +145,7 @@ The super-linter allows you to pass the following `ENV` variables to be able to
- **VALIDATE_TERRAFORM** - **VALIDATE_TERRAFORM**
- Default: `true` - Default: `true`
- Flag to enable or disable the linting process of the language - Flag to enable or disable the linting process of the language
- **VERBOSE_OUTPUT** - **ACTIONS_RUNNER_DEBUG**
- Default: `false` - Default: `false`
- Flag to enable additional information about the linter, versions, and additional output - Flag to enable additional information about the linter, versions, and additional output
@ -161,7 +161,7 @@ If you need to disable certain *rules* and *functionality*, you can view [Disabl
The **Docker** container that is built from this repository is located at `https://cloud.docker.com/u/admiralawkbar/repository/docker/admiralawkbar/super-linter` The **Docker** container that is built from this repository is located at `https://cloud.docker.com/u/admiralawkbar/repository/docker/admiralawkbar/super-linter`
## Running Super-Linter locally (troubleshooting/debugging/enhancements) ## Running Super-Linter locally (troubleshooting/debugging/enhancements)
If you find that you need to run super-linter locally, you can follow the documentation at [Running super-linter locally](https://github.com/github/super-linter/blob/master/.github/run-linter-locally.md) If you find that you need to run super-linter locally, you can follow the documentation at [Running super-linter locally](https://github.com/github/super-linter/blob/master/docs/run-linter-locally.md)
### CI/CT/CD ### CI/CT/CD
The **Super-Linter** has *CI/CT/CD* configured utilizing **GitHub** Actions. The **Super-Linter** has *CI/CT/CD* configured utilizing **GitHub** Actions.

View file

@ -94,6 +94,10 @@ Once the container has been downloaded to your local environment, you can then b
- `-e ANSIBLE_DIRECTORY=</path/local/to/codebase/with/ansible>` - `-e ANSIBLE_DIRECTORY=</path/local/to/codebase/with/ansible>`
- Default: `/ansible` - Default: `/ansible`
- Flag to set the root directory for Ansible file location(s) - Flag to set the root directory for Ansible file location(s)
- **ACTIONS_RUNNER_DEBUG**
- `-e ACTIONS_RUNNER_DEBUG=<true|false>`
- Default: `false`
- Flag to enable or disable additional debug info
## Troubleshooting ## Troubleshooting

View file

@ -55,6 +55,13 @@ LINTER_ARRAY=("jsonlint" "yamllint" "xmllint" "markdownlint" "shellcheck"
"pylint" "perl" "rubocop" "coffeelint" "eslint" "standard" "pylint" "perl" "rubocop" "coffeelint" "eslint" "standard"
"ansible-lint" "/dockerfilelint/bin/dockerfilelint" "golangci-lint" "tflint") "ansible-lint" "/dockerfilelint/bin/dockerfilelint" "golangci-lint" "tflint")
#############################
# Language array for prints #
#############################
LANGUAGE_ARRAY=('YML' 'JSON' 'XML' 'MARKDOWN' 'BASH' 'PERL' 'RUBY' 'PYTHON'
'COFFEESCRIPT' 'ANSIBLE' 'JAVASCRIPT_STANDARD' 'JAVASCRIPT_ES'
'TYPESCRIPT_STANDARD' 'TYPESCRIPT_ES' 'DOCKER' 'GO' 'TERRAFORM')
################### ###################
# GitHub ENV Vars # # GitHub ENV Vars #
################### ###################
@ -86,7 +93,7 @@ TEST_CASE_RUN="${TEST_CASE_RUN}" # Boolean to validate only
# Debug Vars # # Debug Vars #
############## ##############
RUN_LOCAL="${RUN_LOCAL}" # Boolean to see if we are running locally RUN_LOCAL="${RUN_LOCAL}" # Boolean to see if we are running locally
VERBOSE_OUTPUT="${VERBOSE_OUTPUT}" # Boolean to see even more info (debug) ACTIONS_RUNNER_DEBUG="${ACTIONS_RUNNER_DEBUG}" # Boolean to see even more info (debug)
################ ################
# Default Vars # # Default Vars #
@ -97,12 +104,11 @@ DEFAULT_WORKSPACE='/tmp/lint' # Default workspace if run
DEFAULT_ANSIBLE_DIRECTORY="$GITHUB_WORKSPACE/ansible" # Default Ansible Directory DEFAULT_ANSIBLE_DIRECTORY="$GITHUB_WORKSPACE/ansible" # Default Ansible Directory
DEFAULT_RUN_LOCAL='false' # Default value for debugging locally DEFAULT_RUN_LOCAL='false' # Default value for debugging locally
DEFAULT_TEST_CASE_RUN='false' # Flag to tell code to run only test cases DEFAULT_TEST_CASE_RUN='false' # Flag to tell code to run only test cases
DEFAULT_VERBOSE_OUTPUT='false' # Default value for debugging output DEFAULT_ACTIONS_RUNNER_DEBUG='false' # Default value for debugging output
RAW_FILE_ARRAY=() # Array of all files that were changed RAW_FILE_ARRAY=() # Array of all files that were changed
READ_ONLY_CHANGE_FLAG=0 # Flag set to 1 if files changed are not txt or md READ_ONLY_CHANGE_FLAG=0 # Flag set to 1 if files changed are not txt or md
TEST_CASE_FOLDER='.automation/test' # Folder for test cases we should always ignore TEST_CASE_FOLDER='.automation/test' # Folder for test cases we should always ignore
########################## ##########################
# Array of changed files # # Array of changed files #
########################## ##########################
@ -219,16 +225,11 @@ GetLinterRules()
FILE_NAME="$1" # Name fo the linter file FILE_NAME="$1" # Name fo the linter file
FILE_LOCATION="$2" # Location of the linter file FILE_LOCATION="$2" # Location of the linter file
################
# print header #
################
echo "----------------------------------------------"
echo "Gathering users linter:[$FILE_NAME] rules from repository, or defaulting..."
##################################### #####################################
# Validate we have the linter rules # # Validate we have the linter rules #
##################################### #####################################
if [ -f "$GITHUB_WORKSPACE/$LINTER_PATH/$FILE_NAME" ]; then if [ -f "$GITHUB_WORKSPACE/$LINTER_PATH/$FILE_NAME" ]; then
echo "----------------------------------------------"
echo "User provided file:[$FILE_NAME], setting rules file..." echo "User provided file:[$FILE_NAME], setting rules file..."
#################################### ####################################
@ -253,8 +254,10 @@ GetLinterRules()
######################################################## ########################################################
# No user default provided, using the template default # # No user default provided, using the template default #
######################################################## ########################################################
if [[ "$ACTIONS_RUNNER_DEBUG" == "true" ]]; then
echo " -> Codebase does NOT have file:[$LINTER_PATH/$FILE_NAME], using Default rules at:[$FILE_LOCATION]" echo " -> Codebase does NOT have file:[$LINTER_PATH/$FILE_NAME], using Default rules at:[$FILE_LOCATION]"
fi fi
fi
} }
################################################################################ ################################################################################
#### Function GetStandardRules ################################################# #### Function GetStandardRules #################################################
@ -342,15 +345,20 @@ GetStandardRules()
#### Function LintAnsibleFiles ################################################# #### Function LintAnsibleFiles #################################################
LintAnsibleFiles() LintAnsibleFiles()
{ {
######################
# Create Print Array #
######################
PRINT_ARRAY=()
################ ################
# print header # # print header #
################ ################
echo "" PRINT_ARRAY+=("")
echo "----------------------------------------------" PRINT_ARRAY+=("----------------------------------------------")
echo "----------------------------------------------" PRINT_ARRAY+=("----------------------------------------------")
echo "Linting [Ansible] files..." PRINT_ARRAY+=("Linting [Ansible] files...")
echo "----------------------------------------------" PRINT_ARRAY+=("----------------------------------------------")
echo "----------------------------------------------" PRINT_ARRAY+=("----------------------------------------------")
###################### ######################
# Name of the linter # # Name of the linter #
@ -378,7 +386,7 @@ LintAnsibleFiles()
exit 1 exit 1
else else
# Success # Success
if [[ "$VERBOSE_OUTPUT" != "false" ]]; then if [[ "$ACTIONS_RUNNER_DEBUG" == "true" ]]; then
# Success # Success
echo "Successfully found binary in system" echo "Successfully found binary in system"
echo "Location:[$VALIDATE_INSTALL_CMD]" echo "Location:[$VALIDATE_INSTALL_CMD]"
@ -390,6 +398,11 @@ LintAnsibleFiles()
########################## ##########################
LIST_FILES=() LIST_FILES=()
#######################
# Create flag to skip #
#######################
SKIP_FLAG=0
###################################################### ######################################################
# Only go into ansible linter if we have base folder # # Only go into ansible linter if we have base folder #
###################################################### ######################################################
@ -423,7 +436,24 @@ LintAnsibleFiles()
################################### ###################################
# Send message that were skipping # # Send message that were skipping #
################################### ###################################
echo "- Skipping Ansible lint run as file(s) that were modified were read only..." #echo "- Skipping Ansible lint run as file(s) that were modified were read only..."
############################
# Create flag to skip loop #
############################
SKIP_FLAG=1
fi
####################################
# Check if we have data to look at #
####################################
if [ $SKIP_FLAG -eq 0 ]; then
for LINE in "${PRINT_ARRAY[@]}"
do
#########################
# Print the header line #
#########################
echo "$LINE"
done
fi fi
################## ##################
@ -479,13 +509,18 @@ LintAnsibleFiles()
echo " - File:[$FILE_NAME] was linted with [$LINTER_NAME] successfully" echo " - File:[$FILE_NAME] was linted with [$LINTER_NAME] successfully"
fi fi
done done
else else # No ansible directory found in path
###############################
# Check to see if debug is on #
###############################
if [[ "$ACTIONS_RUNNER_DEBUG" == "true" ]]; then
######################## ########################
# No Ansible dir found # # No Ansible dir found #
######################## ########################
echo "WARN! No Ansible base directory found at:[$ANSIBLE_DIRECTORY]" echo "WARN! No Ansible base directory found at:[$ANSIBLE_DIRECTORY]"
echo "skipping ansible lint" echo "skipping ansible lint"
fi fi
fi
} }
################################################################################ ################################################################################
#### Function GetGitHubVars #################################################### #### Function GetGitHubVars ####################################################
@ -624,13 +659,17 @@ GetGitHubVars()
echo "Successfully found:[GITHUB_REPO], value:[$GITHUB_REPO]" echo "Successfully found:[GITHUB_REPO], value:[$GITHUB_REPO]"
fi fi
fi fi
}
################################################################################
#### Function GetValidationInfo ################################################
GetValidationInfo()
{
############################################ ############################################
# Print headers for user provided env vars # # Print headers for user provided env vars #
############################################ ############################################
echo "" echo ""
echo "--------------------------------------------" echo "--------------------------------------------"
echo "Gathering User provided information..." echo "Gathering user validation information..."
########################################### ###########################################
# Skip validation if were running locally # # Skip validation if were running locally #
@ -653,6 +692,11 @@ GetGitHubVars()
fi fi
fi fi
######################
# Create Print Array #
######################
PRINT_ARRAY=()
############################### ###############################
# Convert string to lowercase # # Convert string to lowercase #
############################### ###############################
@ -663,10 +707,10 @@ GetGitHubVars()
if [[ "$VALIDATE_YAML" != "false" ]]; then if [[ "$VALIDATE_YAML" != "false" ]]; then
# Set to true # Set to true
VALIDATE_YAML="$DEFAULT_VALIDATE_LANGUAGE" VALIDATE_YAML="$DEFAULT_VALIDATE_LANGUAGE"
echo "- Validating [YML] files in code base..." PRINT_ARRAY+=("- Validating [YML] files in code base...")
else else
# Its false # Its false
echo "- Excluding [YML] files in code base..." PRINT_ARRAY+=("- Excluding [YML] files in code base...")
fi fi
############################### ###############################
@ -679,10 +723,10 @@ GetGitHubVars()
if [[ "$VALIDATE_JSON" != "false" ]]; then if [[ "$VALIDATE_JSON" != "false" ]]; then
# Set to true # Set to true
VALIDATE_JSON="$DEFAULT_VALIDATE_LANGUAGE" VALIDATE_JSON="$DEFAULT_VALIDATE_LANGUAGE"
echo "- Validating [JSON] files in code base..." PRINT_ARRAY+=("- Validating [JSON] files in code base...")
else else
# Its false # Its false
echo "- Excluding [JSON] files in code base..." PRINT_ARRAY+=("- Excluding [JSON] files in code base...")
fi fi
############################### ###############################
@ -695,10 +739,10 @@ GetGitHubVars()
if [[ "$VALIDATE_XML" != "false" ]]; then if [[ "$VALIDATE_XML" != "false" ]]; then
# Set to true # Set to true
VALIDATE_XML="$DEFAULT_VALIDATE_LANGUAGE" VALIDATE_XML="$DEFAULT_VALIDATE_LANGUAGE"
echo "- Validating [XML] files in code base..." PRINT_ARRAY+=("- Validating [XML] files in code base...")
else else
# Its false # Its false
echo "- Excluding [XML] files in code base..." PRINT_ARRAY+=("- Excluding [XML] files in code base...")
fi fi
############################### ###############################
@ -711,10 +755,10 @@ GetGitHubVars()
if [[ "$VALIDATE_MD" != "false" ]]; then if [[ "$VALIDATE_MD" != "false" ]]; then
# Set to true # Set to true
VALIDATE_MD="$DEFAULT_VALIDATE_LANGUAGE" VALIDATE_MD="$DEFAULT_VALIDATE_LANGUAGE"
echo "- Validating [MARKDOWN] files in code base..." PRINT_ARRAY+=("- Validating [MARKDOWN] files in code base...")
else else
# Its false # Its false
echo "- Excluding [MARKDOWN] files in code base..." PRINT_ARRAY+=("- Excluding [MARKDOWN] files in code base...")
fi fi
############################### ###############################
@ -727,10 +771,10 @@ GetGitHubVars()
if [[ "$VALIDATE_BASH" != "false" ]]; then if [[ "$VALIDATE_BASH" != "false" ]]; then
# Set to true # Set to true
VALIDATE_BASH="$DEFAULT_VALIDATE_LANGUAGE" VALIDATE_BASH="$DEFAULT_VALIDATE_LANGUAGE"
echo "- Validating [BASH] files in code base..." PRINT_ARRAY+=("- Validating [BASH] files in code base...")
else else
# Its false # Its false
echo "- Excluding [BASH] files in code base..." PRINT_ARRAY+=("- Excluding [BASH] files in code base...")
fi fi
############################### ###############################
@ -743,10 +787,10 @@ GetGitHubVars()
if [[ "$VALIDATE_PERL" != "false" ]]; then if [[ "$VALIDATE_PERL" != "false" ]]; then
# Set to true # Set to true
VALIDATE_PERL="$DEFAULT_VALIDATE_LANGUAGE" VALIDATE_PERL="$DEFAULT_VALIDATE_LANGUAGE"
echo "- Validating [PERL] files in code base..." PRINT_ARRAY+=("- Validating [PERL] files in code base...")
else else
# Its false # Its false
echo "- Excluding [PERL] files in code base..." PRINT_ARRAY+=("- Excluding [PERL] files in code base...")
fi fi
############################### ###############################
@ -759,10 +803,10 @@ GetGitHubVars()
if [[ "$VALIDATE_PYTHON" != "false" ]]; then if [[ "$VALIDATE_PYTHON" != "false" ]]; then
# Set to true # Set to true
VALIDATE_PYTHON="$DEFAULT_VALIDATE_LANGUAGE" VALIDATE_PYTHON="$DEFAULT_VALIDATE_LANGUAGE"
echo "- Validating [PYTHON] files in code base..." PRINT_ARRAY+=("- Validating [PYTHON] files in code base...")
else else
# Its false # Its false
echo "- Excluding [PYTHON] files in code base..." PRINT_ARRAY+=("- Excluding [PYTHON] files in code base...")
fi fi
############################### ###############################
@ -775,10 +819,10 @@ GetGitHubVars()
if [[ "$VALIDATE_RUBY" != "false" ]]; then if [[ "$VALIDATE_RUBY" != "false" ]]; then
# Set to true # Set to true
VALIDATE_RUBY="$DEFAULT_VALIDATE_LANGUAGE" VALIDATE_RUBY="$DEFAULT_VALIDATE_LANGUAGE"
echo "- Validating [RUBY] files in code base..." PRINT_ARRAY+=("- Validating [RUBY] files in code base...")
else else
# Its false # Its false
echo "- Excluding [RUBY] files in code base..." PRINT_ARRAY+=("- Excluding [RUBY] files in code base...")
fi fi
############################### ###############################
@ -791,10 +835,10 @@ GetGitHubVars()
if [[ "$VALIDATE_COFFEE" != "false" ]]; then if [[ "$VALIDATE_COFFEE" != "false" ]]; then
# Set to true # Set to true
VALIDATE_COFFEE="$DEFAULT_VALIDATE_LANGUAGE" VALIDATE_COFFEE="$DEFAULT_VALIDATE_LANGUAGE"
echo "- Validating [COFFEE] files in code base..." PRINT_ARRAY+=("- Validating [COFFEE] files in code base...")
else else
# Its false # Its false
echo "- Excluding [COFFEE] files in code base..." PRINT_ARRAY+=("- Excluding [COFFEE] files in code base...")
fi fi
############################### ###############################
@ -807,10 +851,10 @@ GetGitHubVars()
if [[ "$VALIDATE_ANSIBLE" != "false" ]]; then if [[ "$VALIDATE_ANSIBLE" != "false" ]]; then
# Set to true # Set to true
VALIDATE_ANSIBLE="$DEFAULT_VALIDATE_LANGUAGE" VALIDATE_ANSIBLE="$DEFAULT_VALIDATE_LANGUAGE"
echo "- Validating [ANSIBLE] files in code base..." PRINT_ARRAY+=("- Validating [ANSIBLE] files in code base...")
else else
# Its false # Its false
echo "- Excluding [ANSIBLE] files in code base..." PRINT_ARRAY+=("- Excluding [ANSIBLE] files in code base...")
fi fi
############################### ###############################
@ -823,10 +867,10 @@ GetGitHubVars()
if [[ "$VALIDATE_JAVASCRIPT_ES" != "false" ]]; then if [[ "$VALIDATE_JAVASCRIPT_ES" != "false" ]]; then
# Set to true # Set to true
VALIDATE_JAVASCRIPT_ES="$DEFAULT_VALIDATE_LANGUAGE" VALIDATE_JAVASCRIPT_ES="$DEFAULT_VALIDATE_LANGUAGE"
echo "- Validating [JAVASCRIPT(eslint)] files in code base..." PRINT_ARRAY+=("- Validating [JAVASCRIPT(eslint)] files in code base...")
else else
# Its false # Its false
echo "- Excluding [JAVASCRIPT(eslint)] files in code base..." PRINT_ARRAY+=("- Excluding [JAVASCRIPT(eslint)] files in code base...")
fi fi
############################### ###############################
@ -839,10 +883,10 @@ GetGitHubVars()
if [[ "$VALIDATE_JAVASCRIPT_STANDARD" != "false" ]]; then if [[ "$VALIDATE_JAVASCRIPT_STANDARD" != "false" ]]; then
# Set to true # Set to true
VALIDATE_JAVASCRIPT_STANDARD="$DEFAULT_VALIDATE_LANGUAGE" VALIDATE_JAVASCRIPT_STANDARD="$DEFAULT_VALIDATE_LANGUAGE"
echo "- Validating [JAVASCRIPT(standard)] files in code base..." PRINT_ARRAY+=("- Validating [JAVASCRIPT(standard)] files in code base...")
else else
# Its false # Its false
echo "- Excluding [JAVASCRIPT(standard)] files in code base..." PRINT_ARRAY+=("- Excluding [JAVASCRIPT(standard)] files in code base...")
fi fi
############################### ###############################
@ -855,10 +899,10 @@ GetGitHubVars()
if [[ "$VALIDATE_TYPESCRIPT_ES" != "false" ]]; then if [[ "$VALIDATE_TYPESCRIPT_ES" != "false" ]]; then
# Set to true # Set to true
VALIDATE_TYPESCRIPT_ES="$DEFAULT_VALIDATE_LANGUAGE" VALIDATE_TYPESCRIPT_ES="$DEFAULT_VALIDATE_LANGUAGE"
echo "- Validating [TYPESCRIPT(eslint)] files in code base..." PRINT_ARRAY+=("- Validating [TYPESCRIPT(eslint)] files in code base...")
else else
# Its false # Its false
echo "- Excluding [TYPESCRIPT(eslint)] files in code base..." PRINT_ARRAY+=("- Excluding [TYPESCRIPT(eslint)] files in code base...")
fi fi
############################### ###############################
@ -871,10 +915,10 @@ GetGitHubVars()
if [[ "$VALIDATE_TYPESCRIPT_STANDARD" != "false" ]]; then if [[ "$VALIDATE_TYPESCRIPT_STANDARD" != "false" ]]; then
# Set to true # Set to true
VALIDATE_TYPESCRIPT_STANDARD="$DEFAULT_VALIDATE_LANGUAGE" VALIDATE_TYPESCRIPT_STANDARD="$DEFAULT_VALIDATE_LANGUAGE"
echo "- Validating [TYPESCRIPT(standard)] files in code base..." PRINT_ARRAY+=("- Validating [TYPESCRIPT(standard)] files in code base...")
else else
# Its false # Its false
echo "- Excluding [TYPESCRIPT(standard)] files in code base..." PRINT_ARRAY+=("- Excluding [TYPESCRIPT(standard)] files in code base...")
fi fi
############################### ###############################
@ -887,10 +931,10 @@ GetGitHubVars()
if [[ "$VALIDATE_DOCKER" != "false" ]]; then if [[ "$VALIDATE_DOCKER" != "false" ]]; then
# Set to true # Set to true
VALIDATE_DOCKER="$DEFAULT_VALIDATE_LANGUAGE" VALIDATE_DOCKER="$DEFAULT_VALIDATE_LANGUAGE"
echo "- Validating [DOCKER] files in code base..." PRINT_ARRAY+=("- Validating [DOCKER] files in code base...")
else else
# Its false # Its false
echo "- Excluding [DOCKER] files in code base..." PRINT_ARRAY+=("- Excluding [DOCKER] files in code base...")
fi fi
############################### ###############################
@ -903,10 +947,10 @@ GetGitHubVars()
if [[ "$VALIDATE_GO" != "false" ]]; then if [[ "$VALIDATE_GO" != "false" ]]; then
# Set to true # Set to true
VALIDATE_GO="$DEFAULT_VALIDATE_LANGUAGE" VALIDATE_GO="$DEFAULT_VALIDATE_LANGUAGE"
echo "- Validating [GOLANG] files in code base..." PRINT_ARRAY+=("- Validating [GOLANG] files in code base...")
else else
# Its false # Its false
echo "- Excluding [GOLANG] files in code base..." PRINT_ARRAY+=("- Excluding [GOLANG] files in code base...")
fi fi
############################### ###############################
@ -919,10 +963,10 @@ GetGitHubVars()
if [[ "$VALIDATE_TERRAFORM" != "false" ]]; then if [[ "$VALIDATE_TERRAFORM" != "false" ]]; then
# Set to true # Set to true
VALIDATE_TERRAFORM="$DEFAULT_VALIDATE_LANGUAGE" VALIDATE_TERRAFORM="$DEFAULT_VALIDATE_LANGUAGE"
echo "- Validating [TERRAFORM] files in code base..." PRINT_ARRAY+=("- Validating [TERRAFORM] files in code base...")
else else
# Its false # Its false
echo "- Excluding [TERRAFORM] files in code base..." PRINT_ARRAY+=("- Excluding [TERRAFORM] files in code base...")
fi fi
############################## ##############################
@ -946,23 +990,38 @@ GetGitHubVars()
############################ ############################
# Get the run verbose flag # # Get the run verbose flag #
############################ ############################
if [ -z "$VERBOSE_OUTPUT" ]; then if [ -z "$ACTIONS_RUNNER_DEBUG" ]; then
################################## ##################################
# No flag passed, set to default # # No flag passed, set to default #
################################## ##################################
VERBOSE_OUTPUT="$DEFAULT_VERBOSE_OUTPUT" ACTIONS_RUNNER_DEBUG="$DEFAULT_ACTIONS_RUNNER_DEBUG"
fi fi
############################### ###############################
# Convert string to lowercase # # Convert string to lowercase #
############################### ###############################
VERBOSE_OUTPUT=$(echo "$VERBOSE_OUTPUT" | awk '{print tolower($0)}') ACTIONS_RUNNER_DEBUG=$(echo "$ACTIONS_RUNNER_DEBUG" | awk '{print tolower($0)}')
############################
# Set to true if not false #
############################
if [ "$ACTIONS_RUNNER_DEBUG" != "false" ]; then
ACTIONS_RUNNER_DEBUG="true"
fi
################### ###################
# Debug on runner # # Debug on runner #
################### ###################
if [[ "$VERBOSE_OUTPUT" != "false" ]]; then if [[ "$ACTIONS_RUNNER_DEBUG" == "true" ]]; then
echo "--- DEBUG ---" ###########################
# Print the validate info #
###########################
for LINE in "${PRINT_ARRAY[@]}"
do
echo "$LINE"
done
echo "--- DEBUG INFO ---"
echo "---------------------------------------------" echo "---------------------------------------------"
RUNNER=$(whoami) RUNNER=$(whoami)
echo "Runner:[$RUNNER]" echo "Runner:[$RUNNER]"
@ -981,14 +1040,16 @@ BuildFileList()
################ ################
# print header # # print header #
################ ################
if [[ "$ACTIONS_RUNNER_DEBUG" == "true" ]]; then
echo "" echo ""
echo "----------------------------------------------" echo "----------------------------------------------"
echo "Pulling in code history and branches..." echo "Pulling in code history and branches..."
fi
##################################################################### #####################################################################
# Switch codebase back to master to get a list of all files changed # # Switch codebase back to master to get a list of all files changed #
##################################################################### #####################################################################
SWITCH_CMD=$(cd "$GITHUB_WORKSPACE" || exit; git pull; git checkout master 2>&1) SWITCH_CMD=$(cd "$GITHUB_WORKSPACE" || exit; git pull --quiet; git checkout master 2>&1)
####################### #######################
# Load the error code # # Load the error code #
@ -1008,9 +1069,11 @@ BuildFileList()
################ ################
# print header # # print header #
################ ################
if [[ "$ACTIONS_RUNNER_DEBUG" == "true" ]]; then
echo "" echo ""
echo "----------------------------------------------" echo "----------------------------------------------"
echo "Generating Diff with:[git diff --name-only 'master..$GITHUB_SHA' --diff-filter=d]" echo "Generating Diff with:[git diff --name-only 'master..$GITHUB_SHA' --diff-filter=d]"
fi
################################################ ################################################
# Get the Array of files changed in the comits # # Get the Array of files changed in the comits #
@ -1311,15 +1374,20 @@ LintCodebase()
FILE_EXTENSIONS="$1" && shift # Pull the variable and remove from array path (Example: *.json) FILE_EXTENSIONS="$1" && shift # Pull the variable and remove from array path (Example: *.json)
FILE_ARRAY=("$@") # Array of files to validate (Example: $FILE_ARRAY_JSON) FILE_ARRAY=("$@") # Array of files to validate (Example: $FILE_ARRAY_JSON)
######################
# Create Print Array #
######################
PRINT_ARRAY=()
################ ################
# print header # # print header #
################ ################
echo "" PRINT_ARRAY+=("")
echo "----------------------------------------------" PRINT_ARRAY+=("----------------------------------------------")
echo "----------------------------------------------" PRINT_ARRAY+=("----------------------------------------------")
echo "Linting [$FILE_TYPE] files..." PRINT_ARRAY+=("Linting [$FILE_TYPE] files...")
echo "----------------------------------------------" PRINT_ARRAY+=("----------------------------------------------")
echo "----------------------------------------------" PRINT_ARRAY+=("----------------------------------------------")
####################################### #######################################
# Validate we have jsonlint installed # # Validate we have jsonlint installed #
@ -1342,21 +1410,29 @@ LintCodebase()
exit 1 exit 1
else else
# Success # Success
if [[ "$ACTIONS_RUNNER_DEBUG" == "true" ]]; then
echo "Successfully found binary in system" echo "Successfully found binary in system"
echo "Location:[$VALIDATE_INSTALL_CMD]" echo "Location:[$VALIDATE_INSTALL_CMD]"
fi fi
fi
########################## ##########################
# Initialize empty Array # # Initialize empty Array #
########################## ##########################
LIST_FILES=() LIST_FILES=()
################
# Set the flag #
################
SKIP_FLAG=0
############################################################ ############################################################
# Check to see if we need to go through array or all files # # Check to see if we need to go through array or all files #
############################################################ ############################################################
if [ ${#FILE_ARRAY[@]} -eq 0 ] && [ "$VALIDATE_ALL_CODEBASE" == "false" ]; then if [ ${#FILE_ARRAY[@]} -eq 0 ] && [ "$VALIDATE_ALL_CODEBASE" == "false" ]; then
# No files found in commit and user has asked to not validate code base # No files found in commit and user has asked to not validate code base
echo " - No files found in chageset to lint for language:[$FILE_TYPE]" SKIP_FLAG=1
# echo " - No files found in chageset to lint for language:[$FILE_TYPE]"
elif [ ${#FILE_ARRAY[@]} -ne 0 ]; then elif [ ${#FILE_ARRAY[@]} -ne 0 ]; then
# We have files added to array of files to check # We have files added to array of files to check
LIST_FILES=("${FILE_ARRAY[@]}") # Copy the array into list LIST_FILES=("${FILE_ARRAY[@]}") # Copy the array into list
@ -1366,7 +1442,36 @@ LintCodebase()
################################# #################################
# shellcheck disable=SC2207,SC2086 # shellcheck disable=SC2207,SC2086
LIST_FILES=($(cd "$GITHUB_WORKSPACE" || exit; find . -type f -regex "$FILE_EXTENSIONS" 2>&1)) LIST_FILES=($(cd "$GITHUB_WORKSPACE" || exit; find . -type f -regex "$FILE_EXTENSIONS" 2>&1))
############################################################
# Set it back to empty if loaded with blanks from scanning #
############################################################
if [ ${#LIST_FILES[@]} -lt 1 ]; then
######################
# Set to empty array #
######################
LIST_FILES=()
#############################
# Skip as we found no files #
#############################
SKIP_FLAG=1
fi fi
fi
###############################
# Check if any data was found #
###############################
if [ $SKIP_FLAG -eq 0 ]; then
######################
# Print Header array #
######################
for LINE in "${PRINT_ARRAY[@]}"
do
#########################
# Print the header info #
#########################
echo "$LINE"
done
################## ##################
# Lint the files # # Lint the files #
@ -1423,6 +1528,7 @@ LintCodebase()
echo " - File:[$FILE_NAME] was linted with [$LINTER_NAME] successfully" echo " - File:[$FILE_NAME] was linted with [$LINTER_NAME] successfully"
fi fi
done done
fi
} }
################################################################################ ################################################################################
#### Function TestCodebase ##################################################### #### Function TestCodebase #####################################################
@ -1635,26 +1741,25 @@ Footer()
echo "----------------------------------------------" echo "----------------------------------------------"
echo "----------------------------------------------" echo "----------------------------------------------"
echo "" echo ""
echo "ERRORS FOUND in YAML:[$ERRORS_FOUND_YML]"
echo "ERRORS FOUND in JSON:[$ERRORS_FOUND_JSON]" ##############################
echo "ERRORS FOUND in XML:[$ERRORS_FOUND_XML]" # Prints for errors if found #
echo "ERRORS FOUND in MARKDOWN:[$ERRORS_FOUND_MARKDOWN]" ##############################
echo "ERRORS FOUND in BASH:[$ERRORS_FOUND_BASH]" for LANGUAGE in "${LANGUAGE_ARRAY[@]}"
echo "ERRORS FOUND in PERL:[$ERRORS_FOUND_PERL]" do
echo "ERRORS FOUND in PYTHON:[$ERRORS_FOUND_PYTHON]" ###########################
echo "ERRORS FOUND in COFFEESCRIPT:[$ERRORS_FOUND_COFFEESCRIPT]" # Build the error counter #
echo "ERRORS FOUND in RUBY:[$ERRORS_FOUND_RUBY]" ###########################
echo "ERRORS FOUND in ANSIBLE:[$ERRORS_FOUND_ANSIBLE]" ERROR_COUNTER="ERRORS_FOUND_$LANGUAGE"
echo "ERRORS FOUND in JAVASCRIPT(eslint):[$ERRORS_FOUND_JAVASCRIPT_ES]"
echo "ERRORS FOUND in JAVASCRIPT(Standard):[$ERRORS_FOUND_JAVASCRIPT_STANDARD]" ##################
echo "ERRORS FOUND in TYPESCRIPT(eslint):[$ERRORS_FOUND_TYPESCRIPT_ES]" # Print if not 0 #
echo "ERRORS FOUND in TYPESCRIPT(Standard):[$ERRORS_FOUND_TYPESCRIPT_STANDARD]" ##################
echo "ERRORS FOUND in DOCKER:[$ERRORS_FOUND_DOCKER]" if [ "${!ERROR_COUNTER}" -ne 0 ]; then
echo "ERRORS FOUND in GO:[$ERRORS_FOUND_GO]" # Print the goods
echo "ERRORS FOUND in TERRAFORM:[$ERRORS_FOUND_TERRAFORM]" echo "ERRORS FOUND in $LANGUAGE:[${!ERROR_COUNTER}]"
echo "" fi
echo "----------------------------------------------" done
echo ""
############################### ###############################
# Exit with 1 if errors found # # Exit with 1 if errors found #
@ -1680,6 +1785,13 @@ Footer()
echo "Exiting with errors found!" echo "Exiting with errors found!"
exit 1 exit 1
else else
#################
# Footer prints #
#################
echo ""
echo "All file(s) linted successfully with no errors detected"
echo "----------------------------------------------"
echo ""
# Successful exit # Successful exit
exit 0 exit 0
fi fi
@ -1749,6 +1861,11 @@ Header
# needed to connect back and update checks # needed to connect back and update checks
GetGitHubVars GetGitHubVars
##########################################
# Get the langugages we need to validate #
##########################################
GetValidationInfo
######################## ########################
# Get the linter rules # # Get the linter rules #
######################## ########################
@ -1778,7 +1895,7 @@ GetLinterRules "$TERRAFORM_FILE_NAME" "$TERRAFORM_LINTER_RULES"
################################# #################################
# Check if were in verbose mode # # Check if were in verbose mode #
################################# #################################
if [[ "$VERBOSE_OUTPUT" != "false" ]]; then if [[ "$ACTIONS_RUNNER_DEBUG" == "true" ]]; then
################################## ##################################
# Get and print all version info # # Get and print all version info #
################################## ##################################