gcp.rs 0.0%

0 of 57 lines run, 0 of 20 functions · run #418 on main · run missed

//! Google Cloud Storage: `gs://BUCKET/PREFIX`.
//!
//! Credentials, in Google's own order: a service account key file named
//! by `?credentials=PATH` or `GOOGLE_APPLICATION_CREDENTIALS` (which may
//! also hold application default credentials), the key or path in
//! `GOOGLE_SERVICE_ACCOUNT*`, then the application default credentials
//! `gcloud auth application-default login` wrote, then the instance's
//! service account. `?endpoint=URL` points at another endpoint.

use crate::StoreUrl;
use object_store::gcp::{GoogleCloudStorage, GoogleCloudStorageBuilder};
use oxy_core::strata::{Error, Result};

pub const HINT: &str = "run `gcloud auth application-default login`, or set GOOGLE_APPLICATION_CREDENTIALS (or add ?credentials=PATH to the remote URL) to a service account key file";

/// Whether a credentials file is a service account key, as opposed to
/// application default credentials.
fn is_service_account_key(path: &str) -> bool {
    std::fs::read_to_string(path)
        .ok()
        .and_then(|t| serde_json::from_str::<serde_json::Value>(&t).ok())
        .and_then(|v| {
            v.get("type")
                .and_then(|t| t.as_str())
                .map(|t| t == "service_account")
        })
        .unwrap_or(false)
}

/// With `key` (a service account key's JSON) given, only it is used.
pub fn open(url: &StoreUrl, key: Option<&str>) -> Result<GoogleCloudStorage> {
    if let Some(key) = key {
        let mut b = GoogleCloudStorageBuilder::new()
            .with_bucket_name(&url.host)
            .with_http_connector(crate::http::UreqConnector)
            .with_service_account_key(key);
        if let Some(endpoint) = url.param("endpoint") {
            b = b.with_base_url(endpoint);
        }
        return b
            .build()
            .map_err(|e| Error::Backend(format!("{}: {e}", url.plain())));
    }
    let mut b = GoogleCloudStorageBuilder::from_env()
        .with_bucket_name(&url.host)
        .with_http_connector(crate::http::UreqConnector);
    let file = url.param("credentials").map(str::to_string).or_else(|| {
        std::env::var("GOOGLE_APPLICATION_CREDENTIALS")
            .ok()
            .filter(|v| !v.is_empty())
    });
    if let Some(path) = file {
        if !std::path::Path::new(&path).is_file() {
            return Err(Error::Backend(format!(
                "{}: the credentials file {path} does not exist: {HINT}",
                url.plain()
            )));
        }
        b = if is_service_account_key(&path) {
            b.with_service_account_path(path)
        } else {
            b.with_application_credentials(path)
        };
    }
    if let Some(endpoint) = url.param("endpoint") {
        b = b.with_base_url(endpoint);
    }
    b.build()
        .map_err(|e| Error::Backend(format!("{}: {e}: {HINT}", url.plain())))
}

1		//! Google Cloud Storage: `gs://BUCKET/PREFIX`.
2		//!
3		//! Credentials, in Google's own order: a service account key file named
4		//! by `?credentials=PATH` or `GOOGLE_APPLICATION_CREDENTIALS` (which may
5		//! also hold application default credentials), the key or path in
6		//! `GOOGLE_SERVICE_ACCOUNT*`, then the application default credentials
7		//! `gcloud auth application-default login` wrote, then the instance's
8		//! service account. `?endpoint=URL` points at another endpoint.
9
10		use crate::StoreUrl;
11		use object_store::gcp::{GoogleCloudStorage, GoogleCloudStorageBuilder};
12		use oxy_core::strata::{Error, Result};
13
14		pub const HINT: &str = "run `gcloud auth application-default login`, or set GOOGLE_APPLICATION_CREDENTIALS (or add ?credentials=PATH to the remote URL) to a service account key file";
15
16		/// Whether a credentials file is a service account key, as opposed to
17		/// application default credentials.
18	0×	fn is_service_account_key(path: &str) -> bool {
19	0×	std::fs::read_to_string(path)
20	0×	.ok()
21	0×	.and_then(\|t\| serde_json::from_str::<serde_json::Value>(&t).ok())
22	0×	.and_then(\|v\| {
23	0×	v.get("type")
24	0×	.and_then(\|t\| t.as_str())
25	0×	.map(\|t\| t == "service_account")
26	0×	})
27	0×	.unwrap_or(false)
28	0×	}
29
30		/// With `key` (a service account key's JSON) given, only it is used.
31	0×	pub fn open(url: &StoreUrl, key: Option<&str>) -> Result<GoogleCloudStorage> {
32	0×	if let Some(key) = key {
33	0×	let mut b = GoogleCloudStorageBuilder::new()
34	0×	.with_bucket_name(&url.host)
35	0×	.with_http_connector(crate::http::UreqConnector)
36	0×	.with_service_account_key(key);
37	0×	if let Some(endpoint) = url.param("endpoint") {
38	0×	b = b.with_base_url(endpoint);
39	0×	}
40	0×	return b
41	0×	.build()
42	0×	.map_err(\|e\| Error::Backend(format!("{}: {e}", url.plain())));
43	0×	}
44	0×	let mut b = GoogleCloudStorageBuilder::from_env()
45	0×	.with_bucket_name(&url.host)
46	0×	.with_http_connector(crate::http::UreqConnector);
47	0×	let file = url.param("credentials").map(str::to_string).or_else(\|\| {
48	0×	std::env::var("GOOGLE_APPLICATION_CREDENTIALS")
49	0×	.ok()
50	0×	.filter(\|v\| !v.is_empty())
51	0×	});
52	0×	if let Some(path) = file {
53	0×	if !std::path::Path::new(&path).is_file() {
54	0×	return Err(Error::Backend(format!(
55	0×	"{}: the credentials file {path} does not exist: {HINT}",
56	0×	url.plain()
57	0×	)));
58	0×	}
59	0×	b = if is_service_account_key(&path) {
60	0×	b.with_service_account_path(path)
61		} else {
62	0×	b.with_application_credentials(path)
63		};
64	0×	}
65	0×	if let Some(endpoint) = url.param("endpoint") {
66	0×	b = b.with_base_url(endpoint);
67	0×	}
68	0×	b.build()
69	0×	.map_err(\|e\| Error::Backend(format!("{}: {e}: {HINT}", url.plain())))
70	0×	}

`/`	Search
`g` `c`	Code
`g` `h`	History
`g` `b`	Bookmarks
`g` `t`	Trust
`y`	Permalink to this state (files and trees)
`?`	This sheet

Coverage / crates/oxy-strata/src/gcp.rs 0.0%

Keyboard