feat: add a redis extension

Creates a vertx redis extension that provides different flavours of RedisAPI. fixes #4453
quarkusio · May 16, 2020 · 5b6f88c · 5b6f88c
1 parent 04787a0
commit 5b6f88c
Show file tree

Hide file tree

Showing 29 changed files with 2,848 additions and 16 deletions.
diff --git a/.github/boring-cyborg.yml b/.github/boring-cyborg.yml
@@ -280,9 +280,11 @@ labelPRBasedOnFilePath:
         - extensions/vertx/**/*
         - extensions/vertx-core/**/*
         - extensions/vertx-graphql/**/*
+        - extensions/vertx-redis/**/*
         - extensions/vertx-http/**/*
         - extensions/vertx-keycloak/**/*
         - extensions/vertx-web/**/*
         - integration-tests/vertx/**/*
         - integration-tests/vertx-graphql/**/*
+        - integration-tests/vertx-redis/**/*
         - integration-tests/vertx-http/**/*
diff --git a/.github/workflows/ci-actions.yml b/.github/workflows/ci-actions.yml
@@ -34,8 +34,8 @@ on:
 env:
   # Workaround testsuite locale issue
   LANG: en_US.UTF-8
-  NATIVE_TEST_MAVEN_OPTS: "-B --settings .github/mvn-settings.xml --fail-at-end -Dquarkus.native.container-build=true -Dquarkus.native.builder-image=quay.io/quarkus/ubi-quarkus-native-image:19.3.1-java11 -Dtest-postgresql -Dtest-elasticsearch -Dtest-keycloak -Dtest-amazon-services -Dtest-mysql -Dtest-mariadb -Dmariadb.url='jdbc:mariadb://localhost:3308/hibernate_orm_test'  -Dtest-mssql -Dtest-vault -Dtest-neo4j -Dtest-kafka -Dnative-image.xmx=5g -Dnative -Dformat.skip install"
-  JVM_TEST_MAVEN_OPTS: "-e -B --settings .github/mvn-settings.xml -Dtest-postgresql -Dtest-elasticsearch -Dtest-mysql -Dtest-mariadb -Dmariadb.url='jdbc:mariadb://localhost:3308/hibernate_orm_test'  -Dtest-mssql -Dtest-amazon-services -Dtest-vault -Dtest-neo4j -Dtest-kafka -Dtest-keycloak -Dformat.skip"
+  NATIVE_TEST_MAVEN_OPTS: "-B --settings .github/mvn-settings.xml --fail-at-end -Dquarkus.native.container-build=true -Dquarkus.native.builder-image=quay.io/quarkus/ubi-quarkus-native-image:19.3.1-java11 -Dtest-postgresql -Dtest-elasticsearch -Dtest-keycloak -Dtest-amazon-services -Dtest-mysql -Dtest-redis -Dtest-mariadb -Dmariadb.url='jdbc:mariadb://localhost:3308/hibernate_orm_test'  -Dtest-mssql -Dtest-vault -Dtest-neo4j -Dtest-kafka -Dnative-image.xmx=5g -Dnative -Dformat.skip install"
+  JVM_TEST_MAVEN_OPTS: "-e -B --settings .github/mvn-settings.xml -Dtest-postgresql -Dtest-elasticsearch -Dtest-mysql -Dtest-mariadb -Dmariadb.url='jdbc:mariadb://localhost:3308/hibernate_orm_test'  -Dtest-mssql -Dtest-amazon-services -Dtest-vault -Dtest-neo4j -Dtest-kafka -Dtest-keycloak -Dtest-redis -Dformat.skip"
   DB_USER: hibernate_orm_test
   DB_PASSWORD: hibernate_orm_test
   DB_NAME: hibernate_orm_test
@@ -70,7 +70,7 @@ jobs:
       - name: Compute cache restore key
         # Always recompute on a push so that the maven repo doesnt grow indefinitely with old versions
         run: |
