Skip to content

Commit

Permalink
docs: add docs and e2e tests for admin
Browse files Browse the repository at this point in the history
  • Loading branch information
hopeyen committed Apr 22, 2024
1 parent 1691a7a commit b2a6eaf
Show file tree
Hide file tree
Showing 2 changed files with 153 additions and 2 deletions.
8 changes: 6 additions & 2 deletions docs/server_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,8 +79,6 @@ cargo run -p file-service -- --config ./file-server/template.toml

5. Access services via the additional endpoints:



**Cost and Status API**

Schema is provided at the `server-[]-schema.json`. One can access the graphql playground by navigating to the server's endpoint at `/files-status` or `/files-cost`.
Expand Down Expand Up @@ -115,10 +113,16 @@ Available mutations you can make, in addition to Status queries, are to add and
Curl query will be similar to the above examples, here we provide an example in the GraphQL version
```
mutation{
# Add an existing bundle
addBundles(deployments:["QmeD3dRVV6Gs84TRwiNj3tLt9mBEMVqy3GoWm7WN8oDzGz", "QmeaPp764FjQjPB66M9ijmQKmLhwBpHQhA7dEbH2FA1j3v"],
locations:["./example-file", "./example-file"]){
ipfsHash
}
# Create, publish, and serve a bundle
publishAndServeBundle(filenames: ["0017686116-5331aab87811944d-f8d105f60fa2e78d-17686021-default.dbin", "0017686115-f8d105f60fa2e78d-7d23a3e458beaff1-17686021-default.dbin"]) {
ipfsHash
}
}
```
with configuration
Expand Down
147 changes: 147 additions & 0 deletions file-exchange/tests/admin.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,147 @@
#[cfg(test)]
mod tests {
use serde_json::{json, Value};
use std::{process::Command, time::Duration};
use tempfile::tempdir;
use tokio::fs;

use file_exchange::{
config::{DownloaderArgs, LocalDirectory},
download_client::Downloader,
manifest::ipfs::IpfsClient,
test_util::server_ready,
};

#[tokio::test]
async fn test_admin_publish_and_serve() {
std::env::set_var("RUST_LOG", "off,file_exchange=trace,file_transfer=trace,file_service=trace,indexer_service=trace,indexer_common=trace");
file_exchange::config::init_tracing("pretty").unwrap();

let client = IpfsClient::new("https://ipfs.network.thegraph.com")
.expect("Could not create client to thegraph IPFS gateway");
// 1. Setup server
let mut server_process = Command::new("cargo")
.arg("run")
.arg("-p")
.arg("file-service")
.arg("--")
.arg("--config")
.arg("./tests/test0.toml")
.spawn()
.expect("Failed to start server");
tracing::debug!("Wait 10 seconds");
tokio::time::sleep(Duration::from_secs(3)).await;
let _ = server_ready("http://localhost:5677").await;

// 2. admin command
// Read status
let bundles_query = json!({
"query": r#"query {
bundles{
ipfsHash
}
}"#
});
let res = reqwest::Client::new()
.post("http://0.0.0.0:5664/admin")
.header("Content-Type", "application/json")
.header("Authorization", "Bearer slayyy")
.json(&bundles_query)
.send()
.await
.expect("GraphQL admin bundle request gets response");
assert!(res.status().is_success());
let response_body: Value = res.json().await.expect("Status response is a json value");
// Navigate through the JSON to extract the `ipfsHash` values
let ipfs_hashes: Vec<String> = response_body["data"]["bundles"]
.as_array()
.expect("Bundles in response")
.iter()
.filter_map(|bundle| bundle["ipfsHash"].as_str().map(String::from))
.collect();
assert!(ipfs_hashes.len() == 1);

// Mutation: publish and serve new files
let graphql_query = json!({
"query": r#"mutation {
publishAndServeBundle(filenames: ["0017686116-5331aab87811944d-f8d105f60fa2e78d-17686021-default.dbin", "0017686115-f8d105f60fa2e78d-7d23a3e458beaff1-17686021-default.dbin"]) {
ipfsHash
}
}"#
});

let res = reqwest::Client::new()
.post("http://0.0.0.0:5664/admin")
.header("Content-Type", "application/json")
.header("Authorization", "Bearer slayyy")
.json(&graphql_query)
.send()
.await
.expect("GraphQL admin mutation request gets a response");

assert!(res.status().is_success());
let response_body: Value = res.json().await.expect("Response is a json value");
let ipfs_hash = response_body["data"]["publishAndServeBundle"]["ipfsHash"]
.as_str()
.expect("Response has IPFS hash");
assert!(!ipfs_hashes.contains(&ipfs_hash.to_string())); // should be a new hash

// Check public status (checking 5665/admin should be the same)
let res = reqwest::Client::new()
.post("http://0.0.0.0:5677/files-status")
.header("Content-Type", "application/json")
.json(&bundles_query)
.send()
.await
.expect("GraphQL status bundle request gets response");
assert!(res.status().is_success());
let response_body: Value = res.json().await.expect("Status response is a json value");
// Navigate through the JSON to extract the `ipfsHash` values
let ipfs_hashes: Vec<String> = response_body["data"]["bundles"]
.as_array()
.expect("Bundles in response")
.iter()
.filter_map(|bundle| bundle["ipfsHash"].as_str().map(String::from))
.collect();
assert!(ipfs_hashes.contains(&ipfs_hash.to_string())); // should be a new hash

// 3. Setup downloader
let temp_dir = tempdir().unwrap();
let main_dir = temp_dir.path().to_path_buf();

let downloader_args = DownloaderArgs {
storage_method: file_exchange::config::StorageMethod::LocalFiles(LocalDirectory {
main_dir: main_dir.to_str().unwrap().to_string(),
}),
ipfs_hash: ipfs_hash.to_string(),
indexer_endpoints: [
"http://localhost:5679".to_string(),
"http://localhost:5677".to_string(),
]
.to_vec(),
verifier: None,
mnemonic: None,
free_query_auth_token: Some("Bearer free-token".to_string()),
provider: None,
provider_concurrency: 2,
..Default::default()
};

let downloader = Downloader::new(client, downloader_args).await;

// 4. Perform the download
let download_result = downloader.download_target().await;

// 5. Validate the download
tracing::info!(
result = tracing::field::debug(&download_result),
"Download result"
);
assert!(download_result.is_ok());
// Further checks can be added to verify the contents of the downloaded files

// 6. Cleanup
fs::remove_dir_all(temp_dir).await.unwrap();
let _ = server_process.kill();
}
}

0 comments on commit b2a6eaf

Please sign in to comment.