merge new structure for alpha release #51

Merged
PlexSheep merged 5 commits from devel into master 2024-01-17 14:37:38 +01:00
19 changed files with 77 additions and 372 deletions

View File

@ -4,28 +4,27 @@ on:
branches:
- master
#jobs:
# format:
# name: cargo CI
# permissions:
# # Give the default GITHUB_TOKEN write permission to commit and push the
# # added or changed files to the repository.
# contents: write
# steps:
# - name: get repo
# uses: actions/checkout@v4
# - name: install rust
# uses: dtolnay/rust-toolchain@stable
# - name: config custom registry
# run: |
# mkdir -p ~/.cargo/
# echo -e '[registry]
# cscherr= "cscherr"
#
# [registries.cscherr]
# index = "sparse+https://git.cscherr.de/api/packages/PlexSheep/cargo/"
# ' > ~/.cargo/config.toml
# cat ~/.cargo/config.toml
# - name: publish crates on git.cscherr.de
# run: |
# cargo workspaces publish --registry cscherr
jobs:
format:
name: cargo CI
permissions:
# Give the default GITHUB_TOKEN write permission to commit and push the
# added or changed files to the repository.
contents: write
steps:
- name: get repo
uses: actions/checkout@v4
- name: install rust
uses: dtolnay/rust-toolchain@stable
- name: config custom registry
run: |
mkdir -p ~/.cargo/
echo "" > ~/.cargo/config.toml
echo "[registry]" >> ~/.cargo/config.toml
echo 'cscherr = "cscherr"' >> ~/.cargo/config.toml
echo '[registries.cscherr]' >> ~/.cargo/config.toml
echo 'index = "https://git.cscherr.de/PlexSheep/_cargo-index.git"' >> ~/.cargo/config.toml
cat ~/.cargo/config.toml
- name: publish crates on git.cscherr.de
run: |
cargo workspaces publish --registry cscherr

View File

@ -1,4 +1,4 @@
name: Cargo Check, Format, Fix and Test
name: cargo devel CI
on:
push:
branches:
@ -17,16 +17,16 @@ jobs:
uses: actions/checkout@v4
- name: install rust
uses: dtolnay/rust-toolchain@stable
- name: install additional rust things
run: rustup component add rustfmt
- name: config custom registry
run: |
mkdir -p ~/.cargo/
echo -e '[registry]
cscherr= "cscherr"
[registries.cscherr]
index = "sparse+https://git.cscherr.de/api/packages/PlexSheep/cargo/"
' > ~/.cargo/config.toml
echo "" > ~/.cargo/config.toml
echo "[registry]" >> ~/.cargo/config.toml
echo 'cscherr = "cscherr"' >> ~/.cargo/config.toml
echo '[registries.cscherr]' >> ~/.cargo/config.toml
echo 'index = "https://git.cscherr.de/PlexSheep/_cargo-index.git"' >> ~/.cargo/config.toml
cat ~/.cargo/config.toml
- name: cargo check
run: cargo check --all-features --all-targets

View File

