commit c0d63119764f5b110ee83c5a8f2295e922944d78 Author: Lucas Gravley <29484535+admiralAwkbar@users.noreply.github.com> Date: Mon Oct 21 09:12:50 2019 -0500 initial commit diff --git a/.automation/.ansible-lint b/.automation/.ansible-lint new file mode 100644 index 00000000..0007c68d --- /dev/null +++ b/.automation/.ansible-lint @@ -0,0 +1,51 @@ +########################## +########################## +## Ansible Linter rules ## +########################## +########################## + +############################# +# Exclude paths from linter # +############################# +#exclude_paths: + +######################## +# Make output parsable # +######################## +parseable: true + +####################### +# Set output to quiet # +####################### +quiet: true + +##################### +# Path to rules dir # +##################### +#rulesdir: + +################ +# Tags to skip # +################ +skip_list: + - '602' # Allow compare to empty string + - '204' # Allow string length greater that 160 chars + - '301' # False positives for running command shells + - '303' # Allow git commands for push add, etc... + - '305' # Allow use of shell when you want + - '503' # Allow step to run like handler + +################## +# Tags to follow # +################## +#tags: + +############# +# Use rules # +############# +use_default_rules: true + +################# +# Set verbosity # +################# +verbosity: 1 diff --git a/.automation/.rubocop.yml b/.automation/.rubocop.yml new file mode 100644 index 00000000..e9608eed --- /dev/null +++ b/.automation/.rubocop.yml @@ -0,0 +1,189 @@ +--- +####################### +# Rubocop Config file # +####################### + +################################################################################ +############################## Rails Rules ##################################### +################################################################################ + +# Set the linter to enable rails rules +Rails: + Enabled: true + +################################################################################ +############################# Security Rules ################################### +################################################################################ + +# Security rules +Security/Open: + Enabled: false +################################################################################ +############################# Metrics Rules #################################### +################################################################################ + +# Commonly used screens these days easily fit more than 80 characters. +Metrics/LineLength: + Max: 120 + +# Too short methods lead to extraction of single-use methods, which can make +# the code easier to read (by naming things), but can also clutter the class +Metrics/MethodLength: + Max: 30 + +# The guiding principle of classes is SRP, +# SRP can't be accurately measured by LoC +Metrics/ClassLength: + Max: 1500 + +# Turn off the Assignment Branch Condition size for the case of these scripts +Metrics/AbcSize: + Enabled: false + +# Set the complexity of the metrics +Metrics/PerceivedComplexity: + Max: 10 + +# Set the complexity of the cyle +Metrics/CyclomaticComplexity: + Max: 10 + +################################################################################ +########################## Layout Rules ######################################## +################################################################################ + +# No space makes the method definition shorter and differentiates +# from a regular assignment. +Layout/SpaceAroundEqualsInParameterDefault: + EnforcedStyle: no_space + +# Most readable form. +Layout/AlignHash: + EnforcedHashRocketStyle: table + EnforcedColonStyle: table + +# Indenting the chained dots beneath each other is not supported by this cop, +# see https://github.com/bbatsov/rubocop/issues/1633 +Layout/MultilineOperationIndentation: + Enabled: false + +Layout/SpaceInsideBlockBraces: + # The space here provides no real gain in readability while consuming + # horizontal space that could be used for a better parameter name. + # Also {| differentiates better from a hash than { | does. + SpaceBeforeBlockParameters: false + +# No trailing space differentiates better from the block: +# foo} means hash, foo } means block. +Layout/SpaceInsideHashLiteralBraces: + EnforcedStyle: no_space + +################################################################################ +########################### Style Rules ######################################## +################################################################################ + +# Single quotes being faster is hardly measurable and only affects parse time. +# Enforcing double quotes reduces the times where you need to change them +# when introducing an interpolation. Use single quotes only if their semantics +# are needed. +Style/StringLiterals: + EnforcedStyle: double_quotes + +# We do not need to support Ruby 1.9, so this is good to use. +Style/SymbolArray: + Enabled: true + +# Mixing the styles looks just silly. +Style/HashSyntax: + EnforcedStyle: ruby19_no_mixed_keys + +# has_key? and has_value? are far more readable than key? and value? +Style/PreferredHashMethods: + Enabled: false + +# String#% is by far the least verbose and only object oriented variant. +Style/FormatString: + EnforcedStyle: percent + +Style/CollectionMethods: + Enabled: true + PreferredMethods: + # inject seems more common in the community. + reduce: "inject" + +# Either allow this style or don't. Marking it as safe with parenthesis +# is silly. Let's try to live without them for now. +Style/ParenthesesAroundCondition: + AllowSafeAssignment: false + +# A specialized exception class will take one or more arguments +# and construct the message from it. So both variants make sense. +Style/RaiseArgs: + Enabled: false + +# Fail is an alias of raise. Avoid aliases, +# it's more cognitive load for no gain. The argument that fail +# should be used to abort the program is wrong too, +# there's Kernel#abort for that. +Style/SignalException: + EnforcedStyle: only_raise + +# { ... } for multi-line blocks is okay, follow Weirichs rule instead: +# https://web.archive.org/web/20140221124509/http://onestepback.org/index.cgi/Tech/Ruby/BraceVsDoEnd.rdoc +Style/BlockDelimiters: + Enabled: false + +# do / end blocks should be used for side effects, +# methods that run a block for side effects and have +# a useful return value are rare, assign the return +# value to a local variable for those cases. +Style/MethodCalledOnDoEndBlock: + Enabled: true + +# Enforcing the names of variables? To single letter ones? Just no. +Style/SingleLineBlockParams: + Enabled: false + +# Check with yard instead. +Style/Documentation: + Enabled: false + +# Style preference +Style/MethodDefParentheses: + Enabled: false + +################################################################################ +########################### Linter Rules ####################################### +################################################################################ + +# There are valid cases, for example debugging Cucumber steps, +# also they'll fail CI anyway +Lint/Debugger: + Enabled: false + +# Shadowing outer local variables with block parameters is often useful +# to not reinvent a new name for the same thing, it highlights the relation +# between the outer variable and the parameter. The cases where it's actually +# confusing are rare, and usually bad for other reasons already, for example +# because the method is too long. +Lint/ShadowingOuterLocalVariable: + Enabled: false + +# Suppressing exceptions can be perfectly fine, and be it to avoid to +# explicitly type nil into the rescue since that's what you want to return, +# or suppressing LoadError for optional dependencies +Lint/HandleExceptions: + Enabled: false + +Lint/AssignmentInCondition: + AllowSafeAssignment: false + +################################################################################ +############################ Naming Rules ###################################### +################################################################################ + +# This is just silly. Calling the argument `other` in all cases makes no sense. +Naming/BinaryOperatorParameterName: + Enabled: false + +################################################################################ diff --git a/.automation/README.md b/.automation/README.md new file mode 100644 index 00000000..1c553dbc --- /dev/null +++ b/.automation/README.md @@ -0,0 +1,3 @@ +# Automation + +This folder holds all scripting and configuration to run **GitHub Actions** that validate the sanity of the source code in this repository. diff --git a/.automation/ansible-linter.sh b/.automation/ansible-linter.sh new file mode 100644 index 00000000..a9c0f506 --- /dev/null +++ b/.automation/ansible-linter.sh @@ -0,0 +1,184 @@ +#!/bin/bash + +################################################################################ +################## Ansible Linter @admiralawkbar ############################### +################################################################################ + +########### +# GLOBALS # +########### +BUILD_DIR=$(pwd 2>&1) # Current Build dir +ANSIBLE_LINTER_FILE=".automation/.ansible-lint" # Name of the Linter file +ANSIBLE_DIR="$BUILD_DIR/ansible" # Ansible directory + +############ +# Counters # +############ +ERRORS_FOUND_ANSIBLE=0 # Count of errors found + +################################################################################ +########################## FUNCTIONS BELOW ##################################### +################################################################################ +################################################################################ +#### Function Header ########################################################### +Header() +{ + echo "" + echo "-----------------------------------" + echo "---------- Ansible Linter ---------" + echo "-----------------------------------" + echo "" +} +################################################################################ +#### Function LintAnsibleFiles ################################################# +LintAnsibleFiles() +{ + ################ + # print header # + ################ + echo "" + echo "--------------------------------" + echo "Linting Ansible files..." + echo "--------------------------------" + echo "" + + ########################################## + # Validate we have the linter rules file # + ########################################## + if [ ! -f "$ANSIBLE_LINTER_FILE" ]; then + # Error + echo "ERROR! Failed to find rules file at:[$ANSIBLE_LINTER_FILE]" + exit 1 + fi + + ###################### + # Name of the linter # + ###################### + LINTER_NAME="ansible-lint" + + ########################################### + # Validate we have ansible-lint installed # + ########################################### + # shellcheck disable=SC2230 + VALIDATE_INSTALL_CMD=$(which "$LINTER_NAME" 2>&1) + + ####################### + # Load the error code # + ####################### + ERROR_CODE=$? + + ############################## + # Check the shell for errors # + ############################## + if [ $ERROR_CODE -ne 0 ]; then + # Failed + echo "ERROR! Failed to find $LINTER_NAME in system!" + echo "ERROR:[$VALIDATE_INSTALL_CMD]" + exit 1 + else + # Success + echo "Successfully found binary in system" + echo "Location:[$VALIDATE_INSTALL_CMD]" + fi + + ################################# + # Get list of all files to lint # + ################################# + # shellcheck disable=SC2164,SC2010 + LIST_FILES=($(cd "$ANSIBLE_DIR"; ls -I vault.yml -I galaxy.yml | grep ".yml" 2>&1)) + + ################## + # Lint the files # + ################## + for FILE in "${LIST_FILES[@]}" + do + + ####################################### + # Make sure we dont lint node modules # + ####################################### + # if [[ $FILE == *"node_modules"* ]]; then + # # This is a node modules file + # continue + # fi + + #################### + # Get the filename # + #################### + FILE_NAME=$(basename "$ANSIBLE_DIR/$FILE" 2>&1) + + ############## + # File print # + ############## + echo "---------------------------" + echo "File:[$FILE]" + + ################################ + # Lint the file with the rules # + ################################ + LINT_CMD=$("$LINTER_NAME" -v -c "$ANSIBLE_LINTER_FILE" "$ANSIBLE_DIR/$FILE" 2>&1) + + ####################### + # Load the error code # + ####################### + ERROR_CODE=$? + + ############################## + # Check the shell for errors # + ############################## + if [ $ERROR_CODE -ne 0 ]; then + ######### + # Error # + ######### + echo "ERROR! Found errors in [$LINTER_NAME] linter!" + echo "ERROR:[$LINT_CMD]" + # Increment error count + ((ERRORS_FOUND_ANSIBLE++)) + else + ########### + # Success # + ########### + echo " - File:[$FILE_NAME] was linted with [$LINTER_NAME] successfully" + fi + done +} +################################################################################ +#### Function Footer ########################################################### +Footer() +{ + echo "" + echo "---------------------------" + echo "The script has completed" + echo "---------------------------" + echo "ERRORS FOUND in ANSIBLE:[$ERRORS_FOUND_ANSIBLE]" + echo "" + + ############################### + # Exit with 1 if errors found # + ############################### + if [ $ERRORS_FOUND_ANSIBLE -ne 0 ]; then + # Failed exit + echo "Exiting with errors found!" + exit 1 + else + # Successful exit + exit 0 + fi +} +################################################################################ +############################### MAIN ########################################### +################################################################################ + +########## +# Header # +########## +Header + +########################## +# Lint the Ansible files # +########################## +LintAnsibleFiles + +########## +# Footer # +########## +Footer diff --git a/.automation/install-ansible-deps.sh b/.automation/install-ansible-deps.sh new file mode 100644 index 00000000..96c0877a --- /dev/null +++ b/.automation/install-ansible-deps.sh @@ -0,0 +1,347 @@ +#!/bin/bash + +################################################################################ +################## Scripting Language Linter @admiralawkbar #################### +################################################################################ + +########### +# GLOBALS # +########### +APT_PACKAGE_ARRAY=() # Packages to install using APT +GEM_PACKAGE_ARRAY=() # Packages to install using GEM +NPM_PACKAGE_ARRAY=() # Packages to install using NPM +PIP_PACKAGE_ARRAY=( + "ansible-lint==4.0.1") # Packages to install using PIP + +################################################################################ +########################## FUNCTIONS BELOW ##################################### +################################################################################ +################################################################################ +#### Function Header ########################################################### +Header() +{ + echo "" + echo "------------------------------" + echo "---- Install Dependancies ----" + echo "------------------------------" +} +################################################################################ +#### Function InstallAptPackages ############################################### +InstallAptPackages() +{ + ###################################################### + # Convert Array to string for single pass to install # + ###################################################### + INSTALL_PACKAGE_STRING=$(ConvertArray "${APT_PACKAGE_ARRAY[@]}") + + ############################### + # Check the string for length # + ############################### + LENGTH=${#INSTALL_PACKAGE_STRING} + + ############################# + # Skip loop if no variables # + ############################# + if [ "$LENGTH" -le 1 ]; then + echo "" + echo "------------------------------" + echo "No APT package(s) to install... skipping..." + else + ########### + # Headers # + ########### + echo "" + echo "------------------------------" + echo "Installing APT package(s)" + echo "Packages:[$INSTALL_PACKAGE_STRING]" + echo "This could take several moments..." + + #################################### + # Need to install all APT packages # + #################################### + # shellcheck disable=SC2086 + INSTALL_CMD=$(sudo apt-get install $INSTALL_PACKAGE_STRING -y 2>&1) + + ####################### + # Load the error code # + ####################### + ERROR_CODE=$? + + ############################## + # Check the shell for errors # + ############################## + if [ $ERROR_CODE -ne 0 ]; then + # Error + echo "ERROR! Failed to install APT packages!" + echo "ERROR:[$INSTALL_CMD]" + exit 1 + else + # Success + echo "Successfully installed all APT packages" + fi + fi +} +################################################################################ +#### Function InstallPipPackages ############################################### +InstallPipPackages() +{ + ###################################################### + # Convert Array to string for single pass to install # + ###################################################### + INSTALL_PACKAGE_STRING=$(ConvertArray "${PIP_PACKAGE_ARRAY[@]}") + + ############################### + # Check the string for length # + ############################### + LENGTH=${#INSTALL_PACKAGE_STRING} + + ############################# + # Skip loop if no variables # + ############################# + if [ "$LENGTH" -le 1 ]; then + echo "" + echo "------------------------------" + echo "No PIP package(s) to install... skipping..." + else + ########### + # Headers # + ########### + echo "" + echo "------------------------------" + echo "Installing PIP package(s)" + echo "Packages:[$INSTALL_PACKAGE_STRING]" + echo "This could take several moments..." + + #################################### + # Need to install all APT packages # + #################################### + # shellcheck disable=SC2086 + INSTALL_CMD=$(sudo -H pip install $INSTALL_PACKAGE_STRING 2>&1) + + ####################### + # Load the error code # + ####################### + ERROR_CODE=$? + + ############################## + # Check the shell for errors # + ############################## + if [ $ERROR_CODE -ne 0 ]; then + # Error + echo "ERROR! Failed to install PIP packages!" + echo "ERROR:[$INSTALL_CMD]" + exit 1 + else + # Success + echo "Successfully installed all PIP packages" + fi + fi +} +################################################################################ +#### Function InstallGemPackages ############################################### +InstallGemPackages() +{ + ###################################################### + # Convert Array to string for single pass to install # + ###################################################### + INSTALL_PACKAGE_STRING=$(ConvertArray "${GEM_PACKAGE_ARRAY[@]}") + + ############################### + # Check the string for length # + ############################### + LENGTH=${#INSTALL_PACKAGE_STRING} + + ############################# + # Skip loop if no variables # + ############################# + if [ "$LENGTH" -le 1 ]; then + echo "" + echo "------------------------------" + echo "No GEM package(s) to install... skipping..." + else + ########### + # Headers # + ########### + echo "" + echo "------------------------------" + echo "Installing GEM package(s)" + echo "Packages:[$INSTALL_PACKAGE_STRING]" + echo "This could take several moments..." + + #################################### + # Need to install all APT packages # + #################################### + # shellcheck disable=SC2086 + INSTALL_CMD=$(gem install $INSTALL_PACKAGE_STRING 2>&1) + + ####################### + # Load the error code # + ####################### + ERROR_CODE=$? + + ############################## + # Check the shell for errors # + ############################## + if [ $ERROR_CODE -ne 0 ]; then + # Error + echo "ERROR! Failed to install GEM packages!" + echo "ERROR:[$INSTALL_CMD]" + exit 1 + else + # Success + echo "Successfully installed all GEM packages" + fi + fi +} +################################################################################ +#### Function InstallNPMPackages ############################################### +InstallNPMPackages() +{ + ###################################################### + # Convert Array to string for single pass to install # + ###################################################### + INSTALL_PACKAGE_STRING=$(ConvertArray "${NPM_PACKAGE_ARRAY[@]}") + + ############################### + # Check the string for length # + ############################### + LENGTH=${#INSTALL_PACKAGE_STRING} + + ############################# + # Skip loop if no variables # + ############################# + if [ "$LENGTH" -le 1 ]; then + echo "" + echo "------------------------------" + echo "No NPM package(s) to install... skipping..." + else + ########### + # Headers # + ########### + echo "" + echo "------------------------------" + echo "Installing NPM package(s)" + echo "Packages:[$INSTALL_PACKAGE_STRING]" + echo "This could take several moments..." + + #################################### + # Need to install all APT packages # + #################################### + # shellcheck disable=SC2086 + INSTALL_CMD=$(npm -g install $INSTALL_PACKAGE_STRING 2>&1) + + ####################### + # Load the error code # + ####################### + ERROR_CODE=$? + + ############################## + # Check the shell for errors # + ############################## + if [ $ERROR_CODE -ne 0 ]; then + # Error + echo "ERROR! Failed to install NPM packages!" + echo "ERROR:[$INSTALL_CMD]" + exit 1 + else + # Success + echo "Successfully installed all NPM packages" + fi + fi +} +################################################################################ +#### Function ConvertArray ##################################################### +ConvertArray() +{ + ##################### + # Read in the array # + ##################### + ARRAY=("$@") + + ################################################### + # Convert the array into a space seperated string # + ################################################### + STRING=$(IFS=$' '; echo "${ARRAY[*]}" 2>&1) + + ####################### + # Load the error code # + ####################### + ERROR_CODE=$? + + ############################## + # Check the shell for errors # + ############################## + if [ $ERROR_CODE -ne 0 ]; then + # Error + echo "ERROR! Failed to create string!" + echo "ERROR:[$STRING]" + exit 1 + fi + + ########################################## + # Need to remove whitespace on the edges # + ########################################## + CLEANED_STRING=$(echo "$STRING" | xargs 2>&1) + + ####################### + # Load the error code # + ####################### + ERROR_CODE=$? + + ############################## + # Check the shell for errors # + ############################## + if [ $ERROR_CODE -ne 0 ]; then + # Error + echo "ERROR! Failed to clean string!" + echo "ERROR:[$STRING]" + exit 1 + else + ############################################################ + # Echo the cleaned string back to the master function call # + ############################################################ + echo "$CLEANED_STRING" + fi +} +################################################################################ +#### Function Footer ########################################################### +Footer() +{ + echo "" + echo "---------------------------" + echo "The script has completed" + echo "---------------------------" +} +################################################################################ +############################### MAIN ########################################### +################################################################################ + +########## +# Header # +########## +Header + +######################## +# Install APT packages # +######################## +InstallAptPackages + +######################## +# Install PIP packages # +######################## +InstallPipPackages + +######################## +# Install GEM packages # +######################## +InstallGemPackages + +######################## +# Install NPM packages # +######################## +InstallNPMPackages + +########## +# Footer # +########## +Footer diff --git a/.automation/install-deps.sh b/.automation/install-deps.sh new file mode 100644 index 00000000..a582047a --- /dev/null +++ b/.automation/install-deps.sh @@ -0,0 +1,353 @@ +#!/bin/bash + +################################################################################ +################## Scripting Language Linter @admiralawkbar #################### +################################################################################ + +########### +# GLOBALS # +########### +APT_PACKAGE_ARRAY=( + "yamllint" + "shellcheck" + "jsonlint" + "pylint" + "libxml2-utils") # Packages to install using APT +GEM_PACKAGE_ARRAY=( + "rubocop") # Packages to install using GEM +NPM_PACKAGE_ARRAY=( + "markdownlint-cli") # Packages to install using NPM +PIP_PACKAGE_ARRAY=() # Packages to install using PIP + +################################################################################ +########################## FUNCTIONS BELOW ##################################### +################################################################################ +################################################################################ +#### Function Header ########################################################### +Header() +{ + echo "" + echo "------------------------------" + echo "---- Install Dependancies ----" + echo "------------------------------" +} +################################################################################ +#### Function InstallAptPackages ############################################### +InstallAptPackages() +{ + ###################################################### + # Convert Array to string for single pass to install # + ###################################################### + INSTALL_PACKAGE_STRING=$(ConvertArray "${APT_PACKAGE_ARRAY[@]}") + + ############################### + # Check the string for length # + ############################### + LENGTH=${#INSTALL_PACKAGE_STRING} + + ############################# + # Skip loop if no variables # + ############################# + if [ "$LENGTH" -le 1 ]; then + echo "" + echo "------------------------------" + echo "No APT package(s) to install... skipping..." + else + ########### + # Headers # + ########### + echo "" + echo "------------------------------" + echo "Installing APT package(s)" + echo "Packages:[$INSTALL_PACKAGE_STRING]" + echo "This could take several moments..." + + #################################### + # Need to install all APT packages # + #################################### + # shellcheck disable=SC2086 + INSTALL_CMD=$(sudo apt-get install $INSTALL_PACKAGE_STRING -y 2>&1) + + ####################### + # Load the error code # + ####################### + ERROR_CODE=$? + + ############################## + # Check the shell for errors # + ############################## + if [ $ERROR_CODE -ne 0 ]; then + # Error + echo "ERROR! Failed to install APT packages!" + echo "ERROR:[$INSTALL_CMD]" + exit 1 + else + # Success + echo "Successfully installed all APT packages" + fi + fi +} +################################################################################ +#### Function InstallPipPackages ############################################### +InstallPipPackages() +{ + ###################################################### + # Convert Array to string for single pass to install # + ###################################################### + INSTALL_PACKAGE_STRING=$(ConvertArray "${PIP_PACKAGE_ARRAY[@]}") + + ############################### + # Check the string for length # + ############################### + LENGTH=${#INSTALL_PACKAGE_STRING} + + ############################# + # Skip loop if no variables # + ############################# + if [ "$LENGTH" -le 1 ]; then + echo "" + echo "------------------------------" + echo "No PIP package(s) to install... skipping..." + else + ########### + # Headers # + ########### + echo "" + echo "------------------------------" + echo "Installing PIP package(s)" + echo "Packages:[$INSTALL_PACKAGE_STRING]" + echo "This could take several moments..." + + #################################### + # Need to install all APT packages # + #################################### + # shellcheck disable=SC2086 + INSTALL_CMD=$(pip install $INSTALL_PACKAGE_STRING 2>&1) + + ####################### + # Load the error code # + ####################### + ERROR_CODE=$? + + ############################## + # Check the shell for errors # + ############################## + if [ $ERROR_CODE -ne 0 ]; then + # Error + echo "ERROR! Failed to install PIP packages!" + echo "ERROR:[$INSTALL_CMD]" + exit 1 + else + # Success + echo "Successfully installed all PIP packages" + fi + fi +} +################################################################################ +#### Function InstallGemPackages ############################################### +InstallGemPackages() +{ + ###################################################### + # Convert Array to string for single pass to install # + ###################################################### + INSTALL_PACKAGE_STRING=$(ConvertArray "${GEM_PACKAGE_ARRAY[@]}") + + ############################### + # Check the string for length # + ############################### + LENGTH=${#INSTALL_PACKAGE_STRING} + + ############################# + # Skip loop if no variables # + ############################# + if [ "$LENGTH" -le 1 ]; then + echo "" + echo "------------------------------" + echo "No GEM package(s) to install... skipping..." + else + ########### + # Headers # + ########### + echo "" + echo "------------------------------" + echo "Installing GEM package(s)" + echo "Packages:[$INSTALL_PACKAGE_STRING]" + echo "This could take several moments..." + + #################################### + # Need to install all APT packages # + #################################### + # shellcheck disable=SC2086 + INSTALL_CMD=$(gem install $INSTALL_PACKAGE_STRING 2>&1) + + ####################### + # Load the error code # + ####################### + ERROR_CODE=$? + + ############################## + # Check the shell for errors # + ############################## + if [ $ERROR_CODE -ne 0 ]; then + # Error + echo "ERROR! Failed to install GEM packages!" + echo "ERROR:[$INSTALL_CMD]" + exit 1 + else + # Success + echo "Successfully installed all GEM packages" + fi + fi +} +################################################################################ +#### Function InstallNPMPackages ############################################### +InstallNPMPackages() +{ + ###################################################### + # Convert Array to string for single pass to install # + ###################################################### + INSTALL_PACKAGE_STRING=$(ConvertArray "${NPM_PACKAGE_ARRAY[@]}") + + ############################### + # Check the string for length # + ############################### + LENGTH=${#INSTALL_PACKAGE_STRING} + + ############################# + # Skip loop if no variables # + ############################# + if [ "$LENGTH" -le 1 ]; then + echo "" + echo "------------------------------" + echo "No NPM package(s) to install... skipping..." + else + ########### + # Headers # + ########### + echo "" + echo "------------------------------" + echo "Installing NPM package(s)" + echo "Packages:[$INSTALL_PACKAGE_STRING]" + echo "This could take several moments..." + + #################################### + # Need to install all APT packages # + #################################### + # shellcheck disable=SC2086 + INSTALL_CMD=$(npm -g install $INSTALL_PACKAGE_STRING 2>&1) + + ####################### + # Load the error code # + ####################### + ERROR_CODE=$? + + ############################## + # Check the shell for errors # + ############################## + if [ $ERROR_CODE -ne 0 ]; then + # Error + echo "ERROR! Failed to install NPM packages!" + echo "ERROR:[$INSTALL_CMD]" + exit 1 + else + # Success + echo "Successfully installed all NPM packages" + fi + fi +} +################################################################################ +#### Function ConvertArray ##################################################### +ConvertArray() +{ + ##################### + # Read in the array # + ##################### + ARRAY=("$@") + + ################################################### + # Convert the array into a space seperated string # + ################################################### + STRING=$(IFS=$' '; echo "${ARRAY[*]}" 2>&1) + + ####################### + # Load the error code # + ####################### + ERROR_CODE=$? + + ############################## + # Check the shell for errors # + ############################## + if [ $ERROR_CODE -ne 0 ]; then + # Error + echo "ERROR! Failed to create string!" + echo "ERROR:[$STRING]" + exit 1 + fi + + ########################################## + # Need to remove whitespace on the edges # + ########################################## + CLEANED_STRING=$(echo "$STRING" | xargs 2>&1) + + ####################### + # Load the error code # + ####################### + ERROR_CODE=$? + + ############################## + # Check the shell for errors # + ############################## + if [ $ERROR_CODE -ne 0 ]; then + # Error + echo "ERROR! Failed to clean string!" + echo "ERROR:[$STRING]" + exit 1 + else + ############################################################ + # Echo the cleaned string back to the master function call # + ############################################################ + echo "$CLEANED_STRING" + fi +} +################################################################################ +#### Function Footer ########################################################### +Footer() +{ + echo "" + echo "---------------------------" + echo "The script has completed" + echo "---------------------------" +} +################################################################################ +############################### MAIN ########################################### +################################################################################ + +########## +# Header # +########## +Header + +######################## +# Install APT packages # +######################## +InstallAptPackages + +######################## +# Install PIP packages # +######################## +InstallPipPackages + +######################## +# Install GEM packages # +######################## +InstallGemPackages + +######################## +# Install NPM packages # +######################## +InstallNPMPackages + +########## +# Footer # +########## +Footer diff --git a/.automation/markup-markdown-linter.sh b/.automation/markup-markdown-linter.sh new file mode 100644 index 00000000..fbb27cc1 --- /dev/null +++ b/.automation/markup-markdown-linter.sh @@ -0,0 +1,527 @@ +#!/bin/bash + +################################################################################ +########### Markup and Markdown Language Linter @AdmiralAwkbar ################# +################################################################################ + +########### +# GLOBALS # +########### +YAML_LINTER_RULES='.automation/yaml-linter-rules.yml' # Path to the yaml lint rules +MD_LINTER_RULES='.automation/md-linter-rules.yml' # Path to the markdown lint rules + +############ +# Counters # +############ +ERRORS_FOUND_YML=0 # Count of errors found +ERRORS_FOUND_JSON=0 # Count of errors found +ERRORS_FOUND_XML=0 # Count of errors found +ERRORS_FOUND_MD=0 # Count of errors found + +################################################################################ +########################## FUNCTIONS BELOW ##################################### +################################################################################ +################################################################################ +#### Function Header ########################################################### +Header() +{ + echo "" + echo "---------------------------------------------" + echo "---- Markup and Markdown Language Linter ----" + echo "---------------------------------------------" + echo "" +} +################################################################################ +#### Function GetLinterRules ################################################### +GetLinterRules() +{ + # Need to validate the rules files exist + + ##################################### + # Validate we have the linter rules # + ##################################### + if [ ! -f "$YAML_LINTER_RULES" ]; then + echo "ERROR! Failed to find:[$YAML_LINTER_RULES] in root of code base!" + exit 1 + fi + + ##################################### + # Validate we have the linter rules # + ##################################### + if [ ! -f "$MD_LINTER_RULES" ]; then + echo "ERROR! Failed to find:[$MD_LINTER_RULES] in root of code base!" + exit 1 + fi +} +################################################################################ +#### Function LintJsonFiles #################################################### +LintJsonFiles() +{ + ################ + # print header # + ################ + echo "" + echo "--------------------------------" + echo "Linting JSON files..." + echo "--------------------------------" + echo "" + + ###################### + # Name of the linter # + ###################### + LINTER_NAME="jsonlint-php" + + ####################################### + # Validate we have yamllint installed # + ####################################### + # shellcheck disable=SC2230 + VALIDATE_INSTALL_CMD=$(which "$LINTER_NAME" 2>&1) + + ####################### + # Load the error code # + ####################### + ERROR_CODE=$? + + ############################## + # Check the shell for errors # + ############################## + if [ $ERROR_CODE -ne 0 ]; then + # Failed + echo "ERROR! Failed to find [$LINTER_NAME] in system!" + echo "ERROR:[$VALIDATE_INSTALL_CMD]" + exit 1 + else + # Success + echo "Successfully found binary in system" + echo "Location:[$VALIDATE_INSTALL_CMD]" + fi + + ################################# + # Get list of all files to lint # + ################################# + # shellcheck disable=SC2207 + LIST_FILES=($(find . -type f -name "*.json" 2>&1)) + + ################## + # Lint the files # + ################## + for FILE in "${LIST_FILES[@]}" + do + ##################### + # Get the file name # + ##################### + FILE_NAME=$(basename "$FILE" 2>&1) + + ####################################### + # Make sure we dont lint node modules # + ####################################### + if [[ $FILE == *"node_modules"* ]]; then + # This is a node modules file + continue + fi + + ############## + # File print # + ############## + echo "---------------------------" + echo "File:[$FILE]" + + ################################ + # Lint the file with the rules # + ################################ + LINT_CMD=$("$LINTER_NAME" "$FILE" 2>&1) + + ####################### + # Load the error code # + ####################### + ERROR_CODE=$? + + ############################## + # Check the shell for errors # + ############################## + if [ $ERROR_CODE -ne 0 ]; then + ######### + # Error # + ######### + echo "ERROR! Found errors in [$LINTER_NAME] linter!" + echo "ERROR:[$LINT_CMD]" + # Increment error count + ((ERRORS_FOUND_JSON++)) + else + ########### + # Success # + ########### + echo " - File:[$FILE_NAME] was linted with [$LINTER_NAME] successfully" + fi + done +} +################################################################################ +#### Function LintYmlFiles ##################################################### +LintYmlFiles() +{ + ################ + # print header # + ################ + echo "" + echo "--------------------------------" + echo "Linting YAML files..." + echo "--------------------------------" + echo "" + + ###################### + # Name of the linter # + ###################### + LINTER_NAME="yamllint" + + ####################################### + # Validate we have yamllint installed # + ####################################### + # shellcheck disable=SC2230 + VALIDATE_INSTALL_CMD=$(which "$LINTER_NAME" 2>&1) + + ####################### + # Load the error code # + ####################### + ERROR_CODE=$? + + ############################## + # Check the shell for errors # + ############################## + if [ $ERROR_CODE -ne 0 ]; then + # Failed + echo "ERROR! Failed to find [$LINTER_NAME] in system!" + echo "ERROR:[$VALIDATE_INSTALL_CMD]" + exit 1 + else + # Success + echo "Successfully found binary in system" + echo "Location:[$VALIDATE_INSTALL_CMD]" + fi + + ################################# + # Get list of all files to lint # + ################################# + # shellcheck disable=SC2207 + LIST_FILES=($(find . -type f \( -name "*.yml" -or -name "*.yaml" \) 2>&1)) + + ################## + # Lint the files # + ################## + for FILE in "${LIST_FILES[@]}" + do + ##################### + # Get the file name # + ##################### + FILE_NAME=$(basename "$FILE" 2>&1) + + ####################################### + # Make sure we dont lint node modules # + ####################################### + # if [[ $FILE == *"node_modules"* ]]; then + # # This is a node modules file + # continue + # fi + + ############## + # File print # + ############## + echo "---------------------------" + echo "File:[$FILE]" + + ################################ + # Lint the file with the rules # + ################################ + LINT_CMD=$("$LINTER_NAME" "$YAML_LINTER_RULES" "$FILE" 2>&1) + + ####################### + # Load the error code # + ####################### + ERROR_CODE=$? + + ############################## + # Check the shell for errors # + ############################## + if [ $ERROR_CODE -ne 0 ]; then + ######### + # Error # + ######### + echo "ERROR! Found errors in [$LINTER_NAME] linter!" + echo "ERROR:[$LINT_CMD]" + # Increment error count + ((ERRORS_FOUND_YML++)) + else + ########### + # Success # + ########### + echo " - File:[$FILE_NAME] was linted with [$LINTER_NAME] successfully" + fi + done +} +################################################################################ +#### Function LintXmlFiles ##################################################### +LintXmlFiles() +{ + ################ + # print header # + ################ + echo "" + echo "--------------------------------" + echo "Linting XML files..." + echo "--------------------------------" + echo "" + + ###################### + # Name of the linter # + ###################### + LINTER_NAME="xmllint" + + ####################################### + # Validate we have yamllint installed # + ####################################### + # shellcheck disable=SC2230 + VALIDATE_INSTALL_CMD=$(which "$LINTER_NAME" 2>&1) + + ####################### + # Load the error code # + ####################### + ERROR_CODE=$? + + ############################## + # Check the shell for errors # + ############################## + if [ $ERROR_CODE -ne 0 ]; then + # Failed + echo "ERROR! Failed to find [$LINTER_NAME] in system!" + echo "ERROR:[$VALIDATE_INSTALL_CMD]" + exit 1 + else + # Success + echo "Successfully found binary in system" + echo "Location:[$VALIDATE_INSTALL_CMD]" + fi + + ################################# + # Get list of all files to lint # + ################################# + # shellcheck disable=SC2207 + LIST_FILES=($(find . -type f -name "*.xml" 2>&1)) + + ################## + # Lint the files # + ################## + for FILE in "${LIST_FILES[@]}" + do + ##################### + # Get the file name # + ##################### + FILE_NAME=$(basename "$FILE" 2>&1) + + ####################################### + # Make sure we dont lint node modules # + ####################################### + # if [[ $FILE == *"node_modules"* ]]; then + # # This is a node modules file + # continue + # fi + + ############## + # File print # + ############## + echo "---------------------------" + echo "File:[$FILE]" + + ################################ + # Lint the file with the rules # + ################################ + LINT_CMD=$("$LINTER_NAME" "$FILE" 2>&1) + + ####################### + # Load the error code # + ####################### + ERROR_CODE=$? + + ############################## + # Check the shell for errors # + ############################## + if [ $ERROR_CODE -ne 0 ]; then + ######### + # Error # + ######### + echo "ERROR! Found errors in [$LINTER_NAME] linter!" + echo "ERROR:[$LINT_CMD]" + # Increment error count + ((ERRORS_FOUND_XML++)) + else + ########### + # Success # + ########### + echo " - File:[$FILE_NAME] was linted with [$LINTER_NAME] successfully" + fi + done +} +################################################################################ +#### Function LintMdFiles ###################################################### +LintMdFiles() +{ + ################ + # print header # + ################ + echo "" + echo "--------------------------------" + echo "Linting Markdown files..." + echo "--------------------------------" + echo "" + + ###################### + # Name of the linter # + ###################### + LINTER_NAME="markdownlint" + + ####################################### + # Validate we have yamllint installed # + ####################################### + # shellcheck disable=SC2230 + VALIDATE_INSTALL_CMD=$(which "$LINTER_NAME" 2>&1) + + ####################### + # Load the error code # + ####################### + ERROR_CODE=$? + + ############################## + # Check the shell for errors # + ############################## + if [ $ERROR_CODE -ne 0 ]; then + # Failed + echo "ERROR! Failed to find [$LINTER_NAME] in system!" + echo "ERROR:[$VALIDATE_INSTALL_CMD]" + exit 1 + else + # Success + echo "Successfully found binary in system" + echo "Location:[$VALIDATE_INSTALL_CMD]" + fi + + ################################# + # Get list of all files to lint # + ################################# + # shellcheck disable=SC2207 + LIST_FILES=($(find . -type f -name "*.md" 2>&1)) + + ################## + # Lint the files # + ################## + for FILE in "${LIST_FILES[@]}" + do + ##################### + # Get the file name # + ##################### + FILE_NAME=$(basename "$FILE" 2>&1) + + ####################################### + # Make sure we dont lint node modules # + ####################################### + # if [[ $FILE == *"node_modules"* ]]; then + # # This is a node modules file + # continue + # fi + + ############## + # File print # + ############## + echo "---------------------------" + echo "File:[$FILE]" + + ################################ + # Lint the file with the rules # + ################################ + LINT_CMD=$("$LINTER_NAME" -c "$MD_LINTER_RULES" "$FILE" 2>&1) + + ####################### + # Load the error code # + ####################### + ERROR_CODE=$? + + ############################## + # Check the shell for errors # + ############################## + if [ $ERROR_CODE -ne 0 ]; then + ######### + # Error # + ######### + echo "ERROR! Found errors in [$LINTER_NAME] linter!" + echo "ERROR:[$LINT_CMD]" + # Increment error count + ((ERRORS_FOUND_MD++)) + else + ########### + # Success # + ########### + echo " - File:[$FILE_NAME] was linted with [$LINTER_NAME] successfully" + fi + done +} +################################################################################ +#### Function Footer ########################################################### +Footer() +{ + echo "" + echo "---------------------------" + echo "The script has completed" + 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]" + echo "ERRORS FOUND IN MD:[$ERRORS_FOUND_MD]" + 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_MD -ne 0 ]; then + # Failed exit + echo "Exiting with errors found!" + exit 1 + else + # Successful exit + exit 0 + fi +} +################################################################################ +############################### MAIN ########################################### +################################################################################ + +########## +# Header # +########## +Header + +######################## +# Get the linter rules # +######################## +GetLinterRules + +###################### +# Lint the Yml Files # +###################### +LintYmlFiles + +####################### +# Lint the json files # +####################### +LintJsonFiles + +###################### +# Lint the XML Files # +###################### +LintXmlFiles + +########################### +# Lint the Markdown Files # +########################### +LintMdFiles + +########## +# Footer # +########## +Footer diff --git a/.automation/md-linter-rules.yml b/.automation/md-linter-rules.yml new file mode 100644 index 00000000..f2dec62f --- /dev/null +++ b/.automation/md-linter-rules.yml @@ -0,0 +1,35 @@ +--- +########################### +########################### +## Markdown Linter rules ## +########################### +########################### + +# Linter rules doc: +# - https://github.com/DavidAnson/markdownlint +# +# Note: +# To comment out a single error: +# +# any violations you want +# +# + +############### +# Rules by id # +############### +MD004: false # Unordered list style +MD007: + indent: 2 # Unordered list indentation +MD013: + line_length: 808 # Line length +MD026: + punctuation: ".,;:!。，；:" # List of not allowed +MD029: false # Ordered list item prefix +MD033: false # Allow inline HTML +MD036: false # Emphasis used instead of a heading + +################# +# Rules by tags # +################# +blank_lines: false # Error on blank lines diff --git a/.automation/pylintrc b/.automation/pylintrc new file mode 100644 index 00000000..8e9cc00e --- /dev/null +++ b/.automation/pylintrc @@ -0,0 +1,542 @@ +[MASTER] + +# A comma-separated list of package or module names from where C extensions may +# be loaded. Extensions are loading into the active Python interpreter and may +# run arbitrary code +extension-pkg-whitelist= + +# Add files or directories to the blacklist. They should be base names, not +# paths. +ignore=CVS + +# Add files or directories matching the regex patterns to the blacklist. The +# regex matches against base names, not paths. +ignore-patterns= + +# Python code to execute, usually for sys.path manipulation such as +# pygtk.require(). +#init-hook= + +# Use multiple processes to speed up Pylint. +jobs=1 + +# List of plugins (as comma separated values of python modules names) to load, +# usually to register additional checkers. +load-plugins= + +# Pickle collected data for later comparisons. +persistent=yes + +# Specify a configuration file. +#rcfile= + +# When enabled, pylint would attempt to guess common misconfiguration and emit +# user-friendly hints instead of false-positive error messages +suggestion-mode=yes + +# Allow loading of arbitrary C extensions. Extensions are imported into the +# active Python interpreter and may run arbitrary code. +unsafe-load-any-extension=no + + +[MESSAGES CONTROL] + +# Only show warnings with the listed confidence levels. Leave empty to show +# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED +confidence= + +# Disable the message, report, category or checker with the given id(s). You +# can either give multiple identifiers separated by comma (,) or put this +# option multiple times (only on the command line, not in the configuration +# file where it should appear only once).You can also use "--disable=all" to +# disable everything first and then reenable specific checks. For example, if +# you want to run only the similarities checker, you can use "--disable=all +# --enable=similarities". If you want to run only the classes checker, but have +# no Warning level messages displayed, use"--disable=all --enable=classes +# --disable=W" +disable=print-statement, + parameter-unpacking, + unpacking-in-except, + old-raise-syntax, + backtick, + long-suffix, + old-ne-operator, + old-octal-literal, + import-star-module-level, + non-ascii-bytes-literal, + raw-checker-failed, + bad-inline-option, + locally-disabled, + locally-enabled, + file-ignored, + suppressed-message, + useless-suppression, + deprecated-pragma, + apply-builtin, + basestring-builtin, + buffer-builtin, + cmp-builtin, + coerce-builtin, + execfile-builtin, + file-builtin, + long-builtin, + raw_input-builtin, + reduce-builtin, + standarderror-builtin, + unicode-builtin, + xrange-builtin, + coerce-method, + delslice-method, + getslice-method, + setslice-method, + no-absolute-import, + old-division, + dict-iter-method, + dict-view-method, + next-method-called, + metaclass-assignment, + indexing-exception, + raising-string, + reload-builtin, + oct-method, + hex-method, + nonzero-method, + cmp-method, + input-builtin, + round-builtin, + intern-builtin, + unichr-builtin, + map-builtin-not-iterating, + zip-builtin-not-iterating, + range-builtin-not-iterating, + filter-builtin-not-iterating, + using-cmp-argument, + eq-without-hash, + div-method, + idiv-method, + rdiv-method, + exception-message-attribute, + invalid-str-codec, + sys-max-int, + bad-python3-import, + deprecated-string-function, + deprecated-str-translate-call, + deprecated-itertools-function, + deprecated-types-field, + next-method-defined, + dict-items-not-iterating, + dict-keys-not-iterating, + dict-values-not-iterating + +# Enable the message, report, category or checker with the given id(s). You can +# either give multiple identifier separated by comma (,) or put this option +# multiple time (only on the command line, not in the configuration file where +# it should appear only once). See also the "--disable" option for examples. +enable=c-extension-no-member + + +[REPORTS] + +# Python expression which should return a note less than 10 (10 is the highest +# note). You have access to the variables errors warning, statement which +# respectively contain the number of errors / warnings messages and the total +# number of statements analyzed. This is used by the global evaluation report +# (RP0004). +evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10) + +# Template used to display messages. This is a python new-style format string +# used to format the message information. See doc for all details +#msg-template= + +# Set the output format. Available formats are text, parseable, colorized, json +# and msvs (visual studio).You can also give a reporter class, eg +# mypackage.mymodule.MyReporterClass. +output-format=text + +# Tells whether to display a full report or only the messages +reports=no + +# Activate the evaluation score. +score=yes + + +[REFACTORING] + +# Maximum number of nested blocks for function / method body +max-nested-blocks=5 + +# Complete name of functions that never returns. When checking for +# inconsistent-return-statements if a never returning function is called then +# it will be considered as an explicit return statement and no message will be +# printed. +never-returning-functions=optparse.Values,sys.exit + + +[VARIABLES] + +# List of additional names supposed to be defined in builtins. Remember that +# you should avoid to define new builtins when possible. +additional-builtins= + +# Tells whether unused global variables should be treated as a violation. +allow-global-unused-variables=yes + +# List of strings which can identify a callback function by name. A callback +# name must start or end with one of those strings. +callbacks=cb_, + _cb + +# A regular expression matching the name of dummy variables (i.e. expectedly +# not used). +dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_ + +# Argument names that match this expression will be ignored. Default to name +# with leading underscore +ignored-argument-names=_.*|^ignored_|^unused_ + +# Tells whether we should check for unused import in __init__ files. +init-import=no + +# List of qualified module names which can have objects that can redefine +# builtins. +redefining-builtins-modules=six.moves,past.builtins,future.builtins + + +[LOGGING] + +# Logging modules to check that the string format arguments are in logging +# function parameter format +logging-modules=logging + + +[TYPECHECK] + +# List of decorators that produce context managers, such as +# contextlib.contextmanager. Add to this list to register other decorators that +# produce valid context managers. +contextmanager-decorators=contextlib.contextmanager + +# List of members which are set dynamically and missed by pylint inference +# system, and so shouldn't trigger E1101 when accessed. Python regular +# expressions are accepted. +generated-members= + +# Tells whether missing members accessed in mixin class should be ignored. A +# mixin class is detected if its name ends with "mixin" (case insensitive). +ignore-mixin-members=yes + +# This flag controls whether pylint should warn about no-member and similar +# checks whenever an opaque object is returned when inferring. The inference +# can return multiple potential results while evaluating a Python object, but +# some branches might not be evaluated, which results in partial inference. In +# that case, it might be useful to still emit no-member and other checks for +# the rest of the inferred objects. +ignore-on-opaque-inference=yes + +# List of class names for which member attributes should not be checked (useful +# for classes with dynamically set attributes). This supports the use of +# qualified names. +ignored-classes=optparse.Values,thread._local,_thread._local + +# List of module names for which member attributes should not be checked +# (useful for modules/projects where namespaces are manipulated during runtime +# and thus existing member attributes cannot be deduced by static analysis. It +# supports qualified module names, as well as Unix pattern matching. +ignored-modules= + +# Show a hint with possible names when a member name was not found. The aspect +# of finding the hint is based on edit distance. +missing-member-hint=yes + +# The minimum edit distance a name should have in order to be considered a +# similar match for a missing member name. +missing-member-hint-distance=1 + +# The total number of similar names that should be taken in consideration when +# showing a hint for a missing member. +missing-member-max-choices=1 + + +[MISCELLANEOUS] + +# List of note tags to take in consideration, separated by a comma. +notes=FIXME, + XXX, + TODO + + +[BASIC] + +# Naming style matching correct argument names +argument-naming-style=snake_case + +# Regular expression matching correct argument names. Overrides argument- +# naming-style +#argument-rgx= + +# Naming style matching correct attribute names +attr-naming-style=snake_case + +# Regular expression matching correct attribute names. Overrides attr-naming- +# style +#attr-rgx= + +# Bad variable names which should always be refused, separated by a comma +bad-names=foo, + bar, + baz, + toto, + tutu, + tata + +# Naming style matching correct class attribute names +class-attribute-naming-style=any + +# Regular expression matching correct class attribute names. Overrides class- +# attribute-naming-style +#class-attribute-rgx= + +# Naming style matching correct class names +class-naming-style=PascalCase + +# Regular expression matching correct class names. Overrides class-naming-style +#class-rgx= + +# Naming style matching correct constant names +const-naming-style=UPPER_CASE + +# Regular expression matching correct constant names. Overrides const-naming- +# style +#const-rgx= + +# Minimum line length for functions/classes that require docstrings, shorter +# ones are exempt. +docstring-min-length=-1 + +# Naming style matching correct function names +function-naming-style=snake_case + +# Regular expression matching correct function names. Overrides function- +# naming-style +#function-rgx= + +# Good variable names which should always be accepted, separated by a comma +good-names=i, + j, + k, + ex, + Run, + _ + +# Include a hint for the correct naming format with invalid-name +include-naming-hint=no + +# Naming style matching correct inline iteration names +inlinevar-naming-style=any + +# Regular expression matching correct inline iteration names. Overrides +# inlinevar-naming-style +#inlinevar-rgx= + +# Naming style matching correct method names +method-naming-style=snake_case + +# Regular expression matching correct method names. Overrides method-naming- +# style +#method-rgx= + +# Naming style matching correct module names +module-naming-style=snake_case + +# Regular expression matching correct module names. Overrides module-naming- +# style +#module-rgx= + +# Colon-delimited sets of names that determine each other's naming style when +# the name regexes allow several styles. +name-group= + +# Regular expression which should only match function or class names that do +# not require a docstring. +no-docstring-rgx=^_ + +# List of decorators that produce properties, such as abc.abstractproperty. Add +# to this list to register other decorators that produce valid properties. +property-classes=abc.abstractproperty + +# Naming style matching correct variable names +variable-naming-style=snake_case + +# Regular expression matching correct variable names. Overrides variable- +# naming-style +#variable-rgx= + + +[SPELLING] + +# Limits count of emitted suggestions for spelling mistakes +max-spelling-suggestions=4 + +# Spelling dictionary name. Available dictionaries: none. To make it working +# install python-enchant package. +spelling-dict= + +# List of comma separated words that should not be checked. +spelling-ignore-words= + +# A path to a file that contains private dictionary; one word per line. +spelling-private-dict-file= + +# Tells whether to store unknown words to indicated private dictionary in +# --spelling-private-dict-file option instead of raising a message. +spelling-store-unknown-words=no + + +[FORMAT] + +# Expected format of line ending, e.g. empty (any line ending), LF or CRLF. +expected-line-ending-format= + +# Regexp for a line that is allowed to be longer than the limit. +ignore-long-lines=^\s*(# )??$ + +# Number of spaces of indent required inside a hanging or continued line. +indent-after-paren=4 + +# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 +# tab). +indent-string=' ' + +# Maximum number of characters on a single line. +max-line-length=100 + +# Maximum number of lines in a module +max-module-lines=1000 + +# List of optional constructs for which whitespace checking is disabled. `dict- +# separator` is used to allow tabulation in dicts, etc.: {1 : 1,\n222: 2}. +# `trailing-comma` allows a space between comma and closing bracket: (a, ). +# `empty-line` allows space-only lines. +no-space-check=trailing-comma, + dict-separator + +# Allow the body of a class to be on the same line as the declaration if body +# contains single statement. +single-line-class-stmt=no + +# Allow the body of an if to be on the same line as the test if there is no +# else. +single-line-if-stmt=no + + +[SIMILARITIES] + +# Ignore comments when computing similarities. +ignore-comments=yes + +# Ignore docstrings when computing similarities. +ignore-docstrings=yes + +# Ignore imports when computing similarities. +ignore-imports=no + +# Minimum lines number of a similarity. +min-similarity-lines=4 + + +[DESIGN] + +# Maximum number of arguments for function / method +max-args=5 + +# Maximum number of attributes for a class (see R0902). +max-attributes=7 + +# Maximum number of boolean expressions in a if statement +max-bool-expr=5 + +# Maximum number of branch for function / method body +max-branches=12 + +# Maximum number of locals for function / method body +max-locals=15 + +# Maximum number of parents for a class (see R0901). +max-parents=7 + +# Maximum number of public methods for a class (see R0904). +max-public-methods=20 + +# Maximum number of return / yield for function / method body +max-returns=6 + +# Maximum number of statements in function / method body +max-statements=50 + +# Minimum number of public methods for a class (see R0903). +min-public-methods=2 + + +[IMPORTS] + +# Allow wildcard imports from modules that define __all__. +allow-wildcard-with-all=no + +# Analyse import fallback blocks. This can be used to support both Python 2 and +# 3 compatible code, which means that the block might have code that exists +# only in one or another interpreter, leading to false positives when analysed. +analyse-fallback-blocks=no + +# Deprecated modules which should not be used, separated by a comma +deprecated-modules=regsub, + TERMIOS, + Bastion, + rexec + +# Create a graph of external dependencies in the given file (report RP0402 must +# not be disabled) +ext-import-graph= + +# Create a graph of every (i.e. internal and external) dependencies in the +# given file (report RP0402 must not be disabled) +import-graph= + +# Create a graph of internal dependencies in the given file (report RP0402 must +# not be disabled) +int-import-graph= + +# Force import order to recognize a module as part of the standard +# compatibility libraries. +known-standard-library= + +# Force import order to recognize a module as part of a third party library. +known-third-party=enchant + + +[CLASSES] + +# List of method names used to declare (i.e. assign) instance attributes. +defining-attr-methods=__init__, + __new__, + setUp + +# List of member names, which should be excluded from the protected access +# warning. +exclude-protected=_asdict, + _fields, + _replace, + _source, + _make + +# List of valid names for the first argument in a class method. +valid-classmethod-first-arg=cls + +# List of valid names for the first argument in a metaclass class method. +valid-metaclass-classmethod-first-arg=mcs + + +[EXCEPTIONS] + +# Exceptions that will emit a warning when being caught. Defaults to +# "Exception" +overgeneral-exceptions=Exception diff --git a/.automation/scripting-linter.sh b/.automation/scripting-linter.sh new file mode 100644 index 00000000..4f0b50cc --- /dev/null +++ b/.automation/scripting-linter.sh @@ -0,0 +1,504 @@ +#!/bin/bash + +################################################################################ +################## Scripting Language Linter @admiralawkbar #################### +################################################################################ + +########### +# GLOBALS # +########### +PYTHON_LINTER_FILE=".automation/pylintrc" # Name of the Linter file +RUBY_LINTER_FILE=".automation/.rubocop.yml" # Name of the Linter file + +############ +# Counters # +############ +ERRORS_FOUND_BASH=0 # Count of errors found +ERRORS_FOUND_PERL=0 # Count of errors found +ERRORS_FOUND_RUBY=0 # Count of errors found +ERRORS_FOUND_PYTHON=0 # Count of errors found + +################################################################################ +########################## FUNCTIONS BELOW ##################################### +################################################################################ +################################################################################ +#### Function Header ########################################################### +Header() +{ + echo "" + echo "-----------------------------------" + echo "---- Scripting Language Linter ----" + echo "-----------------------------------" + echo "" +} +################################################################################ +#### Function LintBashFiles #################################################### +LintBashFiles() +{ + ################ + # print header # + ################ + echo "" + echo "--------------------------------" + echo "Linting Bash files..." + echo "--------------------------------" + echo "" + + ###################### + # Name of the linter # + ###################### + LINTER_NAME="shellcheck" + + ######################################### + # Validate we have shellcheck installed # + ######################################### + # shellcheck disable=SC2230 + VALIDATE_INSTALL_CMD=$(which "$LINTER_NAME" 2>&1) + + ####################### + # Load the error code # + ####################### + ERROR_CODE=$? + + ############################## + # Check the shell for errors # + ############################## + if [ $ERROR_CODE -ne 0 ]; then + # Failed + echo "ERROR! Failed to find $LINTER_NAME in system!" + echo "ERROR:[$VALIDATE_INSTALL_CMD]" + exit 1 + else + # Success + echo "Successfully found binary in system" + echo "Location:[$VALIDATE_INSTALL_CMD]" + fi + + ################################# + # Get list of all files to lint # + ################################# + # shellcheck disable=SC2207 + LIST_FILES=($(find . -type f -name "*.sh" 2>&1)) + + ################## + # Lint the files # + ################## + for FILE in "${LIST_FILES[@]}" + do + + ####################################### + # Make sure we dont lint node modules # + ####################################### + # if [[ $FILE == *"node_modules"* ]]; then + # # This is a node modules file + # continue + # fi + + #################### + # Get the filename # + #################### + FILE_NAME=$(basename "$FILE" 2>&1) + + ############## + # File print # + ############## + echo "---------------------------" + echo "File:[$FILE]" + + ################################ + # Lint the file with the rules # + ################################ + LINT_CMD=$("$LINTER_NAME" "$FILE" 2>&1) + + ####################### + # Load the error code # + ####################### + ERROR_CODE=$? + + ############################## + # Check the shell for errors # + ############################## + if [ $ERROR_CODE -ne 0 ]; then + ######### + # Error # + ######### + echo "ERROR! Found errors in [$LINTER_NAME] linter!" + echo "ERROR:[$LINT_CMD]" + # Increment error count + ((ERRORS_FOUND_BASH++)) + else + ########### + # Success # + ########### + echo " - File:[$FILE_NAME] was linted with [$LINTER_NAME] successfully" + fi + done +} +################################################################################ +#### Function LintPythonFiles ################################################## +LintPythonFiles() +{ + ################ + # print header # + ################ + echo "" + echo "--------------------------------" + echo "Linting Python files..." + echo "--------------------------------" + echo "" + + ###################### + # Name of the linter # + ###################### + LINTER_NAME="pylint" + + ##################################### + # Validate we have pylint installed # + ##################################### + # shellcheck disable=SC2230 + VALIDATE_INSTALL_CMD=$(which "$LINTER_NAME" 2>&1) + + ####################### + # Load the error code # + ####################### + ERROR_CODE=$? + + ############################## + # Check the shell for errors # + ############################## + if [ $ERROR_CODE -ne 0 ]; then + # Failed + echo "ERROR! Failed to find $LINTER_NAME in system!" + echo "ERROR:[$VALIDATE_INSTALL_CMD]" + exit 1 + else + # Success + echo "Successfully found binary in system" + echo "Location:[$VALIDATE_INSTALL_CMD]" + fi + + ################################# + # Get list of all files to lint # + ################################# + # shellcheck disable=SC2207 + LIST_FILES=($(find . -type f -name "*.py" 2>&1)) + + ################## + # Lint the files # + ################## + for FILE in "${LIST_FILES[@]}" + do + + ####################################### + # Make sure we dont lint node modules # + ####################################### + # if [[ $FILE == *"node_modules"* ]]; then + # # This is a node modules file + # continue + # fi + + #################### + # Get the filename # + #################### + FILE_NAME=$(basename "$FILE" 2>&1) + + ############## + # File print # + ############## + echo "---------------------------" + echo "File:[$FILE]" + + ################################ + # Lint the file with the rules # + ################################ + LINT_CMD=$("$LINTER_NAME" --rcfile "$PYTHON_LINTER_FILE" -E "$FILE" 2>&1) + + ####################### + # Load the error code # + ####################### + ERROR_CODE=$? + + ############################## + # Check the shell for errors # + ############################## + if [ $ERROR_CODE -ne 0 ]; then + ######### + # Error # + ######### + echo "ERROR! Found errors in [$LINTER_NAME] linter!" + echo "ERROR:[$LINT_CMD]" + # Increment error count + ((ERRORS_FOUND_PYTHON++)) + else + ########### + # Success # + ########### + echo " - File:[$FILE_NAME] was linted with [$LINTER_NAME] successfully" + fi + done +} +################################################################################ +#### Function LintPerlFiles #################################################### +LintPerlFiles() +{ + ################ + # print header # + ################ + echo "" + echo "--------------------------------" + echo "Linting Perl files..." + echo "--------------------------------" + echo "" + + ###################### + # Name of the linter # + ###################### + LINTER_NAME="perl" + + ################################### + # Validate we have perl installed # + ################################### + # shellcheck disable=SC2230 + VALIDATE_INSTALL_CMD=$(which "$LINTER_NAME" 2>&1) + + ####################### + # Load the error code # + ####################### + ERROR_CODE=$? + + ############################## + # Check the shell for errors # + ############################## + if [ $ERROR_CODE -ne 0 ]; then + # Failed + echo "ERROR! Failed to find $LINTER_NAME in system!" + echo "ERROR:[$VALIDATE_INSTALL_CMD]" + exit 1 + else + # Success + echo "Successfully found binary in system" + echo "Location:[$VALIDATE_INSTALL_CMD]" + fi + + ################################# + # Get list of all files to lint # + ################################# + # shellcheck disable=SC2207 + LIST_FILES=($(find . -type f -name "*.pl" 2>&1)) + + ################## + # Lint the files # + ################## + for FILE in "${LIST_FILES[@]}" + do + + ####################################### + # Make sure we dont lint node modules # + ####################################### + # if [[ $FILE == *"node_modules"* ]]; then + # # This is a node modules file + # continue + # fi + + #################### + # Get the filename # + #################### + FILE_NAME=$(basename "$FILE" 2>&1) + + ############## + # File print # + ############## + echo "---------------------------" + echo "File:[$FILE]" + + ################################ + # Lint the file with the rules # + ################################ + LINT_CMD=$("$LINTER_NAME" -Mstrict -cw "$FILE" 2>&1) + + ####################### + # Load the error code # + ####################### + ERROR_CODE=$? + + ############################## + # Check the shell for errors # + ############################## + if [ $ERROR_CODE -ne 0 ]; then + ######### + # Error # + ######### + echo "ERROR! Found errors in [$LINTER_NAME] linter!" + echo "ERROR:[$LINT_CMD]" + # Increment error count + ((ERRORS_FOUND_PERL++)) + else + ########### + # Success # + ########### + echo " - File:[$FILE_NAME] was linted with [$LINTER_NAME] successfully" + fi + done +} +################################################################################ +#### Function LintRubyFiles #################################################### +LintRubyFiles() +{ + ################ + # print header # + ################ + echo "" + echo "--------------------------------" + echo "Linting Ruby files..." + echo "--------------------------------" + echo "" + + ###################### + # Name of the linter # + ###################### + LINTER_NAME="rubocop" + + ################################### + # Validate we have perl installed # + ################################### + # shellcheck disable=SC2230 + VALIDATE_INSTALL_CMD=$(which "$LINTER_NAME" 2>&1) + + ####################### + # Load the error code # + ####################### + ERROR_CODE=$? + + ############################## + # Check the shell for errors # + ############################## + if [ $ERROR_CODE -ne 0 ]; then + # Failed + echo "ERROR! Failed to find $LINTER_NAME in system!" + echo "ERROR:[$VALIDATE_INSTALL_CMD]" + exit 1 + else + # Success + echo "Successfully found binary in system" + echo "Location:[$VALIDATE_INSTALL_CMD]" + fi + + ################################# + # Get list of all files to lint # + ################################# + # shellcheck disable=SC2207 + LIST_FILES=($(find . -type f -name "*.rb" 2>&1)) + + ################## + # Lint the files # + ################## + for FILE in "${LIST_FILES[@]}" + do + + ####################################### + # Make sure we dont lint node modules # + ####################################### + # if [[ $FILE == *"node_modules"* ]]; then + # # This is a node modules file + # continue + # fi + + #################### + # Get the filename # + #################### + FILE_NAME=$(basename "$FILE" 2>&1) + + ############## + # File print # + ############## + echo "---------------------------" + echo "File:[$FILE]" + + ################################ + # Lint the file with the rules # + ################################ + LINT_CMD=$("$LINTER_NAME" -c "$RUBY_LINTER_FILE" "$FILE" 2>&1) + + ####################### + # Load the error code # + ####################### + ERROR_CODE=$? + + ############################## + # Check the shell for errors # + ############################## + if [ $ERROR_CODE -ne 0 ]; then + ######### + # Error # + ######### + echo "ERROR! Found errors in [$LINTER_NAME] linter!" + echo "ERROR:[$LINT_CMD]" + # Increment error count + ((ERRORS_FOUND_RUBY++)) + else + ########### + # Success # + ########### + echo " - File:[$FILE_NAME] was linted with [$LINTER_NAME] successfully" + fi + done +} +################################################################################ +#### Function Footer ########################################################### +Footer() +{ + echo "" + echo "---------------------------" + echo "The script has completed" + echo "---------------------------" + echo "ERRORS FOUND in BASH:[$ERRORS_FOUND_BASH]" + echo "ERRORS FOUND in PERL:[$ERRORS_FOUND_PERL]" + echo "ERRORS FOUND in PYTHON:[$ERRORS_FOUND_PYTHON]" + echo "ERRORS FOUND in RUBY:[$ERRORS_FOUND_RUBY]" + echo "" + + ############################### + # Exit with 1 if errors found # + ############################### + if [ $ERRORS_FOUND_BASH -ne 0 ] || [ $ERRORS_FOUND_PERL -ne 0 ] || [ $ERRORS_FOUND_PYTHON -ne 0 ] || [ $ERRORS_FOUND_RUBY -ne 0 ]; then + # Failed exit + echo "Exiting with errors found!" + exit 1 + else + # Successful exit + exit 0 + fi +} +################################################################################ +############################### MAIN ########################################### +################################################################################ + +########## +# Header # +########## +Header + +####################### +# Lint the bash files # +####################### +LintBashFiles + +######################### +# Lint the python files # +######################### +LintPythonFiles + +####################### +# Lint the perl files # +####################### +LintPerlFiles + +####################### +# Lint the ruby files # +####################### +LintRubyFiles + +########## +# Footer # +########## +Footer diff --git a/.automation/yaml-linter-rules.yml b/.automation/yaml-linter-rules.yml new file mode 100644 index 00000000..faccea80 --- /dev/null +++ b/.automation/yaml-linter-rules.yml @@ -0,0 +1,59 @@ +--- +########################################### +# These are the rules used for # +# linting all the yaml files in the stack # +# NOTE: # +# You can disble line with: # +# # yamllint disable-line # +########################################### +rules: + braces: + level: warning + min-spaces-inside: 0 + max-spaces-inside: 0 + min-spaces-inside-empty: 1 + max-spaces-inside-empty: 5 + brackets: + level: warning + min-spaces-inside: 0 + max-spaces-inside: 0 + min-spaces-inside-empty: 1 + max-spaces-inside-empty: 5 + colons: + level: warning + max-spaces-before: 0 + max-spaces-after: 1 + commas: + level: warning + max-spaces-before: 0 + min-spaces-after: 1 + max-spaces-after: 1 + comments: disable + comments-indentation: disable + document-end: disable + document-start: + level: warning + present: true + empty-lines: + level: warning + max: 2 + max-start: 0 + max-end: 0 + hyphens: + level: warning + max-spaces-after: 1 + indentation: + level: warning + spaces: consistent + indent-sequences: true + check-multi-line-strings: false + key-duplicates: enable + line-length: + level: warning + max: 80 + allow-non-breakable-words: true + allow-non-breakable-inline-mappings: true + new-line-at-end-of-file: disable + new-lines: + type: unix + trailing-spaces: disable diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 00000000..1f687ccc --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1,7 @@ +###################################################################### +# These owners will be the default owners for everything in the repo # +###################################################################### +* @github/services-devops-engineers +* @github/services-implementation-engineers +* @github/services-solution-architects +* @github/data-portability diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 00000000..e5f0de9a --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,39 @@ +# Contributing +:wave: Hi there! +We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great. + +## Submitting a pull request +[Pull Requests][pulls] are used for adding new playbooks, roles, and documents to the repository, or editing the existing ones. + +**With write access** +1. Clone the repository (only if you do not have write access) +1. Create a new branch: `git checkout -b my-branch-name` +1. Make your change +1. Push and [submit a pull request][pr] +1. Pat yourself on the back and wait for your pull request to be reviewed and merged. + +**Without write access** +1. [Fork][fork] and clone the repository +1. Create a new branch: `git checkout -b my-branch-name` +1. Make your change +1. Push to your fork and [submit a pull request][pr] +1. Pat your self on the back and wait for your pull request to be reviewed and merged. + +Here are a few things you can do that will increase the likelihood of your pull request being accepted: + +- Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests. +- Write [good commit messages](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html). + +Work in Progress pull requests are also welcome to get feedback early on, or if there is something blocking you. + +- Create a branch with a name that identifies the user and nature of the changes (similar to `user/branch-purpose`) +- Open a pull request and request a review from a member of the appropriate `@github/services-account-engineering` and/or `@github/services-engineering` teams + +## Resources +- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/) +- [Using Pull Requests](https://help.github.com/articles/about-pull-requests/) +- [GitHub Help](https://help.github.com) + +[pulls]: https://github.com/github/github-demo-stack/pulls +[pr]: https://github.com/github/github-demo-stack/compare +[fork]: https://github.com/github/github-demo-stack/fork diff --git a/.github/workflows/stack-linter.yml b/.github/workflows/stack-linter.yml new file mode 100644 index 00000000..0cc350c3 --- /dev/null +++ b/.github/workflows/stack-linter.yml @@ -0,0 +1,73 @@ +--- +############################# +############################# +## CI/CT/CD GitHub Actions ## +############################# +############################# +name: Source Linter + +# +# Documentation: +# https://help.github.com/en/articles/workflow-syntax-for-github-actions +# + +############################# +# Start the job on all push # +############################# +on: ['push'] + +############### +# Set the Job # +############### +jobs: + build: + # Name the Job + name: Source linter + # Set the agent to run on + runs-on: ubuntu-latest + ################## + # Load all steps # + ################## + steps: + ########################## + # Checkout the code base # + ########################## + - name: Checkout Code + uses: actions/checkout@master + + ##################### + # Install Ruby Libs # + ##################### + - name: Set up Ruby + uses: actions/setup-ruby@master + with: + ruby-version: 2.6.x + + #################### + # Install NPM Libs # + #################### + - name: Setup NPM + uses: actions/setup-node@master + with: + node-version: 10.x + + ################################# + # Install all base dependancies # + ################################# + - name: Install Dependencies + shell: bash + run: ./.automation/install-deps.sh + + ############################################# + # Run the markup and markdown linter script # + ############################################# + - name: Run Markup and Markdown Linter + shell: bash + run: ./.automation/markup-markdown-linter.sh + + ################################### + # Run the scripting linter script # + ################################### + - name: Run Scripting Linter + shell: bash + run: ./.automation/scripting-linter.sh diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..ad46b308 --- /dev/null +++ b/.gitignore @@ -0,0 +1,61 @@ +# Logs +logs +*.log +npm-debug.log* +yarn-debug.log* +yarn-error.log* + +# Runtime data +pids +*.pid +*.seed +*.pid.lock + +# Directory for instrumented libs generated by jscoverage/JSCover +lib-cov + +# Coverage directory used by tools like istanbul +coverage + +# nyc test coverage +.nyc_output + +# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) +.grunt + +# Bower dependency directory (https://bower.io/) +bower_components + +# node-waf configuration +.lock-wscript + +# Compiled binary addons (https://nodejs.org/api/addons.html) +build/Release + +# Dependency directories +node_modules/ +jspm_packages/ + +# TypeScript v1 declaration files +typings/ + +# Optional npm cache directory +.npm + +# Optional eslint cache +.eslintcache + +# Optional REPL history +.node_repl_history + +# Output of 'npm pack' +*.tgz + +# Yarn Integrity file +.yarn-integrity + +# dotenv environment variables file +.env + +# next.js build output +.next diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 00000000..548a1532 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,51 @@ +########################################### +########################################### +## Dockerfile to run GitHub Super-Linter ## +########################################### +########################################### + +################## +# Get base image # +################## +FROM python:alpine + +######################################### +# Label the instance and set maintainer # +######################################### +LABEL com.github.actions.name="GitHub Super-Linter" \ + com.github.actions.description="Lint your codebase with Github Actions" \ + com.github.actions.icon="code" \ + com.github.actions.color="red" \ + maintainer="GitHub DevOps " + +################## +# Run the Update # +################## +RUN apk add --no-cache \ + bash git musl-dev jq \ + npm nodejs bash git musl-dev jq gcc curl + +RUN pip install --upgrade --no-cache-dir \ + awscli aws-sam-cli yq + +#################################### +# Setup AWS CLI Command Completion # +#################################### +RUN echo complete -C '/usr/local/bin/aws_completer' aws >> ~/.bashrc + +########################################### +# Load GitHub Env Vars for Github Actions # +########################################### +ENV GITHUB_SHA=${GITHUB_SHA} +ENV GITHUB_EVENT_PATH=${GITHUB_EVENT_PATH} +ENV GITHUB_WORKSPACE=${GITHUB_WORKSPACE} + +########################### +# Copy files to container # +########################### +COPY lib /action/lib + +###################### +# Set the entrypoint # +###################### +ENTRYPOINT ["/action/lib/entrypoint.sh"] diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..f288702d --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md new file mode 100644 index 00000000..6eda95b5 --- /dev/null +++ b/README.md @@ -0,0 +1,87 @@ +# Super-Linter + +This repository is for the **GitHub** Action to run a **Super-Linter**. +Developers on **GitHub** can call this Action to lint their code base with the following list of linters: + +- Ruby (Rubocop) +- Shell (Shellcheck) +- Ansible (Ansible-lint) +- YAML (Yamllint) +- Python3 (Pylint) +- JSON (JsonLint) +- MarkDown (Markdownlint) +- XML (LibXML) + +## How to use + +To use this **GitHub** Action you will need to complete the following: +- Copy **any** or **all** template rules files `TEMPLATES/` to your repository in the location: `.github/` + - If your repository does not have rules files, they will fall back to defaults +- Validate all variables are correct and allow for proper permissions on **AWS** +- Add the **Github** Action: **Super-Linter** to your current **Github** Actions workflow +- Enjoy your more stable, and cleaner code base + +### Example GitHub Action Workflow + +In your repository you should have a `workflows` folder similar to below: + +- `.github/workflows/linter.yml` + +This file should have the following code: + +```yml +--- +########################### +########################### +## Linter GitHub Actions ## +########################### +########################### +name: Lint Code Base + +# +# Documentation: +# https://help.github.com/en/articles/workflow-syntax-for-github-actions +# + +############################# +# Start the job on all push # +############################# +on: ['push'] + +############### +# Set the Job # +############### +jobs: + build: + # Name the Job + name: Lint Code Base + # Set the agent to run on + runs-on: ubuntu-latest + + ################## + # Load all steps # + ################## + steps: + ########################## + # Checkout the code base # + ########################## + - name: Checkout Code + uses: actions/checkout@master + + ################################ + # Run Linter against code base # + ################################ + - name: Lint Code Base + uses: docker://admiralawkbar/super-linter:latest +... +``` + +## How to contribute + +If you would like to help contribute to this **Github** Action, please see [CONTRIBUTING](https://github.com/github-services-engineering/super-linter/blob/master/.github/CONTRIBUTING.md) + +-------------------------------------------------------------------------------- + +### License + +- [License](https://github.com/github-services-engineering/super-linter/blob/master/LICENSE) diff --git a/TEMPLATE/README.md b/TEMPLATE/README.md new file mode 100644 index 00000000..316e55bf --- /dev/null +++ b/TEMPLATE/README.md @@ -0,0 +1,11 @@ +# TEMPLATE/aws-config.yml + +The file in this folder is for the user base to use as a template to consume the **GitHub** Action: +- **Deploy-NodeJS-AWS-SAM** + +The user will need to copy the file to the location: + +- `/github/aws-config.yml` in their repository + +The file will be parsed at run time on the local branch to load all variables needed to deploy their **NodeJS** application to **AWS** Serverless utilizing **AWS SAM**. +The **GitHub** Action will inform the user via the **Checks API** on the status and success of the deployment process. diff --git a/TEMPLATE/aws-config.yml b/TEMPLATE/aws-config.yml new file mode 100644 index 00000000..6028e2c5 --- /dev/null +++ b/TEMPLATE/aws-config.yml @@ -0,0 +1,43 @@ +--- + +########################################################## +# AWS Configuration file for NodeJS Deploy GitHub Action # +# # +# NOTE: This file holds the variables needed # +# to configure the GitHub Deploy NodeJS # +# on AWS Serverless # +# # +# This file needs to be in the location: # +# - .github/aws-config.yml # +# in your repository to be parsed at run time # +########################################################## + +######################################## +# AWS S3 Bucket for package and deploy # +######################################## +# NOTE: This bucket must exist before the GitHub Action +s3_bucket: + +################################## +# AWS Cloud Formation Stack name # +################################## +# NOTE: Defaults to "mystack" if left empty +aws_stack_name: mystack + +#################### +# AWS SAM Template # +#################### +# NOTE: This is the AWS SAM template.yml file that we need to deploy +# Pathing is from root of repository: +# Example: +# if file is called `template.yml` and is in the root of repository +# under the '.github' folder: +# sam_template: .github/template.yml +sam_template: + +################################ +# region for connection to AWS # +################################ +# Default region is: us-west-2 +# if not provided below +region: us-west-2 diff --git a/lib/entrypoint.sh b/lib/entrypoint.sh new file mode 100644 index 00000000..ffabfe5f --- /dev/null +++ b/lib/entrypoint.sh @@ -0,0 +1,1099 @@ +#!/bin/bash + +################################################################################ +################################################################################ +############# EntryPoint for Docker NodeJS Deploy Serverless ################### +################################################################################ +################################################################################ + +######### +# NOTE: # +######### +# - https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-deploying.html +# - https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html#cli-configure-files-where +# - https://developer.github.com/v3/checks/runs/ + +########### +# Globals # +########### +AWS_REGION='' # AWS region to deploy +S3_BUCKET='' # AWS S3 bucket to package and deploy +AWS_SAM_TEMPLATE='' # Path to the SAM template in the user repository +CHECK_NAME='GitHub AWS Deploy Serverless' # Name of the GitHub Action +CHECK_ID='' # GitHub Check ID that is created +AWS_STACK_NAME='' # AWS Cloud Formation Stack name of SAM +SAM_CMD='sam' # Path to AWS SAM Exec +RUNTIME='' # Runtime for AWS SAM App + +################### +# GitHub ENV Vars # +################### +GITHUB_SHA="${GITHUB_SHA}" # GitHub sha from the commit +GITHUB_EVENT_PATH="${GITHUB_EVENT_PATH}" # Github Event Path +GITHUB_TOKEN='' # GitHub token +GITHUB_WORKSPACE="${GITHUB_WORKSPACE}" # Github Workspace +GITHUB_URL='https://api.github.com' # GitHub API URL + +################### +# AWS Secret Vars # +################### +# shellcheck disable=SC2034 +AWS_ACCESS_KEY_ID="${AWS_ACCESS_KEY}" # aws_access_key_id to auth +# shellcheck disable=SC2034 +AWS_SECRET_ACCESS_KEY="${AWS_SECRET_KEY}" # aws_secret_access_key to auth + +############## +# Built Vars # +############## +GITHUB_ORG='' # Name of the GitHub Org +GITHUB_REPO='' # Name of the GitHub repo +USER_CONFIG_FILE="$GITHUB_WORKSPACE/.github/aws-config.yml" # File with users configurations +START_DATE=$(date +"%Y-%m-%dT%H:%M:%SZ") # YYYY-MM-DDTHH:MM:SSZ +FINISHED_DATE='' # YYYY-MM-DDTHH:MM:SSZ when complete +ACTION_CONCLUSTION='' # success, failure, neutral, cancelled, timed_out, or action_required. +ACTION_OUTPUT='' # String to pass back to the user on the output +ERROR_FOUND=0 # Set to 1 if any errors occur in the build before the package and deploy +ERROR_CAUSE='' # String to pass of error that was detected + +################ +# Default Vars # +################ +DEFAULT_OUTPUT='json' # Default Output format +DEFAULT_REGION='us-west-2' # Default region to deploy +LOCAL_CONFIG_FILE='/root/.aws/config' # AWS Config file +AWS_PACKAGED='packaged.yml' # Created SAM Package +DEBUG=0 # Debug=0 OFF | Debug=1 ON +#NVM_SRC='/usr/local/nvm/nvm.sh' # Source for NVM + + +###################################################### +# Variables we need to set in the ~/.aws/credentials # +# aws_access_key_id # +# aws_secret_access_key # +###################################################### + +################################################# +# Variables we need to set in the ~/.aws/config # +# region # +# output # +################################################# + +################################################################################ +######################### SUB ROUTINES BELOW ################################### +################################################################################ +################################################################################ +#### Function ValidateConfigurationFile ######################################## +ValidateConfigurationFile() +{ + ########## + # Prints # + ########## + echo "--------------------------------------------" + echo "Validating input file..." + + #################################################################### + # Validate the config file is in the repository and pull variables # + #################################################################### + if [ ! -f "$USER_CONFIG_FILE" ]; then + # User file not found + echo "ERROR! Failed to find configuration file in user repository!" + ################################################### + # Set the ERROR_FOUND flag to 1 to drop out build # + ################################################### + ERROR_FOUND=1 + ERROR_CAUSE='Failed to find configuration file in user repository!' + else + echo "Success! Found User config file at:[$USER_CONFIG_FILE]" + fi + + ######################################## + # Map the variables to local variables # + ######################################## + + ####################### + ####################### + ## Get the s3_bucket ## + ####################### + ####################### + S3_BUCKET=$(yq -r .s3_bucket "$USER_CONFIG_FILE") + + ####################### + # Load the error code # + ####################### + ERROR_CODE=$? + + ############################## + # Check the shell for errors # + ############################## + if [ $ERROR_CODE -ne 0 ] || [ "$S3_BUCKET" == "null" ]; then + echo "ERROR! Failed to get [s3_bucket]!" + echo "ERROR:[$S3_BUCKET]" + ################################################### + # Set the ERROR_FOUND flag to 1 to drop out build # + ################################################### + ERROR_FOUND=1 + ERROR_CAUSE='Failed to get [s3_bucket]!' + else + echo "Successfully found:[s3_bucket]" + fi + + ############################################ + # Clean any whitespace that may be entered # + ############################################ + S3_BUCKET_NO_WHITESPACE="$(echo "${S3_BUCKET}" | tr -d '[:space:]')" + S3_BUCKET=$S3_BUCKET_NO_WHITESPACE + + ############################ + ############################ + ## Get the AWS Stack Name ## + ############################ + ############################ + AWS_STACK_NAME=$(yq -r .aws_stack_name "$USER_CONFIG_FILE") + + ####################### + # Load the error code # + ####################### + ERROR_CODE=$? + + ############################## + # Check the shell for errors # + ############################## + if [ $ERROR_CODE -ne 0 ] || [ "$AWS_STACK_NAME" == "null" ]; then + echo "ERROR! Failed to get [aws_stack_name]!" + echo "ERROR:[$AWS_STACK_NAME]" + ################################################### + # Set the ERROR_FOUND flag to 1 to drop out build # + ################################################### + ERROR_FOUND=1 + ERROR_CAUSE='Failed to get [aws_stack_name]!' + else + echo "Successfully found:[aws_stack_name]" + fi + + ############################################ + # Clean any whitespace that may be entered # + ############################################ + AWS_STACK_NAME_NO_WHITESPACE="$(echo "${AWS_STACK_NAME}" | tr -d '[:space:]')" + AWS_STACK_NAME=$AWS_STACK_NAME_NO_WHITESPACE + + ############################## + ############################## + ## Get the AWS SAM Template ## + ############################## + ############################## + AWS_SAM_TEMPLATE=$(yq -r .sam_template "$USER_CONFIG_FILE") + + ####################### + # Load the error code # + ####################### + ERROR_CODE=$? + + ############################## + # Check the shell for errors # + ############################## + if [ $ERROR_CODE -ne 0 ] || [ "$AWS_SAM_TEMPLATE" == "null" ]; then + echo "ERROR! Failed to get [sam_template]!" + echo "ERROR:[$AWS_SAM_TEMPLATE]" + ################################################### + # Set the ERROR_FOUND flag to 1 to drop out build # + ################################################### + ERROR_FOUND=1 + ERROR_CAUSE='Failed to get [sam_template]!' + else + echo "Successfully found:[sam_template]" + fi + + ############################################ + # Clean any whitespace that may be entered # + ############################################ + AWS_SAM_TEMPLATE_NO_WHITESPACE="$(echo "${AWS_SAM_TEMPLATE}" | tr -d '[:space:]')" + AWS_SAM_TEMPLATE=$AWS_SAM_TEMPLATE_NO_WHITESPACE + + #################### + #################### + ## Get the region ## + #################### + #################### + AWS_REGION=$(yq -r .region "$USER_CONFIG_FILE") + + ####################### + # Load the error code # + ####################### + ERROR_CODE=$? + + ############################## + # Check the shell for errors # + ############################## + if [ $ERROR_CODE -ne 0 ] || [ "$AWS_REGION" == "null" ]; then + # Error + echo "ERROR! Failed to get [region]!" + echo "ERROR:[$AWS_REGION]" + # Fall back to default + echo "No value provided... Defaulting to:[$DEFAULT_REGION]" + AWS_REGION="$DEFAULT_REGION" + else + echo "Successfully found:[region]" + fi + + ############################################ + # Clean any whitespace that may be entered # + ############################################ + AWS_REGION_NO_WHITESPACE="$(echo "${AWS_REGION}" | tr -d '[:space:]')" + AWS_REGION=$AWS_REGION_NO_WHITESPACE +} +################################################################################ +#### Function CreateLocalConfiguration ######################################### +CreateLocalConfiguration() +{ + ########## + # Prints # + ########## + echo "--------------------------------------------" + echo "Creating local configuration file..." + + ######################################## + # Create the directory if not existant # + ######################################## + MK_DIR_CMD=$(mkdir /root/.aws) + + ####################### + # Load the error code # + ####################### + ERROR_CODE=$? + + ############################## + # Check the shell for errors # + ############################## + if [ $ERROR_CODE -ne 0 ]; then + echo "ERROR! Failed to create root directory!" + echo "ERROR:[$MK_DIR_CMD]" + ################################################### + # Set the ERROR_FOUND flag to 1 to drop out build # + ################################################### + ERROR_FOUND=1 + ERROR_CAUSE='Failed to create root directory!' + fi + + ####################################### + # Create the local file ~/.aws/config # + ####################################### + CREATE_CONFIG_CMD=$(echo -e "[default]\nregion=$AWS_REGION\noutput=$DEFAULT_OUTPUT" >> $LOCAL_CONFIG_FILE ) + + ####################### + # Load the error code # + ####################### + ERROR_CODE=$? + + ############################## + # Check the shell for errors # + ############################## + if [ $ERROR_CODE -ne 0 ]; then + echo "ERROR! Failed to create file:[$LOCAL_CONFIG_FILE]!" + echo "ERROR:[$CREATE_CONFIG_CMD]" + ################################################### + # Set the ERROR_FOUND flag to 1 to drop out build # + ################################################### + ERROR_FOUND=1 + ERROR_CAUSE="Failed to create file:[$LOCAL_CONFIG_FILE]!" + else + echo "Successfully created:[$LOCAL_CONFIG_FILE]" + fi +} +################################################################################ +#### Function GetGitHubVars #################################################### +GetGitHubVars() +{ + ########## + # Prints # + ########## + echo "--------------------------------------------" + echo "Gathering GitHub information..." + + ############################ + # Validate we have a value # + ############################ + if [ -z "$GITHUB_SHA" ]; then + echo "ERROR! Failed to get [GITHUB_SHA]!" + echo "ERROR:[$GITHUB_SHA]" + ################################################### + # Set the ERROR_FOUND flag to 1 to drop out build # + ################################################### + ERROR_FOUND=1 + ERROR_CAUSE='Failed to get [GITHUB_SHA]!' + else + echo "Successfully found:[GITHUB_SHA]" + fi + + # ############################ + # # Validate we have a value # + # ############################ + # if [ -z "$GITHUB_TOKEN" ]; then + # echo "ERROR! Failed to get [GITHUB_TOKEN]!" + # echo "ERROR:[$GITHUB_TOKEN]" + # ################################################### + # # Set the ERROR_FOUND flag to 1 to drop out build # + # ################################################### + # ERROR_FOUND=1 + # ERROR_CAUSE='Failed to get [GITHUB_TOKEN]!' + # else + # echo "Successfully found:[GITHUB_TOKEN]" + # fi + + ############################ + # Validate we have a value # + ############################ + if [ -z "$GITHUB_WORKSPACE" ]; then + echo "ERROR! Failed to get [GITHUB_WORKSPACE]!" + echo "ERROR:[$GITHUB_WORKSPACE]" + ################################################### + # Set the ERROR_FOUND flag to 1 to drop out build # + ################################################### + ERROR_FOUND=1 + ERROR_CAUSE='Failed to get [GITHUB_WORKSPACE]!' + else + echo "Successfully found:[GITHUB_WORKSPACE]" + fi + + ############################ + # Validate we have a value # + ############################ + if [ -z "$GITHUB_EVENT_PATH" ]; then + echo "ERROR! Failed to get [GITHUB_EVENT_PATH]!" + echo "ERROR:[$GITHUB_EVENT_PATH]" + ################################################### + # Set the ERROR_FOUND flag to 1 to drop out build # + ################################################### + ERROR_FOUND=1 + ERROR_CAUSE='Failed to get [GITHUB_EVENT_PATH]!' + else + echo "Successfully found:[GITHUB_EVENT_PATH]" + fi + + ################################################## + # Need to pull the GitHub Vars from the env file # + ################################################## + + ###################### + # Get the GitHub Org # + ###################### + # shellcheck disable=SC2002 + GITHUB_ORG=$(cat "$GITHUB_EVENT_PATH" | jq -r '.repository.owner.login' ) + + ############################ + # Validate we have a value # + ############################ + if [ -z "$GITHUB_ORG" ]; then + echo "ERROR! Failed to get [GITHUB_ORG]!" + echo "ERROR:[$GITHUB_ORG]" + ################################################### + # Set the ERROR_FOUND flag to 1 to drop out build # + ################################################### + ERROR_FOUND=1 + ERROR_CAUSE='Failed to get [GITHUB_ORG]!' + else + echo "Successfully found:[GITHUB_ORG]" + fi + + ####################### + # Get the GitHub Repo # + ####################### + # shellcheck disable=SC2002 + GITHUB_REPO=$(cat "$GITHUB_EVENT_PATH"| jq -r '.repository.name' ) + + ############################ + # Validate we have a value # + ############################ + if [ -z "$GITHUB_REPO" ]; then + echo "ERROR! Failed to get [GITHUB_REPO]!" + echo "ERROR:[$GITHUB_REPO]" + ################################################### + # Set the ERROR_FOUND flag to 1 to drop out build # + ################################################### + ERROR_FOUND=1 + ERROR_CAUSE='Failed to get [GITHUB_REPO]!' + else + echo "Successfully found:[GITHUB_REPO]" + fi +} +################################################################################ +#### Function ValidateAWSCLI ################################################### +ValidateAWSCLI() +{ + ########## + # Prints # + ########## + echo "--------------------------------------------" + echo "Validating AWS information..." + + ############################################ + ############################################ + ## Validate we have access to the aws cli ## + ############################################ + ############################################ + VALIDATE_AWS_CMD=$(which aws ) + + ####################### + # Load the error code # + ####################### + ERROR_CODE=$? + + ############################## + # Check the shell for errors # + ############################## + if [ $ERROR_CODE -ne 0 ]; then + # Error failed to find binary + echo "ERROR! Failed to find aws cli!" + echo "ERROR:[$VALIDATE_AWS_CMD]" + ################################################### + # Set the ERROR_FOUND flag to 1 to drop out build # + ################################################### + ERROR_FOUND=1 + ERROR_CAUSE='Failed to find aws cli!' + else + echo "Successfully validated:[aws cli]" + fi + + ############################################ + ############################################ + ## Validate we have access to the aws cli ## + ############################################ + ############################################ + VALIDATE_SAM_CMD=$(which "$SAM_CMD" ) + + ####################### + # Load the error code # + ####################### + ERROR_CODE=$? + + ############################## + # Check the shell for errors # + ############################## + if [ $ERROR_CODE -ne 0 ]; then + # Error failed to find binary + echo "ERROR! Failed to find aws sam cli!" + echo "ERROR:[$VALIDATE_SAM_CMD]" + ################################################### + # Set the ERROR_FOUND flag to 1 to drop out build # + ################################################### + ERROR_FOUND=1 + ERROR_CAUSE='Failed to find aws sam cli!' + else + echo "Successfully validated:[aws sam cli]" + fi + + ####################################### + ####################################### + ## Validate we can see AWS s3 bucket ## + ####################################### + ####################################### + CHECK_BUCKET_CMD=$(aws s3 ls "$S3_BUCKET" ) + + ####################### + # Load the error code # + ####################### + ERROR_CODE=$? + + ############################## + # Check the shell for errors # + ############################## + if [ $ERROR_CODE -ne 0 ]; then + echo "ERROR! Failed to access AWS S3 bucket:[$S3_BUCKET]" + echo "ERROR:[$CHECK_BUCKET_CMD]" + ################################################### + # Set the ERROR_FOUND flag to 1 to drop out build # + ################################################### + ERROR_FOUND=1 + ERROR_CAUSE="Failed to access AWS S3 bucket:[$S3_BUCKET]" + else + echo "Successfully validated:[aws s3 bucket authorization]" + fi +} +################################################################################ +#### Function CreateCheck ###################################################### +CreateCheck() +{ + ########## + # Prints # + ########## + echo "--------------------------------------------" + echo "Creating GitHub Check..." + + ########################################## + # Call to Github to create the Check API # + ########################################## + CREATE_CHECK_CMD=$( curl -k --fail -X POST \ + --url "$GITHUB_URL/repos/$GITHUB_ORG/$GITHUB_REPO/check-runs" \ + -H 'accept: application/vnd.github.antiope-preview+json' \ + -H "authorization: Bearer $GITHUB_TOKEN" \ + -H 'content-type: application/json' \ + --data "{ \"name\": \"$CHECK_NAME\", \"head_sha\": \"$GITHUB_SHA\", \"status\": \"in_progress\", \"started_at\": \"$START_DATE\" }" \ + ) + + ####################### + # Load the error code # + ####################### + ERROR_CODE=$? + + ############################## + # Check the shell for errors # + ############################## + if [ $ERROR_CODE -ne 0 ]; then + echo "ERROR! Failed to create GitHub Check!" + echo "ERROR:[$CREATE_CHECK_CMD]" + exit 1 + else + echo "Successfully Created GitHub Check" + ############################################# + # Need to get the check ID that was created # + ############################################# + CHECK_ID=$(echo "$CREATE_CHECK_CMD"| jq -r '.id' ) + + ############################ + # Validate we have a value # + ############################ + if [ -z "$CHECK_ID" ]; then + echo "ERROR! Failed to get [CHECK_ID]!" + echo "ERROR:[$CHECK_ID]" + exit 1 + fi + fi +} +################################################################################ +#### Function RunDeploy ######################################################## +RunDeploy() +{ + ########## + # Prints # + ########## + echo "--------------------------------------------" + echo "Running AWS Deploy Process..." + + # Need to complete the following actions to deploy to AWS Serverless: + # https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-deploying.html + # - Package SAM template + # - Deploy packaged SAM template + + # Go into loop if no errors detected + if [ $ERROR_FOUND -eq 0 ]; then + ################# + # Build the App # + ################# + BuidApp + fi + + # Go into loop if no errors detected + if [ $ERROR_FOUND -eq 0 ]; then + ######################## + # Package the template # + ######################## + PackageTemplate + fi + + # Go into loop if no errors detected + if [ $ERROR_FOUND -eq 0 ]; then + ####################### + # Deploy the template # + ####################### + DeployTemplate + fi + + # Go into loop if no errors detected + if [ $ERROR_FOUND -eq 0 ]; then + ####################### + # Deploy the template # + ####################### + GetOutput + fi +} +################################################################################ +#### Function BuidApp ########################################################## +BuidApp() +{ + ########## + # Prints # + ########## + echo "--------------------------------------------" + echo "Building the SAM application..." + + ######################### + # Build the application # + ######################### + # shellcheck disable=SC2164 + BUILD_CMD=$(cd "$GITHUB_WORKSPACE" ; "$SAM_CMD" build) + + ####################### + # Load the error code # + ####################### + ERROR_CODE=$? + + ############################## + # Check the shell for errors # + ############################## + if [ $ERROR_CODE -ne 0 ]; then + # Errors found + echo "ERROR! Failed to build SAM application!" + echo "ERROR:[$BUILD_CMD]" + ######################################### + # Need to update the ACTION_CONCLUSTION # + ######################################### + ERROR_FOUND=1 + ERROR_CAUSE="Failed to build SAM application:[$BUILD_CMD]!" + else + echo "Successfully built local AWS SAM Application" + fi +} +################################################################################ +#### Function PackageTemplate ################################################## +PackageTemplate() +{ + ########## + # Prints # + ########## + echo "--------------------------------------------" + echo "Packaging the template..." + + ############################################## + # Check the source code for the SAM template # + ############################################## + if [ ! -f "$GITHUB_WORKSPACE/$AWS_SAM_TEMPLATE" ]; then + echo "ERROR! Failed to find:[$AWS_SAM_TEMPLATE] in root of repository!" + ################################################### + # Set the ERROR_FOUND flag to 1 to drop out build # + ################################################### + ERROR_FOUND=1 + ERROR_CAUSE="Failed to find:[$AWS_SAM_TEMPLATE] in repository!" + else + echo "Successfully found:[$AWS_SAM_TEMPLATE]" + fi + + ############################ + # Package the SAM template # + ############################ + # shellcheck disable=SC2164 + SAM_PACKAGE_CMD=$(cd "$GITHUB_WORKSPACE"; "$SAM_CMD" package --template-file "$GITHUB_WORKSPACE/$AWS_SAM_TEMPLATE" --s3-bucket "$S3_BUCKET" --output-template-file "$AWS_PACKAGED" --region "$AWS_REGION") + + ####################### + # Load the error code # + ####################### + ERROR_CODE=$? + + ############################## + # Check the shell for errors # + ############################## + if [ $ERROR_CODE -ne 0 ]; then + # Errors found + echo "ERROR! Failed to package SAM template!" + echo "ERROR:[$SAM_PACKAGE_CMD]" + ######################################### + # Need to update the ACTION_CONCLUSTION # + ######################################### + ERROR_FOUND=1 + ERROR_CAUSE='Failed to package SAM template!' + else + echo "Successfully packaged AWS SAM Application" + fi +} +################################################################################ +#### Function DeployTemplate ################################################### +DeployTemplate() +{ + ########## + # Prints # + ########## + echo "--------------------------------------------" + echo "Deploying the template..." + + ############################################ + # Need to validate the package was created # + ############################################ + if [ ! -f "$GITHUB_WORKSPACE/$AWS_PACKAGED" ]; then + echo "ERROR! Failed to find created package:[$AWS_PACKAGED]" + ################################################### + # Set the ERROR_FOUND flag to 1 to drop out build # + ################################################### + ERROR_FOUND=1 + ERROR_CAUSE="Failed to find created package:[$AWS_PACKAGED]" + fi + + ########################### + # Deploy the SAM template # + ########################### + # shellcheck disable=SC2164 + SAM_DEPLOY_CMD=$(cd "$GITHUB_WORKSPACE"; "$SAM_CMD" deploy --template-file "$GITHUB_WORKSPACE/$AWS_PACKAGED" --stack-name "$AWS_STACK_NAME" --capabilities CAPABILITY_IAM --region "$AWS_REGION") + + ####################### + # Load the error code # + ####################### + ERROR_CODE=$? + + ############################## + # Check the shell for errors # + ############################## + if [ $ERROR_CODE -ne 0 ]; then + # Errors found + echo "ERROR! Failed to deploy SAM template!" + echo "ERROR:[$SAM_DEPLOY_CMD]" + ######################################### + # Need to update the ACTION_CONCLUSTION # + ######################################### + ERROR_FOUND=1 + ACTION_CONCLUSTION='failure' + ACTION_OUTPUT="Failed to deploy SAM App" + else + # Success + echo "Successfully deployed AWS SAM Application" + ######################################### + # Need to update the ACTION_CONCLUSTION # + ######################################### + ACTION_CONCLUSTION='success' + ACTION_OUTPUT="Successfully Deployed SAM App" + fi +} +################################################################################ +#### Function GetOutput ######################################################## +GetOutput() +{ + # Need to get the generated output from the stack + # to display back to the user for consumption + + ########## + # Prints # + ########## + echo "--------------------------------------------" + echo "Gathering Output from deployed SAM application..." + + ########################### + # Get the output from AWS # + ########################### + IFS=$'\n' # Set IFS to newline + OUTPUT_CMD=($(aws cloudformation describe-stacks --stack-name "$AWS_STACK_NAME" --query "Stacks[0].Outputs[*]" --region "$AWS_REGION")) + + ####################### + # Load the error code # + ####################### + ERROR_CODE=$? + + ############################## + # Check the shell for errors # + ############################## + if [ $ERROR_CODE -ne 0 ]; then + # Errors found + echo "ERROR! Failed to get output from deployed SAM application!" + echo "ERROR:[${OUTPUT_CMD[*]}]" + ######################################### + # Need to update the ACTION_CONCLUSTION # + ######################################### + ERROR_FOUND=1 + ACTION_CONCLUSTION='failure' + ACTION_OUTPUT="Failed to get output from deployed SAM application" + else + # Success + ################################################ + # Itterate through all lines returned from AWS # + ################################################ + echo "Output from deployed AWS SAM Application:[$AWS_STACK_NAME]:" + for LINE in "${OUTPUT_CMD[@]}" + do + # Print the output to the logfile + echo "$LINE" + done + fi +} +################################################################################ +#### Function ValidateSourceAndRuntime ######################################### +ValidateSourceAndRuntime() +{ + ########## + # Prints # + ########## + echo "--------------------------------------------" + echo "Validating file:[$AWS_SAM_TEMPLATE] and NodeJS runtime..." + + ############################################## + # Validate the user has the template.yml and # + # we have the correct runtime set # + ############################################## + + ############################################ + # Look for the template in the source code # + ############################################ + if [ ! -f "$GITHUB_WORKSPACE/$AWS_SAM_TEMPLATE" ]; then + # Errors found + echo "ERROR! Failed to find template:[$GITHUB_WORKSPACE/$AWS_SAM_TEMPLATE]!" + ######################################### + # Need to update the ACTION_CONCLUSTION # + ######################################### + ERROR_FOUND=1 + ERROR_CAUSE="Failed to find template:[$GITHUB_WORKSPACE/$AWS_SAM_TEMPLATE]!" + else + ################################# + # Get the runtime from template # + ################################# + GET_RUNTIME_CMD=$(grep "Runtime" "$GITHUB_WORKSPACE/$AWS_SAM_TEMPLATE" ) + + ####################### + # Load the error code # + ####################### + ERROR_CODE=$? + + ############################################# + # Clean any whitespace that may be returned # + ############################################# + GET_RUNTIME_CMD_NO_WHITESPACE="$(echo "${GET_RUNTIME_CMD}" | tr -d '[:space:]')" + GET_RUNTIME_CMD=$GET_RUNTIME_CMD_NO_WHITESPACE + + ############################## + # Check the shell for errors # + ############################## + if [ $ERROR_CODE -ne 0 ]; then + # Errors found + echo "ERROR! Failed to find [Runtime] in:[$GITHUB_WORKSPACE/$AWS_SAM_TEMPLATE]!" + ######################################### + # Need to update the ACTION_CONCLUSTION # + ######################################### + ERROR_FOUND=1 + ERROR_CAUSE="Failed to find [Runtime] in:[$GITHUB_WORKSPACE/$AWS_SAM_TEMPLATE]!" + else + echo "File found and Runtime variable parsed successfully" + ########################### + # Need to set the runtime # + ########################### + RUNTIME=$(echo "$GET_RUNTIME_CMD" | cut -f2 -d':') + fi + fi + + ################################################## + # Need to set the Runtime for the app deployment # + ################################################## + #SetRuntime "$RUNTIME" +} +################################################################################ +#### Function SetRuntime ####################################################### +SetRuntime() +{ + ################ + # Pull in vars # + ################ + RUNTIME=$1 + + ########## + # Prints # + ########## + echo "--------------------------------------------" + echo "Setting NodeJS runtime..." + + ########################################### + # Remove the 'NodeJS' and get the version # + ########################################### + # shellcheck disable=SC2116 + VERSION=$(echo "${RUNTIME:6}") + + # echo "Version:[$VERSION]" + + ################ + # Set the vars # + ################ + VERSION_MAJOR=$(echo "$VERSION" | cut -f1 -d'.') + VERSION_MINOR=$(echo "$VERSION" | cut -f2 -d'.') + + ################################ + # Check if minor is x or undef # + ################################ + if [ "$VERSION_MINOR" == "x" ] || [ -z "$VERSION_MINOR" ]; then + ######################### + # Need to set to latest # + ######################### + # shellcheck disable=SC1090 + NVM_INSTALL_CMD=$(. "$NVM_SRC"; nvm install "$VERSION_MAJOR" ; nvm use "$VERSION_MAJOR") + + ####################### + # Load the error code # + ####################### + ERROR_CODE=$? + + ############################## + # Check the shell for errors # + ############################## + if [ $ERROR_CODE -ne 0 ]; then + echo "ERROR! Failed to install and set Node:[$VERSION_MAJOR]!" + echo "ERROR:[$NVM_INSTALL_CMD]" + ######################################### + # Need to update the ACTION_CONCLUSTION # + ######################################### + ERROR_FOUND=1 + ERROR_CAUSE="Failed to install and set Node:[$VERSION_MAJOR]!" + fi + else + ######################### + # Running exact version # + ######################### + # shellcheck disable=SC1090 + NVM_INSTALL_CMD=$(. "$NVM_SRC"; nvm install "$VERSION" ; nvm use "$VERSION") + + ####################### + # Load the error code # + ####################### + ERROR_CODE=$? + + ############################## + # Check the shell for errors # + ############################## + if [ $ERROR_CODE -ne 0 ]; then + echo "ERROR! Failed to install and set Node:[$VERSION]!" + echo "ERROR:[$NVM_INSTALL_CMD]" + ######################################### + # Need to update the ACTION_CONCLUSTION # + ######################################### + ERROR_FOUND=1 + ERROR_CAUSE="Failed to install and set Node:[$VERSION]!" + fi + fi +} +################################################################################ +#### Function UpdateCheck ###################################################### +UpdateCheck() +{ + ########## + # Prints # + ########## + echo "--------------------------------------------" + echo "Updating GitHub Check..." + + ########################### + # Build the finished time # + ########################### + FINISHED_DATE=$(date +"%Y-%m-%dT%H:%M:%SZ") + + ###################################################### + # Set the conclusion to failure if errors were found # + ###################################################### + if [ $ERROR_FOUND -ne 0 ]; then + # Set conclusion + ACTION_CONCLUSTION='failure' + # Set the output + ACTION_OUTPUT="$ERROR_CAUSE" + fi + + ########################################## + # Call to Github to update the Check API # + ########################################## + UPDATE_CHECK_CMD=$( curl -k --fail -X PATCH \ + --url "$GITHUB_URL/repos/$GITHUB_ORG/$GITHUB_REPO/check-runs/$CHECK_ID" \ + -H 'accept: application/vnd.github.antiope-preview+json' \ + -H "authorization: Bearer $GITHUB_TOKEN" \ + -H 'content-type: application/json' \ + --data "{ \"name\": \"$CHECK_NAME\", \"head_sha\": \"$GITHUB_SHA\", \"status\": \"completed\", \"completed_at\": \"$FINISHED_DATE\" , \"conclusion\": \"$ACTION_CONCLUSTION\" , \"output\": { \"title\": \"AWS SAM Deploy Summary\" , \"text\": \"$ACTION_OUTPUT\"} }") + + ####################### + # Load the error code # + ####################### + ERROR_CODE=$? + + ############################## + # Check the shell for errors # + ############################## + if [ $ERROR_CODE -ne 0 ]; then + echo "ERROR! Failed to update GitHub Check!" + echo "ERROR:[$UPDATE_CHECK_CMD]" + exit 1 + else + echo "Success! Updated Github Checks API" + fi +} +################################################################################ +################################# MAIN ######################################### +################################################################################ + +####################### +# Debug print all env # +####################### +if [ $DEBUG -ne 0 ]; then + echo "--------------------------------------------" + echo "PRINTENV" + printenv + echo "--------------------------------------------" +fi + +# Go into loop if no errors detected +if [ $ERROR_FOUND -eq 0 ]; then + ####################### + # Get Github Env Vars # + ####################### + # Need to pull in all the Github variables + # needed to connect back and update checks + GetGitHubVars +fi + +# Go into loop if no errors detected +if [ $ERROR_FOUND -eq 0 ]; then + ####################################### + # Validate We have configuration file # + ####################################### + # Look for the users configuration file to + # connect to AWS and start the Serverless app + ValidateConfigurationFile +fi + +# Go into loop if no errors detected +if [ $ERROR_FOUND -eq 0 ]; then + ################################### + # Create local configuration file # + ################################### + # Create the local configuration file used + # to connect to AWS and deploy the Serverless app + CreateLocalConfiguration +fi + +# Go into loop if no errors detected +if [ $ERROR_FOUND -eq 0 ]; then + #################### + # Validate AWS CLI # + #################### + # Need to validate we have the aws cli installed + # And avilable for usage + ValidateAWSCLI +fi + +######################################## +# Validate the user source and runtime # +######################################## +ValidateSourceAndRuntime + +################ +# Create Check # +################ +# Create the check in GitHub to let the +# user know we are running the deploy action +# We always want to inform user of the process +# Note: No need to create check as were calling from inside a gitHub Action +#CreateCheck + +# Go into loop if no errors detected +if [ $ERROR_FOUND -eq 0 ]; then + ############## + # Run Deploy # + ############## + # Run the actual deployment of the NodeJS + # to AWS Serverless + RunDeploy +fi + +################ +# Update Check # +################ +# Update the check with the status +# of the deployment +# We always want to inform user of the process +# Note: No need to create check as were calling from inside a gitHub Action +#UpdateCheck + +############################### +# Exit with proper error code # +############################### +if [ $ERROR_FOUND -eq 0 ]; then + # Exit with SUCCESS + exit 0 +else + # Exit with ERROR + exit 1 +fi