create release first

.gitlab-ci.yml

@@ -25,5 +25,5 @@ release:
         script:
                 - 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_REF_NAME
+                  -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

gitlabreleaseuploader.py

@@ -16,10 +16,15 @@ parser.add_argument('--projectUrl', '-u',
 parser.add_argument('--file', '-f',
                     help='File to be released, can appear multiple times',
                     action='append',
-                    required=True)
+                    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,
@@ -29,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)
@@ -47,6 +52,11 @@ parser.add_argument('--instanceUrl', '-I',
 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,
@@ -59,6 +69,7 @@ projectId = args.projectId
 projectUrl = args.projectUrl
 filesToUpload = args.file
 releaseName = args.releaseName
+createRelease = args.createRelease
 releaseTag = args.releaseTag
 releaseTagTarget = args.releaseTagTarget
 releaseDescription = args.description
@@ -67,14 +78,18 @@ 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:
@@ -89,89 +104,157 @@ if releaseName == '':
     raise Exception('No release name given')
 if releaseTag == '':
     raise Exception('No release tag given')
-if releaseTagTarget == '':
+if (releaseTagTarget == '') and createReleaseTag:
-    raise Exception('No release tag target given')
+    raise Exception('No release tag target given but creation of tag requested')
-if releaseDescription == '':
+if (releaseDescription == '') and createRelease:
-    raise Exception('No release description given')
+    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)
+assets = []  # is required later, must be defined
+if filesToUpload:
+    url = "%s/api/v4/projects/%s/uploads" % (instanceUrl, projectId)
     headers = {"PRIVATE-TOKEN": privateToken}
 
-assets = []
     for filename in filesToUpload:
         with open(filename, 'rb') as filehandle:
             files = {"file": filehandle}
 
-        uploadResult = requests.post(uploadUrl, files=files, headers=headers, verify=caBundle)
-
-        if uploadResult.status_code != 201:
-            print(uploadResult)
-            print(uploadResult.text)
-            raise Exception('Unable to upload file to Gitlab')
-
             if verbose:
-            print(uploadResult)
+                print("POST to {}".format(url))
-            print(uploadResult.text)
+            result = requests.post(url, files=files, headers=headers, verify=caBundle)
-        print('File {} successfully uploaded'.format(filename))
 
-        url = projectUrl + json.loads(uploadResult.text)['url']
+            checkAndShowResult(result, 201, 'Unable to upload file to Gitlab')
-        assets.append({'name': filename, 'url': url})
+
+            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" %
+    url = "%s/api/v4//projects/%s/repository/tags" % (instanceUrl, projectId)
-                           (instanceUrl, projectId))
+    headers = {"PRIVATE-TOKEN": privateToken, "Content-Type": "application/json"}
-    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),
-                                           verify=caBundle)
-
-    if createReleaseTagResult.status_code != 201:
-        print(createReleaseTagResult)
-        print(createReleaseTagResult.text)
-        raise Exception('Unable to create release tag')
-
     if verbose:
-        print(createReleaseTagResult)
+        print("POST to {}".format(url))
-        print(createReleaseTagResult.text)
+    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)
+if createRelease:
+    url = "%s/api/v4/projects/%s/releases" % (instanceUrl, projectId)
     headers = {"PRIVATE-TOKEN": privateToken, "Content-Type": "application/json"}
 
-payloadCreateRelease = {
+    payload = {
         "name": releaseName,
         "tag_name": releaseTag,
-    "description": releaseDescription,
+        "description": releaseDescription
-    "assets": {
-        "links": assets
     }
-}
-
-createReleaseResult = requests.post(createReleaseUrl, headers=headers,
-                                    data=json.dumps(payloadCreateRelease),
-                                    verify=caBundle)
-
-if createReleaseResult.status_code != 201:
-    print(createReleaseResult)
-    print(createReleaseResult.text)
-    raise Exception('Unable to create release')
 
     if verbose:
-    print(createReleaseResult)
+        print("POST to {}".format(url))
-    print(createReleaseResult.text)
+    result = requests.post(url, headers=headers, data=json.dumps(payload), verify=caBundle)
+
+    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("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.11",
+  "createRelease": "true",
+  "releaseTag": "v1.12",
   "createReleaseTag": "true",
-  "releaseName": "semantic version validator added",
+  "releaseName": "updater release",
-  "description": "semantic version validator added"
+  "description": "add option to add files to existing release or extend description of existing release"
 }