-           if ${{ github.event_name == 'pull_request' }}; then echo "::set-env name=COMPUTED_RESTORE_KEY::q2maven-"; fi
+          if ${{ github.event_name == 'pull_request' }}; then echo "::set-env name=COMPUTED_RESTORE_KEY::q2maven-"; fi
       - name: Cache Maven Repository
         id: cache-maven
         uses: n1hility/cache@v2
@@ -158,7 +158,7 @@ jobs:
         image: neo4j/neo4j-experimental:4.0.0-rc01
         env:
           NEO4J_AUTH: neo4j/secret
-          NEO4J_dbms_memory_pagecache_size: 10M 
+          NEO4J_dbms_memory_pagecache_size: 10M
           NEO4J_dbms_memory_heap_initial__size: 10M
         ports:
           - 127.0.0.1:7687:7687
@@ -172,7 +172,10 @@ jobs:
           - 127.0.0.1:8008:4572
           - 127.0.0.1:8009:4575
           - 127.0.0.1:8010:4576
-
+      redis:
+        image: redis:5.0.8-alpine
+        ports:
+          - 127.0.0.1:6379:6379
     steps:
       - name: Start mysql
         shell: bash
@@ -209,7 +212,7 @@ jobs:
       - name: Prepare failure archive (if maven failed)
         if: failure()
         shell: bash
-        run: find . -name '*-reports' -type d | tar -czvf test-reports.tgz -T - 
+        run: find . -name '*-reports' -type d | tar -czvf test-reports.tgz -T -
       - name: Upload failure Archive (if maven failed)
         uses: actions/upload-artifact@v1
         if: failure()
@@ -224,7 +227,7 @@ jobs:
     timeout-minutes: 120
     env:
       MAVEN_OPTS: -Xmx1408m
-   
+
     steps:
       - uses: actions/checkout@v2
       - name: Set up JDK 11
@@ -275,7 +278,7 @@ jobs:
         image: neo4j/neo4j-experimental:4.0.0-rc01
         env:
           NEO4J_AUTH: neo4j/secret
-          NEO4J_dbms_memory_pagecache_size: 10M 
+          NEO4J_dbms_memory_pagecache_size: 10M
           NEO4J_dbms_memory_heap_initial__size: 10M
         ports:
           - 7687:7687
@@ -319,14 +322,14 @@ jobs:
       - name: Prepare failure archive (if maven failed)
         if: failure()
         shell: bash
-        run: find . -name '*-reports' -type d | tar -czvf test-reports.tgz -T - 
+        run: find . -name '*-reports' -type d | tar -czvf test-reports.tgz -T -
       - name: Upload failure Archive (if maven failed)
         uses: actions/upload-artifact@v1
         if: failure()
         with:
           name: test-reports-tcks
           path: 'test-reports.tgz'
-       
+
   native-tests:
     name: Native Tests - ${{matrix.category}}
     needs: build-jdk11
@@ -373,10 +376,12 @@ jobs:
               panache-rest-hibernate-orm
           - category: Data4
             neo4j: "true"
-            timeout: 30
+            redis: "true"
+            timeout: 45
             test-modules: >
               mongodb-client
               mongodb-panache
+              vertx-redis
               neo4j
           - category: Data5
             timeout: 30
@@ -492,9 +497,9 @@ jobs:
       # These should be services, but services do not (yet) allow conditional execution
       - name: Postgres Service
         run: |
-              docker run --rm --publish 5432:5432 --name build-postgres \
-              -e POSTGRES_USER=$DB_USER -e POSTGRES_PASSWORD=$DB_PASSWORD -e POSTGRES_DB=$DB_NAME \
-              -d postgres:10.5
+          docker run --rm --publish 5432:5432 --name build-postgres \
+          -e POSTGRES_USER=$DB_USER -e POSTGRES_PASSWORD=$DB_PASSWORD -e POSTGRES_DB=$DB_NAME \
+          -d postgres:10.5
         if: matrix.postgres
       - name: MySQL Service
         run: |
