utils.release

  1#!/usr/bin/env python3
  2"""
  3release.py
  4
  5Common code useful for release pipelines.
  6
  7Example Usage:
  8    from utils import release
  9    from utils.release import get_new_build_release as _version
 10"""
 11
 12import datetime
 13# from subprocess_tee import run as _run
 14import os
 15import sys
 16from subprocess_tee import run as _run
 17try:
 18    import loggy
 19except ImportError:
 20    from utils import loggy
 21try:
 22    from .common import resolve_gocd_pipeline_variable
 23except ImportError:
 24    from utils.common import resolve_gocd_pipeline_variable
 25
 26
 27from enum import Enum
 28
 29
 30class Release(Enum):
 31    DEV = "develop"
 32    DEVELOP = "develop"
 33    QA = "qa"
 34    STAGE = "staging"
 35    STAGING = "staging"
 36    DEMO = "demo"
 37    PROD = "master"
 38    HOTFIX = "hotfix"
 39
 40
 41def get_semver():
 42    """
 43    get_semver()
 44
 45    Generates a new build version string using Semantic Versioning using environment variables.
 46
 47    Uses the following Environment variables to generate the version string:
 48
 49    * VERSION_MAJOR
 50    * VERSION_MINOR
 51    * GO_PIPELINE_COUNTER
 52
 53    Returns: None if environment variables are not set
 54    """
 55    if os.environ.get('VERSION_MAJOR') and os.environ.get('VERSION_MINOR') and os.environ.get('GO_PIPELINE_COUNTER'):
 56        return f"{os.environ.get('VERSION_MAJOR')}.{os.environ.get('VERSION_MINOR')}.{os.environ.get('GO_PIPELINE_COUNTER')}"
 57
 58    return None
 59
 60
 61def get_version():
 62    """
 63    get_version()
 64
 65    Generates a new build version string using `get_new_build_release()`
 66
 67    NOTE: This is the `default` version format for ALL of our backend versioning.
 68
 69    """
 70    return get_new_build_release()
 71
 72
 73def get_new_build_release():
 74    """
 75    get_new_build_release()
 76
 77    Generates a new build version string in the format: YY.MM.DD.GO_PIPELINE_COUNTER
 78
 79    returns: String
 80    """
 81    now = datetime.datetime.now().strftime("%y.%m.%d.")
 82    version = f"{now}{os.environ.get('GO_PIPELINE_COUNTER', '0')}"
 83    loggy.info(f"release.get_new_build_release(): Generated build: {version}")
 84    return version
 85
 86
 87def _check_for_multiple_materials():
 88    """
 89    _check_for_multiple_materials()
 90
 91    Checks for and exits if multiple materials in a GoCD pipeline are found.
 92    We currently do not support this in our release functions.
 93
 94    returns: False
 95    """
 96    counter = sum(x.startswith('GO_REVISION_') for x in os.environ.keys())
 97
 98    if counter > 1:
 99        loggy.error("release.get_commit_short_hash(): Error: (" + counter + ") Materials found in Env. We only support 1 Material right now.")
