2 Commits

Author SHA1 Message Date
3e557665c9 Debian 12-compatible minimum openssl crates
Crate `openssl-sys = 0.9.55` seems to look for OpenSSL v1.x, which is
not available to Debian 12. Pinning it up to 0.9.64 makes it match with
OpenSSL 3.x which *is* available.

HOWEVER! Building the crate on Debian 11 works just fine. Pinning the
dependencies this way is an error as I neither use them directly, nor
have any reason to depend on this specific version.

Cargo can't know about the distro version. Maybe I can use crate
features to select different openssl-sys crates? Further work required.
2025-07-02 14:52:38 -05:00
faa5ce8549 Pin crate log to 0.4.6
The `reqwest` crate says it can accept `log` version 0.4.5, but it uses
an item (a fn, probably) that doesn't exist until 0.4.6.
2025-07-02 14:32:50 -05:00
9 changed files with 53 additions and 283 deletions

View File

@@ -8,11 +8,6 @@ jobs:
name: Compile and upload a release build
steps:
- uses: actions/checkout@v4
- name: Get Cargo version
run: echo "cargo_version=v$(grep "^version" Cargo.toml | cut -d \" -f2)" >> $GITHUB_ENV
- name: Abort if Cargo.toml & Git Tag versions don't match
if: ${{ env.cargo_version != github.ref_name }}
run: exit 1
- name: Install Rust Stable
uses: dtolnay/rust-toolchain@stable
- name: Build binary crate

View File

@@ -1,16 +1,28 @@
[package]
name = "gt-tool"
version = "2.2.0"
version = "1.0.0"
edition = "2024"
[dependencies]
clap = { version = "4.0.7", features = ["derive", "env"] }
colored = "2.0.0"
itertools = "0.10.0"
reqwest = { version = "0.11.13", features = ["json", "stream", "multipart"] }
serde = { version = "1.0.152", features = ["derive"] }
tokio = { version = "1.24.2", features = ["macros", "rt-multi-thread"] }
toml = "0.5"
# Grand-dependency Pins ----
# Fixes: Reqwest uses too-old version of crate `log`
log = "0.4.6"
# Debian 12 uses OpenSSL 3.x and older libssl-sys crates are angry about that
# Fixes: native lib lookup.
# Causes: missing item in crate `ffi`
openssl-sys = "0.9.64"
# Fixes: missing item in crate `ffi` (from openssl-sys)
openssl = "0.10.35"
# End Grand-dependency Pins ----
# Packages available in Debian (Sid)
# clap = "4.5.23"

View File

@@ -1,4 +1,4 @@
# gt-tool
# gt-tools
CLI tools for interacting with the Gitea API. Use interactively to talk to your Gitea instance, or automatically via a CI/CD pipeline.

View File

