Compare commits
23 Commits
bddff51ab3
...
v0.1.2
Author | SHA1 | Date | |
---|---|---|---|
10f22956b6 | |||
89e37e2258 | |||
3f42a08bcb | |||
b33935b5f8 | |||
406c485055 | |||
967d561911 | |||
2f32c7b415 | |||
07915f5e54 | |||
f86c774965 | |||
74aa5d724d | |||
bfd146de95 | |||
e3fffe1814 | |||
4c00f45b1c | |||
8e72bedcf1 | |||
59d4123321 | |||
821dcdf277 | |||
faba9d8b69 | |||
3daab2f3f8 | |||
33d3313927 | |||
eb5bdc3fd5 | |||
d74c30132c | |||
11be50d89f | |||
1dcba64095 |
23
.gitea/workflows/ci.yaml
Normal file
23
.gitea/workflows/ci.yaml
Normal file
@ -0,0 +1,23 @@
|
|||||||
|
name: CI
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- main
|
||||||
|
pull_request: {}
|
||||||
|
jobs:
|
||||||
|
ci:
|
||||||
|
name: CI
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: https://gitea.com/actions/checkout@v3
|
||||||
|
- uses: https://github.com/actions-rs/toolchain@v1
|
||||||
|
with:
|
||||||
|
toolchain: stable
|
||||||
|
profile: minimal
|
||||||
|
components: clippy, rustfmt
|
||||||
|
- name: clippy
|
||||||
|
run: cargo clippy --all-targets --all-features -- -D warnings
|
||||||
|
- name: formatting
|
||||||
|
run: cargo fmt --check
|
||||||
|
- name: test
|
||||||
|
run: cargo test --release
|
44
.gitea/workflows/release.yaml
Normal file
44
.gitea/workflows/release.yaml
Normal file
@ -0,0 +1,44 @@
|
|||||||
|
name: Release
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
tags:
|
||||||
|
- "v*.*.*"
|
||||||
|
jobs:
|
||||||
|
release-crate:
|
||||||
|
name: Publish to crates.io
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: https://gitea.com/actions/checkout@v3
|
||||||
|
- uses: https://github.com/actions-rs/toolchain@v1
|
||||||
|
with:
|
||||||
|
toolchain: stable
|
||||||
|
profile: minimal
|
||||||
|
- name: Publish release
|
||||||
|
run: cargo publish --token ${{ secrets.CRATES_IO_TOKEN }}
|
||||||
|
release-docker:
|
||||||
|
name: Publish to Docker Hub
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: https://gitea.com/actions/checkout@v3
|
||||||
|
- name: docker meta
|
||||||
|
id: meta
|
||||||
|
uses: https://github.com/docker/metadata-action@v4
|
||||||
|
with:
|
||||||
|
images: |
|
||||||
|
kelnos/bebot
|
||||||
|
tags: |
|
||||||
|
type=semver,pattern={{version}}
|
||||||
|
type=semver,pattern={{major}}.{{minor}}
|
||||||
|
type=semver,pattern={{major}}
|
||||||
|
- uses: https://gitea.com/docker/setup-qemu-action@v2
|
||||||
|
- uses: https://gitea.com/docker/setup-buildx-action@v2
|
||||||
|
- uses: https://gitea.com/docker/login-action@v2
|
||||||
|
with:
|
||||||
|
username: ${{ secrets.DOCKERHUB_USERNAME }}
|
||||||
|
password: ${{ secrets.DOCKERHUB_PASSWORD }}
|
||||||
|
- uses: https://gitea.com/docker/build-push-action@f2a1d5e99d037542a71f64918e516c093c6f3fc4
|
||||||
|
with:
|
||||||
|
context: .
|
||||||
|
push: true
|
||||||
|
tags: ${{ steps.meta.outputs.tags }}
|
||||||
|
labels: ${{ steps.meta.output.labels }}
|
78
Cargo.lock
generated
78
Cargo.lock
generated
@ -30,9 +30,9 @@ dependencies = [
|
|||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "aho-corasick"
|
name = "aho-corasick"
|
||||||
version = "1.0.5"
|
version = "1.1.1"
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
checksum = "0c378d78423fdad8089616f827526ee33c19f2fddbd5de1629152c9593ba4783"
|
checksum = "ea5d730647d4fadd988536d06fecce94b7b4f2a7efdae548f1cf4b63205518ab"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"memchr",
|
"memchr",
|
||||||
]
|
]
|
||||||
@ -89,7 +89,7 @@ checksum = "16e62a023e7c117e27523144c5d2459f4397fcc3cab0085af8e2224f643a0193"
|
|||||||
dependencies = [
|
dependencies = [
|
||||||
"proc-macro2",
|
"proc-macro2",
|
||||||
"quote",
|
"quote",
|
||||||
"syn 2.0.33",
|
"syn 2.0.37",
|
||||||
]
|
]
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
@ -100,7 +100,7 @@ checksum = "bc00ceb34980c03614e35a3a4e218276a0a824e911d07651cd0d858a51e8c0f0"
|
|||||||
dependencies = [
|
dependencies = [
|
||||||
"proc-macro2",
|
"proc-macro2",
|
||||||
"quote",
|
"quote",
|
||||||
"syn 2.0.33",
|
"syn 2.0.37",
|
||||||
]
|
]
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
@ -152,7 +152,7 @@ checksum = "9ba43ea6f343b788c8764558649e08df62f86c6ef251fdaeb1ffd010a9ae50a2"
|
|||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "bebot"
|
name = "bebot"
|
||||||
version = "0.1.0"
|
version = "0.1.2"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"anyhow",
|
"anyhow",
|
||||||
"constant_time_eq",
|
"constant_time_eq",
|
||||||
@ -160,8 +160,10 @@ dependencies = [
|
|||||||
"http",
|
"http",
|
||||||
"log",
|
"log",
|
||||||
"matrix-sdk",
|
"matrix-sdk",
|
||||||
|
"regex",
|
||||||
"serde",
|
"serde",
|
||||||
"serde_json",
|
"serde_json",
|
||||||
|
"serde_regex",
|
||||||
"serde_yaml",
|
"serde_yaml",
|
||||||
"tokio",
|
"tokio",
|
||||||
"warp",
|
"warp",
|
||||||
@ -467,7 +469,7 @@ checksum = "89ca545a94061b6365f2c7355b4b32bd20df3ff95f02da9329b34ccc3bd6ee72"
|
|||||||
dependencies = [
|
dependencies = [
|
||||||
"proc-macro2",
|
"proc-macro2",
|
||||||
"quote",
|
"quote",
|
||||||
"syn 2.0.33",
|
"syn 2.0.37",
|
||||||
]
|
]
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
@ -532,7 +534,7 @@ checksum = "913dce4c5f06c2ea40fc178c06f777ac89fc6b1383e90c254fafb1abe4ba3c82"
|
|||||||
dependencies = [
|
dependencies = [
|
||||||
"proc-macro2",
|
"proc-macro2",
|
||||||
"quote",
|
"quote",
|
||||||
"syn 2.0.33",
|
"syn 2.0.37",
|
||||||
"uuid",
|
"uuid",
|
||||||
]
|
]
|
||||||
|
|
||||||
@ -613,9 +615,9 @@ dependencies = [
|
|||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "hermit-abi"
|
name = "hermit-abi"
|
||||||
version = "0.3.2"
|
version = "0.3.3"
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
checksum = "443144c8cdadd93ebf52ddb4056d257f5b52c04d3c804e657d19eb73fc33668b"
|
checksum = "d77f7ec81a6d05a3abb01ab6eb7590f6083d08449fe5a1c8b1e620283546ccb7"
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "http"
|
name = "http"
|
||||||
@ -1055,7 +1057,7 @@ checksum = "4359fd9c9171ec6e8c62926d6faaf553a8dc3f64e1507e76da7911b4f6a04405"
|
|||||||
dependencies = [
|
dependencies = [
|
||||||
"proc-macro2",
|
"proc-macro2",
|
||||||
"quote",
|
"quote",
|
||||||
"syn 2.0.33",
|
"syn 2.0.37",
|
||||||
]
|
]
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
@ -1352,9 +1354,9 @@ checksum = "d626bb9dae77e28219937af045c257c28bfd3f69333c512553507f5f9798cb76"
|
|||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "rustix"
|
name = "rustix"
|
||||||
version = "0.38.13"
|
version = "0.38.14"
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
checksum = "d7db8590df6dfcd144d22afd1b83b36c21a18d7cbc1dc4bb5295a8712e9eb662"
|
checksum = "747c788e9ce8e92b12cd485c49ddf90723550b654b32508f979b71a7b1ecda4f"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"bitflags 2.4.0",
|
"bitflags 2.4.0",
|
||||||
"errno",
|
"errno",
|
||||||
@ -1439,7 +1441,7 @@ checksum = "4eca7ac642d82aa35b60049a6eccb4be6be75e599bd2e9adb5f875a737654af2"
|
|||||||
dependencies = [
|
dependencies = [
|
||||||
"proc-macro2",
|
"proc-macro2",
|
||||||
"quote",
|
"quote",
|
||||||
"syn 2.0.33",
|
"syn 2.0.37",
|
||||||
]
|
]
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
@ -1453,6 +1455,16 @@ dependencies = [
|
|||||||
"serde",
|
"serde",
|
||||||
]
|
]
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "serde_regex"
|
||||||
|
version = "1.1.0"
|
||||||
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
|
checksum = "a8136f1a4ea815d7eac4101cfd0b16dc0cb5e1fe1b8609dfd728058656b7badf"
|
||||||
|
dependencies = [
|
||||||
|
"regex",
|
||||||
|
"serde",
|
||||||
|
]
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "serde_urlencoded"
|
name = "serde_urlencoded"
|
||||||
version = "0.7.1"
|
version = "0.7.1"
|
||||||
@ -1500,9 +1512,9 @@ dependencies = [
|
|||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "smallvec"
|
name = "smallvec"
|
||||||
version = "1.11.0"
|
version = "1.11.1"
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
checksum = "62bb4feee49fdd9f707ef802e22365a35de4b7b299de4763d44bfea899442ff9"
|
checksum = "942b4a808e05215192e39f4ab80813e599068285906cc91aa64f923db842bd5a"
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "socket2"
|
name = "socket2"
|
||||||
@ -1555,9 +1567,9 @@ dependencies = [
|
|||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "syn"
|
name = "syn"
|
||||||
version = "2.0.33"
|
version = "2.0.37"
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
checksum = "9caece70c63bfba29ec2fed841a09851b14a235c60010fa4de58089b6c025668"
|
checksum = "7303ef2c05cd654186cb250d29049a24840ca25d2747c25c0381c8d9e2f582e8"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"proc-macro2",
|
"proc-macro2",
|
||||||
"quote",
|
"quote",
|
||||||
@ -1566,9 +1578,9 @@ dependencies = [
|
|||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "termcolor"
|
name = "termcolor"
|
||||||
version = "1.2.0"
|
version = "1.3.0"
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
checksum = "be55cf8942feac5c765c2c993422806843c9a9a45d4d5c407ad6dd2ea95eb9b6"
|
checksum = "6093bad37da69aab9d123a8091e4be0aa4a03e4d601ec641c327398315f62b64"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"winapi-util",
|
"winapi-util",
|
||||||
]
|
]
|
||||||
@ -1590,7 +1602,7 @@ checksum = "49922ecae66cc8a249b77e68d1d0623c1b2c514f0060c27cdc68bd62a1219d35"
|
|||||||
dependencies = [
|
dependencies = [
|
||||||
"proc-macro2",
|
"proc-macro2",
|
||||||
"quote",
|
"quote",
|
||||||
"syn 2.0.33",
|
"syn 2.0.37",
|
||||||
]
|
]
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
@ -1633,7 +1645,7 @@ checksum = "630bdcf245f78637c13ec01ffae6187cca34625e8c63150d424b59e55af2675e"
|
|||||||
dependencies = [
|
dependencies = [
|
||||||
"proc-macro2",
|
"proc-macro2",
|
||||||
"quote",
|
"quote",
|
||||||
"syn 2.0.33",
|
"syn 2.0.37",
|
||||||
]
|
]
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
@ -1671,9 +1683,9 @@ dependencies = [
|
|||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "tokio-util"
|
name = "tokio-util"
|
||||||
version = "0.7.8"
|
version = "0.7.9"
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
checksum = "806fe8c2c87eccc8b3267cbae29ed3ab2d0bd37fca70ab622e46aaa9375ddb7d"
|
checksum = "1d68074620f57a0b21594d9735eb2e98ab38b17f80d3fcb189fca266771ca60d"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"bytes",
|
"bytes",
|
||||||
"futures-core",
|
"futures-core",
|
||||||
@ -1736,7 +1748,7 @@ checksum = "5f4f31f56159e98206da9efd823404b79b6ef3143b4a7ab76e67b1751b25a4ab"
|
|||||||
dependencies = [
|
dependencies = [
|
||||||
"proc-macro2",
|
"proc-macro2",
|
||||||
"quote",
|
"quote",
|
||||||
"syn 2.0.33",
|
"syn 2.0.37",
|
||||||
]
|
]
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
@ -1775,9 +1787,9 @@ dependencies = [
|
|||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "typenum"
|
name = "typenum"
|
||||||
version = "1.16.0"
|
version = "1.17.0"
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
checksum = "497961ef93d974e23eb6f433eb5fe1b7930b659f06d12dec6fc44a8f554c0bba"
|
checksum = "42ff0bf0c66b8238c6f3b578df37d0b7848e55df8577b3f74f92a69acceeb825"
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "unicase"
|
name = "unicase"
|
||||||
@ -1920,7 +1932,7 @@ dependencies = [
|
|||||||
"once_cell",
|
"once_cell",
|
||||||
"proc-macro2",
|
"proc-macro2",
|
||||||
"quote",
|
"quote",
|
||||||
"syn 2.0.33",
|
"syn 2.0.37",
|
||||||
"wasm-bindgen-shared",
|
"wasm-bindgen-shared",
|
||||||
]
|
]
|
||||||
|
|
||||||
@ -1954,7 +1966,7 @@ checksum = "54681b18a46765f095758388f2d0cf16eb8d4169b639ab575a8f5693af210c7b"
|
|||||||
dependencies = [
|
dependencies = [
|
||||||
"proc-macro2",
|
"proc-macro2",
|
||||||
"quote",
|
"quote",
|
||||||
"syn 2.0.33",
|
"syn 2.0.37",
|
||||||
"wasm-bindgen-backend",
|
"wasm-bindgen-backend",
|
||||||
"wasm-bindgen-shared",
|
"wasm-bindgen-shared",
|
||||||
]
|
]
|
||||||
@ -2020,9 +2032,9 @@ checksum = "ac3b87c63620426dd9b991e5ce0329eff545bccbbb34f3be09ff6fb6ab51b7b6"
|
|||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "winapi-util"
|
name = "winapi-util"
|
||||||
version = "0.1.5"
|
version = "0.1.6"
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
checksum = "70ec6ce85bb158151cae5e5c87f95a8e97d2c0c4b001223f33a334e3ce5de178"
|
checksum = "f29e6f9198ba0d26b4c9f07dbe6f9ed633e1f3d5b8b414090084349e46a52596"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"winapi",
|
"winapi",
|
||||||
]
|
]
|
||||||
@ -2120,9 +2132,9 @@ dependencies = [
|
|||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "zeroize"
|
name = "zeroize"
|
||||||
version = "1.3.0"
|
version = "1.6.0"
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
checksum = "4756f7db3f7b5574938c3eb1c117038b8e07f95ee6718c0efad4ac21508f1efd"
|
checksum = "2a0956f1ba7c7909bfb66c2e9e4124ab6f6482560f6628b5aaeba39207c9aad9"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"zeroize_derive",
|
"zeroize_derive",
|
||||||
]
|
]
|
||||||
@ -2135,5 +2147,5 @@ checksum = "ce36e65b0d2999d2aafac989fb249189a141aee1f53c612c1f37d72631959f69"
|
|||||||
dependencies = [
|
dependencies = [
|
||||||
"proc-macro2",
|
"proc-macro2",
|
||||||
"quote",
|
"quote",
|
||||||
"syn 2.0.33",
|
"syn 2.0.37",
|
||||||
]
|
]
|
||||||
|
25
Cargo.toml
25
Cargo.toml
@ -1,9 +1,26 @@
|
|||||||
[package]
|
[package]
|
||||||
name = "bebot"
|
name = "bebot"
|
||||||
version = "0.1.0"
|
version = "0.1.2"
|
||||||
|
description = "Gitlab webhook bot that publishes events to Matrix"
|
||||||
|
license = "GPL-3.0"
|
||||||
|
authors = [
|
||||||
|
"Brian J. Tarricone <brian@tarricone.org>",
|
||||||
|
]
|
||||||
|
homepage = "https://git.spurint.org/kelnos/bebot"
|
||||||
|
repository = "https://git.spurint.org/kelnos/bebot"
|
||||||
edition = "2021"
|
edition = "2021"
|
||||||
|
categories = [
|
||||||
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
|
"development-tools",
|
||||||
|
]
|
||||||
|
keywords = [
|
||||||
|
"gitlab",
|
||||||
|
"matrix",
|
||||||
|
"bot",
|
||||||
|
"webhook",
|
||||||
|
]
|
||||||
|
exclude = [
|
||||||
|
".gitea/*",
|
||||||
|
]
|
||||||
|
|
||||||
[dependencies]
|
[dependencies]
|
||||||
anyhow = "1"
|
anyhow = "1"
|
||||||
@ -12,8 +29,10 @@ env_logger = "0.10"
|
|||||||
http = "0.2"
|
http = "0.2"
|
||||||
log = { version = "0.4", features = ["std"] }
|
log = { version = "0.4", features = ["std"] }
|
||||||
matrix-sdk = { version = "0.6", features = ["anyhow", "markdown", "rustls-tls"], default-features = false }
|
matrix-sdk = { version = "0.6", features = ["anyhow", "markdown", "rustls-tls"], default-features = false }
|
||||||
|
regex = "1"
|
||||||
serde = { version = "1", features = ["derive"] }
|
serde = { version = "1", features = ["derive"] }
|
||||||
serde_json = "1"
|
serde_json = "1"
|
||||||
|
serde_regex = "1"
|
||||||
serde_yaml = "0.9"
|
serde_yaml = "0.9"
|
||||||
tokio = { version = "1", default-features = false, features = ["rt-multi-thread", "macros"] }
|
tokio = { version = "1", default-features = false, features = ["rt-multi-thread", "macros"] }
|
||||||
warp = "0.3"
|
warp = "0.3"
|
||||||
|
10
Dockerfile
10
Dockerfile
@ -2,7 +2,15 @@ FROM rust:1.72-slim-bullseye AS builder
|
|||||||
|
|
||||||
WORKDIR /bebot-build
|
WORKDIR /bebot-build
|
||||||
|
|
||||||
COPY . ./
|
# Build and cache dependencies
|
||||||
|
COPY Cargo.toml Cargo.lock ./
|
||||||
|
RUN mkdir -p src && echo 'fn main() {}' > src/main.rs
|
||||||
|
RUN cargo build --release
|
||||||
|
|
||||||
|
# Build and link our app
|
||||||
|
RUN rm -rf src
|
||||||
|
COPY src ./src
|
||||||
|
RUN touch src/main.rs
|
||||||
RUN cargo build --release
|
RUN cargo build --release
|
||||||
|
|
||||||
FROM debian:bookworm-slim
|
FROM debian:bookworm-slim
|
||||||
|
688
LICENSE
Normal file
688
LICENSE
Normal file
@ -0,0 +1,688 @@
|
|||||||
|
bebot -- Gitlab webhook bot for Matrix
|
||||||
|
Copyright (C) 2023 Brian Tarricone <brian@tarricone.org>
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
This program 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.
|
||||||
|
|
||||||
|
GNU GENERAL PUBLIC LICENSE
|
||||||
|
Version 3, 29 June 2007
|
||||||
|
|
||||||
|
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies
|
||||||
|
of this license document, but changing it is not allowed.
|
||||||
|
|
||||||
|
Preamble
|
||||||
|
|
||||||
|
The GNU General Public License is a free, copyleft license for
|
||||||
|
software and other kinds of works.
|
||||||
|
|
||||||
|
The licenses for most software and other practical works are designed
|
||||||
|
to take away your freedom to share and change the works. By contrast,
|
||||||
|
the GNU General Public License is intended to guarantee your freedom to
|
||||||
|
share and change all versions of a program--to make sure it remains free
|
||||||
|
software for all its users. We, the Free Software Foundation, use the
|
||||||
|
GNU General Public License for most of our software; it applies also to
|
||||||
|
any other work released this way by its authors. You can apply it to
|
||||||
|
your programs, too.
|
||||||
|
|
||||||
|
When we speak of free software, we are referring to freedom, not
|
||||||
|
price. Our General Public Licenses are designed to make sure that you
|
||||||
|
have the freedom to distribute copies of free software (and charge for
|
||||||
|
them if you wish), that you receive source code or can get it if you
|
||||||
|
want it, that you can change the software or use pieces of it in new
|
||||||
|
free programs, and that you know you can do these things.
|
||||||
|
|
||||||
|
To protect your rights, we need to prevent others from denying you
|
||||||
|
these rights or asking you to surrender the rights. Therefore, you have
|
||||||
|
certain responsibilities if you distribute copies of the software, or if
|
||||||
|
you modify it: responsibilities to respect the freedom of others.
|
||||||
|
|
||||||
|
For example, if you distribute copies of such a program, whether
|
||||||
|
gratis or for a fee, you must pass on to the recipients the same
|
||||||
|
freedoms that you received. You must make sure that they, too, receive
|
||||||
|
or can get the source code. And you must show them these terms so they
|
||||||
|
know their rights.
|
||||||
|
|
||||||
|
Developers that use the GNU GPL protect your rights with two steps:
|
||||||
|
(1) assert copyright on the software, and (2) offer you this License
|
||||||
|
giving you legal permission to copy, distribute and/or modify it.
|
||||||
|
|
||||||
|
For the developers' and authors' protection, the GPL clearly explains
|
||||||
|
that there is no warranty for this free software. For both users' and
|
||||||
|
authors' sake, the GPL requires that modified versions be marked as
|
||||||
|
changed, so that their problems will not be attributed erroneously to
|
||||||
|
authors of previous versions.
|
||||||
|
|
||||||
|
Some devices are designed to deny users access to install or run
|
||||||
|
modified versions of the software inside them, although the manufacturer
|
||||||
|
can do so. This is fundamentally incompatible with the aim of
|
||||||
|
protecting users' freedom to change the software. The systematic
|
||||||
|
pattern of such abuse occurs in the area of products for individuals to
|
||||||
|
use, which is precisely where it is most unacceptable. Therefore, we
|
||||||
|
have designed this version of the GPL to prohibit the practice for those
|
||||||
|
products. If such problems arise substantially in other domains, we
|
||||||
|
stand ready to extend this provision to those domains in future versions
|
||||||
|
of the GPL, as needed to protect the freedom of users.
|
||||||
|
|
||||||
|
Finally, every program is threatened constantly by software patents.
|
||||||
|
States should not allow patents to restrict development and use of
|
||||||
|
software on general-purpose computers, but in those that do, we wish to
|
||||||
|
avoid the special danger that patents applied to a free program could
|
||||||
|
make it effectively proprietary. To prevent this, the GPL assures that
|
||||||
|
patents cannot be used to render the program non-free.
|
||||||
|
|
||||||
|
The precise terms and conditions for copying, distribution and
|
||||||
|
modification follow.
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
0. Definitions.
|
||||||
|
|
||||||
|
"This License" refers to version 3 of the GNU General Public License.
|
||||||
|
|
||||||
|
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||||
|
works, such as semiconductor masks.
|
||||||
|
|
||||||
|
"The Program" refers to any copyrightable work licensed under this
|
||||||
|
License. Each licensee is addressed as "you". "Licensees" and
|
||||||
|
"recipients" may be individuals or organizations.
|
||||||
|
|
||||||
|
To "modify" a work means to copy from or adapt all or part of the work
|
||||||
|
in a fashion requiring copyright permission, other than the making of an
|
||||||
|
exact copy. The resulting work is called a "modified version" of the
|
||||||
|
earlier work or a work "based on" the earlier work.
|
||||||
|
|
||||||
|
A "covered work" means either the unmodified Program or a work based
|
||||||
|
on the Program.
|
||||||
|
|
||||||
|
To "propagate" a work means to do anything with it that, without
|
||||||
|
permission, would make you directly or secondarily liable for
|
||||||
|
infringement under applicable copyright law, except executing it on a
|
||||||
|
computer or modifying a private copy. Propagation includes copying,
|
||||||
|
distribution (with or without modification), making available to the
|
||||||
|
public, and in some countries other activities as well.
|
||||||
|
|
||||||
|
To "convey" a work means any kind of propagation that enables other
|
||||||
|
parties to make or receive copies. Mere interaction with a user through
|
||||||
|
a computer network, with no transfer of a copy, is not conveying.
|
||||||
|
|
||||||
|
An interactive user interface displays "Appropriate Legal Notices"
|
||||||
|
to the extent that it includes a convenient and prominently visible
|
||||||
|
feature that (1) displays an appropriate copyright notice, and (2)
|
||||||
|
tells the user that there is no warranty for the work (except to the
|
||||||
|
extent that warranties are provided), that licensees may convey the
|
||||||
|
work under this License, and how to view a copy of this License. If
|
||||||
|
the interface presents a list of user commands or options, such as a
|
||||||
|
menu, a prominent item in the list meets this criterion.
|
||||||
|
|
||||||
|
1. Source Code.
|
||||||
|
|
||||||
|
The "source code" for a work means the preferred form of the work
|
||||||
|
for making modifications to it. "Object code" means any non-source
|
||||||
|
form of a work.
|
||||||
|
|
||||||
|
A "Standard Interface" means an interface that either is an official
|
||||||
|
standard defined by a recognized standards body, or, in the case of
|
||||||
|
interfaces specified for a particular programming language, one that
|
||||||
|
is widely used among developers working in that language.
|
||||||
|
|
||||||
|
The "System Libraries" of an executable work include anything, other
|
||||||
|
than the work as a whole, that (a) is included in the normal form of
|
||||||
|
packaging a Major Component, but which is not part of that Major
|
||||||
|
Component, and (b) serves only to enable use of the work with that
|
||||||
|
Major Component, or to implement a Standard Interface for which an
|
||||||
|
implementation is available to the public in source code form. A
|
||||||
|
"Major Component", in this context, means a major essential component
|
||||||
|
(kernel, window system, and so on) of the specific operating system
|
||||||
|
(if any) on which the executable work runs, or a compiler used to
|
||||||
|
produce the work, or an object code interpreter used to run it.
|
||||||
|
|
||||||
|
The "Corresponding Source" for a work in object code form means all
|
||||||
|
the source code needed to generate, install, and (for an executable
|
||||||
|
work) run the object code and to modify the work, including scripts to
|
||||||
|
control those activities. However, it does not include the work's
|
||||||
|
System Libraries, or general-purpose tools or generally available free
|
||||||
|
programs which are used unmodified in performing those activities but
|
||||||
|
which are not part of the work. For example, Corresponding Source
|
||||||
|
includes interface definition files associated with source files for
|
||||||
|
the work, and the source code for shared libraries and dynamically
|
||||||
|
linked subprograms that the work is specifically designed to require,
|
||||||
|
such as by intimate data communication or control flow between those
|
||||||
|
subprograms and other parts of the work.
|
||||||
|
|
||||||
|
The Corresponding Source need not include anything that users
|
||||||
|
can regenerate automatically from other parts of the Corresponding
|
||||||
|
Source.
|
||||||
|
|
||||||
|
The Corresponding Source for a work in source code form is that
|
||||||
|
same work.
|
||||||
|
|
||||||
|
2. Basic Permissions.
|
||||||
|
|
||||||
|
All rights granted under this License are granted for the term of
|
||||||
|
copyright on the Program, and are irrevocable provided the stated
|
||||||
|
conditions are met. This License explicitly affirms your unlimited
|
||||||
|
permission to run the unmodified Program. The output from running a
|
||||||
|
covered work is covered by this License only if the output, given its
|
||||||
|
content, constitutes a covered work. This License acknowledges your
|
||||||
|
rights of fair use or other equivalent, as provided by copyright law.
|
||||||
|
|
||||||
|
You may make, run and propagate covered works that you do not
|
||||||
|
convey, without conditions so long as your license otherwise remains
|
||||||
|
in force. You may convey covered works to others for the sole purpose
|
||||||
|
of having them make modifications exclusively for you, or provide you
|
||||||
|
with facilities for running those works, provided that you comply with
|
||||||
|
the terms of this License in conveying all material for which you do
|
||||||
|
not control copyright. Those thus making or running the covered works
|
||||||
|
for you must do so exclusively on your behalf, under your direction
|
||||||
|
and control, on terms that prohibit them from making any copies of
|
||||||
|
your copyrighted material outside their relationship with you.
|
||||||
|
|
||||||
|
Conveying under any other circumstances is permitted solely under
|
||||||
|
the conditions stated below. Sublicensing is not allowed; section 10
|
||||||
|
makes it unnecessary.
|
||||||
|
|
||||||
|
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||||
|
|
||||||
|
No covered work shall be deemed part of an effective technological
|
||||||
|
measure under any applicable law fulfilling obligations under article
|
||||||
|
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||||
|
similar laws prohibiting or restricting circumvention of such
|
||||||
|
measures.
|
||||||
|
|
||||||
|
When you convey a covered work, you waive any legal power to forbid
|
||||||
|
circumvention of technological measures to the extent such circumvention
|
||||||
|
is effected by exercising rights under this License with respect to
|
||||||
|
the covered work, and you disclaim any intention to limit operation or
|
||||||
|
modification of the work as a means of enforcing, against the work's
|
||||||
|
users, your or third parties' legal rights to forbid circumvention of
|
||||||
|
technological measures.
|
||||||
|
|
||||||
|
4. Conveying Verbatim Copies.
|
||||||
|
|
||||||
|
You may convey verbatim copies of the Program's source code as you
|
||||||
|
receive it, in any medium, provided that you conspicuously and
|
||||||
|
appropriately publish on each copy an appropriate copyright notice;
|
||||||
|
keep intact all notices stating that this License and any
|
||||||
|
non-permissive terms added in accord with section 7 apply to the code;
|
||||||
|
keep intact all notices of the absence of any warranty; and give all
|
||||||
|
recipients a copy of this License along with the Program.
|
||||||
|
|
||||||
|
You may charge any price or no price for each copy that you convey,
|
||||||
|
and you may offer support or warranty protection for a fee.
|
||||||
|
|
||||||
|
5. Conveying Modified Source Versions.
|
||||||
|
|
||||||
|
You may convey a work based on the Program, or the modifications to
|
||||||
|
produce it from the Program, in the form of source code under the
|
||||||
|
terms of section 4, provided that you also meet all of these conditions:
|
||||||
|
|
||||||
|
a) The work must carry prominent notices stating that you modified
|
||||||
|
it, and giving a relevant date.
|
||||||
|
|
||||||
|
b) The work must carry prominent notices stating that it is
|
||||||
|
released under this License and any conditions added under section
|
||||||
|
7. This requirement modifies the requirement in section 4 to
|
||||||
|
"keep intact all notices".
|
||||||
|
|
||||||
|
c) You must license the entire work, as a whole, under this
|
||||||
|
License to anyone who comes into possession of a copy. This
|
||||||
|
License will therefore apply, along with any applicable section 7
|
||||||
|
additional terms, to the whole of the work, and all its parts,
|
||||||
|
regardless of how they are packaged. This License gives no
|
||||||
|
permission to license the work in any other way, but it does not
|
||||||
|
invalidate such permission if you have separately received it.
|
||||||
|
|
||||||
|
d) If the work has interactive user interfaces, each must display
|
||||||
|
Appropriate Legal Notices; however, if the Program has interactive
|
||||||
|
interfaces that do not display Appropriate Legal Notices, your
|
||||||
|
work need not make them do so.
|
||||||
|
|
||||||
|
A compilation of a covered work with other separate and independent
|
||||||
|
works, which are not by their nature extensions of the covered work,
|
||||||
|
and which are not combined with it such as to form a larger program,
|
||||||
|
in or on a volume of a storage or distribution medium, is called an
|
||||||
|
"aggregate" if the compilation and its resulting copyright are not
|
||||||
|
used to limit the access or legal rights of the compilation's users
|
||||||
|
beyond what the individual works permit. Inclusion of a covered work
|
||||||
|
in an aggregate does not cause this License to apply to the other
|
||||||
|
parts of the aggregate.
|
||||||
|
|
||||||
|
6. Conveying Non-Source Forms.
|
||||||
|
|
||||||
|
You may convey a covered work in object code form under the terms
|
||||||
|
of sections 4 and 5, provided that you also convey the
|
||||||
|
machine-readable Corresponding Source under the terms of this License,
|
||||||
|
in one of these ways:
|
||||||
|
|
||||||
|
a) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by the
|
||||||
|
Corresponding Source fixed on a durable physical medium
|
||||||
|
customarily used for software interchange.
|
||||||
|
|
||||||
|
b) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by a
|
||||||
|
written offer, valid for at least three years and valid for as
|
||||||
|
long as you offer spare parts or customer support for that product
|
||||||
|
model, to give anyone who possesses the object code either (1) a
|
||||||
|
copy of the Corresponding Source for all the software in the
|
||||||
|
product that is covered by this License, on a durable physical
|
||||||
|
medium customarily used for software interchange, for a price no
|
||||||
|
more than your reasonable cost of physically performing this
|
||||||
|
conveying of source, or (2) access to copy the
|
||||||
|
Corresponding Source from a network server at no charge.
|
||||||
|
|
||||||
|
c) Convey individual copies of the object code with a copy of the
|
||||||
|
written offer to provide the Corresponding Source. This
|
||||||
|
alternative is allowed only occasionally and noncommercially, and
|
||||||
|
only if you received the object code with such an offer, in accord
|
||||||
|
with subsection 6b.
|
||||||
|
|
||||||
|
d) Convey the object code by offering access from a designated
|
||||||
|
place (gratis or for a charge), and offer equivalent access to the
|
||||||
|
Corresponding Source in the same way through the same place at no
|
||||||
|
further charge. You need not require recipients to copy the
|
||||||
|
Corresponding Source along with the object code. If the place to
|
||||||
|
copy the object code is a network server, the Corresponding Source
|
||||||
|
may be on a different server (operated by you or a third party)
|
||||||
|
that supports equivalent copying facilities, provided you maintain
|
||||||
|
clear directions next to the object code saying where to find the
|
||||||
|
Corresponding Source. Regardless of what server hosts the
|
||||||
|
Corresponding Source, you remain obligated to ensure that it is
|
||||||
|
available for as long as needed to satisfy these requirements.
|
||||||
|
|
||||||
|
e) Convey the object code using peer-to-peer transmission, provided
|
||||||
|
you inform other peers where the object code and Corresponding
|
||||||
|
Source of the work are being offered to the general public at no
|
||||||
|
charge under subsection 6d.
|
||||||
|
|
||||||
|
A separable portion of the object code, whose source code is excluded
|
||||||
|
from the Corresponding Source as a System Library, need not be
|
||||||
|
included in conveying the object code work.
|
||||||
|
|
||||||
|
A "User Product" is either (1) a "consumer product", which means any
|
||||||
|
tangible personal property which is normally used for personal, family,
|
||||||
|
or household purposes, or (2) anything designed or sold for incorporation
|
||||||
|
into a dwelling. In determining whether a product is a consumer product,
|
||||||
|
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||||
|
product received by a particular user, "normally used" refers to a
|
||||||
|
typical or common use of that class of product, regardless of the status
|
||||||
|
of the particular user or of the way in which the particular user
|
||||||
|
actually uses, or expects or is expected to use, the product. A product
|
||||||
|
is a consumer product regardless of whether the product has substantial
|
||||||
|
commercial, industrial or non-consumer uses, unless such uses represent
|
||||||
|
the only significant mode of use of the product.
|
||||||
|
|
||||||
|
"Installation Information" for a User Product means any methods,
|
||||||
|
procedures, authorization keys, or other information required to install
|
||||||
|
and execute modified versions of a covered work in that User Product from
|
||||||
|
a modified version of its Corresponding Source. The information must
|
||||||
|
suffice to ensure that the continued functioning of the modified object
|
||||||
|
code is in no case prevented or interfered with solely because
|
||||||
|
modification has been made.
|
||||||
|
|
||||||
|
If you convey an object code work under this section in, or with, or
|
||||||
|
specifically for use in, a User Product, and the conveying occurs as
|
||||||
|
part of a transaction in which the right of possession and use of the
|
||||||
|
User Product is transferred to the recipient in perpetuity or for a
|
||||||
|
fixed term (regardless of how the transaction is characterized), the
|
||||||
|
Corresponding Source conveyed under this section must be accompanied
|
||||||
|
by the Installation Information. But this requirement does not apply
|
||||||
|
if neither you nor any third party retains the ability to install
|
||||||
|
modified object code on the User Product (for example, the work has
|
||||||
|
been installed in ROM).
|
||||||
|
|
||||||
|
The requirement to provide Installation Information does not include a
|
||||||
|
requirement to continue to provide support service, warranty, or updates
|
||||||
|
for a work that has been modified or installed by the recipient, or for
|
||||||
|
the User Product in which it has been modified or installed. Access to a
|
||||||
|
network may be denied when the modification itself materially and
|
||||||
|
adversely affects the operation of the network or violates the rules and
|
||||||
|
protocols for communication across the network.
|
||||||
|
|
||||||
|
Corresponding Source conveyed, and Installation Information provided,
|
||||||
|
in accord with this section must be in a format that is publicly
|
||||||
|
documented (and with an implementation available to the public in
|
||||||
|
source code form), and must require no special password or key for
|
||||||
|
unpacking, reading or copying.
|
||||||
|
|
||||||
|
7. Additional Terms.
|
||||||
|
|
||||||
|
"Additional permissions" are terms that supplement the terms of this
|
||||||
|
License by making exceptions from one or more of its conditions.
|
||||||
|
Additional permissions that are applicable to the entire Program shall
|
||||||
|
be treated as though they were included in this License, to the extent
|
||||||
|
that they are valid under applicable law. If additional permissions
|
||||||
|
apply only to part of the Program, that part may be used separately
|
||||||
|
under those permissions, but the entire Program remains governed by
|
||||||
|
this License without regard to the additional permissions.
|
||||||
|
|
||||||
|
When you convey a copy of a covered work, you may at your option
|
||||||
|
remove any additional permissions from that copy, or from any part of
|
||||||
|
it. (Additional permissions may be written to require their own
|
||||||
|
removal in certain cases when you modify the work.) You may place
|
||||||
|
additional permissions on material, added by you to a covered work,
|
||||||
|
for which you have or can give appropriate copyright permission.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, for material you
|
||||||
|
add to a covered work, you may (if authorized by the copyright holders of
|
||||||
|
that material) supplement the terms of this License with terms:
|
||||||
|
|
||||||
|
a) Disclaiming warranty or limiting liability differently from the
|
||||||
|
terms of sections 15 and 16 of this License; or
|
||||||
|
|
||||||
|
b) Requiring preservation of specified reasonable legal notices or
|
||||||
|
author attributions in that material or in the Appropriate Legal
|
||||||
|
Notices displayed by works containing it; or
|
||||||
|
|
||||||
|
c) Prohibiting misrepresentation of the origin of that material, or
|
||||||
|
requiring that modified versions of such material be marked in
|
||||||
|
reasonable ways as different from the original version; or
|
||||||
|
|
||||||
|
d) Limiting the use for publicity purposes of names of licensors or
|
||||||
|
authors of the material; or
|
||||||
|
|
||||||
|
e) Declining to grant rights under trademark law for use of some
|
||||||
|
trade names, trademarks, or service marks; or
|
||||||
|
|
||||||
|
f) Requiring indemnification of licensors and authors of that
|
||||||
|
material by anyone who conveys the material (or modified versions of
|
||||||
|
it) with contractual assumptions of liability to the recipient, for
|
||||||
|
any liability that these contractual assumptions directly impose on
|
||||||
|
those licensors and authors.
|
||||||
|
|
||||||
|
All other non-permissive additional terms are considered "further
|
||||||
|
restrictions" within the meaning of section 10. If the Program as you
|
||||||
|
received it, or any part of it, contains a notice stating that it is
|
||||||
|
governed by this License along with a term that is a further
|
||||||
|
restriction, you may remove that term. If a license document contains
|
||||||
|
a further restriction but permits relicensing or conveying under this
|
||||||
|
License, you may add to a covered work material governed by the terms
|
||||||
|
of that license document, provided that the further restriction does
|
||||||
|
not survive such relicensing or conveying.
|
||||||
|
|
||||||
|
If you add terms to a covered work in accord with this section, you
|
||||||
|
must place, in the relevant source files, a statement of the
|
||||||
|
additional terms that apply to those files, or a notice indicating
|
||||||
|
where to find the applicable terms.
|
||||||
|
|
||||||
|
Additional terms, permissive or non-permissive, may be stated in the
|
||||||
|
form of a separately written license, or stated as exceptions;
|
||||||
|
the above requirements apply either way.
|
||||||
|
|
||||||
|
8. Termination.
|
||||||
|
|
||||||
|
You may not propagate or modify a covered work except as expressly
|
||||||
|
provided under this License. Any attempt otherwise to propagate or
|
||||||
|
modify it is void, and will automatically terminate your rights under
|
||||||
|
this License (including any patent licenses granted under the third
|
||||||
|
paragraph of section 11).
|
||||||
|
|
||||||
|
However, if you cease all violation of this License, then your
|
||||||
|
license from a particular copyright holder is reinstated (a)
|
||||||
|
provisionally, unless and until the copyright holder explicitly and
|
||||||
|
finally terminates your license, and (b) permanently, if the copyright
|
||||||
|
holder fails to notify you of the violation by some reasonable means
|
||||||
|
prior to 60 days after the cessation.
|
||||||
|
|
||||||
|
Moreover, your license from a particular copyright holder is
|
||||||
|
reinstated permanently if the copyright holder notifies you of the
|
||||||
|
violation by some reasonable means, this is the first time you have
|
||||||
|
received notice of violation of this License (for any work) from that
|
||||||
|
copyright holder, and you cure the violation prior to 30 days after
|
||||||
|
your receipt of the notice.
|
||||||
|
|
||||||
|
Termination of your rights under this section does not terminate the
|
||||||
|
licenses of parties who have received copies or rights from you under
|
||||||
|
this License. If your rights have been terminated and not permanently
|
||||||
|
reinstated, you do not qualify to receive new licenses for the same
|
||||||
|
material under section 10.
|
||||||
|
|
||||||
|
9. Acceptance Not Required for Having Copies.
|
||||||
|
|
||||||
|
You are not required to accept this License in order to receive or
|
||||||
|
run a copy of the Program. Ancillary propagation of a covered work
|
||||||
|
occurring solely as a consequence of using peer-to-peer transmission
|
||||||
|
to receive a copy likewise does not require acceptance. However,
|
||||||
|
nothing other than this License grants you permission to propagate or
|
||||||
|
modify any covered work. These actions infringe copyright if you do
|
||||||
|
not accept this License. Therefore, by modifying or propagating a
|
||||||
|
covered work, you indicate your acceptance of this License to do so.
|
||||||
|
|
||||||
|
10. Automatic Licensing of Downstream Recipients.
|
||||||
|
|
||||||
|
Each time you convey a covered work, the recipient automatically
|
||||||
|
receives a license from the original licensors, to run, modify and
|
||||||
|
propagate that work, subject to this License. You are not responsible
|
||||||
|
for enforcing compliance by third parties with this License.
|
||||||
|
|
||||||
|
An "entity transaction" is a transaction transferring control of an
|
||||||
|
organization, or substantially all assets of one, or subdividing an
|
||||||
|
organization, or merging organizations. If propagation of a covered
|
||||||
|
work results from an entity transaction, each party to that
|
||||||
|
transaction who receives a copy of the work also receives whatever
|
||||||
|
licenses to the work the party's predecessor in interest had or could
|
||||||
|
give under the previous paragraph, plus a right to possession of the
|
||||||
|
Corresponding Source of the work from the predecessor in interest, if
|
||||||
|
the predecessor has it or can get it with reasonable efforts.
|
||||||
|
|
||||||
|
You may not impose any further restrictions on the exercise of the
|
||||||
|
rights granted or affirmed under this License. For example, you may
|
||||||
|
not impose a license fee, royalty, or other charge for exercise of
|
||||||
|
rights granted under this License, and you may not initiate litigation
|
||||||
|
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||||
|
any patent claim is infringed by making, using, selling, offering for
|
||||||
|
sale, or importing the Program or any portion of it.
|
||||||
|
|
||||||
|
11. Patents.
|
||||||
|
|
||||||
|
A "contributor" is a copyright holder who authorizes use under this
|
||||||
|
License of the Program or a work on which the Program is based. The
|
||||||
|
work thus licensed is called the contributor's "contributor version".
|
||||||
|
|
||||||
|
A contributor's "essential patent claims" are all patent claims
|
||||||
|
owned or controlled by the contributor, whether already acquired or
|
||||||
|
hereafter acquired, that would be infringed by some manner, permitted
|
||||||
|
by this License, of making, using, or selling its contributor version,
|
||||||
|
but do not include claims that would be infringed only as a
|
||||||
|
consequence of further modification of the contributor version. For
|
||||||
|
purposes of this definition, "control" includes the right to grant
|
||||||
|
patent sublicenses in a manner consistent with the requirements of
|
||||||
|
this License.
|
||||||
|
|
||||||
|
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||||
|
patent license under the contributor's essential patent claims, to
|
||||||
|
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||||
|
propagate the contents of its contributor version.
|
||||||
|
|
||||||
|
In the following three paragraphs, a "patent license" is any express
|
||||||
|
agreement or commitment, however denominated, not to enforce a patent
|
||||||
|
(such as an express permission to practice a patent or covenant not to
|
||||||
|
sue for patent infringement). To "grant" such a patent license to a
|
||||||
|
party means to make such an agreement or commitment not to enforce a
|
||||||
|
patent against the party.
|
||||||
|
|
||||||
|
If you convey a covered work, knowingly relying on a patent license,
|
||||||
|
and the Corresponding Source of the work is not available for anyone
|
||||||
|
to copy, free of charge and under the terms of this License, through a
|
||||||
|
publicly available network server or other readily accessible means,
|
||||||
|
then you must either (1) cause the Corresponding Source to be so
|
||||||
|
available, or (2) arrange to deprive yourself of the benefit of the
|
||||||
|
patent license for this particular work, or (3) arrange, in a manner
|
||||||
|
consistent with the requirements of this License, to extend the patent
|
||||||
|
license to downstream recipients. "Knowingly relying" means you have
|
||||||
|
actual knowledge that, but for the patent license, your conveying the
|
||||||
|
covered work in a country, or your recipient's use of the covered work
|
||||||
|
in a country, would infringe one or more identifiable patents in that
|
||||||
|
country that you have reason to believe are valid.
|
||||||
|
|
||||||
|
If, pursuant to or in connection with a single transaction or
|
||||||
|
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||||
|
covered work, and grant a patent license to some of the parties
|
||||||
|
receiving the covered work authorizing them to use, propagate, modify
|
||||||
|
or convey a specific copy of the covered work, then the patent license
|
||||||
|
you grant is automatically extended to all recipients of the covered
|
||||||
|
work and works based on it.
|
||||||
|
|
||||||
|
A patent license is "discriminatory" if it does not include within
|
||||||
|
the scope of its coverage, prohibits the exercise of, or is
|
||||||
|
conditioned on the non-exercise of one or more of the rights that are
|
||||||
|
specifically granted under this License. You may not convey a covered
|
||||||
|
work if you are a party to an arrangement with a third party that is
|
||||||
|
in the business of distributing software, under which you make payment
|
||||||
|
to the third party based on the extent of your activity of conveying
|
||||||
|
the work, and under which the third party grants, to any of the
|
||||||
|
parties who would receive the covered work from you, a discriminatory
|
||||||
|
patent license (a) in connection with copies of the covered work
|
||||||
|
conveyed by you (or copies made from those copies), or (b) primarily
|
||||||
|
for and in connection with specific products or compilations that
|
||||||
|
contain the covered work, unless you entered into that arrangement,
|
||||||
|
or that patent license was granted, prior to 28 March 2007.
|
||||||
|
|
||||||
|
Nothing in this License shall be construed as excluding or limiting
|
||||||
|
any implied license or other defenses to infringement that may
|
||||||
|
otherwise be available to you under applicable patent law.
|
||||||
|
|
||||||
|
12. No Surrender of Others' Freedom.
|
||||||
|
|
||||||
|
If conditions are imposed on you (whether by court order, agreement or
|
||||||
|
otherwise) that contradict the conditions of this License, they do not
|
||||||
|
excuse you from the conditions of this License. If you cannot convey a
|
||||||
|
covered work so as to satisfy simultaneously your obligations under this
|
||||||
|
License and any other pertinent obligations, then as a consequence you may
|
||||||
|
not convey it at all. For example, if you agree to terms that obligate you
|
||||||
|
to collect a royalty for further conveying from those to whom you convey
|
||||||
|
the Program, the only way you could satisfy both those terms and this
|
||||||
|
License would be to refrain entirely from conveying the Program.
|
||||||
|
|
||||||
|
13. Use with the GNU Affero General Public License.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, you have
|
||||||
|
permission to link or combine any covered work with a work licensed
|
||||||
|
under version 3 of the GNU Affero General Public License into a single
|
||||||
|
combined work, and to convey the resulting work. The terms of this
|
||||||
|
License will continue to apply to the part which is the covered work,
|
||||||
|
but the special requirements of the GNU Affero General Public License,
|
||||||
|
section 13, concerning interaction through a network will apply to the
|
||||||
|
combination as such.
|
||||||
|
|
||||||
|
14. Revised Versions of this License.
|
||||||
|
|
||||||
|
The Free Software Foundation may publish revised and/or new versions of
|
||||||
|
the GNU General Public License from time to time. Such new versions will
|
||||||
|
be similar in spirit to the present version, but may differ in detail to
|
||||||
|
address new problems or concerns.
|
||||||
|
|
||||||
|
Each version is given a distinguishing version number. If the
|
||||||
|
Program specifies that a certain numbered version of the GNU General
|
||||||
|
Public License "or any later version" applies to it, you have the
|
||||||
|
option of following the terms and conditions either of that numbered
|
||||||
|
version or of any later version published by the Free Software
|
||||||
|
Foundation. If the Program does not specify a version number of the
|
||||||
|
GNU General Public License, you may choose any version ever published
|
||||||
|
by the Free Software Foundation.
|
||||||
|
|
||||||
|
If the Program specifies that a proxy can decide which future
|
||||||
|
versions of the GNU General Public License can be used, that proxy's
|
||||||
|
public statement of acceptance of a version permanently authorizes you
|
||||||
|
to choose that version for the Program.
|
||||||
|
|
||||||
|
Later license versions may give you additional or different
|
||||||
|
permissions. However, no additional obligations are imposed on any
|
||||||
|
author or copyright holder as a result of your choosing to follow a
|
||||||
|
later version.
|
||||||
|
|
||||||
|
15. Disclaimer of Warranty.
|
||||||
|
|
||||||
|
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||||
|
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||||
|
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||||
|
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||||
|
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||||
|
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||||
|
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||||
|
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||||
|
|
||||||
|
16. Limitation of Liability.
|
||||||
|
|
||||||
|
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||||
|
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||||
|
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||||
|
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||||
|
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||||
|
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||||
|
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||||
|
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||||
|
SUCH DAMAGES.
|
||||||
|
|
||||||
|
17. Interpretation of Sections 15 and 16.
|
||||||
|
|
||||||
|
If the disclaimer of warranty and limitation of liability provided
|
||||||
|
above cannot be given local legal effect according to their terms,
|
||||||
|
reviewing courts shall apply local law that most closely approximates
|
||||||
|
an absolute waiver of all civil liability in connection with the
|
||||||
|
Program, unless a warranty or assumption of liability accompanies a
|
||||||
|
copy of the Program in return for a fee.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
How to Apply These Terms to Your New Programs
|
||||||
|
|
||||||
|
If you develop a new program, and you want it to be of the greatest
|
||||||
|
possible use to the public, the best way to achieve this is to make it
|
||||||
|
free software which everyone can redistribute and change under these terms.
|
||||||
|
|
||||||
|
To do so, attach the following notices to the program. It is safest
|
||||||
|
to attach them to the start of each source file to most effectively
|
||||||
|
state the exclusion of warranty; and each file should have at least
|
||||||
|
the "copyright" line and a pointer to where the full notice is found.
|
||||||
|
|
||||||
|
<one line to give the program's name and a brief idea of what it does.>
|
||||||
|
Copyright (C) <year> <name of author>
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
This program 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 this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
Also add information on how to contact you by electronic and paper mail.
|
||||||
|
|
||||||
|
If the program does terminal interaction, make it output a short
|
||||||
|
notice like this when it starts in an interactive mode:
|
||||||
|
|
||||||
|
<program> Copyright (C) <year> <name of author>
|
||||||
|
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||||
|
This is free software, and you are welcome to redistribute it
|
||||||
|
under certain conditions; type `show c' for details.
|
||||||
|
|
||||||
|
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||||
|
parts of the General Public License. Of course, your program's commands
|
||||||
|
might be different; for a GUI interface, you would use an "about box".
|
||||||
|
|
||||||
|
You should also get your employer (if you work as a programmer) or school,
|
||||||
|
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||||
|
For more information on this, and how to apply and follow the GNU GPL, see
|
||||||
|
<https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
The GNU General Public License does not permit incorporating your program
|
||||||
|
into proprietary programs. If your program is a subroutine library, you
|
||||||
|
may consider it more useful to permit linking proprietary applications with
|
||||||
|
the library. If this is what you want to do, use the GNU Lesser General
|
||||||
|
Public License instead of this License. But first, please read
|
||||||
|
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
||||||
|
|
63
README.md
Normal file
63
README.md
Normal file
@ -0,0 +1,63 @@
|
|||||||
|
# `bebot`
|
||||||
|
|
||||||
|
Bebot is a Gitlab webhook handler that publishes messages to Matrix when
|
||||||
|
interesting things happen in your configured repos.
|
||||||
|
|
||||||
|
Currently-supported Gitlab event types:
|
||||||
|
|
||||||
|
* Push events
|
||||||
|
* Tag push events
|
||||||
|
* Issue events
|
||||||
|
* Merge request events
|
||||||
|
* Pipeline events (only publishes on failure for now)
|
||||||
|
|
||||||
|
## Building
|
||||||
|
|
||||||
|
Bebot is written in Rust, and requires a Rust toolchain in order to
|
||||||
|
build. The usual `cargo build` or `cargo build --release` will do the
|
||||||
|
trick.
|
||||||
|
|
||||||
|
You can also build and install the latest released version of Bebot by
|
||||||
|
running `cargo install bebot`.
|
||||||
|
|
||||||
|
## Setup
|
||||||
|
|
||||||
|
Bebot requires a configuration file in YAML format. See
|
||||||
|
`sample-config.yaml` for all existing configuration options, as well as
|
||||||
|
documentation on what each option does.
|
||||||
|
|
||||||
|
When setting up the webhook in Gitlab, use the same `token` from the
|
||||||
|
configuration file in the webhook's "Secret token" field. You should
|
||||||
|
only select "Push events", "Tag push events", "Issues events", "Merge
|
||||||
|
request events", and "Pipeline events". You can leave some of these out
|
||||||
|
if you don't want Bebot to publish messages for everything.
|
||||||
|
|
||||||
|
Bebot does not support serving the webhook over TLS, so you will
|
||||||
|
probably want to put it behind a reverse-proxy such as nginx.
|
||||||
|
|
||||||
|
In the `scripts` directory is a `set-webhook.py` script that can set up
|
||||||
|
(or update) webhooks for your repository, automatically generating a
|
||||||
|
token for you. If setting up the webhook for the first time, it will
|
||||||
|
output to stdout a YAML snippet that goes under the `repo_configs`
|
||||||
|
section of the configuration file. If you run the script with no
|
||||||
|
arguments, it will print out usage details.
|
||||||
|
|
||||||
|
## Running
|
||||||
|
|
||||||
|
After you've done all that, simply run Bebot:
|
||||||
|
|
||||||
|
```
|
||||||
|
bebot /path/to/config-file.yaml
|
||||||
|
```
|
||||||
|
|
||||||
|
You can set the `BEBOT_LOG` environment variable to increase or decrease
|
||||||
|
logging verbosity. (Try `debug`, `info`, `warn` `error`, or `off`.)
|
||||||
|
|
||||||
|
### Docker
|
||||||
|
|
||||||
|
A `Dockerfile` is also provided. When running the container it builds,
|
||||||
|
mount the configuration file so it appears inside the container as
|
||||||
|
`/bebot/config/bebot.yaml`.
|
||||||
|
|
||||||
|
Release images are [published to Docker
|
||||||
|
Hub](https://hub.docker.com/r/kelnos/bebot).
|
58
sample-config.yaml
Normal file
58
sample-config.yaml
Normal file
@ -0,0 +1,58 @@
|
|||||||
|
# Address/interface the webhook listener should bind to (default is 127.0.0.1).
|
||||||
|
bind_address: 127.0.0.1
|
||||||
|
# Port the webhook listener should bind to (default is 3000).
|
||||||
|
bind_port: 3000
|
||||||
|
# Optional prefix to serve the webhook path under (default is empty string).
|
||||||
|
url_prefix: "/bebot"
|
||||||
|
# Matrix user to sign in as.
|
||||||
|
user_id: "@mybebot:example.com"
|
||||||
|
# Password for Matrix user.
|
||||||
|
password: "secret-matrix-account-password"
|
||||||
|
# Default Matrix room to publish events to.
|
||||||
|
default_room: "#my-project-commits:example.com"
|
||||||
|
# Default set of events to publish. If left out, all events will be published.
|
||||||
|
default_publish_events:
|
||||||
|
- name: push
|
||||||
|
# Regexes of branch names. Leave out entirely for "all branches".
|
||||||
|
branches:
|
||||||
|
- '^main$'
|
||||||
|
- '^xfce-.+'
|
||||||
|
- name: tag_push
|
||||||
|
- name: issues
|
||||||
|
# See the Gitlab docs for a full list of actions. If left out, all actions
|
||||||
|
# will be published.
|
||||||
|
actions:
|
||||||
|
- open
|
||||||
|
- close
|
||||||
|
- name: merge_request
|
||||||
|
# See the Gitlab docs for a full list of actions. If left out, all actions
|
||||||
|
# will be published.
|
||||||
|
actions:
|
||||||
|
- open
|
||||||
|
- merge
|
||||||
|
- name: pipeline
|
||||||
|
# See the Gitlab docs for a full list of statuses. If left out, all
|
||||||
|
# actions will be published.
|
||||||
|
statuses:
|
||||||
|
- failed
|
||||||
|
# Key-value configuration for repositories.
|
||||||
|
repo_configs:
|
||||||
|
# Keys are the instance name / namespace / repository name
|
||||||
|
"gitlab.example.com/myorg/my-cool-app":
|
||||||
|
# Each repository should use a unique, randomly-generated token. Enter
|
||||||
|
# this token in the webhook configuration's "Secret token" on Gitlab.
|
||||||
|
token: "abcdefg12345"
|
||||||
|
# You can override the default_room above. Leave out to use the default.
|
||||||
|
room: "#my-cool-app-events:example.com"
|
||||||
|
# You can override default_events above. Leave out this section to
|
||||||
|
# use the defaults.
|
||||||
|
publish_events:
|
||||||
|
- name: push
|
||||||
|
branches:
|
||||||
|
- main
|
||||||
|
- name: pipeline
|
||||||
|
statuses:
|
||||||
|
- failed
|
||||||
|
"gitlab.example.com/myuser/some-other-less-cool-app":
|
||||||
|
token: "kljaslkdjaklsdjalksd"
|
||||||
|
# This repo uses the default events and room.
|
59
scripts/set-webook.py
Executable file
59
scripts/set-webook.py
Executable file
@ -0,0 +1,59 @@
|
|||||||
|
#!/usr/bin/env python3
|
||||||
|
|
||||||
|
import re
|
||||||
|
import os
|
||||||
|
import requests
|
||||||
|
import secrets
|
||||||
|
import sys
|
||||||
|
|
||||||
|
|
||||||
|
def die(s):
|
||||||
|
print(s, file=sys.stderr)
|
||||||
|
sys.exit(1)
|
||||||
|
|
||||||
|
|
||||||
|
gitlab_token = os.getenv('GITLAB_TOKEN')
|
||||||
|
if gitlab_token is None:
|
||||||
|
die("GITLAB_TOKEN must be set in the environment")
|
||||||
|
|
||||||
|
if len(sys.argv) < 4:
|
||||||
|
die("Usage: {} GITLAB_INSTANCE HOOK_URL_BASE NAMESPACE/REPO\n\nExample: {} gitlab.example.com https://bot.example.com/bebot stuff/myrepo")
|
||||||
|
|
||||||
|
gitlab_instance = sys.argv[1]
|
||||||
|
hook_url = f"{sys.argv[2]}/hooks/gitlab"
|
||||||
|
repo_name = sys.argv[3]
|
||||||
|
|
||||||
|
gl_base = 'https://{}/api/v4/projects/{}/hooks'.format(
|
||||||
|
gitlab_instance,
|
||||||
|
re.sub('/', '%2F', repo_name)
|
||||||
|
)
|
||||||
|
headers = {
|
||||||
|
'authorization': 'Bearer {}'.format(gitlab_token),
|
||||||
|
}
|
||||||
|
payload = {
|
||||||
|
"issues_events": True,
|
||||||
|
"merge_requests_events": True,
|
||||||
|
"pipeline_events": True,
|
||||||
|
"push_events": True,
|
||||||
|
"tag_push_events": True,
|
||||||
|
}
|
||||||
|
|
||||||
|
resp = requests.get(gl_base, headers=headers)
|
||||||
|
if resp.status_code != 200:
|
||||||
|
resp.raise_for_status()
|
||||||
|
existing = resp.json()
|
||||||
|
|
||||||
|
for hook in existing:
|
||||||
|
if hook['url'] == hook_url:
|
||||||
|
upd_url = '{}/{}'.format(gl_base, hook['id'])
|
||||||
|
resp = requests.put(upd_url, headers=headers, json=payload)
|
||||||
|
print("Updated existing hook for {}".format(repo_name))
|
||||||
|
sys.exit(0)
|
||||||
|
|
||||||
|
token = secrets.token_urlsafe(32)
|
||||||
|
payload["url"] = hook_url
|
||||||
|
payload["token"] = token
|
||||||
|
resp = requests.post(gl_base, headers=headers, json=payload)
|
||||||
|
resp.raise_for_status()
|
||||||
|
print(' "{}/{}":'.format(gitlab_instance, repo_name))
|
||||||
|
print(' token: "{}"'.format(token))
|
@ -1,15 +1,55 @@
|
|||||||
|
// bebot
|
||||||
|
// Copyright (C) 2023 Brian Tarricone <brian@tarricone.org>
|
||||||
|
//
|
||||||
|
// 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.
|
||||||
|
//
|
||||||
|
// This program 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 this program. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
use std::{collections::HashMap, fmt, fs::File, io::BufReader};
|
use std::{collections::HashMap, fmt, fs::File, io::BufReader};
|
||||||
|
|
||||||
use anyhow::Context;
|
use anyhow::Context;
|
||||||
use matrix_sdk::ruma::{OwnedRoomOrAliasId, OwnedUserId, RoomOrAliasId, UserId};
|
use matrix_sdk::ruma::{OwnedRoomOrAliasId, OwnedUserId, RoomOrAliasId, UserId};
|
||||||
|
use regex::Regex;
|
||||||
use serde::de;
|
use serde::de;
|
||||||
|
|
||||||
|
use crate::event::{IssueAction, MergeRequestAction, PipelineStatus};
|
||||||
|
|
||||||
|
#[derive(Deserialize)]
|
||||||
|
#[serde(tag = "name", rename_all = "snake_case")]
|
||||||
|
pub enum PublishEvent {
|
||||||
|
Push {
|
||||||
|
#[serde(default)]
|
||||||
|
#[serde(with = "serde_regex")]
|
||||||
|
branches: Option<Vec<Regex>>,
|
||||||
|
},
|
||||||
|
TagPush,
|
||||||
|
Issues {
|
||||||
|
actions: Option<Vec<IssueAction>>,
|
||||||
|
},
|
||||||
|
MergeRequest {
|
||||||
|
actions: Option<Vec<MergeRequestAction>>,
|
||||||
|
},
|
||||||
|
Pipeline {
|
||||||
|
statuses: Option<Vec<PipelineStatus>>,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
#[derive(Deserialize)]
|
#[derive(Deserialize)]
|
||||||
pub struct RepoConfig {
|
pub struct RepoConfig {
|
||||||
pub token: String,
|
pub token: String,
|
||||||
#[serde(default)]
|
#[serde(default)]
|
||||||
#[serde(deserialize_with = "deser_optional_room_or_alias_id")]
|
#[serde(deserialize_with = "deser_optional_room_or_alias_id")]
|
||||||
pub room: Option<OwnedRoomOrAliasId>,
|
pub room: Option<OwnedRoomOrAliasId>,
|
||||||
|
pub publish_events: Option<Vec<PublishEvent>>,
|
||||||
}
|
}
|
||||||
|
|
||||||
#[derive(Deserialize)]
|
#[derive(Deserialize)]
|
||||||
@ -23,6 +63,7 @@ pub struct Config {
|
|||||||
#[serde(default)]
|
#[serde(default)]
|
||||||
#[serde(deserialize_with = "deser_optional_room_or_alias_id")]
|
#[serde(deserialize_with = "deser_optional_room_or_alias_id")]
|
||||||
pub default_room: Option<OwnedRoomOrAliasId>,
|
pub default_room: Option<OwnedRoomOrAliasId>,
|
||||||
|
pub default_publish_events: Option<Vec<PublishEvent>>,
|
||||||
pub repo_configs: HashMap<String, RepoConfig>, // key is repo url without scheme; e.g.
|
pub repo_configs: HashMap<String, RepoConfig>, // key is repo url without scheme; e.g.
|
||||||
// gitlab.xfce.org/xfce/xfdesktop
|
// gitlab.xfce.org/xfce/xfdesktop
|
||||||
}
|
}
|
||||||
|
486
src/event.rs
486
src/event.rs
@ -1,9 +1,29 @@
|
|||||||
|
// bebot
|
||||||
|
// Copyright (C) 2023 Brian Tarricone <brian@tarricone.org>
|
||||||
|
//
|
||||||
|
// 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.
|
||||||
|
//
|
||||||
|
// This program 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 this program. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
use core::fmt;
|
||||||
|
|
||||||
|
use crate::config::PublishEvent;
|
||||||
|
|
||||||
pub trait GitlabEventExt {
|
pub trait GitlabEventExt {
|
||||||
|
fn should_publish(&self, publish_events: &[PublishEvent]) -> bool;
|
||||||
fn project(&self) -> &Project;
|
fn project(&self) -> &Project;
|
||||||
fn r#ref(&self) -> &str;
|
fn r#ref(&self) -> Option<&str>;
|
||||||
fn user(&self) -> &str;
|
fn user(&self) -> &str;
|
||||||
fn url(&self) -> String;
|
fn titles(&self) -> Vec<String>;
|
||||||
fn title(&self) -> String;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
#[derive(Debug, Deserialize)]
|
#[derive(Debug, Deserialize)]
|
||||||
@ -14,9 +34,7 @@ pub struct User {
|
|||||||
#[derive(Debug, Deserialize)]
|
#[derive(Debug, Deserialize)]
|
||||||
pub struct Project {
|
pub struct Project {
|
||||||
pub name: String,
|
pub name: String,
|
||||||
pub description: String,
|
|
||||||
pub web_url: String,
|
pub web_url: String,
|
||||||
pub avatar_url: Option<String>,
|
|
||||||
pub namespace: String,
|
pub namespace: String,
|
||||||
pub path_with_namespace: String,
|
pub path_with_namespace: String,
|
||||||
pub default_branch: String,
|
pub default_branch: String,
|
||||||
@ -26,7 +44,6 @@ pub struct Project {
|
|||||||
pub struct Repository {
|
pub struct Repository {
|
||||||
pub name: String,
|
pub name: String,
|
||||||
pub url: String,
|
pub url: String,
|
||||||
pub description: String,
|
|
||||||
}
|
}
|
||||||
|
|
||||||
#[derive(Debug, Deserialize)]
|
#[derive(Debug, Deserialize)]
|
||||||
@ -37,42 +54,45 @@ pub struct Commit {
|
|||||||
}
|
}
|
||||||
|
|
||||||
#[derive(PartialEq, Debug, Deserialize)]
|
#[derive(PartialEq, Debug, Deserialize)]
|
||||||
|
#[serde(rename_all = "snake_case")]
|
||||||
pub enum MergeRequestAction {
|
pub enum MergeRequestAction {
|
||||||
#[serde(rename = "open")]
|
Open,
|
||||||
Opened,
|
Close,
|
||||||
#[serde(rename = "close")]
|
Reopen,
|
||||||
Closed,
|
Update,
|
||||||
#[serde(rename = "reopen")]
|
Approve,
|
||||||
Reopened,
|
Unapprove,
|
||||||
#[serde(rename = "update")]
|
|
||||||
Updated,
|
|
||||||
#[serde(rename = "approved")]
|
|
||||||
Approved,
|
|
||||||
#[serde(rename = "unapproved")]
|
|
||||||
Unapproved,
|
|
||||||
#[serde(rename = "merge")]
|
|
||||||
Merged,
|
Merged,
|
||||||
|
Approval,
|
||||||
|
Unapproval,
|
||||||
#[serde(other)]
|
#[serde(other)]
|
||||||
Other,
|
Other,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl MergeRequestAction {
|
impl fmt::Display for MergeRequestAction {
|
||||||
pub fn as_str(&self) -> &str {
|
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
|
||||||
|
write!(
|
||||||
|
f,
|
||||||
|
"{}",
|
||||||
match self {
|
match self {
|
||||||
MergeRequestAction::Opened => "opened",
|
MergeRequestAction::Open => "opened",
|
||||||
MergeRequestAction::Closed => "closed",
|
MergeRequestAction::Close => "closed",
|
||||||
MergeRequestAction::Reopened => "reopened",
|
MergeRequestAction::Reopen => "reopened",
|
||||||
MergeRequestAction::Updated => "updated",
|
MergeRequestAction::Update => "updated",
|
||||||
MergeRequestAction::Approved => "approved",
|
MergeRequestAction::Approve => "approved",
|
||||||
MergeRequestAction::Unapproved => "unapproved",
|
MergeRequestAction::Unapprove => "unapproved",
|
||||||
|
MergeRequestAction::Approval => "approval",
|
||||||
|
MergeRequestAction::Unapproval => "unapproval",
|
||||||
MergeRequestAction::Merged => "merged",
|
MergeRequestAction::Merged => "merged",
|
||||||
MergeRequestAction::Other => "other",
|
MergeRequestAction::Other => "other",
|
||||||
}
|
}
|
||||||
|
)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
#[derive(Debug, Deserialize)]
|
#[derive(Debug, Deserialize)]
|
||||||
pub struct MergeRequestObjectAttributes {
|
pub struct MergeRequestObjectAttributes {
|
||||||
|
pub iid: u64,
|
||||||
pub target_branch: String,
|
pub target_branch: String,
|
||||||
pub source_branch: String,
|
pub source_branch: String,
|
||||||
pub title: String,
|
pub title: String,
|
||||||
@ -83,19 +103,43 @@ pub struct MergeRequestObjectAttributes {
|
|||||||
}
|
}
|
||||||
|
|
||||||
#[derive(PartialEq, Debug, Deserialize)]
|
#[derive(PartialEq, Debug, Deserialize)]
|
||||||
|
#[serde(rename_all = "snake_case")]
|
||||||
pub enum PipelineStatus {
|
pub enum PipelineStatus {
|
||||||
#[serde(rename = "failed")]
|
Created,
|
||||||
|
WaitingForResource,
|
||||||
|
Preparing,
|
||||||
|
Pending,
|
||||||
|
Running,
|
||||||
|
Success,
|
||||||
Failed,
|
Failed,
|
||||||
|
Canceled,
|
||||||
|
Skipped,
|
||||||
|
Manual,
|
||||||
|
Scheduled,
|
||||||
#[serde(other)]
|
#[serde(other)]
|
||||||
Other,
|
Other,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl PipelineStatus {
|
impl fmt::Display for PipelineStatus {
|
||||||
pub fn as_str(&self) -> &str {
|
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
|
||||||
|
write!(
|
||||||
|
f,
|
||||||
|
"{}",
|
||||||
match self {
|
match self {
|
||||||
|
PipelineStatus::Created => "created",
|
||||||
|
PipelineStatus::WaitingForResource => "waiting for resource",
|
||||||
|
PipelineStatus::Preparing => "preparing",
|
||||||
|
PipelineStatus::Pending => "pending",
|
||||||
|
PipelineStatus::Running => "running",
|
||||||
|
PipelineStatus::Success => "succeeded",
|
||||||
PipelineStatus::Failed => "failed",
|
PipelineStatus::Failed => "failed",
|
||||||
|
PipelineStatus::Canceled => "canceled",
|
||||||
|
PipelineStatus::Skipped => "skipped",
|
||||||
|
PipelineStatus::Manual => "manual",
|
||||||
|
PipelineStatus::Scheduled => "scheduled",
|
||||||
PipelineStatus::Other => "other",
|
PipelineStatus::Other => "other",
|
||||||
}
|
}
|
||||||
|
)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -112,6 +156,41 @@ pub struct PipelineMergeRequest {
|
|||||||
pub title: String,
|
pub title: String,
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[derive(PartialEq, Debug, Deserialize)]
|
||||||
|
#[serde(rename_all = "snake_case")]
|
||||||
|
pub enum IssueAction {
|
||||||
|
Open,
|
||||||
|
Close,
|
||||||
|
Reopen,
|
||||||
|
Update,
|
||||||
|
#[serde(other)]
|
||||||
|
Other,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl fmt::Display for IssueAction {
|
||||||
|
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
|
||||||
|
write!(
|
||||||
|
f,
|
||||||
|
"{}",
|
||||||
|
match self {
|
||||||
|
IssueAction::Open => "opened",
|
||||||
|
IssueAction::Close => "closed",
|
||||||
|
IssueAction::Reopen => "reopened",
|
||||||
|
IssueAction::Update => "updated",
|
||||||
|
IssueAction::Other => "other",
|
||||||
|
}
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Debug, Deserialize)]
|
||||||
|
pub struct IssueObjectAttributes {
|
||||||
|
pub iid: u32,
|
||||||
|
pub title: String,
|
||||||
|
pub action: IssueAction,
|
||||||
|
pub url: String,
|
||||||
|
}
|
||||||
|
|
||||||
#[derive(Debug, Deserialize)]
|
#[derive(Debug, Deserialize)]
|
||||||
#[serde(tag = "object_kind")]
|
#[serde(tag = "object_kind")]
|
||||||
pub enum GitlabEvent {
|
pub enum GitlabEvent {
|
||||||
@ -151,6 +230,12 @@ pub enum GitlabEvent {
|
|||||||
commits: Vec<Commit>,
|
commits: Vec<Commit>,
|
||||||
total_commits_count: u64,
|
total_commits_count: u64,
|
||||||
},
|
},
|
||||||
|
#[serde(rename = "issue")]
|
||||||
|
Issue {
|
||||||
|
user: User,
|
||||||
|
project: Project,
|
||||||
|
object_attributes: IssueObjectAttributes,
|
||||||
|
},
|
||||||
#[serde(rename = "merge_request")]
|
#[serde(rename = "merge_request")]
|
||||||
MergeRequest {
|
MergeRequest {
|
||||||
user: User,
|
user: User,
|
||||||
@ -161,95 +246,235 @@ pub enum GitlabEvent {
|
|||||||
#[serde(rename = "pipeline")]
|
#[serde(rename = "pipeline")]
|
||||||
Pipeline {
|
Pipeline {
|
||||||
object_attributes: PipelineObjectAttributes,
|
object_attributes: PipelineObjectAttributes,
|
||||||
merge_request: PipelineMergeRequest,
|
merge_request: Option<PipelineMergeRequest>,
|
||||||
user: User,
|
user: User,
|
||||||
project: Project,
|
project: Project,
|
||||||
},
|
},
|
||||||
|
#[serde(other)]
|
||||||
|
Other,
|
||||||
|
}
|
||||||
|
|
||||||
|
macro_rules! find_publish_event {
|
||||||
|
($cfgs:expr, $case:pat) => {
|
||||||
|
$cfgs.iter().find(|cfg| match cfg {
|
||||||
|
$case => true,
|
||||||
|
_ => false,
|
||||||
|
})
|
||||||
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
impl GitlabEventExt for GitlabEvent {
|
impl GitlabEventExt for GitlabEvent {
|
||||||
fn project(&self) -> &Project {
|
fn should_publish(&self, publish_events: &[PublishEvent]) -> bool {
|
||||||
match self {
|
match self {
|
||||||
GitlabEvent::Push { project, .. } => &project,
|
GitlabEvent::Push { r#ref, .. } => {
|
||||||
GitlabEvent::TagPush { project, .. } => &project,
|
if let Some(PublishEvent::Push { branches }) =
|
||||||
GitlabEvent::MergeRequest { project, .. } => &project,
|
find_publish_event!(publish_events, PublishEvent::Push { .. })
|
||||||
GitlabEvent::Pipeline { project, .. } => &project,
|
{
|
||||||
|
match branches {
|
||||||
|
None => true,
|
||||||
|
Some(branches) => {
|
||||||
|
let refname = parse_ref(r#ref);
|
||||||
|
branches.iter().any(|branch| branch.find(&refname).is_some())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
GitlabEvent::TagPush { .. } => find_publish_event!(publish_events, PublishEvent::TagPush { .. }).is_some(),
|
||||||
|
GitlabEvent::Issue { object_attributes, .. } => {
|
||||||
|
if let Some(PublishEvent::Issues { actions }) =
|
||||||
|
find_publish_event!(publish_events, PublishEvent::Issues { .. })
|
||||||
|
{
|
||||||
|
match actions {
|
||||||
|
None => true,
|
||||||
|
Some(actions) => actions.contains(&object_attributes.action),
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
GitlabEvent::MergeRequest { object_attributes, .. } => {
|
||||||
|
if let Some(PublishEvent::MergeRequest { actions }) =
|
||||||
|
find_publish_event!(publish_events, PublishEvent::MergeRequest { .. })
|
||||||
|
{
|
||||||
|
match actions {
|
||||||
|
None => true,
|
||||||
|
Some(actions) => actions.contains(&object_attributes.action),
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
GitlabEvent::Pipeline { object_attributes, .. } => {
|
||||||
|
if let Some(PublishEvent::Pipeline { statuses }) =
|
||||||
|
find_publish_event!(publish_events, PublishEvent::Pipeline { .. })
|
||||||
|
{
|
||||||
|
match statuses {
|
||||||
|
None => true,
|
||||||
|
Some(statuses) => statuses.contains(&object_attributes.status),
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
GitlabEvent::Other => false,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
fn r#ref(&self) -> &str {
|
fn project(&self) -> &Project {
|
||||||
match self {
|
match self {
|
||||||
GitlabEvent::Push { r#ref, .. } => &r#ref,
|
GitlabEvent::Push { project, .. } => project,
|
||||||
GitlabEvent::TagPush { r#ref, .. } => &r#ref,
|
GitlabEvent::TagPush { project, .. } => project,
|
||||||
GitlabEvent::MergeRequest { object_attributes, .. } => &object_attributes.target_branch,
|
GitlabEvent::Issue { project, .. } => project,
|
||||||
GitlabEvent::Pipeline { object_attributes, .. } => &object_attributes.r#ref,
|
GitlabEvent::MergeRequest { project, .. } => project,
|
||||||
|
GitlabEvent::Pipeline { project, .. } => project,
|
||||||
|
GitlabEvent::Other => unreachable!("Unsupported event type"),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn r#ref(&self) -> Option<&str> {
|
||||||
|
match self {
|
||||||
|
GitlabEvent::Push { r#ref, .. } => Some(r#ref),
|
||||||
|
GitlabEvent::TagPush { r#ref, .. } => Some(r#ref),
|
||||||
|
GitlabEvent::Issue { .. } => None,
|
||||||
|
GitlabEvent::MergeRequest { object_attributes, .. } => Some(&object_attributes.target_branch),
|
||||||
|
GitlabEvent::Pipeline { object_attributes, .. } => Some(&object_attributes.r#ref),
|
||||||
|
GitlabEvent::Other => unreachable!("Unsupported event type"),
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
fn user(&self) -> &str {
|
fn user(&self) -> &str {
|
||||||
match self {
|
match self {
|
||||||
GitlabEvent::Push { user_name, .. } => &user_name,
|
GitlabEvent::Push { user_name, .. } => user_name,
|
||||||
GitlabEvent::TagPush { user_name, .. } => &user_name,
|
GitlabEvent::TagPush { user_name, .. } => user_name,
|
||||||
|
GitlabEvent::Issue { user, .. } => &user.name,
|
||||||
GitlabEvent::MergeRequest { user, .. } => &user.name,
|
GitlabEvent::MergeRequest { user, .. } => &user.name,
|
||||||
GitlabEvent::Pipeline { user, .. } => &user.name,
|
GitlabEvent::Pipeline { user, .. } => &user.name,
|
||||||
|
GitlabEvent::Other => unreachable!("Unsupported event type"),
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
fn url(&self) -> String {
|
fn titles(&self) -> Vec<String> {
|
||||||
let url = match self {
|
fn find_commit<'a>(commits: &'a [Commit], sha: &str) -> Option<&'a Commit> {
|
||||||
GitlabEvent::Push { after, project, .. } => format!("{}/-/commits/{}", project.web_url, after),
|
|
||||||
GitlabEvent::TagPush {
|
|
||||||
r#ref,
|
|
||||||
checkout_sha,
|
|
||||||
project,
|
|
||||||
..
|
|
||||||
} => {
|
|
||||||
let refname = r#ref.split('/').into_iter().last().unwrap_or(checkout_sha);
|
|
||||||
format!("{}/-/tags/{}", project.web_url, refname)
|
|
||||||
}
|
|
||||||
GitlabEvent::MergeRequest { object_attributes, .. } => object_attributes.url.clone(),
|
|
||||||
GitlabEvent::Pipeline { object_attributes, .. } => object_attributes.url.clone(),
|
|
||||||
};
|
|
||||||
|
|
||||||
url.replace("http://", "https://").to_string()
|
|
||||||
}
|
|
||||||
|
|
||||||
fn title(&self) -> String {
|
|
||||||
fn find_commit<'a>(commits: &'a Vec<Commit>, sha: &str) -> Option<&'a Commit> {
|
|
||||||
commits.iter().find(|commit| commit.id == sha)
|
commits.iter().find(|commit| commit.id == sha)
|
||||||
}
|
}
|
||||||
|
|
||||||
match self {
|
match self {
|
||||||
GitlabEvent::Push { after, commits, .. } => find_commit(commits, &after)
|
GitlabEvent::Push {
|
||||||
.map(|commit| commit.title.clone())
|
after,
|
||||||
.unwrap_or_else(|| "New commit(s) pushed".to_string()),
|
project,
|
||||||
|
commits,
|
||||||
|
..
|
||||||
|
} => {
|
||||||
|
const MAX_COMMITS: usize = 15; // TODO: make configurable
|
||||||
|
commits.iter().fold(Vec::new(), |mut titles, commit| {
|
||||||
|
if titles.len() < MAX_COMMITS {
|
||||||
|
titles.push(format!("[**pushed** {}]({})", commit.title, commit.url));
|
||||||
|
|
||||||
|
if titles.len() == MAX_COMMITS {
|
||||||
|
titles.push(format!(
|
||||||
|
"[**pushed** {} more commits]({}/-/compare/{}...{})",
|
||||||
|
commits.len() - MAX_COMMITS,
|
||||||
|
project.web_url,
|
||||||
|
commit.id,
|
||||||
|
after
|
||||||
|
));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
titles
|
||||||
|
})
|
||||||
|
}
|
||||||
GitlabEvent::TagPush {
|
GitlabEvent::TagPush {
|
||||||
checkout_sha, commits, ..
|
r#ref,
|
||||||
} => find_commit(commits, &checkout_sha)
|
checkout_sha,
|
||||||
.map(|commit| commit.title.clone())
|
project,
|
||||||
.unwrap_or_else(|| "New tag pushed".to_string()),
|
commits,
|
||||||
|
..
|
||||||
|
} => {
|
||||||
|
let title = format!(
|
||||||
|
"**tagged** {}",
|
||||||
|
find_commit(commits, checkout_sha)
|
||||||
|
.map(|commit| &commit.title)
|
||||||
|
.unwrap_or(checkout_sha)
|
||||||
|
);
|
||||||
|
let url = format!("{}/-/tags/{}", project.web_url, parse_ref(r#ref));
|
||||||
|
vec![markdown_link(&title, &url)]
|
||||||
|
}
|
||||||
|
GitlabEvent::Issue { object_attributes, .. } => {
|
||||||
|
if object_attributes.action != IssueAction::Other {
|
||||||
|
let title = format!(
|
||||||
|
"Issue #{} **{}**: {}",
|
||||||
|
object_attributes.iid, object_attributes.action, object_attributes.title
|
||||||
|
);
|
||||||
|
vec![markdown_link(&title, &object_attributes.url)]
|
||||||
|
} else {
|
||||||
|
vec![]
|
||||||
|
}
|
||||||
|
}
|
||||||
GitlabEvent::MergeRequest { object_attributes, .. } => {
|
GitlabEvent::MergeRequest { object_attributes, .. } => {
|
||||||
format!("MR {}: {}", object_attributes.action.as_str(), object_attributes.title)
|
if object_attributes.action != MergeRequestAction::Other {
|
||||||
|
let title = format!(
|
||||||
|
"MR !{} **{}**: {}",
|
||||||
|
object_attributes.iid, object_attributes.action, object_attributes.title
|
||||||
|
);
|
||||||
|
vec![markdown_link(&title, &object_attributes.url)]
|
||||||
|
} else {
|
||||||
|
vec![]
|
||||||
|
}
|
||||||
}
|
}
|
||||||
GitlabEvent::Pipeline {
|
GitlabEvent::Pipeline {
|
||||||
object_attributes,
|
object_attributes,
|
||||||
merge_request,
|
merge_request,
|
||||||
..
|
..
|
||||||
} => {
|
} => {
|
||||||
let title = object_attributes.name.as_ref().unwrap_or(&merge_request.title);
|
if object_attributes.status != PipelineStatus::Other {
|
||||||
format!("Pipeline {}: {}", object_attributes.status.as_str(), title)
|
let title = object_attributes
|
||||||
|
.name
|
||||||
|
.as_ref()
|
||||||
|
.cloned()
|
||||||
|
.or(merge_request.as_ref().map(|mr| mr.title.clone()))
|
||||||
|
.iter()
|
||||||
|
.fold(format!("Pipeline **{}**", object_attributes.status), |accum, title| {
|
||||||
|
format!("{}: {}", accum, title)
|
||||||
|
});
|
||||||
|
vec![markdown_link(&title, &object_attributes.url)]
|
||||||
|
} else {
|
||||||
|
vec![]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
GitlabEvent::Other => unreachable!("Unsupported event type"),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
|
fn markdown_link(title: &String, url: &String) -> String {
|
||||||
|
format!("[{}]({})", title, url)
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn parse_ref(r#ref: &str) -> String {
|
||||||
|
if r#ref.starts_with("refs/") {
|
||||||
|
let parts = r#ref.split('/').collect::<Vec<_>>();
|
||||||
|
if parts.len() > 2 {
|
||||||
|
parts.into_iter().skip(2).collect::<Vec<_>>().join("/").to_string()
|
||||||
|
} else {
|
||||||
|
r#ref.to_string()
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
r#ref.to_string()
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
#[cfg(test)]
|
#[cfg(test)]
|
||||||
mod test {
|
mod test {
|
||||||
use super::*;
|
use super::*;
|
||||||
|
use regex::Regex;
|
||||||
use std::{fs::File, io::BufReader};
|
use std::{fs::File, io::BufReader};
|
||||||
|
|
||||||
fn load_test_data(name: &str) -> anyhow::Result<GitlabEvent> {
|
fn load_test_data(name: &str) -> anyhow::Result<GitlabEvent> {
|
||||||
let f = File::open(&format!("{}/test-data/{}.json", env!("CARGO_MANIFEST_DIR"), name))?;
|
let f = File::open(format!("{}/test-data/{}.json", env!("CARGO_MANIFEST_DIR"), name))?;
|
||||||
let r = BufReader::new(f);
|
let r = BufReader::new(f);
|
||||||
let event: GitlabEvent = serde_json::from_reader(r)?;
|
let event: GitlabEvent = serde_json::from_reader(r)?;
|
||||||
Ok(event)
|
Ok(event)
|
||||||
@ -259,7 +484,7 @@ mod test {
|
|||||||
pub fn parse_push_event() -> anyhow::Result<()> {
|
pub fn parse_push_event() -> anyhow::Result<()> {
|
||||||
let event = load_test_data("push-event")?;
|
let event = load_test_data("push-event")?;
|
||||||
|
|
||||||
match event {
|
match &event {
|
||||||
GitlabEvent::Push {
|
GitlabEvent::Push {
|
||||||
event_name,
|
event_name,
|
||||||
before,
|
before,
|
||||||
@ -282,11 +507,32 @@ mod test {
|
|||||||
assert_eq!(project.namespace, "Mike");
|
assert_eq!(project.namespace, "Mike");
|
||||||
assert_eq!(repository.name, "Diaspora");
|
assert_eq!(repository.name, "Diaspora");
|
||||||
assert_eq!(repository.url, "git@example.com:mike/diaspora.git");
|
assert_eq!(repository.url, "git@example.com:mike/diaspora.git");
|
||||||
assert_eq!(total_commits_count, 4);
|
assert_eq!(*total_commits_count, 4);
|
||||||
}
|
}
|
||||||
_ => panic!("not a push event"),
|
_ => panic!("not a push event"),
|
||||||
};
|
};
|
||||||
|
|
||||||
|
let publish_events = vec![PublishEvent::Push { branches: None }];
|
||||||
|
assert!(event.should_publish(&publish_events));
|
||||||
|
|
||||||
|
let publish_events = vec![PublishEvent::Push {
|
||||||
|
branches: Some(vec![Regex::new(r"^master$").unwrap()]),
|
||||||
|
}];
|
||||||
|
assert!(event.should_publish(&publish_events));
|
||||||
|
|
||||||
|
let publish_events = vec![PublishEvent::Push {
|
||||||
|
branches: Some(vec![Regex::new(r"^mas").unwrap()]),
|
||||||
|
}];
|
||||||
|
assert!(event.should_publish(&publish_events));
|
||||||
|
|
||||||
|
let publish_events = vec![PublishEvent::Push {
|
||||||
|
branches: Some(vec![Regex::new(r"^foobar$").unwrap()]),
|
||||||
|
}];
|
||||||
|
assert!(!event.should_publish(&publish_events));
|
||||||
|
|
||||||
|
let publish_events = vec![PublishEvent::Pipeline { statuses: None }];
|
||||||
|
assert!(!event.should_publish(&publish_events));
|
||||||
|
|
||||||
Ok(())
|
Ok(())
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -294,7 +540,7 @@ mod test {
|
|||||||
pub fn parse_tag_push_event() -> anyhow::Result<()> {
|
pub fn parse_tag_push_event() -> anyhow::Result<()> {
|
||||||
let event = load_test_data("tag-push-event")?;
|
let event = load_test_data("tag-push-event")?;
|
||||||
|
|
||||||
match event {
|
match &event {
|
||||||
GitlabEvent::TagPush {
|
GitlabEvent::TagPush {
|
||||||
event_name,
|
event_name,
|
||||||
before,
|
before,
|
||||||
@ -316,11 +562,53 @@ mod test {
|
|||||||
assert_eq!(project.name, "Example");
|
assert_eq!(project.name, "Example");
|
||||||
assert_eq!(project.namespace, "Jsmith");
|
assert_eq!(project.namespace, "Jsmith");
|
||||||
assert_eq!(repository.name, "Example");
|
assert_eq!(repository.name, "Example");
|
||||||
assert_eq!(total_commits_count, 0);
|
assert_eq!(*total_commits_count, 0);
|
||||||
}
|
}
|
||||||
_ => panic!("not a tag push event"),
|
_ => panic!("not a tag push event"),
|
||||||
};
|
};
|
||||||
|
|
||||||
|
let publish_events = vec![PublishEvent::TagPush];
|
||||||
|
assert!(event.should_publish(&publish_events));
|
||||||
|
|
||||||
|
let publish_events = vec![PublishEvent::Push { branches: None }];
|
||||||
|
assert!(!event.should_publish(&publish_events));
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
pub fn parse_issue_event() -> anyhow::Result<()> {
|
||||||
|
let event = load_test_data("issue-event")?;
|
||||||
|
|
||||||
|
match &event {
|
||||||
|
GitlabEvent::Issue {
|
||||||
|
user,
|
||||||
|
object_attributes,
|
||||||
|
..
|
||||||
|
} => {
|
||||||
|
assert_eq!(user.name, "Administrator");
|
||||||
|
assert_eq!(object_attributes.iid, 23);
|
||||||
|
assert_eq!(object_attributes.action, IssueAction::Open);
|
||||||
|
}
|
||||||
|
_ => panic!("not an issue event"),
|
||||||
|
}
|
||||||
|
|
||||||
|
let publish_events = vec![PublishEvent::Issues { actions: None }];
|
||||||
|
assert!(event.should_publish(&publish_events));
|
||||||
|
|
||||||
|
let publish_events = vec![PublishEvent::Issues {
|
||||||
|
actions: Some(vec![IssueAction::Open]),
|
||||||
|
}];
|
||||||
|
assert!(event.should_publish(&publish_events));
|
||||||
|
|
||||||
|
let publish_events = vec![PublishEvent::Issues {
|
||||||
|
actions: Some(vec![IssueAction::Close]),
|
||||||
|
}];
|
||||||
|
assert!(!event.should_publish(&publish_events));
|
||||||
|
|
||||||
|
let publish_events = vec![PublishEvent::Push { branches: None }];
|
||||||
|
assert!(!event.should_publish(&publish_events));
|
||||||
|
|
||||||
Ok(())
|
Ok(())
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -328,19 +616,35 @@ mod test {
|
|||||||
pub fn parse_merge_request_event() -> anyhow::Result<()> {
|
pub fn parse_merge_request_event() -> anyhow::Result<()> {
|
||||||
let event = load_test_data("merge-request-event")?;
|
let event = load_test_data("merge-request-event")?;
|
||||||
|
|
||||||
match event {
|
match &event {
|
||||||
GitlabEvent::MergeRequest {
|
GitlabEvent::MergeRequest {
|
||||||
user,
|
user,
|
||||||
object_attributes,
|
object_attributes,
|
||||||
..
|
..
|
||||||
} => {
|
} => {
|
||||||
assert_eq!(user.name, "Administrator");
|
assert_eq!(user.name, "Administrator");
|
||||||
assert_eq!(object_attributes.action, MergeRequestAction::Opened);
|
assert_eq!(object_attributes.action, MergeRequestAction::Open);
|
||||||
assert_eq!(object_attributes.title, "MS-Viewport");
|
assert_eq!(object_attributes.title, "MS-Viewport");
|
||||||
}
|
}
|
||||||
_ => panic!("not a merge request event"),
|
_ => panic!("not a merge request event"),
|
||||||
};
|
};
|
||||||
|
|
||||||
|
let publish_events = vec![PublishEvent::MergeRequest { actions: None }];
|
||||||
|
assert!(event.should_publish(&publish_events));
|
||||||
|
|
||||||
|
let publish_events = vec![PublishEvent::MergeRequest {
|
||||||
|
actions: Some(vec![MergeRequestAction::Open]),
|
||||||
|
}];
|
||||||
|
assert!(event.should_publish(&publish_events));
|
||||||
|
|
||||||
|
let publish_events = vec![PublishEvent::MergeRequest {
|
||||||
|
actions: Some(vec![MergeRequestAction::Close]),
|
||||||
|
}];
|
||||||
|
assert!(!event.should_publish(&publish_events));
|
||||||
|
|
||||||
|
let publish_events = vec![PublishEvent::Push { branches: None }];
|
||||||
|
assert!(!event.should_publish(&publish_events));
|
||||||
|
|
||||||
Ok(())
|
Ok(())
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -348,7 +652,7 @@ mod test {
|
|||||||
pub fn parse_pipeline_event() -> anyhow::Result<()> {
|
pub fn parse_pipeline_event() -> anyhow::Result<()> {
|
||||||
let event = load_test_data("pipeline-event")?;
|
let event = load_test_data("pipeline-event")?;
|
||||||
|
|
||||||
match event {
|
match &event {
|
||||||
GitlabEvent::Pipeline {
|
GitlabEvent::Pipeline {
|
||||||
object_attributes,
|
object_attributes,
|
||||||
merge_request,
|
merge_request,
|
||||||
@ -358,12 +662,28 @@ mod test {
|
|||||||
assert_eq!(object_attributes.name, Some("Pipeline for branch: master".to_string()));
|
assert_eq!(object_attributes.name, Some("Pipeline for branch: master".to_string()));
|
||||||
assert_eq!(object_attributes.r#ref, "master");
|
assert_eq!(object_attributes.r#ref, "master");
|
||||||
assert_eq!(object_attributes.status, PipelineStatus::Failed);
|
assert_eq!(object_attributes.status, PipelineStatus::Failed);
|
||||||
assert_eq!(merge_request.title, "Test");
|
assert_eq!(merge_request.as_ref().unwrap().title, "Test");
|
||||||
assert_eq!(user.name, "Administrator");
|
assert_eq!(user.name, "Administrator");
|
||||||
}
|
}
|
||||||
_ => panic!("not a pipeline event"),
|
_ => panic!("not a pipeline event"),
|
||||||
};
|
};
|
||||||
|
|
||||||
|
let publish_events = vec![PublishEvent::Pipeline { statuses: None }];
|
||||||
|
assert!(event.should_publish(&publish_events));
|
||||||
|
|
||||||
|
let publish_events = vec![PublishEvent::Pipeline {
|
||||||
|
statuses: Some(vec![PipelineStatus::Failed]),
|
||||||
|
}];
|
||||||
|
assert!(event.should_publish(&publish_events));
|
||||||
|
|
||||||
|
let publish_events = vec![PublishEvent::Pipeline {
|
||||||
|
statuses: Some(vec![PipelineStatus::Success]),
|
||||||
|
}];
|
||||||
|
assert!(!event.should_publish(&publish_events));
|
||||||
|
|
||||||
|
let publish_events = vec![PublishEvent::Push { branches: None }];
|
||||||
|
assert!(!event.should_publish(&publish_events));
|
||||||
|
|
||||||
Ok(())
|
Ok(())
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
113
src/main.rs
113
src/main.rs
@ -1,3 +1,19 @@
|
|||||||
|
// bebot
|
||||||
|
// Copyright (C) 2023 Brian Tarricone <brian@tarricone.org>
|
||||||
|
//
|
||||||
|
// 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.
|
||||||
|
//
|
||||||
|
// This program 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 this program. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
#[macro_use(anyhow)]
|
#[macro_use(anyhow)]
|
||||||
extern crate anyhow;
|
extern crate anyhow;
|
||||||
#[macro_use]
|
#[macro_use]
|
||||||
@ -20,10 +36,9 @@ use matrix_sdk::{
|
|||||||
ruma::{events::room::message::RoomMessageEventContent, OwnedRoomOrAliasId},
|
ruma::{events::room::message::RoomMessageEventContent, OwnedRoomOrAliasId},
|
||||||
BaseRoom, Client,
|
BaseRoom, Client,
|
||||||
};
|
};
|
||||||
|
use tokio::sync::mpsc;
|
||||||
use warp::Filter;
|
use warp::Filter;
|
||||||
|
|
||||||
use crate::event::{MergeRequestAction, PipelineStatus};
|
|
||||||
|
|
||||||
async fn build_sync_settings(matrix_client: &Client) -> SyncSettings {
|
async fn build_sync_settings(matrix_client: &Client) -> SyncSettings {
|
||||||
let mut settings = SyncSettings::default().timeout(Duration::from_secs(30));
|
let mut settings = SyncSettings::default().timeout(Duration::from_secs(30));
|
||||||
if let Some(token) = matrix_client.sync_token().await {
|
if let Some(token) = matrix_client.sync_token().await {
|
||||||
@ -68,58 +83,56 @@ async fn ensure_matrix_room_joined(matrix_client: &Client, room_id: &OwnedRoomOr
|
|||||||
|| a_room
|
|| a_room
|
||||||
.canonical_alias()
|
.canonical_alias()
|
||||||
.iter()
|
.iter()
|
||||||
.find(|alias| alias.as_str() == our_room_str)
|
.any(|alias| alias.as_str() == our_room_str)
|
||||||
.is_some()
|
|| a_room.alt_aliases().iter().any(|alias| alias.as_str() == our_room_str)
|
||||||
|| a_room
|
|
||||||
.alt_aliases()
|
|
||||||
.iter()
|
|
||||||
.find(|alias| alias.as_str() == our_room_str)
|
|
||||||
.is_some()
|
|
||||||
}
|
}
|
||||||
|
|
||||||
let mut room = matrix_client
|
let mut room = matrix_client
|
||||||
.joined_rooms()
|
.joined_rooms()
|
||||||
.iter()
|
.iter()
|
||||||
.find(|a_room| room_matches(*a_room, room_id))
|
.find(|a_room| room_matches(a_room, room_id))
|
||||||
.map(|room| room.clone());
|
.cloned();
|
||||||
if room.is_none() {
|
if room.is_none() {
|
||||||
if let Some(invited) = matrix_client
|
if let Some(invited) = matrix_client
|
||||||
.invited_rooms()
|
.invited_rooms()
|
||||||
.iter()
|
.iter()
|
||||||
.find(|a_room| room_matches(*a_room, room_id))
|
.find(|a_room| room_matches(a_room, room_id))
|
||||||
{
|
{
|
||||||
invited.accept_invitation().await?;
|
invited.accept_invitation().await?;
|
||||||
} else {
|
} else {
|
||||||
matrix_client.join_room_by_id_or_alias(room_id, &[]).await?;
|
matrix_client.join_room_by_id_or_alias(room_id, &[]).await?;
|
||||||
}
|
}
|
||||||
let settings = build_sync_settings(&matrix_client).await;
|
let settings = build_sync_settings(matrix_client).await;
|
||||||
matrix_client.sync_once(settings).await?;
|
matrix_client.sync_once(settings).await?;
|
||||||
room = matrix_client
|
room = matrix_client
|
||||||
.joined_rooms()
|
.joined_rooms()
|
||||||
.iter()
|
.iter()
|
||||||
.find(|a_room| room_matches(*a_room, room_id))
|
.find(|a_room| room_matches(a_room, room_id))
|
||||||
.map(|room| room.clone());
|
.cloned();
|
||||||
}
|
}
|
||||||
|
|
||||||
room.ok_or_else(|| anyhow!("Unable to join room {}", room_id))
|
room.ok_or_else(|| anyhow!("Unable to join room {}", room_id))
|
||||||
}
|
}
|
||||||
|
|
||||||
fn build_gitlab_message(event: &GitlabEvent) -> String {
|
fn build_gitlab_messages(event: &GitlabEvent) -> Vec<String> {
|
||||||
let project = event.project();
|
let project = event.project();
|
||||||
let refname = event
|
let refname = event.r#ref().map(event::parse_ref);
|
||||||
.r#ref()
|
event
|
||||||
.split('/')
|
.titles()
|
||||||
.last()
|
.iter()
|
||||||
.unwrap_or_else(|| event.r#ref())
|
.map(|title| {
|
||||||
.to_string();
|
|
||||||
format!(
|
format!(
|
||||||
"*{}* {} **{}** [{}]({})",
|
"\\[{}\\] {}*{}* {}",
|
||||||
project.path_with_namespace,
|
project.path_with_namespace,
|
||||||
refname,
|
refname
|
||||||
|
.as_ref()
|
||||||
|
.map(|rn| format!("`{}` ", rn))
|
||||||
|
.unwrap_or_else(|| "".to_string()),
|
||||||
event.user(),
|
event.user(),
|
||||||
event.title(),
|
title,
|
||||||
event.url()
|
|
||||||
)
|
)
|
||||||
|
})
|
||||||
|
.collect()
|
||||||
}
|
}
|
||||||
|
|
||||||
async fn handle_gitlab_event(
|
async fn handle_gitlab_event(
|
||||||
@ -127,21 +140,12 @@ async fn handle_gitlab_event(
|
|||||||
room_id: &OwnedRoomOrAliasId,
|
room_id: &OwnedRoomOrAliasId,
|
||||||
matrix_client: &Client,
|
matrix_client: &Client,
|
||||||
) -> anyhow::Result<()> {
|
) -> anyhow::Result<()> {
|
||||||
if let GitlabEvent::MergeRequest { object_attributes, .. } = &event {
|
|
||||||
if object_attributes.action == MergeRequestAction::Other {
|
|
||||||
return Ok(());
|
|
||||||
}
|
|
||||||
} else if let GitlabEvent::Pipeline { object_attributes, .. } = &event {
|
|
||||||
if object_attributes.status == PipelineStatus::Other {
|
|
||||||
return Ok(());
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
let room = ensure_matrix_room_joined(matrix_client, room_id).await?;
|
let room = ensure_matrix_room_joined(matrix_client, room_id).await?;
|
||||||
let msg = build_gitlab_message(&event);
|
for msg in build_gitlab_messages(&event) {
|
||||||
debug!("Sending message to {}: {}", room_id, msg);
|
debug!("Sending message to {}: {}", room_id, msg);
|
||||||
let msg_content = RoomMessageEventContent::text_markdown(&msg);
|
let msg_content = RoomMessageEventContent::text_markdown(&msg);
|
||||||
room.send(msg_content, None).await?;
|
room.send(msg_content, None).await?;
|
||||||
|
}
|
||||||
Ok(())
|
Ok(())
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -153,7 +157,7 @@ async fn run() -> anyhow::Result<()> {
|
|||||||
let addr = config
|
let addr = config
|
||||||
.bind_address
|
.bind_address
|
||||||
.as_ref()
|
.as_ref()
|
||||||
.map(|ba| ba.clone())
|
.cloned()
|
||||||
.unwrap_or_else(|| "127.0.0.1".to_string())
|
.unwrap_or_else(|| "127.0.0.1".to_string())
|
||||||
.parse::<IpAddr>()
|
.parse::<IpAddr>()
|
||||||
.context("Failed to parse bind_address")?;
|
.context("Failed to parse bind_address")?;
|
||||||
@ -161,6 +165,15 @@ async fn run() -> anyhow::Result<()> {
|
|||||||
|
|
||||||
let matrix_client = matrix_connect(&config).await.context("Failed to connect to Matrix")?;
|
let matrix_client = matrix_connect(&config).await.context("Failed to connect to Matrix")?;
|
||||||
|
|
||||||
|
let (event_tx, mut event_rx) = mpsc::channel::<(GitlabEvent, OwnedRoomOrAliasId)>(100);
|
||||||
|
tokio::spawn(async move {
|
||||||
|
while let Some((event, room)) = event_rx.recv().await {
|
||||||
|
if let Err(err) = handle_gitlab_event(event, &room, &matrix_client).await {
|
||||||
|
warn!("Failed to handle payload: {}", err);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
let gitlab_root_path = if let Some(url_prefix) = config.url_prefix.as_ref() {
|
let gitlab_root_path = if let Some(url_prefix) = config.url_prefix.as_ref() {
|
||||||
url_prefix.split('/').fold(warp::any().boxed(), |last, segment| {
|
url_prefix.split('/').fold(warp::any().boxed(), |last, segment| {
|
||||||
if segment.is_empty() {
|
if segment.is_empty() {
|
||||||
@ -180,9 +193,14 @@ async fn run() -> anyhow::Result<()> {
|
|||||||
.and(warp::body::json())
|
.and(warp::body::json())
|
||||||
.then(move |token: String, event: event::GitlabEvent| {
|
.then(move |token: String, event: event::GitlabEvent| {
|
||||||
let config = Arc::clone(&config);
|
let config = Arc::clone(&config);
|
||||||
let matrix_client = matrix_client.clone();
|
let event_tx = event_tx.clone();
|
||||||
|
|
||||||
async move {
|
async move {
|
||||||
|
match event {
|
||||||
|
GitlabEvent::Other => {
|
||||||
|
warp::reply::with_status("Unsupported Gitlab event type", StatusCode::BAD_REQUEST)
|
||||||
|
}
|
||||||
|
_ => {
|
||||||
let project = event.project();
|
let project = event.project();
|
||||||
let config_key = project.web_url.replace("http://", "").replace("https://", "");
|
let config_key = project.web_url.replace("http://", "").replace("https://", "");
|
||||||
if let Some(repo_config) = config.repo_configs.get(&config_key) {
|
if let Some(repo_config) = config.repo_configs.get(&config_key) {
|
||||||
@ -192,13 +210,22 @@ async fn run() -> anyhow::Result<()> {
|
|||||||
} else {
|
} else {
|
||||||
debug!("payload: {:?}", event);
|
debug!("payload: {:?}", event);
|
||||||
if let Some(room) = repo_config.room.as_ref().or(config.default_room.as_ref()) {
|
if let Some(room) = repo_config.room.as_ref().or(config.default_room.as_ref()) {
|
||||||
if let Err(err) = handle_gitlab_event(event, &room, &matrix_client).await {
|
let publish_events = repo_config
|
||||||
warn!("Failed to handle payload: {}", err);
|
.publish_events
|
||||||
|
.as_ref()
|
||||||
|
.or(config.default_publish_events.as_ref());
|
||||||
|
if publish_events.map(|ecs| event.should_publish(ecs)).unwrap_or(true) {
|
||||||
|
if let Err(err) = event_tx.send((event, room.clone())).await {
|
||||||
|
warn!("Failed to enqueue payload: {}", err);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
warp::reply::with_status("OK", StatusCode::OK)
|
warp::reply::with_status("OK", StatusCode::OK)
|
||||||
} else {
|
} else {
|
||||||
info!("Channel not configured for repo '{}'", config_key);
|
info!("Channel not configured for repo '{}'", config_key);
|
||||||
warp::reply::with_status("Matrix room not configured for repo", StatusCode::NOT_FOUND)
|
warp::reply::with_status(
|
||||||
|
"Matrix room not configured for repo",
|
||||||
|
StatusCode::NOT_FOUND,
|
||||||
|
)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
} else {
|
} else {
|
||||||
@ -206,6 +233,8 @@ async fn run() -> anyhow::Result<()> {
|
|||||||
warp::reply::with_status("Repo not configured", StatusCode::NOT_FOUND)
|
warp::reply::with_status("Repo not configured", StatusCode::NOT_FOUND)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
let routes = gitlab.with(warp::log("bebot"));
|
let routes = gitlab.with(warp::log("bebot"));
|
||||||
|
145
test-data/issue-event.json
Normal file
145
test-data/issue-event.json
Normal file
@ -0,0 +1,145 @@
|
|||||||
|
{
|
||||||
|
"object_kind": "issue",
|
||||||
|
"event_type": "issue",
|
||||||
|
"user": {
|
||||||
|
"id": 1,
|
||||||
|
"name": "Administrator",
|
||||||
|
"username": "root",
|
||||||
|
"avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=40\u0026d=identicon",
|
||||||
|
"email": "admin@example.com"
|
||||||
|
},
|
||||||
|
"project": {
|
||||||
|
"id": 1,
|
||||||
|
"name":"Gitlab Test",
|
||||||
|
"description":"Aut reprehenderit ut est.",
|
||||||
|
"web_url":"http://example.com/gitlabhq/gitlab-test",
|
||||||
|
"avatar_url":null,
|
||||||
|
"git_ssh_url":"git@example.com:gitlabhq/gitlab-test.git",
|
||||||
|
"git_http_url":"http://example.com/gitlabhq/gitlab-test.git",
|
||||||
|
"namespace":"GitlabHQ",
|
||||||
|
"visibility_level":20,
|
||||||
|
"path_with_namespace":"gitlabhq/gitlab-test",
|
||||||
|
"default_branch":"master",
|
||||||
|
"ci_config_path": null,
|
||||||
|
"homepage":"http://example.com/gitlabhq/gitlab-test",
|
||||||
|
"url":"http://example.com/gitlabhq/gitlab-test.git",
|
||||||
|
"ssh_url":"git@example.com:gitlabhq/gitlab-test.git",
|
||||||
|
"http_url":"http://example.com/gitlabhq/gitlab-test.git"
|
||||||
|
},
|
||||||
|
"object_attributes": {
|
||||||
|
"id": 301,
|
||||||
|
"title": "New API: create/update/delete file",
|
||||||
|
"assignee_ids": [51],
|
||||||
|
"assignee_id": 51,
|
||||||
|
"author_id": 51,
|
||||||
|
"project_id": 14,
|
||||||
|
"created_at": "2013-12-03T17:15:43Z",
|
||||||
|
"updated_at": "2013-12-03T17:15:43Z",
|
||||||
|
"updated_by_id": 1,
|
||||||
|
"last_edited_at": null,
|
||||||
|
"last_edited_by_id": null,
|
||||||
|
"relative_position": 0,
|
||||||
|
"description": "Create new API for manipulations with repository",
|
||||||
|
"milestone_id": null,
|
||||||
|
"state_id": 1,
|
||||||
|
"confidential": false,
|
||||||
|
"discussion_locked": true,
|
||||||
|
"due_date": null,
|
||||||
|
"moved_to_id": null,
|
||||||
|
"duplicated_to_id": null,
|
||||||
|
"time_estimate": 0,
|
||||||
|
"total_time_spent": 0,
|
||||||
|
"time_change": 0,
|
||||||
|
"human_total_time_spent": null,
|
||||||
|
"human_time_estimate": null,
|
||||||
|
"human_time_change": null,
|
||||||
|
"weight": null,
|
||||||
|
"health_status": "at_risk",
|
||||||
|
"iid": 23,
|
||||||
|
"url": "http://example.com/diaspora/issues/23",
|
||||||
|
"state": "opened",
|
||||||
|
"action": "open",
|
||||||
|
"severity": "high",
|
||||||
|
"escalation_status": "triggered",
|
||||||
|
"escalation_policy": {
|
||||||
|
"id": 18,
|
||||||
|
"name": "Engineering On-call"
|
||||||
|
},
|
||||||
|
"labels": [{
|
||||||
|
"id": 206,
|
||||||
|
"title": "API",
|
||||||
|
"color": "#ffffff",
|
||||||
|
"project_id": 14,
|
||||||
|
"created_at": "2013-12-03T17:15:43Z",
|
||||||
|
"updated_at": "2013-12-03T17:15:43Z",
|
||||||
|
"template": false,
|
||||||
|
"description": "API related issues",
|
||||||
|
"type": "ProjectLabel",
|
||||||
|
"group_id": 41
|
||||||
|
}]
|
||||||
|
},
|
||||||
|
"repository": {
|
||||||
|
"name": "Gitlab Test",
|
||||||
|
"url": "http://example.com/gitlabhq/gitlab-test.git",
|
||||||
|
"description": "Aut reprehenderit ut est.",
|
||||||
|
"homepage": "http://example.com/gitlabhq/gitlab-test"
|
||||||
|
},
|
||||||
|
"assignees": [{
|
||||||
|
"name": "User1",
|
||||||
|
"username": "user1",
|
||||||
|
"avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=40\u0026d=identicon"
|
||||||
|
}],
|
||||||
|
"assignee": {
|
||||||
|
"name": "User1",
|
||||||
|
"username": "user1",
|
||||||
|
"avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=40\u0026d=identicon"
|
||||||
|
},
|
||||||
|
"labels": [{
|
||||||
|
"id": 206,
|
||||||
|
"title": "API",
|
||||||
|
"color": "#ffffff",
|
||||||
|
"project_id": 14,
|
||||||
|
"created_at": "2013-12-03T17:15:43Z",
|
||||||
|
"updated_at": "2013-12-03T17:15:43Z",
|
||||||
|
"template": false,
|
||||||
|
"description": "API related issues",
|
||||||
|
"type": "ProjectLabel",
|
||||||
|
"group_id": 41
|
||||||
|
}],
|
||||||
|
"changes": {
|
||||||
|
"updated_by_id": {
|
||||||
|
"previous": null,
|
||||||
|
"current": 1
|
||||||
|
},
|
||||||
|
"updated_at": {
|
||||||
|
"previous": "2017-09-15 16:50:55 UTC",
|
||||||
|
"current": "2017-09-15 16:52:00 UTC"
|
||||||
|
},
|
||||||
|
"labels": {
|
||||||
|
"previous": [{
|
||||||
|
"id": 206,
|
||||||
|
"title": "API",
|
||||||
|
"color": "#ffffff",
|
||||||
|
"project_id": 14,
|
||||||
|
"created_at": "2013-12-03T17:15:43Z",
|
||||||
|
"updated_at": "2013-12-03T17:15:43Z",
|
||||||
|
"template": false,
|
||||||
|
"description": "API related issues",
|
||||||
|
"type": "ProjectLabel",
|
||||||
|
"group_id": 41
|
||||||
|
}],
|
||||||
|
"current": [{
|
||||||
|
"id": 205,
|
||||||
|
"title": "Platform",
|
||||||
|
"color": "#123123",
|
||||||
|
"project_id": 14,
|
||||||
|
"created_at": "2013-12-03T17:15:43Z",
|
||||||
|
"updated_at": "2013-12-03T17:15:43Z",
|
||||||
|
"template": false,
|
||||||
|
"description": "Platform related issues",
|
||||||
|
"type": "ProjectLabel",
|
||||||
|
"group_id": 41
|
||||||
|
}]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
Reference in New Issue
Block a user