create release first

.gitlab-ci.yml

@@ -4,18 +4,18 @@ stages:
 
 build:
         stage: check
-        image: registry.gitlab.com/wolutator/base-build-env:latest
+        image: registry.hottis.de/dockerized/base-build-env:latest
         tags:
                 - hottis
                 - linux
                 - docker
         script:
                 - for I in *.py; do python -m py_compile $I; done
-                - for I in *.py; do python -m pycodestyle --max-line-length=120 $I; done
+                - for I in *.py; do python -m pycodestyle --ignore=E501 $I; done
 
 release:
         stage: release
-        image: registry.gitlab.com/wolutator/base-build-env
+        image: registry.hottis.de/dockerized/base-build-env:latest
         tags:
                 - hottis
                 - linux
@@ -23,7 +23,7 @@ release:
         only:
                 - release
         script:
-                - zip GitlabReleaseTool.zip gitlabreleaseuploader.py deleterelease.py
-                - python gitlabreleaseuploader.py -p $PRIVATE_TOKEN -i $CI_PROJECT_ID -u $CI_PROJECT_URL
-                  -f GitlabReleaseTool.zip -F info.json -T $CI_COMMIT_REF_NAME
+                - zip GitlabReleaseTool.zip gitlabreleaseuploader.py deleterelease.py checksemver.py
+                - python gitlabreleaseuploader.py -p $PRIVATE_TOKEN -i $CI_PROJECT_ID -u $CI_PROJECT_URL -I $CI_SERVER_URL
+                  -f GitlabReleaseTool.zip -F info.json -T $CI_COMMIT_SHA
 

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 Wolfgang Hottgenroth
+Copyright (c) 2019-2020 Wolfgang Hottgenroth
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

checksemver.py

@@ -0,0 +1,80 @@
+#!/usr/bin/python
+
+import re
+import argparse
+import sys
+
+parser = argparse.ArgumentParser(description='Semantic Version Validator')
+parser.add_argument('--versionToValidate', '-V',
+                    help='The version to validate against the semantic versioning rules',
+                    required=True)
+parser.add_argument('--messageToValidate', '-M',
+                    help='A message to validate, means: it must not be empty',
+                    default='',
+                    required=False)
+parser.add_argument('--validateMessage', '-m',
+                    help='Consider -M',
+                    required=False,
+                    action='store_true',
+                    default=False)
+parser.add_argument('--printExports', '-e',
+                    help='Print exports',
+                    action='store_true',
+                    default=False,
+                    required=False)
+parser.add_argument('--exportFormat', '-f',
+                    help='Print exports in >bash< or >powershell< format, to be used in '
+                         'backticks or with Invoke-Expression',
+                    default='bash',
+                    required=False)
+parser.add_argument('--verbose', '-v',
+                    help='Verbose output, overrides -q',
+                    required=False,
+                    action='store_true',
+                    default=False)
+args = parser.parse_args()
+
+verbose = args.verbose
+versionToValidate = args.versionToValidate
+messageToValidate = args.messageToValidate
+validateMessage = args.validateMessage
+printExports = args.printExports
+exportFormat = args.exportFormat
+
+r = re.compile(r'^(?P<major>0|[1-9]\d*)\.(?P<minor>0|[1-9]\d*)\.(?P<patch>0|[1-9]\d*)(?:-(?P<prerelease>(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+(?P<buildmetadata>[0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$')
+
+if verbose:
+    print("Version to validate: {}".format(versionToValidate))
+
+m = r.match(versionToValidate)
+
+if m:
+    if verbose:
+        for i in r.groupindex:
+            print("Found: {}: {}".format(i, m.group(i)))
+    if validateMessage:
+        if verbose:
+            print("Checking message {}".format(messageToValidate))
+        if messageToValidate == '':
+            if verbose:
+                print("Message shall be validate and is invalid")
+            sys.exit(1)
+        else:
+            if printExports:
+                if exportFormat == "bash":
+                    print("export MESSAGE={}".format(messageToValidate))
+                elif exportFormat == "powershell":
+                    print("set MESSAGE {}".format(messageToValidate))
+
+    if printExports:
+        for i in r.groupindex:
+            if exportFormat == "bash":
+                print("export {}={}".format(i.upper(), '' if m.group(i) is None else m.group(i)))
+            elif exportFormat == "powershell":
+                print("set {} {}".format(i.upper(), '""' if m.group(i) is None else m.group(i)))
+
+    sys.exit(0)
+else:
+    if verbose:
+        print("Version is invalid")
+    sys.exit(1)

deleterelease.py

@@ -23,11 +23,16 @@ parser.add_argument('--verbose', '-v',
                     required=False,
                     action='store_true',
                     default=False)
