Fix too many issues to name them all

Author: parttimenerd

README.md

@@ -2,16 +2,24 @@ Loader for AsyncProfiler
 ========================
 
 Packages [async-profiler](https://github.com/jvm-profiling-tools/async-profiler) releases in a JAR
-with a `AsyncProfilerLoader` that loads the suitable native library for the current platform.
+with a `AsyncProfilerLoader` (version 2+) that loads the suitable native library for the current platform.
 
 This is usable as a java agent (same arguments as the async-profiler agent) and as the basis for other libraries.
 The real rationale behind this library is that the async-profiler is a nice tool, but it cannot be easily integrated
 into other Java based tools.
 
-Take the `all` build and you have a JAR that provides the important features of async-profiler on all supported platforms:
+The wrapper is tested against all relevant tests of the async-profiler tool, ensuring that it has the same behavior.
+
+Take the `all` build and you have a JAR that provides the important features of async-profiler on all supported
+platforms.
 
 A changelog can be found at the async-profiler repository, as this library should rarely change itself.
 
+_This project assumes that you used async-profiler before, if not, don't worry, you can still use this project,
+but be aware that it's documentation refers you to the async-profiler documentation a lot._
+
+_fdtransfer is currently not supported, feel free to create an issue if you need it._
+
 Supported Platforms
 -------------------
 
@@ -30,27 +38,29 @@ Commands
 
 The following is a more in-depth description of the commands of `java -jar ap-loader.jar`.
 
-Be aware that it is recommended to use run the JVM with the 
-`-XX:+UnlockDiagnosticVMOptions -XX:+DebugNonSafepoints` flags when attaching to a running JVM.
+Be aware that it is recommended to use run the JVM with the
+`-XX:+UnlockDiagnosticVMOptions -XX:+DebugNonSafepoints` flags.
 This improves the accuracy of the profiler.
 
 Overview over the commands:
 
 ```sh
 Usage: java -jar ap-loader.jar <command> [args]
 Commands:
-  help        show this help
-  jattach     run the included jattach binary
-  profiler    run the included profiler.sh
-  supported   fails if this JAR does not include a profiler for the current OS and architecture
-  converter   run the included converter JAR
-  version     version of the included async-profiler
-  clear       clear the directory used for storing extracted files
+  help         show this help
+  jattach      run the included jattach binary
+  profiler     run the included profiler.sh
+  agentpath    prints the path of the extracted async-profiler agent
+  jattachpath  prints the path of the extracted jattach binary
+  supported    fails if this JAR does not include a profiler for the current OS and architecture
+  converter    run the included converter JAR
+  version      version of the included async-profiler
+  clear        clear the directory used for storing extracted files
 ```
 
 ### jattach
 
-`java -jar ap-loader.jar jattach` is equivalent to calling the suitable `jattach` binary 
+`java -jar ap-loader.jar jattach` is equivalent to calling the suitable `jattach` binary
 from [GitHub](https://github.com/apangin/jattach)>:
 
 ```sh
@@ -67,6 +77,7 @@ java -jar ap-loader.jar jattach <pid> jcmd "help -all"
 See the [GitHub page of jattach](https://github.com/apangin/jattach) for more details.
 
 ### profiler
+
 `java -jar ap-loader.jar profiler` is equivalent to calling the suitable `profiler.sh`:
 
 ```sh
@@ -97,7 +108,7 @@ java -jar ap-loader.jar converter jfr2flame <input.jfr> <output.html>
 
 The available converters depend on the included async-profiler version.
 Call `java -jar converter` to a list of available converters, see
-[the source code on GitHub](https://github.com/jvm-profiling-tools/async-profiler/blob/master/src/converter/Main.java) 
+[the source code on GitHub](https://github.com/jvm-profiling-tools/async-profiler/blob/master/src/converter/Main.java)
 for more details.
 
 ### clear
@@ -127,18 +138,21 @@ Using in Java code
 Then you can use the `AsyncProfilerLoader` class to load the native library:
 
 ```java
-AsyncProfiler profiler + one.profiler.AsyncProfilerLoader.load();
+AsyncProfiler profiler = one.profiler.AsyncProfilerLoader.load();
 ```
 
-`AsyncProfiler` is the [main API class](https://github.com/jvm-profiling-tools/async-profiler/blob/master/src/api/one/profiler/AsyncProfiler.java)
+`AsyncProfiler` is
+the [main API class](https://github.com/jvm-profiling-tools/async-profiler/blob/master/src/api/one/profiler/AsyncProfiler.java)
 from the async-profiler.jar.
 
 The API of the `AsyncProfilerLoader` can be used to execute all commands the CLI programmatically.
 
 ### Snapsshots
+
 We currently only release to snapshop, as the API is not stable yet.
 
 ```xml
+
 <dependency>
     <groupId>me.bechberger</groupId>
     <artifactId>ap-loader</artifactId>
@@ -147,7 +161,9 @@ We currently only release to snapshop, as the API is not stable yet.
 ```
 
 For example for the all variant of version 2.8.3:
+
 ```xml
+
 <dependency>
     <groupId>me.bechberger</groupId>
     <artifactId>ap-loader</artifactId>
@@ -156,7 +172,9 @@ For example for the all variant of version 2.8.3:
 ```
 
 You also have to add the snapshot repository:
+
 ```xml
+
 <repositories>
     <repository>
         <id>snapshots</id>
@@ -171,7 +189,6 @@ You also have to add the snapshot repository:
 </repositories>
 ```
 
-
 Build and test
 --------------
 
@@ -187,21 +204,41 @@ unzip -o async-profiler-2.8.3-macos.zip -d ap-releases
 # build the JAR for the release
 # maven might throw warnings, related to the project version setting,
 # but the alternative solutions don't work, so we ignore the warning for now
-mvn -Dproject.versionPlatform=2.8.3-macos assembly:single
+mvn -Dproject.versionPlatform=2.8.3-macos package assembly:single
 # use it
 java -jar target/ap-loader-2.8.3-macos-full.jar ...
 # build the all JAR
-mvn -Dproject.versionPlatform=2.8.3-all -f pom_all.xml assembly:single
+mvn -Dproject.versionPlatform=2.8.3-all -f pom_all.xml package assembly:single
 ```
 
 Development
 -----------
 This project is written in Java 8, to support all relevant platforms.
-The feature set should not increase beyond what is currently: 
+The feature set should not increase beyond what is currently:
 Just build your library on top of it. But I'm of course happy for bug reports and fixes.
 
 The code is formatted using [google-java-format](https://github.com/google/google-java-format).
 
+### bin/releaser.py
+
+```sh
+Usage:
+    python3 ./bin/releaser.py <command> ... <command> [release or current if not present]
+
+Commands:
+    current_version   print the youngest released version of async-profiler
+    versions          print all released versions of async-profiler (supported by this project)
+    download          download and prepare the folders for the given release
+    build             build the wrappers for the given release
+    test              test the given release
+    deploy            deploy the wrappers for the given release, i.e., use "mvn deploy"
+    clear             clear the ap-releases and target folders for a fresh start
+
+Environment variables:
+    JAVA_VERSIONS  comma-separated list of Java versions to test with
+                   (in the form of sdkman! version names, e.g. 17.0.1-sapmchn)
+```
+
 License
 -------
 Apache 2.0

bin/copy_all_libs.sh

@@ -1,12 +1,15 @@
 #! /bin/sh
-# ./copy_all_libs.sh <base_dir> <artifact version, like 2.8.3-all
+# ./copy_all_libs.sh <base_dir> <artifact version, like 2.8.3-all>
 
 set -e
 
+OWN_DIR=$(dirname "$0")
+
 # extract the version without the platform suffix
 version=$(echo "$2" | cut -d '-' -f 1)
 echo "version: $version"
 cd "$1" || exit 1
+rm -fr target/classes/libs
 mkdir -p target/classes/libs
 for f in ap-releases/async-profiler-$version-*; do
   if (echo "$f" | grep 'code' || echo "$f" | grep ".tar.gz" || echo "$f" | grep ".zip"); then
@@ -16,17 +19,19 @@ for f in ap-releases/async-profiler-$version-*; do
   platform=$(echo "$f" | cut -d '-' -f 5-10)
   # copy the library
   echo "Copying $f/build/libasyncProfiler.so for platform $platform"
-  cp "$f/build/libasyncProfiler.so" "target/classes/libs/libasyncProfiler-$platform.so"
+  cp "$f/build/libasyncProfiler.so" "target/classes/libs/libasyncProfiler-$version-$platform.so"
   echo "Copying $f/build/jattach for platform $platform"
-  cp "$f/build/jattach" "target/classes/libs/jattach-$platform"
-  echo "Copying $f/profiler.sh for platform $platform"
-  cp "$f/profiler.sh" "target/classes/libs/profiler-$platform.sh"
+  cp "$f/build/jattach" "target/classes/libs/jattach-$version-$platform"
 done
 first_folder=$(echo ap-releases/async-profiler-$version-linux* | cut -d " " -f 1)
-# copy the converter
+# copy the converter and profile.sh
 echo "Copy $first_folder/build/converter.jar"
-cp "$first_folder/build/converter.jar" "target/classes/libs/converter.jar"
+cp "$first_folder/build/converter.jar" "target/classes/libs/converter-$version.jar"
+echo "Copy $first_folder/profiler.sh"
+cp "$first_folder/profiler.sh" "target/classes/libs/profiler-$version.sh"
+python3 "$OWN_DIR/profile_processor.py" "target/classes/libs/profiler-$version.sh"
 # extract the async-profiler JAR
 echo "Extracting $first_folder/build/async-profiler.jar"
-ls target/classes/libs >target/classes/libs/index
-unzip -o $first_folder/build/async-profiler* "*.class" -d target/classes
+python3 "$OWN_DIR/timestamp.py" > "target/classes/libs/ap-timestamp-$version"
+echo "$version" > target/classes/libs/ap-version
+unzip -o "$first_folder/build/async-profiler*" "*.class" -d "target/classes"

bin/copy_libs.sh

@@ -0,0 +1,31 @@
+#! /bin/sh
+# ./copy_libs.sh <base_dir> <artifact version, like 2.8.3-macos>
+
+set -e
+
+BASEDIR="$1"
+VERSION_PLATFORM=$2
+AP_RELEASE="ap-releases/async-profiler-$VERSION_PLATFORM"
+OWN_DIR=$(dirname "$0")
+
+cd "$BASEDIR" || exit 1
+
+version=$(echo "$2" | cut -d '-' -f 1)
+rm -fr target/classes/libs
+mkdir -p target/classes/libs
+cp "$AP_RELEASE/build/libasyncProfiler.so" \
+  "target/classes/libs/libasyncProfiler-$VERSION_PLATFORM.so"
+cp "$AP_RELEASE/build/jattach" \
+  "target/classes/libs/jattach-$VERSION_PLATFORM"
+
+python3 "$OWN_DIR/timestamp.py" > "target/classes/libs/ap-timestamp-$version"
+echo "$version" > target/classes/libs/ap-version
+
+echo "Copy $AP_RELEASE/build/converter.jar"
+cp "$AP_RELEASE/build/converter.jar" "target/classes/libs/converter-$version.jar"
+echo "Copy $AP_RELEASE/profiler.sh"
+cp "$AP_RELEASE/profiler.sh" "target/classes/libs/profiler-$version.sh"
+python3 "$OWN_DIR/profile_processor.py" "target/classes/libs/profiler-$version.sh"
+echo "Extracting $AP_RELEASE/build/async-profiler.jar"
+unzip -o "ap-releases/async-profiler-$VERSION_PLATFORM/build/async-profiler.jar" \
+  "*.class" -d "target/classes"

bin/profile_processor.py

@@ -0,0 +1,12 @@
+#!/usr/bin/python3
+"""
+./profile_processor.py FILE
+"""
+
+import sys
+
+with open(sys.argv[1], "r") as f:
+    content = f.read()
+content = content.replace("JATTACH=$SCRIPT_DIR/build/jattach", "").replace("PROFILER=$SCRIPT_DIR/build/libasyncProfiler.so", "")
+with open(sys.argv[1], "w") as f:
+    f.write(content)