Fix blocking test

Closes #506

.github/dependabot.yml

@@ -10,3 +10,15 @@ updates:
       - vbrandl
     labels:
       - dependencies
+      - dependabot
+
+  - package-ecosystem: 'github-actions'
+    directory: '/'
+    schedule:
+      interval: 'daily'
+    open-pull-requests-limit: 10
+    assignees:
+      - vbrandl
+    labels:
+      - dependabot
+      - dependencies

.github/workflows/audit.yml

@@ -16,6 +16,6 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
-      - uses: actions-rs/audit-check@v1
+      - uses: rustsec/audit-check@v1
         with:
           token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/dependabot-changelog.yml

@@ -0,0 +1,26 @@
+name: 'Dependabot Changelog'
+on:
+  pull_request:
+    types:
+      - opened
+      - synchronize
+      - reopened
+      - ready_for_review
+      - labeled
+      - unlabeled
+
+jobs:
+  changelog:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          token: ${{ secrets.ACTION_TOKEN }}
+      - uses: dangoslen/dependabot-changelog-helper@v3
+        with:
+          activationLabel: 'dependabot'
+      - uses: stefanzweifel/git-auto-commit-action@v4
+        with:
+          commit_message: "Update Changelog"

.github/workflows/release.yml

@@ -42,7 +42,7 @@ jobs:
           override: true
 
       - name: Cache cargo registry, index and build directory
-        uses: actions/cache@v2
+        uses: actions/cache@v3
         with:
           path: |
             ~/.cargo/registry

.github/workflows/rust.yml

@@ -16,18 +16,11 @@ jobs:
         uses: actions/checkout@v3
 
       - name: Install stable toolchain
-        uses: actions-rs/toolchain@v1
+        uses: dtolnay/rust-toolchain@stable
-        with:
-          toolchain: stable
-          profile: minimal
-          override: true
-          components: rustfmt
 
       - name: Check Formatting
-        uses: actions-rs/cargo@v1
+        run: cargo fmt --all -- --check
-        with:
+
-          command: fmt
-          args: --all -- --check
 
   clippy:
     name: Clippy
@@ -37,12 +30,7 @@ jobs:
         uses: actions/checkout@v3
 
       - name: Install stable toolchain
-        uses: actions-rs/toolchain@v1
+        uses: dtolnay/rust-toolchain@stable
-        with:
-          toolchain: stable
-          profile: minimal
-          override: true
-          components: rustfmt
 
       - name: Cache cargo registry, index and build directory
         uses: actions/cache@v3
@@ -54,10 +42,13 @@ jobs:
           key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
 
       - name: Clippy Linting
-        uses: actions-rs/cargo@v1
+        run: cargo clippy --all-features -- -Dclippy::all
-        with:
+        # TODO
-          command: clippy
+        # run: cargo clippy --all-features -- -Dclippy::all -Dclippy::pedantic
-          args: -- -D warnings
+      - name: Clippy Test Linting
+        run: cargo clippy --tests -- -Dclippy::all
+        # TODO
+        # run: cargo clippy --tests -- -Dclippy::all -Dclippy::pedantic
 
 
   test:
@@ -74,11 +65,7 @@ jobs:
         uses: actions/checkout@v3
 
       - name: Install stable toolchain
-        uses: actions-rs/toolchain@v1
+        uses: dtolnay/rust-toolchain@stable
-        with:
-          toolchain: stable
-          profile: minimal
-          override: true
 
       - name: Cache cargo registry, index and build directory
         uses: actions/cache@v3
@@ -90,6 +77,4 @@ jobs:
           key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
 
       - name: Run Tests
-        uses: actions-rs/cargo@v1
+        run: cargo test
-        with:
-          command: test

CHANGELOG.md

