Add flake8 and bug fix venv in the AC tool. (#1784)

* Update venv.sh to add a custom galaxy config to enable flake8

Signed-off-by: ddimatos <[email protected]>

* update galaxy config with comments

Signed-off-by: ddimatos <[email protected]>

* Update ac export var for galaxy config

Signed-off-by: ddimatos <[email protected]>

* Update ac so that a venv will find the locally venv installed collection

Signed-off-by: ddimatos <[email protected]>

* fragment added

Signed-off-by: ddimatos <[email protected]>

* Change flake8 design

Signed-off-by: ddimatos <[email protected]>

* change flake8 design

Signed-off-by: ddimatos <[email protected]>

---------

Signed-off-by: ddimatos <[email protected]>

Author: ddimatos

ac

@@ -121,6 +121,7 @@ ENDC=$'\e[0m'
 # return codes.. Use this method for messages to the console.
 # ------------------------------------------------------------------------------
 message(){
+    printf '%s\n' "" >&2
     printf '%s\n' "${GRN}${DIV}${ENDC}" >&2
     printf '%s\n' "${GRN}INFO:${ENDC} ${1}" >&2
     printf '%s\n' "${GRN}${DIV}${ENDC}" >&2
@@ -132,6 +133,7 @@ message(){
 # Use this method for error messages to the console.
 # ------------------------------------------------------------------------------
 message_error(){
+    printf '%s\n' "" >&2
     printf '%s\n' "${RED}${DIV}${RED}" >&2
     printf '%s\n' "${RED}ERROR:${ENDC} ${1}" >&2
     printf '%s\n' "${RED}${DIV}${ENDC}" >&2
@@ -144,6 +146,7 @@ message_error(){
 # Use this method for error messages to the console.
 # ------------------------------------------------------------------------------
 message_warn(){
+    printf '%s\n' "" >&2
     printf '%s\n' "${YEL}${DIV}${YEL}" >&2
     printf '%s\n' "${YEL}WARN:${ENDC} ${1}" >&2
     printf '%s\n' "${YEL}${DIV}${YEL}" >&2
@@ -369,11 +372,27 @@ ac_build(){
 ## Example:
 ##  $ ac --ac-galaxy-importer
 ac_galaxy_importer(){
+    # Extract the pytest ignore errors from `$VENV/galaxy-importer.cfg` and trim all white space
+    FLAKE8_IGNORE=`cat $VENV/galaxy-importer.cfg| grep -i "ignore = " | cut -d "=" -f 2 | tr -d ' '`
+
+    # Path to the installed constants.py
+    eval "ORIGINAL_CONSTANTS_DIR=(${VENV}/lib/*/site-packages/galaxy_importer/)"
+
+    # Backup up the constants.py file before editing it.
+    cp $ORIGINAL_CONSTANTS_DIR/constants.py /tmp/
+
+    # Update constants.py with our choice of FLAKE8_IGNORE entry
+    sed "s/E402/$FLAKE8_IGNORE/" ${ORIGINAL_CONSTANTS_DIR}/constants.py > ${ORIGINAL_CONSTANTS_DIR}/constants.py.tmp
+
+    mv ${ORIGINAL_CONSTANTS_DIR}/constants.py.tmp ${ORIGINAL_CONSTANTS_DIR}/constants.py
+
     message "Creating 'ibm_zos_core' collection with branch: '$GH_BRANCH'."
     . $VENV_BIN/activate && collection_name=$($VENV_BIN/ansible-galaxy collection build --force | awk -F/ '{print $NF}') && ls -la $collection_name
 
     message "Running Galaxy Importer for collection $collection_name"
-    . $VENV_BIN/activate && python3 -m galaxy_importer.main $collection_name
+    . $VENV_BIN/activate && export GALAXY_IMPORTER_CONFIG=$VENV/galaxy-importer.cfg; python3 -m galaxy_importer.main $collection_name
+
+    mv /tmp/constants.py ${ORIGINAL_CONSTANTS_DIR}/constants.py
 }
 
 # ------------------------------------------------------------------------------
@@ -1711,8 +1730,14 @@ venv_start(){
     fi
 
     message "Starting managed python virtual environment: $VENV_BASENAME"
+    # Original , see comments below.
     #. $VENV_BIN/activate; exec /bin/sh -i
-    /bin/bash -c ". $VENV_BIN/activate; exec /bin/sh -i;"
+
+    # TODO: Document wny /bin/bash -c was introduced , the shebang already forces this, could have been because of original CE design which should not depend on bash.
+    # /bin/bash -c ". $VENV_BIN/activate; exec /bin/sh -i;"
+
+    # Invoke venv with epxorts that can find the ansible collection within the venv.
+    /bin/bash -c ". $VENV_BIN/activate && export ANSIBLE_LIBRARY=$VENV/ansible_collections/ibm/ibm_zos_core/plugins/modules;export ANSIBLE_CONFIG=$VENV/ansible.cfg; exec /bin/sh -i;"
 }
 
 # ------------------------------------------------------------------------------

changelogs/fragments/1784-ac-added-flake8-collections-mapping.yml

@@ -0,0 +1,9 @@
+trivial:
+  - ac - Enabled flake8 support through galaxy-importer, updates
+    venv.sh to create the galaxy-importer.cfg needed to activate
+    flake8.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/1784).
+
+  - ac - Enabled managed venv's ability to detect locally installed
+    collections. 
+    (https://github.com/ansible-collections/ibm_zos_core/pull/1784).

scripts/venv.sh

@@ -175,6 +175,37 @@ write_ansible_cfg(){
     unset ansible_cfg
 }
 
+# Customized galaxy-importer.cfg for each managed venv, ./ac will know how to source this so its used during execution.
+write_galaxy_cfg(){
+    galaxy_cfg=${galaxy_cfg}"[galaxy-importer]\\n"
+    galaxy_cfg=${galaxy_cfg}"LOG_LEVEL_MAIN = INFO\\n"
+    galaxy_cfg=${galaxy_cfg}"RUN_ANSIBLE_TEST = False\\n"
+    galaxy_cfg=${galaxy_cfg}"ANSIBLE_LOCAL_TMP = '~/.ansible/tmp'\\n"
+    galaxy_cfg=${galaxy_cfg}"RUN_FLAKE8 = True\\n\\n"
+
+    galaxy_cfg=${galaxy_cfg}"[flake8]\\n"
+    galaxy_cfg=${galaxy_cfg}"exclude =\\n"
+    galaxy_cfg=${galaxy_cfg}"    ./galaxy_importer.egg-info/*,\\n"
+    galaxy_cfg=${galaxy_cfg}"    ./build/*,\\n"
+    galaxy_cfg=${galaxy_cfg}"    ./dist/*\\n"
+    galaxy_cfg=${galaxy_cfg}"    ./.git/*\\n"
+    galaxy_cfg=${galaxy_cfg}"    ./.env/*,\\n"
+    galaxy_cfg=${galaxy_cfg}"    ./.venv/*,\\n"
+    galaxy_cfg=${galaxy_cfg}"    ./.pytest_cache/*,\\n\\n"
+
+    galaxy_cfg=${galaxy_cfg}"ignore = E402,W503,W504\\n\\n"
+
+    galaxy_cfg=${galaxy_cfg}"# Flake8 codes\\n"
+    galaxy_cfg=${galaxy_cfg}"# --------------------\\n"
+    galaxy_cfg=${galaxy_cfg}"# W503: This enforces operators before line breaks which is not pep8 or black compatible.\\n"
+    galaxy_cfg=${galaxy_cfg}"# W504: This enforces operators after line breaks which is not pep8 or black compatible.\\n"
+    galaxy_cfg=${galaxy_cfg}"# E402: This enforces module level imports at the top of the file.\\n\\n"
+
+    echo -e "${galaxy_cfg}">"${VENV_HOME_MANAGED}"/"${venv_name}"/galaxy-importer.cfg
+    unset galaxy_cfg
+
+}
+
 # Lest normalize the version from 3.10.2 to 3010002000
 # Do we we need that 4th octet?
 normalize_version() {
@@ -321,6 +352,7 @@ write_requirements(){
             cp ce.py "${VENV_HOME_MANAGED}"/"${venv_name}"/
             cp -R modules "${VENV_HOME_MANAGED}"/"${venv_name}"/
             write_ansible_cfg
+            write_galaxy_cfg
 
             # Decrypt file
             if [ "$option_pass" ]; then