X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=tools%2Fcheckdocs.sh;h=66cbd4c47539131a0fbea00c69a8d75734296483;hb=2360a44a06e2ce2da7f878cf8303006f74a9e3b5;hp=1f7f10be5467e367cbaf3d697bef3dc5b9c10d21;hpb=73ed651d81f44c75bda8e0041f3ffa32da847d87;p=doc.git diff --git a/tools/checkdocs.sh b/tools/checkdocs.sh index 1f7f10be5..66cbd4c47 100755 --- a/tools/checkdocs.sh +++ b/tools/checkdocs.sh @@ -19,7 +19,7 @@ ### checkdocs.sh ### ### AUTHOR(S): -### Thomas Kulik, Deutsche Telekom AG, 2020 +### Thomas Kulik, Deutsche Telekom AG, 2020 - 2021 ### ### DESCRIPTION: ### Retrieves a full list of ONAP repos from gerrit inluding their state. @@ -46,8 +46,8 @@ ### create repo list ### curl -s https://git.onap.org/ | grep "^1)print}' | jq -c '.[] | {id, state}' | sed -r 's:%2F:/:g; s:["{}]::g; s:id\:::; s:,state\::|:; /All-Projects/d; /All-Users/d' ### -script_version="1.2 (2020-11-18)" +script_version="1.7 (2021-04-12)" # save command for the restart with logging enabled command=$0 @@ -79,7 +79,7 @@ function usage() { echo " " echo " ARGUMENTS: " echo " -u|--user username " - echo " linux foundation username used to clone ONAP Gerrit repos" + echo " linux foundation username used to clone ONAP repositories" echo " " echo " -b|--branches branch1,branch2,branch3 " echo " list of branches to be cloned. master is automatically " @@ -106,6 +106,45 @@ function InterruptedScript { exit 0 } +# function to parse wiki (project) lifecycle state information +# call: getwikilifecyclestate "projectname" +# result: $return_from_getwikilifecyclestate +# because bash supports only returning numeric values a variable $return_from_getwikilifecyclestate is used + +function getwikilifecyclestate { + + local requested=$1 + local wikiline="" + local wikirepo="" + local wikistate="" + + return_from_getwikilifecyclestate="" + + for wikiline in "${wikiplsarray[@]}" + do + + wikirepo=$(echo $wikiline | awk -F ";" '{print $1}'); + wikistate=$(echo $wikiline | awk -F ";" '{print $2}'); + + #echo "DBUG: getwikilifecyclestate wikiline = \"${wikiline}\""; + #echo "DBUG: getwikilifecyclestate wikirepo = \"${wikirepo}\"" + #echo "DBUG: getwikilifecyclestate wikistate = \"${wikistate}\"" + + if [[ ${wikirepo} == ${requested} ]]; then + return_from_getwikilifecyclestate=${wikistate} + #echo "DBUG: getwikilifecyclestate wikirepo = \"${wikirepo}\"" + #echo "DBUG: getwikilifecyclestate requested = \"${requested}\"" + #echo "DBUG: return_from_getwikilifecyclestate = \"${return_from_getwikilifecyclestate}\""; + return 0; + fi + + done + + #echo "DBUG: getwikilifecyclestate requested \"${requested}\" NOT FOUND in list" + return_from_getwikilifecyclestate="" + +} + ### ### arguments handling ### @@ -164,7 +203,7 @@ if [[ $branches_csv == *"master"* ]]; then usage exit -1 fi -# clone master first, the the other branches +# clone master first, then the other branches branches_csv="master,${branches_csv}" # create the branches array by readinging in the values from the variable @@ -189,7 +228,40 @@ echo " " echo "checkdocs.sh Version ${script_version}" echo " " +# +# read in wiki (project) lifecycle state +# always use the lastest available file (derived from date in filename e.g. wiki_lifecycle_state_210409.txt) +# format is ;; +# + +wikiplsfile=$(ls | sed -nr '/wiki_lifecycle_state_[0-9]{6}.txt/Ip' | tail -1); + +if [[ $wikiplsfile == "" ]]; then + echo "ERROR: wiki_lifecycle_state_yymmdd.txt missing" + exit -1 +fi + +echo "Using \"${wikiplsfile}\" as the source for wiki (project) lifecycle state information." + +readarray -t wikiplsarray < ./${wikiplsfile}; +i=0 +((i++)) +for line in "${wikiplsarray[@]}" +do + wikiplsrepo=$(echo $line | awk -F ";" '{print $1}'); + wikiplsstate=$(echo $line | awk -F ";" '{print $2}'); + #echo "DBUG: wikipls line=\"${line}\""; + #echo "DBUG: wikipls ${wikiplsrepo}=${wikiplsstate}" + ((i++)) +done +unset i +unset wikiplsrepo +unset wikiplsstate + +# # curl must be installed +# + if ! command -v curl &> /dev/null then echo "ERROR: curl command could not be found" @@ -202,15 +274,19 @@ unique=$(date +%s) echo "Retrieving a full list of ONAP repositories (master) from gerrit.onap.org." +# # retrieve the full repolist from gerrit # workaround because of the (wrong?) response of gerrit.onap.org which makes jq command fail # "| awk '{if(NR>1)print}'" filters the first line of the response so that jq will work again (thx marek) +# + curl -s 'https://gerrit.onap.org/r/projects/?d' | awk '{if(NR>1)print}' | jq -c '.[] | {id, state}' | sed -r 's:%2F:/:g; s:["{}]::g; s:id\:::; s:,state\::|:; /All-Projects/d; /All-Users/d' >./$repolist -# process the created repolist -# only active projects will be cloned in case the requested branch of the project exists -echo "Accessing gerrit.onap.org with username \"${lfusername}\"." -echo "Start cloning of repositories." +# process the created repolist and try to clone the projects from the mirror + +source="git://cloud.onap.org/mirror" +echo "Using \"${source}\" as the source and username \"${lfusername}\" for cloning the repositories." +echo "Start cloning of repositories ..." for branch in "${branches[@]}" do @@ -237,7 +313,7 @@ do devcounter=$((devcounter+1)) fi - if [[ $devcounter -lt "11" ]]; then + if [[ $devcounter -lt "50" ]]; then if [[ $devmode == "TRUE" ]]; then echo "INFO: devmode! counter=${devcounter}" @@ -249,10 +325,12 @@ do echo $reponame echo $repostate - if [[ $repostate == "ACTIVE" ]]; then - echo "Cloning \"${branch}\" branch of ACTIVE project ${reponame}..." + if [[ $repostate == "ACTIVE" ]] || [[ $repostate == "READ_ONLY" ]]; then + echo "Cloning \"${branch}\" branch of \"${repostate}\" project ${reponame}..." - git clone --branch ${branch} --recurse-submodules ssh://${lfusername}@gerrit.onap.org:29418/$reponame ./$reponame + # previously used: git clone --branch ${branch} --recurse-submodules ssh://${lfusername}@gerrit.onap.org:29418/$reponame ./$reponame + # clone script Jess: git clone "git://cloud.onap.org/mirror/${i}" "${LOCALNAME}" + git clone --branch ${branch} --recurse-submodules ${source}/${reponame} ./${reponame} gitexitcode=$? if [[ ! ${gitexitcode} == "0" ]]; then @@ -261,13 +339,13 @@ do errormsg="cloned" fi - # gerritclone.log format: $1=gitexitcode|$2=reponame|$3=repostate|$4=errormsg - echo "${gitexitcode}|${reponame}|${repostate}|${errormsg}" | tee -a ${branch}_gerritclone.log + # repoclone.log format: $1=gitexitcode|$2=reponame|$3=repostate|$4=errormsg + echo "${gitexitcode}|${reponame}|${repostate}|${errormsg}" | tee -a ${branch}_repoclone.log - elif [[ $repostate == "READ_ONLY" ]]; then - echo "-|${reponame}|${repostate}|ignored" | tee -a ${branch}_gerritclone.log + #elif [[ $repostate == "READ_ONLY" ]]; then + #echo "-|${reponame}|${repostate}|ignored" | tee -a ${branch}_repoclone.log else - echo "-|${reponame}|unknown repo state \"${repostate}\"|-" | tee -a ${branch}_gerritclone.log + echo "-|${reponame}|unknown repo state \"${repostate}\"|-" | tee -a ${branch}_repoclone.log fi # examine repo @@ -291,6 +369,9 @@ do printf "\nindex.rst files:\n" find ./$reponame -type f -name index.rst | sed -r 's:./::' | sed -r s:${reponame}:[${reponame}]: | tee -a ${branch}_indexrst.log + printf "\nINFO.yaml files:\n" + find ./$reponame -type f -name INFO.yaml | sed -r 's:./::' | sed -r s:${reponame}:[${reponame}]: | tee -a ${branch}_infoyaml.log + fi # end defcounter loop @@ -414,13 +495,13 @@ do # csv column #4: clone message # - readarray -t array < ./${branch}_gerritclone.log; + readarray -t array < ./${branch}_repoclone.log; i=0 csv[i]="${csv[i]},${branch_upper} clone message" ((i++)) for line in "${array[@]}" do - # gerritclone.log format: $1=gitexitcode|$2=reponame|$3=repostate|$4=errormsg + # repoclone.log format: $1=gitexitcode|$2=reponame|$3=repostate|$4=errormsg errormsg=$(echo $line | awk -F "|" '{print $4}'); csv[i]="${csv[i]},${errormsg}" ((i++)) @@ -430,20 +511,98 @@ do unset errormsg # - # csv column #5: RELEASE component (yes|no|maybe) + # csv column #5: latest branch + # + + readarray -t array < ./${repolist}; + i=0 + csv[i]="${csv[i]},latest branch" + ((i++)) + for line in "${array[@]}" + do + reponame=$(echo $line | awk -F "|" '{print $1}'); + latestbranch=$(git ls-remote -q --heads "${source}/${reponame}" | sed 's/^.*heads\///' | sed -nr '/^master$|^amsterdam$|^beijing$|^casablanca$|^dublin$|^elalto$|^frankfurt$|^guilin$|^honolulu$|^istanbul$/Ip' | tail -2 | head -1); + #echo "DBUG: reponame=${reponame}" + #echo "DBUG: latestbranch=${latestbranch}" + echo "latest available branch for repo \"${reponame}\" is \"${latestbranch}\"" + csv[i]="${csv[i]},${latestbranch}" + ((i++)) + done + unset array + unset i + unset reponame + unset latestbranch + + # + # csv column #6: INFO.yaml LC state (project lifecycle state based on INFO.yaml / per repo) + # csv column #7: WIKI LC state (project lifecycle state based on ONAP Dev Wiki / per project) + # csv column #8: LC state match shows a "match" if both LC states match + # + + readarray -t array < ./${repolist}; + i=0 + csv[i]="${csv[i]},INFO.yaml LC state,WIKI LC state,LC state match" + ((i++)) + for line in "${array[@]}" + do + reponame=$(echo $line | awk -F "|" '{print $1}'); + project=$(echo $reponame | sed 's:/.*$::') + + if [ -f ./${reponame}/INFO.yaml ] ; then + # check if repo/branch has a INFO.yaml + lifecycleproject=$(grep '^project: ' ./${reponame}/INFO.yaml | awk -F ":" '{print $2}' | sed 's:^ ::' | sed "s:'::g" | tr '[:upper:]' '[:lower:]' | sed 's/\r$//') + lifecyclestate=$(grep '^lifecycle_state: ' ./${reponame}/INFO.yaml | awk -F ":" '{print $2}' | sed 's:^ ::' | sed "s:'::g" | tr '[:upper:]' '[:lower:]' | sed 's/\r$//') + elif [ ${branch} != "master" ] && [ -f ../master/${reponame}/INFO.yaml ] ; then + # if current branch is not master AND if info.yaml not found in the current repo/branch THAN use INFO.yaml of repo/master if available + #echo "DBUG: branch=${branch} - checking master for INFO.yaml" + lifecycleproject=$(grep '^project: ' ../master/${reponame}/INFO.yaml | awk -F ":" '{print $2}' | sed 's:^ ::' | sed "s:'::g" | tr '[:upper:]' '[:lower:]' | sed 's/\r$//') + lifecyclestate=$(grep '^lifecycle_state: ' ../master/${reponame}/INFO.yaml | awk -F ":" '{print $2}' | sed 's:^ ::' | sed "s:'::g" | tr '[:upper:]' '[:lower:]' | sed 's/\r$//') + lifecyclestate="(${lifecyclestate})" + else + lifecyclestate="INFO.yaml not found" + fi + + getwikilifecyclestate ${project} + # returns value in ${return_from_getwikilifecyclestate} + + #echo "DBUG: working dir is ...";pwd + #echo "DBUG: lifecycleproject=${lifecycleproject}" + #echo "DBUG: lifecyclestate=${lifecyclestate}" + #echo "DBUG: wikilifecyclestate=${return_from_getwikilifecyclestate}" + + #check if YAML.info LC state is not empty _AND_ if WIKI LC state is not empty _AND_ if YAML.info LC state contains WIKI LC state + if [[ ${lifecyclestate} != "" ]] && [[ ${return_from_getwikilifecyclestate} != "" ]] && [[ ${lifecyclestate} == *"${return_from_getwikilifecyclestate}"* ]]; then + lcstatesmatch="match" + else + lcstatesmatch="" + fi + + csv[i]="${csv[i]},${lifecyclestate},${return_from_getwikilifecyclestate},${lcstatesmatch}" + ((i++)) + done + unset array + unset i + unset reponame + unset project + unset lifecycleproject + unset lifecyclestate + unset lcstatesmatch + + # + # csv column #9: RELEASE component (yes|maybe|unknown) # to be filled with values of the planned release config file maintained by # the onap release manager # - # gerritclone.log format: $1=gitexitcode|$2=reponame|$3=repostate|$4=errormsg - readarray -t array < ./${branch}_gerritclone.log; + # repoclone.log format: $1=gitexitcode|$2=reponame|$3=repostate|$4=errormsg + readarray -t array < ./${branch}_repoclone.log; i=0 csv[i]="${csv[i]},${branch_upper} component" ((i++)) for line in "${array[@]}" do - # gerritclone.log format: $1=gitexitcode|$2=reponame|$3=repostate|$4=errormsg + # repoclone.log format: $1=gitexitcode|$2=reponame|$3=repostate|$4=errormsg gitexitcode=$(echo $line | awk -F "|" '{print $1}'); reponame=$(echo $line | awk -F "|" '{print $2}'); repostate=$(echo $line | awk -F "|" '{print $3}'); @@ -451,10 +610,13 @@ do if [[ ${repostate} == "ACTIVE" && ${gitexitcode} == "0" ]]; then releasecomponent="yes" - elif [[ ${repostate} == "ACTIVE" && ${gitexitcode} == "128" ]]; then + elif [ ${repostate} == "ACTIVE" ]; then + #elif [[ ${repostate} == "ACTIVE" && ${gitexitcode} == "128" ]]; then releasecomponent="maybe" + elif [[ ${repostate} == "READ_ONLY" && ${gitexitcode} == "0" ]]; then + releasecomponent="yes" elif [ ${repostate} == "READ_ONLY" ]; then - releasecomponent="no" + releasecomponent="maybe" else releasecomponent="unknown" fi @@ -471,14 +633,14 @@ do unset releasecomponent # - # csv column #6: docs (at repo root directory only; no recursive search!) - # csv column #7: conf.py - # csv column #8: tox.ini - # csv column #9: index.rst + # csv column #10: docs (at repo root directory only; no recursive search!) + # csv column #11: conf.py + # csv column #12: tox.ini + # csv column #13: index.rst # # columns are filled with values from requested branch. # if data is not available values from master branch are used. - # to identify master branch values, data is put into brackets "(...)" + # to identify master branch values, data is put into round brackets "(...)" # readarray -t array < ./${repolist}; @@ -509,12 +671,31 @@ do docs="${docs},-" fi - # tox.ini - if [ -f ./${line}/docs/tox.ini ] ; then + # tox.ini (check docs dir and also check project root dir) + if [ -f ./${line}/docs/tox.ini ] || [ -f ./${line}/tox.ini ]; then docs="${docs},tox.ini" - elif [ -f ../master/${line}/docs/tox.ini ] ; then - docs="${docs},(tox.ini)" + # tox.ini @ branch/docs dir + if [ -f ./${line}/docs/tox.ini ] ; then + docs="${docs} @docs" + fi + # tox.ini @ branch/project root dir + if [ -f ./${line}/tox.ini ] ; then + docs="${docs} @root" + fi + elif [ -f ../master/${line}/docs/tox.ini ] || [ -f ../master/${line}/tox.ini ]; then + docs="${docs},(tox.ini" + # tox.ini @ master/docs dir + if [ -f ../master/${line}/docs/tox.ini ] ; then + docs="${docs} @docs" + fi + # tox.ini @ master/project root dir + if [ -f ../master/${line}/tox.ini ] ; then + docs="${docs} @root" + fi + # just add a round bracket at the end of the value + docs="${docs})" else + # no tox.ini found in docs or root dir docs="${docs},-" fi @@ -537,17 +718,17 @@ do unset docs # - # csv column #10: index.html@RTD accessibility check - # csv column #11: index.html url + # csv column #14: index.html@RTD accessibility check + # csv column #15: index.html url # - readarray -t array < ./${branch}_gerritclone.log; + readarray -t array < ./${branch}_repoclone.log; i=0 csv[i]="${csv[i]},index.html@RTD,index.html url" ((i++)) for line in "${array[@]}" do - # gerritclone.log format: $1=gitexitcode|$2=reponame|$3=repostate|$4=errormsg + # repoclone.log format: $1=gitexitcode|$2=reponame|$3=repostate|$4=errormsg gitexitcode=$(echo $line | awk -F "|" '{print $1}'); reponame=$(echo $line | awk -F "|" '{print $2}'); repostate=$(echo $line | awk -F "|" '{print $3}'); @@ -556,7 +737,7 @@ do url="" curl_result="" - # this routine works only with release "frankfurt" and later because + # this script works only with release "frankfurt" and later because # earlier releases are using submodule structure for documentation files if echo "$branch" | grep -q '^[abcde]'; then curl_result="unsupported release" @@ -564,8 +745,7 @@ do else # we are working on "frankfurt" branch or later ... - # only if repostate IS ACTIVE a curl test is required - if [[ ${repostate} == "ACTIVE" ]]; then + if [[ ${repostate} == "ACTIVE" ]] || [[ ${repostate} == "READ_ONLY" ]]; then # OPTIONAL: USE ALSO GITEXITCODE AS A FILTER CRITERIA ??? @@ -638,7 +818,7 @@ do fi else - # repostate IS NOT ACTIVE - no curl test required + # repostate IS NOT ACTIVE OR READ_ONLY - no curl test required curl_result="-" url="-" fi @@ -652,7 +832,7 @@ do done # - # csv column #12: release notes + # csv column #16: release notes # readarray -t array < ../${repolist}; @@ -675,16 +855,19 @@ do if [ -d ./${line} ] ; then # if yes, check if repo name appears in the branch releasenotes.log relnote=$(find "./${line}" -type f | grep 'release.*note.*.rst' | wc -l); + #echo "DBUG: relnote=${relnote}" # repo dir DOES NOT exist in this branch - so check if repo dir exists in MASTER branch elif [ -d ../master/${line} ] ; then # if yes, check if repo name appears in the MASTER releasenotes.log # count release notes files in MASTER branch (in repo root and its subdirectories) relnote=$(find "../master/${line}" -type f | grep 'release.*note.*.rst' | wc -l); + #echo "DBUG: relnote=${relnote}" # put results in round brackets to show that this is MASTER data relnote=$(echo ${relnote} | sed -r s:${relnote}:\(${relnote}\):) else relnote="-" fi + #echo "DBUG: relnote=${relnote}" line="${csv[i]},${relnote}" csv[i]=${line} @@ -712,6 +895,7 @@ do datadir=${branch}_data mkdir $datadir cp $repolist $datadir + cp $wikiplsfile $datadir cp ${branch}_table.csv $datadir cp ${branch}_*.log $datadir zip -r ${datadir}.zip $datadir