Devops系列之对接Gerrit的计划与实现（三）-- Java编程实现 ...

农民  论坛元老 | 2025-4-12 02:35:20 | 显示全部楼层 | 阅读模式
打印 上一主题 下一主题
楼主

主题 1580|帖子 1580|积分 4740

一、配景

上文讲述了怎样使用shell下令实现创建gerrit项目，本文介绍怎样使用java语言编程实现。
二、java语言实现

1、引入jar包

  1.         <dependency>
  2.             <groupId>com.urswolfer.gerrit.client.rest</groupId>
  3.             <artifactId>gerrit-rest-java-client</artifactId>
  4.             <version>0.9.3</version>
  5.         </dependency>
复制代码
核心类GroupApiRestClient.java

2、配置

  1. project:
  2.   gerrit:
  3.     host: http://192.168.5.60:8080
  4.     login: admin
  5.     password: 123456
  6.     # 负责人
  7.     groupOwnerId: 34dd8f718972d73c9a3474b2sfad2d52x2cf596f
复制代码
3、实现类



  • 配置类GerritProperties.java
  2. import lombok.Data;
  3. import org.springframework.boot.context.properties.ConfigurationProperties;
  4. import org.springframework.cloud.context.config.annotation.RefreshScope;
  5. import org.springframework.context.annotation.Configuration;
  7. /**
  8. * gerrit配置
  9. *
  10. * @author xxx
  11. */
  12. @RefreshScope
  13. @Data
  14. @Configuration
  15. @ConfigurationProperties(prefix = "project.gerrit")
  16. public class GerritProperties {
  17.     /**
  18.      * 地址
  19.      */
  20.     private String host;
  22.     /**
  23.      * 用户名
  24.      */
  25.     private String login;
  27.     /**
  28.      * 密码
  29.      */
  30.     private String password;
  32.     /**
  33.      * 所属的组ID
  34.      */
  35.     private String groupOwnerId;
  36. }
复制代码


  • 总体实现
  2. import com.google.common.collect.Lists;
  3. import com.google.common.collect.Maps;
  4. import com.google.gerrit.extensions.api.GerritApi;
  5. import com.google.gerrit.extensions.api.access.AccessSectionInfo;
  6. import com.google.gerrit.extensions.api.access.PermissionInfo;
  7. import com.google.gerrit.extensions.api.access.PermissionRuleInfo;
  8. import com.google.gerrit.extensions.api.access.ProjectAccessInput;
  9. import com.google.gerrit.extensions.api.groups.GroupInput;
  10. import com.google.gerrit.extensions.api.projects.ProjectApi;
  11. import com.google.gerrit.extensions.api.projects.ProjectInput;
  12. import com.google.gerrit.extensions.client.SubmitType;
  13. import com.google.gerrit.extensions.common.GroupBaseInfo;
  14. import com.google.gerrit.extensions.common.GroupInfo;
  15. import com.google.gerrit.extensions.common.ProjectInfo;
  16. import com.urswolfer.gerrit.client.rest.GerritAuthData;
  17. import com.urswolfer.gerrit.client.rest.GerritRestApiFactory;
  18. import com.urswolfer.gerrit.client.rest.http.HttpStatusException;
  19. import lombok.extern.slf4j.Slf4j;
  20. import org.springframework.beans.factory.annotation.Autowired;
  21. import org.springframework.stereotype.Service;
  23. import javax.annotation.PostConstruct;
  24. import java.util.Map;
  26. /**
  27. * gerrit api
  28. * <p>
  29. * 1.创建负责人组
  30. * 2.创建开发人组
  31. * 3.创建工程
  32. * 4.设置权限
  33. * </p>
  34. *
  35. * @author xxx
  36. */
  37. @Slf4j
  38. @Service
  39. public class GerritService {
  41.     private GerritRestApiFactory gerritRestApiFactory;
  42.     private GerritAuthData.Basic authData;
  43.     private GerritApi gerritApi;
  45.     @Autowired
  46.     private GerritProperties gerritProperties;
  48.     @PostConstruct
  49.     public void init() {
  50.         gerritRestApiFactory = new GerritRestApiFactory();
  51.         authData = new GerritAuthData.Basic(gerritProperties.getHost(), gerritProperties.getLogin(), gerritProperties.getPassword());
  52.         gerritApi = gerritRestApiFactory.create(authData);
  53.     }
  55.     /**
  56.      * 新建gerrit项目及组、权限
  57.      *
  58.      * @param group       项目组
  59.      * @param projectName 项目名称，比如：root/watch-answering-server
  60.      */
  61.     public void create(String group, String projectName) {
  62.         String ownerGroupName = projectName + "-owner";
  63.         String devGroupName = projectName + "-dev";
  65.         try {
  66.             // 创建负责人分组
  67.             GroupBaseInfo ownerGroupBaseInfo = this.createGroup(ownerGroupName, gerritProperties.getGroupOwnerId());
  68.             String ownerGroupId = ownerGroupBaseInfo.id;
  69.             log.info("负责人分组ID:{}", ownerGroupId);
  71.             // 创建开发者分组
  72.             GroupBaseInfo devGroupBaseInfo = this.createGroup(devGroupName, ownerGroupId);
  73.             String devGroupId = devGroupBaseInfo.id;
  74.             log.info("开发者分组ID:{}", devGroupId);
  76.             // 创建工程
  77.             ProjectInfo projectInfo = this.createProject(projectName, ownerGroupName);
  78.             log.info("项目的详情是:{}", JsonUtils.toJsonString(projectInfo));
  80.             // 赋权限项
  81.             if (null != projectInfo) {
  82.                 this.setAccess(projectName, ownerGroupId, devGroupId);
  83.             }
  84.         } catch (Exception e) {
  85.             log.error("创建组、工程、赋权出现了异常， projectName={}", projectName, e);
  86.         }
  87.     }
  88. }
