1#!/bin/bash 2set -e 3 4ARG_COMMIT=$1 5DIFF_SUBSET="scripts/.diff_*" 6DIFF_DOC_ALL="scripts/.diff_all.txt" 7DIFF_DOC_FIXED="scripts/.diff_fixed.txt" 8LAST_SEVERITY= 9LAST_DOC= 10 11function check_doc() 12{ 13 local TOP_SEVERITY LANGUAGE=$1 14 15 if [ "${LANGUAGE}" == "EN" ] ; then 16 SVT_CRITIAL="critical" 17 SVT_IMPORTANT="important" 18 SVT_MODERATE="moderate" 19 DOC=`git log ${ARG_COMMIT} -1 --name-only | sed -n "/_EN\.md/p"` 20 else 21 SVT_CRITIAL="紧急" 22 SVT_IMPORTANT="重要" 23 SVT_MODERATE="普通" 24 DOC=`git log ${ARG_COMMIT} -1 --name-only | sed -n "/_CN\.md/p"` 25 fi 26 27 echo "Checking doc: ${DOC}" 28 29 # check DOS encoding 30 git show ${ARG_COMMIT} -1 ${DOC} | sed -n "/^+/p" > ${DIFF_DOC_ALL} 31 git show ${ARG_COMMIT} -1 ${DOC} | sed -n "/^+/p" > ${DIFF_DOC_ALL}.dos 32 dos2unix ${DIFF_DOC_ALL}.dos >/dev/null 2>&1 33 CSUM1=`md5sum ${DIFF_DOC_ALL} | awk '{ print $1 }'` 34 CSUM2=`md5sum ${DIFF_DOC_ALL}.dos | awk '{ print $1 }'` 35 if [ "${CSUM1}" != "${CSUM2}" ]; then 36 echo "ERROR: ${DOC} is DOS encoding. Fix it by: 'dos2unix ${DOC}'" 37 exit 1 38 fi 39 40 TITLE=`sed -n "/^+## /p" ${DIFF_DOC_ALL} | tr -d " +#"` 41 DATE=`sed -n "/^+| 20[0-9][0-9]-/p" ${DIFF_DOC_ALL} | tr -d " " | awk -F "|" '{ print $2 }'` 42 YEAR=`sed -n "/^+| 20[0-9][0-9]-/p" ${DIFF_DOC_ALL} | tr -d " " | awk -F "|" '{ print $2 }' | awk -F "-" '{ print $1 }'` 43 FILE=`sed -n "/^+| 20[0-9][0-9]-/p" ${DIFF_DOC_ALL} | tr -d " " | awk -F "|" '{ print $3 }'` 44 COMMIT=`sed -n "/^+| 20[0-9][0-9]-/p" ${DIFF_DOC_ALL} | tr -d " " | awk -F "|" '{ print $4 }'` 45 SEVERITY=`sed -n "/^+| 20[0-9][0-9]-/p" ${DIFF_DOC_ALL} | tr -d " " | awk -F "|" '{ print $5 }'` 46 END_LINE_3=`tail -n 3 ${DIFF_DOC_ALL} | sed -n '1p'` 47 END_LINE_2=`tail -n 3 ${DIFF_DOC_ALL} | sed -n '2p'` 48 END_LINE_1=`tail -n 3 ${DIFF_DOC_ALL} | sed -n '3p'` 49 HOST_YEAR=`date +%Y` 50 # echo "### ${COMMIT}, ${SEVERITY}, ${TITLE}, ${FILE}" 51 52 # check blank line after Heading 1 53 HEADING_1=`sed -n '1p' ${DOC}` 54 if sed -n '2p' ${DOC} | grep -q [a-z,A-Z] ; then 55 echo "ERROR: ${DOC}: Please add blank line after '${HEADING_1}'" 56 exit 1 57 fi 58 59 # check space 60 if sed -n "/##/p" ${DOC} | grep -v '## [a-z,A-Z]' ; then 61 echo "ERROR: ${DOC}: Please only 1 space between '#' and word" 62 exit 1 63 fi 64 65 # check new content location 66 if ! git show ${ARG_COMMIT} -1 ${DOC} | grep -q 'Release Note' ; then 67 echo "ERROR: ${DOC}: Please add new content at the top but not bottom" 68 exit 1 69 fi 70 71 # check title 72 if grep -Eq '### NEW|### new' ${DIFF_DOC_ALL} ; then 73 echo "ERROR: ${DOC}: Please use '### New'" 74 exit 1 75 fi 76 77 if grep -Eq '### FIXED|### fixed' ${DIFF_DOC_ALL} ; then 78 echo "ERROR: ${DOC}: Please use '### Fixed'" 79 exit 1 80 fi 81 82 # check year 83 if [ "${HOST_YEAR}" != "${YEAR}" ]; then 84 echo "ERROR: ${DOC}: '${DATE}' is wrong, the year should be ${HOST_YEAR}" 85 exit 1 86 fi 87 88 # check TAB before index of 'New' body 89 if grep -q $'\t[0-9]' ${DOC} ; then 90 echo "ERROR: ${DOC}: Don't add TAB before index:" 91 grep $'\t[0-9]' ${DOC} 92 exit 1 93 fi 94 95 # check upper case and line end 96 if [ "${LANGUAGE}" == "EN" ] ; then 97 if grep -q '^[0-9]\. [a-z]' ${DOC} ; then 98 echo "ERROR: ${DOC}: Please use upper case of first word(i.e. \"1. add ..\" => \"1. Add ...\"):" 99 grep '^[0-9]\. [a-z]' ${DOC} 100 exit 1 101 fi 102 103 # check end with '.' 104 if sed -n '/^[0-9]\. [A-Z]/p' ${DOC} | grep -q '[^.]$' ; then 105 echo "ERROR: ${DOC}: Please end line with '.'" 106 grep '^[0-9]\. [A-Z]' ${DOC} | grep '[^.]$' 107 exit 1 108 fi 109 else 110 # check end with '。' 111 if sed -n '/^[0-9]\. /p' ${DOC} | grep -q '[^。]$' ; then 112 echo "ERROR: ${DOC}: Please end line with '。'" 113 grep '^[0-9]\. ' ${DOC} | grep '[^。]$' 114 exit 1 115 fi 116 fi 117 118 # check space after index of 'New' body 119 SUM1=`grep '^[0-9]\.' ${DOC} | wc -l` 120 SUM2=`grep '^[0-9]\.[[:blank:]]' ${DOC} | wc -l` 121 if [ "$SUM1" != "$SUM2" ]; then 122 echo "ERROR: ${DOC}: Please add space after index (e.g: '1. ' but not '1.'):" 123 grep '^+[0-9]\.' ${DIFF_DOC_ALL} 124 exit 1 125 fi 126 127 # check standalone file 128 if ! echo ${FILE} | grep -Eq '\.bin|\.elf|\.img' ; then 129 echo "ERROR: ${DOC}: '${FILE}' missing the file format suffix" 130 exit 1 131 fi 132 if ! echo ${FILE} | grep -q { ; then 133 if ! git log ${ARG_COMMIT} -1 --name-only | grep -q ${FILE}; then 134 echo "ERROR: ${DOC}: '${FILE}' is not updated in this patch" 135 exit 1 136 fi 137 fi 138 139 # check title 140 if [ "${TITLE}" != "${FILE}" ]; then 141 echo "ERROR: ${DOC}: Title '${TITLE}' is not match with '${FILE}'" 142 exit 1 143 fi 144 145 # check commit 146 COMMIT=${COMMIT//#/ } 147 for LIST in ${COMMIT}; do 148 CMT=`echo ${LIST} | cut -d : -f 2` 149 if ! git log ${ARG_COMMIT} -1 | grep -q ${CMT} ; then 150 echo "ERROR: ${DOC}: '${CMT}' is not match in commit message" 151 exit 1 152 fi 153 154 if ! echo ${FILE} | grep -q { ; then 155 if echo ${FILE} | grep -Eq 'spl_|tpl_|bl31_|bl32_|tee_' ; then 156 FILE_PATH=`find -name ${FILE}` 157 if [ -z "${FILE_PATH}" ]; then 158 echo "ERROR: ${DOC}: No ${FILE}" 159 exit 1 160 fi 161 if ! strings ${FILE_PATH} | grep -q ${CMT} ; then 162 echo "ERROR: ${DOC}: ${FILE} is not build from '${CMT}'" 163 exit 1 164 fi 165 fi 166 fi 167 done 168 169 # check severity 170 if [ "${SEVERITY}" != "${SVT_CRITIAL}" -a "${SEVERITY}" != "${SVT_IMPORTANT}" -a "${SEVERITY}" != "${SVT_MODERATE}" ]; then 171 echo "ERROR: ${DOC}: Unknown main severity: ${SEVERITY}" 172 exit 1 173 fi 174 175 # check horizontal line 176 if [ "${END_LINE_2}" != "+------" ]; then 177 echo "ERROR: ${DOC}: Please add horizontal line '------' at the last of new content" 178 exit 1 179 fi 180 if [ "${END_LINE_3}" != "+" ]; then 181 echo "ERROR: ${DOC}: Please add blank line before horizontal line '------'" 182 exit 1 183 fi 184 if [ "${END_LINE_1}" != "+" ]; then 185 echo "ERROR: ${DOC}: Please add blank line after horizontal line '------'" 186 exit 1 187 fi 188 189 # check 'Fixed' content 190 if grep -q "^+### Fixed" ${DIFF_DOC_ALL} ; then 191 awk -v RS='### Fixed' 'END{printf "%s", $0}' ${DIFF_DOC_ALL} > ${DIFF_DOC_FIXED} 192 sed -i "/^$/d" ${DIFF_DOC_FIXED} 193 sed -i "/Index/d" ${DIFF_DOC_FIXED} 194 sed -i "/---/d" ${DIFF_DOC_FIXED} 195 sed -i "/^+$/d" ${DIFF_DOC_FIXED} 196 197 while read LINE 198 do 199 EACH_SEVERITY=`echo "${LINE}" | awk -F "|" '{ print $3 }' | tr -d " "` 200 if [ "${EACH_SEVERITY}" != "${SVT_CRITIAL}" -a "${EACH_SEVERITY}" != "${SVT_IMPORTANT}" -a "${EACH_SEVERITY}" != "${SVT_MODERATE}" ]; then 201 if [ -z "${EACH_SEVERITY}" ]; then 202 echo "ERROR: ${DOC}: No severity found, please use Table to list what you '### Fixed'" 203 else 204 echo "ERROR: ${DOC}: Unknown severity: ${EACH_SEVERITY}" 205 fi 206 exit 1 207 fi 208 209 # echo "## EACH: $EACH_SEVERITY" 210 if [ -z "${TOP_SEVERITY}" ]; then 211 TOP_SEVERITY="${EACH_SEVERITY}" 212 elif [ "${TOP_SEVERITY}" == "${SVT_MODERATE}" ]; then 213 if [ "${EACH_SEVERITY}" == "${SVT_CRITIAL}" -o "${EACH_SEVERITY}" == "${SVT_IMPORTANT}" ]; then 214 TOP_SEVERITY="${EACH_SEVERITY}" 215 fi 216 elif [ "${TOP_SEVERITY}" == "${SVT_IMPORTANT}" ]; then 217 if [ "${EACH_SEVERITY}" == "${SVT_CRITIAL}" ]; then 218 TOP_SEVERITY="${EACH_SEVERITY}" 219 fi 220 fi 221 done < ${DIFF_DOC_FIXED} 222 223 if [ "${SEVERITY}" != "${TOP_SEVERITY}" ]; then 224 echo "ERROR: ${DOC}: Top severity should be '${TOP_SEVERITY}' as it's the highest level of all sub severity" 225 exit 1 226 fi 227 228 # check top severity miss match 229 if [ ! -z ${LAST_SEVERITY} ]; then 230 if [ "${LAST_SEVERITY}" == "普通" -a "${TOP_SEVERITY}" != "moderate" ]; then 231 MISS_MATCH="y" 232 elif [ "${LAST_SEVERITY}" == "重要" -a "${TOP_SEVERITY}" != "important" ]; then 233 MISS_MATCH="y" 234 elif [ "${LAST_SEVERITY}" == "紧急" -a "${TOP_SEVERITY}" != "critical" ]; then 235 MISS_MATCH="y" 236 elif [ "${LAST_SEVERITY}" == "moderate" -a "${TOP_SEVERITY}" != "普通" ]; then 237 MISS_MATCH="y" 238 elif [ "${LAST_SEVERITY}" == "important" -a "${TOP_SEVERITY}" != "重要" ]; then 239 MISS_MATCH="y" 240 elif [ "${LAST_SEVERITY}" == "critical" -a "${TOP_SEVERITY}" != "紧急" ]; then 241 MISS_MATCH="y" 242 fi 243 244 if [ "${MISS_MATCH}" == "y" ]; then 245 echo "ERROR: ${DOC}: top Severity is '${SEVERITY}', while ${LAST_DOC}: top Severity is '${LAST_SEVERITY}'" 246 echo " Available Severity types are: moderate(普通), important(重要), critical(紧急)" 247 exit 1 248 fi 249 fi 250 251 LAST_SEVERITY="${SEVERITY}" 252 LAST_DOC="${DOC}" 253 fi 254} 255 256function check_docs() 257{ 258 if git log ${ARG_COMMIT} -1 --name-only | sed -n '5p' | grep -Eq '^ Revert "' ; then 259 return; 260 fi 261 262 if git log ${ARG_COMMIT} -1 --name-only | grep -Eq '\.bin|\.elf' ; then 263 DOC_CN=`git log ${ARG_COMMIT} -1 --name-only | sed -n "/_CN\.md/p"` 264 DOC_EN=`git log ${ARG_COMMIT} -1 --name-only | sed -n "/_EN\.md/p"` 265 if [ -z "${DOC_CN}" -o -z "${DOC_EN}" ]; then 266 echo "ERROR: Should update CN and EN Release-Note when .bin/elf changed" 267 exit 1 268 fi 269 270 NUM=`git log ${ARG_COMMIT} -1 --name-only | sed -n "/\.md/p" | wc -l` 271 if [ ${NUM} -gt 2 ]; then 272 echo "ERROR: More than 2 release note are updated" 273 exit 1 274 fi 275 276 if ! which dos2unix > /dev/null 2>&1 ; then 277 echo "ERROR: No 'dos2unix'. Fix by: sudo apt-get install dos2unix" 278 exit 1 279 fi 280 281 check_doc CN 282 check_doc EN 283 fi 284 285 rm -f ${DIFF_SUBSET} 286} 287 288function pack_loader_image() 289{ 290 for FILE in `ls ./RKBOOT/*MINIALL*.ini` 291 do 292 if [ "${FILE}" = "./RKBOOT/RK302AMINIALL.ini" -o \ 293 "${FILE}" = "./RKBOOT/RK30BMINIALL.ini" -o \ 294 "${FILE}" = "./RKBOOT/RK30MINIALL.ini" -o \ 295 "${FILE}" = "./RKBOOT/RK310BMINIALL.ini" ]; then 296 continue; 297 fi 298 299 if grep -q '^PATH=img/' ${FILE}; then 300 continue; 301 fi 302 303 echo "Pack loader: ${FILE}" 304 ./tools/boot_merger ${FILE} 305 rm -f *loader*.bin *download*.bin *idblock*.img 306 echo 307 done 308} 309 310function pack_trust_image() 311{ 312 # Pack 32-bit trust 313 for FILE in `ls ./RKTRUST/*TOS*.ini` 314 do 315 if ! test -s ${FILE}; then 316 continue; 317 elif ! grep -q 'TOS' ${FILE}; then 318 continue; 319 elif grep -q '^PATH=img/' ${FILE}; then 320 continue; 321 fi 322 323 echo "Pack trust: ${FILE}" 324 # Parse orignal path 325 TOS=`sed -n "/TOS=/s/TOS=//p" ${FILE}|tr -d '\r'` 326 TOS_TA=`sed -n "/TOSTA=/s/TOSTA=//p" ${FILE}|tr -d '\r'` 327 328 # replace "./tools/rk_tools/" with "./" to compatible legacy ini content of rkdevelop branch 329 TOS=$(echo ${TOS} | sed "s/tools\/rk_tools\//\.\//g") 330 TOS_TA=$(echo ${TOS_TA} | sed "s/tools\/rk_tools\//\.\//g") 331 332 if [ x${TOS_TA} != x -a x${TOS} != x ]; then 333 ./tools/loaderimage --pack --trustos ${TOS} ./trust.img 0x68400000 334 ./tools/loaderimage --pack --trustos ${TOS_TA} ./trust_with_ta.img 0x68400000 335 elif [ ${TOS} ]; then 336 ./tools/loaderimage --pack --trustos ${TOS} ./trust.img 0x68400000 337 elif [ ${TOS_TA} ]; then 338 ./tools/loaderimage --pack --trustos ${TOS_TA} ./trust.img 0x68400000 339 else 340 exit 1 341 fi 342 rm -f trust*.img 343 echo 344 done 345 346 # Pack 64-bit trust 347 for FILE in `ls ./RKTRUST/*TRUST*.ini` 348 do 349 if grep -q '^PATH=img/' ${FILE}; then 350 continue; 351 fi 352 353 echo "Pack trust: ${FILE}" 354 ./tools/trust_merger ${FILE} 355 rm -f trust*.img 356 echo 357 done 358} 359 360function check_dirty() 361{ 362 for FILE in `find -name '*spl*.bin' -o -name '*tpl*.bin' -o -name '*usbplug*.bin' -o -name '*bl31*.elf' -o -name '*bl32*.bin'`; do 363 echo "Checking clean: ${FILE}" 364 if strings ${FILE} | grep '\-dirty ' ; then 365 echo "ERROR: ${FILE} is dirty" 366 exit 1 367 fi 368 done 369} 370 371function check_stripped() 372{ 373 for FILE in `find -name '*bl31*.elf'`; do 374 echo "Checking strip: ${FILE}" 375 INFO=`file ${FILE}` 376 if echo ${INFO} | grep -q "not stripped" ; then 377 echo "ERROR: ${FILE} is not stripped" 378 exit 1 379 fi 380 done 381} 382 383function check_mode() 384{ 385 echo "Checking file mode..." 386 if git whatchanged ${ARG_COMMIT} -1 --oneline | sed -n '/RKBOOT\//p; /RKTRUST\//p; /bin\//p; /doc\//p;' | awk '{ print $2 }' | grep -q 755 ; then 387 git whatchanged ${ARG_COMMIT} -1 --oneline | sed -n '/RKBOOT\//p; /RKTRUST\//p; /bin\//p; /doc\//p;' | grep 755 388 echo "ERROR: Set 644 file permission but not 755." 389 exit 1 390 fi 391} 392 393function finish() 394{ 395 echo "OK, everything is nice." 396 echo 397} 398 399check_mode 400check_docs 401check_dirty 402check_stripped 403pack_loader_image 404pack_trust_image 405finish 406