ci: Enable travis build result comment in pull request (#59)

* travis: when pull requests, send the wrong result as a comment to github (#54)

* travis: get the result of the make linkcheck and then change it's format

Signed-off-by: Jingru Wang <[email protected]>

* travis: change the comment header

Signed-off-by: Jingru Wang <[email protected]>

* travis: when use cur_core,specify it in job(gitlab)

Signed-off-by: Jingru Wang <[email protected]>

* travis: add job name when send comment (#56)

* travis: add job name when send comment

Signed-off-by: Jingru Wang <[email protected]>

* travis: trigger a build

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

* travis: use html element pre to ensure line breaks

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

Author: fanghuaqi

.ci/before_install.sh

@@ -29,4 +29,5 @@ fi
     pip install PrettyTable || die
     pip install colorama || die
     pip install configparser || die
+    pip install requests || die
 }

.ci/build.py

@@ -2,6 +2,7 @@
 import json
 import os
 import sys
+import requests
 from prettytable import PrettyTable
 from colorama import Fore, Back, Style
 from configparser import ConfigParser
@@ -374,14 +375,32 @@ def get_expected_result(expected_file, app_path, board, bd_ver):
     return result
 
 
+def send_pull_request_comment(columns, results):
+    job = os.environ.get("NAME")
+    comment_job = "## " + job + "\n"
+    if len(results)>0:
+        head = "|".join(columns) + "\n"
+        table_format =  "|".join(["---"]*len(columns)) + "\n"
+        table_head =head +table_format
+        comments = ""
+        comment = ""
+        for result in results:
+            for k in result:
+                comment += (k.replace(Fore.RED, "")).replace("\n", "<br>") +" |"
+            comment = comment.rstrip("|") + "\n"
+            comments += comment
+        comment_on_pull_request(comment_job + table_head + comments)
+
+
 def show_results(results, expected=None):
-    columns = ['TOOLCHAIN', 'APP', "TOOLCHAIN_VER", 'CONF', 'PASS']
+    columns = ["TOOLCHAIN_VER", 'TOOLCHAIN', 'APP', 'CONF', 'PASS']
     failed_pt = PrettyTable(columns)
     failed_results = []
     success_results = []
     expected_results = None
     success_pt = PrettyTable(columns)
     expected_pt = PrettyTable(columns)
+    
     for result in results:
         status = result.pop("status")
         if status != 0:
@@ -398,6 +417,7 @@ def show_results(results, expected=None):
 
     if expected is not None:
         expected_results = failed_results
+        send_pull_request_comment(columns, expected_results)
         for result in expected_results:
             if len(result) > 0:
                 expected_pt.add_row(result)
@@ -413,6 +433,8 @@ def show_results(results, expected=None):
                 success_pt.add_row(result)
         print Fore.GREEN + "Successfull results"
         print success_pt
+        
+        
         print Style.RESET_ALL
         sys.stdout.flush()
 
@@ -427,6 +449,7 @@ def show_results(results, expected=None):
 
         print Fore.RED + "Failed result:"
         print failed_pt
+        
         print Style.RESET_ALL
         sys.stdout.flush()
 
@@ -529,14 +552,26 @@ def build_makefiles_project(config):
             diff_expected_differents[app_path] = copy.deepcopy(expected_different[app_path])
 
     print "There are {} projects, and they are compiled for {} times".format(app_count, count)
-    results_list = build_result_combine_tail(apps_results)
+    results_list = copy.deepcopy(build_result_combine_tail(apps_results))
     show_results(results_list)
     expected_differents_list = build_result_combine_tail(diff_expected_differents)
     show_results(expected_differents_list, expected=True)
 
     return applications_failed, diff_expected_differents
 
 
+def comment_on_pull_request(comment):
+    pr_number = os.environ.get("TRAVIS_PULL_REQUEST")
+    slug =  os.environ.get("TRAVIS_REPO_SLUG")
+    token = os.environ.get("GH_TOKEN")
+    if all([pr_number, slug, token, comment]):
+        url = 'https://api.github.com/repos/{slug}/issues/{number}/comments'.format(
+            slug=slug, number=pr_number)
+        response = requests.post(url, data=json.dumps({'body': comment}),
+            headers={'Authorization': 'token ' + token})
+        return response.json()
+
+
 def get_options_parser():
     configs = dict()
     toolchainlist = ["gnu", "mw"]
@@ -590,4 +625,6 @@ def get_options_parser():
     else:
         print "these applications failed with some configuration: "
         print expected_differents.keys()
+        comment = "applications failed with some configuration: \n" + "\n".join(expected_differents.keys())
+        comment_on_pull_request(comment)
         sys.exit(1)

.ci/deploy_doc.sh

@@ -25,6 +25,13 @@ make html &> build_html.log || { tail -n 100 build_html.log ; die "Build sphinx
 # Check if this is a pull request
 if [ "$TRAVIS_PULL_REQUEST" != "false" ] ; then
     echo "Don't push built docs to gh-pages for pull request "
+    
+    make linkcheck -k 2>&1
+    COMMENT_CONTENT=$(sed 's/$/&<br>/g' build/linkcheck/output.txt)
+    COMMENT_HEAD="# Sphinx link check result \n***********************\n<pre>"
+    COMMENT_TAIL="</pre>"
+    COMMENT="${COMMENT_HEAD}${COMMENT_CONTENT}${COMMENT_TAIL}"
+    bash -c "$COMMENTS"
     exit 0
 fi
 

.gitlab-ci.yml

@@ -4,7 +4,6 @@ variables:
   PIP_CACHE_DIR: "$CI_PROJECT_DIR/.cache"
   OSP_ROOT: "."
   TOOLCHAIN: "gnu"
-  CUR_CORE: "none"
   TOOLCHAIN_VER: "2017.09"
   EXPECTED: ".ci/expected.ini"
   PARALLEL: ""

.travis.yml

@@ -15,6 +15,13 @@ env:
       "context": "travis-ci/$NAME",
       "target_url": "https://travis-ci.org/$TRAVIS_REPO_SLUG/jobs/$TRAVIS_JOB_ID"
       }\nDATA'
+      
+      COMMENT=none
+      COMMENTS=$'curl -so/dev/null --user "$EMBARC_BOT" --request POST
+      https://api.github.com/repos/$TRAVIS_REPO_SLUG/issues/$TRAVIS_PULL_REQUEST/comments
+      --data @- << DATA\n{
+      "body": "$COMMENT"
+      }\nDATA'
 
 cache:
   pip: true
@@ -28,7 +35,7 @@ branches:
 
 before_install:
   - bash .ci/before_install.sh
-  # setup git config
+  # setup git config 
   - git config --global user.name "embARC Automated Bot"
   - git config --global user.email "[email protected]"