Compare commits

...

15 Commits

Author SHA1 Message Date
Christoph J. Scherr 11a2d7908e chore: just use github for ci and also add cd 2024-10-16 20:26:44 +02:00
Christoph J. Scherr 90e3442b50 chore: change ci message to fit conventional git commits 2024-10-16 13:49:50 +02:00
Christoph J. Scherr 30168c5523 chore: bump version
cargo devel CI / cargo CI (push) Successful in 1m49s Details
2024-09-08 01:34:28 +02:00
Christoph J. Scherr a7d0c18f52 chore: reset publish script
cargo devel CI / cargo CI (push) Has been cancelled Details
2024-09-08 01:27:27 +02:00
Christoph J. Scherr 54a694645f refactor(log): make logfile kinda behave like normal
cargo devel CI / cargo CI (push) Has been cancelled Details
2024-09-08 01:26:37 +02:00
Christoph J. Scherr 492e655d29 chore: bump versions
cargo devel CI / cargo CI (push) Successful in 1m50s Details
2024-09-08 01:14:35 +02:00
Christoph J. Scherr a9fbcf9518 fix(log): panic when trying to open alogfile in a dir that did not exist
cargo devel CI / cargo CI (push) Has been cancelled Details
2024-09-08 01:14:04 +02:00
Christoph J. Scherr 51e2c3029e chore: bump versions
cargo devel CI / cargo CI (push) Successful in 1m52s Details
2024-09-08 01:05:08 +02:00
Christoph J. Scherr 6197532bc7 refactor(log): refactor the build function
cargo devel CI / cargo CI (push) Has been cancelled Details
2024-09-08 00:35:19 +02:00
Christoph J. Scherr 3063f77798 Merge branch 'master' into devel
cargo devel CI / cargo CI (push) Successful in 1m50s Details
2024-09-07 23:51:36 +02:00
Christoph J. Scherr 05910ae3be docs: add backtics
cargo devel CI / cargo CI (push) Has been cancelled Details
2024-09-07 23:51:19 +02:00
PlexSheep 895b156e02 automatic cargo CI changes 2024-09-07 21:51:12 +00:00
Christoph J. Scherr 35ab3d9b28 chore: fix publish script
cargo devel CI / cargo CI (push) Successful in 2m1s Details
2024-09-07 23:49:15 +02:00
Christoph J. Scherr 917a68c8ab chore: bump versions
cargo devel CI / cargo CI (push) Has been cancelled Details
2024-09-07 23:48:22 +02:00
Christoph J. Scherr 5b0c82cf2b feat(log): specify span events + doc fixes 2024-09-07 23:47:06 +02:00
10 changed files with 151 additions and 110 deletions

View File

@ -21,8 +21,6 @@ jobs:
run: | run: |
rustup component add rustfmt rustup component add rustfmt
rustup component add clippy rustup component add clippy
- name: install python
run: apt update && apt install libpython3-dev -y
- name: config custom registry - name: config custom registry
run: | run: |
mkdir -p ~/.cargo/ mkdir -p ~/.cargo/
@ -45,4 +43,4 @@ jobs:
with: with:
# Optional. Commit message for the created commit. # Optional. Commit message for the created commit.
# Defaults to "Apply automatic changes" # Defaults to "Apply automatic changes"
commit_message: automatic cargo CI changes commit_message: "ci: automatic cargo CI changes"

7
.github/dependabot.yaml vendored Normal file
View File

@ -0,0 +1,7 @@
version: 2
updates:
- package-ecosystem: "github-actions"
directory: "/"
# Check for updates every Monday
schedule:
interval: "weekly"

View File

