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
|
import os
from typing import Optional, Dict
def str_to_bool(input_string: str) -> bool:
"""
Takes a boolean string representation and returns a bool type value.
"""
if isinstance(input_string, bool):
return input_string
elif input_string.lower() in ("true", "t", "1"):
return True
elif input_string.lower() in ("false", "f", "0"):
return False
else:
return False
def discover_repo_root(input_repo: Optional[str] = None):
"""
Resolves the root of the repository given a current working directory. This function should be used if a target repo argument is not provided.
If the value of input_repo has value, that will supplant the path ascension logic.
"""
if input_repo is not None:
if os.path.exists(input_repo):
return input_repo
current_dir: str = os.getcwd()
while current_dir is not None and not (os.path.dirname(current_dir) == current_dir):
if os.path.exists(os.path.join(current_dir, ".git")):
return current_dir
else:
current_dir = os.path.dirname(current_dir)
raise Exception(
"Commands invoked against azure-sdk-tooling should either be run from within the repo directory or provide --repo_root argument that directs at one."
)
def get_artifact_directory(input_directory: Optional[str] = None) -> str:
"""
Resolves the root of an artifact directory that the \"sdk_build\" action will output to!
"""
if input_directory is not None:
if not os.path.exists(input_directory):
os.makedirs(input_directory)
return input_directory
return os.getenv("SDK_ARTIFACT_DIRECTORY", os.path.join(discover_repo_root(), ".artifacts"))
def get_log_directory(input_directory: Optional[str] = None) -> str:
"""
Resolves the location of the log directory.
"""
if input_directory is not None:
if not os.path.exists(input_directory):
os.makedirs(input_directory)
return input_directory
return os.getenv("SDK_LOG_DIRECTORY", os.path.join(discover_repo_root(), ".logs"))
def in_ci() -> int:
# TF_BUILD is set to `true` on azure devops agents, returns 1
# CI is set to `true` on github actions agents, return 2
# 0 otherwise
if os.getenv("TF_BUILD", None):
return 1
if os.getenv("CI", None):
return 2
return 0
def in_public() -> int:
# Returns 3 if the build originates from a pull request
# 0 otherwise
if os.getenv("BUILD_REASON") == "PullRequest" or os.getenv("GITHUB_EVENT_NAME") == "pull_request":
return 3
return 0
def in_analyze_weekly() -> int:
# Returns 4 if the build originates from the tests-weekly analyze job
# 0 otherwise
if (
"tests-weekly" in os.getenv("SYSTEM_DEFINITIONNAME", "")
and os.getenv("SYSTEM_STAGEDISPLAYNAME", "") == "Analyze_Test"
):
return 4
return 0
DEV_BUILD_IDENTIFIER = os.getenv("SDK_DEV_BUILD_IDENTIFIER", "a")
DEFAULT_BUILD_ID = os.getenv("GITHUB_RUN_ID", os.getenv("BUILD.BUILDID", os.getenv("SDK_BUILD_ID", "20220101.1")))
DEFAULT_ENVIRONMENT_VARIABLES = {
"SPHINX_APIDOC_OPTIONS": "members,undoc-members,inherited-members",
"PROXY_URL": "http://localhost:5000",
"VIRTUALENV_WHEEL": "0.45.1",
"VIRTUALENV_PIP": "24.0",
"VIRTUALENV_SETUPTOOLS": "75.3.2",
"PIP_EXTRA_INDEX_URL": "https://pypi.python.org/simple",
# I haven't spent much time looking to see if a variable exists when invoking uv run. there might be one already that we can depend
# on for get_pip_command adjustment.
"IN_UV": "1",
}
def set_environment_from_dictionary(settings: Dict[str, str]) -> None:
"""
Sets default environment variables for any given process.
Args:
settings (Dict[str, str]): A dictionary of environment variable names and their default values.
"""
for key, value in settings.items():
if key not in os.environ:
os.environ.setdefault(key, value)
def set_envvar_defaults() -> None:
"""
Sets default environment variables for any given process to our default dictionary.
Args:
settings (Dict[str, str]): A dictionary of environment variable names and their default values.
"""
set_environment_from_dictionary(DEFAULT_ENVIRONMENT_VARIABLES)
|
