Initial commit
continuous-integration/drone/tag Build is passing Details

pull/1/head 1.0.0
kalle 2022-06-15 16:33:27 +02:00
commit 898b0e1d13
18 changed files with 854 additions and 0 deletions

20
.drone.yml Normal file
View File

@ -0,0 +1,20 @@
---
kind: pipeline
type: docker
name: default
steps:
- name: "Build"
image: "eclipse-temurin:16-jdk"
commands:
- "./gradlew assemble"
- name: "Create Release"
image: plugins/gitea-release
settings:
api_key:
from_secret: "gitea_api_key"
base_url:
from_secret: "gitea_base_url"
files: build/libs/GitlabRepoStats-*.jar
when:
event:
- tag

45
.gitignore vendored Normal file
View File

@ -0,0 +1,45 @@
.gradle
build/
!gradle/wrapper/gradle-wrapper.jar
!**/src/main/**/build/
!**/src/test/**/build/
### IntelliJ IDEA ###
.idea/
*.iws
*.iml
*.ipr
out/
!**/src/main/**/out/
!**/src/test/**/out/
### Eclipse ###
.apt_generated
.classpath
.factorypath
.project
.settings
.springBeans
.sts4-cache
bin/
!**/src/main/**/bin/
!**/src/test/**/bin/
### NetBeans ###
/nbproject/private/
/nbbuild/
/dist/
/nbdist/
/.nb-gradle/
### VS Code ###
.vscode/
### Mac OS ###
.DS_Store
### Secret ###
secret.txt
### No CSVs ###
*.csv

20
README.md Normal file
View File