100        sys.exit(1)
101
102    return False
103
104
105def get_commit_short_hash():
106    """
107    get_commit_short_hash()
108
109    Grabs the git commit hash from ENV vars in a GoCD pipeline and returns the first 8 chars.
110
111    returns: String
112    """
113    _check_for_multiple_materials()
114    return next(val for key, val in os.environ.items() if key.startswith('GO_REVISION_'))[0:8]
115
116
117def get_source_branch():
118    """
119    get_source_branch()
120
121    Grabs the git branch from ENV vars in a GoCD pipeline
122
123    returns: String
124    """
125    _check_for_multiple_materials()
126    try:
127        return next(val for key, val in os.environ.items() if key.startswith('GO_MATERIAL_BRANCH'))
128    except StopIteration as e:
129        loggy.error(f"release.get_source_branch(): No branches found. GO_MATERIAIL_BRANCH_x env vars not found. Is this a GoCD pipeline? {str(e)}")
130        return None
131
132
133def get_last_tag():
134    """
135    get_last_tag()
136
137    Grabs the latest tag in a git repo.
138
139    returns: String or None
140    """
141    _run("git fetch --all --tags", check=False, shell=True)
142    latest_tag = _run("git for-each-ref refs/tags --sort=-taggerdate --count=1 --format=\"%(refname)\"", check=False, shell=True)
143
144    resolved = latest_tag.stdout.strip().split('/')[-1] if latest_tag else None
145
146    loggy.info(f"release.get_last_tag(): Returning latest tag as: {resolved}")
147    return resolved
148
149
150def git_promote(version=None, source=None, dest=None, tag=None) -> bool:
151    """
152    git_promote()
153
154    Git promote a release from one branch to another.
155
156    version: Defaults to `get_new_build_release()`, which generates a version
157    string in the following format: YYYY.MM.BUILD_NUMBER
158
159    source: Defaults to `develop`
160
161    dest: Defaults to `qa`
162
163    tag: Default is None. If set, we will tag the release version.
164    """
165    source_branch = 'develop' if source is None else resolve_gocd_pipeline_variable(source)
166    dest_branch = 'qa' if dest is None else resolve_gocd_pipeline_variable(dest)
167    version = get_new_build_release() if version is None else resolve_gocd_pipeline_variable(version)
168    promote_branch = f"promote/{version}"
169
170    _run("git status", check=False, shell=True)
171    _run("git config -l", check=False, shell=True)
172    _skip_merge = False
173
174    try:
175        _run(f"git checkout {dest_branch}", check=True, shell=True)
176        _run(f"git pull origin {dest_branch}", check=True, shell=True)
177    except Exception as e:
178        # dest branch doesn't exist. creating it
179        loggy.error("release.git_promote(): Exception: " + str(e))
180        _run(f"git checkout -b {dest_branch}", check=True, shell=True)
181        _run(f"git push origin {dest_branch}", check=True, shell=True)
182
183        _skip_merge = True
184        pass
185
186    if not _skip_merge:
187        _run(f"git checkout {source_branch}", check=True, shell=True)
188        _run(f"git pull origin {source_branch}", check=True, shell=True)
189
190        try:
191            loggy.info(f"release.git_promote(): Creating temp release branch {promote_branch}")
192            _run(f"git checkout -b {promote_branch}", check=True, shell=True)
193        except Exception as e:
194            # branch probably already exists...
195            loggy.error("release.git_promote(): Exception: " + str(e))
196            _run(f"git branch -D {promote_branch}", check=True, shell=True)
197            _run(f"git checkout -b {promote_branch}", check=True, shell=True)
198            pass
199
200        _run(f"git merge --strategy=ours --no-edit {dest_branch}", check=True, shell=True)
201        _run(f"git checkout {dest_branch}", check=True, shell=True)
202        _run(f"git merge --squash {promote_branch}", check=True, shell=True)
203
204        try:
205            output = _run(f"git commit -m \"GoCD merge {source_branch} to {dest_branch} for promotion {version}\"", check=False, shell=True)
206
207            if output.returncode != 0:
208                if 'nothing to commit' in output.stderr or 'nothing to commit' in output.stdout:
209                    loggy.info("release.git_commit(): Nothing to commit. Skipping push and proceeding as success.")
210                else:
211                    loggy.error("release.git_commit(): Git commit failure. Exiting. now")
212                    loggy.error(f"release.git_promote(): {output.stdout}")
213                    loggy.error(f"release.git_promote(): {output.stderr}")
214                    loggy.error(f"release.git_promote(): {str(output.returncode)}")
215                    raise Exception(output.stderr)
216            else:
217                _run(f"git push origin {dest_branch}", check=True, shell=True)
218        except Exception as e:
219            loggy.error(f"release.git_promot(): {str(e)}")
220            return False
221
222    if 'master' in dest_branch:
223        version = get_new_build_release() if tag is None else tag
224        _run(f"git tag -f -a {version} -m \"Rev to version {version}\"", check=True, shell=True)
225        _run(f"git push origin {version}", check=True, shell=True)
226
227    return True