nerdbank_gitversioning/cloud_build_services/
mod.rs1mod appveyor;
7mod atlassian_bamboo;
8mod bitbucket_cloud;
9mod github_actions;
10mod gitlab;
11mod jenkins;
12mod space_automation;
13mod team_city;
14mod travis;
15mod visual_studio_team_services;
16
17pub use appveyor::AppVeyor;
18pub use atlassian_bamboo::AtlassianBamboo;
19pub use bitbucket_cloud::BitbucketCloud;
20pub use github_actions::GitHubActions;
21pub use gitlab::GitLab;
22pub use jenkins::Jenkins;
23pub use space_automation::SpaceAutomation;
24pub use team_city::TeamCity;
25pub use travis::Travis;
26pub use visual_studio_team_services::VisualStudioTeamServices;
27
28#[cfg(test)]
29mod tests {
30 use super::*;
31 use crate::cloud::{CloudBuild, active};
32 use std::ffi::OsString;
33 use std::sync::Mutex;
34
35 static ENVIRONMENT_LOCK: Mutex<()> = Mutex::new(());
36
37 const DETECTION_VARIABLES: &[&str] = &[
38 "APPVEYOR",
39 "SYSTEM_TEAMPROJECTID",
40 "GITHUB_ACTIONS",
41 "BUILD_VCS_NUMBER",
42 "bamboo.buildKey",
43 "JENKINS_URL",
44 "GITLAB_CI",
45 "TRAVIS",
46 "JB_SPACE_GIT_REVISION",
47 "BITBUCKET_PIPELINE_UUID",
48 "BITBUCKET_STEP_UUID",
49 "BITBUCKET_STEP_TRIGGERER_UUID",
50 ];
51
52 struct EnvironmentGuard(Vec<(&'static str, Option<OsString>)>);
53
54 impl EnvironmentGuard {
55 fn set(values: &[(&'static str, Option<&str>)]) -> Self {
56 let names = DETECTION_VARIABLES
57 .iter()
58 .copied()
59 .chain(values.iter().map(|(name, _)| *name))
60 .collect::<std::collections::HashSet<_>>();
61 let old_values = names
62 .iter()
63 .map(|name| (*name, std::env::var_os(name)))
64 .collect();
65 for name in DETECTION_VARIABLES {
66 unsafe { std::env::remove_var(name) };
68 }
69 for (name, value) in values {
70 match value {
71 Some(value) => {
72 unsafe { std::env::set_var(name, value) };
74 }
75 None => {
76 unsafe { std::env::remove_var(name) };
78 }
79 }
80 }
81 Self(old_values)
82 }
83 }
84
85 impl Drop for EnvironmentGuard {
86 fn drop(&mut self) {
87 for (name, value) in &self.0 {
88 match value {
89 Some(value) => {
90 unsafe { std::env::set_var(name, value) };
92 }
93 None => {
94 unsafe { std::env::remove_var(name) };
96 }
97 }
98 }
99 }
100 }
101
102 #[test]
103 fn detects_each_provider() {
104 type ProviderCase<'a> = (&'a dyn CloudBuild, &'a [(&'static str, Option<&'a str>)]);
105
106 let _lock = ENVIRONMENT_LOCK.lock().unwrap();
107 let cases: &[ProviderCase<'_>] = &[
108 (&AppVeyor, &[("APPVEYOR", Some("True"))]),
109 (
110 &VisualStudioTeamServices,
111 &[("SYSTEM_TEAMPROJECTID", Some("1"))],
112 ),
113 (&GitHubActions, &[("GITHUB_ACTIONS", Some("true"))]),
114 (&TeamCity, &[("BUILD_VCS_NUMBER", Some("abc"))]),
115 (&AtlassianBamboo, &[("bamboo.buildKey", Some("key"))]),
116 (&Jenkins, &[("JENKINS_URL", Some("https://jenkins/"))]),
117 (&GitLab, &[("GITLAB_CI", Some("true"))]),
118 (&Travis, &[("TRAVIS", Some("true"))]),
119 (&SpaceAutomation, &[("JB_SPACE_GIT_REVISION", Some("abc"))]),
120 (
121 &BitbucketCloud,
122 &[
123 ("BITBUCKET_PIPELINE_UUID", Some("pipeline")),
124 ("BITBUCKET_STEP_UUID", Some("step")),
125 ("BITBUCKET_STEP_TRIGGERER_UUID", Some("trigger")),
126 ],
127 ),
128 ];
129
130 for (provider, variables) in cases {
131 let _environment = EnvironmentGuard::set(variables);
132 assert!(
133 provider.is_applicable(),
134 "{} was not detected",
135 provider.name()
136 );
137 assert_eq!(active().unwrap().name(), provider.name());
138 }
139 }
140
141 #[test]
142 fn provider_refs_match_managed_behavior() {
143 let _lock = ENVIRONMENT_LOCK.lock().unwrap();
144
145 {
146 let _environment = EnvironmentGuard::set(&[
147 ("APPVEYOR", Some("True")),
148 ("APPVEYOR_REPO_BRANCH", Some("main")),
149 ("APPVEYOR_PULL_REQUEST_NUMBER", Some("12")),
150 ("APPVEYOR_REPO_TAG", Some("TRUE")),
151 ("APPVEYOR_REPO_TAG_NAME", Some("v1")),
152 ]);
153 assert_eq!(AppVeyor.building_branch(), None);
154 assert_eq!(AppVeyor.building_tag().as_deref(), Some("refs/tags/v1"));
155 assert!(AppVeyor.is_pull_request());
156 }
157 {
158 let _environment = EnvironmentGuard::set(&[
159 ("BUILD_SOURCEBRANCH", Some("refs/pull/12/merge")),
160 ("SYSTEM_TEAMPROJECTID", Some("1")),
161 ]);
162 assert!(VisualStudioTeamServices.is_pull_request());
163 assert_eq!(VisualStudioTeamServices.building_branch(), None);
164 }
165 {
166 let _environment = EnvironmentGuard::set(&[
167 ("CI_COMMIT_TAG", Some("1.0.0")),
168 ("CI_COMMIT_REF_NAME", Some("main")),
169 ("CI_COMMIT_SHA", Some("abc")),
170 ("GITLAB_CI", Some("true")),
171 ]);
172 assert_eq!(GitLab.building_branch(), None);
173 assert_eq!(GitLab.building_tag().as_deref(), Some("refs/tags/1.0.0"));
174 assert_eq!(GitLab.git_commit_id().as_deref(), Some("abc"));
175 }
176 {
177 let _environment =
178 EnvironmentGuard::set(&[("CI_COMMIT_TAG", None), ("CI_COMMIT_REF_NAME", Some(""))]);
179 assert_eq!(GitLab.building_branch(), None);
180 }
181 for event_name in ["pull_request", "pull_request_target"] {
182 let _environment = EnvironmentGuard::set(&[("GITHUB_EVENT_NAME", Some(event_name))]);
183 assert!(GitHubActions.is_pull_request());
184 }
185 {
186 let _environment = EnvironmentGuard::set(&[("GITHUB_EVENT_NAME", Some("push"))]);
187 assert!(!GitHubActions.is_pull_request());
188 }
189 {
190 let _environment = EnvironmentGuard::set(&[
191 ("BITBUCKET_BRANCH", Some("main")),
192 ("BITBUCKET_TAG", Some("v1")),
193 ("BITBUCKET_PR_ID", Some(" ")),
194 ]);
195 assert_eq!(
196 BitbucketCloud.building_branch().as_deref(),
197 Some("refs/heads/main")
198 );
199 assert_eq!(
200 BitbucketCloud.building_tag().as_deref(),
201 Some("refs/tags/v1")
202 );
203 assert!(!BitbucketCloud.is_pull_request());
204 }
205 }
206
207 #[test]
208 fn service_message_outputs_and_environment_updates_are_exact() {
209 let mut output = Vec::new();
210 let mut errors = Vec::new();
211
212 let variables = VisualStudioTeamServices
213 .set_cloud_build_number("1.2.3", &mut output, &mut errors)
214 .unwrap();
215 assert_eq!(output, b"##vso[build.updatebuildnumber]1.2.3\n");
216 assert_eq!(variables["BUILD_BUILDNUMBER"], "1.2.3");
217
218 output.clear();
219 let variables = VisualStudioTeamServices
220 .set_cloud_build_variable("Git.Build.Version", "value", &mut output, &mut errors)
221 .unwrap();
222 assert_eq!(
223 output,
224 b"##vso[task.setvariable variable=Git.Build.Version;]value\n\
225 ##vso[task.setvariable variable=Git.Build.Version;isOutput=true;]value\n"
226 );
227 assert_eq!(variables["GIT_BUILD_VERSION"], "value");
228
229 output.clear();
230 let variables = VisualStudioTeamServices
231 .set_cloud_build_number("1%\r\n2", &mut output, &mut errors)
232 .unwrap();
233 assert_eq!(output, b"##vso[build.updatebuildnumber]1%AZP25%0D%0A2\n");
234 assert_eq!(variables["BUILD_BUILDNUMBER"], "1%\r\n2");
235
236 output.clear();
237 let variables = VisualStudioTeamServices
238 .set_cloud_build_variable("N%;]\r\n", "V%\r\n", &mut output, &mut errors)
239 .unwrap();
240 assert_eq!(
241 output,
242 b"##vso[task.setvariable variable=N%AZP25%3B%5D%0D%0A;]V%AZP25%0D%0A\n\
243 ##vso[task.setvariable variable=N%AZP25%3B%5D%0D%0A;isOutput=true;]V%AZP25%0D%0A\n"
244 );
245 assert_eq!(variables["N%;]\r\n"], "V%\r\n");
246
247 output.clear();
248 TeamCity
249 .set_cloud_build_variable("Name", "Value", &mut output, &mut errors)
250 .unwrap();
251 assert_eq!(
252 output,
253 b"##teamcity[setParameter name='Name' value='Value']\n\
254 ##teamcity[setParameter name='system.Name' value='Value']\n"
255 );
256
257 output.clear();
258 TeamCity
259 .set_cloud_build_number("|'\n\r[]", &mut output, &mut errors)
260 .unwrap();
261 assert_eq!(output, b"##teamcity[buildNumber '|||'|n|r|[|]']\n");
262
263 output.clear();
264 TeamCity
265 .set_cloud_build_variable("|'\n\r[]", "|'\n\r[]", &mut output, &mut errors)
266 .unwrap();
267 assert_eq!(
268 output,
269 b"##teamcity[setParameter name='|||'|n|r|[|]' value='|||'|n|r|[|]']\n\
270 ##teamcity[setParameter name='system.|||'|n|r|[|]' value='|||'|n|r|[|]']\n"
271 );
272 }
273}