Version 0.5.0: Many improvements #8

Merged
cadey merged 5 commits from refactor-git-mod into main 2020-07-09 19:25:58 +00:00
13 changed files with 354 additions and 56 deletions

View File

@ -6,6 +6,26 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## Unreleased
## 0.5.0
A lot of internals to this program were exposed to external consumers. This was
used to provide an integration test.
Support for bracketed versions was added, a-la:
```markdown
## [0.1.0]
Hi there this is a test!
### ADDED
- something
```
The gitea crate was brought up to version `0.2.0` and includes a lot more
functionality.
## 0.4.0
This is a functionality-breaking release that removes untested/extraneous parts

62
Cargo.lock generated
View File

@ -198,6 +198,19 @@ version = "1.0.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "b5320ae4c3782150d900b79807611a59a99fc9a1d61d686faafc24b93fc8d7ca"
[[package]]
name = "env_logger"
version = "0.7.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "44533bbbb3bb3c1fa17d9f2e4e38bbbaf8396ba82193c4cb1b6445d711445d36"
dependencies = [
"atty",
"humantime",
"log",
"regex",
"termcolor",
]
[[package]]
name = "fake-simd"
version = "0.1.2"
@ -323,7 +336,7 @@ dependencies = [
[[package]]
name = "gitea"
version = "0.1.0"
version = "0.2.0"
dependencies = [
"anyhow",
"reqwest",
@ -335,7 +348,7 @@ dependencies = [
[[package]]
name = "gitea-release"
version = "0.3.2"
version = "0.5.0"
dependencies = [
"anyhow",
"comrak",
@ -344,6 +357,8 @@ dependencies = [
"gitea",
"http",
"kankyo",
"log",
"pretty_env_logger",
"reqwest",
"serde",
"serde_json",
@ -417,6 +432,15 @@ version = "1.3.4"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "cd179ae861f0c2e53da70d892f5f3029f9594be0c41dc5269cd371691b1dc2f9"
[[package]]
name = "humantime"
version = "1.3.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "df004cfca50ef23c36850aaaa59ad52cc70d0e90243c3c7737a4dd32dc7a3c4f"
dependencies = [
"quick-error",
]
[[package]]
name = "hyper"
version = "0.13.6"
@ -819,6 +843,16 @@ version = "0.2.8"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "237a5ed80e274dbc66f86bd59c1e25edc039660be53194b5fe0a482e0f2612ea"
[[package]]
name = "pretty_env_logger"
version = "0.4.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "926d36b9553851b8b0005f1275891b392ee4d2d833852c417ed025477350fb9d"
dependencies = [
"env_logger",
"log",
]
[[package]]
name = "proc-macro-error"
version = "1.0.2"
@ -854,6 +888,12 @@ dependencies = [
"unicode-xid",
]
[[package]]
name = "quick-error"
version = "1.2.3"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "a1d01941d82fa2ab50be1e79e6714289dd7cde78eba4c074bc5a4374f650dfe0"
[[package]]
name = "quote"
version = "1.0.6"
@ -1203,6 +1243,15 @@ dependencies = [
"winapi 0.3.8",
]
[[package]]
name = "termcolor"
version = "1.1.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "bb6bfa289a4d7c5766392812c0a1f4c1ba45afa1ad47803c11e1f407d846d75f"
dependencies = [
"winapi-util",
]
[[package]]
name = "textwrap"
version = "0.11.0"
@ -1552,6 +1601,15 @@ version = "0.4.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "ac3b87c63620426dd9b991e5ce0329eff545bccbbb34f3be09ff6fb6ab51b7b6"
[[package]]
name = "winapi-util"
version = "0.1.5"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "70ec6ce85bb158151cae5e5c87f95a8e97d2c0c4b001223f33a334e3ce5de178"
dependencies = [
"winapi 0.3.8",
]
[[package]]
name = "winapi-x86_64-pc-windows-gnu"
version = "0.4.0"

View File

@ -1,6 +1,6 @@
[package]
name = "gitea-release"
version = "0.3.2"
version = "0.5.0"
authors = ["Christine Dodrill <me@christine.website>"]
edition = "2018"
@ -12,6 +12,7 @@ comrak = "0.7"
git2 = "0.13"
http = "0.2"
kankyo = "0.3"
log = "0.4"
reqwest = { version = "0.10", features = ["json"] }
serde_json = "1.0"
serde = { version = "1.0", features = ["derive"] }
@ -24,6 +25,7 @@ gitea = { path = "./gitea" }
[dev-dependencies]
tempfile = "3"
elfs = { path = "./elfs" }
pretty_env_logger = "0.4"
[profile.release]
lto = true

View File

@ -1 +1 @@
0.4.0
0.5.0

View File

@ -1,6 +1,6 @@
[package]
name = "gitea"
version = "0.1.0"
version = "0.2.0"
authors = ["Christine Dodrill <me@christine.website>"]
edition = "2018"
homepage = "https://tulpa.dev/cadey/gitea-release/src/branch/main/gitea"

View File

@ -1,5 +1,4 @@
/// The main Gitea client. You will need an API token as described [here](https://docs.gitea.io/en-us/api-usage/).
use reqwest::header;
use serde::{Deserialize, Serialize};
use std::result::Result as StdResult;
@ -70,6 +69,20 @@ pub struct Attachment {
pub browser_download_url: String,
}
/// Inputs to create a gitea repo.
/// https://try.gitea.io/api/swagger#model-CreateRepoOption
#[derive(Default, Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct CreateRepo {
pub auto_init: bool,
pub description: String,
pub gitignores: String,
pub issue_labels: String,
pub license: String,
pub name: String,
pub private: bool,
pub readme: String,
}
/// A git repository.
/// https://try.gitea.io/api/swagger#model-Repository
#[derive(Default, Debug, Clone, PartialEq, Serialize, Deserialize)]
@ -234,6 +247,46 @@ impl Client {
}
}
/// Creates a new gitea repo for the currently authenticated user with given details.
pub async fn create_user_repo(&self, cr: CreateRepo) -> Result<Repo> {
Ok(self
.cli
.post(&format!("{}/api/v1/user/repos", self.base_url))
.json(&cr)
.send()
.await?
.error_for_status()?
.json()
.await?)
}
/// Creates a new gitea repo for a given organization with given details.
pub async fn create_org_repo(&self, org: String, cr: CreateRepo) -> Result<Repo> {
Ok(self
.cli
.post(&format!("{}/api/v1/org/{}/repos", self.base_url, org))
.json(&cr)
.send()
.await?
.error_for_status()?
.json()
.await?)
}
/// Deletes a gitea repo by owner and name.
pub async fn delete_repo(&self, owner: String, repo: String) -> Result<()> {
self.cli
.delete(&format!(
"{}/api/v1/repos/{}/{}",
self.base_url, owner, repo
))
.send()
.await?
.error_for_status()?;
Ok(())
}
/// Gets a gitea repo by name.
///
/// ```rust
@ -357,4 +410,16 @@ impl Client {
Ok(())
}
/// Returns information about the currently authenticated user.
pub async fn whoami(&self) -> Result<User> {
Ok(self
.cli
.get(&format!("{}/api/v1/user", self.base_url))
.send()
.await?
.error_for_status()?
.json()
.await?)
}
}

View File

@ -2,7 +2,7 @@ use crate::{changelog, cmd::*, git, version};
use anyhow::Result;
use std::path::PathBuf;
pub(crate) async fn run(
pub async fn run(
common: Common,
fname: PathBuf,
tag: Option<String>,
@ -10,20 +10,15 @@ pub(crate) async fn run(
) -> Result<()> {
let repo = git2::Repository::open(".")?;
let tag = tag.unwrap_or(version::read_version("VERSION".into())?);
let desc = changelog::read(fname.clone(), tag.clone())?;
if !git::has_tag(&repo, tag.clone())? {
git::tag_version(&repo, tag.clone(), desc.clone())?;
let _ = git::push_tags(&repo);
} else
/* The tag already exists */
{
return Ok(());
if git::has_tag(&repo, tag.clone())? {
return Err(anyhow::anyhow!("what"));
}
let desc = changelog::read(fname, tag.clone())?;
let cli = gitea::Client::new(common.server, common.token, crate::APP_USER_AGENT)?;
let vtag = format!("v{}", tag);
let repo = cli.get_repo(common.owner.clone(), common.repo.clone()).await?;
let cr = gitea::CreateRelease {
body: desc,
@ -31,7 +26,7 @@ pub(crate) async fn run(
name: rm.name.or(Some(format!("Version {}", tag))).unwrap(),
prerelease: rm.pre_release,
tag_name: vtag,
target_commitish: "HEAD".into(),
target_commitish: repo.default_branch,
};
let _ = cli.create_release(common.owner, common.repo, cr).await?;

View File

@ -3,7 +3,7 @@ use anyhow::Result;
use git2::Repository;
use url::Url;
pub(crate) async fn run(env: DroneEnv) -> Result<()> {
pub async fn run(env: DroneEnv) -> Result<()> {
let common: Common = env.clone().into();
let default_branch = {

View File

@ -1,40 +1,55 @@
use std::path::PathBuf;
use structopt::StructOpt;
pub(crate) mod cut;
pub(crate) mod drone_plugin;
pub mod cut;
pub mod drone_plugin;
#[derive(StructOpt, Debug, Clone)]
pub(crate) struct Common {
pub struct Common {
/// The gitea server to connect to
#[structopt(short, long, env = "GITEA_SERVER")]
pub server: String,
/// The gitea token to authenticate with
#[structopt(long, env = "GITEA_TOKEN")]
pub token: String,
/// The gitea user to authenticate as
#[structopt(short, long, env = "GITEA_AUTH_USER")]
pub auth_user: String,
/// The owner of the gitea repo
#[structopt(short, long, env = "GITEA_OWNER")]
pub owner: String,
/// The gitea repo to operate on
#[structopt(short, long, env = "GITEA_REPO")]
pub repo: String,
/// Git signature email
#[structopt(long, short = "E", env = "SIGNATURE_EMAIL", default_value = "domo@tulpa.dev")]
pub email: String,
/// Git signature username
#[structopt(long, short = "U", env = "SIGNATURE_NAME", default_value = "Domo Arigato")]
pub username: String,
}
#[derive(StructOpt, Debug, Clone)]
pub(crate) struct DroneEnv {
pub struct DroneEnv {
// Given by drone
/// push URL
#[structopt(long, env = "DRONE_GIT_HTTP_URL")]
pub push_url: String,
/// repo owner
#[structopt(long, env = "DRONE_REPO_OWNER")]
pub owner: String,
/// repo name
#[structopt(long, env = "DRONE_REPO_NAME")]
pub repo: String,
/// branch
#[structopt(long, env = "DRONE_REPO_BRANCH")]
pub branch: String,
@ -43,18 +58,30 @@ pub(crate) struct DroneEnv {
/// auth username
#[structopt(long, env = "PLUGIN_AUTH_USERNAME")]
pub auth_user: String,
/// Gitea server
#[structopt(long, env = "PLUGIN_GITEA_SERVER")]
pub server: String,
/// Gitea token
#[structopt(long, env = "PLUGIN_GITEA_TOKEN")]
pub token: String,
/// CHANGELOG path
#[structopt(long, env = "PLUGIN_CHANGELOG_PATH", default_value = "./CHANGELOG.md")]
pub changelog_path: PathBuf,
/// Default branch name
#[structopt(long, env = "PLUGIN_DEFAULT_BRANCH")]
pub default_branch: Option<String>,
/// Git signature email
#[structopt(long, short = "E", env = "PLUGIN_SIGNATURE_EMAIL", default_value = "domo@tulpa.dev")]
pub email: String,
/// Git signature username
#[structopt(long, short = "U", env = "PLUGIN_SIGNATURE_NAME", default_value = "Domo Arigato")]
pub username: String,
}
impl Into<Common> for DroneEnv {
@ -65,12 +92,14 @@ impl Into<Common> for DroneEnv {
auth_user: self.auth_user,
owner: self.owner,
repo: self.repo,
email: self.email,
username: self.username,
}
}
}
#[derive(StructOpt, Debug)]
pub(crate) struct ReleaseMeta {
pub struct ReleaseMeta {
/// Release name
#[structopt(short, long)]
pub name: Option<String>,
@ -84,7 +113,7 @@ pub(crate) struct ReleaseMeta {
#[derive(StructOpt, Debug)]
#[structopt(about = "Gitea release assistant")]
pub(crate) enum Cmd {
pub enum Cmd {
/// Create a new tag and release on Gitea
#[structopt(alias = "release")]
Cut {

View File

@ -1,22 +1,67 @@
use anyhow::Result;
use git2::{Repository, Signature};
use git2::{
Cred, CredentialType, Direction, FetchOptions, PushOptions, RemoteCallbacks, Repository,
Signature,
};
use std::path::Path;
pub(crate) fn push_tags(repo: &Repository) -> Result<()> {
pub const TAGS: &'static [&'static str] = &["refs/tags/*:refs/tags/*"];
pub fn pull(repo: &Repository, token: String, what: &[&str]) -> Result<()> {
let mut remote = repo.find_remote("origin")?;
remote.connect(git2::Direction::Push)?;
remote.push(&["refs/tags/*:refs/tags/*"], None)?;
let mut fo = FetchOptions::new();
remote.connect_auth(Direction::Fetch, Some(callbacks(token.clone())), None)?;
fo.remote_callbacks(callbacks(token));
remote.fetch(what, Some(&mut fo), None)?;
Ok(())
}
pub(crate) fn tag_version(repo: &Repository, tag: String, desc: String) -> Result<()> {
let sig = &Signature::now("Gitea Release Tool", "gitea-release@tulpa.dev")?;
fn callbacks<'a>(token: String) -> RemoteCallbacks<'a> {
let mut callbacks = RemoteCallbacks::new();
callbacks.credentials(move |_u, _username, allowed_types| {
if allowed_types.contains(CredentialType::SSH_KEY) {
let user = "git";
Cred::ssh_key_from_agent(user)
} else {
Cred::userpass_plaintext(&token, "x-oauth-basic")
}
});
callbacks
}
pub fn push(repo: &Repository, token: String, what: &[&str]) -> Result<()> {
let mut remote = repo.find_remote("origin")?;
remote.connect_auth(Direction::Push, Some(callbacks(token.clone())), None)?;
let mut po = PushOptions::new();
po.remote_callbacks(callbacks(token));
remote.push(what, Some(&mut po))?;
Ok(())
}
pub fn commit(repo: &Repository, sig: &Signature, msg: &str, files: &[&str]) -> Result<()> {
let mut index = repo.index()?;
for file in files {
index.add_path(Path::new(file))?;
}
let oid = index.write_tree()?;
let tree = repo.find_tree(oid)?;
repo.commit(Some("HEAD"), &sig, &sig, &msg, &tree, &[])?;
Ok(())
}
pub fn tag_version(repo: &Repository, sig: &Signature, tag: String, desc: String) -> Result<()> {
let obj = repo.revparse_single("HEAD")?;
repo.tag(&tag, &obj, &sig, &desc, false)?;
Ok(())
}
pub(crate) fn has_tag(repo: &Repository, tag: String) -> Result<bool> {
pub fn has_tag(repo: &Repository, tag: String) -> Result<bool> {
let tags = repo.tag_names(Some(&tag))?;
for tag_obj in tags.iter() {
@ -25,6 +70,7 @@ pub(crate) fn has_tag(repo: &Repository, tag: String) -> Result<bool> {
}
let tag_name = tag_obj.unwrap();
log::debug!("tag: {}", tag_name.to_string());
if tag == tag_name.to_string() {
return Ok(true);
}
@ -37,7 +83,7 @@ pub(crate) fn has_tag(repo: &Repository, tag: String) -> Result<bool> {
mod tests {
use anyhow::Result;
use git2::*;
use std::{fs::File, io::Write, path::Path};
use std::{fs::File, io::Write};
use tempfile::tempdir;
#[test]
@ -48,22 +94,10 @@ mod tests {
let mut fout = File::create(&dir.path().join("VERSION"))?;
write!(fout, "{}", TAG)?;
drop(fout);
let mut index = repo.index()?;
index.add_path(Path::new("VERSION"))?;
let oid = index.write_tree()?;
let tree = repo.find_tree(oid)?;
let sig = &Signature::now("Gitea Release Tool", "gitea-release@tulpa.dev")?;
repo.commit(
Some("HEAD"),
&sig,
&sig,
"test commit please ignore",
&tree,
&[],
)?;
super::tag_version(&repo, TAG.into(), format!("version {}", TAG))?;
super::commit(&repo, &sig, "test commit please ignore", &["VERSION"])?;
super::tag_version(&repo, &sig, TAG.into(), format!("version {}", TAG))?;
assert!(super::has_tag(&repo, TAG.into())?);
Ok(())

8
src/lib.rs Normal file
View File

@ -0,0 +1,8 @@
pub mod changelog;
pub mod cmd;
pub mod git;
pub mod version;
// Name your user agent after your app?
pub static APP_USER_AGENT: &str =
concat!(env!("CARGO_PKG_NAME"), "/", env!("CARGO_PKG_VERSION"));

View File

@ -1,21 +1,12 @@
use anyhow::Result;
use structopt::StructOpt;
mod changelog;
mod cmd;
mod git;
mod version;
pub(crate) use cmd::*;
// Name your user agent after your app?
pub(crate) static APP_USER_AGENT: &str =
concat!(env!("CARGO_PKG_NAME"), "/", env!("CARGO_PKG_VERSION"));
use ::gitea_release::{cmd::{self, Cmd}};
#[tokio::main]
async fn main() -> Result<()> {
let _ = kankyo::init();
let cmd = cmd::Cmd::from_args();
let cmd = Cmd::from_args();
match cmd {
Cmd::Cut {

96
tests/cut.rs Normal file
View File

@ -0,0 +1,96 @@
use ::gitea_release::{cmd, git, APP_USER_AGENT};
use anyhow::Result;
use git2::{Repository, Signature};
use log::debug;
use std::{fs::File, io::Write};
const TAG: &'static str = "0.1.0";
#[tokio::test]
async fn cut() -> Result<()> {
let _ = pretty_env_logger::try_init();
let name = elfs::next();
let token = std::env::var("DOMO_GITEA_TOKEN")?;
let cli = gitea::Client::new("https://tulpa.dev".into(), token.clone(), APP_USER_AGENT)?;
debug!("created gitea client");
let gitea_repo = cli
.create_user_repo(gitea::CreateRepo {
auto_init: false,
description: format!("https://tulpa.dev/cadey/gitea-release test repo"),
gitignores: "".into(),
issue_labels: "".into(),
license: "".into(),
name: name.clone(),
private: true,
readme: "".into(),
})
.await?;
debug!("created repo domo/{}", name);
let dir = tempfile::tempdir()?;
let repo = Repository::init(&dir)?;
let sig = &Signature::now("Domo Arigato", "domo@tulpa.dev")?;
debug!("initialized repo in {:?}", dir.path());
let mut fout = File::create(&dir.path().join("VERSION"))?;
write!(fout, "{}", TAG)?;
drop(fout);
let mut fout = File::create(&dir.path().join("CHANGELOG.md"))?;
fout.write_all(include_bytes!("../testdata/basic.md"))?;
drop(fout);
git::commit(&repo, &sig, TAG.into(), &["VERSION", "CHANGELOG.md"])?;
debug!("committed files");
repo.remote("origin", &gitea_repo.clone_url)?;
debug!("set up origin remote to {}", gitea_repo.clone_url);
git::push(
&repo,
token.clone(),
&["refs/heads/master:refs/heads/master"],
)?;
debug!("pushed to {} with token {}", gitea_repo.clone_url, token);
std::env::set_current_dir(dir.path())?;
cmd::cut::run(
cmd::Common {
server: "https://tulpa.dev".into(),
token: token,
auth_user: gitea_repo.owner.login.clone(),
owner: gitea_repo.owner.login.clone(),
repo: gitea_repo.name,
email: "domo@tulpa.dev".into(),
username: "Domo Arigato".into(),
},
"CHANGELOG.md".into(),
None,
cmd::ReleaseMeta {
name: None,
draft: false,
pre_release: false,
},
)
.await?;
let rls = cli
.get_release_by_tag(
gitea_repo.owner.login.clone(),
name.clone(),
format!("v{}", TAG),
)
.await?;
assert_eq!(
rls.body,
"Hi there this is a test\\!\n### ADDED\n - something\n"
);
cli.delete_repo(gitea_repo.owner.login, name).await?;
debug!("deleted repo {}", gitea_repo.clone_url);
Ok(())
}