Add ci (#7)

Author: zupzup

.github/workflows/rust.yml

@@ -0,0 +1,81 @@
+name: Rust CI
+
+on:
+  push:
+    branches: [ "*" ]
+
+permissions:
+  contents: read
+  security-events: write
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Free up disk space
+        run: |
+          echo "Before cleanup:"
+          df -h
+          docker system prune -a -f
+          sudo rm -rf /usr/local/lib/android
+          sudo rm -rf /opt/ghc
+          sudo apt-get clean
+          sudo apt-get autoremove -y
+          echo "After cleanup:"
+          df -h
+
+      - name: Switch rust version
+        run: rustup default stable
+
+      - name: Update rust
+        run: rustup update
+
+      - name: Cargo update
+        run: cargo update --verbose
+
+      - name: Check
+        run: cargo check --verbose
+
+      - name: Add fmt
+        run: rustup component add rustfmt
+
+      - name: Add cargo deny
+        run: cargo install cargo-deny
+
+      - name: Check formatting
+        run: cargo fmt -- --check
+
+      - name: Test
+        run: cargo test
+        continue-on-error: true
+
+      - name: Build
+        run: cargo build --verbose
+
+      - name: Install required cargo
+        run: cargo install clippy-sarif sarif-fmt
+
+      - name: Add clippy
+        run: rustup component add clippy
+
+      - name: Clippy
+        run:
+          cargo clippy
+          --all-features
+          --message-format=json | clippy-sarif | tee rust-clippy-results.sarif | sarif-fmt
+        continue-on-error: true
+
+      - name: Cargo deny
+        run: cargo deny check
+        continue-on-error: true
+
+      - name: Upload analysis results to GitHub
+        uses: github/codeql-action/upload-sarif@v3
+        with:
+          sarif_file: rust-clippy-results.sarif
+          wait-for-processing: true

.github/workflows/test.yml

@@ -0,0 +1,46 @@
+name: Test coverage
+
+on:
+  push:
+    branches: [ "*" ]
+
+permissions:
+  contents: read
+  security-events: write
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        toolchain:
+          - stable
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4
+
+      - name: Free up disk space
+        run: |
+          echo "Before cleanup:"
+          df -h
+          docker system prune -a -f
+          sudo rm -rf /usr/local/lib/android
+          sudo rm -rf /opt/ghc
+          sudo apt-get clean
+          sudo apt-get autoremove -y
+          echo "After cleanup:"
+          df -h
+
+      - name: Install Rust
+        uses: dtolnay/rust-toolchain@master
+        with:
+          toolchain: ${{ matrix.toolchain }}
+          components: llvm-tools-preview
+
+      - name: Activate cache
+        uses: Swatinem/[email protected]
+
+      - name: run tests
+        run: cargo test --verbose
+

Cargo.lock

@@ -19,7 +19,7 @@ axum-extra = { version = "0.10", features = ["form"] }
 axum-raw-websocket = { git = "https://github.com/tompro/axum-raw-websocket.git" }
 anyhow = "1"
 tracing = "0.1.41"
-tracing-subscriber = "0.3.19"
+tracing-subscriber = "0.3.20"
 tower-http = { version = "0.6.6", features = ["cors", "fs"] }
 clap = { version = "4.5.39", features = ["derive", "env"] }
 chrono = "0.4"

Cargo.toml

@@ -0,0 +1,64 @@
+# The graph table configures how the dependency graph is constructed and thus
+# which crates the checks are performed against
+[graph]
+targets = []
+exclude = []
+all-features = false
+no-default-features = false
+features = []
+
+[output]
+feature-depth = 1
+
+# This section is considered when running `cargo deny check advisories`
+# More documentation for the advisories section can be found here:
+# https://embarkstudios.github.io/cargo-deny/checks/advisories/cfg.html
+[advisories]
+ignore = []
+unmaintained = "workspace"
+
+# This section is considered when running `cargo deny check licenses`
+# More documentation for the licenses section can be found here:
+# https://embarkstudios.github.io/cargo-deny/checks/licenses/cfg.html
+[licenses]
+allow = ["MIT", "Apache-2.0", "Unicode-3.0", "Unlicense", "CDLA-Permissive-2.0", "ISC", "CC0-1.0",
+     "BSD-3-Clause", "Zlib", "BSD-2-Clause",
+]
+confidence-threshold = 0.8
+exceptions = []
+
+[licenses.private]
+ignore = false
+registries = []
+
+# This section is considered when running `cargo deny check bans`.
+# More documentation about the 'bans' section can be found here:
+# https://embarkstudios.github.io/cargo-deny/checks/bans/cfg.html
+[bans]
+# Lint level for when multiple versions of the same crate are detected
+multiple-versions = "allow"
+wildcards = "allow"
+highlight = "all"
+workspace-default-features = "allow"
+external-default-features = "allow"
+allow = []
+deny = []
+skip = []
+skip-tree = []
+[bans.workspace-dependencies]
+duplicates = "deny"
+unused = "deny"
+
+# This section is considered when running `cargo deny check sources`.
+# More documentation about the 'sources' section can be found here:
+# https://embarkstudios.github.io/cargo-deny/checks/sources/cfg.html
+[sources]
+unknown-registry = "warn"
+unknown-git = "warn"
+allow-registry = ["https://github.com/rust-lang/crates.io-index"]
+allow-git = []
+
+[sources.allow-org]
+github = ["BitcreditProtocol", "tompro"]
+gitlab = []
+bitbucket = []

deny.toml

@@ -3,16 +3,16 @@ pub mod file_store;
 use std::io::Write;
 
 use axum::{
+    Json,
     body::{Body, Bytes},
     extract::{Path, State},
     http::StatusCode,
     response::{IntoResponse, Response},
-    Json,
 };
 use nostr::{
     hashes::{
-        sha256::{self, Hash as Sha256Hash},
         Hash,
+        sha256::{self, Hash as Sha256Hash},
     },
     types::Url,
 };

src/blossom/mod.rs

@@ -9,11 +9,12 @@ use std::{net::SocketAddr, sync::Arc};
 
 use anyhow::Result;
 use axum::{
+    Router,
     extract::{ConnectInfo, State},
     http::{StatusCode, Uri},
     response::IntoResponse,
     routing::{any, delete, get, head, post, put},
-    serve, Router,
+    serve,
 };
 use axum_raw_websocket::RawSocketUpgrade;
 use blossom::file_store::FileStoreApi;
@@ -31,8 +32,8 @@ use tracing::{error, info};
 use crate::{
     notification::{
         email::{
-            mailjet::{MailjetConfig, MailjetService},
             EmailService,
+            mailjet::{MailjetConfig, MailjetService},
         },
         notification_store::NotificationStoreApi,
     },

src/main.rs

@@ -1,11 +1,11 @@
 use axum::{
+    Json,
     extract::{Path, Query, State},
     http::StatusCode,
     response::{Html, IntoResponse, Redirect},
-    Json,
 };
 use axum_extra::extract::Form;
-use base64::{engine::general_purpose::URL_SAFE_NO_PAD, Engine as _};
+use base64::{Engine as _, engine::general_purpose::URL_SAFE_NO_PAD};
 use borsh_derive::BorshSerialize;
 use chrono::{DateTime, Duration, Utc};
 use rand::RngCore;
@@ -14,13 +14,13 @@ use tinytemplate::TinyTemplate;
 use tracing::{error, warn};
 
 use crate::{
+    AppState,
     notification::{
         email::{build_email_confirmation_message, build_email_notification_message},
         preferences::{PreferencesContextContentFlag, PreferencesFlags},
     },
     rate_limit::RealIp,
     util::{self, get_logo_link},
-    AppState,
 };
 
 pub mod email;

src/notification/mod.rs

@@ -1,6 +1,6 @@
 use axum::{
     extract::{ConnectInfo, FromRequestParts},
-    http::{request::Parts, StatusCode},
+    http::{StatusCode, request::Parts},
 };
 use chrono::{DateTime, Duration, Utc};
 use std::{

src/rate_limit.rs

@@ -2,8 +2,8 @@ use anyhow::Result;
 use clap::Parser;
 use nostr::types::Url;
 use nostr_relay_builder::{
-    builder::{RelayBuilderNip42, RelayBuilderNip42Mode},
     LocalRelay, RelayBuilder,
+    builder::{RelayBuilderNip42, RelayBuilderNip42Mode},
 };
 use nostr_sqldb::*;
 use tracing::info;