@ -0,0 +1,20 @@
# Gitlab Repo Stats
Tool for analysing gitlab repo statistics.
## Building
Prebuilt binaries available in [the releases tab](https://git.kallestruik.nl/kalle/GitlabRepoStats/releases) or you can build your own with:
```sh
git clone https://git.kallestruik.nl/kalle/GitlabRepoStats.git
cd GitlabRepoStats
./gradlew build
# Jar is now available at build/libs/GitlabRepoStats-1.0.jar
```
## Running
```sh
java -jar path/to/GitlabRepoStats.jar -u "https://url.of.gitlab.instance/" -t "PERSONAL_ACCESS_TOKEN" -p "project id" # options to enable statistics
```
### Available statistics
**--pipeline-stats**: Gather information about the pipelines that have been ran on this project.
**--issue-stats**: Gather information related to issues of this project. A CSV file for graphing time spent over time is output to `PWD/issue-stats_time-tracking.csv`.

47
build.gradle.kts Normal file
View File

@ -0,0 +1,47 @@
import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
plugins {
kotlin("jvm") version "1.7.0-RC"
kotlin("plugin.serialization") version "1.7.0-RC"
}
val ktorVersion = "2.0.2"
group = "nl.kallestruik"
version = "1.0"
repositories {
mavenCentral()
}
dependencies {
implementation("org.jetbrains.kotlinx:kotlinx-serialization-json:1.3.3")
implementation("org.jetbrains.kotlinx:kotlinx-cli:0.3.4")
implementation("io.ktor:ktor-client-core:$ktorVersion")
implementation("io.ktor:ktor-client-cio:$ktorVersion")
implementation("io.ktor:ktor-client-content-negotiation:$ktorVersion")
implementation("io.ktor:ktor-serialization-kotlinx-json:$ktorVersion")
testImplementation(kotlin("test"))
}
tasks.test {
useJUnitPlatform()
}
tasks.withType<KotlinCompile> {
kotlinOptions.jvmTarget = "1.8"
}
tasks.withType<Jar>() {
manifest {
attributes(
"Main-Class" to "nl.kallestruik.gitlabrepostats.MainKt"
)
}
duplicatesStrategy = DuplicatesStrategy.INCLUDE
configurations["compileClasspath"].forEach { file: File ->
from(zipTree(file.absoluteFile))
}
}

1
gradle.properties Normal file
View File

@ -0,0 +1 @@
kotlin.code.style=official

BIN
gradle/wrapper/gradle-wrapper.jar vendored Normal file

Binary file not shown.

View File

@ -0,0 +1,5 @@
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-7.4.2-bin.zip
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists

234
gradlew vendored Executable file
View File

@ -0,0 +1,234 @@
#!/bin/sh
#
# Copyright © 2015-2021 the original authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
##############################################################################
#
# Gradle start up script for POSIX generated by Gradle.
#
# Important for running:
#
# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is
# noncompliant, but you have some other compliant shell such as ksh or
# bash, then to run this script, type that shell name before the whole
# command line, like:
#
# ksh Gradle
#
# Busybox and similar reduced shells will NOT work, because this script
# requires all of these POSIX shell features:
# * functions;
# * expansions «$var», «${var}», «${var:-default}», «${var+SET}»,
# «${var#prefix}», «${var%suffix}», and «$( cmd )»;
# * compound commands having a testable exit status, especially «case»;
# * various built-in commands including «command», «set», and «ulimit».
#
# Important for patching:
#
# (2) This script targets any POSIX shell, so it avoids extensions provided
# by Bash, Ksh, etc; in particular arrays are avoided.
#
# The "traditional" practice of packing multiple parameters into a
# space-separated string is a well documented source of bugs and security
# problems, so this is (mostly) avoided, by progressively accumulating
# options in "$@", and eventually passing that to Java.
#
# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS,
# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly;
# see the in-line comments for details.
#
# There are tweaks for specific operating systems such as AIX, CygWin,
# Darwin, MinGW, and NonStop.
#
# (3) This script is generated from the Groovy template
# https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
# within the Gradle project.
#
# You can find Gradle at https://github.com/gradle/gradle/.
#
##############################################################################
# Attempt to set APP_HOME
# Resolve links: $0 may be a link
app_path=$0
# Need this for daisy-chained symlinks.
while
APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path
[ -h "$app_path" ]
do
ls=$( ls -ld "$app_path" )
link=${ls#*' -> '}
case $link in #(
/*) app_path=$link ;; #(
*) app_path=$APP_HOME$link ;;
esac
done
APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit
APP_NAME="Gradle"
APP_BASE_NAME=${0##*/}
# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
# Use the maximum available, or set MAX_FD != -1 to use that value.
MAX_FD=maximum
warn () {
echo "$*"
} >&2
die () {
echo
echo "$*"
echo
exit 1
} >&2
# OS specific support (must be 'true' or 'false').
cygwin=false
msys=false
darwin=false
nonstop=false
case "$( uname )" in #(
CYGWIN* ) cygwin=true ;; #(
Darwin* ) darwin=true ;; #(
MSYS* | MINGW* ) msys=true ;; #(
NONSTOP* ) nonstop=true ;;
esac
CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
# Determine the Java command to use to start the JVM.
if [ -n "$JAVA_HOME" ] ; then
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
# IBM's JDK on AIX uses strange locations for the executables
JAVACMD=$JAVA_HOME/jre/sh/java
else
JAVACMD=$JAVA_HOME/bin/java
fi
if [ ! -x "$JAVACMD" ] ; then
die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
Please set the JAVA_HOME variable in your environment to match the
location of your Java installation."
fi
else
JAVACMD=java
which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
Please set the JAVA_HOME variable in your environment to match the
location of your Java installation."
fi
# Increase the maximum file descriptors if we can.
if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
case $MAX_FD in #(
max*)
MAX_FD=$( ulimit -H -n ) ||
warn "Could not query maximum file descriptor limit"
esac
case $MAX_FD in #(
'' | soft) :;; #(
*)
ulimit -n "$MAX_FD" ||
warn "Could not set maximum file descriptor limit to $MAX_FD"
esac
fi
# Collect all arguments for the java command, stacking in reverse order:
# * args from the command line
# * the main class name
# * -classpath
# * -D...appname settings
# * --module-path (only if needed)
# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables.
# For Cygwin or MSYS, switch paths to Windows format before running java
if "$cygwin" || "$msys" ; then
APP_HOME=$( cygpath --path --mixed "$APP_HOME" )
CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" )
JAVACMD=$( cygpath --unix "$JAVACMD" )
# Now convert the arguments - kludge to limit ourselves to /bin/sh
for arg do
if
case $arg in #(
-*) false ;; # don't mess with options #(
/?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath
[ -e "$t" ] ;; #(
*) false ;;
esac
then
arg=$( cygpath --path --ignore --mixed "$arg" )
fi
# Roll the args list around exactly as many times as the number of
# args, so each arg winds up back in the position where it started, but
# possibly modified.
#
# NB: a `for` loop captures its iteration list before it begins, so
# changing the positional parameters here affects neither the number of
# iterations, nor the values presented in `arg`.
shift # remove old arg
set -- "$@" "$arg" # push replacement arg
done
fi
# Collect all arguments for the java command;
# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of
# shell script including quotes and variable substitutions, so put them in
# double quotes to make sure that they get re-expanded; and
# * put everything else in single quotes, so that it's not re-expanded.
set -- \
"-Dorg.gradle.appname=$APP_BASE_NAME" \
-classpath "$CLASSPATH" \
org.gradle.wrapper.GradleWrapperMain \
"$@"
# Use "xargs" to parse quoted args.
#
# With -n1 it outputs one arg per line, with the quotes and backslashes removed.
#
# In Bash we could simply go:
#
# readarray ARGS < <( xargs -n1 <<<"$var" ) &&
# set -- "${ARGS[@]}" "$@"
#
# but POSIX shell has neither arrays nor command substitution, so instead we
# post-process each arg (as a line of input to sed) to backslash-escape any
# character that might be a shell metacharacter, then use eval to reverse
# that process (while maintaining the separation between arguments), and wrap
# the whole thing up as a single "set" statement.
#
# This will of course break if any of these variables contains a newline or
# an unmatched quote.
#
eval "set -- $(
printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" |
xargs -n1 |
sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' |
tr '\n' ' '
)" '"$@"'
exec "$JAVACMD" "$@"

