content/release_notes_clear.py at master · XuyuFu/content · GitHub

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
# remove all releaseNotes from files in: Itegrations, Playbooks, Reports and Scripts.
# Note: using yaml will destroy the file structures so filtering as regular text-file.\
# Note2: file must be run from root directory with 4 sub-directories: Integration, Playbook, Reports, Scripts
# Usage: python release_notes_clear.py
import os
import glob
import argparse

from Tests.scripts.update_id_set import update_id_set

def yml_remove_releaseNote_record(file_path):
    '''
    locate and remove release notes from a yaml file.
    :param file_path: path of the file
    :return: True if file was changed, otherwise False.
    '''
    with open(file_path, 'r') as f:
        lines = f.readlines()

    orig_size = len(lines)
    consider_multiline_notes = False
    new_lines = []
    for line in lines:
        if line.startswith('releaseNotes:'):
            # releaseNote title: ignore current line and consider following lines as part of it (multiline notes)
            consider_multiline_notes = True

        elif consider_multiline_notes:
            # not a releaseNote title (right after a releaseNote block (single or multi line)
            if not line[0].isspace():
                # regular line
                consider_multiline_notes = False
                new_lines.append(line)
            else:
                # line is part of a multiline releaseNote: ignore it
                pass
        else:
            # regular line
            new_lines.append(line)

    with open(file_path, 'w') as f:
        f.write(''.join(new_lines))

    return orig_size != len(new_lines)


def json_remove_releaseNote_record(file_path):
    '''
    locate and remove release notes from a json file.
    :param file_path: path of the file
    :return: True if file was changed, otherwise False.
    '''
    with open(file_path, 'r') as f:
        lines = f.readlines()

    orig_size = len(lines)
    consider_multiline_notes = False
    new_lines = []
    for line in lines:
        if line.strip().startswith('"releaseNotes"'):
            # releaseNote title: ignore current line and consider following lines as part of it (multiline notes)
            consider_multiline_notes = True

        elif consider_multiline_notes:
            # not a releaseNote title (right after a releaseNote block (single or multi line)
            if line.strip():
                if line.strip()[0] == '"': # regular line
                    consider_multiline_notes = False
                    new_lines.append(line)
                elif line.strip() == '}': # releaseNote was at end of dict
                    # needs to remove ',' from last line
                    idx = new_lines[-1].rfind(',')
                    new_lines[-1] = new_lines[-1][:idx] + new_lines[-1][idx+1:]
                    consider_multiline_notes = False
                    new_lines.append(line)
                    pass
            else:
                # line is part of a multiline releaseNote: ignore it
                pass
        else:
            # regular line
            new_lines.append(line)

    with open(file_path, 'w') as f:
        f.write(''.join(new_lines))

    return orig_size != len(new_lines)


FILE_EXTRACTER_DICT = {
    '*.yml' : yml_remove_releaseNote_record,
    '*.json' : json_remove_releaseNote_record,
}


def remove_releaseNotes_folder(folder_path, files_extension):
    '''
    scan folder and remove all references to release notes
    :param folder_path: path of the folder
    :param files_extension: type of file to look for (json or yml)
    '''
    scan_files = glob.glob(os.path.join(folder_path, files_extension))

    count = 0
    for path in scan_files:
        if FILE_EXTRACTER_DICT[files_extension](path):
            count += 1

    print '--> Changed %d out of %d files' % (count, len(scan_files), )


def get_git_sha():
    parser = argparse.ArgumentParser(description='Utility for getting latest release')
    parser.add_argument('-g', '--gitsha', help='Git SHA1')
    options = parser.parse_args()
    return options.gitsha


def main(root_dir):
    update_id_set(get_git_sha())

    yml_folders_to_scan = ['Integrations', 'Playbooks', 'Scripts', 'TestPlaybooks'] # yml
    json_folders_to_scan = ['Reports', 'Misc', 'Dashboards', 'Widgets', 'Classifiers', 'Layouts', 'IncidentFields' ] # json

    for folder in yml_folders_to_scan:
        print 'Scanning directory: "%s"' % (folder, )
        remove_releaseNotes_folder(os.path.join(root_dir, folder), '*.yml')

    for folder in json_folders_to_scan:
        print 'Scanning directory: "%s"' % (folder, )
        remove_releaseNotes_folder(os.path.join(root_dir, folder), '*.json')


if __name__ == '__main__':
    main(os.path.dirname(__file__))