1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
mod args;
mod client;
pub mod config;
mod factory;
mod init;
use indicatif::ProgressBar;
use shuttle_common::models::project::{State, IDLE_MINUTES};
use shuttle_common::project::ProjectName;
use std::collections::BTreeMap;
use std::ffi::OsString;
use std::fs::{read_to_string, File};
use std::io::stdout;
use std::net::{Ipv4Addr, SocketAddr};
use std::path::{Path, PathBuf};
use std::str::FromStr;
use anyhow::{anyhow, bail, Context, Result};
pub use args::{Args, Command, DeployArgs, InitArgs, LoginArgs, ProjectArgs, RunArgs};
use cargo_metadata::Message;
use clap::CommandFactory;
use clap_complete::{generate, Shell};
use config::RequestContext;
use crossterm::style::Stylize;
use dialoguer::{theme::ColorfulTheme, Confirm, FuzzySelect, Input, Password};
use factory::LocalFactory;
use flate2::write::GzEncoder;
use flate2::Compression;
use futures::StreamExt;
use git2::{Repository, StatusOptions};
use ignore::overrides::OverrideBuilder;
use ignore::WalkBuilder;
use shuttle_common::models::{project, secret};
use shuttle_service::loader::{build_crate, Loader};
use shuttle_service::Logger;
use std::fmt::Write;
use strum::IntoEnumIterator;
use tar::Builder;
use tokio::sync::mpsc;
use tracing::trace;
use uuid::Uuid;
use crate::args::{DeploymentCommand, ProjectCommand};
use crate::client::Client;
pub struct Shuttle {
ctx: RequestContext,
}
impl Shuttle {
pub fn new() -> Result<Self> {
let ctx = RequestContext::load_global()?;
Ok(Self { ctx })
}
pub async fn run(mut self, mut args: Args) -> Result<CommandOutcome> {
trace!("running local client");
if matches!(
args.cmd,
Command::Deploy(..)
| Command::Deployment(..)
| Command::Project(..)
| Command::Stop
| Command::Clean
| Command::Secrets
| Command::Status
| Command::Logs { .. }
| Command::Run(..)
) {
self.load_project(&mut args.project_args)?;
}
self.ctx.set_api_url(args.api_url);
match args.cmd {
Command::Init(init_args) => self.init(init_args, args.project_args).await,
Command::Generate { shell, output } => self.complete(shell, output).await,
Command::Login(login_args) => self.login(login_args).await,
Command::Logout => self.logout().await,
Command::Feedback => self.feedback().await,
Command::Run(run_args) => self.local_run(run_args).await,
need_client => {
let mut client = Client::new(self.ctx.api_url());
client.set_api_key(self.ctx.api_key()?);
match need_client {
Command::Deploy(deploy_args) => {
return self.deploy(deploy_args, &client).await;
}
Command::Status => self.status(&client).await,
Command::Logs { id, follow } => self.logs(&client, id, follow).await,
Command::Deployment(DeploymentCommand::List) => {
self.deployments_list(&client).await
}
Command::Deployment(DeploymentCommand::Status { id }) => {
self.deployment_get(&client, id).await
}
Command::Stop => self.stop(&client).await,
Command::Clean => self.clean(&client).await,
Command::Secrets => self.secrets(&client).await,
Command::Project(ProjectCommand::New { idle_minutes }) => {
self.project_create(&client, idle_minutes).await
}
Command::Project(ProjectCommand::Status { follow }) => {
self.project_status(&client, follow).await
}
Command::Project(ProjectCommand::List { filter }) => {
self.projects_list(&client, filter).await
}
Command::Project(ProjectCommand::Rm) => self.project_delete(&client).await,
_ => {
unreachable!("commands that don't need a client have already been matched")
}
}
}
}
.map(|_| CommandOutcome::Ok)
}
async fn init(&mut self, args: InitArgs, mut project_args: ProjectArgs) -> Result<()> {
let interactive = project_args.name.is_none() || args.framework().is_none();
let theme = ColorfulTheme::default();
if self.ctx.api_key().is_err() {
if interactive {
println!("First, let's log in to your Shuttle account.");
self.login(args.login_args.clone()).await?;
println!();
} else if args.new && args.login_args.api_key.is_some() {
self.login(args.login_args.clone()).await?;
} else {
bail!("Tried to login to create a Shuttle environment, but no API key was set.")
}
}
if project_args.name.is_none() {
println!("How do you want to name your project? It will be hosted at ${{project_name}}.shuttleapp.rs.");
project_args.name = Some(
Input::with_theme(&theme)
.with_prompt("Project name")
.interact()?,
);
println!();
}
let path = if interactive {
println!("Where should we create this project?");
let directory_str: String = Input::with_theme(&theme)
.with_prompt("Directory")
.default(".".to_owned())
.interact()?;
println!();
args::parse_init_path(OsString::from(directory_str))?
} else {
args.path.clone()
};
let framework = match args.framework() {
Some(framework) => framework,
None => {
println!(
"Shuttle works with a range of web frameworks. Which one do you want to use?"
);
let frameworks = init::Framework::iter().collect::<Vec<_>>();
let index = FuzzySelect::with_theme(&theme)
.items(&frameworks)
.default(0)
.interact()?;
println!();
frameworks[index]
}
};
init::cargo_init(path.clone())?;
init::cargo_shuttle_init(path.clone(), framework)?;
println!();
let should_create_environment = if !interactive {
args.new
} else if args.new {
true
} else {
let should_create = Confirm::with_theme(&theme)
.with_prompt("Do you want to create the project environment on Shuttle?")
.default(true)
.interact()?;
println!();
should_create
};
if should_create_environment {
project_args.working_directory = path;
self.load_project(&mut project_args)?;
let mut client = Client::new(self.ctx.api_url());
client.set_api_key(self.ctx.api_key()?);
self.project_create(&client, IDLE_MINUTES).await?;
}
Ok(())
}
fn find_root_directory(dir: &Path) -> Option<PathBuf> {
dir.ancestors()
.find(|ancestor| ancestor.join("Cargo.toml").exists())
.map(|path| path.to_path_buf())
}
pub fn load_project(&mut self, project_args: &mut ProjectArgs) -> Result<()> {
trace!("loading project arguments: {project_args:?}");
let root_directory_path = Self::find_root_directory(&project_args.working_directory);
if let Some(working_directory) = root_directory_path {
project_args.working_directory = working_directory;
} else {
return Err(anyhow!("Could not locate the root of a cargo project. Are you inside a cargo project? You can also use `--working-directory` to locate your cargo project."));
}
self.ctx.load_local(project_args)
}
async fn feedback(&self) -> Result<()> {
let url = "https://github.com/shuttle-hq/shuttle/issues/new";
let _ = webbrowser::open(url);
println!("\nIf your browser did not open automatically, go to {url}");
Ok(())
}
async fn login(&mut self, login_args: LoginArgs) -> Result<()> {
let api_key_str = match login_args.api_key {
Some(api_key) => api_key,
None => {
let url = "https://shuttle.rs/login";
let _ = webbrowser::open(url);
println!("If your browser did not automatically open, go to {url}");
Password::with_theme(&ColorfulTheme::default())
.with_prompt("API key")
.interact()?
}
};
let api_key = api_key_str.trim().parse()?;
self.ctx.set_api_key(api_key)?;
Ok(())
}
async fn logout(&mut self) -> Result<()> {
self.ctx.clear_api_key()?;
println!("Successfully logged out of shuttle.");
Ok(())
}
async fn stop(&self, client: &Client) -> Result<()> {
let mut service = client.stop_service(self.ctx.project_name()).await?;
let progress_bar = create_spinner();
loop {
let Some(ref deployment) = service.deployment else {
break;
};
if let shuttle_common::deployment::State::Stopped = deployment.state {
break;
}
progress_bar.set_message(format!("Stopping {}", deployment.id));
service = client.get_service_summary(self.ctx.project_name()).await?;
}
progress_bar.finish_and_clear();
println!(
r#"{}
{}"#,
"Successfully stopped service".bold(),
service
);
Ok(())
}
async fn complete(&self, shell: Shell, output: Option<PathBuf>) -> Result<()> {
let name = env!("CARGO_PKG_NAME");
let mut app = Command::command();
match output {
Some(v) => generate(shell, &mut app, name, &mut File::create(v)?),
None => generate(shell, &mut app, name, &mut stdout()),
};
Ok(())
}
async fn status(&self, client: &Client) -> Result<()> {
let summary = client.get_service_summary(self.ctx.project_name()).await?;
println!("{summary}");
Ok(())
}
async fn secrets(&self, client: &Client) -> Result<()> {
let secrets = client.get_secrets(self.ctx.project_name()).await?;
let table = secret::get_table(&secrets);
println!("{table}");
Ok(())
}
async fn clean(&self, client: &Client) -> Result<()> {
let lines = client.clean_project(self.ctx.project_name()).await?;
for line in lines {
println!("{line}");
}
println!("Cleaning done!");
Ok(())
}
async fn logs(&self, client: &Client, id: Option<Uuid>, follow: bool) -> Result<()> {
let id = if let Some(id) = id {
id
} else {
let summary = client.get_service_summary(self.ctx.project_name()).await?;
if let Some(deployment) = summary.deployment {
deployment.id
} else {
return Err(anyhow!("could not automatically find a running deployment for '{}'. Try passing a deployment ID manually", self.ctx.project_name()));
}
};
if follow {
let mut stream = client.get_logs_ws(self.ctx.project_name(), &id).await?;
while let Some(Ok(msg)) = stream.next().await {
if let tokio_tungstenite::tungstenite::Message::Text(line) = msg {
let log_item: shuttle_common::LogItem =
serde_json::from_str(&line).expect("to parse log line");
println!("{log_item}")
}
}
} else {
let logs = client.get_logs(self.ctx.project_name(), &id).await?;
for log in logs.into_iter() {
println!("{log}");
}
}
Ok(())
}
async fn deployments_list(&self, client: &Client) -> Result<()> {
let details = client.get_service_details(self.ctx.project_name()).await?;
println!("{details}");
Ok(())
}
async fn deployment_get(&self, client: &Client, deployment_id: Uuid) -> Result<()> {
let deployment = client
.get_deployment_details(self.ctx.project_name(), &deployment_id)
.await?;
println!("{deployment}");
Ok(())
}
async fn local_run(&self, run_args: RunArgs) -> Result<()> {
trace!("starting a local run for a service: {run_args:?}");
let (tx, rx): (crossbeam_channel::Sender<Message>, _) = crossbeam_channel::bounded(0);
tokio::task::spawn_blocking(move || {
while let Ok(message) = rx.recv() {
match message {
Message::TextLine(line) => println!("{line}"),
Message::CompilerMessage(message) => {
if let Some(rendered) = message.message.rendered {
println!("{rendered}");
}
}
_ => {}
}
}
});
let working_directory = self.ctx.working_directory();
let id = Default::default();
trace!("building project");
println!(
"{:>12} {}",
"Building".bold().green(),
working_directory.display()
);
let so_path = build_crate(id, working_directory, run_args.release, tx).await?;
trace!("loading secrets");
let secrets_path = if working_directory.join("Secrets.dev.toml").exists() {
working_directory.join("Secrets.dev.toml")
} else {
working_directory.join("Secrets.toml")
};
let secrets: BTreeMap<String, String> =
if let Ok(secrets_str) = read_to_string(secrets_path) {
let secrets: BTreeMap<String, String> =
secrets_str.parse::<toml::Value>()?.try_into()?;
trace!(keys = ?secrets.keys(), "available secrets");
secrets
} else {
trace!("no Secrets.toml was found");
Default::default()
};
let loader = Loader::from_so_file(so_path)?;
let mut factory = LocalFactory::new(
self.ctx.project_name().clone(),
secrets,
working_directory.to_path_buf(),
)?;
let addr = if run_args.external {
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!(
"\n{:>12} {} on http://{}",
"Starting".bold().green(),
self.ctx.project_name(),
addr
);
let (tx, mut rx) = mpsc::unbounded_channel();
tokio::spawn(async move {
while let Some(log) = rx.recv().await {
println!("{log}");
}
});
let logger = Logger::new(tx, id);
let (handle, so) = loader.load(&mut factory, addr, logger).await?;
handle.await??;
tokio::task::spawn_blocking(move || {
trace!("closing so file");
so.close().unwrap();
});
Ok(())
}
async fn deploy(&self, args: DeployArgs, client: &Client) -> Result<CommandOutcome> {
if !args.allow_dirty {
self.is_dirty()?;
}
let data = self.make_archive()?;
let deployment = client
.deploy(data, self.ctx.project_name(), args.no_test)
.await?;
let mut stream = client
.get_logs_ws(self.ctx.project_name(), &deployment.id)
.await?;
while let Some(Ok(msg)) = stream.next().await {
if let tokio_tungstenite::tungstenite::Message::Text(line) = msg {
let log_item: shuttle_common::LogItem =
serde_json::from_str(&line).expect("to parse log line");
match log_item.state {
shuttle_common::deployment::State::Queued
| shuttle_common::deployment::State::Building
| shuttle_common::deployment::State::Built
| shuttle_common::deployment::State::Loading => {
println!("{log_item}");
}
shuttle_common::deployment::State::Crashed => {
println!();
println!("{}", "Deployment crashed".red());
println!("Run the following for more details");
println!();
print!("cargo shuttle logs {}", deployment.id);
println!();
return Ok(CommandOutcome::DeploymentFailure);
}
shuttle_common::deployment::State::Running
| shuttle_common::deployment::State::Completed
| shuttle_common::deployment::State::Stopped
| shuttle_common::deployment::State::Unknown => break,
}
}
}
let service = client.get_service_summary(self.ctx.project_name()).await?;
if let Some(ref new_deployment) = service.deployment {
println!("{service}");
Ok(match new_deployment.state {
shuttle_common::deployment::State::Crashed => CommandOutcome::DeploymentFailure,
_ => CommandOutcome::Ok,
})
} else {
println!("Deployment has not entered the running state");
Ok(CommandOutcome::DeploymentFailure)
}
}
async fn project_create(&self, client: &Client, idle_minutes: u64) -> Result<()> {
let config = project::Config { idle_minutes };
self.wait_with_spinner(
&[
project::State::Ready,
project::State::Errored {
message: Default::default(),
},
],
client.create_project(self.ctx.project_name(), config),
self.ctx.project_name(),
client,
)
.await?;
Ok(())
}
async fn projects_list(&self, client: &Client, filter: Option<String>) -> Result<()> {
let projects = match filter {
Some(filter) => {
if let Ok(filter) = State::from_str(filter.trim()) {
client
.get_projects_list_filtered(filter.to_string())
.await?
} else {
return Err(anyhow!("That's not a valid project status!"));
}
}
None => client.get_projects_list().await?,
};
let projects_table = project::get_table(&projects);
println!("{projects_table}");
Ok(())
}
async fn project_status(&self, client: &Client, follow: bool) -> Result<()> {
match follow {
true => {
self.wait_with_spinner(
&[
project::State::Ready,
project::State::Destroyed,
project::State::Errored {
message: Default::default(),
},
],
client.get_project(self.ctx.project_name()),
self.ctx.project_name(),
client,
)
.await?;
}
false => {
let project = client.get_project(self.ctx.project_name()).await?;
println!("{project}");
}
}
Ok(())
}
async fn wait_with_spinner<'a, Fut>(
&self,
states_to_check: &[project::State],
fut: Fut,
project_name: &'a ProjectName,
client: &'a Client,
) -> Result<(), anyhow::Error>
where
Fut: std::future::Future<Output = Result<project::Response>> + 'a,
{
let mut project = fut.await?;
let progress_bar = create_spinner();
loop {
if states_to_check.contains(&project.state) {
break;
}
progress_bar.set_message(format!("{project}"));
project = client.get_project(project_name).await?;
}
progress_bar.finish_and_clear();
println!("{project}");
Ok(())
}
async fn project_delete(&self, client: &Client) -> Result<()> {
self.wait_with_spinner(
&[
project::State::Destroyed,
project::State::Errored {
message: Default::default(),
},
],
client.delete_project(self.ctx.project_name()),
self.ctx.project_name(),
client,
)
.await?;
Ok(())
}
fn make_archive(&self) -> Result<Vec<u8>> {
let encoder = GzEncoder::new(Vec::new(), Compression::fast());
let mut tar = Builder::new(encoder);
let working_directory = self.ctx.working_directory();
let base_directory = working_directory
.parent()
.context("get parent directory of crate")?;
let overrides = OverrideBuilder::new(working_directory)
.add("!target/")
.context("add `!target/` override")?
.build()
.context("build an override")?;
for dir_entry in WalkBuilder::new(working_directory)
.hidden(false)
.overrides(overrides)
.build()
{
let dir_entry = dir_entry.context("get directory entry")?;
if dir_entry.file_type().context("get file type")?.is_dir() {
continue;
}
let path = dir_entry
.path()
.strip_prefix(base_directory)
.context("strip the base of the archive entry")?;
tar.append_path_with_name(dir_entry.path(), path)
.context("archive entry")?;
}
let secrets_path = self.ctx.working_directory().join("Secrets.toml");
if secrets_path.exists() {
tar.append_path_with_name(secrets_path, Path::new("shuttle").join("Secrets.toml"))?;
}
let encoder = tar.into_inner().context("get encoder from tar archive")?;
let bytes = encoder.finish().context("finish up encoder")?;
Ok(bytes)
}
fn is_dirty(&self) -> Result<()> {
let working_directory = self.ctx.working_directory();
if let Ok(repo) = Repository::discover(working_directory) {
let repo_path = repo
.workdir()
.context("getting working directory of repository")?
.canonicalize()?;
trace!(?repo_path, "found git repository");
let repo_rel_path = working_directory
.strip_prefix(repo_path.as_path())
.context("stripping repository path from working directory")?;
trace!(
?repo_rel_path,
"got working directory path relative to git repository"
);
let mut status_options = StatusOptions::new();
status_options
.pathspec(repo_rel_path)
.include_untracked(true);
let statuses = repo
.statuses(Some(&mut status_options))
.context("getting status of repository files")?;
if !statuses.is_empty() {
let mut error: String = format!("{} files in the working directory contain changes that were not yet committed into git:", statuses.len());
writeln!(error).expect("to append error");
for status in statuses.iter() {
trace!(
path = status.path(),
status = ?status.status(),
"found file with updates"
);
let path =
repo_path.join(status.path().context("getting path of changed file")?);
let rel_path = path
.strip_prefix(working_directory)
.expect("getting relative path of changed file")
.display();
writeln!(error, "{rel_path}").expect("to append error");
}
writeln!(error).expect("to append error");
writeln!(error, "to proceed despite this and include the uncommitted changes, pass the `--allow-dirty` flag").expect("to append error");
return Err(anyhow::Error::msg(error));
}
}
Ok(())
}
}
fn create_spinner() -> ProgressBar {
let pb = indicatif::ProgressBar::new_spinner();
pb.enable_steady_tick(std::time::Duration::from_millis(350));
pb.set_style(
indicatif::ProgressStyle::with_template("{spinner:.orange} {msg}")
.unwrap()
.tick_strings(&[
"( ● )",
"( ● )",
"( ● )",
"( ● )",
"( ●)",
"( ● )",
"( ● )",
"( ● )",
"( ● )",
"(● )",
"(●●●●●●)",
]),
);
pb
}
pub enum CommandOutcome {
Ok,
DeploymentFailure,
}
#[cfg(test)]
mod tests {
use flate2::read::GzDecoder;
use shuttle_common::project::ProjectName;
use tar::Archive;
use tempfile::TempDir;
use crate::args::ProjectArgs;
use crate::Shuttle;
use std::fs::{self, canonicalize};
use std::path::PathBuf;
use std::str::FromStr;
fn path_from_workspace_root(path: &str) -> PathBuf {
PathBuf::from(std::env::var("CARGO_MANIFEST_DIR").unwrap())
.join("..")
.join(path)
}
fn get_archive_entries(mut project_args: ProjectArgs) -> Vec<String> {
let mut shuttle = Shuttle::new().unwrap();
shuttle.load_project(&mut project_args).unwrap();
let archive = shuttle.make_archive().unwrap();
let tar = GzDecoder::new(&archive[..]);
let mut archive = Archive::new(tar);
archive
.entries()
.unwrap()
.map(|entry| {
entry
.unwrap()
.path()
.unwrap()
.components()
.skip(1)
.collect::<PathBuf>()
.display()
.to_string()
})
.collect()
}
#[test]
fn find_root_directory_returns_proper_directory() {
let working_directory = path_from_workspace_root("examples/axum/hello-world/src");
let root_dir = Shuttle::find_root_directory(&working_directory).unwrap();
assert_eq!(
root_dir,
path_from_workspace_root("examples/axum/hello-world/")
);
}
#[test]
fn load_project_returns_proper_working_directory_in_project_args() {
let mut project_args = ProjectArgs {
working_directory: path_from_workspace_root("examples/axum/hello-world/src"),
name: None,
};
let mut shuttle = Shuttle::new().unwrap();
Shuttle::load_project(&mut shuttle, &mut project_args).unwrap();
assert_eq!(
project_args.working_directory,
path_from_workspace_root("examples/axum/hello-world/")
);
}
#[test]
fn make_archive_include_secrets() {
let working_directory =
canonicalize(path_from_workspace_root("examples/rocket/secrets")).unwrap();
fs::write(
working_directory.join("Secrets.toml"),
"MY_API_KEY = 'the contents of my API key'",
)
.unwrap();
let project_args = ProjectArgs {
working_directory,
name: None,
};
let mut entries = get_archive_entries(project_args);
entries.sort();
assert_eq!(
entries,
vec![
".gitignore",
"Cargo.toml",
"README.md",
"Secrets.toml",
"Secrets.toml.example",
"Shuttle.toml",
"src/lib.rs",
]
);
}
#[test]
fn make_archive_respect_ignore() {
let tmp_dir = TempDir::new().unwrap();
let working_directory = tmp_dir.path();
fs::write(working_directory.join(".env"), "API_KEY = 'blabla'").unwrap();
fs::write(working_directory.join(".ignore"), ".env").unwrap();
fs::write(working_directory.join("Cargo.toml"), "[package]").unwrap();
let project_args = ProjectArgs {
working_directory: working_directory.to_path_buf(),
name: Some(ProjectName::from_str("secret").unwrap()),
};
let mut entries = get_archive_entries(project_args);
entries.sort();
assert_eq!(entries, vec![".ignore", "Cargo.toml"]);
}
#[test]
fn make_archive_ignore_target_folder() {
let tmp_dir = TempDir::new().unwrap();
let working_directory = tmp_dir.path();
fs::create_dir_all(working_directory.join("target")).unwrap();
fs::write(working_directory.join("target").join("binary"), "12345").unwrap();
fs::write(working_directory.join("Cargo.toml"), "[package]").unwrap();
let project_args = ProjectArgs {
working_directory: working_directory.to_path_buf(),
name: Some(ProjectName::from_str("exclude_target").unwrap()),
};
let mut entries = get_archive_entries(project_args);
entries.sort();
assert_eq!(entries, vec!["Cargo.toml"]);
}
}