@ -3,14 +3,11 @@ resolver = "2"
members = [
".",
"members/libpt-core",
"members/libpt-bintols",
"members/libpt-math",
"members/libpt-bin",
"members/libpt-log",
"members/libpt-net",
"members/libpt-hedu",
]
default-members = [".", "members/libpt-bin", "members/libpt-core"]
default-members = [".", "members/libpt-core"]
[workspace.package]
publish = true
version = "0.2.0-alpha.3"
@ -31,8 +28,11 @@ categories = [
[workspace.dependencies]
anyhow = "1.0.79"
thiserror = "1.0.56"
libpt-log = { version = "0.2.0-alpha.2", path = "../libpt-log" }
libpt-bintols = { version = "0.2.0-alpha.2", ath = "../libpt-bintols" }
libpt-core = { version = "0.2.0-alpha.2", path = "members/libpt-core", registry = "cscherr" }
libpt-bintols = { version = "0.2.0-alpha.2", path = "members/libpt-bintols", registry = "cscherr" }
libpt-log = { version = "0.2.0-alpha.2", path = "members/libpt-log", registry = "cscherr" }
libpt-math = { version = "0.2.0-alpha.2", path = "members/libpt-math", registry = "cscherr" }
libpt-net = { version = "0.2.0-alpha.2", path = "members/libpt-net", registry = "cscherr" }
[package]
name = "libpt"
@ -50,15 +50,12 @@ categories.workspace = true
[features]
default = ["log", "core"]
all = ["default", "math", "log", "bintols", "net", "ccc", "hedu", "core"]
core = []
fw = []
math = []
log = []
bintols = []
net = []
ccc = ["math"]
hedu = ["bintols"]
bin = ["dep:clap", "dep:clap-num", "dep:clap-verbosity-flag"]
[lib]
name = "libpt"
@ -68,13 +65,23 @@ crate-type = [
"rlib",
]
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
[[bin]]
name = "ccc"
path = "src/ccc/mod.rs"
required-features = ["bin", "math"]
[[bin]]
name = "hedu"
path = "src/hedu/mod.rs"
required-features = ["bin", "bintols"]
[dependencies]
libpt-bintols = { version = "0.2.0-alpha.2", path = "members/libpt-bintols", registry="cscherr"}
libpt-core = { version = "0.2.0-alpha.2", path = "members/libpt-core", registry="cscherr" }
libpt-hedu = { version = "0.2.0-alpha.2", path = "members/libpt-hedu", registry="cscherr" }
libpt-log = { version = "0.2.0-alpha.2", path = "members/libpt-log", registry="cscherr" }
libpt-math = { version = "0.2.0-alpha.2", path = "members/libpt-math", registry="cscherr" }
libpt-ccc = { version = "0.2.0-alpha.2", path = "members/libpt-ccc", registry="cscherr" }
libpt-net = { version = "0.2.0-alpha.2", path = "members/libpt-net", registry="cscherr" }
libpt-core = { workspace = true }
libpt-bintols = { workspace = true }
libpt-log = { workspace = true }
libpt-math = { workspace = true }
libpt-net = { workspace = true }
clap = { version = "4.4.4", features = ["derive"], optional = true }
clap-num = { version = "1.0.2", optional = true }
clap-verbosity-flag = { version = "2.0.1", optional = true }

View File

@ -1,41 +0,0 @@
[package]
autobins = true
name = "libpt-bin"
publish.workspace = true
version.workspace = true
edition.workspace = true
authors.workspace = true
license.workspace = true
description.workspace = true
readme.workspace = true
homepage.workspace = true
repository.workspace = true
keywords.workspace = true
categories.workspace = true
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
[[bin]]
name = "ccc"
path = "src/ccc/mod.rs"
[[bin]]
name = "hedu"
path = "src/hedu/mod.rs"
[[bin]]
name = "libpt"
path = "src/main/mod.rs"
[dependencies]
clap = { version = "4.4.4", features = ["derive"] }
clap-num = "1.0.2"
clap-verbosity-flag = "2.0.1"
libpt = { version = "0.2.0-alpha.2", path = "../..", features = [
"default",
"ccc",
"math",
"hedu",
"net",
"log",
], registry = "cscherr" }

View File

@ -1,124 +0,0 @@
//! # args module
//!
//! The args module of libpt is used to parse commandline arguments. For this, it makes use of
//! [`clap`].
//// ATTRIBUTES ////////////////////////////////////////////////////////////////////////////////////
// we want docs
#![warn(missing_docs)]
#![warn(rustdoc::missing_crate_level_docs)]
////////////////////////////////////////////////////////////////////////////////////////////////////
// we want Debug everywhere.
#![warn(missing_debug_implementations)]
////////////////////////////////////////////////////////////////////////////////////////////////////
// enable clippy's extra lints, the pedantic version
#![warn(clippy::pedantic)]
//// IMPORTS ///////////////////////////////////////////////////////////////////////////////////////
use clap::{Parser, Subcommand};
use clap_num::number_range;
use clap_verbosity_flag::{InfoLevel, Verbosity};
//// CONSTANTS /////////////////////////////////////////////////////////////////////////////////////
/// short about section displayed in help
const ABOUT_ROOT: &'static str = r##"
Personal multi tool
A collection of tools made for personal use
"##;
/// longer about section displayed in help, is combined with [the short help](ABOUT_ROOT)
static LONG_ABOUT_ROOT: &'static str = r##"
libpt is a personal general purpose library, offering this executable, a python module and a
dynamic library.
"##;
//// STATICS ///////////////////////////////////////////////////////////////////////////////////////
/// ## Main struct for parsing CLI arguments
///
/// This struct describes the complete commandline options/arguments that [pt](crate) can take. It
/// makes use of composition to build a complex system of commands, subcommands, flags and options.
#[derive(Debug, Clone, Parser)]
#[command(
author,
version,
about = ABOUT_ROOT,
long_about = format!("{}{}", ABOUT_ROOT ,LONG_ABOUT_ROOT),
help_template =
r#"libpt: {version}{about-section}Author:
{author-with-newline}
{usage-heading} {usage}{all-args}{tab}"#
)]
pub struct Cli {
// clap_verbosity_flag seems to make this a global option implicitly
/// set a verbosity, multiple allowed (f.e. -vvv)
#[command(flatten)]
pub verbose: Verbosity<InfoLevel>,
/// show logger meta
#[arg(short, long, global = true)]
pub log_meta: bool,
/// choose a subcommand
#[command(subcommand)]
pub command: Commands,
}
//// ENUMS /////////////////////////////////////////////////////////////////////////////////////////
/// ## defines the top level commands
#[derive(Debug, Clone, Subcommand)]
#[non_exhaustive]
pub enum Commands {
/// networking commands
Net {
/// Networking subcommands
#[command(subcommand)]
command: NetCommands,
},
}
////////////////////////////////////////////////////////////////////////////////////////////////////
/// ## defines the networking commands
#[derive(Debug, Clone, Subcommand)]
#[non_exhaustive]
pub enum NetCommands {
/// monitor your network
Monitor {
/// repeat every N seconds, 0 means no repeat
#[clap(short, long, default_value_t = 0, name = "N")]
repeat: u64,
/// At what percentage should the try be considered successful
#[clap(short, long, default_value_t = 100, value_parser=max100)]
success_ratio: u8,
/// extra URLs to check with
extra_urls: Vec<String>,
/// Don't check for default URLs
#[clap(short, long)]
no_default: bool,
/// set a timeout (in ms)
#[clap(short, long, default_value_t = 100)]
timeout: u64,
},
/// discover hosts in your network
Discover {},
}
////////////////////////////////////////////////////////////////////////////////////////////////////
//// STRUCTS ///////////////////////////////////////////////////////////////////////////////////////
//// IMPLEMENTATION ////////////////////////////////////////////////////////////////////////////////
//// PUBLIC FUNCTIONS //////////////////////////////////////////////////////////////////////////////
//// PRIVATE FUNCTIONS /////////////////////////////////////////////////////////////////////////////
/// custom value parser, only allow 0 to 100
fn max100(s: &str) -> Result<u8, String> {
number_range(s, 0, 100)
}