@ -1,10 +1,16 @@
name: cargo devel CI name: Rust CI
on: on:
pull_request:
branches:
- '**'
push: push:
branches: branches:
- '**' - '**'
# - '!master' # - '!master'
env:
CARGO_TERM_COLOR: always
jobs: jobs:
CI: CI:
runs-on: ubuntu-latest runs-on: ubuntu-latest
@ -42,10 +48,10 @@ jobs:
- name: cargo fmt - name: cargo fmt
run: cargo fmt --all run: cargo fmt --all
- name: cargo test - name: cargo test
run: cargo test --all-features --all-targets --workspace && cargo test --all-features --workspace --doc run: cargo test --all-features --all-targets --workspace
- name: commit back to repository - name: commit back to repository
uses: stefanzweifel/git-auto-commit-action@v5 uses: stefanzweifel/git-auto-commit-action@v5
with: with:
# Optional. Commit message for the created commit. # Optional. Commit message for the created commit.
# Defaults to "Apply automatic changes" # Defaults to "Apply automatic changes"
commit_message: automatic cargo CI changes commit_message: "ci: automatic Rust CI changes"

54
.github/workflows/release.yaml vendored Normal file
View File

@ -0,0 +1,54 @@
name: Release-plz
permissions:
pull-requests: write
contents: write
on:
push:
branches:
- master
- main
jobs:
# Release unpublished packages.
release-plz-release:
name: Release-plz release
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Install Rust toolchain
uses: dtolnay/rust-toolchain@stable
- name: Run release-plz
uses: MarcoIeni/release-plz-action@v0.5
with:
command: release
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}
# Create a PR with the new versions and changelog, preparing the next release.
release-plz-pr:
name: Release-plz PR
runs-on: ubuntu-latest
concurrency:
group: release-plz-${{ github.ref }}
cancel-in-progress: false
steps:
- name: Checkout repository
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Install Rust toolchain
uses: dtolnay/rust-toolchain@stable
- name: Run release-plz
uses: MarcoIeni/release-plz-action@v0.5
with:
command: release-pr
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}

View File

@ -5,7 +5,7 @@ default-members = [".", "members/libpt-core"]
[workspace.package] [workspace.package]
publish = true publish = true
version = "0.7.1" version = "0.7.3-alpha.2"
edition = "2021" edition = "2021"
authors = ["Christoph J. Scherr <software@cscherr.de>"] authors = ["Christoph J. Scherr <software@cscherr.de>"]
license = "GPL-3.0-or-later" license = "GPL-3.0-or-later"
@ -21,8 +21,8 @@ anyhow = "1.0.79"
thiserror = "1.0.56" thiserror = "1.0.56"
libpt-core = { version = "0.5.0", path = "members/libpt-core" } libpt-core = { version = "0.5.0", path = "members/libpt-core" }
libpt-bintols = { version = "0.5.1", path = "members/libpt-bintols" } libpt-bintols = { version = "0.5.1", path = "members/libpt-bintols" }
libpt-log = { version = "0.6.0", path = "members/libpt-log" } libpt-log = { version = "0.6.2-alpha.1", path = "members/libpt-log" }
libpt-cli = { version = "0.2.1", path = "members/libpt-cli" } libpt-cli = { version = "0.2.2-alpha.1", path = "members/libpt-cli" }
[package] [package]
name = "libpt" name = "libpt"

View File

@ -1,7 +1,7 @@
[package] [package]
name = "libpt-cli" name = "libpt-cli"
publish.workspace = true publish.workspace = true
version = "0.2.1" version = "0.2.2-alpha.2"
edition.workspace = true edition.workspace = true
authors.workspace = true authors.workspace = true
license.workspace = true license.workspace = true
@ -24,8 +24,6 @@ comfy-table = "7.1.1"
console = "0.15.8" console = "0.15.8"
dialoguer = { version = "0.11.0", features = ["completion", "history"] } dialoguer = { version = "0.11.0", features = ["completion", "history"] }
embed-doc-image = "0.1.4" embed-doc-image = "0.1.4"
exitcode = "1.1.2"
human-panic = "2.0.0"
indicatif = "0.17.8" indicatif = "0.17.8"
libpt-log = { workspace = true, optional = false } libpt-log = { workspace = true, optional = false }
log = { version = "0.4.21", optional = true } log = { version = "0.4.21", optional = true }

View File

