Upstream master 2023-12-21

.github/workflows/pr-build-and-test.yml

@@ -0,0 +1,45 @@
+name: Build and test
+
+on:
+  pull_request:
+    branches:
+      - master
+  push:
+    branches:
+      - master
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - name: Set up JDK 17
+        uses: actions/setup-java@v3
+        with:
+          distribution: temurin
+          java-version: 17
+
+      - name: Build and Verify
+        run: mvn --no-transfer-progress --batch-mode verify
+
+      - name: package surefire test results
+        if: failure()
+        run: |
+          rm -rf test-results
+          mkdir test-results
+          find . -type d -name "*surefire*" -exec cp --parents -R {} test-results/ \;
+          zip -r test-results.zip test-results
+      - uses: actions/upload-artifact@v3
+        name: upload test-results
+        if: failure()
+        with:
+          name: test-results
+          path: test-results.zip

README.md

@@ -1,23 +1,47 @@
 # OpenMessaging Benchmark Framework
-[![Build Status](https://app.travis-ci.com/openmessaging/benchmark.svg?branch=master)](https://app.travis-ci.com/openmessaging/benchmark)
-[![Total alerts](https://img.shields.io/lgtm/alerts/g/openmessaging/benchmark.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/openmessaging/benchmark/alerts/)
-[![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/openmessaging/benchmark.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/openmessaging/benchmark/context:python)
-[![Language grade: Java](https://img.shields.io/lgtm/grade/java/g/openmessaging/benchmark.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/openmessaging/benchmark/context:java)
-[![License](https://img.shields.io/badge/license-Apache%202-4EB1BA.svg)](https://www.apache.org/licenses/LICENSE-2.0.html)
 
+[![Build](https://github.com/openmessaging/benchmark/actions/workflows/pr-build-and-test.yml/badge.svg)](https://github.com/openmessaging/benchmark/actions/workflows/pr-build-and-test.yml)
+[![License](https://img.shields.io/badge/license-Apache%202-4EB1BA.svg)](https://www.apache.org/licenses/LICENSE-2.0.html)
 
-**Notice：** We do not consider or plan to release any unilateral test results based on this standard. For reference, you can purchase server tests on the cloud by yourself. 
+**Notice：** We do not consider or plan to release any unilateral test results based on this standard. For reference, you can purchase server tests on the cloud by yourself.
 
 This repository houses user-friendly, cloud-ready benchmarking suites for the following messaging platforms:
 
+* [Apache ActiveMQ Artemis](https://activemq.apache.org/components/artemis/)
+* [Apache Bookkeeper](https://bookkeeper.apache.org)
 * [Apache Kafka](https://kafka.apache.org)
+* [Apache Pulsar](https://pulsar.apache.org)
 * [Apache RocketMQ](https://rocketmq.apache.org)
+* Generic [JMS](https://javaee.github.io/jms-spec/)
+* [KoP (Kafka-on-Pulsar)](https://github.com/streamnative/kop)
+* [NATS JetStream](https://docs.nats.io/nats-concepts/jetstream)
+* [NATS Streaming (STAN)](https://docs.nats.io/legacy/stan/intro)
+* [NSQ](https://nsq.io)
+* [Pravega](https://pravega.io/)
 * [RabbitMQ](https://www.rabbitmq.com/)
-* [Apache Pulsar](https://pulsar.apache.org)
-* [NATS Streaming](https://nats.io/)
 * [Redis](https://redis.com/)
-* [Pravega](https://pravega.io/)
 
 > More details could be found at the [official documentation](http://openmessaging.cloud/docs/benchmarks/).
 
+## Build
+
+Requirements:
+
+* JDK 8
+* Maven 3.8.6+
+
+Common build actions:
+
+|             Action              |                 Command                  |
+|---------------------------------|------------------------------------------|
+| Full build and test             | `mvn clean verify`                       |
+| Skip tests                      | `mvn clean verify -DskipTests`           |
+| Skip Jacoco test coverage check | `mvn clean verify -Djacoco.skip`         |
+| Skip Checkstyle standards check | `mvn clean verify -Dcheckstyle.skip`     |
+| Skip Spotless formatting check  | `mvn clean verify -Dspotless.check.skip` |
+| Format code                     | `mvn spotless:apply`                     |
+| Generate license headers        | `mvn license:format`                     |
+
+## License
 
+Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0