From 4e1e6d5254ce829ec7b80669d95a120103d077bd Mon Sep 17 00:00:00 2001 From: Waldemar Hummer Date: Tue, 2 Apr 2024 14:02:47 +0200 Subject: [PATCH] upgrade version of Kafka embedded server to 3.2.7 (#27) --- kafka-server/.gitignore | 1 + kafka-server/Makefile | 17 ++++++++++++++++- kafka-server/README.md | 15 +++++++++++++++ kafka-server/build.gradle | 4 ++-- 4 files changed, 34 insertions(+), 3 deletions(-) diff --git a/kafka-server/.gitignore b/kafka-server/.gitignore index 315b305..7fd4bba 100644 --- a/kafka-server/.gitignore +++ b/kafka-server/.gitignore @@ -1,3 +1,4 @@ .idea/ kafka-server.iml local.properties +kafka-embedded-env/ diff --git a/kafka-server/Makefile b/kafka-server/Makefile index dfd8b7c..b2175bf 100644 --- a/kafka-server/Makefile +++ b/kafka-server/Makefile @@ -1,8 +1,23 @@ +KAFKA_EMBEDDED_ENV_VERSION ?= 3.2.7 +KAFKA_EMBEDDED_ENV_COMMIT ?= a5a21c8c6593d30860160cff54ffd350f7e1a0d5 usage: ## Show this help @fgrep -h "##" $(MAKEFILE_LIST) | fgrep -v fgrep | sed -e 's/\\$$//' | sed -e 's/##//' +patch: ## Clone and patch the kafka-embedded-env repo, build code into local Maven repo + test -e kafka-embedded-env || git clone https://github.com/navikt/kafka-embedded-env + (cd kafka-embedded-env; git checkout $(KAFKA_EMBEDDED_ENV_COMMIT)) + # note: using perl instead of sed below, for better Linux/MacOS cross-compatibility + perl -i -pe 's|17<|11<|g' kafka-embedded-env/pom.xml + perl -i -pe 's|17<|11<|g' kafka-embedded-env/pom.xml + perl -i -pe 's|17<|11<|g' kafka-embedded-env/pom.xml + (cd kafka-embedded-env; mvn -B versions:set -DnewVersion="$(KAFKA_EMBEDDED_ENV_VERSION)" -DgenerateBackupPoms=false) + (cd kafka-embedded-env; mvn install) + build: ## Build the JAR file gradle shadowJar -.PHONY: build +clean: ## Clean up local temporary files + rm -rf kafka-embedded-env + +.PHONY: usage build patch clean diff --git a/kafka-server/README.md b/kafka-server/README.md index 3d791b9..767a31f 100644 --- a/kafka-server/README.md +++ b/kafka-server/README.md @@ -7,9 +7,24 @@ ## Building +Note: recent versions of [`kafka-embedded-env`](https://github.com/navikt/kafka-embedded-env) require Java 17+, whereas we only have JRE 11 installed in the LocalStack container. +Hence, we first need to check out and patch the repo locally: +``` +make patch +``` + To build the latest version of the embedded server, run this command: ``` make build ``` On successful build, this will generate a file `build/libs/kafka-server-all.jar` which should then be renamed to `kafka-server-all-.jar` (e.g., `kafka-server-all-3.1.0.jar`) and pushed to the `localstack-assets` S3 bucket. + +## Upgrading + +To upgrade to a newer version, follow these steps: + +* Adjust `KAFKA_EMBEDDED_ENV_VERSION` and `KAFKA_EMBEDDED_ENV_COMMIT` in `Makefile` +* Adjust the version in `implementation("no.nav:kafka-embedded-env:")` in `build.gradle` +* Run `make clean` to ensure that local patches are cleaned up +* Run `make patch` and `make build` as per instructions further above diff --git a/kafka-server/build.gradle b/kafka-server/build.gradle index be1c5fd..6dee9a9 100644 --- a/kafka-server/build.gradle +++ b/kafka-server/build.gradle @@ -6,6 +6,7 @@ plugins { } repositories { + mavenLocal() mavenCentral() maven { url 'https://packages.confluent.io/maven' @@ -16,8 +17,7 @@ repositories { } dependencies { - // note: later versions of kafka-embedded-env require Java 17+, whereas we only have JRE 11 installed in the LS container - implementation("no.nav:kafka-embedded-env:3.1.0") { + implementation("no.nav:kafka-embedded-env:3.2.7") { exclude group: 'log4j', module: 'log4j' // exclude libs to prevent CVEs with certain versions exclude group: 'io.confluent', module: 'confluent-log4j'