@ -1,7 +1,7 @@
[package] [package]
name = "libpt-log" name = "libpt-log"
publish.workspace = true publish.workspace = true
version = "0.6.0" version = "0.6.2-alpha.2"
edition.workspace = true edition.workspace = true
authors.workspace = true authors.workspace = true
license.workspace = true license.workspace = true
@ -13,12 +13,13 @@ keywords.workspace = true
categories.workspace = true categories.workspace = true
[dependencies] [dependencies]
tracing = "0.1.37" tracing = "0.1.40"
tracing-appender = "0.2.2" tracing-appender = "0.2.3"
tracing-subscriber = "0.3.17" tracing-subscriber = { version = "0.3.18", features = ["env-filter"] }
anyhow = { workspace = true } anyhow = { workspace = true }
thiserror = { workspace = true } thiserror = { workspace = true }
libpt-core = { workspace = true, optional = false } libpt-core = { workspace = true, optional = false }
chrono = "0.4.38"
[dev-dependencies] [dev-dependencies]
gag = "1.0.0" gag = "1.0.0"

View File

@ -17,7 +17,9 @@ pub enum Error {
/// Could not assign logger as the global default /// Could not assign logger as the global default
#[error("Could not assign logger as global default")] #[error("Could not assign logger as global default")]
SetGlobalDefaultFail(#[from] SetGlobalDefaultError), SetGlobalDefaultFail(#[from] SetGlobalDefaultError),
/// any other error type, wrapped in [anyhow::Error](anyhow::Error) /// any other error type, wrapped in [`anyhow::Error`]
#[error(transparent)] #[error(transparent)]
Other(#[from] anyhow::Error), Other(#[from] anyhow::Error),
#[error("Tried to open the logfile, but logging to file was not requested")]
LogfileButNoFilelog,
} }

View File

@ -18,7 +18,7 @@
#![warn(clippy::pedantic, clippy::style, clippy::nursery)] #![warn(clippy::pedantic, clippy::style, clippy::nursery)]
use std::{ use std::{
fmt, fmt::{self, Debug},
path::PathBuf, path::PathBuf,
sync::atomic::{AtomicBool, Ordering}, sync::atomic::{AtomicBool, Ordering},
}; };
@ -31,8 +31,9 @@ use error::Error;
/// I'm just repackaging it a little to make it more ergonomic /// I'm just repackaging it a little to make it more ergonomic
pub use tracing; pub use tracing;
pub use tracing::{debug, error, info, trace, warn, Level}; pub use tracing::{debug, error, info, trace, warn, Level};
use tracing_appender::{self}; use tracing_subscriber::{
use tracing_subscriber::fmt::{format::FmtSpan, time}; fmt::format::FmtSpan, layer::SubscriberExt as _, util::SubscriberInitExt, Layer,
};
use anyhow::{bail, Result}; use anyhow::{bail, Result};
/// The log level used when none is specified /// The log level used when none is specified
@ -61,7 +62,7 @@ static INITIALIZED: AtomicBool = AtomicBool::new(false);
/// # } /// # }
/// ///
/// ``` /// ```
#[derive(PartialEq, Eq, PartialOrd, Ord, Hash, Debug)] #[derive(PartialEq, Eq, PartialOrd, Ord, Debug)]
#[allow(clippy::struct_excessive_bools)] // it's just true/false values, not states, and I don't #[allow(clippy::struct_excessive_bools)] // it's just true/false values, not states, and I don't
// need to reinvent the wheel // need to reinvent the wheel
pub struct LoggerBuilder { pub struct LoggerBuilder {
@ -94,6 +95,8 @@ pub struct LoggerBuilder {
show_time: bool, show_time: bool,
/// show timestamps as uptime (duration since the logger was initialized) /// show timestamps as uptime (duration since the logger was initialized)
uptime: bool, uptime: bool,
/// log when span things happen
span_events: FmtSpan,
} }
impl LoggerBuilder { impl LoggerBuilder {
@ -128,100 +131,72 @@ impl LoggerBuilder {
/// This function will return an error if a global Logger was aready initialized. This module /// This function will return an error if a global Logger was aready initialized. This module
/// uses the [tracing] crate for logging, so if a [tracing] logger is initialized elsewhere, /// uses the [tracing] crate for logging, so if a [tracing] logger is initialized elsewhere,
/// this method will error. /// this method will error.
#[allow(clippy::missing_panics_doc)]
pub fn build(self) -> Result<Logger> { pub fn build(self) -> Result<Logger> {
// only init if no init has been performed yet // only init if no init has been performed yet
if INITIALIZED.load(Ordering::Relaxed) { if INITIALIZED.load(Ordering::Relaxed) {
warn!("trying to reinitialize the logger, ignoring"); warn!("trying to reinitialize the logger, ignoring");
bail!(Error::Usage("logging is already initialized".to_string())); bail!(Error::Usage("logging is already initialized".to_string()));
} }
let subscriber = tracing_subscriber::fmt::Subscriber::builder() let layer = tracing_subscriber::fmt::layer()
.with_level(self.display_level)
.with_max_level(self.max_level)
.with_ansi(self.ansi) .with_ansi(self.ansi)
.with_target(self.display_target) .with_target(self.display_target)
.with_file(self.display_filename) .with_file(self.display_filename)
.with_thread_ids(self.display_thread_ids) .with_thread_ids(self.display_thread_ids)
.with_line_number(self.display_line_number) .with_line_number(self.display_line_number)
.with_thread_names(self.display_thread_names) .with_thread_names(self.display_thread_names)
.with_span_events(FmtSpan::FULL); .with_span_events(self.span_events.clone())
// HACK: somehow find a better solution for this .with_filter(tracing::level_filters::LevelFilter::from_level(
// I know this is hacky, but I couldn't get it any other way. I couldn't even find a self.max_level,
// project that could do it any other way. You can't apply one after another, because the ));
// type is changed every time. When using `Box<dyn Whatever>`, some methods complain about if self.log_to_file {
// not being in trait bounds. tracing_subscriber::registry()
match (self.log_to_file, self.show_time, self.pretty, self.uptime) { .with(layer.and_then({
(true, true, true, true) => { tracing_subscriber::fmt::layer()
let subscriber = subscriber .with_writer(
.with_writer(new_file_appender(self.log_dir)) self.logfile()?
.with_timer(time::uptime()) .expect("logging to file is requested but logfile returned None"),
.pretty() )
.finish(); .with_ansi(self.ansi)
tracing::subscriber::set_global_default(subscriber)?; .with_target(self.display_target)
} .with_file(self.display_filename)
(true, true, true, false) => { .with_thread_ids(self.display_thread_ids)
let subscriber = subscriber .with_line_number(self.display_line_number)
.with_writer(new_file_appender(self.log_dir)) .with_thread_names(self.display_thread_names)
.pretty() .with_span_events(self.span_events.clone())
.finish(); .with_filter(tracing::level_filters::LevelFilter::from_level(
tracing::subscriber::set_global_default(subscriber)?; self.max_level,
} ))
(true, false, true, _) => { }))
let subscriber = subscriber .init();
.with_writer(new_file_appender(self.log_dir)) } else {
.without_time() tracing_subscriber::registry().with(layer).init();
.pretty()
.finish();
tracing::subscriber::set_global_default(subscriber)?;
}
(true, true, false, true) => {
let subscriber = subscriber
.with_writer(new_file_appender(self.log_dir))
.with_timer(time::uptime())
.finish();
tracing::subscriber::set_global_default(subscriber)?;
}
(true, true, false, false) => {
let subscriber = subscriber
.with_writer(new_file_appender(self.log_dir))
.finish();
tracing::subscriber::set_global_default(subscriber)?;
}
(true, false, false, _) => {
let subscriber = subscriber
.with_writer(new_file_appender(self.log_dir))
.without_time()
.finish();
tracing::subscriber::set_global_default(subscriber)?;
}
(false, true, true, true) => {
let subscriber = subscriber.pretty().with_timer(time::uptime()).finish();
tracing::subscriber::set_global_default(subscriber)?;
}
(false, true, true, false) => {
let subscriber = subscriber.pretty().with_timer(time::uptime()).finish();
tracing::subscriber::set_global_default(subscriber)?;
}
(false, false, true, _) => {
let subscriber = subscriber.without_time().pretty().finish();
tracing::subscriber::set_global_default(subscriber)?;
}
(false, true, false, true) => {
let subscriber = subscriber.with_timer(time::uptime()).finish();
tracing::subscriber::set_global_default(subscriber)?;
}
(false, true, false, false) => {
let subscriber = subscriber.finish();
tracing::subscriber::set_global_default(subscriber)?;
}
(false, false, false, _) => {
let subscriber = subscriber.without_time().finish();
tracing::subscriber::set_global_default(subscriber)?;
}
} }
INITIALIZED.store(true, Ordering::Relaxed); INITIALIZED.store(true, Ordering::Relaxed);
Ok(Logger {}) Ok(Logger {})
} }
/// Opens a new file for logging to.
///
/// Format: `{log_dir}/{consumer_name}_2024-09-01.log`
///
/// Will be none if [`Self::log_to_file`] is [false].
fn logfile(&self) -> Result<Option<std::fs::File>> {
if !self.log_to_file {
return Err(Error::LogfileButNoFilelog.into());
}
let mut path = self.log_dir.clone();
std::fs::create_dir_all(&path)?;
path.push(format!(
"{}_{}.log",
libpt_core::get_crate_name().unwrap_or_else(|| "logfile".to_string()),
chrono::Local::now().date_naive()
));
let file = std::fs::File::create(path)?;
Ok(Some(file))
}
/// enable or disable logging to and creating of logfiles /// enable or disable logging to and creating of logfiles
/// ///
/// If you want to log to a file, don't forget to set [`Self::log_dir`]! /// If you want to log to a file, don't forget to set [`Self::log_dir`]!
@ -347,6 +322,15 @@ impl LoggerBuilder {
self.max_level = max_level; self.max_level = max_level;
self self
} }
/// set how span events are handled
///
/// Default: [`FmtSpan::NONE`]
#[must_use]
pub const fn span_events(mut self, span_events: FmtSpan) -> Self {
self.span_events = span_events;
self
}
} }
impl Default for LoggerBuilder { impl Default for LoggerBuilder {
@ -365,11 +349,12 @@ impl Default for LoggerBuilder {
pretty: false, pretty: false,
show_time: true, show_time: true,
uptime: false, uptime: false,
span_events: FmtSpan::NONE,
} }
} }
} }
/// ## Logger for [`pt`](libpt) /// ## Logger for `libpt`
/// ///
/// A logger is generally a functionality that let's you write information from your library or /// A logger is generally a functionality that let's you write information from your library or
/// application in a more structured manner than if you just wrote all information to `stdout` or /// application in a more structured manner than if you just wrote all information to `stdout` or
@ -478,13 +463,3 @@ impl Default for Logger {
.expect("building a Logger failed") .expect("building a Logger failed")
} }
} }
fn new_file_appender(log_dir: PathBuf) -> tracing_appender::rolling::RollingFileAppender {
tracing_appender::rolling::daily(
log_dir,
format!(
"{}.log",
libpt_core::get_crate_name().unwrap_or_else(|| "logfile".to_string())
),
)
}

View File

@ -1,6 +1,6 @@
#!/bin/bash #!/bin/bash
set -e set -e
cargo check --all-features cargo check --all-features --workspace
echo ">>>>>>>> SELECT A NEW VERSION" echo ">>>>>>>> SELECT A NEW VERSION"
cargo ws version cargo ws version
NEW_VERSION=$(cat Cargo.toml | rg '^\s*version\s*=\s*"([^"]*)"\s*$' -or '$1') NEW_VERSION=$(cat Cargo.toml | rg '^\s*version\s*=\s*"([^"]*)"\s*$' -or '$1')