chore: Bump version (v0.23.0)

Use different rust-musl image

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "hoc"
-version = "0.22.4"
+version = "0.23.0"
 authors = ["Valentin Brandl <vbrandl@riseup.net>"]
 edition = "2018"
 build = "build.rs"
@@ -16,31 +16,32 @@ name = "hoc"
 actix-rt = "2.7.0"
 actix-web = "4.1.0"
 badge = "0.3.0"
-bytes = "1.1.0"
-config = { version = "0.13.1", features = ["toml"] }
+bytes = "1.2.1"
+config = { version = "0.13.2", features = ["toml"] }
 dotenv = "0.15.0"
-futures = "0.3.21"
-git2 = "0.14.4"
+futures = "0.3.23"
+git2 = "0.15.0"
 lazy_static = "1.4.0"
+mime = "0.3"
 number_prefix = "0.4.0"
 openssl-probe = "0.1.5"
 reqwest = "0.11.11"
-serde = "1.0.137"
-serde_derive = "1.0.136"
-serde_json = "1.0.81"
-tracing = "0.1.34"
-tracing-actix-web = "0.5.1"
-tracing-bunyan-formatter = "0.3.2"
+serde = "1.0.144"
+serde_derive = "1.0.137"
+serde_json = "1.0.85"
+tracing = "0.1.36"
+tracing-actix-web = "0.6.0"
+tracing-bunyan-formatter = "0.3.3"
 tracing-futures = "0.2.5"
 tracing-log = "0.1.3"
-tracing-subscriber = { version = "0.3.11", features = ["registry", "env-filter"] }
+tracing-subscriber = { version = "0.3.15", features = ["registry", "env-filter"] }
 
 [build-dependencies]
-ructe = "0.14.0"
-vergen = { version = "7.2.1", default-features = false, features = ["git"] }
+ructe = { version = "0.14.2", features = ["mime03"] }
+vergen = { version = "7.3.1", default-features = false, features = ["git"] }
 
 [dev-dependencies]
 awc = "3.0.0"
-ructe = "0.14.0"
+ructe = "0.14.2"
 tempfile = "3.3.0"
-tokio = "1.19.2"
+tokio = "1.20.1"

Dockerfile

@@ -1,10 +1,13 @@
-FROM ekidd/rust-musl-builder:stable as builder
+# FROM ekidd/rust-musl-builder:stable as builder
+FROM clux/muslrust:stable as builder
 
 # create new cargo project
-RUN USER=rust cargo init --lib
+RUN cargo init --lib
+# RUN USER=rust cargo init --lib
 RUN echo 'fn main() { println!("Hello, world!"); }' >> src/main.rs
 # copy build config
-COPY --chown=rust ./Cargo.lock ./Cargo.lock
+# COPY --chown=rust ./Cargo.lock ./Cargo.lock
+COPY ./Cargo.lock ./Cargo.lock
 COPY ./Cargo.toml ./Cargo.toml
 # HACK: remove build-dependencies so we have at least some caching
 RUN head -n $(($(grep -n "\[build-dependencies\]" Cargo.toml | cut -f1 -d:) - 1)) Cargo.toml | sed '/build.rs/d' > \
@@ -38,6 +41,7 @@ USER hoc
 # FROM scratch
 # COPY --from=linuxkit/ca-certificates:v0.7 / /
 
-COPY --from=builder /home/rust/src/target/x86_64-unknown-linux-musl/release/hoc .
+# COPY --from=builder /home/rust/src/target/x86_64-unknown-linux-musl/release/hoc .
+COPY --from=builder /volume/target/x86_64-unknown-linux-musl/release/hoc .
 
 ENTRYPOINT ["/home/hoc/hoc"]

build.rs

@@ -8,5 +8,8 @@ fn main() -> Result<(), RucteError> {
     let mut config = Config::default();
     *config.git_mut().sha_kind_mut() = ShaKind::Short;
     vergen(config).expect("Unable to generate static repo info");
-    Ructe::from_env()?.compile_templates("templates")
+    let mut ructe = Ructe::from_env()?;
+    let mut statics = ructe.statics()?;
+    statics.add_files("static")?;
+    ructe.compile_templates("templates")
 }

src/count.rs

@@ -1,27 +1,30 @@
 use crate::error::Result;
-use std::{fs::read_dir, path::Path, result::Result as StdResult};
+use std::{
+    fs::{read_dir, ReadDir},
+    iter::once,
+    path::Path,
+    result::Result as StdResult,
+};
 