复制代码


  • 创建组的实当代码
  1.     /**
  2.      * 创建组.
  3.      *
  4.      * @param groupName 组名
  5.      * @param ownerId   所属组
  6.      * @return
  7.      * @throws Exception
  8.      */
  9.     private GroupBaseInfo createGroup(String groupName, String ownerId) throws Exception {
  10.         GroupBaseInfo groupBaseInfo = new GroupBaseInfo();
  12.         GroupInfo groupInfo;
  13.         try {
  14.             groupInfo = gerritApi.groups().id(groupName).get();
  15.             log.warn("组{}已存在，请勿重复创建", groupName);
  16.         } catch (HttpStatusException e) {
  17.             // 不存在，则重新创建
  19.             GroupInput groupInput = new GroupInput();
  20.             groupInput.name = groupName;
  21.             groupInput.description = groupName;
  22.             groupInput.ownerId = ownerId;
  23.             groupInput.visibleToAll = false;
  25.             groupInfo = gerritApi.groups().create(groupInput).get();
  26.             if (null == groupInfo) {
  27.                 throw new IllegalArgumentException("创建组出现异常");
  28.             }
  30.             log.info("组创建成功, groupInput={}", JsonUtils.toJsonString(groupInput));
  32.             groupBaseInfo.id = groupInfo.id;
  33.             groupBaseInfo.name = groupInfo.name;
  34.             return groupBaseInfo;
  35.         }
  37.         groupBaseInfo.id = groupInfo.id;
  38.         groupBaseInfo.name = groupInfo.name;
  39.         return groupBaseInfo;
  40.     }
复制代码


  • 创建工程的实当代码
  1. /**
  2.      * 新建工程.
  3.      *
  4.      * @param projectName    工程名
  5.      * @param ownerGroupName 所属组
  6.      * @return
  7.      * @throws Exception
  8.      */
  9.     private ProjectInfo createProject(String projectName, String ownerGroupName) throws Exception {
  10.         try {
  11.             ProjectApi projectApi = gerritApi.projects().name(projectName);
  13.             ProjectInfo projectInfo = projectApi.get();
  14.             if (null != projectInfo) {
  15.                 log.warn("工程{}已存在，请勿重复创建", projectName);
  16.                 return projectInfo;
  17.             }
  18.         } catch (Exception e) {
  19.             ProjectInput request = new ProjectInput();
  20.             request.name = projectName;
  21.             request.description = projectName;
  22.             request.submitType = SubmitType.INHERIT;
  23.             request.owners = Lists.newArrayList(ownerGroupName);
  25.             log.info("新建gerrit工程成功, request={}", JsonUtils.toJsonString(request));
  27.             return gerritApi.projects().create(request).get();
  28.         }
  30.         return null;
  31.     }
