build-github-pull-request

Build GitHub Pull Request in Hyper_ Container with Jenkins

• 1.Summary
  • 1.1 Prerequisite
  • 1.2 GitHub Repo
  • 1.3 Workflow
• 2.Run Jenkins Server
• 3. Access Jenkins Web UI
• 4.Config Jenkins
  • 4.1 Config hyper-slaves-plugin
  • 4.2 Config GitHub Pull Request Builder Plugin
    • 4.2.1 Create API Token
    • 4.2.2 Config other options
• 5.Config Job
  • 5.1 General
  • 5.2 Source Code Management
  • 5.3 Build Triggers
  • 5.4 Build Step
    • Build script
  • 5.5 Post-build Actions
  • 5.6 Save Job
• 6. Trigger Build by GitHub Webhook
• 7. Build Result
  • 7.1 Jenkins Log
    • Build History
    • Build Status
    • Console Output
  • 7.2 GitHub status
    • 1) Set build status to "pending" on GitHub commit
    • 2) Set build status on GitHub commit
    • 3) Build status on each commit
• 8 Problem
  • 8.1 Doesn’t support build in parallel

1.Summary

1.1 Prerequisite

• GitHub Account
• Hyper_ Credential
• Hyper client
  • Installed on localhost (it’s used to run Jenkins Server in Hyper_ Cloud)
• Docker image
  • hyperhq/hyperkins (pre-built Jenkins server image)
    • hyper client
    • GitHub Pull Request Builder Plugin
    • Hyper_ Slaves Plugin
    • Other Recommended Plugin(git, ssh-slaves, credentials-binding, gradle,...)

1.2 GitHub Repo

• Main repo(build PR)
  • https://github.com/Jimmy-Xu/example
• Cloned repo(create PR)
  • https://github.com/cocobjcn/example

1.3 Workflow

• Commit the change to cloned repo.
• Create PR via cloned repo.
• Jenkins job(for Main Repo) will be triggered via GitHub Webhook.
• Jenkins build PR automatically.
• Jenkins will set build status of PR on GitHub.

2.Run Jenkins Server

//start Jenkins Server container
$ hyper run --name jenkins-server \
  -d -P \
  -v jenkins-data:/var/jenkins_home \
  hyperhq/hyperkins

//add public ip to container
$ FIP=$(hyper fip allocate 1)
$ hyper fip attach $FIP jenkins-server

3. Access Jenkins Web UI

Open http://$FIP:8080 in Web Browser.

The default admin account is admin/nimda.

If you want to customize the admin account, please see this

4.Config Jenkins

4.1 Config hyper-slaves-plugin

(Menu) Manage Jenkins ->  Configure System -> Hyper Config
  -> Input "Hyper_ Access Key" and "Hyper_ Secret Key"
  -> Click "Save credential" button
  -> Click "Test connection to Hyper_" button

4.2 Config GitHub Pull Request Builder Plugin

4.2.1 Create API Token

(Menu) Manage Jenkins ->  Configure System -> GitHub Pull Request Builder
  -> Click "Create API Token" button
  -> Input "Username temp" and "Password temp"  (GitHub account to create token)
  -> Click "Create Token" button

-> Click global "Save" button of "Config System"

Goto https://github.com/settings/tokens.

A personal access token named Jenkins GitHub Pull Request Builder will be created in GitHub.

This token is used to create GitHub Webhook and update status of each PR on GitHub

4.2.2 Config other options

(Menu) Manage Jenkins ->  Configure System -> GitHub Pull Request Builder
  -> Shared secret  : Secret of GitHub Webhook.
  -> Credentials    : Select GitHub auto generated token credentials.

5.Config Job

Create a job of Freestyle project.

5.1 General

• Check Run the build inside Hyper_ container
  • Docker Image
    • hyperhq/jenkins-slave-golang:1.7-centos (Dockerfile)
• GitHub project
  • Project URL
    • https://github.com/Jimmy-Xu/example

5.2 Source Code Management

Repository URL: https://github.com/Jimmy-Xu/example

Refspec：+refs/pull/*:refs/remotes/origin/pr/*

Branch Specifer：${sha1}

[Optional]
To build PR manually，just add a "String Parameter" like this：

5.3 Build Triggers

• GitHub API credentials
  • Be Configured in Jenkins global config
• Use GitHub Webhook for build triggering
  • Trigger Build via GitHub Webhook
  • This option will disable cron-based polling
• Whitelist
  • People who submit pull requests can have their pull requests automatically build.
  • If you don’t add people to the white list you will need to tell Jenkins to build the PR.

5.4 Build Step

Add two build step:

• Set build status to pending on GitHub commit
• Execute shell

Build script

  set +x

  START_TIME=$(date "+%F %T %z")
  START_TS=$(date "+%s")

  #################################
  echo "------------------------------------------------" > result.txt
  cat /proc/cpuinfo | grep -E '(processor|model name|cpu cores)' >> result.txt
  echo "-------------------------------------" >> result.txt
  cat /proc/meminfo | grep ^Mem >> result.txt
  echo "-------------------------------------" >> result.txt
  cat result.txt
  #################################


  echo "----- prepare -----"
  export GOPATH=$WORKSPACE/../gopath
  mkdir -p $GOPATH $GOPATH/src/github.com/golang
  if [ ! -L $GOPATH/src/github.com/golang/example ];then
    ln -s $WORKSPACE $GOPATH/src/github.com/golang/example
  fi

  echo "----- start unit test -----"
  cd $WORKSPACE/stringutil
  go test -v

  echo "----- start compile -----"
  cd $WORKSPACE/hello
  go build

  RLT=$(./hello)
  if [ "$RLT" == "Hello, Go examples!" ];then #centos use bash
    echo OK
  else
    echo Failed
    exit 1
  fi

  echo "----- compress -----"
  tar czvf hello.tar.gz hello

  #################################
  END_TIME=$(date "+%F %T %z")
  END_TS=$(date "+%s")
  echo "--------------------------------"
  echo "Step Start Time:${START_TIME}"
  echo "Step End Time:${END_TIME}"
  echo "Step duration: $((END_TS-START_TS))"

5.5 Post-build Actions

5.6 Save Job

After the above Jenkins Job was saved, a GitHub Webhook will be created automatically.

(https://github.com/Jimmy-Xu/example/settings/hooks)

6. Trigger Build by GitHub Webhook

To build PR by GitHub Webhook:

1. Commit the change to cloned repo https://github.com/cocobjcn/example .
2. Create Pull Request in cloned repo. Then, Jenkins Job build will be triggered via GitHub Webhook automatically.

Note: For test purpose, you just need to create one Pull Request. You can Close and Re-Open the PR, then a new job build will be triggered again.

7. Build Result

7.1 Jenkins Log

Build History

Build Status

Console Output

7.2 GitHub status

Jenkins will set build status of PR on GitHub.

1) Set build status to "pending" on GitHub commit

2) Set build status on GitHub commit

Click the Details link will jump to Jenkins build history.

3) Build status on each commit

8 Problem

8.1 Doesn’t support build in parallel