add integration test crate & static file integration test

Author: syphar

Cargo.lock

@@ -1,7 +1,7 @@
 [workspace]
 resolver = "2" 
 
-members = ["crates/bin/*", "crates/lib/*"]
+members = ["crates/bin/*", "crates/lib/*", "integration_tests"]
 
 default-members = [
     "crates/bin/docs_rs_admin",

Cargo.toml

@@ -0,0 +1,20 @@
+use anyhow::Result;
+use docs_rs_context::Context;
+use std::sync::Arc;
+
+pub async fn build_context() -> Result<Arc<Context>> {
+    Ok(Arc::new(
+        Context::builder()
+            .with_runtime()
+            .await?
+            .with_meter_provider()?
+            .with_pool()
+            .await?
+            .with_build_queue()?
+            .with_storage()
+            .await?
+            .with_registry_api()?
+            .with_build_limits()?
+            .build()?,
+    ))
+}

crates/bin/docs_rs_web/src/context.rs

@@ -6,6 +6,7 @@
 
 mod cache;
 mod config;
+mod context;
 mod error;
 mod extractors;
 mod file;
@@ -21,6 +22,7 @@ pub(crate) mod testing;
 mod utils;
 
 pub use config::Config;
+pub use context::build_context;
 pub use docs_rs_build_limits::DEFAULT_MAX_TARGETS;
 pub use docs_rs_utils::{APP_USER_AGENT, BUILD_VERSION, RUSTDOC_STATIC_STORAGE_PREFIX};
 pub use font_awesome_as_a_crate::icons;

crates/bin/docs_rs_web/src/lib.rs

@@ -1,7 +1,7 @@
 use anyhow::Context as _;
 use clap::Parser;
 use docs_rs_config::AppConfig as _;
-use docs_rs_web::{Config, run_web_server};
+use docs_rs_web::{Config, build_context, run_web_server};
 use std::{net::SocketAddr, sync::Arc};
 
 #[derive(Parser)]
@@ -20,22 +20,7 @@ async fn main() -> anyhow::Result<()> {
     let _guard = docs_rs_logging::init().context("error initializing logging")?;
 
     let args = Cli::parse();
-
-    let context = Arc::new(
-        docs_rs_context::Context::builder()
-            .with_runtime()
-            .await?
-            .with_meter_provider()?
-            .with_pool()
-            .await?
-            .with_build_queue()?
-            .with_storage()
-            .await?
-            .with_registry_api()?
-            .with_build_limits()?
-            .build()?,
-    );
-
+    let context = build_context().await?;
     let config = Arc::new(Config::from_environment()?);
 
     run_web_server(Some(args.socket_addr), config, context).await?;

crates/bin/docs_rs_web/src/main.rs

@@ -0,0 +1,13 @@
+[package]
+name = "docs_rs_integration_tests"
+version = "0.1.0"
+edition = "2024"
+
+[dev-dependencies]
+anyhow = { workspace = true }
+docs_rs_config = { path = "../crates/lib/docs_rs_config", features = ["testing"] }
+docs_rs_context = { path = "../crates/lib/docs_rs_context", features = ["testing"] }
+docs_rs_web = { path = "../crates/bin/docs_rs_web" }
+reqwest = { workspace = true }
+tokio = { workspace = true }
+tracing = { workspace = true }

integration_tests/Cargo.toml

@@ -0,0 +1 @@
+// Integration tests live in `integration_tests/tests`.

integration_tests/src/lib.rs

@@ -0,0 +1,70 @@
+use anyhow::{Context as _, Result, bail};
+use docs_rs_config::AppConfig;
+use docs_rs_context::Context;
+use docs_rs_web::{Config, build_context, run_web_server};
+use reqwest::Url;
+use std::{sync::Arc, time::Duration};
+use tokio::{
+    net::{TcpListener, TcpStream},
+    time,
+};
+use tracing::debug;
+
+fn web_config() -> Result<Arc<Config>> {
+    Ok(Arc::new(Config::test_config()?))
+}
+
+/// starts a test webserver.
+///
+/// Graceful shutdown is not needed, the test runtime will clean up after
+/// the test is finished.
+async fn start_web_server(config: Arc<Config>, context: Arc<Context>) -> Result<Url> {
+    let socket_addr = {
+        // find free local random port.
+        let listener = TcpListener::bind("127.0.0.1:0")
+            .await
+            .context("error binding socket for web server")?;
+
+        listener.local_addr()?
+    };
+
+    tokio::spawn(async move {
+        run_web_server(Some(socket_addr), config, context)
+            .await
+            .expect("error starting web server")
+    });
+
+    const WAIT_DURATION: Duration = Duration::from_millis(10);
+    const WAIT_ATTEMPTS: usize = 20;
+
+    for _attempt in 0..WAIT_ATTEMPTS {
+        if TcpStream::connect(socket_addr).await.is_ok() {
+            return Ok(Url::parse(&format!("http://{}/", socket_addr))?);
+        }
+        debug!("waiting for webserver to start...");
+        time::sleep(WAIT_DURATION).await;
+    }
+
+    bail!(
+        "test web server failed to start after {}s",
+        (WAIT_DURATION * WAIT_ATTEMPTS as u32).as_secs()
+    );
+}
+
+#[tokio::test(flavor = "multi_thread")]
+async fn test_static_files_from_repo_root() -> Result<()> {
+    let config = web_config()?;
+    let context = build_context().await?;
+    let base_url = start_web_server(config, context).await?;
+
+    assert!(
+        reqwest::get(base_url.join("/-/static/menu.js")?)
+            .await?
+            .error_for_status()?
+            .text()
+            .await?
+            .contains("updateMenuPositionForSubMenu")
+    );
+
+    Ok(())
+}