复制代码


  • 赋权限的实当代码
  2.    
  3.     /**
  4.      * 赋权限.
  5.      *
  6.      * @param projectName  项目名称
  7.      * @param ownerGroupId 负责人组ID
  8.      * @param devGroupId   开发组ID
  9.      * @throws Exception
  10.      */
  11.     private void setAccess(String projectName, String ownerGroupId, String devGroupId) throws Exception {
  12.         try {
  13.             ProjectApi projectApi = gerritApi.projects().name(projectName);
  15.             ProjectAccessInput projectAccessInput = new ProjectAccessInput();
  16.             Map<String, AccessSectionInfo> addMap = Maps.newHashMap();
  17.             addMap.put("refs/*", buildAccessSectionInfo(ownerGroupId, devGroupId));
  18.             addMap.put("refs/tags/*", buildTagsAccessSectionInfo(devGroupId));
  19.             addMap.put("refs/heads/*", buildHeadsAccessSectionInfo(ownerGroupId, devGroupId));
  21.             log.info("权限列表是:{}", JsonUtils.toJsonString(addMap));
  23.             projectAccessInput.add = addMap;
  25.             projectApi.access(projectAccessInput);
  26.         } catch (HttpStatusException e) {
  27.             log.error("赋权限出现异常, projectName={}, ownerGroupId={}, devGroupId={}", projectName, ownerGroupId, devGroupId, e);
  28.         }
  29.     }
  32.     private AccessSectionInfo buildAccessSectionInfo(String ownerGroupId, String devGroupId) {
  33.         AccessSectionInfo accessSectionInfo = new AccessSectionInfo();
  35.         Map<String, PermissionInfo> permissions = Maps.newHashMap();
  37.         permissions.put("read", buildPermissionInfo("", devGroupId));
  38.         permissions.put("label-Code-Review", buildReviewPermissionInfo("Code-Review", ownerGroupId, devGroupId));
  39.         permissions.put("label-Verified", buildReviewPermissionInfo("Verified", ownerGroupId, devGroupId));
  40.         permissions.put("labelAs-Verified", buildReviewPermissionInfo("Verified", ownerGroupId, devGroupId));
  41.         permissions.put("forgeServerAsCommitter", buildPermissionInfo("", ownerGroupId, devGroupId));
  42.         permissions.put("forgeAuthor", buildPermissionInfo("", ownerGroupId, devGroupId));
  43.         permissions.put("removeReviewer", buildPermissionInfo("", ownerGroupId, devGroupId));
  44.         permissions.put("delete", buildPermissionInfo("", ownerGroupId));
  45.         permissions.put("viewPrivateChanges", buildPermissionInfo("", ownerGroupId));
  46.         permissions.put("createTag", buildPermissionInfo("", ownerGroupId));
  47.         permissions.put("createSignedTag", buildPermissionInfo("", ownerGroupId));
  48.         permissions.put("editHashtags", buildPermissionInfo("", ownerGroupId));
  49.         permissions.put("deleteOwnChanges", buildPermissionInfo("", devGroupId));
  50.         permissions.put("editTopicName", buildPermissionInfo("", devGroupId));
  51.         permissions.put("abandon", buildPermissionInfo("", devGroupId));
  52.         permissions.put("push", buildPermissionInfo("", devGroupId));
  53.         permissions.put("addPatchSet", buildPermissionInfo("", devGroupId));
  54.         permissions.put("forgeCommitter", buildPermissionInfo("", devGroupId));
  55.         permissions.put("pushMerge", buildPermissionInfo("", devGroupId));
  56.         permissions.put("rebase", buildPermissionInfo("", devGroupId));
  57.         permissions.put("submit", buildPermissionInfo("", ownerGroupId));
  58.         permissions.put("submitAs", buildPermissionInfo("", ownerGroupId));
  60.         accessSectionInfo.permissions = permissions;
  62.         return accessSectionInfo;
  63.     }
  65.     private AccessSectionInfo buildTagsAccessSectionInfo(String devGroupId) {
  66.         AccessSectionInfo accessSectionInfo = new AccessSectionInfo();
  68.         Map<String, PermissionInfo> permissions = Maps.newHashMap();
  70.         permissions.put("createSignedTag", buildPermissionInfo("", devGroupId));
  71.         permissions.put("createTag", buildPermissionInfo("", devGroupId));
  73.         accessSectionInfo.permissions = permissions;
  75.         return accessSectionInfo;
  76.     }
  78.     private AccessSectionInfo buildHeadsAccessSectionInfo(String ownerGroupId, String devGroupId) {
  79.         AccessSectionInfo accessSectionInfo = new AccessSectionInfo();
  81.         Map<String, PermissionInfo> permissions = Maps.newHashMap();
  83.         permissions.put("forgeCommitter", buildPermissionInfo("", devGroupId));
  84.         permissions.put("label-Code-Review", buildReviewPermissionInfo("Code-Review", ownerGroupId, devGroupId));
  85.         permissions.put("forgeAuthor", buildPermissionInfo("", devGroupId));
  86.         permissions.put("editTopicName", buildPermissionInfo("", devGroupId));
  87.         permissions.put("create", buildPermissionInfo("", devGroupId));
  88.         permissions.put("push", buildPermissionInfo("", devGroupId));
  89.         permissions.put("submit", buildPermissionInfo("", ownerGroupId));
  91.         accessSectionInfo.permissions = permissions;
  93.         return accessSectionInfo;
  94.     }
  96.     private PermissionInfo buildPermissionInfo(String label, String groupId) {
  97.         PermissionInfo permissionInfo = new PermissionInfo(label, false);
  99.         Map<String, PermissionRuleInfo> rules = buildRules(groupId);
  100.         permissionInfo.rules = rules;
  102.         return permissionInfo;
  103.     }
  105.     private PermissionInfo buildPermissionInfo(String label, String ownerGroupId, String devGroupId) {
  106.         PermissionInfo permissionInfo = new PermissionInfo(label, false);
  108.         Map<String, PermissionRuleInfo> rules = buildRules(ownerGroupId, devGroupId);
  109.         permissionInfo.rules = rules;
  111.         return permissionInfo;
  112.     }
  114.     private PermissionInfo buildReviewPermissionInfo(String label, String ownerGroupId, String devGroupId) {
  115.         PermissionInfo permissionInfo = new PermissionInfo(label, false);
  117.         Map<String, PermissionRuleInfo> rules = buildReviewRules(ownerGroupId, devGroupId);
  118.         permissionInfo.rules = rules;
  120.         return permissionInfo;
  121.     }
  123.     private Map<String, PermissionRuleInfo> buildRules(String groupId) {
  124.         Map<String, PermissionRuleInfo> rules = Maps.newHashMap();
  126.         PermissionRuleInfo permissionRuleInfo = buildPermissionRuleInfo();
  127.         rules.put(groupId, permissionRuleInfo);
  129.         return rules;
  130.     }
  132.     private Map<String, PermissionRuleInfo> buildRules(String ownerGroupId, String devGroupId) {
  133.         Map<String, PermissionRuleInfo> rules = Maps.newHashMap();
  135.         PermissionRuleInfo permissionRuleInfo = buildPermissionRuleInfo();
  136.         rules.put(ownerGroupId, permissionRuleInfo);
  137.         rules.put(devGroupId, permissionRuleInfo);
  139.         return rules;
  140.     }
  142.     private Map<String, PermissionRuleInfo> buildReviewRules(String ownerGroupId, String devGroupId) {
  143.         Map<String, PermissionRuleInfo> rules = Maps.newHashMap();
  145.         PermissionRuleInfo permissionRuleInfo = buildPermissionRuleInfo();
  146.         permissionRuleInfo.max = 2;
  147.         permissionRuleInfo.min = -2;
  148.         rules.put(ownerGroupId, permissionRuleInfo);
  150.         permissionRuleInfo = buildPermissionRuleInfo();
  151.         permissionRuleInfo.max = 1;
  152.         permissionRuleInfo.min = -1;
  153.         rules.put(devGroupId, permissionRuleInfo);
  155.         return rules;
  156.     }
  158.     private PermissionRuleInfo buildPermissionRuleInfo() {
  159.         PermissionRuleInfo permissionRuleInfo = new PermissionRuleInfo(PermissionRuleInfo.Action.ALLOW, false);
  161.         return permissionRuleInfo;
  162.     }
