使用Gitlab的CI对SpringBoot Maven项目测试、部署流程

环境准备

操作系统：CentOS 7.x
Docker版本：1.13.x
gitlab-runner镜像：docker.io/gitlab/gitlab-runner:latest
maven镜像：docker.io/maven:3.3-jdk-8
SpringBoot版本2.1.4

申请Gitlab官网账号

官网地址
注册账号、创建Git仓库就不说了

CI集成过程

准备gitlab-runner

docker pull gitlab/gitlab-runner:latest

docker run -d --name gitlab-runner --restart always \
-v /var/run/docker.sock:/var/run/docker.sock \
-v /var/build_cache:/cache \
gitlab/gitlab-runner:latest

注意 -v /var/run/docker.sock:/var/run/docker.sock 不能少，因为我executor用的是docker

接下来要注册gitlab-runner

进入image

docker exec -it gitlab-runner /bin/bash

执行注册

gitlab-runner register -n \
  --url https://gitlab.com/ \
  --registration-token pAgjBUc7y9fKCi_AzxyE \
  --executor docker \
  --output-limit 81920 \
  --description "Gitlab Runner" \
  --docker-image "maven:3.3-jdk-8" \
  --docker-volumes /var/run/docker.sock:/var/run/docker.sock

这里有几个参数要解释一下，
--url：gitlab ci的服务器地址；
--registration-token：gitlab你的项目的citoken；
--executor：制定runner的执行方式，有很多种，shell、docker等等，我用的docker；
--output-limit：构建过程的输出的日志大小限制；
--description：runner描述；
--docker-image：指定构建的镜像环境；
--docker-volumes：runner就是通过这个路径使用宿主机docker构建

url，registration-token是从哪来的呢？
先到gitlab -> 你的项目 -> Settings -> CI/CD -> 展开Runners，你就会看到如下图

gitlab-runners.jpg

注册完runner后，再来这个CI/CD的Runners页面，你会发现它已经关联上了，如图

gitlab-runner-activatedd.jpg

注意还要给runner设置一个tag，点击名称 GfXt9GLr 后面的修改按钮，进去后设置tags字段，保存，我这里设置为xgsh

编写 .gitlab-ci.yml 文件

注意，这里就用到了设置的tag字段；
在gitlab项目根目录下，新建文件.gitlab-ci.yml，内容如下

image: maven:3.3-jdk-8
stages:
  - test
  - deploy
test_job:
  stage: test
  script:
    - pwd
    - mvn clean
    - mvn compile
    - mvn test
  tags:
    - xgsh
deploy_job:
  stage: deploy
  script:
    - curl http://xxxxx/hooks/xgsh
  only:
    - master

我的做法是，分两个stages，当push代码到master分支后，先执行test，如果test通过，然后执行deploy

编写 Dockerfile 文件

在gitlab项目根目录下，新建文件Dockerfile，内容如下

FROM maven:3.3-jdk-8

MAINTAINER [email protected]

USER root

COPY . /root/xgsh-api
RUN rm -rf /root/xgsh-api/.git
RUN rm -rf /root/xgsh-api/Dockerfile

WORKDIR /root/xgsh-api

ENV TZ=Asia/Shanghai
RUN ln -snf /usr/share/zoneinfo/$TZ /etc/localtime && echo $TZ > /etc/timezone

VOLUME ["/root/.m2"]
RUN mvn clean package -Dmaven.test.skip=true

EXPOSE 8080

CMD ["java", "-jar", "/root/xgsh-api/target/xgsh-api-1.0-SNAPSHOT.jar"]

这样，当有新的push到master分支，立刻就触发ci，在项目的CI/CD菜单，可以看到pipelines如下图

gitlab-runner-status.jpg

上面的是test成功、deploy也成功
下面的是test失败、deploy跳过

Deploy到测试服务器

上面的deploy脚本写的是

deploy_job:
  stage: deploy
  script:
    - curl http://xxxxx/hooks/xgsh

就是说，当push到master分支的代码通过测试后，就会触发deploy阶段，执行脚本curl http://xxxxx/hooks/xgsh，这个地址是一个webhook，配置如下
webhook配置文件hooks.yaml

- id: xgsh
  execute-command: /root/webhook/pull-and-redeploy.sh
  command-working-directory: /root/xgsh
  response-message: Start to redeploy!
  response-headers:
  - name: Access-Control-Allow-Origin
    value: '*'

脚本pull-and-redeploy.sh

#!/bin/bash

kill -9 `cat app.pid`
rm -rf app.pid
git reset --hard head
git pull
mvn clean package -Dmaven.test.skip=true
java -jar ./target/xgsh-api-1.0-SNAPSHOT.jar > web.log 2>&1 & echo "$!" > app.pid
echo 'redeploy done.'

这样以后只要push代码，就自动测试，然后运行最新的代码，很方便测试

总结

配置gitlab-runner的docker容器，进入容器注册runner
配置gitlab自己项目runner的tag
编写.gitlab-ci.yml、Dockerfile
流程：push代码到master分支，触发pipelines的test_job，测试通过后，执行deploy_job，通过webhook触发服务器端执行脚本pull-and-redeploy.sh，然后git pull更新代码，java -jar运行SpringBoot应用