89
gradlew.bat vendored Normal file
View File

@ -0,0 +1,89 @@
@rem
@rem Copyright 2015 the original author or authors.
@rem
@rem Licensed under the Apache License, Version 2.0 (the "License");
@rem you may not use this file except in compliance with the License.
@rem You may obtain a copy of the License at
@rem
@rem https://www.apache.org/licenses/LICENSE-2.0
@rem
@rem Unless required by applicable law or agreed to in writing, software
@rem distributed under the License is distributed on an "AS IS" BASIS,
@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@rem See the License for the specific language governing permissions and
@rem limitations under the License.
@rem
@if "%DEBUG%" == "" @echo off
@rem ##########################################################################
@rem
@rem Gradle startup script for Windows
@rem
@rem ##########################################################################
@rem Set local scope for the variables with windows NT shell
if "%OS%"=="Windows_NT" setlocal
set DIRNAME=%~dp0
if "%DIRNAME%" == "" set DIRNAME=.
set APP_BASE_NAME=%~n0
set APP_HOME=%DIRNAME%
@rem Resolve any "." and ".." in APP_HOME to make it shorter.
for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi
@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m"
@rem Find java.exe
if defined JAVA_HOME goto findJavaFromJavaHome
set JAVA_EXE=java.exe
%JAVA_EXE% -version >NUL 2>&1
if "%ERRORLEVEL%" == "0" goto execute
echo.
echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
echo.
echo Please set the JAVA_HOME variable in your environment to match the
echo location of your Java installation.
goto fail
:findJavaFromJavaHome
set JAVA_HOME=%JAVA_HOME:"=%
set JAVA_EXE=%JAVA_HOME%/bin/java.exe
if exist "%JAVA_EXE%" goto execute
echo.
echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
echo.
echo Please set the JAVA_HOME variable in your environment to match the
echo location of your Java installation.
goto fail
:execute
@rem Setup the command line
set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
@rem Execute Gradle
"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %*
:end
@rem End local scope for the variables with windows NT shell
if "%ERRORLEVEL%"=="0" goto mainEnd
:fail
rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
rem the _cmd.exe /c_ return code!
if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
exit /b 1
:mainEnd
if "%OS%"=="Windows_NT" endlocal
:omega

3
settings.gradle.kts Normal file
View File

