Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: add flag for router IP local run #565

Merged
merged 13 commits into from
Jan 10, 2023
Merged

feat: add flag for router IP local run #565

Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
47b619b
feat: add flag for router IP local run
joshua-mo-143 Jan 4, 2023
f43e2e5
refactor: amend ipaddr setting, local run init fn
joshua-mo-143 Jan 5, 2023
1794cc6
refactor: delete unnecessary dependency
joshua-mo-143 Jan 5, 2023
288b0f7
Revert "refactor: delete unnecessary dependency"
joshua-mo-143 Jan 5, 2023
cabab8c
refactor: remove unnecessary dep (amendment)
joshua-mo-143 Jan 5, 2023
b8fe057
clippy
joshua-mo-143 Jan 5, 2023
20da60e
amendment from clippy warning (needless borrow)
joshua-mo-143 Jan 5, 2023
b00e9e2
refactor: apply cargo fmt diffs
joshua-mo-143 Jan 5, 2023
5471e66
refactor: return URL from run test setup fn
joshua-mo-143 Jan 6, 2023
127fb5f
refactor: change flag name to be 'external'
joshua-mo-143 Jan 6, 2023
75c2895
refactor: use passed args directly for struct
joshua-mo-143 Jan 6, 2023
1df901a
test: make sure tests align to proper folders
joshua-mo-143 Jan 6, 2023
d273426
Merge branch 'main' into main
oddgrd Jan 9, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions cargo-shuttle/src/args.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,9 @@ pub struct RunArgs {
/// port to start service on
#[clap(long, default_value = "8000")]
pub port: u16,
/// use router ip address instead of localhost
#[clap(long)]
pub router_ip: bool,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sold on the name, but can't think of anything better either 😅

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The only other things I can really think of are network or local_ip, but yeah to be honest I'm not huge on either of them and router_ip is not really that descriptive

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Honestly tempted to use network or lan as the flag since router_ip or use_router_ip isn't technically accurate anymore, what do you think?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, I was thinking more like 'host' but don't like it. How about external?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok that sounds like a good idea, I'll add that in then

}

#[derive(Parser, Debug)]
Expand Down
8 changes: 7 additions & 1 deletion cargo-shuttle/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -405,7 +405,13 @@ impl Shuttle {
secrets,
working_directory.to_path_buf(),
)?;
let addr = SocketAddr::new(Ipv4Addr::LOCALHOST.into(), run_args.port);
let addr = if run_args.router_ip {
std::net::IpAddr::V4(Ipv4Addr::new(0, 0, 0, 0))
} else {
Ipv4Addr::LOCALHOST.into()
};

let addr = SocketAddr::new(addr, run_args.port);