@@ -4,6 +4,15 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+### Dependencies
+- Bump `serde` from 1.0.160 to 1.0.164 (#613, #617, #627)
+- Bump `actions/cache` from 2 to 3 (#616)
+- Bump `tokio` from 1.28.0 to 1.28.2 (#618, #625)
+- Bump `reqwest` from 0.11.17 to 0.11.18 (#619)
+- Bump `vergen` from 8.1.3 to 8.2.1 (#621, #622)
+- Bump `tracing-actix-web` from 0.7.4 to 0.7.5 (#623)
+- Bump `git2` from 0.17.1 to 0.17.2 (#624)
+- Bump `tempfile` from 3.5.0 to 3.6.0 (#626)
 
 
 ## [0.35.0] 2023-05-04
@@ -227,4 +236,4 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 [#502]: https://github.com/vbrandl/hoc/pull/502
 [#503]: https://github.com/vbrandl/hoc/pull/503
 [#504]: https://github.com/vbrandl/hoc/pull/504
-[#508]: https://github.com/vbrandl/hoc/pull/508
+[#508]: https://github.com/vbrandl/hoc/pull/508

Cargo.lock

@@ -807,9 +807,9 @@ dependencies = [
 
 [[package]]
 name = "git2"
-version = "0.17.1"
+version = "0.17.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "8b7905cdfe33d31a88bb2e8419ddd054451f5432d1da9eaf2ac7804ee1ea12d5"
+checksum = "7b989d6a7ca95a362cf2cfc5ad688b3a467be1f87e480b8dad07fee8c79b0044"
 dependencies = [
  "bitflags 1.3.2",
  "libc",
@@ -1671,9 +1671,9 @@ checksum = "6a987beff54b60ffa6d51982e1aa1146bc42f19bd26be28b0586f252fccf5317"
 
 [[package]]
 name = "libgit2-sys"
-version = "0.15.1+1.6.4"
+version = "0.15.2+1.6.4"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "fb4577bde8cdfc7d6a2a4bcb7b049598597de33ffd337276e9c7db6cd4a2cee7"
+checksum = "a80df2e11fb4a61f4ba2ab42dbe7f74468da143f1a75c74e11dee7c813f694fa"
 dependencies = [
  "cc",
  "libc",
@@ -2197,9 +2197,9 @@ checksum = "f162c6dd7b008981e4d40210aca20b4bd0f9b60ca9271061b07f78537722f2e1"
 
 [[package]]
 name = "reqwest"
-version = "0.11.17"
+version = "0.11.18"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "13293b639a097af28fc8a90f22add145a9c954e49d77da06263d58cf44d5fb91"
+checksum = "cde824a14b7c14f85caff81225f411faacc04a2013f41670f41443742b1c1c55"
 dependencies = [
  "base64 0.21.0",
  "bytes",
@@ -2357,18 +2357,18 @@ checksum = "bebd363326d05ec3e2f532ab7660680f3b02130d780c299bca73469d521bc0ed"
 
 [[package]]
 name = "serde"
-version = "1.0.160"
+version = "1.0.164"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "bb2f3770c8bce3bcda7e149193a069a0f4365bda1fa5cd88e03bca26afc1216c"
+checksum = "9e8c8cf938e98f769bc164923b06dce91cea1751522f46f8466461af04c9027d"
 dependencies = [
  "serde_derive",
 ]
 
 [[package]]
 name = "serde_derive"
-version = "1.0.160"
+version = "1.0.164"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "291a097c63d8497e00160b166a967a4a79c64f3facdd01cbd7502231688d77df"
+checksum = "d9735b638ccc51c28bf6914d90a2e9725b377144fc612c49a611fddd1b631d68"
 dependencies = [
  "proc-macro2",
  "quote",
@@ -2509,15 +2509,16 @@ dependencies = [
 
 [[package]]
 name = "tempfile"
-version = "3.5.0"
+version = "3.6.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "b9fbec84f381d5795b08656e4912bec604d162bff9291d6189a78f4c8ab87998"
+checksum = "31c0432476357e58790aaa47a8efb0c5138f137343f3b5f23bd36a27e3b0a6d6"
 dependencies = [
+ "autocfg",
  "cfg-if",
  "fastrand",
  "redox_syscall 0.3.5",
  "rustix",
- "windows-sys 0.45.0",
+ "windows-sys 0.48.0",
 ]
 
 [[package]]
@@ -2596,9 +2597,9 @@ checksum = "1f3ccbac311fea05f86f61904b462b55fb3df8837a366dfc601a0161d0532f20"
 
 [[package]]
 name = "tokio"
-version = "1.28.0"
+version = "1.28.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "c3c786bf8134e5a3a166db9b29ab8f48134739014a3eca7bc6bfa95d673b136f"
+checksum = "94d7b1cfd2aa4011f2de74c2c4c63665e27a71006b0a192dcd2710272e73dfa2"
 dependencies = [
  "autocfg",
  "bytes",
@@ -2665,9 +2666,9 @@ dependencies = [
 
 [[package]]
 name = "tracing-actix-web"
-version = "0.7.4"
+version = "0.7.5"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "e2def0ffabc0116481e14e82cf705fef814f5178171d445b6790137ff8a85a73"
+checksum = "ce52ffaf2d544e317d3bef63f49a6a22022866505fa4840a4339b1756834a2a9"
 dependencies = [
  "actix-web",
  "pin-project",
@@ -2838,9 +2839,9 @@ checksum = "accd4ea62f7bb7a82fe23066fb0957d48ef677f6eeb8215f372f52e48bb32426"
 
 [[package]]
 name = "vergen"
-version = "8.1.3"
+version = "8.2.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "6e03272e388fb78fc79481a493424f78d77be1d55f21bcd314b5a6716e195afe"
+checksum = "8b3c89c2c7e50f33e4d35527e5bf9c11d6d132226dbbd1753f0fbe9f19ef88c6"
 dependencies = [
  "anyhow",
  "gix",

Cargo.toml

@@ -20,17 +20,17 @@ bytes = "1.4.0"
 config = { version = "0.13.3", features = ["toml"] }
 dotenvy = "0.15.7"
 futures = "0.3.27"
-git2 = "0.17.1"
+git2 = "0.17.2"
 lazy_static = "1.4.0"
 mime = "0.3"
 number_prefix = "0.4.0"
 openssl-probe = "0.1.5"
-reqwest = "0.11.17"
+reqwest = "0.11.18"
-serde = "1.0.158"
+serde = "1.0.164"
 serde_derive = "1.0.137"
 serde_json = "1.0.94"
 tracing = "0.1.37"
-tracing-actix-web = "0.7.3"
+tracing-actix-web = "0.7.5"
 tracing-bunyan-formatter = "0.3.6"
 tracing-futures = "0.2.5"
 tracing-log = "0.1.3"
@@ -39,10 +39,10 @@ tracing-subscriber = { version = "0.3.17", features = ["registry", "env-filter"]
 [build-dependencies]
 anyhow = "1.0.71"
 ructe = { version = "0.16.1", features = ["mime03"] }
-vergen = { version = "8.1.3", default-features = false, features = ["git", "gitoxide"] }
+vergen = { version = "8.2.1", default-features = false, features = ["git", "gitoxide"] }
 
 [dev-dependencies]
 awc = "3.1.1"
 ructe = "0.16.1"
-tempfile = "3.5.0"
+tempfile = "3.6.0"
-tokio = "1.28.0"
+tokio = "1.28.2"

src/cache.rs

@@ -36,10 +36,10 @@ impl<'a> CacheState<'a> {
         trace!("Reading cache");
         if path.as_ref().exists() {
             let cache: Cache = serde_json::from_reader(BufReader::new(File::open(path)?))?;
-            Ok(cache
+            Ok(cache.entries.get(branch).map_or_else(
-                .entries
+                // TODO: get rid of clone
-                .get(branch)
+                || CacheState::NoneForBranch(cache.clone()),
-                .map(|c| {
+                |c| {
                     if c.head == head {
                         trace!("Cache is up to date");
                         CacheState::Current {
@@ -56,9 +56,8 @@ impl<'a> CacheState<'a> {
                             cache: cache.clone(),
                         }
                     }
-                })
+                },
-                // TODO: get rid of clone
+            ))
-                .unwrap_or_else(|| CacheState::NoneForBranch(cache.clone())))
         } else {
             Ok(CacheState::No)
         }

src/config.rs

@@ -18,6 +18,12 @@ pub struct Settings {
 }
 
 impl Settings {
+    /// Load the configuration from file and environment.
+    ///
+    /// # Errors
+    ///
+    /// * File cannot be read or parsed
+    /// * Environment variables cannot be parsed
     pub fn load() -> Result<Self, ConfigError> {
         Config::builder()
             .add_source(File::with_name("hoc.toml").required(false))

src/lib.rs

@@ -22,7 +22,7 @@ use crate::{
     cache::CacheState,
     config::Settings,
     error::{Error, Result},
-    service::{Bitbucket, FormService, GitHub, Gitlab, Service, Sourcehut},
+    service::{Bitbucket, FormValue, GitHub, Gitlab, Service, Sourcehut},
     statics::{CLIENT, VERSION_INFO},
     template::{RepoGeneratorInfo, RepoInfo},
 };
@@ -53,7 +53,7 @@ include!(concat!(env!("OUT_DIR"), "/templates.rs"));
 
 #[derive(Deserialize, Serialize)]
 struct GeneratorForm<'a> {
-    service: FormService,
+    service: FormValue,
     user: Cow<'a, str>,
     repo: Cow<'a, str>,
     branch: Option<Cow<'a, str>>,
@@ -309,7 +309,7 @@ pub(crate) async fn json_hoc<T: Service>(
     let branch = branch.branch.as_deref().unwrap_or("master");
     let rc_clone = repo_count.clone();
     let mapper = move |r| match r {
-        HocResult::NotFound => p404(rc_clone),
+        HocResult::NotFound => p404(&rc_clone),
         HocResult::Hoc {
             hoc, head, commits, ..
         } => Ok(HttpResponse::Ok().json(JsonResponse {
@@ -345,7 +345,7 @@ pub(crate) async fn calculate_hoc<T: Service>(
     let rc_clone = repo_count.clone();
     let label = query.label.clone();
     let mapper = move |r| match r {
-        HocResult::NotFound => p404(rc_clone),
+        HocResult::NotFound => p404(&rc_clone),
         HocResult::Hoc { hoc_pretty, .. } => {
             let badge_opt = BadgeOptions {
                 subject: label,
@@ -386,7 +386,7 @@ async fn overview<T: Service>(
     let base_url = state.settings.base_url.clone();
     let rc_clone = repo_count.clone();
     let mapper = move |r| match r {
-        HocResult::NotFound => p404(rc_clone),
+        HocResult::NotFound => p404(&rc_clone),
         HocResult::Hoc {
             hoc,
             commits,
@@ -413,7 +413,7 @@ async fn overview<T: Service>(
                 VERSION_INFO,
                 rc_clone.load(Ordering::Relaxed),
                 repo_info,
-                label,
+                &label,
             )?;
 
             Ok(HttpResponse::Ok().content_type("text/html").body(buf))
@@ -423,11 +423,13 @@ async fn overview<T: Service>(
 }
 
 #[get("/health_check")]
+#[allow(clippy::unused_async)]
 async fn health_check() -> HttpResponse {
     HttpResponse::Ok().finish()
 }
 
 #[get("/")]
+#[allow(clippy::unused_async)]
 async fn index(
     state: web::Data<State>,
     repo_count: web::Data<AtomicUsize>,
@@ -443,6 +445,7 @@ async fn index(
 }
 
 #[post("/generate")]
+#[allow(clippy::unused_async)]
 async fn generate(
     params: web::Form<GeneratorForm<'_>>,
     state: web::Data<State>,
@@ -470,20 +473,22 @@ async fn generate(
     Ok(HttpResponse::Ok().content_type("text/html").body(buf))
 }
 
-fn p404(repo_count: web::Data<AtomicUsize>) -> Result<HttpResponse> {
+fn p404(repo_count: &web::Data<AtomicUsize>) -> Result<HttpResponse> {
     let mut buf = Vec::new();
     templates::p404_html(&mut buf, VERSION_INFO, repo_count.load(Ordering::Relaxed))?;
     Ok(HttpResponse::NotFound().content_type("text/html").body(buf))
 }
 
+#[allow(clippy::unused_async)]
 async fn async_p404(repo_count: web::Data<AtomicUsize>) -> Result<HttpResponse> {
-    p404(repo_count)
+    p404(&repo_count)
 }
 
 /// 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}")]
+#[allow(clippy::unused_async)]
 async fn static_file(
     path: web::Path<String>,
     repo_count: web::Data<AtomicUsize>,
@@ -496,11 +501,11 @@ async fn static_file(
                 .content_type(data.mime.clone())
                 .body(data.content)
         })
-        .map(Result::Ok)
+        .map_or_else(|| p404(&repo_count), Result::Ok)
-        .unwrap_or_else(|| p404(repo_count))
 }
 
 #[get("/favicon.ico")]
+#[allow(clippy::unused_async)]
 async fn favicon32() -> HttpResponse {
     let data = &template_statics::favicon32_png;
     HttpResponse::Ok()
@@ -508,6 +513,7 @@ async fn favicon32() -> HttpResponse {
         .body(data.content)
 }
 
+#[allow(clippy::unused_async)]
 async fn start_server(listener: TcpListener, settings: Settings) -> std::io::Result<Server> {
     let workers = settings.workers;
     let repo_count =
@@ -536,6 +542,11 @@ async fn start_server(listener: TcpListener, settings: Settings) -> std::io::Res
     .run())
 }
 
+/// Start the server.
+///
+/// # Errors
+///
+/// * server cannot bind to `listener`
 pub async fn run(listener: TcpListener, settings: Settings) -> std::io::Result<Server> {
     let span = info_span!("hoc", version = env!("CARGO_PKG_VERSION"));
     let _ = span.enter();

src/service.rs

@@ -29,7 +29,7 @@ pub(crate) trait Service: Sized + 'static {
 }
 
 #[derive(Deserialize, Serialize, Clone, Copy)]
-pub enum FormService {
+pub enum FormValue {
     #[serde(rename = "github")]
     GitHub,
     #[serde(rename = "gitlab")]
@@ -40,22 +40,22 @@ pub enum FormService {
     Sourcehut,
 }
 
-impl FormService {
+impl FormValue {
     pub(crate) fn url(&self) -> &str {
         match self {
-            FormService::GitHub => "github.com",
+            FormValue::GitHub => "github.com",
-            FormService::Gitlab => "gitlab.com",
+            FormValue::Gitlab => "gitlab.com",
-            FormService::Bitbucket => "bitbucket.org",
+            FormValue::Bitbucket => "bitbucket.org",
-            FormService::Sourcehut => "git.sr.ht",
+            FormValue::Sourcehut => "git.sr.ht",
         }
     }
 
     pub(crate) fn service(&self) -> &str {
         match self {
-            FormService::GitHub => "github",
+            FormValue::GitHub => "github",
-            FormService::Gitlab => "gitlab",
+            FormValue::Gitlab => "gitlab",
-            FormService::Bitbucket => "bitbucket",
+            FormValue::Bitbucket => "bitbucket",
-            FormService::Sourcehut => "sourcehut",
+            FormValue::Sourcehut => "sourcehut",
         }
     }
 }

src/statics.rs

@@ -1,3 +1,4 @@
+#[derive(Clone, Copy)]
 pub struct VersionInfo<'a> {
     pub commit: &'a str,
     pub version: &'a str,

src/template.rs

@@ -1,5 +1,6 @@
-use crate::service::FormService;
+use crate::service::FormValue;
 
+#[derive(Clone, Copy)]
 pub struct RepoInfo<'a> {
     pub commit_url: &'a str,
     pub commits: u64,
@@ -13,7 +14,7 @@ pub struct RepoInfo<'a> {
 }
 
 pub struct RepoGeneratorInfo<'a> {
-    pub service: FormService,
+    pub service: FormValue,
     pub user: &'a str,
     pub repo: &'a str,
     pub branch: &'a str,

templates/base.rs.html

@@ -1,4 +1,4 @@
-@use super::statics::*;
+@use super::statics::tacit_css_min_css;
 @use crate::statics::VersionInfo;
 
 @(title: &str, header: &str, content: Content, version_info: VersionInfo, repo_count: usize)

templates/overview.rs.html

@@ -2,7 +2,7 @@
 @use crate::statics::VersionInfo;
 @use crate::template::RepoInfo;
 
-@(version_info: VersionInfo, repo_count: usize, repo_info: RepoInfo, label: String)
+@(version_info: VersionInfo, repo_count: usize, repo_info: RepoInfo, label: &str)
 
 @:base_html("Hits-of-Code Badges", "Overview", {
 

tests/util/mod.rs

@@ -38,6 +38,8 @@ pub async fn spawn_app() -> TestApp {
         .await
         .expect("Failed to bind address");
 
+    #[allow(clippy::let_underscore_future)]
+    // don't await so the test server runs in the background
     let _ = tokio::spawn(server);
 
     TestApp {