+parser.add_argument('--caBundle', '-B',
+                    help='File with the CA certificates to trust', required=False,
+                    default='/etc/ssl/certs/ca-certificates.crt')
 parser.add_argument('--insecure',
                     help='insecure ssl connect',
                     required=False,
                     action='store_true',
                     default=False)
+
+
 args = parser.parse_args()
 
 privateToken = args.privateToken
@@ -35,9 +40,9 @@ projectId = args.projectId
 releaseTag = args.releaseTag
 instanceUrl = args.instanceUrl
 verbose = args.verbose
+caBundle = args.caBundle
 insecure = args.insecure
 
-
 # --- delete release
 deleteReleaseUrl = "%s/api/v4/projects/%s/releases/%s" % (instanceUrl, projectId, releaseTag)
 headers = {"PRIVATE-TOKEN": privateToken, "Content-Type": "application/json"}
@@ -45,7 +50,10 @@ headers = {"PRIVATE-TOKEN": privateToken, "Content-Type": "application/json"}
 if verbose:
     print("URL: %s" % deleteReleaseUrl)
 
-deleteReleaseResult = requests.delete(deleteReleaseUrl, headers=headers, verify=(not insecure))
+if insecure:
+    caBundle = (False)
+
+deleteReleaseResult = requests.delete(deleteReleaseUrl, headers=headers, verify=caBundle)
 
 if deleteReleaseResult.status_code != 200:
     print(deleteReleaseResult)

gitlabreleaseuploader.py

@@ -14,10 +14,17 @@ parser.add_argument('--projectId', '-i',
 parser.add_argument('--projectUrl', '-u',
                     help='URL of the related project at Gitlab', required=True)
 parser.add_argument('--file', '-f',
-                    help='File to be released', required=True)
+                    help='File to be released, can appear multiple times',
+                    action='append',
+                    required=False)
 parser.add_argument('--releaseName', '-n',
                     help='Name of the release', required=False,
                     default='')