@@ -526,6 +531,9 @@ jobs:
             -e NEO4J_AUTH=neo4j/secret -e NEO4J_dbms_memory_pagecache_size=10M -e NEO4J_dbms_memory_heap_initial__size=10M \
             -d neo4j/neo4j-experimental:4.0.0-rc01
         if: matrix.neo4j
+      - name: Redis Service
+        run: docker run --rm --publish 6379:6379 --name build-redis -d redis:5.0.8-alpine
+        if: matrix.redis
       - name: Keycloak Service
         run: |
           docker run --rm --publish 8180:8080 --publish 8543:8443 --name build-keycloak \
@@ -552,7 +560,7 @@ jobs:
         shell: bash
         run: tar -xzvf maven-repo.tgz -C ~
       - name: Build with Maven
-        env: 
+        env:
           TEST_MODULES: ${{matrix.test-modules}}
           CATEGORY: ${{matrix.category}}
         run: |
@@ -569,7 +577,7 @@ jobs:
       - name: Prepare failure archive (if maven failed)
         if: failure()
         shell: bash
-        run: find . -name '*-reports' -type d | tar -czvf test-reports.tgz -T - 
+        run: find . -name '*-reports' -type d | tar -czvf test-reports.tgz -T -
       - name: Upload failure Archive (if maven failed)
         uses: actions/upload-artifact@v1
         if: failure()

diff --git a/bom/deployment/pom.xml b/bom/deployment/pom.xml
@@ -753,6 +753,11 @@
                 <artifactId>quarkus-jsch-deployment</artifactId>
                 <version>${project.version}</version>
             </dependency>
+            <dependency>
+                <groupId>io.quarkus</groupId>
+                <artifactId>quarkus-vertx-redis-deployment</artifactId>
+                <version>${project.version}</version>
+            </dependency>
             <dependency>
                 <groupId>io.quarkus</groupId>
                 <artifactId>quarkus-vault-deployment</artifactId>

diff --git a/bom/runtime/pom.xml b/bom/runtime/pom.xml
@@ -2586,6 +2586,16 @@
                 <artifactId>smallrye-mutiny-vertx-mail-client</artifactId>
                 <version>${mutiny-client.version}</version>
             </dependency>
+            <dependency>
+                <groupId>io.smallrye.reactive</groupId>
+                <artifactId>smallrye-mutiny-vertx-redis-client</artifactId>
+                <version>${mutiny-client.version}</version>
+            </dependency>
+            <dependency>
+                <groupId>io.smallrye.reactive</groupId>
+                <artifactId>smallrye-axle-redis-client</artifactId>
+                <version>${axle-client.version}</version>
+            </dependency>
             <dependency>
                 <groupId>io.vertx</groupId>
                 <artifactId>vertx-rx-java2</artifactId>
@@ -3229,6 +3239,12 @@
                 <version>${project.version}</version>
             </dependency>
 
+            <dependency>
+                <groupId>io.quarkus</groupId>
+                <artifactId>quarkus-vertx-redis</artifactId>
+                <version>${project.version}</version>
+            </dependency>
+
             <!--  Qute  -->
             <dependency>
                 <groupId>io.quarkus.qute</groupId>

diff --git a/core/deployment/src/main/java/io/quarkus/deployment/builditem/FeatureBuildItem.java b/core/deployment/src/main/java/io/quarkus/deployment/builditem/FeatureBuildItem.java
@@ -110,6 +110,7 @@ public final class FeatureBuildItem extends MultiBuildItem {
     public static final String VERTX = "vertx";
     public static final String VERTX_WEB = "vertx-web";
     public static final String VERTX_GRAPHQL = "vertx-graphql";
+    public static final String VERTX_REDIS = "vertx-redis";
 
     private final String info;
 

diff --git a/docs/src/main/asciidoc/index.adoc b/docs/src/main/asciidoc/index.adoc
@@ -62,6 +62,7 @@ include::quarkus-intro.adoc[tag=intro]
 * link:camel.html[Apache Camel]
 * link:command-mode-reference.html[Command Mode Applications]
 * link:grpc.html[Using gRPC]
+* link:redis.html[Connecting to Redis]
 
 * link:faq.html[FAQs]