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