+parser.add_argument('--createRelease', '-C',
+                    help='Shall the release be created here',
+                    required=False,
+                    action='store_true',
+                    default=False)
 parser.add_argument('--releaseTag', '-t',
                     help='Tag of the release in the repo',
                     required=False,
@@ -27,7 +34,7 @@ parser.add_argument('--releaseTagTarget', '-T',
                     required=False,
                     default='')
 parser.add_argument('--createReleaseTag', '-c',
-                    help='Shall the release be created here',
+                    help='Shall the release tag be created here',
                     required=False,
                     action='store_true',
                     default=False)
@@ -42,6 +49,14 @@ parser.add_argument('--releaseInfoFile', '-F',
 parser.add_argument('--instanceUrl', '-I',
                     help='URL of your gitlab instance', required=False,
                     default='https://gitlab.com')
+parser.add_argument('--caBundle', '-B',
+                    help='File with the CA certificates to trust', required=False,
+                    default='/etc/ssl/certs/ca-certificates.crt')
+parser.add_argument('--insecure',
+                    help='insecure ssl connect',
+                    required=False,
+                    action='store_true',
+                    default=False)
 parser.add_argument('--verbose', '-v',
                     help='verbose output',
                     required=False,
@@ -52,23 +67,29 @@ args = parser.parse_args()
 privateToken = args.privateToken
 projectId = args.projectId
 projectUrl = args.projectUrl
-fileToUpload = args.file
+filesToUpload = args.file
 releaseName = args.releaseName
+createRelease = args.createRelease
 releaseTag = args.releaseTag
 releaseTagTarget = args.releaseTagTarget
 releaseDescription = args.description
 instanceUrl = args.instanceUrl
 createReleaseTag = args.createReleaseTag
 releaseInfoFilename = args.releaseInfoFile
+caBundle = args.caBundle
 verbose = args.verbose
-releaseInfo = {}
+insecure = args.insecure
 
+releaseInfo = {}
 if (releaseInfoFilename):
     with open(releaseInfoFilename, 'r') as releaseInfoFile:
         releaseInfo = releaseInfoFile.read()
     releaseInfo = json.loads(releaseInfo)
     if 'releaseName' in releaseInfo:
         releaseName = releaseInfo['releaseName']
+    if 'createRelease' in releaseInfo:
+        createRelease = (releaseInfo['createRelease'] in
+                         ('true', 'True'))
     if 'releaseTag' in releaseInfo:
         releaseTag = releaseInfo['releaseTag']
     if 'releaseTagTarget' in releaseInfo:
@@ -83,88 +104,157 @@ if releaseName == '':
     raise Exception('No release name given')
 if releaseTag == '':
     raise Exception('No release tag given')
-if releaseTagTarget == '':
-    raise Exception('No release tag target given')
-if releaseDescription == '':
-    raise Exception('No release description given')
+if (releaseTagTarget == '') and createReleaseTag:
+    raise Exception('No release tag target given but creation of tag requested')
+if (releaseDescription == '') and createRelease:
+    raise Exception('No release description given but creation of release requested')
+
+if insecure:
+    caBundle = (False)
+
+
+def checkAndShowResult(result, expectedCode, errorMessage):
+    global verbose
+
+    if result.status_code != expectedCode:
+        print(result)
+        print(result.text)
+        raise Exception(errorMessage)
+
+    if verbose:
+        print(result)
+        print(result.text)
 
 
 # --- upload the file
-uploadUrl = "%s/api/v4/projects/%s/uploads" % (instanceUrl, projectId)
-headers = {"PRIVATE-TOKEN": privateToken}
-files = {"file": open(fileToUpload, 'rb')}
+assets = []  # is required later, must be defined
+if filesToUpload:
+    url = "%s/api/v4/projects/%s/uploads" % (instanceUrl, projectId)
+    headers = {"PRIVATE-TOKEN": privateToken}
 
-uploadResult = requests.post(uploadUrl, files=files, headers=headers)
+    for filename in filesToUpload:
+        with open(filename, 'rb') as filehandle:
+            files = {"file": filehandle}
 
-if uploadResult.status_code != 201:
-    print(uploadResult)
-    print(uploadResult.text)
-    raise Exception('Unable to upload file to Gitlab')
+            if verbose:
+                print("POST to {}".format(url))
+            result = requests.post(url, files=files, headers=headers, verify=caBundle)
 
-if verbose:
-    print(uploadResult)
-    print(uploadResult.text)
-print('File successfully uploaded')
+            checkAndShowResult(result, 201, 'Unable to upload file to Gitlab')
 
-uploadResultJson = json.loads(uploadResult.text)
+            assetUrl = projectUrl + json.loads(result.text)['url']
+            assets.append({'name': filename, 'url': assetUrl, 'id': "new-link-{}".format(len(assets))})
+
+            print('File {} successfully uploaded, url is {}'.format(filename, assetUrl))
 
 # --- create release tag
 if createReleaseTag:
-    createReleaseTagUrl = ("%s/api/v4//projects/%s/repository/tags" %
-                           (instanceUrl, projectId))
-    headers = {"PRIVATE-TOKEN": privateToken,
-               "Content-Type": "application/json"}
+    url = "%s/api/v4//projects/%s/repository/tags" % (instanceUrl, projectId)
+    headers = {"PRIVATE-TOKEN": privateToken, "Content-Type": "application/json"}
 
-    payloadCreateReleaseTag = {
+    payload = {
         "tag_name": releaseTag,
         "id": projectId,
         "ref": releaseTagTarget,
         "message": "Tag for release %s" % releaseName
     }
 
-    createReleaseTagResult = requests.post(createReleaseTagUrl,
-                                           headers=headers,
-                                           data=json.dumps(payloadCreateReleaseTag))
-
-    if createReleaseTagResult.status_code != 201:
-        print(createReleaseTagResult)
-        print(createReleaseTagResult.text)
-        raise Exception('Unable to create release tag')
-
     if verbose:
-        print(createReleaseTagResult)
-        print(createReleaseTagResult.text)
+        print("POST to {}".format(url))
+    result = requests.post(url, headers=headers, data=json.dumps(payload), verify=caBundle)
+
+    checkAndShowResult(result, 201, 'Unable to create release tag')
+
     print('Tag successfully created')
 
 
 # --- create release
-createReleaseUrl = "%s/api/v4/projects/%s/releases" % (instanceUrl, projectId)
-headers = {"PRIVATE-TOKEN": privateToken, "Content-Type": "application/json"}
-fullUrl = projectUrl + uploadResultJson['url']
+if createRelease:
+    url = "%s/api/v4/projects/%s/releases" % (instanceUrl, projectId)
+    headers = {"PRIVATE-TOKEN": privateToken, "Content-Type": "application/json"}
 
-payloadCreateRelease = {
-  "name": releaseName,
-  "tag_name": releaseTag,
-  "description": releaseDescription,
-  "assets": {
-    "links": [
-      {
-        "name": fileToUpload,
-        "url": fullUrl
-      }
-    ]
-  }
-}
+    payload = {
+        "name": releaseName,
+        "tag_name": releaseTag,
+        "description": releaseDescription
+    }
 
-createReleaseResult = requests.post(createReleaseUrl, headers=headers,
-                                    data=json.dumps(payloadCreateRelease))
+    if verbose:
+        print("POST to {}".format(url))
+    result = requests.post(url, headers=headers, data=json.dumps(payload), verify=caBundle)
 
-if createReleaseResult.status_code != 201:
-    print(createReleaseResult)
-    print(createReleaseResult.text)
-    raise Exception('Unable to create release')
+    checkAndShowResult(result, 201, 'Unable to create release')
 
+    print('Release successfully created')
+
+
+# --- update release in case of additional description
+if not createRelease and releaseDescription:
+    # --- get release to fetch existing description
+    url = "%s/api/v4/projects/%s/releases/%s" % (instanceUrl, projectId, releaseTag)
+    headers = {"PRIVATE-TOKEN": privateToken}
+
+    if verbose:
+        print("GET to {}".format(url))
+    result = requests.get(url, headers=headers, verify=caBundle)
+
+    checkAndShowResult(result, 200, 'Unable to get release')
+    existingDescription = json.loads(result.text)['description']
+    print("Existing description is {}".format(existingDescription))
+
+    releaseDescription += "\n\n---------------------------------------------\n\n"
+    releaseDescription += existingDescription
+
+    # --- update release
+    url = "%s/api/v4/projects/%s/releases/%s" % (instanceUrl, projectId, releaseTag)
+    headers = {"PRIVATE-TOKEN": privateToken, "Content-Type": "application/json"}
+
+    payload = {
+        "name": releaseName,
+        "tag_name": releaseTag,
+        "description": releaseDescription
+    }
+
+    if verbose:
+        print("PUT to {}".format(url))
+    result = requests.put(url, headers=headers, data=json.dumps(payload), verify=caBundle)
+
+    checkAndShowResult(result, 200, 'Unable to update release')
+
+    print('Release successfully update')
+
+
+# --- add assets
+# get existing assets
+headers = {"PRIVATE-TOKEN": privateToken}
+url = "%s/api/v4/projects/%s/releases/%s" % (instanceUrl, projectId, releaseTag)
 if verbose:
-    print(createReleaseResult)
-    print(createReleaseResult.text)
-print('Release successfully created')
+    print("GET to {}".format(url))
+result = requests.get(url, headers=headers, verify=caBundle)
+checkAndShowResult(result, 200, 'Unable to get release information')
+
+# add existing assets to list of assets
+links = json.loads(result.text)['assets']['links']
+assets.extend(links)
+
+# delete existing assets
+headers = {"PRIVATE-TOKEN": privateToken}
+for link in links:
+    assetId = link['id']
+    url = "%s/api/v4/projects/%s/releases/%s/assets/links/%s" % (instanceUrl, projectId, releaseTag, assetId)
+    if verbose:
+        print("DELETE to {}".format(url))
+    result = requests.delete(url, headers=headers, verify=caBundle)
+    checkAndShowResult(result, 200, 'Unable to delete asset')
+    print("Asset {} successfully deleted".format(assetId))
+
+
+# create all assets ("existing" and new)
+headers = {"PRIVATE-TOKEN": privateToken, "Content-Type": "application/json"}
+url = "%s/api/v4/projects/%s/releases/%s/assets/links" % (instanceUrl, projectId, releaseTag)
+for asset in assets:
+    if verbose:
+        print("POST to {}".format(url))
+    result = requests.post(url, headers=headers, data=json.dumps(asset), verify=caBundle)
+    checkAndShowResult(result, 201, "Unable to create asset")
+    print("Asset {} successfully created".format(asset))

info.json

@@ -1,7 +1,8 @@
 {
-  "releaseTag": "v1.7",
+  "createRelease": "true",
+  "releaseTag": "v1.12",
   "createReleaseTag": "true",
-  "releaseName": "Delete Release supporting release",
-  "description": "Separate tool to delete releases added"
+  "releaseName": "updater release",
+  "description": "add option to add files to existing release or extend description of existing release"
 }
 

readme.md

@@ -21,6 +21,7 @@ Gitlab CI scripts.
                                     [--createReleaseTag]
                                     [--description DESCRIPTION]
                                     [--releaseInfoFile RELEASEINFOFILE]
+                                    [--caBundle FILE_WITH_CA_CERTIFICATES_TO_TRUST]
                                     [--instanceUrl INSTANCEURL] [--verbose]
 
     Gitlab Release Uploader
@@ -49,6 +50,7 @@ Gitlab CI scripts.
                             tag, create release tag, description
     --instanceUrl INSTANCEURL, -I INSTANCEURL
                             URL of your gitlab instance
+    --caBundle FILE_WITH_CA_CERTIFICATES_TO_TRUST, -B FILE_WITH_CA_CERTIFICATES_TO_TRUST                        
     --verbose, -v         verbose output
     wn@tron:~/workspace-python/gitlabreleaseuploader [master ≡]$