@ -0,0 +1,3 @@
rootProject.name = "GitlabRepoStats"

View File

@ -0,0 +1,70 @@
@file:Suppress("unused")
package nl.kallestruik.gitlabrepostats
object CC {
// Reset
const val RESET = "\u001b[0m" // Text Reset
// Regular Colors
const val BLACK = "\u001b[0;30m" // BLACK
const val RED = "\u001b[0;31m" // RED
const val GREEN = "\u001b[0;32m" // GREEN
const val YELLOW = "\u001b[0;33m" // YELLOW
const val BLUE = "\u001b[0;34m" // BLUE
const val PURPLE = "\u001b[0;35m" // PURPLE
const val CYAN = "\u001b[0;36m" // CYAN
const val WHITE = "\u001b[0;37m" // WHITE
// Bold
const val BLACK_BOLD = "\u001b[1;30m" // BLACK
const val RED_BOLD = "\u001b[1;31m" // RED
const val GREEN_BOLD = "\u001b[1;32m" // GREEN
const val YELLOW_BOLD = "\u001b[1;33m" // YELLOW
const val BLUE_BOLD = "\u001b[1;34m" // BLUE
const val PURPLE_BOLD = "\u001b[1;35m" // PURPLE
const val CYAN_BOLD = "\u001b[1;36m" // CYAN
const val WHITE_BOLD = "\u001b[1;37m" // WHITE
// Underline
const val BLACK_UNDERLINED = "\u001b[4;30m" // BLACK
const val RED_UNDERLINED = "\u001b[4;31m" // RED
const val GREEN_UNDERLINED = "\u001b[4;32m" // GREEN
const val YELLOW_UNDERLINED = "\u001b[4;33m" // YELLOW
const val BLUE_UNDERLINED = "\u001b[4;34m" // BLUE
const val PURPLE_UNDERLINED = "\u001b[4;35m" // PURPLE
const val CYAN_UNDERLINED = "\u001b[4;36m" // CYAN
const val WHITE_UNDERLINED = "\u001b[4;37m" // WHITE
// Background
const val BLACK_BACKGROUND = "\u001b[40m" // BLACK
const val RED_BACKGROUND = "\u001b[41m" // RED
const val GREEN_BACKGROUND = "\u001b[42m" // GREEN
const val YELLOW_BACKGROUND = "\u001b[43m" // YELLOW
const val BLUE_BACKGROUND = "\u001b[44m" // BLUE
const val PURPLE_BACKGROUND = "\u001b[45m" // PURPLE
const val CYAN_BACKGROUND = "\u001b[46m" // CYAN
const val WHITE_BACKGROUND = "\u001b[47m" // WHITE
// High Intensity
const val BLACK_BRIGHT = "\u001b[0;90m" // BLACK
const val RED_BRIGHT = "\u001b[0;91m" // RED
const val GREEN_BRIGHT = "\u001b[0;92m" // GREEN
const val YELLOW_BRIGHT = "\u001b[0;93m" // YELLOW
const val BLUE_BRIGHT = "\u001b[0;94m" // BLUE
const val PURPLE_BRIGHT = "\u001b[0;95m" // PURPLE
const val CYAN_BRIGHT = "\u001b[0;96m" // CYAN
const val WHITE_BRIGHT = "\u001b[0;97m" // WHITE
// Bold High Intensity
const val BLACK_BOLD_BRIGHT = "\u001b[1;90m" // BLACK
const val RED_BOLD_BRIGHT = "\u001b[1;91m" // RED
const val GREEN_BOLD_BRIGHT = "\u001b[1;92m" // GREEN
const val YELLOW_BOLD_BRIGHT = "\u001b[1;93m" // YELLOW
const val BLUE_BOLD_BRIGHT = "\u001b[1;94m" // BLUE
const val PURPLE_BOLD_BRIGHT = "\u001b[1;95m" // PURPLE
const val CYAN_BOLD_BRIGHT = "\u001b[1;96m" // CYAN
const val WHITE_BOLD_BRIGHT = "\u001b[1;97m" // WHITE
// High Intensity backgrounds
const val BLACK_BACKGROUND_BRIGHT = "\u001b[0;100m" // BLACK
const val RED_BACKGROUND_BRIGHT = "\u001b[0;101m" // RED
const val GREEN_BACKGROUND_BRIGHT = "\u001b[0;102m" // GREEN
const val YELLOW_BACKGROUND_BRIGHT = "\u001b[0;103m" // YELLOW
const val BLUE_BACKGROUND_BRIGHT = "\u001b[0;104m" // BLUE
const val PURPLE_BACKGROUND_BRIGHT = "\u001b[0;105m" // PURPLE
const val CYAN_BACKGROUND_BRIGHT = "\u001b[0;106m" // CYAN
const val WHITE_BACKGROUND_BRIGHT = "\u001b[0;107m" // WHITE
}

