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
|
#!/usr/bin/env python
# --------------------------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for license information.
# --------------------------------------------------------------------------------------------
# Normally, this module will be executed as referenced as part of the devops build definitions.
# An enterprising user can easily glance over this and leverage for their own purposes.
import argparse
import sys
import os
import logging
from common_tasks import process_glob_string, parse_setup, run_check_call
logging.getLogger().setLevel(logging.INFO)
root_dir = os.path.abspath(os.path.join(os.path.abspath(__file__), "..", "..", ".."))
psscript = os.path.join(root_dir, "scripts", "devops_tasks", "find_change_log.ps1")
# Service fabric change log has non standard versioning for e.g 7.0.0.0
# Verify change log should skip this package since this script looks for standard version format of x.y.z
NON_STANDARD_CHANGE_LOG_PACKAGES = ["azure-servicefabric",]
def find_change_log(targeted_package, version):
# Execute powershell script to find a matching version in change log
command_array = ["pwsh"]
command_array.append("-File {}".format(psscript))
command_array.append("-workingDir {}".format(targeted_package))
command_array.append("-version {}".format(version))
command_array.append("set-ExecutionPolicy Unrestricted")
allowed_return_codes = []
# Execute powershell script to verify version
er_result = run_check_call(
command_array, root_dir, allowed_return_codes, True, False
)
if er_result:
logging.error(
"Failed to find version in change log for package {}".format(
targeted_package
)
)
return False
return True
def verify_packages(targeted_packages):
# run the build and distribution
change_log_missing = {}
for package in targeted_packages:
# Parse setup.py using common helper method to get version and package name
pkg_name, version, _, _ = parse_setup(package)
# Skip management packages and any explicitly excluded packages
if "-mgmt" in pkg_name or pkg_name in NON_STANDARD_CHANGE_LOG_PACKAGES:
logging.info("Skipping {} due to known exclusion in change log verification".format(pkg_name))
continue
if not find_change_log(package, version):
logging.error(
"Change log is not updated for package {0}, version {1}".format(
pkg_name, version
)
)
change_log_missing[pkg_name] = version
return change_log_missing
if __name__ == "__main__":
parser = argparse.ArgumentParser(
description="Verifies latest version is updated in change log, Called from DevOps YAML Pipeline"
)
parser.add_argument(
"glob_string",
nargs="?",
help=(
"A comma separated list of glob strings that will target the top level directories that contain packages. "
'Examples: All == "azure-*", Single = "azure-keyvault"'
),
)
parser.add_argument(
"--service",
help=(
"Name of service directory (under sdk/) to build."
"Example: --service applicationinsights"
),
)
parser.add_argument(
"--pkgfilter",
default="",
dest="package_filter_string",
help=(
"An additional string used to filter the set of artifacts by a simple CONTAINS clause."
),
)
args = parser.parse_args()
# We need to support both CI builds of everything and individual service
# folders. This logic allows us to do both.
if args.service:
service_dir = os.path.join("sdk", args.service)
target_dir = os.path.join(root_dir, service_dir)
else:
target_dir = root_dir
# Skip nspkg and metapackage from version check.
# Change log file may be missing for these two types
# process glob helper methods filter nspkg and metapackages with filter type "Docs"
targeted_packages = process_glob_string(
args.glob_string, target_dir, args.package_filter_string, "Docs"
)
change_missing = verify_packages(targeted_packages)
if len(change_missing) > 0:
logging.error("Below packages do not have change log")
logging.error("***************************************************")
for pkg_name in change_missing.keys():
logging.error("{0} - {1}".format(pkg_name, change_missing[pkg_name]))
sys.exit(1)
|
