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 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391
|
from contextlib import suppress
import json
import logging
import os
import re
from azure_devtools.ci_tools.git_tools import get_add_diff_file_list
from pathlib import Path
from subprocess import check_call
from typing import Dict, Any
from glob import glob
import yaml
from .swaggertosdk.autorest_tools import build_autorest_options, generate_code
from .swaggertosdk.SwaggerToSdkCore import CONFIG_FILE_DPG, read_config
from jinja2 import Environment, FileSystemLoader
_LOGGER = logging.getLogger(__name__)
_SDK_FOLDER_RE = re.compile(r"^(sdk/[\w-]+)/(azure[\w-]+)/", re.ASCII)
DEFAULT_DEST_FOLDER = "./dist"
_DPG_README = "README.md"
def dpg_relative_folder(spec_folder: str) -> str:
return ("../" * 4) + spec_folder + "/"
def get_package_names(sdk_folder):
files = get_add_diff_file_list(sdk_folder)
matches = {_SDK_FOLDER_RE.search(f) for f in files}
package_names = {match.groups() for match in matches if match is not None}
return package_names
def init_new_service(package_name, folder_name, is_cadl = False):
if not is_cadl:
setup = Path(folder_name, package_name, "setup.py")
if not setup.exists():
check_call(
f"python -m packaging_tools --build-conf {package_name} -o {folder_name}",
shell=True,
)
ci = Path(folder_name, "ci.yml")
if not ci.exists():
with open("ci_template.yml", "r") as file_in:
content = file_in.readlines()
name = package_name.replace("azure-", "").replace("mgmt-", "")
content = [line.replace("MyService", name) for line in content]
with open(str(ci), "w") as file_out:
file_out.writelines(content)
else:
output_path = Path(folder_name) / package_name
if not (output_path / "sdk_packaging.toml").exists():
with open(output_path / "sdk_packaging.toml", "w") as file_out:
file_out.write("[packaging]\nauto_update = false")
# add ci.yaml
generate_ci(
template_path=Path("scripts/quickstart_tooling_dpg/template_ci"),
folder_path=Path(folder_name),
package_name=package_name
)
def update_servicemetadata(sdk_folder, data, config, folder_name, package_name, spec_folder, input_readme):
metadata = {
"commit": data["headSha"],
"repository_url": data["repoHttpsUrl"],
}
if "meta" in config:
readme_file = str(Path(spec_folder, input_readme))
global_conf = config["meta"]
local_conf = config.get("projects", {}).get(readme_file, {})
if "resource-manager" in input_readme:
cmd = ["autorest", input_readme]
else:
# autorest for DPG will be executed in package folder like: sdk/deviceupdate/azure-iot-deviceupdate/swagger
cmd = ["autorest", _DPG_README]
cmd += build_autorest_options(global_conf, local_conf)
# metadata
metadata.update({
"autorest": global_conf["autorest_options"]["version"],
"use": global_conf["autorest_options"]["use"],
"autorest_command": " ".join(cmd),
"readme": input_readme,
})
else:
metadata["cadl_src"] = input_readme
metadata.update(config)
_LOGGER.info("Metadata json:\n {}".format(json.dumps(metadata, indent=2)))
package_folder = Path(sdk_folder, folder_name, package_name).expanduser()
if not os.path.exists(package_folder):
_LOGGER.info(f"Package folder doesn't exist: {package_folder}")
_LOGGER.info("Failed to save metadata.")
return
metadata_file_path = os.path.join(package_folder, "_meta.json")
with open(metadata_file_path, "w") as writer:
json.dump(metadata, writer, indent=2)
_LOGGER.info(f"Saved metadata to {metadata_file_path}")
# Check whether MANIFEST.in includes _meta.json
if "resource-manager" in input_readme:
require_meta = "include _meta.json\n"
manifest_file = os.path.join(package_folder, "MANIFEST.in")
if not os.path.exists(manifest_file):
_LOGGER.info(f"MANIFEST.in doesn't exist: {manifest_file}")
return
includes = []
write_flag = False
with open(manifest_file, "r") as f:
includes = f.readlines()
if require_meta not in includes:
includes = [require_meta] + includes
write_flag = True
if write_flag:
with open(manifest_file, "w") as f:
f.write("".join(includes))
def judge_tag_preview(path: str) -> bool:
files = [i for i in Path(path).glob("**/*.py")]
default_api_version = "" # for multi-api
api_version = "" # for single-api
for file in files:
try:
with open(file, "r") as file_in:
list_in = file_in.readlines()
except:
_LOGGER.info(f"can not open {file}")
continue
for line in list_in:
if "DEFAULT_API_VERSION = " in line:
default_api_version += line.split("=")[-1].strip("\n") # collect all default api version
if default_api_version == "" and "api_version" in line:
api_version += ", ".join(re.findall("\d{4}-\d{2}-\d{2}[-a-z]*", line)) # collect all single api version
if default_api_version != "":
_LOGGER.info(f"find default api version:{default_api_version}")
return "preview" in default_api_version
_LOGGER.info(f"find single api version:{api_version}")
return "preview" in api_version
def extract_yaml_content(autorest_config: str) -> str:
num = []
content = autorest_config.split("\r\n")
for i in range(len(content)):
if "```" in content[i]:
num.append(i)
if len(num) != 2:
raise Exception(f"autorestConfig content is not valid: {autorest_config}")
return "\n".join(content[num[0] + 1 : num[1]])
def add_config_title(content: str) -> str:
return f"# autorest configuration for Python\n\n{content}"
def yaml_block(content: str, annotation: str = "", tag: str = "") -> str:
annotation = f"{annotation}\n\n" if annotation else annotation
return f"{annotation}" + f"``` yaml {tag}\n" + content + "```\n"
def gen_package_name(origin_config: Dict[str, Any]) -> str:
return Path(origin_config["output-folder"]).parts[-1]
def gen_basic_config(origin_config: Dict[str, Any], spec_folder: str) -> Dict[str, Any]:
return {
"package-name": gen_package_name(origin_config),
"license-header": "MICROSOFT_MIT_NO_VERSION",
"package-version": origin_config.get("package-version", "1.0.0b1"),
"require": [spec_folder + line for line in origin_config["require"]],
"package-mode": "dataplane",
"output-folder": "../",
}
def gen_general_namespace(package_name: str) -> str:
return package_name.replace("-", ".")
def gen_dpg_config_single_client(origin_config: Dict[str, Any], spec_folder: str) -> str:
package_name = Path(origin_config["output-folder"]).parts[-1]
readme_config = gen_basic_config(origin_config, spec_folder)
readme_config.update(
{
"namespace": gen_general_namespace(package_name),
}
)
readme_content = yaml_block(yaml.safe_dump(readme_config), "### Settings")
return add_config_title(readme_content)
def gen_tag_config(origin_config: Dict[str, Any]) -> Dict[str, Any]:
tag_config = {}
package_name = gen_package_name(origin_config)
for tag in origin_config["batch"]:
tag_name = tag["tag"]
extra_part = tag_name.split("-")[-1]
tag_config[tag_name] = {
"namespace": gen_general_namespace(package_name) + f".{extra_part}",
}
return tag_config
def gen_batch_config(origin_config: Dict[str, Any]) -> Dict[str, Any]:
batch_config = []
for item in origin_config["batch"]:
for _, value in item.items():
batch_config.append({value: True})
return {"batch": batch_config}
def gen_dpg_config_multi_client(origin_config: Dict[str, Any], spec_folder: str) -> str:
# generate config
basic_config = gen_basic_config(origin_config, spec_folder)
batch_config = gen_batch_config(origin_config)
tag_config = gen_tag_config(origin_config)
# convert to string
readme_content = yaml_block(yaml.dump(basic_config), "### Settings")
readme_content += yaml_block(yaml.dump(batch_config), "\n### Python multi-client")
for tag, value in tag_config.items():
readme_content += yaml_block(
yaml.dump(value),
f"\n### Tag: {tag}",
f"$({tag})",
)
return add_config_title(readme_content)
# generate swagger/README.md and return relative path based on SDK repo root path
def gen_dpg_config(autorest_config: str, spec_folder: str) -> str:
# remove useless lines
autorest_config = extract_yaml_content(autorest_config)
_LOGGER.info(f"autorestConfig after remove useless lines:\n{autorest_config}")
# make dir if not exist
origin_config = yaml.safe_load(autorest_config)
_LOGGER.info(f"autorestConfig: {origin_config}")
swagger_folder = str(Path(origin_config["output-folder"], "swagger"))
if not os.path.exists(swagger_folder):
os.makedirs(swagger_folder)
# generate autorest configuration
if "batch:" in autorest_config:
readme_content = gen_dpg_config_multi_client(origin_config, spec_folder)
else:
readme_content = gen_dpg_config_single_client(origin_config, spec_folder)
# output autorest configuration
swagger_readme = str(Path(swagger_folder, _DPG_README))
with open(swagger_readme, "w") as file:
file.write(readme_content)
return swagger_readme
def lookup_swagger_readme(rest_readme_path: str) -> str:
all_swagger_readme = glob(str(Path(f"sdk/*/*/swagger/{_DPG_README}")))
for readme in all_swagger_readme:
with open(readme, "r") as file:
content = file.read()
if rest_readme_path in content:
_LOGGER.info(f"find swagger readme: {readme}")
return readme
_LOGGER.info(f"do not find swagger readme which contains {rest_readme_path}")
return ""
def gen_dpg(rest_readme_path: str, autorest_config: str, spec_folder: str) -> Dict[str, Any]:
# generate or find swagger/README.md
if autorest_config:
swagger_readme = gen_dpg_config(autorest_config, spec_folder)
else:
swagger_readme = lookup_swagger_readme(rest_readme_path)
if not swagger_readme:
return
# extract global config
global_config = read_config(".", CONFIG_FILE_DPG)
# generate code
current_path = os.getcwd()
os.chdir(Path(swagger_readme).parent)
generate_code(_DPG_README, global_config["meta"], {})
os.chdir(current_path)
return global_config
def format_samples(sdk_code_path) -> None:
generate_sample_path = Path(sdk_code_path) / "generated_samples"
if not generate_sample_path.exists():
_LOGGER.info(f"not find generated_samples")
return
try:
import black
except Exception as e:
check_call("pip install black", shell=True)
import black
_BLACK_MODE = black.Mode()
_BLACK_MODE.line_length = 120
files = generate_sample_path.glob("**/*.py")
for path in files:
with open(path, "r") as fr:
file_content = fr.read()
with suppress(black.NothingChanged):
file_content = black.format_file_contents(file_content, fast=True, mode=_BLACK_MODE)
with open(path, "w") as fw:
fw.write(file_content)
_LOGGER.info(f"format generated_samples successfully")
def get_npm_package_version(package: str) -> Dict[any, any]:
temp_file = "python_temp.json"
check_call(f"npm list {package} -json > {temp_file}", shell=True)
with open(temp_file, "r") as file_in:
data = json.load(file_in)
if "dependencies" not in data:
_LOGGER.info(f"can not find {package}: {data}")
return {}
return data["dependencies"]
def generate_ci(template_path: Path, folder_path: Path, package_name: str) -> None:
ci = Path(folder_path, "ci.yml")
service_name = folder_path.name
safe_name = package_name.replace("-", "")
if not ci.exists():
env = Environment(loader=FileSystemLoader(template_path), keep_trailing_newline=True)
template = env.get_template('ci.yml')
content = template.render(package_name=package_name, service_name=service_name, safe_name=safe_name)
else:
with open(ci, "r") as file_in:
content = file_in.readlines()
for line in content:
if package_name in line:
return
content.append(f' - name: {package_name}\n')
content.append(f' safeName: {safe_name}\n')
with open(ci, "w") as file_out:
file_out.writelines(content)
def gen_cadl(cadl_relative_path: str, spec_folder: str) -> Dict[str, Any]:
cadl_python = "@azure-tools/cadl-python"
autorest_python = "@autorest/python"
# npm install tool
origin_path = os.getcwd()
with open("cadl_to_sdk_config.json", "r") as file_in:
cadl_python_dep = json.load(file_in)
os.chdir(Path(spec_folder) / cadl_relative_path)
if Path("package.json").exists():
with open("package.json", "r") as file_in:
cadl_tools = json.load(file_in)
else:
cadl_tools = {"dependencies:{}"}
cadl_tools["dependencies"].update(cadl_python_dep["dependencies"])
with open("package.json", "w") as file_out:
json.dump(cadl_tools, file_out)
check_call("npm install", shell=True)
# generate code
cadl_file = "client.cadl" if Path("client.cadl").exists() else "."
check_call(f"npx cadl compile {cadl_file} --emit {cadl_python} --arg \"python-sdk-folder={origin_path}\" ", shell=True)
# get version of codegen used in generation
npm_package_verstion = get_npm_package_version(autorest_python)
# return to original folder
os.chdir(origin_path)
return npm_package_verstion
|