feat: fundamental

Author: KrLite

.dockerignore

@@ -0,0 +1,5 @@
+target/
+.git/
+.gitignore
+Dockerfile
+docker-compose.yml

.editorconfig

@@ -0,0 +1,24 @@
+# EditorConfig helps developers define and maintain consistent
+# coding styles between different editors and IDEs
+# editorconfig.org
+
+root = true
+
+[*]
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+indent_style = space
+indent_size = 4
+
+[*.rs]
+max_line_length = 100
+
+[*.md]
+# double whitespace at end of line
+# denotes a line break in Markdown
+trim_trailing_whitespace = false
+
+[*.yml]
+indent_size = 2

.github/workflows/build.yml

@@ -0,0 +1,45 @@
+name: Build & push to Docker Hub
+
+on:
+  push:
+    branches: ["main"]
+  pull_request:
+    branches: ["main"]
+  workflow_dispatch:
+
+concurrency:
+  group: "build"
+  cancel-in-progress: true
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  build:
+    name: Build the image
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Get Git SHA
+        id: git_sha
+        run: |
+          echo "full=$(git rev-parse HEAD)" >> $GITHUB_OUTPUT
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Login to Docker Hub
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKER_HUB_USERNAME }}
+          password: ${{ secrets.DOCKER_HUB_TOKEN }}
+
+      - name: Build and push
+        uses: docker/build-push-action@v6
+        with:
+          context: .
+          push: true
+          tags: ${{ secrets.DOCKER_HUB_USERNAME }}/${{ vars.DOCKER_IMAGE_NAME }}:latest
+          build-args: |
+            GIT_COMMIT=${{ steps.git_sha.outputs.full }}

.gitignore

@@ -0,0 +1,10 @@
+*/target
+/target
+/.vscode
+/.idea
+/.VSCodeCounter
+*/Cargo.lock
+/Cargo.lock
+.env
+
+*.DS_Store

Cargo.toml

@@ -0,0 +1,92 @@
+[package]
+name = "update"
+version = "0.2.0"
+edition = "2024"
+build = "build.rs"
+
+[dependencies]
+api-framework = { git = "https://github.com/KessokuTeaTime/api-framework", default-features = false, features = [
+    "framework",
+] }
+anyhow = "1.0.98"
+axum = "0.8.4"
+dotenvy = "0.15.7"
+serde = { version = "1.0.219", features = ["derive"] }
+tokio = { version = "1.47", features = ["rt-multi-thread", "process"] }
+tower-http = { version = "0.6.6", features = ["auth", "trace"] }
+tower-layer = "0.3.3"
+tracing = "0.1.41"
+tracing-subscriber = { version = "0.3.19", features = ["chrono"] }
+tracing-appender = "0.2.3"
+file-rotate = "0.8.0"
+clap = { version = "4.5.44", features = ["cargo"] }
+config-file = "0.2.3"
+
+[build-dependencies]
+anyhow = "1.0.98"
+vergen = { version = "9.0.6", features = ["build", "cargo", "rustc", "si"] }
+
+[workspace.lints.rust]
+missing-docs = "warn"
+missing-debug-implementations = "warn"
+let-underscore-drop = "warn"
+single-use-lifetimes = "warn"
+trivial-numeric-casts = "warn"
+elided-lifetimes-in-paths = "deny"
+unused-lifetimes = "forbid"
+unused-macro-rules = "warn"
+unused-qualifications = "warn"
+variant-size-differences = "warn"
+dyn-drop = "forbid"
+ellipsis-inclusive-range-patterns = "forbid"
+exported-private-dependencies = "forbid"
+uncommon-codepoints = "deny"
+
+[workspace.lints.clippy]
+missing-panics-doc = "warn"
+missing-errors-doc = "warn"
+cloned-instead-of-copied = "warn"
+future-not-send = "warn"
+if-not-else = "warn"
+if-then-some-else-none = "warn"
+impl-trait-in-params = "warn"
+macro-use-imports = "deny"
+exhaustive-enums = "warn"
+str-to-string = "warn"
+iter-without-into-iter = "warn"
+decimal-literal-representation = "warn"
+ref-as-ptr = "warn"
+unused-trait-names = "warn"
+unnecessary-semicolon = "warn"
+unnecessary-debug-formatting = "warn"
+too-long-first-doc-paragraph = "warn"
+ref-option = "warn"
+redundant-test-prefix = "warn"
+map-with-unused-argument-over-ranges = "warn"
+manual-midpoint = "warn"
+manual-is-power-of-two = "warn"
+ip-constant = "warn"
+elidable-lifetime-names = "warn"
+coerce-container-to-any = "warn"
+todo = "warn"
+inline-always = "warn"
+# multiple-crate-versions = "warn"
+use-self = "warn"
+useless-let-if-seq = "warn"
+suboptimal-flops = "warn"
+redundant-clone = "warn"
+
+[profile.release]
+opt-level = 3
+split-debuginfo = "packed"
+strip = "symbols"
+lto = true
+panic = "unwind"
+codegen-units = 1
+
+[lints]
+workspace = true
+
+[[bin]]
+name = "api-update"
+path = "src/main.rs"