View File

@ -0,0 +1,113 @@
package nl.kallestruik.gitlabrepostats
import io.ktor.client.*
import io.ktor.client.call.*
import io.ktor.client.request.*
import io.ktor.http.*
import kotlinx.coroutines.delay
import nl.kallestruik.gitlabrepostats.objects.GitlabIssue
import java.io.File
import kotlin.time.Duration.Companion.seconds
object IssueStats {
suspend fun printStats(httpClient: HttpClient, gitlabUrl: String, accessToken: String, projectId: String) {
println("${CC.CYAN}Starting retrieval of issue statistics...${CC.RESET}")
val apiBaseUrl =
if (gitlabUrl.endsWith("/"))
"${gitlabUrl}api/v4/projects/$projectId"
else
"$gitlabUrl/api/v4/projects/$projectId"
var totalPages = -1
var currentPage = 1
val issues = mutableListOf<GitlabIssue>()
do {
val response = httpClient.get("$apiBaseUrl/issues?per_page=100&page=$currentPage") {
header("Authorization", "Bearer $accessToken")
}
// If we got something other than a 200 OK we are most likely rate-limited.
if (response.status != HttpStatusCode.OK) {
delay(1000)
continue
}
// Append the response to the list of jobs.
issues += response.body<List<GitlabIssue>>()
totalPages = response.headers["x-total-pages"]?.toIntOrNull() ?: totalPages
currentPage++
} while (currentPage <= totalPages)
val numberOfTotalIssues = issues.size
val numberOfClosedIssues = issues
.filter { it.state == "closed" }
.size
println("Total number of issues (closed): ${CC.CYAN}$numberOfTotalIssues${CC.RESET} (${CC.RED}$numberOfClosedIssues${CC.RESET})")
val users = issues
.flatMap { issue ->
issue.assignees
.map { it.name }
}
.distinct()
val issuesByUser = mutableMapOf<String, List<GitlabIssue>>()
users.forEach { user ->
issuesByUser[user] = issues
.filter { issue ->
issue.assignees
.map { it.name }
.contains(user)
}
}
println("Issues per user:")
issuesByUser.forEach {
val issueCount = it.value.size
val closedIssueCount = it.value
.filter { it.state == "closed" }
.size
val totalTimeSpent = it.value
.sumOf { (it.timeStats.totalTimeSpent ?: 0) / it.assignees.size }
val totalTimeEstimated = it.value
.sumOf { (it.timeStats.timeEstimate ?: 0) / it.assignees.size }
println("${CC.GREEN}${it.key}${CC.RESET}:")
println("\tTotal (closed): ${CC.CYAN}$issueCount${CC.RESET} (${CC.RED}$closedIssueCount${CC.RESET})")
println("\tTime spent (estimated): ${CC.CYAN}${totalTimeSpent.seconds.formatTime()}${CC.RESET} (${CC.GREEN}${totalTimeEstimated.seconds.formatTime()}${CC.RESET})")
}
val closedDates = issues
.mapNotNull { it.closedAt }
.map { it.toLocalDate() }
.distinct()
.sorted()
val outputFile = File("issue-stats_time-tracking.csv")
outputFile.createNewFile()
val userTotals = users.associateWith { 0 }.toMutableMap()
outputFile.writeText("Date;${users.joinToString(";")}\n")
closedDates.forEach {date ->
users.forEach {user ->
val timeSpentToday = issues
.filter { it.assignees.map { it.name }.contains(user) }
.filter { it.closedAt?.toLocalDate() == date }
.sumOf { (it.timeStats.totalTimeSpent ?: 0) / it.assignees.size }
userTotals[user] = userTotals[user]!! + timeSpentToday
}
outputFile.appendText("$date;${userTotals.map { it.value / 60.0 / 60.0 }.joinToString(";")}\n")
}
}
}