View File

@ -1,102 +0,0 @@
//! # Main executable of libpt
//!
//! This module contains all code specific to the executable version of [`pt`]: [`pt`](crate).
//!
//!
//// ATTRIBUTES ////////////////////////////////////////////////////////////////////////////////////
// we want docs
#![warn(missing_docs)]
#![warn(rustdoc::missing_crate_level_docs)]
// we want Debug everywhere.
#![warn(missing_debug_implementations)]
// enable clippy's extra lints, the pedantic version
#![warn(clippy::pedantic)]
//// IMPORTS ///////////////////////////////////////////////////////////////////////////////////////
use libpt::{log::*, net::monitoring::uptime};
use clap::Parser;
pub mod args;
use args::*;
//// CONSTANTS /////////////////////////////////////////////////////////////////////////////////////
#[allow(dead_code)]
//// STATICS ///////////////////////////////////////////////////////////////////////////////////////
//// MACROS ////////////////////////////////////////////////////////////////////////////////////////
//// ENUMS /////////////////////////////////////////////////////////////////////////////////////////
//// STRUCTS ///////////////////////////////////////////////////////////////////////////////////////
//// IMPLEMENTATION ////////////////////////////////////////////////////////////////////////////////
//// PUBLIC FUNCTIONS //////////////////////////////////////////////////////////////////////////////
/// ## Main function of the [`pt`](crate) binary
pub fn main() {
let cli = Cli::parse();
let ll: Level = match cli.verbose.log_level().unwrap().as_str() {
"TRACE" => Level::TRACE,
"DEBUG" => Level::DEBUG,
"INFO" => Level::INFO,
"WARN" => Level::WARN,
"ERROR" => Level::ERROR,
_ => {
eprintln!("'{}' is not a valid loglevel", cli.verbose.to_string());
std::process::exit(1);
}
};
if cli.log_meta {
Logger::init(None, Some(ll)).expect("could not initialize Logger");
} else {
// less verbose version
Logger::init_mini(Some(ll)).expect("could not initialize Logger");
}
trace!("started the main function");
trace!("{:?}", &cli);
match cli.clone().command {
Commands::Net { command } => net(&cli, command),
}
}
////////////////////////////////////////////////////////////////////////////////////////////////////
/// ## Process [`Net`](args::NetCommands) subcommands
pub fn net(cli: &Cli, command: NetCommands) {
match command {
NetCommands::Monitor {
repeat,
success_ratio,
extra_urls,
no_default,
timeout,
} => {
let urls: Vec<String>;
if no_default {
urls = extra_urls;
} else {
let mut combined: Vec<String> = Vec::new();
for i in uptime::DEFAULT_CHECK_URLS {
combined.push(i.to_string());
}
combined.extend(extra_urls);
urls = combined;
}
let _verbose = cli.verbose.log_level().is_some();
if repeat > 0 {
uptime::continuous_uptime_monitor(success_ratio, urls, repeat * 1000, timeout);
} else {
let status = uptime::UptimeStatus::new(success_ratio, urls, timeout);
info!("status:\n{}", status);
}
}
NetCommands::Discover {} => {
todo!()
}
}
}
//// PRIVATE FUNCTIONS /////////////////////////////////////////////////////////////////////////////

