Compare commits
14 Commits
06795df3f7
...
debian/2.1
| Author | SHA1 | Date | |
|---|---|---|---|
| bbae6b4395 | |||
| 2c03c5ba4d | |||
| 136c051c82 | |||
| 6a9ec25d1a | |||
| 395ce8a804 | |||
| 616be020f0 | |||
| a0ba8e7ea8 | |||
| 324c7e67a7 | |||
| 984974c240 | |||
| 88cafc096f | |||
| b200785e71 | |||
| 8246337ae4 | |||
| 4c05749d02 | |||
| c0e6c5d89d |
11
README.md
11
README.md
@@ -51,14 +51,3 @@ One of these, defaults to `help`:
|
||||
| upload-release | Uploads one-or-more files to an existing release, identified by it's tag name. |
|
||||
| help | prints the help text (the usage summary above). |
|
||||
|
||||
## Unit Testing
|
||||
|
||||
The unit test~~s~~ require a Gitea server to execute against. This information is supplied by environment variables rather than on the command line, but it is otherwise exactly the same usage.
|
||||
|
||||
| Variable | Description |
|
||||
|-|-|
|
||||
| TEST_GITEA_SERVER | Server URL, match `-u`, `--url` |
|
||||
| TEST_GITEA_REPO | Owner + repo name, match `-u` `--repo` |
|
||||
| TEST_GITEA_KEY | API key, match `RELEASE_KEY_GITEA`. The use of a new variable for the API token is to help avoid accidentally touching a production environment during test execution. |
|
||||
| TEST_GITEA_RELEASE_TAG | Git tag used to identify the Release. Same as `upload-release`'s positional argument `<TAG_NAME>`. |
|
||||
|
||||
|
||||
29
debian/changelog
vendored
Normal file
29
debian/changelog
vendored
Normal file
@@ -0,0 +1,29 @@
|
||||
gt-tool (2.1.0-1) unstable; urgency=medium
|
||||
|
||||
* Fix: incorrect field names for `Attachment`
|
||||
|
||||
-- Robert Garrett <robertgarrett404@gmail.com> Thu, 12 Jun 2025 17:51:12 -0500
|
||||
|
||||
gt-tool (2.0.0-1) unstable; urgency=medium
|
||||
|
||||
* Interrogate list_releases result more closely
|
||||
* Interrogate create_release result more closely
|
||||
* Drop unused imports
|
||||
* "Fix" the test case
|
||||
* Interrogate create_release_attachment result
|
||||
* Fold client-error-decode into a util function
|
||||
* Add `Attachment` struct, new iface for create-rel
|
||||
* Update main.rs to use new attachment iface
|
||||
* Delete the unit tests
|
||||
* ... and the unit testing notes in README.md
|
||||
* Drop unused import in api/release.rs
|
||||
* Use pre Rust 1.81 compatible file-exists test
|
||||
* Rediff patches
|
||||
|
||||
-- Robert Garrett <robertgarrett404@gmail.com> Thu, 12 Jun 2025 16:28:18 -0500
|
||||
|
||||
gt-tool (1.0.0-1) unstable; urgency=low
|
||||
|
||||
* Experimental release.
|
||||
|
||||
-- Robert Garrett <robertgarrett404@gmail.com> Sun, 1 Jun 2025 16:05:00 -0500
|
||||
30
debian/control
vendored
Normal file
30
debian/control
vendored
Normal file
@@ -0,0 +1,30 @@
|
||||
Source: gt-tool
|
||||
Maintainer: Robert Garrett <robertgarrett404@gmail.com>
|
||||
Section: misc
|
||||
Priority: optional
|
||||
Standards-Version: 4.6.2
|
||||
Build-Depends:
|
||||
debhelper-compat (= 13),
|
||||
dh-cargo,
|
||||
librust-clap-dev,
|
||||
librust-reqwest-dev,
|
||||
librust-tokio-dev,
|
||||
librust-serde-dev,
|
||||
Homepage: https://git.gelvin.dev/robert/gt-tool
|
||||
Vcs-Git: https://git.gelvin.dev/robert/gt-tool
|
||||
Vcs-Browser: https://git.gelvin.dev/robert/gt-tool
|
||||
Rules-Requires-Root: no
|
||||
|
||||
Package: gt-tool
|
||||
Architecture: any
|
||||
Depends:
|
||||
${misc:Depends},
|
||||
${shlibs:Depends},
|
||||
Description: CLI tools for interacting with the Gitea API.
|
||||
Use interactively to talk to your Gitea instance, or automatically via a CI/CD
|
||||
pipeline. Currently supports:
|
||||
.
|
||||
- showing the Releases for a project
|
||||
- creating a new Release for a project
|
||||
- attaching files to a release
|
||||
|
||||
43
debian/copyright
vendored
Normal file
43
debian/copyright
vendored
Normal file
@@ -0,0 +1,43 @@
|
||||
Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
|
||||
Upstream-Name: gt-tools
|
||||
Upstream-Contact: Robert Garrett <robertgarrett404@gmail.com>
|
||||
Source: https://source.mnt.re/reform/mnt-reform-setup-wizard
|
||||
|
||||
Files: *
|
||||
Copyright: 2025 Robert Garrett <robertgarrett404@gmail.com>
|
||||
License: GPL-3+
|
||||
|
||||
Files: debian/*
|
||||
Copyright: 2025 Robert Garrett <robertgarrett404@gmail.com>
|
||||
License: GPL-3+
|
||||
|
||||
Files: debian/rules
|
||||
Copyright:
|
||||
Johannes Schauer Marin Rodrigues <josch@debian.org>
|
||||
2025 Robert Garrett <robertgarrett404@gmail.com>
|
||||
License: GPL-3+
|
||||
Comment:
|
||||
The debian/rules file is liften directly from the tuigreet package. It was
|
||||
linked in the Debian Rust Team Book as a pretty simple example package. The
|
||||
only change I've made is to remove the documentation generation target.
|
||||
.
|
||||
https://salsa.debian.org/debian/tuigreet/-/blob/master/debian/rules?ref_type=heads
|
||||
|
||||
|
||||
License: GPL-3+
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
.
|
||||
It is distributed in the hope that it will be useful, but WITHOUT
|
||||
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
|
||||
or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public
|
||||
License for more details.
|
||||
.
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with it. If not, see <http://www.gnu.org/licenses/>.
|
||||
.
|
||||
On Debian systems, the full text of the GNU General Public License version 3
|
||||
can be found in the file /usr/share/common-licenses/GPL-3.
|
||||
|
||||
6
debian/gbp.conf
vendored
Normal file
6
debian/gbp.conf
vendored
Normal file
@@ -0,0 +1,6 @@
|
||||
[DEFAULT]
|
||||
compression = xz
|
||||
compression-level = 9
|
||||
upstream-tag = v%(version)s
|
||||
debian-branch = deb/bookworm
|
||||
|
||||
23
debian/patches/0001-Rust-edition-downgrade-to-2021.patch
vendored
Normal file
23
debian/patches/0001-Rust-edition-downgrade-to-2021.patch
vendored
Normal file
@@ -0,0 +1,23 @@
|
||||
From: Robert Garrett <robertgarrett404@gmail.com>
|
||||
Date: Sun, 1 Jun 2025 17:59:20 -0500
|
||||
Subject: Rust edition downgrade to 2021
|
||||
|
||||
Debian Bookworm uses Rust 1.64 which only supports up to the 2021
|
||||
edition.
|
||||
---
|
||||
Cargo.toml | 2 +-
|
||||
1 file changed, 1 insertion(+), 1 deletion(-)
|
||||
|
||||
diff --git a/Cargo.toml b/Cargo.toml
|
||||
index febccc4..cf52754 100644
|
||||
--- a/Cargo.toml
|
||||
+++ b/Cargo.toml
|
||||
@@ -1,7 +1,7 @@
|
||||
[package]
|
||||
name = "gt-tool"
|
||||
version = "1.0.0"
|
||||
-edition = "2024"
|
||||
+edition = "2021"
|
||||
|
||||
[dependencies]
|
||||
clap = { version = "4.0.7", features = ["derive", "env"] }
|
||||
1
debian/patches/series
vendored
Normal file
1
debian/patches/series
vendored
Normal file
@@ -0,0 +1 @@
|
||||
0001-Rust-edition-downgrade-to-2021.patch
|
||||
26
debian/rules
vendored
Executable file
26
debian/rules
vendored
Executable file
@@ -0,0 +1,26 @@
|
||||
#!/usr/bin/make -f
|
||||
|
||||
export DEB_BUILD_MAINT_OPTIONS = hardening=+all
|
||||
DPKG_EXPORT_BUILDFLAGS = 1
|
||||
include /usr/share/dpkg/default.mk
|
||||
include /usr/share/rustc/architecture.mk
|
||||
export DEB_HOST_RUST_TYPE
|
||||
export PATH:=/usr/share/cargo/bin:$(PATH)
|
||||
export CARGO=/usr/share/cargo/bin/cargo
|
||||
export CARGO_HOME=$(CURDIR)/debian/cargo_home
|
||||
export CARGO_REGISTRY=$(CURDIR)/debian/cargo_registry
|
||||
export DEB_CARGO_CRATE=$(DEB_SOURCE)_$(DEB_VERSION_UPSTREAM)
|
||||
|
||||
%:
|
||||
dh $@ --buildsystem=cargo
|
||||
|
||||
execute_after_dh_auto_clean:
|
||||
$(CARGO) clean
|
||||
rm -rf $(CARGO_HOME)
|
||||
rm -rf $(CARGO_REGISTRY)
|
||||
rm -f debian/cargo-checksum.json
|
||||
|
||||
execute_before_dh_auto_configure:
|
||||
$(CARGO) prepare-debian $(CARGO_REGISTRY) --link-from-system
|
||||
rm -f Cargo.lock
|
||||
touch debian/cargo-checksum.json
|
||||
1
debian/source/format
vendored
Normal file
1
debian/source/format
vendored
Normal file
@@ -0,0 +1 @@
|
||||
3.0 (quilt)
|
||||
@@ -1,6 +1,6 @@
|
||||
|
||||
use crate::{
|
||||
ApiError, Result,
|
||||
Result,
|
||||
structs::{
|
||||
release::{CreateReleaseOption, Release},
|
||||
},
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
use std::fs;
|
||||
use std::{fs, path};
|
||||
|
||||
use crate::structs::Attachment;
|
||||
|
||||
@@ -16,7 +16,8 @@ pub async fn create_release_attachment(
|
||||
) -> crate::Result<Attachment> {
|
||||
let request_url = format!("{gitea_url}/api/v1/repos/{repo}/releases/{release_id}/assets");
|
||||
|
||||
match fs::exists(&file) {
|
||||
let path = path::Path::new(&file);
|
||||
match path.try_exists() {
|
||||
Ok(true) => (),
|
||||
Ok(false) => return Err(crate::Error::NoSuchFile),
|
||||
Err(e) => {
|
||||
@@ -53,140 +54,3 @@ pub async fn create_release_attachment(
|
||||
}
|
||||
pub fn edit_release_attachment() {}
|
||||
pub fn delete_release_attachment() {}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use reqwest::header::{self, ACCEPT};
|
||||
|
||||
use crate::structs::release::Release;
|
||||
|
||||
|
||||
#[tokio::test]
|
||||
async fn attach_file_exists() {
|
||||
let conf = TestConfig::new();
|
||||
let release_candidates =
|
||||
crate::api::release::list_releases(
|
||||
&conf.client,
|
||||
&conf.server,
|
||||
&conf.repo
|
||||
)
|
||||
.await
|
||||
.expect("Failed to get releases. Pre-conditions unmet, aborting test!");
|
||||
|
||||
let release = match_release_by_tag(&conf.release_tag, release_candidates)
|
||||
.expect("Failed to select matching release. Pre-conditions unmet, aborting test!");
|
||||
|
||||
let api_result = super::create_release_attachment(
|
||||
&conf.client,
|
||||
&conf.server,
|
||||
&conf.repo,
|
||||
release.id,
|
||||
vec![String::from("Cargo.toml")],
|
||||
)
|
||||
.await;
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn attach_file_missing() {
|
||||
let conf = TestConfig::new();
|
||||
let release_candidates =
|
||||
crate::api::release::list_releases(
|
||||
&conf.client,
|
||||
&conf.server,
|
||||
&conf.repo
|
||||
)
|
||||
.await
|
||||
.expect("Failed to get releases. Pre-conditions unmet, aborting test!");
|
||||
|
||||
let release = match_release_by_tag(&conf.release_tag, release_candidates)
|
||||
.expect("Failed to select matching release. Pre-conditions unmet, aborting test!");
|
||||
|
||||
let api_result = super::create_release_attachment(
|
||||
&conf.client,
|
||||
&conf.server,
|
||||
&conf.repo,
|
||||
release.id,
|
||||
vec![String::from("./this-file-doesnt-exist")],
|
||||
)
|
||||
.await;
|
||||
let api_err = api_result.expect_err("Received Ok(()) after uploading non-existent file. That's nonsense, the API Function is wrong.");
|
||||
match api_err {
|
||||
crate::Error::Placeholder=>panic!("Received dummy response from the API function. Finish implementing it, stupid"),
|
||||
crate::Error::WrappedReqwestErr(error)=>panic!("Received a reqwest::Error from the API function: {error}"),
|
||||
crate::Error::MissingAuthToken=>unreachable!("Missing auth token... in a unit test that already panics without the auth token..."),
|
||||
crate::Error::NoSuchFile=>(),
|
||||
crate::Error::ApiErrorMessage(api_error)=>panic!("Received an error message from the API: {api_error:?}"),
|
||||
crate::Error::NoSuchRelease => todo!(),
|
||||
}
|
||||
}
|
||||
|
||||
struct TestConfig {
|
||||
server: String,
|
||||
repo: String,
|
||||
release_tag: String,
|
||||
client: reqwest::Client,
|
||||
}
|
||||
|
||||
impl TestConfig {
|
||||
fn new() -> Self {
|
||||
let server = std::env::var("TEST_GITEA_SERVER")
|
||||
.expect("Must set server address in env var \"TEST_GITEA_SERVER\"");
|
||||
let repo = std::env::var("TEST_GITEA_REPO")
|
||||
.expect("Must set <user>/<repo> name in env var \"TEST_GITEA_REPO\"");
|
||||
let token = format!(
|
||||
"token {}",
|
||||
std::env::var("TEST_GITEA_KEY")
|
||||
.expect("Must set the API token in env var \"TEST_GITEA_KEY\"")
|
||||
);
|
||||
let release_tag = std::env::var("TEST_GITEA_RELEASE_TAG")
|
||||
.expect("Must set the target release tag in env var \"TEST_GITEA_RELEASE_TAG\"");
|
||||
|
||||
let mut headers = reqwest::header::HeaderMap::new();
|
||||
headers.append(ACCEPT, header::HeaderValue::from_static("application/json"));
|
||||
headers.append("Authorization", token.parse().unwrap());
|
||||
|
||||
let client = reqwest::Client::builder()
|
||||
.user_agent(format!(
|
||||
"gt-tools-autotest-agent{}",
|
||||
env!("CARGO_PKG_VERSION")
|
||||
))
|
||||
.default_headers(headers)
|
||||
.build()
|
||||
.expect("Failed to build reqwest::Client.");
|
||||
|
||||
return Self {
|
||||
server,
|
||||
repo,
|
||||
release_tag,
|
||||
client
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
// Testing utils
|
||||
fn match_release_by_tag(tag: &String, releases: Vec<Release>) -> Option<Release> {
|
||||
let mut release: Option<Release> = None;
|
||||
for rel in releases {
|
||||
if rel.tag_name == *tag {
|
||||
// Only store the value if one hasn't been stored already
|
||||
if let Some(first_release) = &release {
|
||||
// if there was already a match, begin the error diagnostic creation.
|
||||
let first_id = first_release.id;
|
||||
let second_id = rel.id;
|
||||
assert!(
|
||||
first_id != second_id,
|
||||
"FAILURE: Found the same release ID twice while scanning for duplicate tags. How did we get the same one twice?"
|
||||
);
|
||||
eprintln!("ERROR: Two releases have been found for the tag \"{tag}\".");
|
||||
eprintln!("ERROR: first ID: {first_id}");
|
||||
eprintln!("ERROR: second ID: {second_id}");
|
||||
panic!("ERROR: Nonsense detected, I'm bailing out!");
|
||||
} else {
|
||||
// else, store our first (and hopefully only) match
|
||||
release = Some(rel);
|
||||
}
|
||||
}
|
||||
}
|
||||
return release;
|
||||
}
|
||||
}
|
||||
@@ -1,4 +1,5 @@
|
||||
use std::fs;
|
||||
|
||||
use std::path;
|
||||
|
||||
use gt_tool::cli::Args;
|
||||
use gt_tool::structs::release::{CreateReleaseOption, Release};
|
||||
@@ -81,7 +82,8 @@ async fn main() -> Result<(), gt_tool::Error> {
|
||||
|
||||
if let Some(release) = match_release_by_tag(&tag_name, release_candidates) {
|
||||
for file in &files {
|
||||
match fs::exists(file) {
|
||||
let path = path::Path::new(&file);
|
||||
match path.try_exists() {
|
||||
Ok(true) => continue,
|
||||
Ok(false) => return Err(gt_tool::Error::NoSuchFile),
|
||||
Err(e) => {
|
||||
|
||||
@@ -9,7 +9,7 @@ pub struct Attachment {
|
||||
name: String,
|
||||
size: i64,
|
||||
download_count: i64,
|
||||
created: String, // TODO: Date-time struct
|
||||
created_at: String, // TODO: Date-time struct
|
||||
uuid: String,
|
||||
download_url: String,
|
||||
browser_download_url: String,
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user