View File

@ -0,0 +1,49 @@
package nl.kallestruik.gitlabrepostats
import io.ktor.client.*
import io.ktor.client.engine.cio.*
import io.ktor.client.plugins.contentnegotiation.*
import io.ktor.serialization.kotlinx.json.*
import kotlinx.cli.ArgParser
import kotlinx.cli.ArgType
import kotlinx.cli.default
import kotlinx.cli.required
import kotlinx.serialization.json.Json
import kotlin.time.Duration
suspend fun main(args: Array<String>) {
val parser = ArgParser("gitlab-repo-stats")
val gitlabUrl by parser.option(ArgType.String, fullName = "url", shortName = "u", description = "The base URL of the gitlab instance.").required()
val accessToken by parser.option(ArgType.String, fullName = "token", shortName = "t", description = "Token used to authenticate to the gitlab api").required()
val projectId by parser.option(ArgType.String, fullName = "project-id", shortName = "p", description = "The project ID of the repo").required()
val pipelineStats by parser.option(ArgType.Boolean, fullName = "pipeline-stats", description = "Gather stats about the pipeline").default(false)
val mergeStats by parser.option(ArgType.Boolean, fullName = "merge-stats", description = "Gather stats about merge requests").default(false)
val issueStats by parser.option(ArgType.Boolean, fullName = "issue-stats", description = "Gather stats about issues").default(false)
parser.parse(args)
val httpClient = HttpClient(CIO) {
install(ContentNegotiation) {
json(Json {
ignoreUnknownKeys = true
})
}
}
if (pipelineStats)
PipelineStats.printStats(httpClient, gitlabUrl, accessToken, projectId)
if (mergeStats)
MergeStats.printStats(httpClient, gitlabUrl, accessToken, projectId)
if (issueStats)
IssueStats.printStats(httpClient, gitlabUrl, accessToken, projectId)
}
fun Duration.formatTime() = this.toComponents { hours, minutes, seconds, _ ->
val hoursFormatted = hours.toString().padStart(2, '0')
val minutesFormatted = minutes.toString().padStart(2, '0')
val secondsFormatted = seconds.toString().padStart(2, '0')
"$hoursFormatted:$minutesFormatted:$secondsFormatted"
}

View File

@ -0,0 +1,16 @@
package nl.kallestruik.gitlabrepostats
import io.ktor.client.*
object MergeStats {
suspend fun printStats(httpClient: HttpClient, gitlabUrl: String, accessToken: String, projectId: String) {
println("Merge stats")
//TODO:
// - Get all MRs
// - Find MRs opened by user
// - Find MRs approved by user
// - Data per day into CSV for graphing?
}
}

View File