View File

@ -16,5 +16,7 @@ categories.workspace = true
[dependencies]
num-traits = "0.2.16"
libpt-core = { version = "0.2.0-alpha.2", path = "../libpt-core", registry="cscherr" }
libpt-log = { version = "0.2.0-alpha.2", path = "../libpt-log", registry="cscherr" }
libpt-core = { workspace = true }
libpt-log = { workspace = true }
anyhow = { workspace = true }
thiserror = { workspace = true }

View File

@ -5,8 +5,8 @@
//!
//! This crate is currently empty.
use crate::display::{bytes_to_bin, humanbytes};
use anyhow::{bail, Result};
use libpt_bintols::display::{bytes_to_bin, humanbytes};
use libpt_log::{debug, error, info, trace, warn};
use std::io::{prelude::*, BufReader, Read, SeekFrom};

View File

@ -25,3 +25,4 @@ pub const YOBI: u128 = 2u128.pow(80);
// use libpt_core;
pub mod datalayout;
pub mod display;
pub mod hedu;

View File

@ -1,22 +0,0 @@
[package]
name = "libpt-ccc"
publish.workspace = true
version.workspace = true
edition.workspace = true
authors.workspace = true
license.workspace = true
description.workspace = true
readme.workspace = true
homepage.workspace = true
repository.workspace = true
keywords.workspace = true
categories.workspace = true
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
[dependencies]
num = "0.4.1"
num-traits = "0.2.16"
libpt-core = { version = "0.2.0-alpha.2", path = "../libpt-core", registry="cscherr" }
libpt-log = { version = "0.2.0-alpha.2", path = "../libpt-log", registry="cscherr" }
libpt-math = { version = "0.2.0-alpha.2", path = "../libpt-math", registry="cscherr" }