复制代码
三、测试

  1.     @Autowired
  2.     private GerritService gerritService;
  4.     @ApiOperation(value = "新建gerrit工程")
  5.     @PostMapping(value = "/api/gerrit/create/{projectName}")
  6.     public ResponseEntity<?> createProject(@NotNull @PathVariable String projectName) {
  8.         // 新建gerrit工程
  9.         gerritService.create("", "root/" + projectName);
  11.         return ResponseEntity.ok("SUCCESS");
  12.     }
复制代码
四、写在最后的话

   制止到现在，对接gerrit的计划与具体实现均已完整梳理，后文将解决代码提交的消息提醒。
  本文只实现了主动创建gerrit项目以及权限项，创建了owner组和dev组。由于缺少信息–每个组里应该添加哪些人。
后期将实现给组里加人的操纵。
也就是说，gerrit工程创建后，申请新项目的人，假如不在上面的owner组内，你会看不到已创建好的gerrti工程！！
不要慌，让owner组里的人员把你参加进组里。

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。

本帖子中包含更多资源

您需要 登录 才可以下载或查看，没有账号？立即注册

x
回复

使用道具 举报

0 个回复

倒序浏览
返回列表

快速回复

高级模式
B Color Image Link Quote Code Smilies
您需要登录后才可以回帖 登录 or 立即注册

本版积分规则

农民

论坛元老
这个人很懒什么都没写!

楼主热帖

标签云

AI 运维 CIO 存储 服务器
微信订阅号
微信服务号
微信客服
小程序
H5
关于我们 商务合作 网站地图
©Copyright 2022-2024 杭州祥升科技有限公司 版权所有 浙ICP备20004199号
快速回复 返回顶部 返回列表