doc fragments workaround for downstream (#59)

* doc fragments workaround for downstream

Signed-off-by: Adam Miller <admiller@redhat.com>

* make shellcheck happy

Signed-off-by: Adam Miller <admiller@redhat.com>

* fix collection location for downstream doc fragment resolution

Signed-off-by: Adam Miller <admiller@redhat.com>

* do things in the correct order

Signed-off-by: Adam Miller <admiller@redhat.com>

* add ANSIBLE_COLLECTIONS_PATH to ansible-doc for downstream

Signed-off-by: Adam Miller <admiller@redhat.com>

* remove elements of the json dump that aren't valid for DOCUMENTATION

Signed-off-by: Adam Miller <admiller@redhat.com>

* Add fix for Ansible 2.9

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>

* Update ci/downstream.sh

Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com>
Co-authored-by: Jeff Geerling <geerlingguy@mac.com>

ci/downstream.sh

@@ -1,4 +1,4 @@
-#!/bin/bash -eu
+#!/bin/bash -e
 
 # Script to dual-home the upstream and downstream Collection in a single repo
 #
@@ -44,7 +44,7 @@ f_text_sub()
     sed -i.bak "s/^version\:.*$/version: ${DOWNSTREAM_VERSION}/" "${_build_dir}/galaxy.yml"
     sed -i.bak "/STARTREMOVE/,/ENDREMOVE/d" "${_build_dir}/README.md"
 
-    find ${_build_dir} -type f -exec sed -i.bak "s/community\.okd/redhat\.openshift/g" {} \;
+    find "${_build_dir}" -type f -exec sed -i.bak "s/community\.okd/redhat\.openshift/g" {} \;
     find "${_build_dir}" -type f -name "*.bak" -delete
 }
 
@@ -76,9 +76,18 @@ f_prep()
         tests
     )
 
+    # Modules with inherited doc fragments from kubernetes.core that need
+    # rendering to deal with Galaxy/AH lack of functionality.
+    _doc_fragment_modules=(
+        k8s
+        openshift_process
+        openshift_route
+    )
 
-    # Temp build dir 
+
+    # Temp build dir
     _tmp_dir=$(mktemp -d)
+    _start_dir="${PWD}"
     _build_dir="${_tmp_dir}/ansible_collections/redhat/openshift"
     mkdir -p "${_build_dir}"
 }
@@ -127,9 +136,50 @@ f_create_collection_dir_structure()
     fi
 }
 
+f_handle_doc_fragments_workaround()
+{
+    f_log_info "${FUNCNAME[0]}"
+    local install_collections_dir="${_build_dir}/collections/"
+    local temp_fragments_json="${_tmp_dir}/fragments.json"
+    local temp_start="${_tmp_dir}/startfile.txt"
+    local temp_end="${_tmp_dir}/endfile.txt"
+    local rendered_fragments="./rendereddocfragments.txt"
+
+    # Build the collection, export docs, render them, stitch it all back together
+    pushd "${_build_dir}" || return
+        ansible-galaxy collection build
+        ansible-galaxy collection install -p "${install_collections_dir}" ./*.tar.gz
+        rm ./*.tar.gz
+        for doc_fragment_mod in "${_doc_fragment_modules[@]}"
+        do
+            local module_py="plugins/modules/${doc_fragment_mod}.py"
+            f_log_info "Processing doc fragments for ${module_py}"
+            ANSIBLE_COLLECTIONS_PATH="${install_collections_dir}" \
+            ANSIBLE_COLLECTIONS_PATHS="${ANSIBLE_COLLECTIONS_PATH}:${install_collections_dir}" \
+                ansible-doc -j "redhat.openshift.${doc_fragment_mod}" > "${temp_fragments_json}"
+            # FIXME: Check Python interpreter from environment variable to work with prow
+            if [ -e /usr/bin/python3.6 ]; then
+                PYTHON="/usr/bin/python3.6"
+            else
+                PYTHON="python"
+            fi
+            "${PYTHON}" "${_start_dir}/ci/downstream_fragments.py" "redhat.openshift.${doc_fragment_mod}" "${temp_fragments_json}"
+            sed -n '/STARTREMOVE/q;p' "${module_py}" > "${temp_start}"
+            sed '0,/ENDREMOVE/d' "${module_py}" > "${temp_end}"
+            cat "${temp_start}" "${rendered_fragments}" "${temp_end}" > "${module_py}"
+            cat "${module_py}"
+        done
+        rm -f "${rendered_fragments}"
+        rm -fr "${install_collections_dir}"
+    popd
+
+}
+
 f_install_kubernetes_core()
 {
+    f_log_info "${FUNCNAME[0]}"
     local install_collections_dir="${_tmp_dir}/ansible_collections"
+
     pushd "${_tmp_dir}"
         ansible-galaxy collection install -p "${install_collections_dir}" kubernetes.core
     popd
@@ -149,6 +199,7 @@ f_common_steps()
     f_prep
     f_create_collection_dir_structure
     f_text_sub
+    f_handle_doc_fragments_workaround
 }
 
 # Run the test sanity scanerio
@@ -192,16 +243,16 @@ f_build_option()
 {
     f_log_info "${FUNCNAME[0]}"
     f_common_steps
-    pushd "${_build_dir}" || return 
+    pushd "${_build_dir}" || return
         f_log_info "BUILD WD: ${PWD}"
-        # FIXME 
-        #   This doesn't work because we end up either recursively curl'ing 
+        # FIXME
+        #   This doesn't work because we end up either recursively curl'ing
         #   kubernetes.core and redoing the text replacement over and over
-        #         
-        # make build 
+        #
+        # make build
         ansible-galaxy collection build
 
-    popd || return 
+    popd || return
     f_copy_collection_to_working_dir
     f_cleanup
 }
@@ -216,19 +267,19 @@ fi
 while getopts ":sirb" option
 do
   case $option in
-    s) 
+    s)
         f_test_sanity_option
         ;;
-    i) 
+    i)
         f_test_integration_option
         ;;
-    r) 
+    r)
         f_release_option
         ;;
-    b) 
+    b)
         f_build_option
         ;;
-    *) 
+    *)
         printf "ERROR: Unimplemented option chosen.\n"
         f_show_help
         f_exit 1