View File

@ -15,4 +15,4 @@ categories.workspace = true
[dependencies]
anyhow = "1.0.79"
cucumber = "0.20.2"
libpt-log = { version = "0.2.0-alpha.2", path = "../libpt-log", registry="cscherr" }
libpt-log = { workspace = true }

View File

@ -1,21 +0,0 @@
[package]
name = "libpt-hedu"
publish.workspace = true
version.workspace = true
edition.workspace = true
authors.workspace = true
license.workspace = true
description.workspace = true
readme.workspace = true
homepage.workspace = true
repository.workspace = true
keywords.workspace = true
categories.workspace = true
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
[dependencies]
anyhow = { workspace = true }
thiserror = { workspace = true }
libpt-log = { version = "0.2.0-alpha.2", path = "../libpt-log", registry="cscherr" }
libpt-bintols = { version = "0.2.0-alpha.2", path = "../libpt-bintols", registry="cscherr" }

View File

@ -15,3 +15,7 @@ categories.workspace = true
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
[dependencies]
num = "0.4.1"
num-traits = "0.2.16"
libpt-core = { workspace = true }
libpt-log = { workspace = true }

View File

@ -19,8 +19,6 @@
#![warn(clippy::pedantic)]
//// IMPORTS ///////////////////////////////////////////////////////////////////////////////////////
use libpt_log;
use libpt_math;
//// TYPES /////////////////////////////////////////////////////////////////////////////////////////

View File

@ -15,6 +15,7 @@
#![warn(clippy::pedantic)]
//// IMPORTS ///////////////////////////////////////////////////////////////////////////////////////
pub mod ccc;
//// TYPES /////////////////////////////////////////////////////////////////////////////////////////

View File

@ -16,9 +16,9 @@ categories.workspace = true
[dependencies]
humantime = "2.1.0"
libpt-core = { version = "0.2.0-alpha.2", path = "../libpt-core", registry="cscherr" }
libpt-log = { version = "0.2.0-alpha.2", path = "../libpt-log", registry="cscherr" }
libpt-math = { version = "0.2.0-alpha.2", path = "../libpt-math", registry="cscherr" }
libpt-core = { workspace = true }
libpt-log = { workspace = true }
libpt-math = { workspace = true }
reqwest = { version = "0.11.20", features = ["blocking"] }
serde = { version = "1.0.188", features = ["serde_derive"] }
serde_json = "1.0.107"

View File

@ -13,7 +13,7 @@
//// IMPORTS ///////////////////////////////////////////////////////////////////////////////////////
use libpt::{hedu::*, log::*};
use libpt::{bintols::hedu::*, log::*};
use clap::Parser;
use clap_verbosity_flag::{InfoLevel, Verbosity};
@ -88,6 +88,11 @@ pub struct Cli {
/// If left empty or set as "-", the program will read from stdin.
pub data_source: Option<String>,
}
impl Cli {
fn parse() -> Cli {
todo!()
}
}
//// IMPLEMENTATION ////////////////////////////////////////////////////////////////////////////////

View File

@ -12,8 +12,6 @@ pub use libpt_bintols as bintols;
pub use libpt_ccc as ccc;
#[cfg(feature = "core")]
pub use libpt_core as core;
#[cfg(feature = "hedu")]
pub use libpt_hedu as hedu;
#[cfg(feature = "log")]
pub use libpt_log as log;
#[cfg(feature = "math")]