@@ -1,9 +1,12 @@
use crate::{
Result,
structs::release::{CreateReleaseOption, Release},
structs::{
release::{CreateReleaseOption, Release},
},
};
pub fn get_release(_id: u64) -> Result<Release> {
pub fn get_release(id: u64) -> Result<Release> {
todo!();
}
pub fn get_latest_release() -> Result<Release> {
@@ -17,7 +20,7 @@ pub async fn list_releases(
) -> Result<Vec<Release>> {
let request_url = format!("{gitea_url}/api/v1/repos/{repo}/releases/");
let req = client.get(request_url).send().await;
let response = req.map_err(crate::Error::WrappedReqwestErr)?;
let response = req.map_err(|reqwest_err| crate::Error::WrappedReqwestErr(reqwest_err))?;
if response.status().is_success() {
let release_list = response
.json::<Vec<Release>>()
@@ -47,22 +50,22 @@ pub async fn create_release(
.json(&submission)
.send()
.await
.map_err(crate::Error::from)?;
.map_err(|e| crate::Error::from(e))?;
if response.status().is_success() {
let new_release = response
.json::<Release>()
.await
.map_err(crate::Error::from)?;
.map_err(|e| crate::Error::from(e))?;
return Ok(new_release);
} else if response.status().is_client_error() {
let mesg = crate::decode_client_error(response).await?;
return Err(crate::Error::ApiErrorMessage(mesg));
return Err(crate::Error::ApiErrorMessage(mesg))
}
panic!("Reached end of create_release without matching a return path");
}
pub fn edit_release(_id: u64) -> Result<Release> {
pub fn edit_release(id: u64) -> Result<Release> {
todo!();
}
pub fn delete_release(_id: u64) -> Result<()> {
pub fn delete_release(id: u64) -> Result<()> {
todo!();
}

View File

@@ -22,10 +22,8 @@ pub async fn create_release_attachment(
Ok(false) => return Err(crate::Error::NoSuchFile),
Err(e) => {
eprintln!("Uh oh! The file-exists check couldn't be done: {e}");
panic!(
"TODO: Deal with scenario where the file's existence cannot be checked (e.g.: no permission)"
);
}
panic!("TODO: Deal with scenario where the file's existence cannot be checked (e.g.: no permission)");
},
}
println!("Uploading file {}", &file);
@@ -46,7 +44,7 @@ pub async fn create_release_attachment(
let attachment_desc = response
.json::<Attachment>()
.await
.map_err(crate::Error::from)?;
.map_err(|e| crate::Error::from(e))?;
return Ok(attachment_desc);
} else if response.status().is_client_error() {
let mesg = crate::decode_client_error(response).await?;

View File

@@ -1,209 +0,0 @@
use toml::{Value, value::Table};
pub type Result<T> = core::result::Result<T, Error>;
#[derive(Debug)]
#[cfg_attr(test, derive(PartialEq))]
pub enum Error {
BadFormat,
NoSuchProperty,
NoSuchTable,
TomlWrap(toml::de::Error),
}
impl From<toml::de::Error> for Error {
fn from(value: toml::de::Error) -> Self {
Error::TomlWrap(value)
}
}
impl core::fmt::Display for Error{
fn fmt(&self, fmt: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
// FIXME: Print a nice output, don't just reuse the Debug impl
write!(fmt, "{self:?}")
}
}
impl std::error::Error for Error {}
#[derive(Debug, Default)]
#[cfg_attr(test, derive(PartialEq))]
struct PartialConfig {
project_path: Option<String>,
gitea_url: Option<String>,
owner: Option<String>,
repo: Option<String>,
token: Option<String>,
}
#[derive(Debug, Default)]
#[cfg_attr(test, derive(PartialEq))]
struct WholeFile {
all: PartialConfig,
project_overrides: Vec<PartialConfig>,
}
fn lconf(text: &str) -> Result<WholeFile> {
let mut whole = WholeFile::default();
let toml_val = text.parse::<Value>()?;
// The config file is one big table. If the string we decoded is
// some other toml::Value variant, it's not correct.
// Try getting it as a table, return Err(BadFormat) otherwise.
let cfg_table = toml_val.as_table().ok_or(Error::BadFormat)?;
// Get the global config out of the file
if let Some(section_all) = cfg_table.get("all") {
if let Some(table_all) = section_all.as_table() {
whole.all.gitea_url = get_maybe_property(&table_all, "gitea_url")?.cloned();
whole.all.owner = get_maybe_property(&table_all, "owner")?.cloned();
whole.all.repo = get_maybe_property(&table_all, "repo")?.cloned();
whole.all.token = get_maybe_property(&table_all, "token")?.cloned();
}
}
Ok(whole)
}
/// The outer value must be a Table so we can get the sub-table from it.
fn get_table<'outer>(outer: &'outer Table, table_name: impl ToString) -> Result<&'outer Table> {
Ok(outer
.get(&table_name.to_string())
.ok_or(Error::NoSuchTable)?
.as_table()
.ok_or(Error::BadFormat)?)
}
/// Similar to `get_property()` but maps the "Error::NoSuchProperty" result to
/// Option::None. Some properties aren't specified, and that's okay... sometimes.
fn get_maybe_property<'outer> (outer: &'outer Table, property: impl ToString) -> Result<Option<&'outer String>> {
let maybe_prop = get_property(outer, property);
match maybe_prop {
Ok(value) => Ok(Some(value)),
Err(e) => {
if let Error::NoSuchProperty = e {
return Ok(None);
} else {
return Err(e);
}
}
}
}
/// The config properties are individual strings. This gets the named property,
/// or an error explaining why it couldn't be fetched.
fn get_property<'outer>(outer: &'outer Table, property: impl ToString) -> Result<&'outer String> {
let maybe_prop = outer.get(&property.to_string()).ok_or(Error::NoSuchProperty)?;
if let Value::String(text) = maybe_prop {
Ok(text)
} else {
Err(Error::BadFormat)
}
}
#[cfg(test)]
mod tests {
use toml::map::Map;
use super::*;
#[test]
fn read_single_prop() -> Result<()> {
let fx_input_str = "owner = \"dingus\"";
let fx_value = fx_input_str.parse::<Value>()?;
let fx_value = fx_value.as_table().ok_or(Error::NoSuchTable)?;
let expected = "dingus";
let res = get_property(&fx_value, String::from("owner"))?;
assert_eq!(res, expected);
Ok(())
}
// The property is given the value of empty-string `""`
#[test]
fn read_single_prop_empty_quotes() -> Result<()> {
let fx_input_str = "owner = \"\"";
let fx_value = fx_input_str.parse::<Value>()?;
let fx_value = fx_value.as_table().ok_or(Error::NoSuchTable)?;
let expected = "";
let res = get_property(&fx_value, String::from("owner"))?;
assert_eq!(res, expected);
Ok(())
}
#[test]
fn read_table() -> Result<()> {
let fx_input_str = "[tab]\nwith_a_garbage = \"value\"";
let fx_value = fx_input_str.parse::<Value>()?;
let fx_value = fx_value.as_table().ok_or(Error::BadFormat)?;
let mut expected: Map<String, Value> = Map::new();
expected.insert(String::from("with_a_garbage"), Value::String(String::from("value")));
let res = get_table(&fx_value, String::from("tab"))?;
assert_eq!(res, &expected);
Ok(())
}
#[test]
fn read_config_string_ok() -> Result<()> {
let fx_sample_config_string = "
[all]
gitea_url = \"http://localhost:3000\"
token = \"fake-token\"
[\"/home/robert/projects/gt-tool\"]
owner = \"robert\"
repo = \"gt-tool\"
[\"/home/robert/projects/rcalc\"]
owner = \"jamis\"
repo = \"rcalc\"
[\"/home/robert/projects/rcalc-builders\"]
owner = \"jamis\"
repo = \"rcalc\"
";
let fx_expected_struct = WholeFile {
all: PartialConfig {
project_path: None,
gitea_url: Some(String::from("http://localhost:3000")),
owner: None,
repo: None,
token: Some(String::from("fake-token"))
},
project_overrides: vec![
PartialConfig {
project_path: Some(String::from("/home/robert/projects/gt-tool")),
gitea_url: None,
owner: Some(String::from("robert")),
repo: Some(String::from("gt-tool")),
token: None,
},
PartialConfig {
project_path: Some(String::from("/home/robert/projects/rcalc")),
gitea_url: None,
owner: Some(String::from("jamis")),
repo: Some(String::from("rcalc")),
token: None,
},
PartialConfig {
project_path: Some(String::from("/home/robert/projects/rcalc-builders")),
gitea_url: None,
owner: Some(String::from("jamis")),
repo: Some(String::from("rcalc")),
token: None,
},
],
};
let conf = lconf(fx_sample_config_string)?;
println!(" ->> Test conf: {:?}", conf);
println!(" ->> Ref conf: {:?}", fx_expected_struct);
assert_eq!(conf, fx_expected_struct);
Ok(())
}
}

View File

@@ -2,7 +2,6 @@ use serde::{Deserialize, Serialize};
pub mod api;
pub mod cli;
pub mod config;
pub mod structs;
#[derive(Debug, Deserialize, Serialize)]
@@ -15,7 +14,9 @@ pub(crate) async fn decode_client_error(response: reqwest::Response) -> Result<A
response
.json::<ApiError>()
.await
.map_err(crate::Error::WrappedReqwestErr)
.map_err(|reqwest_err| {
crate::Error::WrappedReqwestErr(reqwest_err)
})
}
#[derive(Debug)]

View File

@@ -1,3 +1,4 @@
use std::path;
use gt_tool::cli::Args;
@@ -21,7 +22,10 @@ async fn main() -> Result<(), gt_tool::Error> {
headers.append("Authorization", token.parse().unwrap());
}
let client = reqwest::Client::builder()
.user_agent(format!("gt-tools-agent-{}", env!("CARGO_PKG_VERSION")))
.user_agent(format!(
"gt-tools-agent-{}",
env!("CARGO_PKG_VERSION")
))
.default_headers(headers)
.build()?;
@@ -29,15 +33,9 @@ async fn main() -> Result<(), gt_tool::Error> {
gt_tool::cli::Commands::ListReleases => {
let releases =
gt_tool::api::release::list_releases(&client, &args.gitea_url, &args.repo).await?;
// Print in reverse order so the newest items are closest to the
// user's command prompt. Otherwise the newest item scrolls off the
// screen and can't be seen.
itertools::Itertools::intersperse(
releases.iter().rev().map(|release| release.colorized()),
String::from(""),
)
.map(|release| println!("{}", release))
.fold((), |_, _| ());
for release in releases {
println!("{:?}", release);
}
}
gt_tool::cli::Commands::CreateRelease {
name,
@@ -54,7 +52,12 @@ async fn main() -> Result<(), gt_tool::Error> {
tag_name,
target_commitish,
};
gt_tool::api::release::create_release(&client, &args.gitea_url, &args.repo, submission)
gt_tool::api::release::create_release(
&client,
&args.gitea_url,
&args.repo,
submission,
)
.await?;
}
gt_tool::cli::Commands::UploadRelease {
@@ -85,10 +88,8 @@ async fn main() -> Result<(), gt_tool::Error> {
Ok(false) => return Err(gt_tool::Error::NoSuchFile),
Err(e) => {
eprintln!("Uh oh! The file-exists check couldn't be done: {e}");
panic!(
"TODO: Deal with scenario where the file's existence cannot be checked (e.g.: no permission)"
);
}
panic!("TODO: Deal with scenario where the file's existence cannot be checked (e.g.: no permission)");
},
}
}
for file in files {
@@ -142,5 +143,5 @@ fn match_release_by_tag(tag: &String, releases: Vec<Release>) -> Option<Release>
}
}
}
release
return release;
}

View File

@@ -1,4 +1,3 @@
use colored::Colorize;
use serde::{Deserialize, Serialize};
#[derive(Debug, Deserialize, Serialize)]
@@ -20,36 +19,6 @@ pub struct Release {
author: Author,
}
impl Release {
pub fn colorized(&self) -> String {
let tag = "Tag:".green().bold();
let name = "Name:".green();
let published = "Published:".bright_green();
let created = "Created:".green().dimmed();
let author = "Author:".blue();
let body = if !self.body.is_empty() {
&self.body.white()
} else {
&String::from("(empty body)").dimmed()
};
format!(
"{tag} {}
{name} {}
{}
{published} {} ({created} {})
{author} {} ({})",
self.tag_name.bold(),
self.name,
body,
self.published_at,
self.created_at.dimmed(),
self.author.login,
self.author.email,
)
}
}
#[derive(Debug, Deserialize, Serialize)]
pub struct Author {
id: usize,