forked from demisto/content
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathrelease_notes.py
More file actions
344 lines (284 loc) · 10.4 KB
/
release_notes.py
File metadata and controls
344 lines (284 loc) · 10.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
import abc
import datetime
import json
import sys
import yaml
from Tests.test_utils import print_error
contentLibPath = "./"
limitedVersion = False
class Content:
__metaclass__ = abc.ABCMeta
def __init__(self):
self.modifiedStore = []
self.addedStore = []
self.deletedStore = []
def add(self, changeType, data):
if changeType == "M":
self.modifiedStore.append(data)
elif changeType == "A":
self.addedStore.append(data)
elif changeType == "D":
self.deletedStore.append(data)
else:
print "Unknown change type " + changeType
@abc.abstractmethod
def getHeader(self):
return
@abc.abstractmethod
def addedReleaseNotes(self, data):
return
@abc.abstractmethod
def modifiedReleaseNotes(self, data):
return
@abc.abstractmethod
def loadData(self, data):
return
def generateRN(self):
res = ""
missingReleaseNotes = False
if len(self.modifiedStore) + len(self.deletedStore) + len(self.addedStore) > 0:
section_body = ""
if len(self.addedStore) > 0:
newStr = ""
new_count = 0
for rawContent in self.addedStore:
cnt = self.loadData(rawContent)
new_content_rn = self.addedReleaseNotes(cnt)
if new_content_rn:
new_count += 1
newStr += self.addedReleaseNotes(cnt)
if len(newStr) > 0:
if new_count > 1:
section_body += "\n#### " + str(new_count) + " New " + self.getHeader() + "\n"
else:
section_body += "\n#### New " + self.getHeader() + "\n"
section_body += newStr
if len(self.modifiedStore) > 0:
modifiedStr = ""
modified_count = 0
for rawContent in self.modifiedStore:
cnt = self.loadData(rawContent)
ans = self.modifiedReleaseNotes(cnt)
if ans is None:
print_error(cnt["name"] + " is missing releaseNotes entry")
missingReleaseNotes = True
elif ans is not "":
modifiedStr += ans
modified_count += 1
if len(modifiedStr) > 0:
if modified_count > 1:
section_body += "\n#### " + str(modified_count) + " Improved " + self.getHeader() + "\n"
else:
section_body += "\n#### Improved " + self.getHeader() + "\n"
section_body += modifiedStr
if len(self.deletedStore) > 0:
section_body += "\n#### Removed " + self.getHeader() + "\n"
for rawContent in self.deletedStore:
section_body += "- " + rawContent + "\n"
if missingReleaseNotes:
return None
if len(section_body) > 0:
res = "### " + self.getHeader() + "\n"
res += section_body
return res
class ScriptContent(Content):
def loadData(self, data):
return yaml.load(data)
def getHeader(self):
return "Scripts"
def addedReleaseNotes(self,cnt):
rn = cnt.get("releaseNotes", "")
if len(rn) > 0 and rn == "-":
return ""
res = "- " + cnt["name"] + "\n"
if cnt.get("comment") is not None and len(cnt.get("comment")) > 0:
res += "-- " + cnt["comment"] + "\n"
return res
def modifiedReleaseNotes(self,cnt):
rn = cnt.get("releaseNotes", "")
if len(rn) == 0:
return None
res = ""
#Add a comment only if there are release notes
if rn != '-':
res = "- " + cnt["name"] + "\n"
res += "-- " + cnt["releaseNotes"] + "\n"
return res
Content.register(ScriptContent)
class PlaybookContent(Content):
def loadData(self, data):
return yaml.load(data)
def getHeader(self):
return "Playbooks"
def addedReleaseNotes(self, cnt):
rn = cnt.get("releaseNotes", "")
if len(rn) > 0 and rn == "-":
return ""
res = "- " + cnt["name"] + "\n"
if cnt.get("description") is not None and len(cnt.get("description")) > 0:
res += "-- " + cnt["description"] + "\n"
return res
def modifiedReleaseNotes(self, cnt):
rn = cnt.get("releaseNotes", "")
if len(rn) == 0:
return None
res = ""
#Add a comment only if there are release notes
if rn != '-':
res = "- " + cnt["name"] + "\n"
res += "-- " + cnt["releaseNotes"] + "\n"
return res
Content.register(PlaybookContent)
class ReportContent(Content):
def loadData(self, data):
return json.loads(data)
def getHeader(self):
return "Reports"
def addedReleaseNotes(self, cnt):
rn = cnt.get("releaseNotes", "")
if len(rn) > 0 and rn == "-":
return ""
res = "- " + cnt["name"] + "\n"
if cnt.get("description") is not None and len(cnt.get("description")) > 0:
res += "-- " + cnt["description"] + "\n"
return res
def modifiedReleaseNotes(self, cnt):
rn = cnt.get("releaseNotes", "")
if len(rn) == 0:
return None
res = ""
#Add a comment only if there are release notes
if rn != '-':
res = "- " + cnt["name"] + "\n"
res += "-- " + cnt["releaseNotes"] + "\n"
return res
Content.register(ReportContent)
class ReputationContent(Content):
def loadData(self, data):
return json.loads(data)
def getHeader(self):
return "Hypersearch"
def addedReleaseNotes(self, cnt):
#This should never happen
return ""
def modifiedReleaseNotes(self, cnt):
rn = cnt.get("releaseNotes", "")
if len(rn) == 0:
return None
res = ""
#Add a comment only if there are release notes
if rn != '-':
res += "-- " + cnt["releaseNotes"] + "\n"
return res
Content.register(ReputationContent)
class IntegrationContent(Content):
def loadData(self, data):
return yaml.load(data)
def getHeader(self):
return "Integrations"
def addedReleaseNotes(self, cnt):
res = "- " + cnt["name"] + "\n"
if cnt.get("description") is not None and len(cnt.get("description")) > 0:
res += "-- " + cnt["description"] + "\n"
return res
def modifiedReleaseNotes(self, cnt):
rn = cnt.get("releaseNotes", "")
if len(rn) == 0:
return None
res = ""
#Add a comment only if there are release notes
if rn != '-':
res = "- " + cnt["name"] + "\n"
res += "-- " + cnt["releaseNotes"] + "\n"
return res
Content.register(IntegrationContent)
releaseNoteGenerator = {
"Scripts": ScriptContent(),
"Integrations": IntegrationContent(),
"Playbooks": PlaybookContent(),
"Reports": ReportContent(),
"Misc": ReputationContent()
}
def parseChangeList(filePath):
with open(filePath, 'r') as f:
data = f.read()
return data.split("\n")
return []
def getDeletedContent(fullFileName, data):
startIndex = data.find(fullFileName)
if startIndex > 0:
nameIndex = data.find("-name:", startIndex)
if nameIndex > 0:
return data[nameIndex:].split("\n")[0][len("-name:"):].strip()
return ""
def handleDeletedFiles(deleteFilePath, fullFileName):
with open(deleteFilePath, 'r') as f:
data = f.read()
if "/" in fullFileName:
fileType = fullFileName.split("/")[0]
fileTypeMapping = releaseNoteGenerator.get(fileType)
deletedContent = getDeletedContent(fullFileName, data)
if fileTypeMapping is not None:
fileTypeMapping.add("D", deletedContent)
def createFileReleaseNotes(fileName, deleteFilePath):
if len(fileName) > 0:
names = fileName.split("\t")
changeType = names[0]
fullFileName = names[1]
if changeType == "D":
handleDeletedFiles(deleteFilePath, fullFileName)
elif changeType != "R100" and changeType != "R094":
if changeType == "R093" or changeType == "R098" or changeType == "R078":
# handle the same as modified
fullFileName = names[2]
changeType = 'M'
with open(contentLibPath + fullFileName, 'r') as f:
data = f.read()
if "/" in fullFileName:
fileType = fullFileName.split("/")[0]
fileTypeMapping = releaseNoteGenerator.get(fileType)
if fileTypeMapping is not None:
fileTypeMapping.add(changeType, data)
def createContentDescriptor(version, assetId, res):
#time format example 2017 - 06 - 11T15:25:57.0 + 00:00
date = datetime.datetime.now().strftime("%Y-%m-%dT%H:%M:%S.0+00:00")
release_notes = "## Release Notes for version " + version + " (" + assetId + ")" + "\n\n" + res
contentDescriptor = {
"installDate": "0001-01-01T00:00:00Z",
"assetId": int(assetId),
"releaseNotes": release_notes,
"modified": date,
"ignoreGit": False,
"releaseDate": date,
"version": -1,
"release": version,
"id": ""
}
with open('content-descriptor.json', 'w') as outfile:
json.dump(contentDescriptor, outfile)
with open('release-notes.txt', 'w') as outfile:
outfile.write(release_notes)
def main(argv):
if len(argv) < 4:
print "<Release version>, <File with the full list of changes>, <Complete diff file for deleted files>, <assetID>"
sys.exit(1)
files = parseChangeList(argv[1])
for file in files:
createFileReleaseNotes(file, argv[2])
res = ""
missingReleaseNotes = False
for key, value in releaseNoteGenerator.iteritems():
if len(res) > 0:
res += "\n\n"
ans = value.generateRN()
if ans is None:
missingReleaseNotes = True
else:
res += ans
if missingReleaseNotes == True:
sys.exit(1)
version = argv[0]
assetId = argv[3]
createContentDescriptor(version, assetId, res)
if __name__ == "__main__":
main(sys.argv[1:])