blob: 61ff48a525f8823e6a13a6e16f7602411577b6d0 [file] [log] [blame]
Ruslan Gustomiasov5d131b62019-08-21 11:51:26 +02001package com.mirantis.mk
2
3/**
4 *
5 * Functions to work with Helm
6 *
7 */
8
9/**
10 * Build index file for helm chart
Sergey Otpuschennikov50b248c2019-08-28 17:21:18 +040011 * @param extra_params additional params, e.g. --url repository_URL
12 * @param charts_dir path to a directory
Ruslan Gustomiasov5d131b62019-08-21 11:51:26 +020013 */
14
Sergey Otpuschennikov50b248c2019-08-28 17:21:18 +040015def helmRepoIndex(extra_params='', charts_dir='.'){
16 sh("helm repo index ${extra_params} ${charts_dir}")
17}
Mykyta Karpin3c78c0f2019-09-11 18:11:06 +030018
19/**
Sergey Otpuschennikov958f2872019-10-16 17:04:33 +040020 * Rebuild index file for helm chart repo
21 * @param helmRepoUrl repository with helm charts
22 * @param md5Remote md5 sum of index.yaml for check
23 */
24
25def helmMergeRepoIndex(helmRepoUrl, md5Remote='') {
26 def common = new com.mirantis.mk.Common()
27
28 def helmRepoDir = '.'
29 def helmExtraParams = "--url ${helmRepoUrl}"
30
31 def indexRes = common.shCmdStatus("wget -O index-upstream.yaml ${helmRepoUrl}/index.yaml")
32 if (indexRes['status']){
33 if (indexRes['status'] == 8 && indexRes['stderr'].contains('ERROR 404') && !md5Remote) {
34 common.warningMsg("Index.yaml not found in ${helmRepoUrl} and will be fully regenerated")
35 } else {
36 error("Something went wrong during index.yaml download: ${indexRes['stderr']}")
37 }
38 } else {
39 if (md5Remote) {
40 def md5Local = sh(script: "md5sum index-upstream.yaml | cut -d ' ' -f 1", returnStdout: true).readLines()[0]
41 if (md5Local != md5Remote) {
42 error 'Target repository already exist, but upstream index.yaml broken or not found'
43 }
44 }
45 helmExtraParams += " --merge index-upstream.yaml"
46 }
Sergey Otpuschennikov892b4e72019-10-29 14:54:08 +040047 helmRepoIndex(helmExtraParams, helmRepoDir)
Sergey Otpuschennikov958f2872019-10-16 17:04:33 +040048}
49
50/**
Mykyta Karpin3c78c0f2019-09-11 18:11:06 +030051 * Generates version for helm chart based on information from git repository. Tries to search
52 * first parent git tag using pattern '[0-9]*-{tagSuffix}', if found that tag will be used
53 * in final version, if not found - version will be formed as '{defaultVersion}-{tagSuffix}'. Number
54 * of commits since last tag or sha of current commit can be added to version.
55 *
56 * @param repoDir string, path to a directory with git repository of helm charts
57 * @param devVersion Boolean, if set to true development version will be calculated e.g 0.1.0-mcp-{sha of current commit}
58 * @param increment Boolean, if set to true patch version will be incremented (e.g 0.1.0 -> 0.1.1)
59 * @param defaultVersion string, value of version which will be used in case no tags found. should be semver2 compatible
60 * @param tagSuffix string, suffix which will be used for finding tags in git repository, also if tag not found, it
61 * it will be added to {defaultVersion} e.g {defaultVersion}-{tagSuffix}
62 */
63
64def generateChartVersionFromGit(repoDir, devVersion = true, increment = false, defaultVersion = '0.1.0', tagSuffix = 'mcp') {
65 def common = new com.mirantis.mk.Common()
66 def git = new com.mirantis.mk.Git()
Mykyta Karpine7554842019-12-11 17:00:29 +020067 String initialVersion = "${defaultVersion}"
Mykyta Karpin3c78c0f2019-09-11 18:11:06 +030068 String countRange
69 String versionData
Mykyta Karpine7554842019-12-11 17:00:29 +020070 String tagPattern = "[0-9]*"
71 if (tagSuffix) {
72 tagPattern = "${tagPattern}-${tagSuffix}"
73 initialVersion = "${initialVersion}-${tagSuffix}"
74 }
Mykyta Karpin3c78c0f2019-09-11 18:11:06 +030075 dir(repoDir){
76 Map cmd = common.shCmdStatus("git describe --tags --first-parent --abbrev=0 --match ${tagPattern}")
77 String lastTag = cmd['stdout'].trim()
78
79 if (cmd['status'] != 0){
80 if (cmd['stderr'].contains('fatal: No names found, cannot describe anything')){
81 common.warningMsg("No parent git tag found, using initial version ${initialVersion}")
82 versionData = initialVersion
83 countRange = 'HEAD'
84 } else {
85 error("Something went wrong, cannot find git information ${cmd['stderr']}")
86 }
87 } else {
88 versionData = lastTag
89 countRange = "${lastTag}..HEAD"
90 }
91 List versionParts = versionData.tokenize('-')
92
Mykyta Karpine7554842019-12-11 17:00:29 +020093 if (!common.isSemVer(versionData)){
94 error "Version ${versionData} is not in semver2 format"
Mykyta Karpin3c78c0f2019-09-11 18:11:06 +030095 }
Mykyta Karpine7554842019-12-11 17:00:29 +020096 if (tagSuffix && versionParts.size() == 2 && versionParts[1] != tagSuffix){
97 error "Tag suffix ${tagSuffix} was specified but not found in ${versionData}"
98 }
99 String commitsSinceTag = sh(script: "git rev-list --count ${countRange}", returnStdout: true).trim()
100 String commitSha = sh(script: 'git rev-parse --short=7 HEAD', returnStdout: true).trim()
101
102 if (commitsSinceTag == '0'){
103 return versionData
104 }
105
106 if (devVersion){
107 versionParts.add(commitSha)
108 } else {
109 versionParts.add(commitsSinceTag)
110 }
111 // Patch version will be incremented e.g. 0.1.0 -> 0.1.1
112 if (increment) {
113 versionParts[0] = git.incrementVersion(versionParts[0])
114 }
115 return versionParts.join('-')
Mykyta Karpin3c78c0f2019-09-11 18:11:06 +0300116 }
Mykyta Karpin6f050b22019-09-24 13:57:20 +0300117}
118
119/**
120 * Takes a list of dependencies and a version, and sets a version for each dependency in requirements.yaml. If dependency isn't
121 * found in requirements.yaml or requirements.yaml does not exist - does nothing.
122 *
123 * @param chartPath string, path to a directory with helm chart
124 * @param dependencies list of hashes with names and versions of dependencies in format:
125 * [['name': 'chart-name1', 'version': '0.1.0-myversion'], ['name': 'chart-name2', 'version': '0.2.0-myversion']]
126 */
127
128def setChartDependenciesVersion(chartPath, List dependencies){
129 def common = new com.mirantis.mk.Common()
130 if (!dependencies){
131 error 'No list of target dependencies is specified'
132 }
133 def reqsFilePath = "${chartPath}/requirements.yaml"
134 def chartYaml = readYaml file: "${chartPath}/Chart.yaml"
135 def reqsUpdateNeeded = false
136 def reqsMap = [:]
137 if (fileExists(reqsFilePath)){
138 reqsMap = readYaml file: reqsFilePath
139 for (i in dependencies) {
140 for (item in reqsMap.get('dependencies', [])){
141 if (item['name'] == i['name']){
Mykyta Karpin882dd362019-09-25 11:27:55 +0300142 common.infoMsg("Set version ${i['version']} for dependency ${i['name']} in chart ${chartYaml['name']}")
Mykyta Karpin6f050b22019-09-24 13:57:20 +0300143 item['version'] = i['version']
144 reqsUpdateNeeded = true
145 }
146 }
147 }
148 }
149 if (reqsUpdateNeeded){
150 sh "rm ${reqsFilePath}"
151 writeYaml file: reqsFilePath, data: reqsMap
152 } else {
153 common.warningMsg("requirements.yaml doesn't exist at path ${reqsFilePath} or chart doesn't contain ${dependencies}, nothing to set")
154 }
Sergey Otpuschennikov958f2872019-10-16 17:04:33 +0400155}