trace!("loading project");
println!(
Expand Down
115 changes: 72 additions & 43 deletions cargo-shuttle/tests/integration/run.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,28 @@ use std::{fs::canonicalize, process::exit, time::Duration};
use tokio::time::sleep;

/// creates a `cargo-shuttle` run instance with some reasonable defaults set.
async fn cargo_shuttle_run(working_directory: &str) -> u16 {
async fn cargo_shuttle_run(working_directory: &str, router_ip: bool) -> String {
let working_directory = canonicalize(working_directory).unwrap();

let port = pick_unused_port().unwrap();
let run_args = RunArgs { port };

let url = if !router_ip {
format!("http://localhost:{port}")
} else {
format!("http://0.0.0.0:{port}")
};

let run_args = if !router_ip {
RunArgs {
port,
router_ip: false,
}
} else {
RunArgs {
port,
router_ip: true,
}
};
chesedo marked this conversation as resolved.
Show resolved Hide resolved

let runner = Shuttle::new().unwrap().run(Args {
api_url: Some("http://shuttle.invalid:80".to_string()),
Expand All @@ -34,28 +52,23 @@ async fn cargo_shuttle_run(working_directory: &str) -> u16 {
tokio::spawn(runner);

// Wait for service to be responsive
while (reqwest::Client::new()
.get(format!("http://localhost:{port}"))
.send()
.await)
.is_err()
{
while (reqwest::Client::new().get(url.clone()).send().await).is_err() {
println!(
"waiting for '{}' to start up...",
working_directory.display()
);
sleep(Duration::from_millis(350)).await;
}

port
url
}

#[tokio::test(flavor = "multi_thread")]
async fn rocket_hello_world() {
let port = cargo_shuttle_run("../examples/rocket/hello-world").await;
let url = cargo_shuttle_run("../examples/rocket/hello-world", false).await;

let request_text = reqwest::Client::new()
.get(format!("http://localhost:{port}/hello"))
.get(format!("{url}/hello"))
.send()
.await
.unwrap()
Expand All @@ -68,10 +81,10 @@ async fn rocket_hello_world() {

#[tokio::test(flavor = "multi_thread")]
async fn rocket_secrets() {
let port = cargo_shuttle_run("../examples/rocket/secrets").await;
let url = cargo_shuttle_run("../examples/rocket/secrets", false).await;

let request_text = reqwest::Client::new()
.get(format!("http://localhost:{port}/secret"))
.get(format!("{url}/secret"))
.send()
.await
.unwrap()
Expand All @@ -85,11 +98,11 @@ async fn rocket_secrets() {
// This example uses a shared Postgres. Thus local runs should create a docker container for it.
#[tokio::test(flavor = "multi_thread")]
async fn rocket_postgres() {
let port = cargo_shuttle_run("../examples/rocket/postgres").await;
let url = cargo_shuttle_run("../examples/rocket/secrets", false).await;
oddgrd marked this conversation as resolved.
Show resolved Hide resolved
let client = reqwest::Client::new();

let post_text = client
.post(format!("http://localhost:{port}/todo"))
.post(format!("{url}/todo"))
.body("{\"note\": \"Deploy to shuttle\"}")
.send()
.await
Expand All @@ -101,7 +114,7 @@ async fn rocket_postgres() {
assert_eq!(post_text, "{\"id\":1,\"note\":\"Deploy to shuttle\"}");

let request_text = client
.get(format!("http://localhost:{port}/todo/1"))
.get(format!("{url}/todo/1"))
.send()
.await
.unwrap()
Expand All @@ -114,11 +127,11 @@ async fn rocket_postgres() {

#[tokio::test(flavor = "multi_thread")]
async fn rocket_authentication() {
let port = cargo_shuttle_run("../examples/rocket/authentication").await;
let url = cargo_shuttle_run("../examples/rocket/secrets", false).await;
let client = reqwest::Client::new();

let public_text = client
.get(format!("http://localhost:{port}/public"))
.get(format!("{url}/public"))
.send()
.await
.unwrap()
Expand All @@ -132,7 +145,7 @@ async fn rocket_authentication() {
);

let private_status = client
.get(format!("http://localhost:{port}/private"))
.get(format!("{url}/private"))
.send()
.await
.unwrap()
Expand All @@ -141,7 +154,7 @@ async fn rocket_authentication() {
assert_eq!(private_status, StatusCode::FORBIDDEN);

let body = client
.post(format!("http://localhost:{port}/login"))
.post(format!("{url}/login"))
.body("{\"username\": \"username\", \"password\": \"password\"}")
.send()
.await
Expand All @@ -153,7 +166,7 @@ async fn rocket_authentication() {
let token = format!("Bearer {}", json["token"].as_str().unwrap());

let private_text = client
.get(format!("http://localhost:{port}/private"))
.get(format!("{url}/private"))
.header("Authorization", token)
.send()
.await
Expand All @@ -170,10 +183,10 @@ async fn rocket_authentication() {

#[tokio::test(flavor = "multi_thread")]
async fn actix_web_hello_world() {
let port = cargo_shuttle_run("../examples/actix-web/hello-world").await;
let url = cargo_shuttle_run("../examples/rocket/secrets", false).await;

let request_text = reqwest::Client::new()
.get(format!("http://localhost:{port}/hello"))
.get(format!("{url}/hello"))
.send()
.await
.unwrap()
Expand All @@ -186,10 +199,10 @@ async fn actix_web_hello_world() {

#[tokio::test(flavor = "multi_thread")]
async fn axum_hello_world() {
let port = cargo_shuttle_run("../examples/axum/hello-world").await;
let url = cargo_shuttle_run("../examples/rocket/secrets", false).await;

let request_text = reqwest::Client::new()
.get(format!("http://localhost:{port}/hello"))
.get(format!("{url}/hello"))
.send()
.await
.unwrap()
Expand All @@ -202,10 +215,10 @@ async fn axum_hello_world() {

#[tokio::test(flavor = "multi_thread")]
async fn tide_hello_world() {
let port = cargo_shuttle_run("../examples/tide/hello-world").await;
let url = cargo_shuttle_run("../examples/rocket/secrets", false).await;

let request_text = reqwest::Client::new()
.get(format!("http://localhost:{port}/hello"))
.get(format!("{url}/hello"))
.send()
.await
.unwrap()
Expand All @@ -218,10 +231,10 @@ async fn tide_hello_world() {

#[tokio::test(flavor = "multi_thread")]
async fn tower_hello_world() {
let port = cargo_shuttle_run("../examples/tower/hello-world").await;
let url = cargo_shuttle_run("../examples/rocket/secrets", false).await;

let request_text = reqwest::Client::new()
.get(format!("http://localhost:{port}/hello"))
.get(format!("{url}/hello"))
.send()
.await
.unwrap()
Expand All @@ -234,10 +247,10 @@ async fn tower_hello_world() {

#[tokio::test(flavor = "multi_thread")]
async fn warp_hello_world() {
let port = cargo_shuttle_run("../examples/warp/hello-world").await;
let url = cargo_shuttle_run("../examples/warp/hello-world", false).await;

let request_text = reqwest::Client::new()
.get(format!("http://localhost:{port}/hello"))
.get(format!("{url}/hello"))
.send()
.await
.unwrap()
Expand All @@ -250,10 +263,10 @@ async fn warp_hello_world() {

#[tokio::test(flavor = "multi_thread")]
async fn poem_hello_world() {
let port = cargo_shuttle_run("../examples/poem/hello-world").await;
let url = cargo_shuttle_run("../examples/poem/hello-world", false).await;

let request_text = reqwest::Client::new()
.get(format!("http://localhost:{port}/hello"))
.get(format!("{url}/hello"))
.send()
.await
.unwrap()
Expand All @@ -267,11 +280,11 @@ async fn poem_hello_world() {
// This example uses a shared Postgres. Thus local runs should create a docker container for it.
#[tokio::test(flavor = "multi_thread")]
async fn poem_postgres() {
let port = cargo_shuttle_run("../examples/poem/postgres").await;
let url = cargo_shuttle_run("../examples/poem/postgres", false).await;
let client = reqwest::Client::new();

let post_text = client
.post(format!("http://localhost:{port}/todo"))
.post(format!("{url}/todo"))
.body("{\"note\": \"Deploy to shuttle\"}")
.header("content-type", "application/json")
.send()
Expand All @@ -284,7 +297,7 @@ async fn poem_postgres() {
assert_eq!(post_text, "{\"id\":1,\"note\":\"Deploy to shuttle\"}");

let request_text = client
.get(format!("http://localhost:{port}/todo/1"))
.get(format!("{url}/todo/1"))
.send()
.await
.unwrap()
Expand All @@ -298,12 +311,12 @@ async fn poem_postgres() {
// This example uses a shared MongoDb. Thus local runs should create a docker container for it.
#[tokio::test(flavor = "multi_thread")]
async fn poem_mongodb() {
let port = cargo_shuttle_run("../examples/poem/mongodb").await;
let url = cargo_shuttle_run("../examples/poem/mongodb", false).await;
let client = reqwest::Client::new();

// Post a todo note and get the persisted todo objectId
let post_text = client
.post(format!("http://localhost:{port}/todo"))
.post(format!("{url}/todo"))
.body("{\"note\": \"Deploy to shuttle\"}")
.header("content-type", "application/json")
.send()
Expand All @@ -317,7 +330,7 @@ async fn poem_mongodb() {
assert_eq!(post_text.len(), 24);

let request_text = client
.get(format!("http://localhost:{port}/todo/{post_text}"))
.get(format!("{url}/todo/{post_text}"))
.send()
.await
.unwrap()
Expand All @@ -330,10 +343,10 @@ async fn poem_mongodb() {

#[tokio::test(flavor = "multi_thread")]
async fn salvo_hello_world() {
let port = cargo_shuttle_run("../examples/salvo/hello-world").await;
let url = cargo_shuttle_run("../examples/salvo/hello-world", false).await;

let request_text = reqwest::Client::new()
.get(format!("http://localhost:{port}/hello"))
.get(format!("{url}/hello"))
.send()
.await
.unwrap()
Expand All @@ -346,10 +359,10 @@ async fn salvo_hello_world() {

#[tokio::test(flavor = "multi_thread")]
async fn thruster_hello_world() {
let port = cargo_shuttle_run("../examples/thruster/hello-world").await;
let url = cargo_shuttle_run("../examples/thruster/hello-world", false).await;

let request_text = reqwest::Client::new()
.get(format!("http://localhost:{port}/hello"))
.get(format!("{url}/hello"))
.send()
.await
.unwrap()
Expand All @@ -359,3 +372,19 @@ async fn thruster_hello_world() {

assert_eq!(request_text, "Hello, World!");
}

#[tokio::test(flavor = "multi_thread")]
async fn rocket_hello_world_with_router_ip() {
let url = cargo_shuttle_run("../examples/rocket/hello-world", true).await;

let request_text = reqwest::Client::new()
.get(format!("{url}/hello"))
.send()
.await
.unwrap()
.text()
.await
.unwrap();

assert_eq!(request_text, "Hello, world!");
}
2 changes: 1 addition & 1 deletion service/tests/integration/helpers/loader.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,5 +24,5 @@ pub fn build_so_create_loader(resources: &str, crate_name: &str) -> Result<Loade

let so_path = crate_dir.join("target/release").join(lib_name);

Loader::from_so_file(&so_path)
Loader::from_so_file(so_path)
}