@ -0,0 +1,70 @@
package nl.kallestruik.gitlabrepostats
import io.ktor.client.*
import io.ktor.client.call.*
import io.ktor.client.request.*
import io.ktor.http.*
import kotlinx.coroutines.delay
import nl.kallestruik.gitlabrepostats.objects.GitlabJob
import java.text.DecimalFormat
import kotlin.time.Duration
import kotlin.time.Duration.Companion.seconds
import kotlin.time.DurationUnit
object PipelineStats {
suspend fun printStats(httpClient: HttpClient, gitlabUrl: String, accessToken: String, projectId: String) {
println("${CC.CYAN}Starting retrieval of pipeline statistics...${CC.RESET}")
val apiBaseUrl =
if (gitlabUrl.endsWith("/"))
"${gitlabUrl}api/v4/projects/$projectId"
else
"$gitlabUrl/api/v4/projects/$projectId"
var totalPages = -1
var currentPage = 1
val jobs = mutableListOf<GitlabJob>()
do {
val response = httpClient.get("$apiBaseUrl/jobs?per_page=100&page=$currentPage") {
header("Authorization", "Bearer $accessToken")
}
// If we got something other than a 200 OK we are most likely rate-limited.
if (response.status != HttpStatusCode.OK) {
delay(1000)
continue
}
// Append the response to the list of jobs.
jobs += response.body<List<GitlabJob>>()
totalPages = response.headers["x-total-pages"]?.toIntOrNull() ?: totalPages
currentPage++
} while (currentPage <= totalPages)
val jobsPerBranch = jobs
.filterNot { it.ref == null }
.groupBy { it.ref }
.mapValues { it.value.size }
.entries.map { Pair(it.key, it.value) }
.sortedByDescending { it.second }
val totalJobs = jobs.size
val failedJobs = jobs.filter { it.status == "failed" }.size
val failedPercentage = DecimalFormat("#.##").format(failedJobs * 100.0F / totalJobs)
val totalJobLength = jobs.sumOf { it.duration ?: 0.0 }
println("${CC.GREEN}## Pipeline Statistics ##${CC.RESET}")
println("Total job count: ${CC.CYAN}$totalJobs${CC.RESET}")
println("Of which failed: ${CC.CYAN}$failedJobs ${CC.RESET}($failedPercentage%)")
println("Time spent executing: ${CC.CYAN}${totalJobLength.seconds.formatTime()}${CC.RESET}")
println("Branches with most jobs ran:")
jobsPerBranch.take(10).forEach {
println("- ${it.first}: ${it.second}")
}
}
}

View File

@ -0,0 +1,42 @@
package nl.kallestruik.gitlabrepostats.objects
import kotlinx.serialization.KSerializer
import kotlinx.serialization.SerialName
import kotlinx.serialization.Serializable
import kotlinx.serialization.descriptors.PrimitiveKind
import kotlinx.serialization.descriptors.PrimitiveSerialDescriptor
import kotlinx.serialization.descriptors.SerialDescriptor
import kotlinx.serialization.encoding.Decoder
import kotlinx.serialization.encoding.Encoder
import java.time.LocalDateTime
import java.time.format.DateTimeFormatter
@Serializable
data class GitlabIssue(
val iid: Long,
val state: String,
val assignees: List<GitlabUser>,
@SerialName("closed_at")
@Serializable(with = LocalDateTimeAsISOStringSerializer::class)
val closedAt: LocalDateTime?,
@SerialName("time_stats")
val timeStats: GitlabTimeStats,
)
object LocalDateTimeAsISOStringSerializer : KSerializer<LocalDateTime> {
override val descriptor: SerialDescriptor = PrimitiveSerialDescriptor("Date", PrimitiveKind.STRING)
override fun serialize(encoder: Encoder, value: LocalDateTime) = encoder.encodeString(value.toString())
override fun deserialize(decoder: Decoder): LocalDateTime = LocalDateTime.parse(decoder.decodeString(), DateTimeFormatter.ISO_OFFSET_DATE_TIME)
}
@Serializable
data class GitlabTimeStats(
@SerialName("time_estimate")
val timeEstimate: Int?,
@SerialName("total_time_spent")
val totalTimeSpent: Int?,
@SerialName("human_time_estimate")
val humanTimeEstimate: String?,
@SerialName("human_total_time_spent")
val humanTotalTimeSpent: String?,
)

View File

@ -0,0 +1,14 @@
package nl.kallestruik.gitlabrepostats.objects
import kotlinx.serialization.SerialName
import kotlinx.serialization.Serializable
@Serializable
data class GitlabJob(
val duration: Double?,
@SerialName("queued_duration")
val queuedDuration: Double?,
val ref: String?,
val stage: String,
val status: String,
)

View File

@ -0,0 +1,16 @@
package nl.kallestruik.gitlabrepostats.objects
import kotlinx.serialization.SerialName
import kotlinx.serialization.Serializable
@Serializable
data class GitlabUser(
@SerialName("avatar_url")
val avatarUrl: String?,
@SerialName("web_url")
val webUrl: String?,
val state: String,
val username: String,
val id: Long,
val name: String,
)