Fix unit testing: Pass auth-token to restful API

to avoid rate limit

Signed-off-by: Jiahao XU <Jiahao_XU@outlook.com>
This commit is contained in:
Jiahao XU 2024-06-12 20:28:30 +10:00
parent 54149a0bf3
commit 1f363fefda
No known key found for this signature in database
GPG key ID: 76D1E687CA3C4928
4 changed files with 46 additions and 15 deletions

View file

@ -131,6 +131,8 @@ struct Inner {
auth_token: Option<CompactString>, auth_token: Option<CompactString>,
is_auth_token_valid: AtomicBool, is_auth_token_valid: AtomicBool,
only_use_restful_api: AtomicBool,
} }
/// Github API client for querying whether a release artifact exitsts. /// Github API client for querying whether a release artifact exitsts.
@ -147,9 +149,16 @@ impl GhApiClient {
auth_token, auth_token,
is_auth_token_valid: AtomicBool::new(true), is_auth_token_valid: AtomicBool::new(true),
only_use_restful_api: AtomicBool::new(false),
})) }))
} }
/// If you don't want to use GitHub GraphQL API for whatever reason, call this.
pub fn set_only_use_restful_api(&self) {
self.0.only_use_restful_api.store(true, Relaxed);
}
pub fn remote_client(&self) -> &remote::Client { pub fn remote_client(&self) -> &remote::Client {
&self.0.client &self.0.client
} }
@ -193,22 +202,24 @@ impl GhApiClient {
) -> Result<U, GhApiError> ) -> Result<U, GhApiError>
where where
GraphQLFn: Fn(&remote::Client, &T, &str) -> GraphQLFut, GraphQLFn: Fn(&remote::Client, &T, &str) -> GraphQLFut,
RestfulFn: Fn(&remote::Client, &T) -> RestfulFut, RestfulFn: Fn(&remote::Client, &T, Option<&str>) -> RestfulFut,
GraphQLFut: Future<Output = Result<U, GhApiError>> + Send + Sync + 'static, GraphQLFut: Future<Output = Result<U, GhApiError>> + Send + Sync + 'static,
RestfulFut: Future<Output = Result<U, GhApiError>> + Send + Sync + 'static, RestfulFut: Future<Output = Result<U, GhApiError>> + Send + Sync + 'static,
{ {
self.check_retry_after()?; self.check_retry_after()?;
if let Some(auth_token) = self.get_auth_token() { if !self.0.only_use_restful_api.load(Relaxed) {
match graphql_func(&self.0.client, data, auth_token).await { if let Some(auth_token) = self.get_auth_token() {
Err(GhApiError::Unauthorized) => { match graphql_func(&self.0.client, data, auth_token).await {
self.0.is_auth_token_valid.store(false, Relaxed); Err(GhApiError::Unauthorized) => {
self.0.is_auth_token_valid.store(false, Relaxed);
}
res => return res.map_err(|err| err.context("GraphQL API")),
} }
res => return res.map_err(|err| err.context("GraphQL API")),
} }
} }
restful_func(&self.0.client, data) restful_func(&self.0.client, data, self.get_auth_token())
.await .await
.map_err(|err| err.context("Restful API")) .map_err(|err| err.context("Restful API"))
} }
@ -369,6 +380,7 @@ mod test {
tag: CompactString::new_inline("cargo-audit/v0.17.6"), tag: CompactString::new_inline("cargo-audit/v0.17.6"),
}; };
#[allow(unused)]
pub(super) const ARTIFACTS: &[&str] = &[ pub(super) const ARTIFACTS: &[&str] = &[
"cargo-audit-aarch64-unknown-linux-gnu-v0.17.6.tgz", "cargo-audit-aarch64-unknown-linux-gnu-v0.17.6.tgz",
"cargo-audit-armv7-unknown-linux-gnueabihf-v0.17.6.tgz", "cargo-audit-armv7-unknown-linux-gnueabihf-v0.17.6.tgz",
@ -512,10 +524,17 @@ mod test {
fn create_client() -> Vec<GhApiClient> { fn create_client() -> Vec<GhApiClient> {
let client = create_remote_client(); let client = create_remote_client();
let mut gh_clients = vec![GhApiClient::new(client.clone(), None)]; let auth_token = env::var("CI_UNIT_TEST_GITHUB_TOKEN")
.ok()
.map(CompactString::from);
if let Ok(token) = env::var("CI_UNIT_TEST_GITHUB_TOKEN") { let gh_client = GhApiClient::new(client.clone(), auth_token.clone());
gh_clients.push(GhApiClient::new(client, Some(token.into()))); gh_client.set_only_use_restful_api();
let mut gh_clients = vec![gh_client];
if auth_token.is_some() {
gh_clients.push(GhApiClient::new(client, auth_token));
} }
gh_clients gh_clients

View file

@ -38,6 +38,7 @@ fn get_api_endpoint() -> &'static Url {
pub(super) fn issue_restful_api<T>( pub(super) fn issue_restful_api<T>(
client: &remote::Client, client: &remote::Client,
path: &[&str], path: &[&str],
auth_token: Option<&str>,
) -> impl Future<Output = Result<T, GhApiError>> + Send + Sync + 'static ) -> impl Future<Output = Result<T, GhApiError>> + Send + Sync + 'static
where where
T: DeserializeOwned, T: DeserializeOwned,
@ -50,11 +51,16 @@ where
debug!("Getting restful API: {url}"); debug!("Getting restful API: {url}");
let future = client let mut request_builder = client
.get(url) .get(url)
.header("Accept", "application/vnd.github+json") .header("Accept", "application/vnd.github+json")
.header("X-GitHub-Api-Version", "2022-11-28") .header("X-GitHub-Api-Version", "2022-11-28");
.send(false);
if let Some(auth_token) = auth_token {
request_builder = request_builder.bearer_auth(&auth_token);
}
let future = request_builder.send(false);
async move { async move {
let response = check_http_status_and_header(future.await?)?; let response = check_http_status_and_header(future.await?)?;

View file

@ -73,8 +73,13 @@ pub(super) fn fetch_release_artifacts_restful_api(
repo: GhRepo { owner, repo }, repo: GhRepo { owner, repo },
tag, tag,
}: &GhRelease, }: &GhRelease,
auth_token: Option<&str>,
) -> impl Future<Output = Result<Artifacts, GhApiError>> + Send + Sync + 'static { ) -> impl Future<Output = Result<Artifacts, GhApiError>> + Send + Sync + 'static {
issue_restful_api(client, &["repos", owner, repo, "releases", "tags", tag]) issue_restful_api(
client,
&["repos", owner, repo, "releases", "tags", tag],
auth_token,
)
} }
#[derive(Debug, Deserialize)] #[derive(Debug, Deserialize)]

View file

@ -44,8 +44,9 @@ impl RepoInfo {
pub(super) fn fetch_repo_info_restful_api( pub(super) fn fetch_repo_info_restful_api(
client: &remote::Client, client: &remote::Client,
GhRepo { owner, repo }: &GhRepo, GhRepo { owner, repo }: &GhRepo,
auth_token: Option<&str>,
) -> impl Future<Output = Result<Option<RepoInfo>, GhApiError>> + Send + Sync + 'static { ) -> impl Future<Output = Result<Option<RepoInfo>, GhApiError>> + Send + Sync + 'static {
issue_restful_api(client, &["repos", owner, repo]) issue_restful_api(client, &["repos", owner, repo], auth_token)
} }
#[derive(Debug, Deserialize)] #[derive(Debug, Deserialize)]