Dockerfile

@@ -0,0 +1,36 @@
+# rust builder
+
+FROM rust:bookworm AS rust_builder
+
+ARG GIT_COMMIT
+
+ENV GIT_COMMIT=$GIT_COMMIT
+
+WORKDIR /app
+
+COPY rust-toolchain.toml ./
+RUN rustup toolchain install --profile minimal $(grep "channel" rust-toolchain.toml | cut -d'"' -f2)
+
+COPY . .
+RUN cargo build --release
+
+# runtime image
+
+FROM debian:bookworm-slim
+
+WORKDIR /app
+
+COPY --from=rust_builder /app/target/release/api-main .
+RUN apt-get update && \
+    apt-get install -y ca-certificates curl gnupg lsb-release && \
+    install -m 0755 -d /etc/apt/keyrings && \
+    curl -fsSL https://download.docker.com/linux/debian/gpg | gpg --dearmor -o /etc/apt/keyrings/docker.gpg && \
+    echo "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.gpg] https://download.docker.com/linux/debian $(lsb_release -cs) stable" \
+      > /etc/apt/sources.list.d/docker.list && \
+    apt-get update && \
+    apt-get install -y docker-ce-cli && \
+    rm -rf /var/lib/apt/lists/*
+
+# commands
+
+CMD ["./api-main"]

build.rs

@@ -0,0 +1,35 @@
+//! Generates static build info.
+
+use std::process::Command;
+
+use anyhow::Error;
+use vergen::{BuildBuilder, CargoBuilder, Emitter, RustcBuilder, SysinfoBuilder};
+
+fn main() -> Result<(), Error> {
+    {
+        let git_hash = std::env::var("GIT_COMMIT").unwrap_or_else(|_| {
+            let output = Command::new("git")
+                .args(["rev-parse", "HEAD"])
+                .output()
+                .unwrap();
+            String::from_utf8(output.stdout).unwrap()
+        });
+        println!("cargo:rustc-env=GIT_HASH={}", git_hash.trim());
+    }
+
+    {
+        let build = BuildBuilder::all_build()?;
+        let cargo = CargoBuilder::all_cargo()?;
+        let rustc = RustcBuilder::all_rustc()?;
+        let si = SysinfoBuilder::all_sysinfo()?;
+
+        Emitter::default()
+            .add_instructions(&build)?
+            .add_instructions(&cargo)?
+            .add_instructions(&rustc)?
+            .add_instructions(&si)?
+            .emit()?;
+    }
+
+    Ok(())
+}

rust-toolchain.toml

@@ -0,0 +1,3 @@
+[toolchain]
+channel = "stable"
+components = ["rustfmt", "clippy"]

rustfmt.toml

@@ -0,0 +1,6 @@
+edition = "2024"
+match_arm_leading_pipes = "Preserve"
+newline_style = "Unix"
+use_field_init_shorthand = true
+hard_tabs = false
+tab_spaces = 4

src/config/mod.rs

@@ -0,0 +1,70 @@
+//! Reads configs.
+
+use std::path::PathBuf;
+
+use serde::Deserialize;
+
+use crate::env::CONFIG_DIR;
+
+/// The available config files.
+#[non_exhaustive]
+#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
+pub enum ConfigFile {
+    /// The services to update.
+    Services,
+}
+
+impl ConfigFile {
+    /// The file name of the config file.
+    pub fn file_name(&self) -> &'static str {
+        match self {
+            Self::Services => "services.toml",
+        }
+    }
+
+    /// The path to the config file, respecting [`CONFIG_DIR`].
+    pub fn path(&self) -> PathBuf {
+        CONFIG_DIR.join(self.file_name())
+    }
+}
+
+/// A trait for configs that can be deserialized.
+pub trait Config<'de>: Deserialize<'de> {
+    /// The [`ConfigFile`] this config corresponds to.
+    fn file() -> ConfigFile;
+}
+
+/// The services config.
+pub mod services {
+    use super::*;
+
+    /// Defines a service to update.
+    #[derive(Debug, Clone, PartialEq, Eq, Hash, Deserialize)]
+    pub struct ServiceConfig {
+        /// An optional name for the service, for easier identification.
+        pub name: Option<String>,
+        /// The label of the service.
+        ///
+        /// This is used to identify the target of update requests. Must be unique among all services.
+        pub service_label: String,
+        /// The container name of the service.
+        ///
+        /// This is used to identify the Docker container to update. Must match the actual container name.
+        pub container_name: String,
+        /// The image to update the service from.
+        pub image: String,
+    }
+
+    /// Defines the services related to updates.
+    #[derive(Debug, Clone, PartialEq, Eq, Hash, Deserialize)]
+    pub struct ServicesConfig {
+        /// The list of services to update.
+        pub services: Vec<ServiceConfig>,
+    }
+
+    impl Config<'_> for ServicesConfig {
+        fn file() -> ConfigFile {
+            ConfigFile::Services
+        }
+    }
+}