+/// The on disk layout for served repos is `<service>/<user>/<repo>`
+/// so to get the amount of repos, we just have to count everything
+/// in `*/*/*` to get the count.
 #[instrument]
-pub(crate) fn count_repositories<P>(repo_path: P) -> Result<usize>
+pub fn count_repositories<P>(repo_path: P) -> Result<usize>
 where
     P: AsRef<Path> + std::fmt::Debug,
 {
     trace!("Counting repositories");
     std::fs::create_dir_all(&repo_path)?;
-    Ok(read_dir(repo_path)?
-        .filter_map(StdResult::ok)
-        .filter(|entry| entry.file_type().map(|ft| ft.is_dir()).unwrap_or(false))
-        .map(|entry| read_dir(entry.path()))
-        .filter_map(StdResult::ok)
-        .flat_map(|dir| {
-            dir.filter_map(StdResult::ok)
-                .filter(|entry| entry.file_type().map(|ft| ft.is_dir()).unwrap_or(false))
-        })
-        .map(|entry| read_dir(entry.path()))
-        .filter_map(StdResult::ok)
-        .flat_map(|dir| {
-            dir.filter_map(StdResult::ok)
-                .filter(|entry| entry.file_type().map(|ft| ft.is_dir()).unwrap_or(false))
-        })
+    Ok(once(read_dir(repo_path)?)
+        .flat_map(sub_directories)
+        .flat_map(sub_directories)
+        .flat_map(sub_directories)
         .count())
 }
+
+fn sub_directories(dir: ReadDir) -> impl Iterator<Item = ReadDir> {
+    dir.filter_map(StdResult::ok)
+        .filter(|entry| entry.file_type().map(|ft| ft.is_dir()).unwrap_or(false))
+        .filter_map(|entry| read_dir(entry.path()).ok())
+}

src/error.rs

@@ -5,7 +5,7 @@ use std::fmt;
 pub(crate) type Result<T> = std::result::Result<T, Error>;
 
 #[derive(Debug)]
-pub(crate) enum Error {
+pub enum Error {
     Badge(String),
     Client(reqwest::Error),
     Git(git2::Error),

src/lib.rs

@@ -11,7 +11,7 @@ extern crate tracing;
 
 mod cache;
 pub mod config;
-mod count;
+pub mod count;
 mod error;
 mod service;
 mod statics;
@@ -23,8 +23,8 @@ use crate::{
     config::Settings,
     error::{Error, Result},
     service::{Bitbucket, FormService, GitHub, Gitlab, Service, Sourcehut},
-    statics::{CLIENT, CSS, FAVICON, VERSION_INFO},
-    template::RepoInfo,
+    statics::{CLIENT, VERSION_INFO},
+    template::{RepoGeneratorInfo, RepoInfo},
 };
 use actix_web::{
     dev::Server,
@@ -46,6 +46,7 @@ use std::{
     sync::atomic::Ordering,
     time::{Duration, SystemTime},
 };
+use templates::statics::{self as template_statics, StaticFile};
 use tracing::Instrument;
 
 include!(concat!(env!("OUT_DIR"), "/templates.rs"));
@@ -55,6 +56,7 @@ struct GeneratorForm<'a> {
     service: FormService,
     user: Cow<'a, str>,
     repo: Cow<'a, str>,
+    branch: Option<Cow<'a, str>>,
 }
 
 #[derive(Debug)]
@@ -437,16 +439,23 @@ async fn generate(
     state: web::Data<State>,
     repo_count: web::Data<AtomicUsize>,
 ) -> Result<HttpResponse> {
-    let repo = format!("{}/{}", params.user, params.repo);
     let mut buf = Vec::new();
+    let repo_info = RepoGeneratorInfo {
+        service: params.service,
+        user: &params.user,
+        repo: &params.repo,
+        branch: params
+            .branch
+            .as_deref()
+            .filter(|s| !s.is_empty())
+            .unwrap_or("master"),
+    };
     templates::generate(
         &mut buf,
         VERSION_INFO,
         repo_count.load(Ordering::Relaxed),
         &state.settings.base_url,
-        params.service.url(),
-        params.service.service(),
-        &repo,
+        &repo_info,
     )?;
 
     Ok(HttpResponse::Ok().content_type("text/html").body(buf))
@@ -462,14 +471,32 @@ async fn async_p404(repo_count: web::Data<AtomicUsize>) -> Result<HttpResponse>
     p404(repo_count)
 }
 
-#[get("/tacit-css.min.css")]
-async fn css() -> HttpResponse {
-    HttpResponse::Ok().content_type("text/css").body(CSS)
+/// A duration to add to current time for a far expires header.
+static FAR: Duration = Duration::from_secs(180 * 24 * 60 * 60);
+
+#[get("/static/{filename}")]
+async fn static_file(
+    path: web::Path<String>,
+    repo_count: web::Data<AtomicUsize>,
+) -> Result<HttpResponse> {
+    StaticFile::get(&path)
+        .map(|data| {
+            let far_expires = SystemTime::now() + FAR;
+            HttpResponse::Ok()
+                .insert_header(Expires(far_expires.into()))
+                .content_type(data.mime.clone())
+                .body(data.content)
+        })
+        .map(Result::Ok)
+        .unwrap_or_else(|| p404(repo_count))
 }
 
 #[get("/favicon.ico")]
 async fn favicon32() -> HttpResponse {
-    HttpResponse::Ok().content_type("image/png").body(FAVICON)
+    let data = &template_statics::favicon32_png;
+    HttpResponse::Ok()
+        .content_type(data.mime.clone())
+        .body(data.content)
 }
 
 async fn start_server(listener: TcpListener, settings: Settings) -> std::io::Result<Server> {
@@ -486,7 +513,7 @@ async fn start_server(listener: TcpListener, settings: Settings) -> std::io::Res
             .wrap(middleware::NormalizePath::new(TrailingSlash::Trim))
             .service(index)
             .service(health_check)
-            .service(css)
+            .service(static_file)
             .service(favicon32)
             .service(generate)
             .default_service(web::to(async_p404));

src/service.rs

@@ -28,8 +28,8 @@ pub(crate) trait Service: Sized + 'static {
     }
 }
 
-#[derive(Deserialize, Serialize)]
-pub(crate) enum FormService {
+#[derive(Deserialize, Serialize, Clone, Copy)]
+pub enum FormService {
     #[serde(rename = "github")]
     GitHub,
     #[serde(rename = "gitlab")]

src/statics.rs

@@ -7,8 +7,6 @@ pub(crate) const VERSION_INFO: VersionInfo = VersionInfo {
     commit: env!("VERGEN_GIT_SHA_SHORT"),
     version: env!("CARGO_PKG_VERSION"),
 };
-pub(crate) const CSS: &str = include_str!("../static/tacit-css.min.css");
-pub(crate) const FAVICON: &[u8] = include_bytes!("../static/favicon32.png");
 
 lazy_static! {
     pub(crate) static ref CLIENT: reqwest::Client = reqwest::Client::new();

src/template.rs

@@ -1,3 +1,5 @@
+use crate::service::FormService;
+
 pub struct RepoInfo<'a> {
     pub commit_url: &'a str,
     pub commits: u64,
@@ -9,3 +11,10 @@ pub struct RepoInfo<'a> {
     pub url: &'a str,
     pub branch: &'a str,
 }
+
+pub struct RepoGeneratorInfo<'a> {
+    pub service: FormService,
+    pub user: &'a str,
+    pub repo: &'a str,
+    pub branch: &'a str,
+}

templates/base.rs.html

@@ -1,3 +1,4 @@
+@use super::statics::*;
 @use crate::statics::VersionInfo;
 
 @(title: &str, header: &str, content: Content, version_info: VersionInfo, repo_count: usize)
@@ -9,7 +10,7 @@
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
     <meta name="keywords" content="Hits-of-Code, GitHub, Badge" />
     <meta name="description" content="Hits-of-Code Badges for Git repositories" />
-    <link rel="stylesheet" href="/tacit-css.min.css" />
+    <link rel="stylesheet" href="/static/@tacit_css_min_css.name" />
     <title>@title</title>
 </head>
 <body>

templates/generate.rs.html

@@ -1,16 +1,16 @@
 @use super::base;
-@use crate::statics::VersionInfo;
+@use crate::{statics::VersionInfo, template::RepoGeneratorInfo};
 
-@(version_info: VersionInfo, repo_count: usize, base_url: &str, url: &str, service: &str, path: &str)
+@(version_info: VersionInfo, repo_count: usize, base_url: &str, repo_info: &RepoGeneratorInfo)
 
 @:base("Hits-of-Code Badges", "Badge Generator", {
 
 <p>
-Here is the markdown for the badge for <a href="https://@url/@path">@url/@path</a>
+Here is the markdown for the badge for <a href="https://@repo_info.service.url()/@repo_info.user/@repo_info.repo">@repo_info.user/@repo_info.repo</a>
 </p>
 
 <pre>
-[![Hits-of-Code](@base_url/@service/@path)](@base_url/@service/@path/view)
+[![Hits-of-Code](@base_url/@repo_info.service.service()/@repo_info.user/@repo_info.repo?branch=@repo_info.branch)](@base_url/@repo_info.service.service()/@repo_info.user/@repo_info.repo/view?branch=@repo_info.branch)
 </pre>
 
 <p>
@@ -18,6 +18,6 @@ It will be rendered like this
 </p>
 
 <pre>
-<a href="@base_url/@service/@path/view"><img src="@base_url/@service/@path" alt="example badge" /></a>
+<a href="@base_url/@repo_info.service.service()/@repo_info.user/@repo_info.repo/view?branch=@repo_info.branch"><img src="@base_url/@repo_info.service.service()/@repo_info.user/@repo_info.repo?branch=@repo_info.branch" alt="example badge" /></a>
 </pre>
 }, version_info, repo_count)

templates/index.rs.html

@@ -80,6 +80,8 @@ the lines of
     <input name="user" id="user" type="text" placeholder="user" />
     <label>/</label>
     <input name="repo" id="repo" type="text" placeholder="repository" />
+    <label>:</label>
+    <input name="branch" id="branch" type="text" placeholder="branch (defaults to `master`)" />
     <button type="submit">Generate</button>
 </form>
 

tests/count.rs

@@ -0,0 +1,66 @@
+use hoc::count::count_repositories;
+
+use tempfile::TempDir;
+
+#[test]
+fn no_repos() {
+    let repos = TempDir::new().unwrap();
+    assert_eq!(0, count_repositories(&repos).unwrap())
+}
+
+#[test]
+fn no_repos_for_provider() {
+    let repos = TempDir::new().unwrap();
+    let _provider = TempDir::new_in(&repos).unwrap();
+    assert_eq!(0, count_repositories(&repos).unwrap())
+}
+
+#[test]
+fn no_repos_for_owner() {
+    let repos = TempDir::new().unwrap();
+    let provider = TempDir::new_in(&repos).unwrap();
+    let _owner = TempDir::new_in(&provider).unwrap();
+    assert_eq!(0, count_repositories(&repos).unwrap())
+}
+
+#[test]
+fn one_repo_for_owner() {
+    let repos = TempDir::new().unwrap();
+    let provider = TempDir::new_in(&repos).unwrap();
+    let owner = TempDir::new_in(&provider).unwrap();
+    let _repo = TempDir::new_in(&owner).unwrap();
+    assert_eq!(1, count_repositories(&repos).unwrap())
+}
+
+#[test]
+fn two_repos_for_owner() {
+    let repos = TempDir::new().unwrap();
+    let provider = TempDir::new_in(&repos).unwrap();
+    let owner = TempDir::new_in(&provider).unwrap();
+    let _repo1 = TempDir::new_in(&owner).unwrap();
+    let _repo2 = TempDir::new_in(&owner).unwrap();
+    assert_eq!(2, count_repositories(&repos).unwrap())
+}
+
+#[test]
+fn two_repos_for_two_providers() {
+    let repos = TempDir::new().unwrap();
+    let provider1 = TempDir::new_in(&repos).unwrap();
+    let owner1 = TempDir::new_in(&provider1).unwrap();
+    let _repo1 = TempDir::new_in(&owner1).unwrap();
+    let provider2 = TempDir::new_in(&repos).unwrap();
+    let owner2 = TempDir::new_in(&provider2).unwrap();
+    let _repo2 = TempDir::new_in(&owner2).unwrap();
+    assert_eq!(2, count_repositories(&repos).unwrap())
+}
+
+#[test]
+fn two_subdirs_in_one_repo() {
+    let repos = TempDir::new().unwrap();
+    let provider = TempDir::new_in(&repos).unwrap();
+    let owner = TempDir::new_in(&provider).unwrap();
+    let repo = TempDir::new_in(&owner).unwrap();
+    let _subdir1 = TempDir::new_in(&repo).unwrap();
+    let _subdir2 = TempDir::new_in(&repo).unwrap();
+    assert_eq!(1, count_repositories(&repos).unwrap())
+}

tests/resources.rs

@@ -14,18 +14,3 @@ async fn favicon() {
 
     assert!(response.status().is_success());
 }
-
-#[actix_rt::test]
-async fn tacit_css() {
-    let test_app = util::spawn_app().await;
-
-    let client = awc::Client::default();
-
-    let response = client
-        .get(&format!("{}/tacit-css.min.css", test_app.address))
-        .send()
-        .await
-        .expect("Failed to execute request");
-
-    assert!(response.status().is_success());
-}